Merge pull request #126 from appwrite/dev

abnegate · web-flow · commit 5a0e36c71a0c · 2025-05-21T07:34:33.000Z
chore: add setDevKey and upsetDocument method
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import { Client, Account } from "appwrite";
 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:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/appwrite@18.0.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/appwrite@18.1.0"></script>
 ```
 
 
diff --git a/docs/examples/databases/upsert-document.md b/docs/examples/databases/upsert-document.md
@@ -0,0 +1,17 @@
+import { Client, Databases } from "appwrite";
+
+const client = new Client()
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
+    .setProject('<YOUR_PROJECT_ID>'); // Your project ID
+
+const databases = new Databases(client);
+
+const result = await databases.upsertDocument(
+    '<DATABASE_ID>', // databaseId
+    '<COLLECTION_ID>', // collectionId
+    '<DOCUMENT_ID>', // documentId
+    {}, // data
+    ["read("any")"] // permissions (optional)
+);
+
+console.log(result);
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "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": "18.0.0",
+  "version": "18.1.0",
   "license": "BSD-3-Clause",
   "main": "dist/cjs/sdk.js",
   "exports": {
diff --git a/src/client.ts b/src/client.ts
@@ -307,6 +307,7 @@ class Client {
         jwt: '',
         locale: '',
         session: '',
+        devkey: '',
     };
     /**
      * Custom headers for API requests.
@@ -315,7 +316,7 @@ class Client {
         'x-sdk-name': 'Web',
         'x-sdk-platform': 'client',
         'x-sdk-language': 'web',
-        'x-sdk-version': '18.0.0',
+        'x-sdk-version': '18.1.0',
         'X-Appwrite-Response-Format': '1.7.0',
     };
 
@@ -409,6 +410,20 @@ class Client {
         this.config.session = value;
         return this;
     }
+    /**
+     * Set DevKey
+     *
+     * Your secret dev API key
+     *
+     * @param value string
+     *
+     * @return {this}
+     */
+    setDevKey(value: string): this {
+        this.headers['X-Appwrite-Dev-Key'] = value;
+        this.config.devkey = value;
+        return this;
+    }
 
     private realtime: Realtime = {
         socket: undefined,
diff --git a/src/services/databases.ts b/src/services/databases.ts
@@ -127,6 +127,51 @@ export class Databases {
             payload
         );
     }
+    /**
+     * Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
+     *
+     * @param {string} databaseId
+     * @param {string} collectionId
+     * @param {string} documentId
+     * @param {object} data
+     * @param {string[]} permissions
+     * @throws {AppwriteException}
+     * @returns {Promise<Document>}
+     */
+    upsertDocument<Document extends Models.Document>(databaseId: string, collectionId: string, documentId: string, data: object, permissions?: string[]): Promise<Document> {
+        if (typeof databaseId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "databaseId"');
+        }
+        if (typeof collectionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "collectionId"');
+        }
+        if (typeof documentId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "documentId"');
+        }
+        if (typeof data === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "data"');
+        }
+        const apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replace('{databaseId}', databaseId).replace('{collectionId}', collectionId).replace('{documentId}', documentId);
+        const payload: Payload = {};
+        if (typeof data !== 'undefined') {
+            payload['data'] = data;
+        }
+        if (typeof permissions !== 'undefined') {
+            payload['permissions'] = permissions;
+        }
+        const uri = new URL(this.client.config.endpoint + apiPath);
+
+        const apiHeaders: { [header: string]: string } = {
+            'content-type': 'application/json',
+        }
+
+        return this.client.call(
+            'put',
+            uri,
+            apiHeaders,
+            payload
+        );
+    }
     /**
      * Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
      *
