node-appwrite 5.0.0 → 7.0.0

package/index.js

@@ -1,9 +1,10 @@
 const Client = require('./lib/client.js');
 const Query = require('./lib/query.js');
+const InputFile = require('./lib/inputFile.js');
 const AppwriteException = require('./lib/exception.js');
 const Account = require('./lib/services/account.js');
 const Avatars = require('./lib/services/avatars.js');
-const Database = require('./lib/services/database.js');
+const Databases = require('./lib/services/databases.js');
 const Functions = require('./lib/services/functions.js');
 const Health = require('./lib/services/health.js');
 const Locale = require('./lib/services/locale.js');
@@ -14,10 +15,11 @@ const Users = require('./lib/services/users.js');
 module.exports = {
     Client,
     Query,
+    InputFile,
     AppwriteException,
     Account,
     Avatars,
-    Database,
+    Databases,
     Functions,
     Health,
     Locale,

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.0.0',
-            'X-Appwrite-Response-Format' : '0.13.0',
+            'x-sdk-version': 'appwrite:nodejs:7.0.0',
+            'X-Appwrite-Response-Format' : '0.15.0',
         };
         this.selfSigned = false;
     }
@@ -130,7 +130,13 @@ class Client {
             let flatParams = Client.flatten(params);
             
             for (const key in flatParams) {
-                form.append(key, flatParams[key])
+                const value = flatParams[key];
+
+                if(value && value.type && value.type === 'file') {
+                    form.append(key, value.file, { filename: value.filename });
+                } else {
+                    form.append(key, flatParams[key]);
+                }
             }
 
             headers = {

package/lib/inputFile.js

@@ -0,0 +1,47 @@
+const { Readable } = require('stream');
+const fs = require('fs');
+const { promisify } = require('util');
+
+class InputFile {
+  stream; // Content of file, readable stream
+  size; // Total final size of the file content
+  filename; // File name
+
+  static fromPath = (filePath, filename) => {
+    const stream = fs.createReadStream(filePath);
+    const { size } = fs.statSync(filePath);
+    return new InputFile(stream, filename, size);
+  };
+
+  static fromBuffer = (buffer, filename) => {
+    const stream = Readable.from(buffer.toString());
+    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 fromStream = (stream, filename, size) => {
+    return new InputFile(stream, filename, size);
+  };
+
+  static fromPlainText = (content, filename) => {
+    const buffer = Buffer.from(content, "utf-8");
+    const stream = Readable.from(buffer.toString());
+    const size = Buffer.byteLength(buffer);
+    return new InputFile(stream, filename, size);
+  };
+
+  constructor(stream, filename, size) {
+    this.stream = stream;
+    this.filename = filename;
+    this.size = size;
+  }
+}
+
+module.exports = InputFile;

package/lib/services/account.js

@@ -1,6 +1,8 @@
 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');
 
@@ -23,27 +25,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 +126,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
@@ -173,6 +154,44 @@ class Account extends Service {
         }, payload);
     }
 
+    /**
+     * Update Account Phone
+     *
+     * Update currently logged in user account phone number. After changing phone
+     * number, the user confirmation status will get reset. A new confirmation SMS
+     * is not sent automatically however you can use the phone confirmation
+     * endpoint again to send the confirmation SMS.
+     *
+     * @param {string} number
+     * @param {string} password
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updatePhone(number, password) {
+        if (typeof number === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "number"');
+        }
+
+        if (typeof password === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "password"');
+        }
+
+        let path = '/account/phone';
+        let payload = {};
+
+        if (typeof number !== 'undefined') {
+            payload['number'] = number;
+        }
+
+        if (typeof password !== 'undefined') {
+            payload['password'] = password;
+        }
+
+        return await this.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Get Account Preferences
      *
@@ -383,6 +402,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 +448,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
      *
@@ -435,8 +477,8 @@ class Account extends Service {
      * should redirect the user back to your app and allow you to complete the
      * verification process by verifying both the **userId** and **secret**
      * parameters. Learn more about how to [complete the verification
-     * process](/docs/client/account#accountUpdateVerification). The verification
-     * link sent to the user's email address is valid for 7 days.
+     * process](/docs/client/account#accountUpdateEmailVerification). The
+     * verification link sent to the user's email address is valid for 7 days.
      * 
      * Please note that in order to avoid a [Redirect
      * Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md),
@@ -502,6 +544,67 @@ class Account extends Service {
             'content-type': 'application/json',
         }, payload);
     }
+
+    /**
+     * Create Phone Verification
+     *
+     * Use this endpoint to send a verification message to your user's phone
+     * number to confirm they are the valid owners of that address. The provided
+     * secret should allow you to complete the verification process by verifying
+     * both the **userId** and **secret** parameters. Learn more about how to
+     * [complete the verification
+     * process](/docs/client/account#accountUpdatePhoneVerification). The
+     * verification link sent to the user's phone number is valid for 15 minutes.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async createPhoneVerification() {
+        let path = '/account/verification/phone';
+        let payload = {};
+
+        return await this.client.call('post', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create Phone Verification (confirmation)
+     *
+     * Use this endpoint to complete the user phone verification process. Use the
+     * **userId** and **secret** that were sent to your user's phone number to
+     * verify the user email ownership. If confirmed this route will return a 200
+     * status code.
+     *
+     * @param {string} userId
+     * @param {string} secret
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updatePhoneVerification(userId, secret) {
+        if (typeof userId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "userId"');
+        }
+
+        if (typeof secret === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "secret"');
+        }
+
+        let path = '/account/verification/phone';
+        let payload = {};
+
+        if (typeof userId !== 'undefined') {
+            payload['userId'] = userId;
+        }
+
+        if (typeof secret !== 'undefined') {
+            payload['secret'] = secret;
+        }
+
+        return await this.client.call('put', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
 }
 
 module.exports = Account;

package/lib/services/avatars.js

@@ -1,6 +1,8 @@
 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');
 
@@ -10,9 +12,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 +59,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 +132,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 +178,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 +229,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 +278,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