node-appwrite 4.0.0 → 5.0.0

package/lib/services/storage.js

@@ -1,8 +1,258 @@
 const Service = require('../service.js');
 const AppwriteException = require('../exception.js');
+const client = require('../client.js');
+const { promisify } = require('util');
+const fs = require('fs');
 
 class Storage extends Service {
 
+    /**
+     * List buckets
+     *
+     * Get a list of all the storage buckets. You can use the query params to
+     * filter your results.
+     *
+     * @param {string} search
+     * @param {number} limit
+     * @param {number} offset
+     * @param {string} cursor
+     * @param {string} cursorDirection
+     * @param {string} orderType
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async listBuckets(search, limit, offset, cursor, cursorDirection, orderType) {
+        let path = '/storage/buckets';
+        let payload = {};
+
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
+        }
+
+        if (typeof limit !== 'undefined') {
+            payload['limit'] = limit;
+        }
+
+        if (typeof offset !== 'undefined') {
+            payload['offset'] = offset;
+        }
+
+        if (typeof cursor !== 'undefined') {
+            payload['cursor'] = cursor;
+        }
+
+        if (typeof cursorDirection !== 'undefined') {
+            payload['cursorDirection'] = cursorDirection;
+        }
+
+        if (typeof orderType !== 'undefined') {
+            payload['orderType'] = orderType;
+        }
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Create bucket
+     *
+     * Create a new storage bucket.
+     *
+     * @param {string} bucketId
+     * @param {string} name
+     * @param {string} permission
+     * @param {string[]} read
+     * @param {string[]} write
+     * @param {boolean} enabled
+     * @param {number} maximumFileSize
+     * @param {string[]} allowedFileExtensions
+     * @param {boolean} encryption
+     * @param {boolean} antivirus
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async createBucket(bucketId, name, permission, read, write, enabled, maximumFileSize, allowedFileExtensions, encryption, antivirus) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+        if (typeof permission === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "permission"');
+        }
+
+        let path = '/storage/buckets';
+        let payload = {};
+
+        if (typeof bucketId !== 'undefined') {
+            payload['bucketId'] = bucketId;
+        }
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        if (typeof permission !== 'undefined') {
+            payload['permission'] = permission;
+        }
+
+        if (typeof read !== 'undefined') {
+            payload['read'] = read;
+        }
+
+        if (typeof write !== 'undefined') {
+            payload['write'] = write;
+        }
+
+        if (typeof enabled !== 'undefined') {
+            payload['enabled'] = enabled;
+        }
+
+        if (typeof maximumFileSize !== 'undefined') {
+            payload['maximumFileSize'] = maximumFileSize;
+        }
+
+        if (typeof allowedFileExtensions !== 'undefined') {
+            payload['allowedFileExtensions'] = allowedFileExtensions;
+        }
+
+        if (typeof encryption !== 'undefined') {
+            payload['encryption'] = encryption;
+        }
+
+        if (typeof antivirus !== 'undefined') {
+            payload['antivirus'] = antivirus;
+        }
+
+        return await this.client.call('post', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get Bucket
+     *
+     * Get a storage bucket by its unique ID. This endpoint response returns a
+     * JSON object with the storage bucket metadata.
+     *
+     * @param {string} bucketId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getBucket(bucketId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
+
+        return await this.client.call('get', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Update Bucket
+     *
+     * Update a storage bucket by its unique ID.
+     *
+     * @param {string} bucketId
+     * @param {string} name
+     * @param {string} permission
+     * @param {string[]} read
+     * @param {string[]} write
+     * @param {boolean} enabled
+     * @param {number} maximumFileSize
+     * @param {string[]} allowedFileExtensions
+     * @param {boolean} encryption
+     * @param {boolean} antivirus
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async updateBucket(bucketId, name, permission, read, write, enabled, maximumFileSize, allowedFileExtensions, encryption, antivirus) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
+        if (typeof name === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "name"');
+        }
+
+        if (typeof permission === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "permission"');
+        }
+
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
+
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
+        if (typeof permission !== 'undefined') {
+            payload['permission'] = permission;
+        }
+
+        if (typeof read !== 'undefined') {
+            payload['read'] = read;
+        }
+
+        if (typeof write !== 'undefined') {
+            payload['write'] = write;
+        }
+
+        if (typeof enabled !== 'undefined') {
+            payload['enabled'] = enabled;
+        }
+
+        if (typeof maximumFileSize !== 'undefined') {
+            payload['maximumFileSize'] = maximumFileSize;
+        }
+
+        if (typeof allowedFileExtensions !== 'undefined') {
+            payload['allowedFileExtensions'] = allowedFileExtensions;
+        }
+
+        if (typeof encryption !== 'undefined') {
+            payload['encryption'] = encryption;
+        }
+
+        if (typeof antivirus !== 'undefined') {
+            payload['antivirus'] = antivirus;
+        }
+
+        return await this.client.call('put', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Delete Bucket
+     *
+     * Delete a storage bucket by its unique ID.
+     *
+     * @param {string} bucketId
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async deleteBucket(bucketId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
+
+        return await this.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
     /**
      * List Files
      *
@@ -10,6 +260,7 @@ class Storage extends Service {
      * 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).
      *
+     * @param {string} bucketId
      * @param {string} search
      * @param {number} limit
      * @param {number} offset
@@ -19,8 +270,12 @@ class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listFiles(search, limit, offset, cursor, cursorDirection, orderType) {
-        let path = '/storage/files';
+    async listFiles(bucketId, search, limit, offset, cursor, cursorDirection, orderType) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
+        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
         let payload = {};
 
         if (typeof search !== 'undefined') {
@@ -55,18 +310,38 @@ class Storage extends Service {
     /**
      * Create File
      *
-     * Create a new file. The user who creates the file will automatically be
-     * assigned to read and write access unless he has passed custom values for
-     * read and write arguments.
+     * Create a new file. Before using this route, you should create a new bucket
+     * resource using either a [server
+     * integration](/docs/server/database#storageCreateBucket) API or directly
+     * from your Appwrite console.
+     * 
+     * Larger files should be uploaded using multiple requests with the
+     * [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range)
+     * header to send a partial request with a maximum supported chunk of `5MB`.
+     * The `content-range` header values should always be in bytes.
+     * 
+     * When the first request is sent, the server will return the **File** object,
+     * and the subsequent part request must include the file's **id** in
+     * `x-appwrite-id` header to allow the server to know that the partial upload
+     * is for the existing file and not for a new one.
+     * 
+     * If you're creating a new file using one of the Appwrite SDKs, all the
+     * chunking logic will be managed by the SDK internally.
+     * 
      *
+     * @param {string} bucketId
      * @param {string} fileId
-     * @param {File} file
+     * @param {string} file
      * @param {string[]} read
      * @param {string[]} write
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createFile(fileId, file, read, write) {
+    async createFile(bucketId, fileId, file, read, write, onProgress = () => {}) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
@@ -75,7 +350,7 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "file"');
         }
 
-        let path = '/storage/files';
+        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
         let payload = {};
 
         if (typeof fileId !== 'undefined') {
@@ -83,7 +358,7 @@ class Storage extends Service {
         }
 
         if (typeof file !== 'undefined') {
-            payload['file'] = file;
+            payload['file'] = file.toString();
         }
 
         if (typeof read !== 'undefined') {
@@ -94,9 +369,57 @@ class Storage extends Service {
             payload['write'] = write;
         }
 
-        return await this.client.call('post', path, {
-            'content-type': 'multipart/form-data',
-        }, payload);
+        const { size: size } = await promisify(fs.stat)(file);
+
+        if (size <= client.CHUNK_SIZE) {
+                payload['file'] = fs.createReadStream(file);
+                
+                return await this.client.call('post', path, {
+                'content-type': 'multipart/form-data',
+                }, payload);
+        } else {
+                let id = undefined;
+                let response = undefined;
+
+                const totalCounters = Math.ceil(size / client.CHUNK_SIZE);
+
+                for (let counter = 0; counter < totalCounters; counter++) {
+                        const start = (counter * client.CHUNK_SIZE);
+                        const end = Math.min((((counter * client.CHUNK_SIZE) + client.CHUNK_SIZE) - 1), size);
+                        const headers = {
+                                'content-type': 'multipart/form-data',
+                                'content-range': 'bytes ' + start + '-' + end + '/' + size
+                        };
+
+                        if (id) {
+                                headers['x-appwrite-id'] = id;
+                        }
+
+                        const stream = fs.createReadStream(file, {
+                                start,
+                                end
+                        });
+                        payload['file'] = stream;
+
+                        response = await this.client.call('post', path, headers, payload);
+
+                        if (!id) {
+                                id = response['$id'];
+                        }
+                        
+                        if (onProgress !== null) {
+                                onProgress({
+                                        $id: response['$id'],
+                                        progress: Math.min((counter+1) * client.CHUNK_SIZE, size) / size * 100,
+                                        sizeUploaded: end+1,
+                                        chunksTotal: response['chunksTotal'],
+                                        chunksUploaded: response['chunksUploaded']
+                                });
+                        }
+                }
+
+                return response;
+        }
     }
 
     /**
@@ -105,16 +428,21 @@ class Storage extends Service {
      * Get a file by its unique ID. This endpoint response returns a JSON object
      * with the file metadata.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getFile(fileId) {
+    async getFile(bucketId, fileId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -128,26 +456,23 @@ class Storage extends Service {
      * Update a file by its unique ID. Only users with write permissions have
      * access to update this resource.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @param {string[]} read
      * @param {string[]} write
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateFile(fileId, read, write) {
-        if (typeof fileId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "fileId"');
+    async updateFile(bucketId, fileId, read, write) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
         }
 
-        if (typeof read === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "read"');
-        }
-
-        if (typeof write === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "write"');
+        if (typeof fileId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         if (typeof read !== 'undefined') {
@@ -169,16 +494,21 @@ class Storage extends Service {
      * Delete a file by its unique ID. Only users with write permissions have
      * access to delete this resource.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async deleteFile(fileId) {
+    async deleteFile(bucketId, fileId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         return await this.client.call('delete', path, {
@@ -193,16 +523,21 @@ class Storage extends Service {
      * 'Content-Disposition: attachment' header that tells the browser to start
      * downloading the file to user downloads directory.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getFileDownload(fileId) {
+    async getFileDownload(bucketId, fileId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}/download'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         return await this.client.call('get', path, {
@@ -216,8 +551,10 @@ class Storage extends Service {
      * Get a file preview image. Currently, this method supports preview for image
      * files (jpg, png, and gif), other supported formats, like pdf, docs, slides,
      * and spreadsheets, will return the file icon image. You can also pass query
-     * string arguments for cutting and resizing your preview image.
+     * string arguments for cutting and resizing your preview image. Preview is
+     * supported only for image files smaller than 10MB.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @param {number} width
      * @param {number} height
@@ -233,12 +570,16 @@ class Storage extends Service {
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getFilePreview(fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output) {
+    async getFilePreview(bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}/preview'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         if (typeof width !== 'undefined') {
@@ -297,16 +638,21 @@ class Storage extends Service {
      * download method but returns with no  'Content-Disposition: attachment'
      * header.
      *
+     * @param {string} bucketId
      * @param {string} fileId
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async getFileView(fileId) {
+    async getFileView(bucketId, fileId) {
+        if (typeof bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
+        }
+
         if (typeof fileId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/files/{fileId}/view'.replace('{fileId}', fileId);
+        let path = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
 
         return await this.client.call('get', path, {

package/lib/services/teams.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 Teams extends Service {
 
@@ -395,6 +398,10 @@ class Teams extends Service {
      * Use this endpoint to allow a user to accept an invitation to join a team
      * after being redirected back to your app from the invitation email received
      * by the user.
+     * 
+     * If the request is successful, a session for the user is automatically
+     * created.
+     * 
      *
      * @param {string} teamId
      * @param {string} membershipId

package/lib/services/users.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 Users extends Service {
 
@@ -294,8 +297,9 @@ class Users extends Service {
     /**
      * Update User Preferences
      *
-     * Update the user preferences by its unique ID. You can pass only the
-     * specific settings you wish to update.
+     * Update the user 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 error if exceeded.
      *
      * @param {string} userId
      * @param {object} prefs

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