node-appwrite 7.0.0 → 8.0.0-RC1

package/lib/services/storage.js

@@ -8,47 +8,33 @@ const fs = require('fs');
 
 class Storage extends Service {
 
+     constructor(client)
+     {
+        super(client);
+     }
+
+
     /**
      * List buckets
      *
      * Get a list of all the storage buckets. You can use the query params to
      * filter your results.
      *
+     * @param {string[]} queries
      * @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) {
+    async listBuckets(queries, search) {
         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 queries !== 'undefined') {
+            payload['queries'] = queries;
         }
 
-        if (typeof orderType !== 'undefined') {
-            payload['orderType'] = orderType;
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
         }
 
         return await this.client.call('get', path, {
@@ -63,18 +49,20 @@ class Storage extends Service {
      *
      * @param {string} bucketId
      * @param {string} name
-     * @param {string} permission
-     * @param {string[]} read
-     * @param {string[]} write
+     * @param {string[]} permissions
+     * @param {boolean} fileSecurity
      * @param {boolean} enabled
      * @param {number} maximumFileSize
      * @param {string[]} allowedFileExtensions
+     * @param {string} compression
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createBucket(bucketId, name, permission, read, write, enabled, maximumFileSize, allowedFileExtensions, encryption, antivirus) {
+    async createBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
+        let path = '/storage/buckets';
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -83,12 +71,6 @@ class Storage extends Service {
             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;
@@ -98,16 +80,12 @@ class Storage extends Service {
             payload['name'] = name;
         }
 
-        if (typeof permission !== 'undefined') {
-            payload['permission'] = permission;
+        if (typeof permissions !== 'undefined') {
+            payload['permissions'] = permissions;
         }
 
-        if (typeof read !== 'undefined') {
-            payload['read'] = read;
-        }
-
-        if (typeof write !== 'undefined') {
-            payload['write'] = write;
+        if (typeof fileSecurity !== 'undefined') {
+            payload['fileSecurity'] = fileSecurity;
         }
 
         if (typeof enabled !== 'undefined') {
@@ -122,6 +100,10 @@ class Storage extends Service {
             payload['allowedFileExtensions'] = allowedFileExtensions;
         }
 
+        if (typeof compression !== 'undefined') {
+            payload['compression'] = compression;
+        }
+
         if (typeof encryption !== 'undefined') {
             payload['encryption'] = encryption;
         }
@@ -146,12 +128,12 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getBucket(bucketId) {
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
         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',
@@ -165,18 +147,20 @@ class Storage extends Service {
      *
      * @param {string} bucketId
      * @param {string} name
-     * @param {string} permission
-     * @param {string[]} read
-     * @param {string[]} write
+     * @param {string[]} permissions
+     * @param {boolean} fileSecurity
      * @param {boolean} enabled
      * @param {number} maximumFileSize
      * @param {string[]} allowedFileExtensions
+     * @param {string} compression
      * @param {boolean} encryption
      * @param {boolean} antivirus
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateBucket(bucketId, name, permission, read, write, enabled, maximumFileSize, allowedFileExtensions, encryption, antivirus) {
+    async updateBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -185,27 +169,17 @@ class Storage extends Service {
             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 permissions !== 'undefined') {
+            payload['permissions'] = permissions;
         }
 
-        if (typeof read !== 'undefined') {
-            payload['read'] = read;
-        }
-
-        if (typeof write !== 'undefined') {
-            payload['write'] = write;
+        if (typeof fileSecurity !== 'undefined') {
+            payload['fileSecurity'] = fileSecurity;
         }
 
         if (typeof enabled !== 'undefined') {
@@ -220,6 +194,10 @@ class Storage extends Service {
             payload['allowedFileExtensions'] = allowedFileExtensions;
         }
 
+        if (typeof compression !== 'undefined') {
+            payload['compression'] = compression;
+        }
+
         if (typeof encryption !== 'undefined') {
             payload['encryption'] = encryption;
         }
@@ -243,12 +221,12 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async deleteBucket(bucketId) {
+        let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+        let payload = {};
         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',
@@ -263,45 +241,25 @@ class Storage extends Service {
      * project's files. [Learn more about different API modes](/docs/admin).
      *
      * @param {string} bucketId
+     * @param {string[]} queries
      * @param {string} search
-     * @param {number} limit
-     * @param {number} offset
-     * @param {string} cursor
-     * @param {string} cursorDirection
-     * @param {string} orderType
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async listFiles(bucketId, search, limit, offset, cursor, cursorDirection, orderType) {
-        if (typeof bucketId === 'undefined') {
-            throw new AppwriteException('Missing required parameter: "bucketId"');
-        }
-
+    async listFiles(bucketId, queries, search) {
         let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
         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 bucketId === 'undefined') {
+            throw new AppwriteException('Missing required parameter: "bucketId"');
         }
 
-        if (typeof cursor !== 'undefined') {
-            payload['cursor'] = cursor;
-        }
 
-        if (typeof cursorDirection !== 'undefined') {
-            payload['cursorDirection'] = cursorDirection;
+        if (typeof queries !== 'undefined') {
+            payload['queries'] = queries;
         }
 
-        if (typeof orderType !== 'undefined') {
-            payload['orderType'] = orderType;
+        if (typeof search !== 'undefined') {
+            payload['search'] = search;
         }
 
         return await this.client.call('get', path, {
@@ -314,8 +272,8 @@ class Storage extends Service {
      *
      * 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.
+     * integration](/docs/server/storage#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)
@@ -334,12 +292,13 @@ class Storage extends Service {
      * @param {string} bucketId
      * @param {string} fileId
      * @param {InputFile} file
-     * @param {string[]} read
-     * @param {string[]} write
+     * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async createFile(bucketId, fileId, file, read, write, onProgress = () => {}) {
+    async createFile(bucketId, fileId, file, permissions, onProgress = () => {}) {
+        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -352,8 +311,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "file"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
-        let payload = {};
 
         if (typeof fileId !== 'undefined') {
             payload['fileId'] = fileId;
@@ -363,12 +320,8 @@ class Storage extends Service {
             payload['file'] = file;
         }
 
-        if (typeof read !== 'undefined') {
-            payload['read'] = read;
-        }
-
-        if (typeof write !== 'undefined') {
-            payload['write'] = write;
+        if (typeof permissions !== 'undefined') {
+            payload['permissions'] = permissions;
         }
 
         const size = file.size;
@@ -489,6 +442,7 @@ class Storage extends Service {
             
             file.stream.pipe(writeStream);
         });
+
     }
 
     /**
@@ -503,6 +457,8 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFile(bucketId, fileId) {
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -511,8 +467,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
 
         return await this.client.call('get', path, {
             'content-type': 'application/json',
@@ -527,12 +481,13 @@ class Storage extends Service {
      *
      * @param {string} bucketId
      * @param {string} fileId
-     * @param {string[]} read
-     * @param {string[]} write
+     * @param {string[]} permissions
      * @throws {AppwriteException}
      * @returns {Promise}
      */
-    async updateFile(bucketId, fileId, read, write) {
+    async updateFile(bucketId, fileId, permissions) {
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -541,15 +496,9 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
-
-        if (typeof read !== 'undefined') {
-            payload['read'] = read;
-        }
 
-        if (typeof write !== 'undefined') {
-            payload['write'] = write;
+        if (typeof permissions !== 'undefined') {
+            payload['permissions'] = permissions;
         }
 
         return await this.client.call('put', path, {
@@ -569,6 +518,8 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async deleteFile(bucketId, fileId) {
+        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -577,8 +528,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
 
         return await this.client.call('delete', path, {
             'content-type': 'application/json',
@@ -598,6 +547,8 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFileDownload(bucketId, fileId) {
+        let path = '/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"');
         }
@@ -606,8 +557,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
 
         return await this.client.call('get', path, {
             'content-type': 'application/json',
@@ -640,6 +589,8 @@ 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);
+        let payload = {};
         if (typeof bucketId === 'undefined') {
             throw new AppwriteException('Missing required parameter: "bucketId"');
         }
@@ -648,8 +599,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
 
         if (typeof width !== 'undefined') {
             payload['width'] = width;
@@ -713,6 +662,8 @@ class Storage extends Service {
      * @returns {Promise}
      */
     async getFileView(bucketId, fileId) {
+        let path = '/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"');
         }
@@ -721,8 +672,6 @@ class Storage extends Service {
             throw new AppwriteException('Missing required parameter: "fileId"');
         }
 
-        let path = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
-        let payload = {};
 
         return await this.client.call('get', path, {
             'content-type': 'application/json',
@@ -730,4 +679,4 @@ class Storage extends Service {
     }
 }
 
-module.exports = Storage;
+module.exports = Storage;