node-appwrite 8.2.0 → 10.0.0

package/lib/services/graphql.js

@@ -24,7 +24,7 @@ class Graphql extends Service {
      * @returns {Promise}
      */
     async query(query) {
-        let path = '/graphql';
+        const apiPath = '/graphql';
         let payload = {};
         if (typeof query === 'undefined') {
             throw new AppwriteException('Missing required parameter: "query"');
@@ -35,7 +35,7 @@ class Graphql extends Service {
             payload['query'] = query;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'x-sdk-graphql': 'true',
             'content-type': 'application/json',
         }, payload);
@@ -51,7 +51,7 @@ class Graphql extends Service {
      * @returns {Promise}
      */
     async mutation(query) {
-        let path = '/graphql/mutation';
+        const apiPath = '/graphql/mutation';
         let payload = {};
         if (typeof query === 'undefined') {
             throw new AppwriteException('Missing required parameter: "query"');
@@ -62,7 +62,7 @@ class Graphql extends Service {
             payload['query'] = query;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'x-sdk-graphql': 'true',
             'content-type': 'application/json',
         }, payload);

package/lib/services/health.js

@@ -23,10 +23,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async get() {
-        let path = '/health';
+        const apiPath = '/health';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -40,10 +40,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getAntivirus() {
-        let path = '/health/anti-virus';
+        const apiPath = '/health/anti-virus';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -51,17 +51,17 @@ class Health extends Service {
     /**
      * Get Cache
      *
-     * Check the Appwrite in-memory cache server is up and connection is
+     * Check the Appwrite in-memory cache servers are up and connection is
      * successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async getCache() {
-        let path = '/health/cache';
+        const apiPath = '/health/cache';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -69,16 +69,51 @@ class Health extends Service {
     /**
      * Get DB
      *
-     * Check the Appwrite database server is up and connection is successful.
+     * Check the Appwrite database servers are up and connection is successful.
      *
      * @throws {AppwriteException}
      * @returns {Promise}
      */
     async getDB() {
-        let path = '/health/db';
+        const apiPath = '/health/db';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get PubSub
+     *
+     * Check the Appwrite pub-sub servers are up and connection is successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getPubSub() {
+        const apiPath = '/health/pubsub';
+        let payload = {};
+
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * Get Queue
+     *
+     * Check the Appwrite queue messaging servers are up and connection is
+     * successful.
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async getQueue() {
+        const apiPath = '/health/queue';
+        let payload = {};
+
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -94,10 +129,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getQueueCertificates() {
-        let path = '/health/queue/certificates';
+        const apiPath = '/health/queue/certificates';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -109,10 +144,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getQueueFunctions() {
-        let path = '/health/queue/functions';
+        const apiPath = '/health/queue/functions';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -127,10 +162,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getQueueLogs() {
-        let path = '/health/queue/logs';
+        const apiPath = '/health/queue/logs';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -145,10 +180,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getQueueWebhooks() {
-        let path = '/health/queue/webhooks';
+        const apiPath = '/health/queue/webhooks';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -162,10 +197,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getStorageLocal() {
-        let path = '/health/storage/local';
+        const apiPath = '/health/storage/local';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -185,10 +220,10 @@ class Health extends Service {
      * @returns {Promise}
      */
     async getTime() {
-        let path = '/health/time';
+        const apiPath = '/health/time';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }

package/lib/services/locale.js

@@ -28,10 +28,28 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async get() {
-        let path = '/locale';
+        const apiPath = '/locale';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
+            'content-type': 'application/json',
+        }, payload);
+    }
+
+    /**
+     * List Locale Codes
+     *
+     * List of all locale codes in [ISO
+     * 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+     *
+     * @throws {AppwriteException}
+     * @returns {Promise}
+     */
+    async listCodes() {
+        const apiPath = '/locale/codes';
+        let payload = {};
+
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -46,10 +64,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listContinents() {
-        let path = '/locale/continents';
+        const apiPath = '/locale/continents';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -64,10 +82,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listCountries() {
-        let path = '/locale/countries';
+        const apiPath = '/locale/countries';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -82,10 +100,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listCountriesEU() {
-        let path = '/locale/countries/eu';
+        const apiPath = '/locale/countries/eu';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -100,10 +118,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listCountriesPhones() {
-        let path = '/locale/countries/phones';
+        const apiPath = '/locale/countries/phones';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -119,10 +137,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listCurrencies() {
-        let path = '/locale/currencies';
+        const apiPath = '/locale/currencies';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -137,10 +155,10 @@ class Locale extends Service {
      * @returns {Promise}
      */
     async listLanguages() {
-        let path = '/locale/languages';
+        const apiPath = '/locale/languages';
         let payload = {};
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }

package/lib/services/storage.js

@@ -26,7 +26,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async listBuckets(queries, search) {
-        let path = '/storage/buckets';
+        const apiPath = '/storage/buckets';
         let payload = {};
 
         if (typeof queries !== 'undefined') {
@@ -37,7 +37,7 @@ class Storage extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -61,7 +61,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async createBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
-        let path = '/storage/buckets';
+        const apiPath = '/storage/buckets';
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -112,7 +112,7 @@ class Storage extends Service {
             payload['antivirus'] = antivirus;
         }
 
-        return await this.client.call('post', path, {
+        return await this.client.call('post', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -128,14 +128,14 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getBucket(bucketId) {
-        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -159,7 +159,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async updateBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
-        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -206,7 +206,7 @@ class Storage extends Service {
             payload['antivirus'] = antivirus;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -221,14 +221,14 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async deleteBucket(bucketId) {
-        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        const apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -246,7 +246,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async listFiles(bucketId, queries, search) {
-        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
+        const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -261,7 +261,7 @@ class Storage extends Service {
             payload['search'] = search;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -296,7 +296,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async createFile(bucketId, fileId, file, permissions, onProgress = () => {}) {
-        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
+        const apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -336,7 +336,7 @@ class Storage extends Service {
 
         if(fileId != 'unique()') {
             try {
-                response = await this.client.call('get', path + '/' + fileId, headers);
+                response = await this.client.call('get', apiPath + '/' + fileId, headers);
                 chunksUploaded = response.chunksUploaded;
             } catch(e) {
             }
@@ -367,7 +367,7 @@ class Storage extends Service {
             const stream = Stream.Readable.from(currentChunk);
             payload['file'] = { type: 'file', file: stream, filename: file.filename };
 
-            response = await selfClient.call('post', path, headers, payload);
+            response = await selfClient.call('post', apiPath, headers, payload);
 
             if (!id) {
                 id = response['$id'];
@@ -388,48 +388,56 @@ class Storage extends Service {
 
         return await new Promise((resolve, reject) => {
             const writeStream = new Stream.Writable();
-            writeStream._write = async (mainChunk, encoding, next) => {
-                // Segment incoming chunk into up to 5MB chunks
-                const mainChunkSize = Buffer.byteLength(mainChunk);
-                const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
-                const chunks = [];
-
-                for(let i = 0; i < chunksCount; i++) {
-                    const chunk = mainChunk.slice(i * client.CHUNK_SIZE, client.CHUNK_SIZE);
-                    chunks.push(chunk);
-                }
+            writeStream._write = async (mainChunk, encoding, callback) => {
+                try {
+                    // Segment incoming chunk into up to 5MB chunks
+                    const mainChunkSize = Buffer.byteLength(mainChunk);
+                    const chunksCount = Math.ceil(mainChunkSize / client.CHUNK_SIZE);
+                    const chunks = [];
+
+                    for(let i = 0; i < chunksCount; i++) {
+                        const chunk = mainChunk.slice(i * client.CHUNK_SIZE, (i + 1) * client.CHUNK_SIZE);
+                        chunks.push(chunk);
+                    }
 
-                for (const chunk of chunks) {
-                    const chunkSize = Buffer.byteLength(chunk);
-
-                    if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
-                        // Upload chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        await uploadChunk();
-                        currentChunk = Buffer.from('');
-                        currentChunkSize = 0;
-                    } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
-                        // Upload chunk, put rest into next chunk
-                        const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
-                        const newChunkSection = chunk.slice(0, bytesToUpload);
-                        currentChunk = Buffer.concat([currentChunk, newChunkSection]);
-                        currentChunkSize = Buffer.byteLength(currentChunk);
-                        await uploadChunk();
-                        currentChunk = chunk.slice(bytesToUpload, undefined);
-                        currentChunkSize = chunkSize - bytesToUpload;
-                    } else {
-                        // Append into current chunk
-                        currentChunk = Buffer.concat([currentChunk, chunk]);
-                        currentChunkSize = chunkSize + currentChunkSize;
+                    for (const chunk of chunks) {
+                        const chunkSize = Buffer.byteLength(chunk);
+
+                        if(chunkSize + currentChunkSize == client.CHUNK_SIZE) {
+                            // Upload chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            await uploadChunk();
+                            currentChunk = Buffer.from('');
+                            currentChunkSize = 0;
+                        } else if(chunkSize + currentChunkSize > client.CHUNK_SIZE) {
+                            // Upload chunk, put rest into next chunk
+                            const bytesToUpload = client.CHUNK_SIZE - currentChunkSize;
+                            const newChunkSection = chunk.slice(0, bytesToUpload);
+                            currentChunk = Buffer.concat([currentChunk, newChunkSection]);
+                            currentChunkSize = Buffer.byteLength(currentChunk);
+                            await uploadChunk();
+                            currentChunk = chunk.slice(bytesToUpload, undefined);
+                            currentChunkSize = chunkSize - bytesToUpload;
+                        } else {
+                            // Append into current chunk
+                            currentChunk = Buffer.concat([currentChunk, chunk]);
+                            currentChunkSize = chunkSize + currentChunkSize;
+                        }
                     }
-                }
 
-                next();
+                    callback();
+                } catch (e) {
+                    callback(e);
+                }
             }
 
             writeStream.on("finish", async () => {
                 if(currentChunkSize > 0) {
-                    await uploadChunk(true);
+                    try {
+                        await uploadChunk(true);
+                    } catch (e) {
+                        reject(e);
+                    }
                 }
                 
                 resolve(response);
@@ -456,7 +464,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFile(bucketId, fileId) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -467,7 +475,7 @@ class Storage extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -480,12 +488,13 @@ class Storage extends Service {
      *
      * @param {string} bucketId
      * @param {string} fileId
+     * @param {string} name
      * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateFile(bucketId, fileId, permissions) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    async updateFile(bucketId, fileId, name, permissions) {
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -496,11 +505,15 @@ class Storage extends Service {
         }
 
 
+        if (typeof name !== 'undefined') {
+            payload['name'] = name;
+        }
+
         if (typeof permissions !== 'undefined') {
             payload['permissions'] = permissions;
         }
 
-        return await this.client.call('put', path, {
+        return await this.client.call('put', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -517,7 +530,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async deleteFile(bucketId, fileId) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -528,7 +541,7 @@ class Storage extends Service {
         }
 
 
-        return await this.client.call('delete', path, {
+        return await this.client.call('delete', apiPath, {
             'content-type': 'application/json',
         }, payload);
     }
@@ -546,7 +559,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFileDownload(bucketId, fileId) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -557,7 +570,7 @@ class Storage extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -588,7 +601,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFilePreview(bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -643,7 +656,7 @@ class Storage extends Service {
             payload['output'] = output;
         }
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }
@@ -661,7 +674,7 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFileView(bucketId, fileId) {
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        const apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
         let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
@@ -672,7 +685,7 @@ class Storage extends Service {
         }
 
 
-        return await this.client.call('get', path, {
+        return await this.client.call('get', apiPath, {
             'content-type': 'application/json',
         }, payload, 'arraybuffer');
     }