node-appwrite 8.2.0 → 10.0.0

package/lib/client.js

@@ -1,3 +1,4 @@
+const os = require('os');
 const URL = require('url').URL;
 const axios = require('axios');
 const FormData = require('form-data');
@@ -9,12 +10,14 @@ class Client {
     constructor() {
         this.endpoint = 'https://HOSTNAME/v1';
         this.headers = {
+            'accept-encoding': '*',
             'content-type': '',
+            'user-agent' : `AppwriteNodeJSSDK/10.0.0 (${os.type()}; ${os.version()}; ${os.arch()})`,
             'x-sdk-name': 'Node.js',
             'x-sdk-platform': 'server',
             'x-sdk-language': 'nodejs',
-            'x-sdk-version': '8.2.0',
-            'X-Appwrite-Response-Format' : '1.0.0',
+            'x-sdk-version': '10.0.0',
+            'X-Appwrite-Response-Format' : '1.4.0',
         };
         this.selfSigned = false;
     }

package/lib/inputFile.js

@@ -1,6 +1,5 @@
 const { Readable } = require('stream');
 const fs = require('fs');
-const { promisify } = require('util');
 
 class InputFile {
   stream; // Content of file, readable stream
@@ -14,16 +13,15 @@ class InputFile {
   };
 
   static fromBuffer = (buffer, filename) => {
-    const stream = Readable.from(buffer.toString());
+    const stream = Readable.from(buffer);
     const size = Buffer.byteLength(buffer);
     return new InputFile(stream, filename, size);
   };
 
-  static fromBlob = (blob, filename) => {
-    const buffer = blob.arrayBuffer();
-    const stream = Readable.from(buffer.toString());
-    const size = Buffer.byteLength(buffer);
-    return new InputFile(stream, filename);
+  static fromBlob = async (blob, filename) => {
+    const arrayBuffer = await blob.arrayBuffer();
+    const buffer = Buffer.from(arrayBuffer);
+    return InputFile.fromBuffer(buffer, filename);
   };
 
   static fromStream = (stream, filename, size) => {
@@ -32,7 +30,7 @@ class InputFile {
 
   static fromPlainText = (content, filename) => {
     const buffer = Buffer.from(content, "utf-8");
-    const stream = Readable.from(buffer.toString());
+    const stream = Readable.from(buffer);
     const size = Buffer.byteLength(buffer);
     return new InputFile(stream, filename, size);
   };

package/lib/query.js

@@ -17,6 +17,24 @@ class Query {
   static greaterThanEqual = (attribute, value) =>
     Query.addQuery(attribute, "greaterThanEqual", value);
 
+  static isNull = (attribute) =>
+    `isNull("${attribute}")`;
+
+  static isNotNull = (attribute) =>
+    `isNotNull("${attribute}")`;
+
+  static between = (attribute, start, end) =>
+    Query.addQuery(attribute, "between", [start, end]);
+
+  static startsWith = (attribute, value) =>
+    Query.addQuery(attribute, "startsWith", value);
+
+  static endsWith = (attribute, value) =>
+    Query.addQuery(attribute, "endsWith", value);
+
+  static select = (attributes) =>
+    `select([${attributes.map((attr) => `"${attr}"`).join(",")}])`;
+
   static search = (attribute, value) =>
     Query.addQuery(attribute, "search", value);
 

package/lib/services/account.js

@@ -17,16 +17,16 @@ class Account extends Service {
     /**
      * Get Account
      *
-     * Get currently logged in user data as JSON object.
+     * Get the currently logged in user.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async get() {
-        let path = '/account';
+        const apiPath = '/account';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -49,7 +49,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateEmail(email, password) {
-        let path = '/account/email';
+        const apiPath = '/account/email';
         let payload = {};
         if (typeof email === 'undefined') {
             throw new AppwriteException('Missing required parameter: "email"');
@@ -68,7 +68,51 @@ class Account extends Service {
             payload['password'] = password;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Identities
+     *
+     * Get the list of identities for the currently logged in user.
+     *
+     * @param {string} queries
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async listIdentities(queries) {
+        const apiPath = '/account/identities';
+        let payload = {};
+
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
+        }
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete Identity
+     *
+     * Delete an identity by its unique ID.
+     *
+     * @param {string} identityId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async deleteIdentity(identityId) {
+        const apiPath = '/account/identities/{identityId}'.replace('{identityId}', identityId);
+        let payload = {};
+        if (typeof identityId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "identityId"');
+        }
+
+
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -76,22 +120,22 @@ class Account extends Service {
     /**
      * List Logs
      *
-     * Get currently logged in user list of latest security activity logs. Each
-     * log returns user IP address, location and date and time of log.
+     * Get the list of latest security activity logs for the currently logged in
+     * user. Each log returns user IP address, location and date and time of log.
      *
      * @param {string[]} queries
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async listLogs(queries) {
-        let path = '/account/logs';
+        const apiPath = '/account/logs';
         let payload = {};
 
         if (typeof queries !== 'undefined') {
             payload['queries'] = queries;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -106,7 +150,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateName(name) {
-        let path = '/account/name';
+        const apiPath = '/account/name';
         let payload = {};
         if (typeof name === 'undefined') {
             throw new AppwriteException('Missing required parameter: "name"');
@@ -117,7 +161,7 @@ class Account extends Service {
             payload['name'] = name;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -135,7 +179,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePassword(password, oldPassword) {
-        let path = '/account/password';
+        const apiPath = '/account/password';
         let payload = {};
         if (typeof password === 'undefined') {
             throw new AppwriteException('Missing required parameter: "password"');
@@ -150,7 +194,7 @@ class Account extends Service {
             payload['oldPassword'] = oldPassword;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -170,7 +214,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePhone(phone, password) {
-        let path = '/account/phone';
+        const apiPath = '/account/phone';
         let payload = {};
         if (typeof phone === 'undefined') {
             throw new AppwriteException('Missing required parameter: "phone"');
@@ -189,7 +233,7 @@ class Account extends Service {
             payload['password'] = password;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -197,16 +241,16 @@ class Account extends Service {
     /**
      * Get Account Preferences
      *
-     * Get currently logged in user preferences as a key-value object.
+     * Get the preferences as a key-value object for the currently logged in user.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async getPrefs() {
-        let path = '/account/prefs';
+        const apiPath = '/account/prefs';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -223,7 +267,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePrefs(prefs) {
-        let path = '/account/prefs';
+        const apiPath = '/account/prefs';
         let payload = {};
         if (typeof prefs === 'undefined') {
             throw new AppwriteException('Missing required parameter: "prefs"');
@@ -234,7 +278,7 @@ class Account extends Service {
             payload['prefs'] = prefs;
         }
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -257,7 +301,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async createRecovery(email, url) {
-        let path = '/account/recovery';
+        const apiPath = '/account/recovery';
         let payload = {};
         if (typeof email === 'undefined') {
             throw new AppwriteException('Missing required parameter: "email"');
@@ -276,7 +320,7 @@ class Account extends Service {
             payload['url'] = url;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -302,7 +346,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateRecovery(userId, secret, password, passwordAgain) {
-        let path = '/account/recovery';
+        const apiPath = '/account/recovery';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -337,7 +381,7 @@ class Account extends Service {
             payload['passwordAgain'] = passwordAgain;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -345,17 +389,17 @@ class Account extends Service {
     /**
      * List Sessions
      *
-     * Get currently logged in user list of active sessions across different
-     * devices.
+     * Get the list of active sessions across different devices for the currently
+     * logged in user.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async listSessions() {
-        let path = '/account/sessions';
+        const apiPath = '/account/sessions';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -370,10 +414,10 @@ class Account extends Service {
      * @returns {Promise}
      */
     async deleteSessions() {
-        let path = '/account/sessions';
+        const apiPath = '/account/sessions';
         let payload = {};
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -389,14 +433,14 @@ class Account extends Service {
      * @returns {Promise}
      */
     async getSession(sessionId) {
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        const apiPath = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
         let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -413,14 +457,14 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateSession(sessionId) {
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        const apiPath = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
         let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -428,24 +472,24 @@ class Account extends Service {
     /**
      * Delete Session
      *
-     * Use this endpoint to log out the currently logged in user from all their
-     * account sessions across all of their different devices. When using the
-     * Session ID argument, only the unique session ID provided is deleted.
-     * 
+     * Logout the user. Use 'current' as the session ID to logout on this device,
+     * use a session ID to logout on another device. If you're looking to logout
+     * the user on all devices, use [Delete
+     * Sessions](/docs/client/account#accountDeleteSessions) instead.
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async deleteSession(sessionId) {
-        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        const apiPath = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
         let payload = {};
         if (typeof sessionId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "sessionId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -461,10 +505,10 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateStatus() {
-        let path = '/account/status';
+        const apiPath = '/account/status';
         let payload = {};
 
-        return await this.client.call('patch', path, {
+        return await this.client.call('patch', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -493,7 +537,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async createVerification(url) {
-        let path = '/account/verification';
+        const apiPath = '/account/verification';
         let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
@@ -504,7 +548,7 @@ class Account extends Service {
             payload['url'] = url;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -523,7 +567,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updateVerification(userId, secret) {
-        let path = '/account/verification';
+        const apiPath = '/account/verification';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -542,7 +586,7 @@ class Account extends Service {
             payload['secret'] = secret;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -561,10 +605,10 @@ class Account extends Service {
      * @returns {Promise}
      */
     async createPhoneVerification() {
-        let path = '/account/verification/phone';
+        const apiPath = '/account/verification/phone';
         let payload = {};
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -583,7 +627,7 @@ class Account extends Service {
      * @returns {Promise}
      */
     async updatePhoneVerification(userId, secret) {
-        let path = '/account/verification/phone';
+        const apiPath = '/account/verification/phone';
         let payload = {};
         if (typeof userId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "userId"');
@@ -602,7 +646,7 @@ class Account extends Service {
             payload['secret'] = secret;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }

package/lib/services/avatars.js

@@ -35,7 +35,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getBrowser(code, width, height, quality) {
-        let path = '/avatars/browsers/{code}'.replace('{code}', code);
+        const apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
         let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
@@ -54,7 +54,7 @@ class Avatars extends Service {
             payload['quality'] = quality;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -80,7 +80,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getCreditCard(code, width, height, quality) {
-        let path = '/avatars/credit-cards/{code}'.replace('{code}', code);
+        const apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
         let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
@@ -99,7 +99,7 @@ class Avatars extends Service {
             payload['quality'] = quality;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -116,7 +116,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getFavicon(url) {
-        let path = '/avatars/favicon';
+        const apiPath = '/avatars/favicon';
         let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
@@ -127,7 +127,7 @@ class Avatars extends Service {
             payload['url'] = url;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -154,7 +154,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getFlag(code, width, height, quality) {
-        let path = '/avatars/flags/{code}'.replace('{code}', code);
+        const apiPath = '/avatars/flags/{code}'.replace('{code}', code);
         let payload = {};
         if (typeof code === 'undefined') {
             throw new AppwriteException('Missing required parameter: "code"');
@@ -173,7 +173,7 @@ class Avatars extends Service {
             payload['quality'] = quality;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -199,7 +199,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getImage(url, width, height) {
-        let path = '/avatars/image';
+        const apiPath = '/avatars/image';
         let payload = {};
         if (typeof url === 'undefined') {
             throw new AppwriteException('Missing required parameter: "url"');
@@ -218,7 +218,7 @@ class Avatars extends Service {
             payload['height'] = height;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -251,7 +251,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getInitials(name, width, height, background) {
-        let path = '/avatars/initials';
+        const apiPath = '/avatars/initials';
         let payload = {};
 
         if (typeof name !== 'undefined') {
@@ -270,7 +270,7 @@ class Avatars extends Service {
             payload['background'] = background;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -290,7 +290,7 @@ class Avatars extends Service {
      * @returns {Promise}
      */
     async getQR(text, size, margin, download) {
-        let path = '/avatars/qr';
+        const apiPath = '/avatars/qr';
         let payload = {};
         if (typeof text === 'undefined') {
             throw new AppwriteException('Missing required parameter: "text"');
@@ -313,7 +313,7 @@ class Avatars extends Service {
             payload['download'] = download;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }