node-appwrite 8.1.0 → 9.0.0

package/lib/services/functions.js

@@ -51,8 +51,8 @@ class Functions extends Service {
      *
      * @param {string} functionId
      * @param {string} name
-     * @param {string[]} execute
      * @param {string} runtime
+     * @param {string[]} execute
      * @param {string[]} events
      * @param {string} schedule
      * @param {number} timeout
@@ -60,7 +60,7 @@ class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async create(functionId, name, execute, runtime, events, schedule, timeout, enabled) {
+    async create(functionId, name, runtime, execute, events, schedule, timeout, enabled) {
         let path = '/functions';
         let payload = {};
         if (typeof functionId === 'undefined') {
@@ -71,10 +71,6 @@ class Functions extends Service {
             throw new AppwriteException('Missing required parameter: "name"');
         }
 
-        if (typeof execute === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "execute"');
-        }
-
         if (typeof runtime === 'undefined') {
             throw new AppwriteException('Missing required parameter: "runtime"');
         }
@@ -182,10 +178,6 @@ class Functions extends Service {
             throw new AppwriteException('Missing required parameter: "name"');
         }
 
-        if (typeof execute === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "execute"');
-        }
-
 
         if (typeof name !== 'undefined') {
             payload['name'] = name;
@@ -382,48 +374,56 @@ class Functions extends Service {
 
         return await new Promise((resolve, reject) => {
             const writeStream = new Stream.Writable();
-            writeStream._write = async (mainChunk, encoding, next) => {
-                // Segment incoming chunk into up to 5MB chunks
-                const mainChunkSize = Buffer.byteLength(mainChunk);
-                const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
-                const chunks = [];
-
-                for(let i = 0; i < chunksCount; i++) {
-                    const chunk = mainChunk.slice(i * client.CHUNK_SIZE, client.CHUNK_SIZE);
-                    chunks.push(chunk);
-                }
+            writeStream._write = async (mainChunk, encoding, callback) => {
+                try {
+                    // Segment incoming chunk into up to 5MB chunks
+                    const mainChunkSize = Buffer.byteLength(mainChunk);
+                    const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
+                    const chunks = [];
+
+                    for(let i = 0; i < chunksCount; i++) {
+                        const chunk = mainChunk.slice(i * client.CHUNK_SIZE, (i + 1) * client.CHUNK_SIZE);
+                        chunks.push(chunk);
+                    }
 
-                for (const chunk of chunks) {
-                    const chunkSize = Buffer.byteLength(chunk);
-
-                    if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
-                        // Upload chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        await uploadChunk();
-                        currentChunk = Buffer.from('');
-                        currentChunkSize = 0;
-                    } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
-                        // Upload chunk, put rest into next chunk
-                        const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
-                        const newChunkSection = chunk.slice(0, bytesToUpload);
-                        currentChunk = Buffer.concat([currentChunk, newChunkSection]);
-                        currentChunkSize = Buffer.byteLength(currentChunk);
-                        await uploadChunk();
-                        currentChunk = chunk.slice(bytesToUpload, undefined);
-                        currentChunkSize = chunkSize - bytesToUpload;
-                    } else {
-                        // Append into current chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        currentChunkSize = chunkSize + currentChunkSize;
+                    for (const chunk of chunks) {
+                        const chunkSize = Buffer.byteLength(chunk);
+
+                        if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
+                            // Upload chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            await uploadChunk();
+                            currentChunk = Buffer.from('');
+                            currentChunkSize = 0;
+                        } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
+                            // Upload chunk, put rest into next chunk
+                            const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
+                            const newChunkSection = chunk.slice(0, bytesToUpload);
+                            currentChunk = Buffer.concat([currentChunk, newChunkSection]);
+                            currentChunkSize = Buffer.byteLength(currentChunk);
+                            await uploadChunk();
+                            currentChunk = chunk.slice(bytesToUpload, undefined);
+                            currentChunkSize = chunkSize - bytesToUpload;
+                        } else {
+                            // Append into current chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            currentChunkSize = chunkSize + currentChunkSize;
+                        }
                     }
-                }
 
-                next();
+                    callback();
+                } catch (e) {
+                    callback(e);
+                }
             }
 
             writeStream.on("finish", async () => {
                 if(currentChunkSize > 0) {
-                    await uploadChunk(true);
+                    try {
+                        await uploadChunk(true);
+                    } catch (e) {
+                        reject(e);
+                    }
                 }
                 
                 resolve(response);
@@ -522,7 +522,7 @@ class Functions extends Service {
     }
 
     /**
-     * Retry Build
+     * Create Build
      *
      * @param {string} functionId
      * @param {string} deploymentId
@@ -530,7 +530,7 @@ class Functions extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async retryBuild(functionId, deploymentId, buildId) {
+    async createBuild(functionId, deploymentId, buildId) {
         let path = '/functions/{functionId}/deployments/{deploymentId}/builds/{buildId}'.replace('{functionId}', functionId).replace('{deploymentId}', deploymentId).replace('{buildId}', buildId);
         let payload = {};
         if (typeof functionId === 'undefined') {
@@ -555,9 +555,7 @@ class Functions extends Service {
      * List Executions
      *
      * Get a list of all the current user function execution logs. You can use the
-     * query params to filter your results. On admin mode, this endpoint will
-     * return a list of all of the project's executions. [Learn more about
-     * different API modes](/docs/admin).
+     * query params to filter your results.
      *
      * @param {string} functionId
      * @param {string[]} queries

package/lib/services/graphql.js

@@ -0,0 +1,72 @@
+const Service = require('../service.js');
+const AppwriteException = require('../exception.js');
+const InputFile = require('../inputFile.js');
+const client = require('../client.js');
+const Stream = require('stream');
+const { promisify } = require('util');
+const fs = require('fs');
+
+class Graphql extends Service {
+
+     constructor(client)
+     {
+        super(client);
+     }
+
+
+    /**
+     * GraphQL Endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async query(query) {
+        let path = '/graphql';
+        let payload = {};
+        if (typeof query === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "query"');
+        }
+
+
+        if (typeof query !== 'undefined') {
+            payload['query'] = query;
+        }
+
+        return await this.client.call('post', path, {
+            'x-sdk-graphql': 'true',
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * GraphQL Endpoint
+     *
+     * Execute a GraphQL mutation.
+     *
+     * @param {object} query
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async mutation(query) {
+        let path = '/graphql/mutation';
+        let payload = {};
+        if (typeof query === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "query"');
+        }
+
+
+        if (typeof query !== 'undefined') {
+            payload['query'] = query;
+        }
+
+        return await this.client.call('post', path, {
+            'x-sdk-graphql': 'true',
+            'content-type': 'application/json',
+        }, payload);
+    }
+}
+
+module.exports = Graphql;

package/lib/services/storage.js

@@ -237,8 +237,7 @@ class Storage extends Service {
      * List Files
      *
      * Get a list of all the user files. You can use the query params to filter
-     * your results. On admin mode, this endpoint will return a list of all of the
-     * project's files. [Learn more about different API modes](/docs/admin).
+     * your results.
      *
      * @param {string} bucketId
      * @param {string[]} queries
@@ -389,48 +388,56 @@ class Storage extends Service {
 
         return await new Promise((resolve, reject) => {
             const writeStream = new Stream.Writable();
-            writeStream._write = async (mainChunk, encoding, next) => {
-                // Segment incoming chunk into up to 5MB chunks
-                const mainChunkSize = Buffer.byteLength(mainChunk);
-                const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
-                const chunks = [];
-
-                for(let i = 0; i < chunksCount; i++) {
-                    const chunk = mainChunk.slice(i * client.CHUNK_SIZE, client.CHUNK_SIZE);
-                    chunks.push(chunk);
-                }
+            writeStream._write = async (mainChunk, encoding, callback) => {
+                try {
+                    // Segment incoming chunk into up to 5MB chunks
+                    const mainChunkSize = Buffer.byteLength(mainChunk);
+                    const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
+                    const chunks = [];
+
+                    for(let i = 0; i < chunksCount; i++) {
+                        const chunk = mainChunk.slice(i * client.CHUNK_SIZE, (i + 1) * client.CHUNK_SIZE);
+                        chunks.push(chunk);
+                    }
 
-                for (const chunk of chunks) {
-                    const chunkSize = Buffer.byteLength(chunk);
-
-                    if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
-                        // Upload chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        await uploadChunk();
-                        currentChunk = Buffer.from('');
-                        currentChunkSize = 0;
-                    } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
-                        // Upload chunk, put rest into next chunk
-                        const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
-                        const newChunkSection = chunk.slice(0, bytesToUpload);
-                        currentChunk = Buffer.concat([currentChunk, newChunkSection]);
-                        currentChunkSize = Buffer.byteLength(currentChunk);
-                        await uploadChunk();
-                        currentChunk = chunk.slice(bytesToUpload, undefined);
-                        currentChunkSize = chunkSize - bytesToUpload;
-                    } else {
-                        // Append into current chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        currentChunkSize = chunkSize + currentChunkSize;
+                    for (const chunk of chunks) {
+                        const chunkSize = Buffer.byteLength(chunk);
+
+                        if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
+                            // Upload chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            await uploadChunk();
+                            currentChunk = Buffer.from('');
+                            currentChunkSize = 0;
+                        } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
+                            // Upload chunk, put rest into next chunk
+                            const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
+                            const newChunkSection = chunk.slice(0, bytesToUpload);
+                            currentChunk = Buffer.concat([currentChunk, newChunkSection]);
+                            currentChunkSize = Buffer.byteLength(currentChunk);
+                            await uploadChunk();
+                            currentChunk = chunk.slice(bytesToUpload, undefined);
+                            currentChunkSize = chunkSize - bytesToUpload;
+                        } else {
+                            // Append into current chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            currentChunkSize = chunkSize + currentChunkSize;
+                        }
                     }
-                }
 
-                next();
+                    callback();
+                } catch (e) {
+                    callback(e);
+                }
             }
 
             writeStream.on("finish", async () => {
                 if(currentChunkSize > 0) {
-                    await uploadChunk(true);
+                    try {
+                        await uploadChunk(true);
+                    } catch (e) {
+                        reject(e);
+                    }
                 }
                 
                 resolve(response);

package/lib/services/teams.js

@@ -18,10 +18,7 @@ class Teams extends Service {
      * List Teams
      *
      * Get a list of all the teams in which the current user is a member. You can
-     * use the parameters to filter your results.
-     * 
-     * In admin mode, this endpoint returns a list of all the teams in the current
-     * project. [Learn more about different API modes](/docs/admin).
+     * use the parameters to filter your results.
      *
      * @param {string[]} queries
      * @param {string} search
@@ -110,17 +107,16 @@ class Teams extends Service {
     }
 
     /**
-     * Update Team
+     * Update Name
      *
-     * Update a team using its ID. Only members with the owner role can update the
-     * team.
+     * Update the team's name by its unique ID.
      *
      * @param {string} teamId
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async update(teamId, name) {
+    async updateName(teamId, name) {
         let path = '/teams/{teamId}'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
@@ -200,41 +196,45 @@ class Teams extends Service {
     /**
      * Create Team Membership
      *
-     * Invite a new member to join your team. If initiated from the client SDK, an
-     * email with a link to join the team will be sent to the member's email
-     * address and an account will be created for them should they not be signed
-     * up already. If initiated from server-side SDKs, the new member will
-     * automatically be added to the team.
+     * Invite a new member to join your team. Provide an ID for existing users, or
+     * invite unregistered users using an email or phone number. If initiated from
+     * a Client SDK, Appwrite will send an email or sms with a link to join the
+     * team to the invited user, and an account will be created for them if one
+     * doesn't exist. If initiated from a Server SDK, the new member will be added
+     * automatically to the team.
      * 
-     * Use the 'url' parameter to redirect the user from the invitation email back
-     * to your app. When the user is redirected, use the [Update Team Membership
+     * You only need to provide one of a user ID, email, or phone number. Appwrite
+     * will prioritize accepting the user ID > email > phone number if you provide
+     * more than one of these parameters.
+     * 
+     * Use the `url` parameter to redirect the user from the invitation email to
+     * your app. After the user is redirected, use the [Update Team Membership
      * Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow
      * the user to accept the invitation to the team. 
      * 
      * Please note that to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md)
-     * the only valid redirect URL's are the once from domains you have set when
-     * adding your platforms in the console interface.
+     * Appwrite will accept the only redirect URLs under the domains you have
+     * added as a platform on the Appwrite Console.
+     * 
      *
      * @param {string} teamId
-     * @param {string} email
      * @param {string[]} roles
      * @param {string} url
+     * @param {string} email
+     * @param {string} userId
+     * @param {string} phone
      * @param {string} name
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createMembership(teamId, email, roles, url, name) {
+    async createMembership(teamId, roles, url, email, userId, phone, name) {
         let path = '/teams/{teamId}/memberships'.replace('{teamId}', teamId);
         let payload = {};
         if (typeof teamId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "teamId"');
         }
 
-        if (typeof email === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "email"');
-        }
-
         if (typeof roles === 'undefined') {
             throw new AppwriteException('Missing required parameter: "roles"');
         }
@@ -248,6 +248,14 @@ class Teams extends Service {
             payload['email'] = email;
         }
 
+        if (typeof userId !== 'undefined') {
+            payload['userId'] = userId;
+        }
+
+        if (typeof phone !== 'undefined') {
+            payload['phone'] = phone;
+        }
+
         if (typeof roles !== 'undefined') {
             payload['roles'] = roles;
         }
@@ -410,6 +418,63 @@ class Teams extends Service {
             'content-type': 'application/json',
         }, payload);
     }
+
+    /**
+     * Get Team Preferences
+     *
+     * Get the team's shared preferences by its unique ID. If a preference doesn't
+     * need to be shared by all team members, prefer storing them in [user
+     * preferences](/docs/client/account#accountGetPrefs).
+     *
+     * @param {string} teamId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getPrefs(teamId) {
+        let path = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+        let payload = {};
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update Preferences
+     *
+     * Update the team's preferences by its unique ID. The object you pass is
+     * stored as is and replaces any previous value. The maximum allowed prefs
+     * size is 64kB and throws an error if exceeded.
+     *
+     * @param {string} teamId
+     * @param {object} prefs
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updatePrefs(teamId, prefs) {
+        let path = '/teams/{teamId}/prefs'.replace('{teamId}', teamId);
+        let payload = {};
+        if (typeof teamId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "teamId"');
+        }
+
+        if (typeof prefs === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "prefs"');
+        }
+
+
+        if (typeof prefs !== 'undefined') {
+            payload['prefs'] = prefs;
+        }
+
+        return await this.client.call('put', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
 }
 
 module.exports = Teams;

package/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": "8.1.0",
+  "version": "9.0.0",
   "license": "BSD-3-Clause",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -10,9 +10,11 @@
     "type": "git",
     "url": "https://github.com/appwrite/sdk-for-node"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@types/node": "^18.16.1"
+  },
   "dependencies": {
-    "axios": "^0.27.2",
+    "axios": "^1.3.6",
     "form-data": "^4.0.0"
   }
-}
+}

package/docs/examples/locale/get-countries.md

@@ -1,20 +0,0 @@
-const sdk = require('node-appwrite');
-
-// Init SDK
-const client = new sdk.Client();
-
-const locale = new sdk.Locale(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
-
-const promise = locale.getCountries();
-
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});

package/docs/examples/teams/update.md

@@ -1,20 +0,0 @@
-const sdk = require('node-appwrite');
-
-// Init SDK
-const client = new sdk.Client();
-
-const teams = new sdk.Teams(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
-
-const promise = teams.update('[TEAM_ID]', '[NAME]');
-
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});

package/docs/examples/users/get-logs.md

@@ -1,20 +0,0 @@
-const sdk = require('node-appwrite');
-
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
-
-const promise = users.getLogs('[USER_ID]');
-
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});

package/docs/examples/users/get-memberships.md

@@ -1,20 +0,0 @@
-const sdk = require('node-appwrite');
-
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
-
-const promise = users.getMemberships('[USER_ID]');
-
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});

package/docs/examples/users/get-sessions.md

@@ -1,20 +0,0 @@
-const sdk = require('node-appwrite');
-
-// Init SDK
-const client = new sdk.Client();
-
-const users = new sdk.Users(client);
-
-client
-    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
-    .setProject('5df5acd0d48c2') // Your project ID
-    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
-;
-
-const promise = users.getSessions('[USER_ID]');
-
-promise.then(function (response) {
-    console.log(response);
-}, function (error) {
-    console.log(error);
-});