feat: Node.js SDK update for version 24.1.0

CHANGELOG.md

@@ -1,17 +1,26 @@
 # Change Log
 
+## 24.1.0
+
+* Added: Introduced `bigint` create/update APIs for legacy Databases attributes
+* Added: Introduced `bigint` create/update APIs for `TablesDB` columns
+* Updated: Extended key-list query filters with `key`, `resourceType`, `resourceId`, and `secret`
+
 ## 24.0.0
 
 * [BREAKING] Renamed Webhook model fields: `security` → `tls`, `httpUser` → `authUsername`, `httpPass` → `authPassword`, `signatureKey` → `secret`
 * [BREAKING] Renamed Webhook service parameters to match: `security` → `tls`, `httpUser` → `authUsername`, `httpPass` → `authPassword`
+* [BREAKING] Renamed `Webhooks.updateSignature()` to `Webhooks.updateSecret()` with new optional `secret` parameter
+* Added `Client.getHeaders()` method to retrieve request headers
 * Added `secret` parameter to Webhook create and update methods
 * Added `x` OAuth provider to `OAuthProvider` enum
 * Added `userType` field to `Log` model
 * Added `purge` parameter to `updateCollection` and `updateTable` for cache invalidation
 * Added Project service: platform CRUD, key CRUD, protocol/service status management
-* Added new models: `Key`, `KeyList`, `PlatformAndroid`, `PlatformApple`, `PlatformLinux`, `PlatformList`, and others
+* Added new models: `Key`, `KeyList`, `Project`, `DevKey`, `MockNumber`, `AuthProvider`, `PlatformAndroid`, `PlatformApple`, `PlatformLinux`, `PlatformList`, `PlatformWeb`, `PlatformWindows`, `BillingLimits`, `Block`
 * Added new enums: `PlatformType`, `ProtocolId`, `ServiceId`
-* Updated `BuildRuntime`, `Runtime`, `Scopes` enums with new values
+* Updated `BuildRuntime`, `Runtime` enums with `dart-3.11` and `flutter-3.41`
+* Updated `Scopes` enum with `keysRead`, `keysWrite`, `platformsRead`, `platformsWrite`
 * Updated `X-Appwrite-Response-Format` header to `1.9.1`
 * Updated TTL description for list caching in Databases and TablesDB
 

README.md

@@ -1,12 +1,12 @@
 # Appwrite Node.js SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-node.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-1.9.1-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.9.4-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 1.9.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
+**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
 
  > This is the Node.js SDK for integrating with Appwrite from your Node.js server-side code.
                             If you're looking to integrate from the browser, you should check [appwrite/sdk-for-web](https://github.com/appwrite/sdk-for-web)

docs/examples/databases/create-big-int-attribute.md

@@ -0,0 +1,21 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const databases = new sdk.Databases(client);
+
+const result = await databases.createBigIntAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    min: null, // optional
+    max: null, // optional
+    default: null, // optional
+    array: false // optional
+});
+```

docs/examples/databases/update-big-int-attribute.md

@@ -0,0 +1,21 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const databases = new sdk.Databases(client);
+
+const result = await databases.updateBigIntAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: null,
+    min: null, // optional
+    max: null, // optional
+    newKey: '' // optional
+});
+```

docs/examples/functions/create-variable.md

