Merge pull request #130 from appwrite/dev

abnegate · web-flow · commit ec7998e09859 · 2025-12-03T03:05:40.000Z
feat: Node.js SDK update for version 21.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## 21.0.0
+
+* Rename `VCSDeploymentType` enum to `VCSReferenceType`
+* Change `createTemplateDeployment` method signature: replace `version` parameter with `type` (TemplateReferenceType) and `reference` parameters
+* Add `getScreenshot` method to `Avatars` service
+* Add `Theme`, `Timezone` and `Output` enums
+
 ## 20.3.0
 
 * Add `total` parameter to list queries allowing skipping counting rows in a table for improved performance
diff --git a/docs/examples/avatars/get-screenshot.md b/docs/examples/avatars/get-screenshot.md
@@ -0,0 +1,34 @@
+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
+    .setSession(''); // The user session to authenticate with
+
+const avatars = new sdk.Avatars(client);
+
+const result = await avatars.getScreenshot({
+    url: 'https://example.com',
+    headers: {
+        "Authorization": "Bearer token123",
+        "X-Custom-Header": "value"
+    }, // optional
+    viewportWidth: 1920, // optional
+    viewportHeight: 1080, // optional
+    scale: 2, // optional
+    theme: sdk.Theme.Light, // optional
+    userAgent: 'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15', // optional
+    fullpage: true, // optional
+    locale: 'en-US', // optional
+    timezone: sdk.Timezone.AfricaAbidjan, // optional
+    latitude: 37.7749, // optional
+    longitude: -122.4194, // optional
+    accuracy: 100, // optional
+    touch: true, // optional
+    permissions: ["geolocation","notifications"], // optional
+    sleep: 3, // optional
+    width: 800, // optional
+    height: 600, // optional
+    quality: 85, // optional
+    output: sdk.Output.Jpg // optional
+});
diff --git a/docs/examples/functions/create-template-deployment.md b/docs/examples/functions/create-template-deployment.md
@@ -12,6 +12,7 @@ const result = await functions.createTemplateDeployment({
     repository: '<REPOSITORY>',
     owner: '<OWNER>',
     rootDirectory: '<ROOT_DIRECTORY>',
-    version: '<VERSION>',
+    type: sdk.TemplateReferenceType.Commit,
+    reference: '<REFERENCE>',
     activate: false // optional
 });
diff --git a/docs/examples/functions/create-vcs-deployment.md b/docs/examples/functions/create-vcs-deployment.md
@@ -9,7 +9,7 @@ const functions = new sdk.Functions(client);
 
 const result = await functions.createVcsDeployment({
     functionId: '<FUNCTION_ID>',
-    type: sdk.VCSDeploymentType.Branch,
+    type: sdk.VCSReferenceType.Branch,
     reference: '<REFERENCE>',
     activate: false // optional
 });
diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md
@@ -10,7 +10,7 @@ const functions = new sdk.Functions(client);
 const result = await functions.create({
     functionId: '<FUNCTION_ID>',
     name: '<NAME>',
-    runtime: sdk..Node145,
+    runtime: sdk.Runtime.Node145,
     execute: ["any"], // optional
     events: [], // optional
     schedule: '', // optional
diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md
@@ -10,7 +10,7 @@ const functions = new sdk.Functions(client);
 const result = await functions.update({
     functionId: '<FUNCTION_ID>',
     name: '<NAME>',
-    runtime: sdk..Node145, // optional
+    runtime: sdk.Runtime.Node145, // optional
     execute: ["any"], // optional
     events: [], // optional
     schedule: '', // optional
diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md
@@ -8,6 +8,6 @@ const client = new sdk.Client()
 const health = new sdk.Health(client);
 
 const result = await health.getFailedJobs({
-    name: sdk..V1Database,
+    name: sdk.Name.V1Database,
     threshold: null // optional
 });
diff --git a/docs/examples/sites/create-template-deployment.md b/docs/examples/sites/create-template-deployment.md
@@ -12,6 +12,7 @@ const result = await sites.createTemplateDeployment({
     repository: '<REPOSITORY>',
     owner: '<OWNER>',
     rootDirectory: '<ROOT_DIRECTORY>',
-    version: '<VERSION>',
+    type: sdk.TemplateReferenceType.Branch,
+    reference: '<REFERENCE>',
     activate: false // optional
 });
diff --git a/docs/examples/sites/create-vcs-deployment.md b/docs/examples/sites/create-vcs-deployment.md
@@ -9,7 +9,7 @@ const sites = new sdk.Sites(client);
 
 const result = await sites.createVcsDeployment({
     siteId: '<SITE_ID>',
-    type: sdk.VCSDeploymentType.Branch,
+    type: sdk.VCSReferenceType.Branch,
     reference: '<REFERENCE>',
     activate: false // optional
 });
diff --git a/docs/examples/sites/create.md b/docs/examples/sites/create.md
@@ -10,15 +10,15 @@ const sites = new sdk.Sites(client);
 const result = await sites.create({
     siteId: '<SITE_ID>',
     name: '<NAME>',
-    framework: sdk..Analog,
-    buildRuntime: sdk..Node145,
+    framework: sdk.Framework.Analog,
+    buildRuntime: sdk.BuildRuntime.Node145,
     enabled: false, // optional
     logging: false, // optional
     timeout: 1, // optional
     installCommand: '<INSTALL_COMMAND>', // optional
     buildCommand: '<BUILD_COMMAND>', // optional
     outputDirectory: '<OUTPUT_DIRECTORY>', // optional
-    adapter: sdk..Static, // optional
+    adapter: sdk.Adapter.Static, // optional
     installationId: '<INSTALLATION_ID>', // optional
     fallbackFile: '<FALLBACK_FILE>', // optional
     providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
diff --git a/docs/examples/sites/update.md b/docs/examples/sites/update.md
@@ -10,15 +10,15 @@ const sites = new sdk.Sites(client);
 const result = await sites.update({
     siteId: '<SITE_ID>',
     name: '<NAME>',
-    framework: sdk..Analog,
+    framework: sdk.Framework.Analog,
     enabled: false, // optional
     logging: false, // optional
     timeout: 1, // optional
     installCommand: '<INSTALL_COMMAND>', // optional
     buildCommand: '<BUILD_COMMAND>', // optional
     outputDirectory: '<OUTPUT_DIRECTORY>', // optional
-    buildRuntime: sdk..Node145, // optional
-    adapter: sdk..Static, // optional
+    buildRuntime: sdk.BuildRuntime.Node145, // optional
+    adapter: sdk.Adapter.Static, // optional
     fallbackFile: '<FALLBACK_FILE>', // optional
     installationId: '<INSTALLATION_ID>', // optional
     providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md
@@ -15,7 +15,8 @@ const result = await storage.createBucket({
     enabled: false, // optional
     maximumFileSize: 1, // optional
     allowedFileExtensions: [], // optional
-    compression: sdk..None, // optional
+    compression: sdk.Compression.None, // optional
     encryption: false, // optional
-    antivirus: false // optional
+    antivirus: false, // optional
+    transformations: false // optional
 });
diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md
@@ -15,7 +15,8 @@ const result = await storage.updateBucket({
     enabled: false, // optional
     maximumFileSize: 1, // optional
     allowedFileExtensions: [], // optional
-    compression: sdk..None, // optional
+    compression: sdk.Compression.None, // optional
     encryption: false, // optional
-    antivirus: false // optional
+    antivirus: false, // optional
+    transformations: false // optional
 });
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "node-appwrite",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "20.3.0",
+  "version": "21.0.0",
   "license": "BSD-3-Clause",
   "main": "dist/index.js",
   "type": "commonjs",
diff --git a/src/client.ts b/src/client.ts
@@ -33,7 +33,7 @@ class AppwriteException extends Error {
 }
 
 function getUserAgent() {
-    let ua = 'AppwriteNodeJSSDK/20.3.0';
+    let ua = 'AppwriteNodeJSSDK/21.0.0';
 
     // `process` is a global in Node.js, but not fully available in all runtimes.
     const platform: string[] = [];
@@ -82,7 +82,7 @@ class Client {
         'x-sdk-name': 'Node.js',
         'x-sdk-platform': 'server',
         'x-sdk-language': 'nodejs',
-        'x-sdk-version': '20.3.0',
+        'x-sdk-version': '21.0.0',
         'user-agent' : getUserAgent(),
         'X-Appwrite-Response-Format': '1.8.0',
     };
diff --git a/src/enums/build-runtime.ts b/src/enums/build-runtime.ts
@@ -37,6 +37,7 @@ export enum BuildRuntime {
     Dart33 = 'dart-3.3',
     Dart35 = 'dart-3.5',
     Dart38 = 'dart-3.8',
+    Dart39 = 'dart-3.9',
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
@@ -64,4 +65,5 @@ export enum BuildRuntime {
     Flutter327 = 'flutter-3.27',
     Flutter329 = 'flutter-3.29',
     Flutter332 = 'flutter-3.32',
+    Flutter335 = 'flutter-3.35',
 }
diff --git a/src/enums/output.ts b/src/enums/output.ts
@@ -0,0 +1,9 @@
+export enum Output {
+    Jpg = 'jpg',
+    Jpeg = 'jpeg',
+    Png = 'png',
+    Webp = 'webp',
+    Heic = 'heic',
+    Avif = 'avif',
+    Gif = 'gif',
+}
diff --git a/src/enums/runtime.ts b/src/enums/runtime.ts
@@ -37,6 +37,7 @@ export enum Runtime {
     Dart33 = 'dart-3.3',
     Dart35 = 'dart-3.5',
     Dart38 = 'dart-3.8',
+    Dart39 = 'dart-3.9',
     Dotnet60 = 'dotnet-6.0',
     Dotnet70 = 'dotnet-7.0',
     Dotnet80 = 'dotnet-8.0',
@@ -64,4 +65,5 @@ export enum Runtime {
     Flutter327 = 'flutter-3.27',
     Flutter329 = 'flutter-3.29',
     Flutter332 = 'flutter-3.32',
+    Flutter335 = 'flutter-3.35',
 }
diff --git a/src/enums/template-reference-type.ts b/src/enums/template-reference-type.ts
@@ -0,0 +1,5 @@
+export enum TemplateReferenceType {
+    Branch = 'branch',
+    Commit = 'commit',
+    Tag = 'tag',
+}
diff --git a/src/enums/theme.ts b/src/enums/theme.ts
@@ -0,0 +1,4 @@
+export enum Theme {
+    Light = 'light',
+    Dark = 'dark',
+}
diff --git a/src/enums/timezone.ts b/src/enums/timezone.ts
diff --git a/src/enums/vcs-reference-type.ts b/src/enums/vcs-reference-type.ts
diff --git a/src/index.ts b/src/index.ts
diff --git a/src/models.ts b/src/models.ts
diff --git a/src/services/account.ts b/src/services/account.ts
diff --git a/src/services/avatars.ts b/src/services/avatars.ts
diff --git a/src/services/functions.ts b/src/services/functions.ts
diff --git a/src/services/sites.ts b/src/services/sites.ts
diff --git a/src/services/storage.ts b/src/services/storage.ts
diff --git a/src/services/tables-db.ts b/src/services/tables-db.ts
