feat: Node.js SDK update for version 22.0.0

.github/workflows/publish.yml

@@ -5,21 +5,26 @@ on:
     types: [published]
   workflow_dispatch:
 
+permissions:
+  id-token: write
+  contents: read
+
 jobs:
   publish:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v4
 
-    # Setup Node.js environment
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
-        node-version: '20.x'
+        node-version: '22'
         registry-url: 'https://registry.npmjs.org'
 
-    # Determine release tag based on the tag name
+    - name: Update npm to latest version for OIDC support
+      run: npm install -g npm@latest
+
     - name: Determine release tag
       id: release_tag
       run: |
@@ -29,14 +34,10 @@ jobs:
           echo "tag=latest" >> "$GITHUB_OUTPUT"
         fi
 
-    # Install dependencies (if any) and build your project (if necessary)
     - name: Install dependencies and build
       run: |
         npm install
         npm run build
 
-    # Publish to NPM with the appropriate tag
     - name: Publish
-      run: npm publish --tag ${{ steps.release_tag.outputs.tag }}
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_NO_ORG }}
+      run: npm publish --provenance --access public --tag ${{ steps.release_tag.outputs.tag }}

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 22.0.0
+
+* Add array-based enum parameters (e.g., `permissions: BrowserPermission[]`).
+* Breaking change: `Output` enum has been removed; use `ImageFormat` instead.
+* Add `getQueueAudits` support to `Health` service.
+* Add longtext/mediumtext/text/varchar attribute and column helpers to `Databases` and `TablesDB` services.
+
 ## 21.1.0
 
 * Added ability to create columns and indexes synchronously while creating a table

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2026 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.md

@@ -1,7 +1,7 @@
 # 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.8.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-1.8.1-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)
@@ -11,7 +11,7 @@
  > 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)
 
-Appwrite is an open-source backend as a service server that abstract and simplify 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 Node.js 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)
+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 Node.js 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)
 
 ![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
 

docs/examples/account/create-jwt.md

@@ -7,4 +7,6 @@ const client = new sdk.Client()
 
 const account = new sdk.Account(client);
 
-const result = await account.createJWT();
+const result = await account.createJWT({
+    duration: 0 // optional
+});

docs/examples/avatars/get-screenshot.md

@@ -16,19 +16,19 @@ const result = await avatars.getScreenshot({
     viewportWidth: 1920, // optional
     viewportHeight: 1080, // optional
     scale: 2, // optional
-    theme: sdk.Theme.Light, // optional
+    theme: sdk.Theme.Dark, // 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
+    timezone: sdk.Timezone.AmericaNewYork, // optional
     latitude: 37.7749, // optional
     longitude: -122.4194, // optional
     accuracy: 100, // optional
     touch: true, // optional
-    permissions: ["geolocation","notifications"], // optional
+    permissions: [sdk.BrowserPermission.Geolocation, sdk.BrowserPermission.Notifications], // optional
     sleep: 3, // optional
     width: 800, // optional
     height: 600, // optional
     quality: 85, // optional
-    output: sdk.Output.Jpg // optional
+    output: sdk.ImageFormat.Jpeg // optional
 });

docs/examples/databases/create-index.md

@@ -13,6 +13,6 @@ const result = await databases.createIndex({
     key: '',
     type: sdk.IndexType.Key,
     attributes: [],
-    orders: [], // optional
+    orders: [sdk.OrderBy.Asc], // optional
     lengths: [] // optional
 });

docs/examples/databases/create-longtext-attribute.md

@@ -0,0 +1,17 @@
+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.createLongtextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});

docs/examples/databases/create-mediumtext-attribute.md

@@ -0,0 +1,17 @@
+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.createMediumtextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});

docs/examples/databases/create-text-attribute.md

@@ -0,0 +1,17 @@
+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.createTextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});

docs/examples/databases/create-varchar-attribute.md

@@ -0,0 +1,18 @@
+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.createVarcharAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    size: 1,
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});

docs/examples/databases/update-collection.md

@@ -10,7 +10,7 @@ const databases = new sdk.Databases(client);
 const result = await databases.updateCollection({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    name: '<NAME>',
+    name: '<NAME>', // optional
     permissions: [sdk.Permission.read(sdk.Role.any())], // optional
     documentSecurity: false, // optional
     enabled: false // optional

docs/examples/databases/update-document.md

@@ -11,7 +11,13 @@ const result = await databases.updateDocument({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
-    data: {}, // optional
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 33,
+        "isAdmin": false
+    }, // optional
     permissions: [sdk.Permission.read(sdk.Role.any())], // optional
     transactionId: '<TRANSACTION_ID>' // optional
 });

docs/examples/databases/update-documents.md

@@ -10,7 +10,13 @@ const databases = new sdk.Databases(client);
 const result = await databases.updateDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    data: {}, // optional
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 33,
+        "isAdmin": false
+    }, // optional
     queries: [], // optional
     transactionId: '<TRANSACTION_ID>' // optional
 });

docs/examples/databases/update-longtext-attribute.md

@@ -0,0 +1,17 @@
+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.updateLongtextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});

docs/examples/databases/update-mediumtext-attribute.md

@@ -0,0 +1,17 @@
+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.updateMediumtextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});

docs/examples/databases/update-text-attribute.md

@@ -0,0 +1,17 @@
+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.updateTextAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    newKey: '' // optional
+});

docs/examples/databases/update-varchar-attribute.md

@@ -0,0 +1,18 @@
+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.updateVarcharAttribute({
+    databaseId: '<DATABASE_ID>',
+    collectionId: '<COLLECTION_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>',
+    size: 1, // optional
+    newKey: '' // optional
+});

docs/examples/databases/update.md

@@ -9,6 +9,6 @@ const databases = new sdk.Databases(client);
 
 const result = await databases.update({
     databaseId: '<DATABASE_ID>',
-    name: '<NAME>',
+    name: '<NAME>', // optional
     enabled: false // optional
 });

docs/examples/databases/upsert-document.md

@@ -11,7 +11,13 @@ const result = await databases.upsertDocument({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
-    data: {},
+    data: {
+        "username": "walter.obrien",
+        "email": "walter.obrien@example.com",
+        "fullName": "Walter O'Brien",
+        "age": 30,
+        "isAdmin": false
+    }, // optional
     permissions: [sdk.Permission.read(sdk.Role.any())], // optional
     transactionId: '<TRANSACTION_ID>' // optional
 });

docs/examples/functions/create.md

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

docs/examples/functions/update.md

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

docs/examples/health/get-queue-audits.md

@@ -0,0 +1,12 @@
+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 health = new sdk.Health(client);
+
+const result = await health.getQueueAudits({
+    threshold: null // optional
+});

docs/examples/tablesdb/create-index.md

@@ -13,6 +13,6 @@ const result = await tablesDB.createIndex({
     key: '',
     type: sdk.IndexType.Key,
     columns: [],
-    orders: [], // optional
+    orders: [sdk.OrderBy.Asc], // optional
     lengths: [] // optional
 });

docs/examples/tablesdb/create-longtext-column.md

@@ -0,0 +1,17 @@
+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 tablesDB = new sdk.TablesDB(client);
+
+const result = await tablesDB.createLongtextColumn({
+    databaseId: '<DATABASE_ID>',
+    tableId: '<TABLE_ID>',
+    key: '',
+    required: false,
+    default: '<DEFAULT>', // optional
+    array: false // optional
+});