Skip to content

Commit c4178fc

Browse files
authored
Merge pull request #73 from appwrite/dev
2 parents c1222d4 + b43518e commit c4178fc

32 files changed

+567
-461
lines changed

CHANGELOG.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,27 @@
11
# Change Log
22

3-
## 7.0.0
4-
5-
* Breaking: Updated `$sequence` type from `number` to `string` for rows and documents.
6-
* Updated: Compatibility note now refers to Appwrite server `1.9.x`.
7-
* Updated: README badge shows API version `1.9.0`.
8-
* Updated: Set header `X-Appwrite-Response-Format` to `1.9.0`.
3+
## 8.0.0
4+
5+
* [BREAKING] Changed `$sequence` type from `number` to `string` for `Row` and `Document` models
6+
* [BREAKING] Renamed `IndexType` enum: split into `DatabasesIndexType` (for Databases) and `TablesDBIndexType` (for TablesDB)
7+
* [BREAKING] `Project.createVariable` now requires `variableId` as a new first parameter
8+
* [BREAKING] Removed `ProviderRepositoryRuntime`, `ProviderRepositoryRuntimeList`, and `DetectionRuntime` models
9+
* [BREAKING] Removed all RC (release candidate) runtime variants from `Runtime`, `Runtimes`, and `BuildRuntime` enums
10+
* Added new `Domains.updateAutoRenewal()` method for enabling/disabling domain auto-renewal
11+
* Added new `Users.updateImpersonator()` method for enabling/disabling user impersonation
12+
* Added impersonation support: `setImpersonateUserId()`, `setImpersonateUserEmail()`, `setImpersonateUserPhone()` on `Client`
13+
* Added `impersonator` and `impersonatorUserId` optional fields to `User` model
14+
* Added `autoRenewal` optional parameter to `Domains.createPurchase()` and `Domains.createTransferIn()`
15+
* Added optional `queries` and `total` parameters to `Project.listVariables()`
16+
* Added `Documentsdb` and `Vectorsdb` values to `DatabaseType` and `BackupServices` enums
17+
* Added new scopes: `Account`, `ProjectRead`, `ProjectWrite`, `PlatformsRead`, `PlatformsWrite`, `ProjectsRead`, `ProjectsWrite`, `KeysRead`, `KeysWrite`, `DevKeysRead`, `DevKeysWrite`
18+
* Added VectorsDB and DocumentsDB usage metrics to `UsagePeriod` model
19+
* Added embeddings metrics (`embeddingsText*`) to `UsagePeriod` model
20+
* Added `realtimeMessages` and `realtimeBandwidth` fields to `Plan` model
21+
* Changed `Project.updateVariable` `key` parameter from required to optional
22+
* Updated `Log` model field descriptions to clarify impersonation behavior
23+
* Updated `X-Appwrite-Response-Format` header to `1.9.0`
24+
* Updated devDependencies: Rollup 2→3, TypeScript 4.7→5.7, and related plugin upgrades
925

1026
## 6.0.0
1127

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
77
[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
88

9-
**This SDK is compatible with Appwrite server version 1.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
9+
**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-console/releases).**
1010

1111
Appwrite is an open-source backend as a service server that abstracts and simplifies complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Console SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
1212

@@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console";
3333
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:
3434

3535
```html
36-
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@7.0.0"></script>
36+
<script src="https://cdn.jsdelivr.net/npm/@appwrite.io/console@8.0.0"></script>
3737
```
3838

3939

docs/examples/databases/create-index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Databases, IndexType, OrderBy } from "@appwrite.io/console";
2+
import { Client, Databases, DatabasesIndexType, OrderBy } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -11,7 +11,7 @@ const result = await databases.createIndex({
1111
databaseId: '<DATABASE_ID>',
1212
collectionId: '<COLLECTION_ID>',
1313
key: '',
14-
type: IndexType.Key,
14+
type: DatabasesIndexType.Key,
1515
attributes: [],
1616
orders: [OrderBy.Asc], // optional
1717
lengths: [] // optional

docs/examples/domains/create-purchase.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ const result = await domains.createPurchase({
1818
paymentMethodId: '<PAYMENT_METHOD_ID>',
1919
addressLine3: '<ADDRESS_LINE3>', // optional
2020
companyName: '<COMPANY_NAME>', // optional
21-
periodYears: 1 // optional
21+
periodYears: 1, // optional
22+
autoRenewal: false // optional
2223
});
2324

2425
console.log(result);

docs/examples/domains/create-transfer-in.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ const result = await domains.createTransferIn({
1111
domain: '',
1212
organizationId: '<ORGANIZATION_ID>',
1313
authCode: '<AUTH_CODE>',
14-
paymentMethodId: '<PAYMENT_METHOD_ID>'
14+
paymentMethodId: '<PAYMENT_METHOD_ID>',
15+
autoRenewal: false // optional
1516
});
1617

1718
console.log(result);
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
```javascript
2+
import { Client, Domains } from "@appwrite.io/console";
3+
4+
const client = new Client()
5+
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
6+
.setProject('<YOUR_PROJECT_ID>'); // Your project ID
7+
8+
const domains = new Domains(client);
9+
10+
const result = await domains.updateAutoRenewal({
11+
domainId: '<DOMAIN_ID>',
12+
autoRenewal: false
13+
});
14+
15+
console.log(result);
16+
```

docs/examples/project/create-variable.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ const client = new Client()
88
const project = new Project(client);
99

1010
const result = await project.createVariable({
11+
variableId: '<VARIABLE_ID>',
1112
key: '<KEY>',
1213
value: '<VALUE>',
1314
secret: false // optional

docs/examples/project/list-variables.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ const client = new Client()
77

88
const project = new Project(client);
99

10-
const result = await project.listVariables();
10+
const result = await project.listVariables({
11+
queries: [], // optional
12+
total: false // optional
13+
});
1114

1215
console.log(result);
1316
```

docs/examples/project/update-variable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const project = new Project(client);
99

1010
const result = await project.updateVariable({
1111
variableId: '<VARIABLE_ID>',
12-
key: '<KEY>',
12+
key: '<KEY>', // optional
1313
value: '<VALUE>', // optional
1414
secret: false // optional
1515
});

docs/examples/tablesdb/create-index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, TablesDB, IndexType, OrderBy } from "@appwrite.io/console";
2+
import { Client, TablesDB, TablesDBIndexType, OrderBy } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -11,7 +11,7 @@ const result = await tablesDB.createIndex({
1111
databaseId: '<DATABASE_ID>',
1212
tableId: '<TABLE_ID>',
1313
key: '',
14-
type: IndexType.Key,
14+
type: TablesDBIndexType.Key,
1515
columns: [],
1616
orders: [OrderBy.Asc], // optional
1717
lengths: [] // optional

0 commit comments

Comments
 (0)