node-appwrite 17.2.0 → 18.0.0

package/dist/services/storage.js

@@ -6,15 +6,18 @@ class Storage {
   constructor(client) {
     this.client = client;
   }
-  /**
-   * Get a list of all the storage buckets. You can use the query params to filter your results.
-   *
-   * @param {string[]} queries
-   * @param {string} search
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.BucketList>}
-   */
-  listBuckets(queries, search) {
+  listBuckets(paramsOrFirst, ...rest) {
+    let params;
+    if (!paramsOrFirst || paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        queries: paramsOrFirst,
+        search: rest[0]
+      };
+    }
+    const queries = params.queries;
+    const search = params.search;
     const apiPath = "/storage/buckets";
     const payload = {};
     if (typeof queries !== "undefined") {
@@ -32,23 +35,34 @@ class Storage {
       payload
     );
   }
-  /**
-   * Create a new storage bucket.
-   *
-   * @param {string} bucketId
-   * @param {string} name
-   * @param {string[]} permissions
-   * @param {boolean} fileSecurity
-   * @param {boolean} enabled
-   * @param {number} maximumFileSize
-   * @param {string[]} allowedFileExtensions
-   * @param {Compression} compression
-   * @param {boolean} encryption
-   * @param {boolean} antivirus
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.Bucket>}
-   */
-  createBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
+  createBucket(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        name: rest[0],
+        permissions: rest[1],
+        fileSecurity: rest[2],
+        enabled: rest[3],
+        maximumFileSize: rest[4],
+        allowedFileExtensions: rest[5],
+        compression: rest[6],
+        encryption: rest[7],
+        antivirus: rest[8]
+      };
+    }
+    const bucketId = params.bucketId;
+    const name = params.name;
+    const permissions = params.permissions;
+    const fileSecurity = params.fileSecurity;
+    const enabled = params.enabled;
+    const maximumFileSize = params.maximumFileSize;
+    const allowedFileExtensions = params.allowedFileExtensions;
+    const compression = params.compression;
+    const encryption = params.encryption;
+    const antivirus = params.antivirus;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -98,14 +112,16 @@ class Storage {
       payload
     );
   }
-  /**
-   * 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<Models.Bucket>}
-   */
-  getBucket(bucketId) {
+  getBucket(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst
+      };
+    }
+    const bucketId = params.bucketId;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -120,23 +136,34 @@ class Storage {
       payload
     );
   }
-  /**
-   * Update a storage bucket by its unique ID.
-   *
-   * @param {string} bucketId
-   * @param {string} name
-   * @param {string[]} permissions
-   * @param {boolean} fileSecurity
-   * @param {boolean} enabled
-   * @param {number} maximumFileSize
-   * @param {string[]} allowedFileExtensions
-   * @param {Compression} compression
-   * @param {boolean} encryption
-   * @param {boolean} antivirus
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.Bucket>}
-   */
-  updateBucket(bucketId, name, permissions, fileSecurity, enabled, maximumFileSize, allowedFileExtensions, compression, encryption, antivirus) {
+  updateBucket(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        name: rest[0],
+        permissions: rest[1],
+        fileSecurity: rest[2],
+        enabled: rest[3],
+        maximumFileSize: rest[4],
+        allowedFileExtensions: rest[5],
+        compression: rest[6],
+        encryption: rest[7],
+        antivirus: rest[8]
+      };
+    }
+    const bucketId = params.bucketId;
+    const name = params.name;
+    const permissions = params.permissions;
+    const fileSecurity = params.fileSecurity;
+    const enabled = params.enabled;
+    const maximumFileSize = params.maximumFileSize;
+    const allowedFileExtensions = params.allowedFileExtensions;
+    const compression = params.compression;
+    const encryption = params.encryption;
+    const antivirus = params.antivirus;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -183,14 +210,16 @@ class Storage {
       payload
     );
   }
-  /**
-   * Delete a storage bucket by its unique ID.
-   *
-   * @param {string} bucketId
-   * @throws {AppwriteException}
-   * @returns {Promise<{}>}
-   */
-  deleteBucket(bucketId) {
+  deleteBucket(paramsOrFirst) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst
+      };
+    }
+    const bucketId = params.bucketId;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -207,16 +236,20 @@ class Storage {
       payload
     );
   }
-  /**
-   * Get a list of all the user files. You can use the query params to filter your results.
-   *
-   * @param {string} bucketId
-   * @param {string[]} queries
-   * @param {string} search
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.FileList>}
-   */
-  listFiles(bucketId, queries, search) {
+  listFiles(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        queries: rest[0],
+        search: rest[1]
+      };
+    }
+    const bucketId = params.bucketId;
+    const queries = params.queries;
+    const search = params.search;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -237,25 +270,25 @@ class Storage {
       payload
     );
   }
