node-appwrite 4.0.2 → 6.0.0

package/lib/client.js

@@ -4,13 +4,14 @@ const FormData = require('form-data');
 const AppwriteException = require('./exception.js');
 
 class Client {
+    static CHUNK_SIZE = 5*1024*1024; // 5MB
     
     constructor() {
         this.endpoint = 'https://HOSTNAME/v1';
         this.headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:nodejs:4.0.2',
-            'X-Appwrite-Response-Format' : '0.12.0',
+            'x-sdk-version': 'appwrite:nodejs:6.0.0',
+            'X-Appwrite-Response-Format' : '0.14.0',
         };
         this.selfSigned = false;
     }
@@ -115,7 +116,8 @@ class Client {
             process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = 0;
         }
 
-        headers = Object.assign(this.headers, headers);
+
+        headers = Object.assign({}, this.headers, headers);
 
         let contentType = headers['content-type'].toLowerCase();
 
@@ -155,9 +157,9 @@ class Client {
             if('response' in error && error.response !== undefined) {
                 if(error.response && 'data' in error.response) {
                     if (typeof(error.response.data) === 'string') {
-                        throw new AppwriteException(error.response.data, error.response.status, error.response.data);
+                        throw new AppwriteException(error.response.data, error.response.status, '', error.response.data);
                     } else {
-                        throw new AppwriteException(error.response.data.message, error.response.status, error.response.data);
+                        throw new AppwriteException(error.response.data.message, error.response.status, error.response.data.type, error.response.data);
                     }
                 } else {
                     throw new AppwriteException(error.response.statusText, error.response.status, error.response.data);

package/lib/exception.js

@@ -1,7 +1,8 @@
 class AppwriteException extends Error {
-  constructor(message, code, response) {
+  constructor(message, code, type, response) {
     super(message);
     this.code = code;
+    this.type = type;
     this.response = response;
   }
 }

package/lib/services/account.js

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Account extends Service {
 
@@ -20,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
      *
@@ -142,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
@@ -377,12 +359,37 @@ class Account extends Service {
         }, payload);
     }
 
+    /**
+     * 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}
+     */
+    async updateSession(sessionId) {
+        if (typeof sessionId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "sessionId"');
+        }
+
+        let path = '/account/sessions/{sessionId}'.replace('{sessionId}', sessionId);
+        let payload = {};
+
+        return await this.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * Delete Account 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
-     * option id argument, only the session unique ID provider will be deleted.
+     * Session ID argument, only the unique session ID provided is deleted.
+     * 
      *
      * @param {string} sessionId
      * @throws {AppwriteException}
@@ -401,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

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Avatars extends Service {
 
@@ -7,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
@@ -49,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
@@ -116,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
@@ -156,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
@@ -201,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
@@ -244,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

@@ -1,5 +1,8 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Database extends Service {
 
@@ -405,9 +408,9 @@ class Database extends Service {
      * @param {string} collectionId
      * @param {string} key
      * @param {boolean} required
-     * @param {string} min
-     * @param {string} max
-     * @param {string} xdefault
+     * @param {number} min
+     * @param {number} max
+     * @param {number} xdefault
      * @param {boolean} array
      * @throws {AppwriteException}
      * @returns {Promise}
@@ -922,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