Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Change Log

## 13.2.0

* Added: `Apps` service for managing OAuth2 apps, secrets, and tokens
* Added: `Compute` service for dedicated database management (backups, branches, connections, replicas, restorations)
* Added: `Advisor` service with `listInsights`, `getInsight`, `listReports`, `getReport`, and `deleteReport`
* Added: `getAuditsDB` method on `Health` service
* Added: `createSesProvider` and `updateSesProvider` methods on `Messaging` service
* Added: `updateOAuth2Server` method on `Project` service
* Added: `updatePasswordStrengthPolicy` method on `Project` service
* Added: Models for dedicated databases, apps, advisor insights/reports, and new password policies
* Updated: `getPolicy` now also returns password-strength and email-deny policy types
* Updated: Renamed enums to match server naming (`FunctionRuntime` to `Runtime`, `SiteFramework` to `Framework`, `SiteBuildRuntime` to `BuildRuntime`, `SiteAdapter` to `Adapter`, `MigrationOnDuplicate` to `OnDuplicate`, `RedirectStatusCode` to `StatusCode`, `OrganizationAddon` to `Addon`, `ProjectStatus` to `Status`)
* Updated: `X-Appwrite-Project` is now sent per request instead of set globally on `setProject`

## 13.1.0

* Added: `Organization` service with organization-scoped key methods (`listKeys`, `createKey`, `getKey`, `updateKey`, `deleteKey`)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Organization service project-management methods are missing from the entry

The changelog mentions only the five key-management methods on Organization, but src/services/organization.ts also exposes a full set of project CRUD operations: listProjects, createProject, getProject, updateProject, and deleteProject. None of these appeared in any prior changelog version, so they are also new in 13.1.0 and should be documented here.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

* Added: `Presences` service with `list`, `get`, and `getUsage` methods

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Presences service methods are under-documented

The changelog claims the Presences service adds only list, get, and getUsage, but src/services/presences.ts also exports upsert, update, and delete. All six methods are new in this version and have no entry in any prior changelog, so consumers reading the changelog will be unaware that write/delete operations are available.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

* Added: `Usage` service with `listEvents` and `listGauges` methods
* Added: `listOrganizationScopes` and `getEmailTemplate` methods on `Console` service
* Updated: Renamed enums for clearer namespacing (e.g. `Scopes` to `AccountKeyScopes`, `Theme` to `BrowserTheme`, `Runtime` to `FunctionRuntime`)

## 13.0.0

* Breaking: Renamed `updateCanonicalEmails` to `updateDenyCanonicalEmailPolicy` on `Project` service
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
To install with a CDN (content delivery network) add the following scripts to the bottom of your <body> tag, but before you use any Appwrite services:

```html
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@13.1.0"></script>
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@13.2.0"></script>
```


Expand Down
2 changes: 1 addition & 1 deletion docs/examples/account/update-password.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const account = new Account(client);

const result = await account.updatePassword({
password: '',
oldPassword: 'password' // optional
oldPassword: '<OLD_PASSWORD>' // optional
});

console.log(result);
Expand Down
15 changes: 15 additions & 0 deletions docs/examples/advisor/delete-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Advisor } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const advisor = new Advisor(client);

const result = await advisor.deleteReport({
reportId: '<REPORT_ID>'
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/advisor/get-insight.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Advisor } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const advisor = new Advisor(client);

const result = await advisor.getInsight({
reportId: '<REPORT_ID>',
insightId: '<INSIGHT_ID>'
});

console.log(result);
```
15 changes: 15 additions & 0 deletions docs/examples/advisor/get-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Advisor } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const advisor = new Advisor(client);

const result = await advisor.getReport({
reportId: '<REPORT_ID>'
});

console.log(result);
```
17 changes: 17 additions & 0 deletions docs/examples/advisor/list-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```javascript
import { Client, Advisor } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const advisor = new Advisor(client);

const result = await advisor.listInsights({
reportId: '<REPORT_ID>',
queries: [], // optional
total: false // optional
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/advisor/list-reports.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Advisor } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const advisor = new Advisor(client);

const result = await advisor.listReports({
queries: [], // optional
total: false // optional
});

console.log(result);
```
15 changes: 15 additions & 0 deletions docs/examples/apps/create-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.createSecret({
appId: '<APP_ID>'
});

console.log(result);
```
21 changes: 21 additions & 0 deletions docs/examples/apps/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.create({
appId: '<APP_ID>',
name: '<NAME>',
redirectUris: [],
enabled: false, // optional
internal: false, // optional
type: 'public', // optional
teamId: '<TEAM_ID>' // optional
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/apps/delete-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.deleteSecret({
appId: '<APP_ID>',
secretId: '<SECRET_ID>'
});

console.log(result);
```
15 changes: 15 additions & 0 deletions docs/examples/apps/delete-tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.deleteTokens({
appId: '<APP_ID>'
});

console.log(result);
```
15 changes: 15 additions & 0 deletions docs/examples/apps/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.delete({
appId: '<APP_ID>'
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/apps/get-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.getSecret({
appId: '<APP_ID>',
secretId: '<SECRET_ID>'
});

console.log(result);
```
15 changes: 15 additions & 0 deletions docs/examples/apps/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.get({
appId: '<APP_ID>'
});

console.log(result);
```
17 changes: 17 additions & 0 deletions docs/examples/apps/list-secrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.listSecrets({
appId: '<APP_ID>',
queries: [], // optional
total: false // optional
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/apps/list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.list({
queries: [], // optional
total: false // optional
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/apps/update-team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.updateTeam({
appId: '<APP_ID>',
teamId: '<TEAM_ID>'
});

console.log(result);
```
20 changes: 20 additions & 0 deletions docs/examples/apps/update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```javascript
import { Client, Apps } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const apps = new Apps(client);

const result = await apps.update({
appId: '<APP_ID>',
name: '<NAME>',
enabled: false, // optional
internal: false, // optional
redirectUris: [], // optional
type: 'public' // optional
});

console.log(result);
```
21 changes: 21 additions & 0 deletions docs/examples/compute/create-database-backup-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```javascript
import { Client, Compute } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const compute = new Compute(client);

const result = await compute.createDatabaseBackupPolicy({
databaseId: '<DATABASE_ID>',
policyId: '<POLICY_ID>',
name: '<NAME>',
schedule: '',
retention: 1,
type: 'full', // optional
enabled: false // optional
});

console.log(result);
```
16 changes: 16 additions & 0 deletions docs/examples/compute/create-database-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
```javascript
import { Client, Compute } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const compute = new Compute(client);

const result = await compute.createDatabaseBackup({
databaseId: '<DATABASE_ID>',
type: 'full' // optional
});

console.log(result);
```
17 changes: 17 additions & 0 deletions docs/examples/compute/create-database-branch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```javascript
import { Client, Compute } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const compute = new Compute(client);

const result = await compute.createDatabaseBranch({
databaseId: '<DATABASE_ID>',
branchId: '<BRANCH_ID>', // optional
ttl: 300 // optional
});

console.log(result);
```
17 changes: 17 additions & 0 deletions docs/examples/compute/create-database-connection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```javascript
import { Client, Compute } from "@appwrite.io/console";

const client = new Client()
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
.setProject('<YOUR_PROJECT_ID>'); // Your project ID

const compute = new Compute(client);

const result = await compute.createDatabaseConnection({
databaseId: '<DATABASE_ID>',
username: '<USERNAME>',
role: '<ROLE>' // optional
});

console.log(result);
```
Loading