node-appwrite 5.1.0 → 6.0.0

package/README.md

@@ -1,12 +1,12 @@
 # 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-0.13.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.14.0-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)
 
-**This SDK is compatible with Appwrite server version 0.13.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
+**This SDK is compatible with Appwrite server version 0.14.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-node/releases).**
 
  > 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)

package/docs/examples/account/{delete.md → update-status.md}

@@ -11,7 +11,7 @@ client
     .setJWT('eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...') // Your secret JSON Web Token
 ;
 
-let promise = account.delete();
+let promise = account.updateStatus();
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/functions/create-deployment.md

@@ -12,7 +12,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = functions.createDeployment('[FUNCTION_ID]', '[ENTRYPOINT]', fs.createReadStream(__dirname + '/file.png'), false);
+let promise = functions.createDeployment('[FUNCTION_ID]', '[ENTRYPOINT]', 'file.png', false);
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/storage/create-file.md

@@ -12,7 +12,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = storage.createFile('[BUCKET_ID]', '[FILE_ID]', fs.createReadStream(__dirname + '/file.png'));
+let promise = storage.createFile('[BUCKET_ID]', '[FILE_ID]', 'file.png');
 
 promise.then(function (response) {
     console.log(response);

package/docs/examples/{health/get-queue-usage.md → users/get-memberships.md}

@@ -3,7 +3,7 @@ const sdk = require('node-appwrite');
 // Init SDK
 let client = new sdk.Client();
 
-let health = new sdk.Health(client);
+let users = new sdk.Users(client);
 
 client
     .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
@@ -11,7 +11,7 @@ client
     .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
 ;
 
-let promise = health.getQueueUsage();
+let promise = users.getMemberships('[USER_ID]');
 
 promise.then(function (response) {
     console.log(response);

package/index.d.ts

@@ -1037,17 +1037,21 @@ declare module "node-appwrite" {
           */
           userId: string;
           /**
-          * Team ID.
-          */
-          teamId: string;
-          /**
           * User name.
           */
-          name: string;
+          userName: string;
           /**
           * User email address.
           */
-          email: string;
+          userEmail: string;
+          /**
+          * Team ID.
+          */
+          teamId: string;
+          /**
+          * Team name.
+          */
+          teamName: string;
           /**
           * Date, the user has been invited to join the team in Unix timestamp.
           */
@@ -1241,9 +1245,9 @@ declare module "node-appwrite" {
           */
           statusCode: number;
           /**
-          * The script stdout output string. Logs the last 4,000 characters of the execution stdout output.
+          * The script response output string. Logs the last 4,000 characters of the execution response output.
           */
-          stdout: string;
+          response: string;
           /**
           * The script stderr output string. Logs the last 4,000 characters of the execution stderr output
           */
@@ -1506,19 +1510,6 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     get<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
-    /**
-     * Delete Account
-     *
-     * Delete a currently logged in user account. Behind the scene, the user
-     * record is not deleted but permanently blocked from any access. This is done
-     * to avoid deleted accounts being overtaken by new users with the same email
-     * address. Any user-related resources like documents or storage files should
-     * be deleted separately.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    delete(): Promise<Response>;
     /**
      * Update Account Email
      *
@@ -1564,7 +1555,7 @@ declare module "node-appwrite" {
      *
      * Update currently logged in user password. For validation, user is required
      * to pass in the new password, and the old password. For users created with
-     * OAuth and Team Invites, oldPassword is optional.
+     * OAuth, Team Invites and Magic URL, oldPassword is optional.
      *
      * @param {string} password
      * @param {string} oldPassword
@@ -1666,6 +1657,10 @@ declare module "node-appwrite" {
     /**
      * Update Session (Refresh Tokens)
      *
+     * Access tokens have limited lifespan and expire to mitigate security risks.
+     * If session was created using an OAuth provider, this route can be used to
+     * "refresh" the access token.
+     *
      * @param {string} sessionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -1684,6 +1679,17 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     deleteSession(sessionId: string): Promise<Response>;
+    /**
+     * Update Account Status
+     *
+     * Block the currently logged in user account. Behind the scene, the user
+     * record is not deleted but permanently blocked from any access. To
+     * completely delete a user, use the Users API instead.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    updateStatus<Preferences extends Models.Preferences>(): Promise<Models.User<Preferences>>;
     /**
      * Create Email Verification
      *
@@ -1728,9 +1734,14 @@ declare module "node-appwrite" {
      * Get Browser Icon
      *
      * You can use this endpoint to show different browser icons to your users.
-     * The code argument receives the browser code as it appears in your user
-     * /account/sessions endpoint. Use width, height and quality arguments to
-     * change the output settings.
+     * The code argument receives the browser code as it appears in your user [GET
+     * /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+     * width, height and quality arguments to change the output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
      *
      * @param {string} code
      * @param {number} width
@@ -1746,6 +1757,12 @@ declare module "node-appwrite" {
      * The credit card endpoint will return you the icon of the credit card
      * provider you need. Use width, height and quality arguments to change the
      * output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} code
      * @param {number} width
@@ -1773,6 +1790,12 @@ declare module "node-appwrite" {
      * You can use this endpoint to show different country flags icons to your
      * users. The code argument receives the 2 letter country code. Use width,
      * height and quality arguments to change the output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} code
      * @param {number} width
@@ -1789,6 +1812,12 @@ declare module "node-appwrite" {
      * you want. This endpoint is very useful if you need to crop and display
      * remote images in your app or in case you want to make sure a 3rd party
      * image is properly served using a TLS protocol.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 400x400px.
+     * 
      *
      * @param {string} url
      * @param {number} width
@@ -1810,6 +1839,12 @@ declare module "node-appwrite" {
      * default, a random theme will be selected. The random theme will persist for
      * the user's initials when reloading the same theme will always return for
      * the same initials.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} name
      * @param {number} width
@@ -1825,6 +1860,7 @@ declare module "node-appwrite" {
      *
      * Converts a given plain text to a QR code image. You can use the query
      * parameters to change the size and style of the resulting image.
+     * 
      *
      * @param {string} text
      * @param {number} size
@@ -2123,9 +2159,7 @@ declare module "node-appwrite" {
     /**
      * Delete Document
      *
-     * Delete a document by its unique ID. This endpoint deletes only the parent
-     * documents, its attributes and relations to other documents. Child documents
-     * **will not** be deleted.
+     * Delete a document by its unique ID.
      *
      * @param {string} collectionId
      * @param {string} documentId
@@ -2209,7 +2243,7 @@ declare module "node-appwrite" {
      */
     create(functionId: string, name: string, execute: string[], runtime: string, vars?: object, events?: string[], schedule?: string, timeout?: number): Promise<Models.Function>;
     /**
-     * List the currently active function runtimes.
+     * List runtimes
      *
      * Get a list of all runtimes that are currently active on your instance.
      *
@@ -2448,16 +2482,6 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     getQueueLogs(): Promise<Models.HealthQueue>;
-    /**
-     * Get Usage Queue
-     *
-     * Get the number of usage stats that are waiting to be processed in the
-     * Appwrite internal queue server.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    getQueueUsage(): Promise<Models.HealthQueue>;
     /**
      * Get Webhooks Queue
      *
@@ -3000,7 +3024,11 @@ declare module "node-appwrite" {
     /**
      * Delete User
      *
-     * Delete a user by its unique ID.
+     * Delete a user by its unique ID, thereby releasing it's ID. Since ID is
+     * released and can be reused, all user-related resources like documents or
+     * storage files should be deleted before user deletion. If you want to keep
+     * ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus)
+     * endpoint instead.
      *
      * @param {string} userId
      * @throws {AppwriteException}
@@ -3030,6 +3058,16 @@ declare module "node-appwrite" {
      * @returns {Promise}
      */
     getLogs(userId: string, limit?: number, offset?: number): Promise<Models.LogList>;
+    /**
+     * Get User Memberships
+     *
+     * Get the user membership list by its unique ID.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    getMemberships(userId: string): Promise<Models.MembershipList>;
     /**
      * Update Name
      *
@@ -3109,7 +3147,8 @@ declare module "node-appwrite" {
     /**
      * Update User Status
      *
-     * Update the user status by its unique ID.
+     * Update the user status by its unique ID. Use this endpoint as an
+     * alternative to deleting a user if you want to keep user's ID reserved.
      *
      * @param {string} userId
      * @param {boolean} status

package/lib/client.js

@@ -10,8 +10,8 @@ class Client {
         this.endpoint = 'https://HOSTNAME/v1';
         this.headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:nodejs:5.1.0',
-            'X-Appwrite-Response-Format' : '0.13.0',
+            'x-sdk-version': 'appwrite:nodejs:6.0.0',
+            'X-Appwrite-Response-Format' : '0.14.0',
         };
         this.selfSigned = false;
     }

package/lib/services/account.js

@@ -23,27 +23,6 @@ class Account extends Service {
         }, payload);
     }
 
-    /**
-     * Delete Account
-     *
-     * Delete a currently logged in user account. Behind the scene, the user
-     * record is not deleted but permanently blocked from any access. This is done
-     * to avoid deleted accounts being overtaken by new users with the same email
-     * address. Any user-related resources like documents or storage files should
-     * be deleted separately.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    async delete() {
-        let path = '/account';
-        let payload = {};
-
-        return await this.client.call('delete', path, {
-            'content-type': 'application/json',
-        }, payload);
-    }
-
     /**
      * Update Account Email
      *
@@ -145,7 +124,7 @@ class Account extends Service {
      *
      * Update currently logged in user password. For validation, user is required
      * to pass in the new password, and the old password. For users created with
-     * OAuth and Team Invites, oldPassword is optional.
+     * OAuth, Team Invites and Magic URL, oldPassword is optional.
      *
      * @param {string} password
      * @param {string} oldPassword
@@ -383,6 +362,10 @@ class Account extends Service {
     /**
      * Update Session (Refresh Tokens)
      *
+     * Access tokens have limited lifespan and expire to mitigate security risks.
+     * If session was created using an OAuth provider, this route can be used to
+     * "refresh" the access token.
+     *
      * @param {string} sessionId
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -425,6 +408,25 @@ class Account extends Service {
         }, payload);
     }
 
+    /**
+     * Update Account Status
+     *
+     * Block the currently logged in user account. Behind the scene, the user
+     * record is not deleted but permanently blocked from any access. To
+     * completely delete a user, use the Users API instead.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updateStatus() {
+        let path = '/account/status';
+        let payload = {};
+
+        return await this.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Create Email Verification
      *

package/lib/services/avatars.js

@@ -10,9 +10,14 @@ class Avatars extends Service {
      * Get Browser Icon
      *
      * You can use this endpoint to show different browser icons to your users.
-     * The code argument receives the browser code as it appears in your user
-     * /account/sessions endpoint. Use width, height and quality arguments to
-     * change the output settings.
+     * The code argument receives the browser code as it appears in your user [GET
+     * /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use
+     * width, height and quality arguments to change the output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
      *
      * @param {string} code
      * @param {number} width
@@ -52,6 +57,12 @@ class Avatars extends Service {
      * The credit card endpoint will return you the icon of the credit card
      * provider you need. Use width, height and quality arguments to change the
      * output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} code
      * @param {number} width
@@ -119,6 +130,12 @@ class Avatars extends Service {
      * You can use this endpoint to show different country flags icons to your
      * users. The code argument receives the 2 letter country code. Use width,
      * height and quality arguments to change the output settings.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} code
      * @param {number} width
@@ -159,6 +176,12 @@ class Avatars extends Service {
      * you want. This endpoint is very useful if you need to crop and display
      * remote images in your app or in case you want to make sure a 3rd party
      * image is properly served using a TLS protocol.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 400x400px.
+     * 
      *
      * @param {string} url
      * @param {number} width
@@ -204,6 +227,12 @@ class Avatars extends Service {
      * default, a random theme will be selected. The random theme will persist for
      * the user's initials when reloading the same theme will always return for
      * the same initials.
+     * 
+     * When one dimension is specified and the other is 0, the image is scaled
+     * with preserved aspect ratio. If both dimensions are 0, the API provides an
+     * image at source quality. If dimensions are not specified, the default size
+     * of image returned is 100x100px.
+     * 
      *
      * @param {string} name
      * @param {number} width
@@ -247,6 +276,7 @@ class Avatars extends Service {
      *
      * Converts a given plain text to a QR code image. You can use the query
      * parameters to change the size and style of the resulting image.
+     * 
      *
      * @param {string} text
      * @param {number} size

package/lib/services/database.js

@@ -925,9 +925,7 @@ class Database extends Service {
     /**
      * Delete Document
      *
-     * Delete a document by its unique ID. This endpoint deletes only the parent
-     * documents, its attributes and relations to other documents. Child documents
-     * **will not** be deleted.
+     * Delete a document by its unique ID.
      *
      * @param {string} collectionId
      * @param {string} documentId

package/lib/services/functions.js

@@ -130,7 +130,7 @@ class Functions extends Service {
     }
 
     /**
-     * List the currently active function runtimes.
+     * List runtimes
      *
      * Get a list of all runtimes that are currently active on your instance.
      *

package/lib/services/health.js

@@ -127,24 +127,6 @@ class Health extends Service {
         }, payload);
     }
 
-    /**
-     * Get Usage Queue
-     *
-     * Get the number of usage stats that are waiting to be processed in the
-     * Appwrite internal queue server.
-     *
-     * @throws {AppwriteException}
-     * @returns {Promise}
-     */
-    async getQueueUsage() {
-        let path = '/health/queue/usage';
-        let payload = {};
-
-        return await this.client.call('get', path, {
-            'content-type': 'application/json',
-        }, payload);
-    }
-
     /**
      * Get Webhooks Queue
      *

package/lib/services/users.js

@@ -128,7 +128,11 @@ class Users extends Service {
     /**
      * Delete User
      *
-     * Delete a user by its unique ID.
+     * Delete a user by its unique ID, thereby releasing it's ID. Since ID is
+     * released and can be reused, all user-related resources like documents or
+     * storage files should be deleted before user deletion. If you want to keep
+     * ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus)
+     * endpoint instead.
      *
      * @param {string} userId
      * @throws {AppwriteException}
@@ -210,6 +214,28 @@ class Users extends Service {
         }, payload);
     }
 
+    /**
+     * Get User Memberships
+     *
+     * Get the user membership list by its unique ID.
+     *
+     * @param {string} userId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getMemberships(userId) {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        let path = '/users/{userId}/memberships'.replace('{userId}', userId);
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Update Name
      *
@@ -401,7 +427,8 @@ class Users extends Service {
     /**
      * Update User Status
      *
-     * Update the user status by its unique ID.
+     * Update the user status by its unique ID. Use this endpoint as an
+     * alternative to deleting a user if you want to keep user's ID reserved.
      *
      * @param {string} userId
      * @param {boolean} status

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": "5.1.0",
+  "version": "6.0.0",
   "license": "BSD-3-Clause",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -12,7 +12,7 @@
   },
   "devDependencies": {},
   "dependencies": {
-    "axios": "^0.26.1",
+    "axios": "^0.27.2",
     "form-data": "^4.0.0"
   }
 }