Merge pull request #126 from appwrite/dev

abnegate · web-flow · commit 71f8567b4e3c · 2025-10-09T23:18:12.000+13:00
feat: Node.js SDK update for version 20.2.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log
 
+## 20.2.0
+
+* Add transaction support for Databases and TablesDB
+
 ## 20.1.0
 
 * Deprecate `createVerification` method in `Account` service
diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md
@@ -18,5 +18,6 @@ const result = await databases.createDocument({
         "age": 30,
         "isAdmin": false
     },
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md
@@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);
 const result = await databases.createDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    documents: []
+    documents: [],
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/create-operations.md b/docs/examples/databases/create-operations.md
@@ -0,0 +1,23 @@
+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.createOperations({
+    transactionId: '<TRANSACTION_ID>',
+    operations: [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "collectionId": "<COLLECTION_ID>",
+	        "documentId": "<DOCUMENT_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] // optional
+});
diff --git a/docs/examples/databases/create-transaction.md b/docs/examples/databases/create-transaction.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 databases = new sdk.Databases(client);
+
+const result = await databases.createTransaction({
+    ttl: 60 // optional
+});
diff --git a/docs/examples/databases/decrement-document-attribute.md b/docs/examples/databases/decrement-document-attribute.md
@@ -13,5 +13,6 @@ const result = await databases.decrementDocumentAttribute({
     documentId: '<DOCUMENT_ID>',
     attribute: '',
     value: null, // optional
-    min: null // optional
+    min: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md
@@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);
 const result = await databases.deleteDocument({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    documentId: '<DOCUMENT_ID>'
+    documentId: '<DOCUMENT_ID>',
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/delete-documents.md b/docs/examples/databases/delete-documents.md
@@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);
 const result = await databases.deleteDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/delete-transaction.md b/docs/examples/databases/delete-transaction.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 databases = new sdk.Databases(client);
+
+const result = await databases.deleteTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md
@@ -11,5 +11,6 @@ const result = await databases.getDocument({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/get-transaction.md b/docs/examples/databases/get-transaction.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 databases = new sdk.Databases(client);
+
+const result = await databases.getTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
diff --git a/docs/examples/databases/increment-document-attribute.md b/docs/examples/databases/increment-document-attribute.md
@@ -13,5 +13,6 @@ const result = await databases.incrementDocumentAttribute({
     documentId: '<DOCUMENT_ID>',
     attribute: '',
     value: null, // optional
-    max: null // optional
+    max: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md
@@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);
 const result = await databases.listDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/list-transactions.md b/docs/examples/databases/list-transactions.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 databases = new sdk.Databases(client);
+
+const result = await databases.listTransactions({
+    queries: [] // optional
+});
diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md
@@ -12,5 +12,6 @@ const result = await databases.updateDocument({
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
     data: {}, // optional
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/update-documents.md b/docs/examples/databases/update-documents.md
@@ -11,5 +11,6 @@ const result = await databases.updateDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
     data: {}, // optional
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/update-transaction.md b/docs/examples/databases/update-transaction.md
@@ -0,0 +1,14 @@
+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.updateTransaction({
+    transactionId: '<TRANSACTION_ID>',
+    commit: false, // optional
+    rollback: false // optional
+});
diff --git a/docs/examples/databases/upsert-document.md b/docs/examples/databases/upsert-document.md
@@ -12,5 +12,6 @@ const result = await databases.upsertDocument({
     collectionId: '<COLLECTION_ID>',
     documentId: '<DOCUMENT_ID>',
     data: {},
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/databases/upsert-documents.md b/docs/examples/databases/upsert-documents.md
@@ -10,5 +10,6 @@ const databases = new sdk.Databases(client);
 const result = await databases.upsertDocuments({
     databaseId: '<DATABASE_ID>',
     collectionId: '<COLLECTION_ID>',
-    documents: []
+    documents: [],
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md
@@ -16,7 +16,7 @@ const result = await messaging.createPush({
     targets: [], // optional
     data: {}, // optional
     action: '<ACTION>', // optional
-    image: '[ID1:ID2]', // optional
+    image: '<ID1:ID2>', // optional
     icon: '<ICON>', // optional
     sound: '<SOUND>', // optional
     color: '<COLOR>', // optional
diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md
@@ -16,7 +16,7 @@ const result = await messaging.updatePush({
     body: '<BODY>', // optional
     data: {}, // optional
     action: '<ACTION>', // optional
-    image: '[ID1:ID2]', // optional
+    image: '<ID1:ID2>', // optional
     icon: '<ICON>', // optional
     sound: '<SOUND>', // optional
     color: '<COLOR>', // optional
diff --git a/docs/examples/tablesdb/create-operations.md b/docs/examples/tablesdb/create-operations.md
@@ -0,0 +1,23 @@
+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.createOperations({
+    transactionId: '<TRANSACTION_ID>',
+    operations: [
+	    {
+	        "action": "create",
+	        "databaseId": "<DATABASE_ID>",
+	        "tableId": "<TABLE_ID>",
+	        "rowId": "<ROW_ID>",
+	        "data": {
+	            "name": "Walter O'Brien"
+	        }
+	    }
+	] // optional
+});
diff --git a/docs/examples/tablesdb/create-row.md b/docs/examples/tablesdb/create-row.md
@@ -18,5 +18,6 @@ const result = await tablesDB.createRow({
         "age": 30,
         "isAdmin": false
     },
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/create-rows.md b/docs/examples/tablesdb/create-rows.md
@@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
 const result = await tablesDB.createRows({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
-    rows: []
+    rows: [],
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/create-transaction.md b/docs/examples/tablesdb/create-transaction.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 tablesDB = new sdk.TablesDB(client);
+
+const result = await tablesDB.createTransaction({
+    ttl: 60 // optional
+});
diff --git a/docs/examples/tablesdb/decrement-row-column.md b/docs/examples/tablesdb/decrement-row-column.md
@@ -13,5 +13,6 @@ const result = await tablesDB.decrementRowColumn({
     rowId: '<ROW_ID>',
     column: '',
     value: null, // optional
-    min: null // optional
+    min: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/delete-row.md b/docs/examples/tablesdb/delete-row.md
@@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
 const result = await tablesDB.deleteRow({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
-    rowId: '<ROW_ID>'
+    rowId: '<ROW_ID>',
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/delete-rows.md b/docs/examples/tablesdb/delete-rows.md
@@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
 const result = await tablesDB.deleteRows({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/delete-transaction.md b/docs/examples/tablesdb/delete-transaction.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 tablesDB = new sdk.TablesDB(client);
+
+const result = await tablesDB.deleteTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
diff --git a/docs/examples/tablesdb/get-row.md b/docs/examples/tablesdb/get-row.md
@@ -11,5 +11,6 @@ const result = await tablesDB.getRow({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
     rowId: '<ROW_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/get-transaction.md b/docs/examples/tablesdb/get-transaction.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 tablesDB = new sdk.TablesDB(client);
+
+const result = await tablesDB.getTransaction({
+    transactionId: '<TRANSACTION_ID>'
+});
diff --git a/docs/examples/tablesdb/increment-row-column.md b/docs/examples/tablesdb/increment-row-column.md
@@ -13,5 +13,6 @@ const result = await tablesDB.incrementRowColumn({
     rowId: '<ROW_ID>',
     column: '',
     value: null, // optional
-    max: null // optional
+    max: null, // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/list-rows.md b/docs/examples/tablesdb/list-rows.md
@@ -10,5 +10,6 @@ const tablesDB = new sdk.TablesDB(client);
 const result = await tablesDB.listRows({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/list-transactions.md b/docs/examples/tablesdb/list-transactions.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 tablesDB = new sdk.TablesDB(client);
+
+const result = await tablesDB.listTransactions({
+    queries: [] // optional
+});
diff --git a/docs/examples/tablesdb/update-row.md b/docs/examples/tablesdb/update-row.md
@@ -12,5 +12,6 @@ const result = await tablesDB.updateRow({
     tableId: '<TABLE_ID>',
     rowId: '<ROW_ID>',
     data: {}, // optional
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/update-rows.md b/docs/examples/tablesdb/update-rows.md
@@ -11,5 +11,6 @@ const result = await tablesDB.updateRows({
     databaseId: '<DATABASE_ID>',
     tableId: '<TABLE_ID>',
     data: {}, // optional
-    queries: [] // optional
+    queries: [], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/update-transaction.md b/docs/examples/tablesdb/update-transaction.md
@@ -0,0 +1,14 @@
+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.updateTransaction({
+    transactionId: '<TRANSACTION_ID>',
+    commit: false, // optional
+    rollback: false // optional
+});
diff --git a/docs/examples/tablesdb/upsert-row.md b/docs/examples/tablesdb/upsert-row.md
@@ -12,5 +12,6 @@ const result = await tablesDB.upsertRow({
     tableId: '<TABLE_ID>',
     rowId: '<ROW_ID>',
     data: {}, // optional
-    permissions: ["read("any")"] // optional
+    permissions: ["read("any")"], // optional
+    transactionId: '<TRANSACTION_ID>' // optional
 });
diff --git a/docs/examples/tablesdb/upsert-rows.md b/docs/examples/tablesdb/upsert-rows.md
diff --git a/package.json b/package.json
diff --git a/src/client.ts b/src/client.ts
diff --git a/src/models.ts b/src/models.ts
diff --git a/src/services/databases.ts b/src/services/databases.ts
diff --git a/src/services/tables-db.ts b/src/services/tables-db.ts