@@ -10,6 +10,7 @@ const functions = new sdk.Functions(client);
 
 const result = await functions.createVariable({
     functionId: '<FUNCTION_ID>',
+    variableId: '<VARIABLE_ID>',
     key: '<KEY>',
     value: '<VALUE>',
     secret: false // optional

docs/examples/functions/create.md

@@ -20,7 +20,7 @@ const result = await functions.create({
     logging: false, // optional
     entrypoint: '<ENTRYPOINT>', // optional
     commands: '<COMMANDS>', // optional
-    scopes: [sdk.Scopes.SessionsWrite], // optional
+    scopes: [sdk.Scopes.ProjectRead], // optional
     installationId: '<INSTALLATION_ID>', // optional
     providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
     providerBranch: '<PROVIDER_BRANCH>', // optional

docs/examples/functions/list-variables.md

@@ -9,6 +9,8 @@ const client = new sdk.Client()
 const functions = new sdk.Functions(client);
 
 const result = await functions.listVariables({
-    functionId: '<FUNCTION_ID>'
+    functionId: '<FUNCTION_ID>',
+    queries: [], // optional
+    total: false // optional
 });
 ```

docs/examples/functions/update-variable.md

@@ -11,7 +11,7 @@ const functions = new sdk.Functions(client);
 const result = await functions.updateVariable({
     functionId: '<FUNCTION_ID>',
     variableId: '<VARIABLE_ID>',
-    key: '<KEY>',
+    key: '<KEY>', // optional
     value: '<VALUE>', // optional
     secret: false // optional
 });

docs/examples/functions/update.md

@@ -20,7 +20,7 @@ const result = await functions.update({
     logging: false, // optional
     entrypoint: '<ENTRYPOINT>', // optional
     commands: '<COMMANDS>', // optional
-    scopes: [sdk.Scopes.SessionsWrite], // optional
+    scopes: [sdk.Scopes.ProjectRead], // optional
     installationId: '<INSTALLATION_ID>', // optional
     providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
     providerBranch: '<PROVIDER_BRANCH>', // optional

docs/examples/presences/delete.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.delete({
+    presenceId: '<PRESENCE_ID>'
+});
+```

docs/examples/presences/get.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.get({
+    presenceId: '<PRESENCE_ID>'
+});
+```

docs/examples/presences/list.md

@@ -0,0 +1,16 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.list({
+    queries: [], // optional
+    total: false, // optional
+    ttl: 0 // optional
+});
+```

docs/examples/presences/update-presence.md

@@ -0,0 +1,20 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.updatePresence({
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>', // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: {}, // optional
+    permissions: [sdk.Permission.read(sdk.Role.any())], // optional
+    purge: false // optional
+});
+```

docs/examples/presences/upsert.md

@@ -0,0 +1,19 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const presences = new sdk.Presences(client);
+
+const result = await presences.upsert({
+    presenceId: '<PRESENCE_ID>',
+    userId: '<USER_ID>',
+    status: '<STATUS>',
+    permissions: [sdk.Permission.read(sdk.Role.any())], // optional
+    expiresAt: '2020-10-15T06:38:00.000+00:00', // optional
+    metadata: {} // optional
+});
+```

docs/examples/project/create-ephemeral-key.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.createEphemeralKey({
+    scopes: [sdk.Scopes.ProjectRead],
+    duration: 600
+});
+```

docs/examples/project/create-key.md

@@ -11,7 +11,7 @@ const project = new sdk.Project(client);
 const result = await project.createKey({
     keyId: '<KEY_ID>',
     name: '<NAME>',
-    scopes: [sdk.Scopes.SessionsWrite],
+    scopes: [sdk.Scopes.ProjectRead],
     expire: '2020-10-15T06:38:00.000+00:00' // optional
 });
 ```

docs/examples/project/create-mock-phone.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.createMockPhone({
+    number: '+12065550100',
+    otp: '<OTP>'
+});
+```

docs/examples/project/create-smtp-test.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.createSMTPTest({
+    emails: []
+});
+```

docs/examples/project/delete-mock-phone.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.deleteMockPhone({
+    number: '+12065550100'
+});
+```

docs/examples/project/delete.md

@@ -0,0 +1,12 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.delete();
+```

docs/examples/project/get-email-template.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.getEmailTemplate({
+    templateId: sdk.EmailTemplateType.Verification,
+    locale: sdk.EmailTemplateLocale.Af // optional
+});
+```

docs/examples/project/get-mock-phone.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.getMockPhone({
+    number: '+12065550100'
+});
+```

docs/examples/project/get-o-auth-2-provider.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.getOAuth2Provider({
+    providerId: sdk.ProviderId.Amazon
+});
+```

docs/examples/project/get-policy.md

@@ -0,0 +1,14 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.getPolicy({
+    policyId: sdk.PolicyId.PasswordDictionary
+});
+```

docs/examples/project/list-email-templates.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.listEmailTemplates({
+    queries: [], // optional
+    total: false // optional
+});
+```

docs/examples/project/list-mock-phones.md

@@ -0,0 +1,15 @@
+```javascript
+const sdk = require('node-appwrite');
+
+const client = new sdk.Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>') // Your project ID
+    .setKey('<YOUR_API_KEY>'); // Your secret API key
+
+const project = new sdk.Project(client);
+
+const result = await project.listMockPhones({
+    queries: [], // optional
+    total: false // optional
+});
+```