-  /**
-   * 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.
-   * 
-   * 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&#039;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&#039;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[]} permissions
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.File>}
-   */
-  createFile(bucketId, fileId, file, permissions, onProgress = (progress) => {
-  }) {
+  createFile(paramsOrFirst, ...rest) {
+    let params;
+    let onProgress;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+      onProgress = paramsOrFirst == null ? void 0 : paramsOrFirst.onProgress;
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0],
+        file: rest[1],
+        permissions: rest[2]
+      };
+      onProgress = rest[3];
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
+    const file = params.file;
+    const permissions = params.permissions;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -288,15 +321,18 @@ class Storage {
       onProgress
     );
   }
-  /**
-   * 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<Models.File>}
-   */
-  getFile(bucketId, fileId) {
+  getFile(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -314,17 +350,22 @@ class Storage {
       payload
     );
   }
-  /**
-   * 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} name
-   * @param {string[]} permissions
-   * @throws {AppwriteException}
-   * @returns {Promise<Models.File>}
-   */
-  updateFile(bucketId, fileId, name, permissions) {
+  updateFile(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0],
+        name: rest[1],
+        permissions: rest[2]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
+    const name = params.name;
+    const permissions = params.permissions;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -350,15 +391,18 @@ class Storage {
       payload
     );
   }
-  /**
-   * 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<{}>}
-   */
-  deleteFile(bucketId, fileId) {
+  deleteFile(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -378,16 +422,20 @@ class Storage {
       payload
     );
   }
-  /**
-   * Get a file content by its unique ID. The endpoint response return with a &#039;Content-Disposition: attachment&#039; header that tells the browser to start downloading the file to user downloads directory.
-   *
-   * @param {string} bucketId
-   * @param {string} fileId
-   * @param {string} token
-   * @throws {AppwriteException}
-   * @returns {Promise<ArrayBuffer>}
-   */
-  getFileDownload(bucketId, fileId, token) {
+  getFileDownload(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0],
+        token: rest[1]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
+    const token = params.token;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -409,27 +457,42 @@ class Storage {
       "arrayBuffer"
     );
   }
-  /**
-   * 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. Preview is supported only for image files smaller than 10MB.
-   *
-   * @param {string} bucketId
-   * @param {string} fileId
-   * @param {number} width
-   * @param {number} height
-   * @param {ImageGravity} gravity
-   * @param {number} quality
-   * @param {number} borderWidth
-   * @param {string} borderColor
-   * @param {number} borderRadius
-   * @param {number} opacity
-   * @param {number} rotation
-   * @param {string} background
-   * @param {ImageFormat} output
-   * @param {string} token
-   * @throws {AppwriteException}
-   * @returns {Promise<ArrayBuffer>}
-   */
-  getFilePreview(bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, token) {
+  getFilePreview(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0],
+        width: rest[1],
+        height: rest[2],
+        gravity: rest[3],
+        quality: rest[4],
+        borderWidth: rest[5],
+        borderColor: rest[6],
+        borderRadius: rest[7],
+        opacity: rest[8],
+        rotation: rest[9],
+        background: rest[10],
+        output: rest[11],
+        token: rest[12]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
+    const width = params.width;
+    const height = params.height;
+    const gravity = params.gravity;
+    const quality = params.quality;
+    const borderWidth = params.borderWidth;
+    const borderColor = params.borderColor;
+    const borderRadius = params.borderRadius;
+    const opacity = params.opacity;
+    const rotation = params.rotation;
+    const background = params.background;
+    const output = params.output;
+    const token = params.token;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }
@@ -484,16 +547,20 @@ class Storage {
       "arrayBuffer"
     );
   }
-  /**
-   * Get a file content by its unique ID. This endpoint is similar to the download method but returns with no  &#039;Content-Disposition: attachment&#039; header.
-   *
-   * @param {string} bucketId
-   * @param {string} fileId
-   * @param {string} token
-   * @throws {AppwriteException}
-   * @returns {Promise<ArrayBuffer>}
-   */
-  getFileView(bucketId, fileId, token) {
+  getFileView(paramsOrFirst, ...rest) {
+    let params;
+    if (paramsOrFirst && typeof paramsOrFirst === "object" && !Array.isArray(paramsOrFirst)) {
+      params = paramsOrFirst || {};
+    } else {
+      params = {
+        bucketId: paramsOrFirst,
+        fileId: rest[0],
+        token: rest[1]
+      };
+    }
+    const bucketId = params.bucketId;
+    const fileId = params.fileId;
+    const token = params.token;
     if (typeof bucketId === "undefined") {
       throw new client.AppwriteException('Missing required parameter: "bucketId"');
     }