node-appwrite 20.2.1 → 21.0.0

package/dist/services/storage.d.mts

@@ -21,25 +21,28 @@ declare class Storage {
     /**
      * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
-     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BucketList>}
      */
     listBuckets(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.BucketList>;
     /**
      * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
-     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BucketList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
+    listBuckets(queries?: string[], search?: string, total?: boolean): Promise<Models.BucketList>;
     /**
      * Create a new storage bucket.
      *
@@ -53,6 +56,7 @@ declare class Storage {
      * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} params.transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
@@ -67,6 +71,7 @@ declare class Storage {
         compression?: Compression;
         encryption?: boolean;
         antivirus?: boolean;
+        transformations?: boolean;
     }): Promise<Models.Bucket>;
     /**
      * Create a new storage bucket.
@@ -81,11 +86,12 @@ declare class Storage {
      * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
     /**
      * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
      *
@@ -118,6 +124,7 @@ declare class Storage {
      * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} params.transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
@@ -132,6 +139,7 @@ declare class Storage {
         compression?: Compression;
         encryption?: boolean;
         antivirus?: boolean;
+        transformations?: boolean;
     }): Promise<Models.Bucket>;
     /**
      * Update a storage bucket by its unique ID.
@@ -146,11 +154,12 @@ declare class Storage {
      * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
     /**
      * Delete a storage bucket by its unique ID.
      *
@@ -176,6 +185,7 @@ declare class Storage {
      * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FileList>}
      */
@@ -183,6 +193,7 @@ declare class Storage {
         bucketId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.FileList>;
     /**
      * Get a list of all the user files. You can use the query params to filter your results.
@@ -190,11 +201,12 @@ declare class Storage {
      * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FileList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
+    listFiles(bucketId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.FileList>;
     /**
      * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
      *

package/dist/services/storage.d.ts

@@ -21,25 +21,28 @@ declare class Storage {
     /**
      * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
-     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus
+     * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BucketList>}
      */
     listBuckets(params?: {
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.BucketList>;
     /**
      * Get a list of all the storage buckets. You can use the query params to filter your results.
      *
-     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus
+     * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.BucketList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listBuckets(queries?: string[], search?: string): Promise<Models.BucketList>;
+    listBuckets(queries?: string[], search?: string, total?: boolean): Promise<Models.BucketList>;
     /**
      * Create a new storage bucket.
      *
@@ -53,6 +56,7 @@ declare class Storage {
      * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} params.transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
@@ -67,6 +71,7 @@ declare class Storage {
         compression?: Compression;
         encryption?: boolean;
         antivirus?: boolean;
+        transformations?: boolean;
     }): Promise<Models.Bucket>;
     /**
      * Create a new storage bucket.
@@ -81,11 +86,12 @@ declare class Storage {
      * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none,  [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    createBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
     /**
      * Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.
      *
@@ -118,6 +124,7 @@ declare class Storage {
      * @param {Compression} params.compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} params.encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} params.antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} params.transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      */
@@ -132,6 +139,7 @@ declare class Storage {
         compression?: Compression;
         encryption?: boolean;
         antivirus?: boolean;
+        transformations?: boolean;
     }): Promise<Models.Bucket>;
     /**
      * Update a storage bucket by its unique ID.
@@ -146,11 +154,12 @@ declare class Storage {
      * @param {Compression} compression - Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
      * @param {boolean} encryption - Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
      * @param {boolean} antivirus - Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
+     * @param {boolean} transformations - Are image transformations enabled?
      * @throws {AppwriteException}
      * @returns {Promise<Models.Bucket>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean): Promise<Models.Bucket>;
+    updateBucket(bucketId: string, name: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maximumFileSize?: number, allowedFileExtensions?: string[], compression?: Compression, encryption?: boolean, antivirus?: boolean, transformations?: boolean): Promise<Models.Bucket>;
     /**
      * Delete a storage bucket by its unique ID.
      *
@@ -176,6 +185,7 @@ declare class Storage {
      * @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FileList>}
      */
@@ -183,6 +193,7 @@ declare class Storage {
         bucketId: string;
         queries?: string[];
         search?: string;
+        total?: boolean;
     }): Promise<Models.FileList>;
     /**
      * Get a list of all the user files. You can use the query params to filter your results.
@@ -190,11 +201,12 @@ declare class Storage {
      * @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
      * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
      * @param {string} search - Search term to filter your list results. Max length: 256 chars.
+     * @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
      * @throws {AppwriteException}
      * @returns {Promise<Models.FileList>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    listFiles(bucketId: string, queries?: string[], search?: string): Promise<Models.FileList>;
+    listFiles(bucketId: string, queries?: string[], search?: string, total?: boolean): Promise<Models.FileList>;
     /**
      * Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https://appwrite.io/docs/server/storage#storageCreateBucket) API or directly from your Appwrite console.
      *

package/dist/services/storage.js

@@ -13,11 +13,13 @@ class Storage {
     } else {
       params = {
         queries: paramsOrFirst,
-        search: rest[0]
+        search: rest[0],
+        total: rest[1]
       };
     }
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     const apiPath = "/storage/buckets";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -26,6 +28,9 @@ class Storage {
     if (typeof search !== "undefined") {
       payload["search"] = search;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(
@@ -50,7 +55,8 @@ class Storage {
         allowedFileExtensions: rest[5],
         compression: rest[6],
         encryption: rest[7],
-        antivirus: rest[8]
+        antivirus: rest[8],
+        transformations: rest[9]
       };
     }
     const bucketId = params.bucketId;
@@ -63,6 +69,7 @@ class Storage {
     const compression = params.compression;
     const encryption = params.encryption;
     const antivirus = params.antivirus;
+    const transformations = params.transformations;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -101,6 +108,9 @@ class Storage {
     if (typeof antivirus !== "undefined") {
       payload["antivirus"] = antivirus;
     }
+    if (typeof transformations !== "undefined") {
+      payload["transformations"] = transformations;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
@@ -151,7 +161,8 @@ class Storage {
         allowedFileExtensions: rest[5],
         compression: rest[6],
         encryption: rest[7],
-        antivirus: rest[8]
+        antivirus: rest[8],
+        transformations: rest[9]
       };
     }
     const bucketId = params.bucketId;
@@ -164,6 +175,7 @@ class Storage {
     const compression = params.compression;
     const encryption = params.encryption;
     const antivirus = params.antivirus;
+    const transformations = params.transformations;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -199,6 +211,9 @@ class Storage {
     if (typeof antivirus !== "undefined") {
       payload["antivirus"] = antivirus;
     }
+    if (typeof transformations !== "undefined") {
+      payload["transformations"] = transformations;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {
       "content-type": "application/json"
@@ -244,12 +259,14 @@ class Storage {
       params = {
         bucketId: paramsOrFirst,
         queries: rest[0],
-        search: rest[1]
+        search: rest[1],
+        total: rest[2]
       };
     }
     const bucketId = params.bucketId;
     const queries = params.queries;
     const search = params.search;
+    const total = params.total;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -261,6 +278,9 @@ class Storage {
     if (typeof search !== "undefined") {
       payload["search"] = search;
     }
+    if (typeof total !== "undefined") {
+      payload["total"] = total;
+    }
     const uri = new URL(this.client.config.endpoint + apiPath);
     const apiHeaders = {};
     return this.client.call(