appwrite-cli 12.0.0 → 13.0.0-rc.1

package/lib/commands/{storage.js → storage.ts}

@@ -1,31 +1,27 @@
-const fs = require('fs');
-const pathLib = require('path');
-const tar = require("tar");
-const ignore = require("ignore");
-const { promisify } = require('util');
-const libClient = require('../client.js');
-const { getAllFiles, showConsoleLink } = require('../utils.js');
-const { Command } = require('commander');
-const { sdkForProject, sdkForConsole } = require('../sdks')
-const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } = require('../parser')
-const { localConfig, globalConfig } = require("../config");
-const { File } = require('undici');
-const { ReadableStream } = require('stream/web');
-
-/**
- * @param {fs.ReadStream} readStream
- * @returns {ReadableStream}
- */
-function convertReadStreamToReadableStream(readStream) {
+import fs = require('fs');
+import pathLib = require('path');
+import tar = require('tar');
+import ignore = require('ignore');
+import { promisify } from 'util';
+import Client from '../client';
+import { getAllFiles, showConsoleLink } from '../utils';
+import { Command } from 'commander';
+import { sdkForProject, sdkForConsole } from '../sdks';
+import { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log, warn } from '../parser';
+import { localConfig, globalConfig } from '../config';
+import { File } from 'undici';
+import { ReadableStream } from 'stream/web';
+
+function convertReadStreamToReadableStream(readStream: fs.ReadStream): ReadableStream {
   return new ReadableStream({
     start(controller) {
-      readStream.on("data", (chunk) => {
+      readStream.on("data", (chunk: Buffer) => {
         controller.enqueue(chunk);
       });
       readStream.on("end", () => {
         controller.close();
       });
-      readStream.on("error", (err) => {
+      readStream.on("error", (err: Error) => {
         controller.error(err);
       });
     },
@@ -35,24 +31,21 @@ function convertReadStreamToReadableStream(readStream) {
   });
 }
 
-const storage = new Command("storage").description(commandDescriptions['storage'] ?? '').configureHelp({
+export const storage = new Command("storage").description(commandDescriptions['storage'] ?? '').configureHelp({
     helpWidth: process.stdout.columns || 80
 })
 
-/**
- * @typedef {Object} StorageListBucketsRequestParams
- * @property {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
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageListBucketsRequestParams} params
- */
-const storageListBuckets = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface StorageListBucketsRequestParams {
+    queries?: string[];
+    search?: string;
+    total?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const storageListBuckets = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: StorageListBucketsRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets';
@@ -73,7 +66,7 @@ const storageListBuckets = async ({queries,search,total,parseOutput = true, over
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('storage', 'listBuckets');
          } else {
             parse(response)
@@ -83,28 +76,24 @@ const storageListBuckets = async ({queries,search,total,parseOutput = true, over
     return response;
 
 }
-/**
- * @typedef {Object} StorageCreateBucketRequestParams
- * @property {string} bucketId Unique Id. Choose a custom ID or generate a random ID with &#039;ID.unique()&#039;. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
- * @property {string} name Bucket name
- * @property {string[]} permissions An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} fileSecurity Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} enabled Is bucket enabled? When set to &#039;disabled&#039;, users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
- * @property {number} maximumFileSize Maximum file size allowed in bytes. Maximum allowed value is 30MB.
- * @property {string[]} allowedFileExtensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
- * @property {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&#039;s enabled
- * @property {boolean} encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
- * @property {boolean} antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
- * @property {boolean} transformations Are image transformations enabled?
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageCreateBucketRequestParams} params
- */
-const storageCreateBucket = async ({bucketId,name,permissions,fileSecurity,enabled,maximumFileSize,allowedFileExtensions,compression,encryption,antivirus,transformations,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageCreateBucketRequestParams {
+    bucketId: string;
+    name: string;
+    permissions?: string[];
+    fileSecurity?: boolean;
+    enabled?: boolean;
+    maximumFileSize?: number;
+    allowedFileExtensions?: string[];
+    compression?: Compression;
+    encryption?: boolean;
+    antivirus?: boolean;
+    transformations?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageCreateBucket = async ({bucketId,name,permissions,fileSecurity,enabled,maximumFileSize,allowedFileExtensions,compression,encryption,antivirus,transformations,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageCreateBucketRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets';
@@ -158,18 +147,15 @@ const storageCreateBucket = async ({bucketId,name,permissions,fileSecurity,enabl
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetBucketRequestParams
- * @property {string} bucketId Bucket unique ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageGetBucketRequestParams} params
- */
-const storageGetBucket = async ({bucketId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface StorageGetBucketRequestParams {
+    bucketId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const storageGetBucket = async ({bucketId,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: StorageGetBucketRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
@@ -181,7 +167,7 @@ const storageGetBucket = async ({bucketId,parseOutput = true, overrideForCli = f
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('storage', 'getBucket', bucketId);
          } else {
             parse(response)
@@ -191,28 +177,24 @@ const storageGetBucket = async ({bucketId,parseOutput = true, overrideForCli = f
     return response;
 
 }
-/**
- * @typedef {Object} StorageUpdateBucketRequestParams
- * @property {string} bucketId Bucket unique ID.
- * @property {string} name Bucket name
- * @property {string[]} permissions An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} fileSecurity Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} enabled Is bucket enabled? When set to &#039;disabled&#039;, users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.
- * @property {number} maximumFileSize Maximum file size allowed in bytes. Maximum allowed value is 30MB.
- * @property {string[]} allowedFileExtensions Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.
- * @property {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&#039;s enabled
- * @property {boolean} encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it&#039;s enabled
- * @property {boolean} antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it&#039;s enabled
- * @property {boolean} transformations Are image transformations enabled?
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageUpdateBucketRequestParams} params
- */
-const storageUpdateBucket = async ({bucketId,name,permissions,fileSecurity,enabled,maximumFileSize,allowedFileExtensions,compression,encryption,antivirus,transformations,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageUpdateBucketRequestParams {
+    bucketId: string;
+    name: string;
+    permissions?: string[];
+    fileSecurity?: boolean;
+    enabled?: boolean;
+    maximumFileSize?: number;
+    allowedFileExtensions?: string[];
+    compression?: Compression;
+    encryption?: boolean;
+    antivirus?: boolean;
+    transformations?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageUpdateBucket = async ({bucketId,name,permissions,fileSecurity,enabled,maximumFileSize,allowedFileExtensions,compression,encryption,antivirus,transformations,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageUpdateBucketRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
@@ -263,18 +245,14 @@ const storageUpdateBucket = async ({bucketId,name,permissions,fileSecurity,enabl
     return response;
 
 }
-/**
- * @typedef {Object} StorageDeleteBucketRequestParams
- * @property {string} bucketId Bucket unique ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageDeleteBucketRequestParams} params
- */
-const storageDeleteBucket = async ({bucketId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageDeleteBucketRequestParams {
+    bucketId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageDeleteBucket = async ({bucketId,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageDeleteBucketRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
@@ -293,21 +271,18 @@ const storageDeleteBucket = async ({bucketId,parseOutput = true, overrideForCli
     return response;
 
 }
-/**
- * @typedef {Object} StorageListFilesRequestParams
- * @property {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).
- * @property {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
- * @property {string} search Search term to filter your list results. Max length: 256 chars.
- * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageListFilesRequestParams} params
- */
-const storageListFiles = async ({bucketId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface StorageListFilesRequestParams {
+    bucketId: string;
+    queries?: string[];
+    search?: string;
+    total?: boolean;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const storageListFiles = async ({bucketId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: StorageListFilesRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
@@ -328,7 +303,7 @@ const storageListFiles = async ({bucketId,queries,search,total,parseOutput = tru
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('storage', 'listFiles', bucketId);
          } else {
             parse(response)
@@ -338,22 +313,18 @@ const storageListFiles = async ({bucketId,queries,search,total,parseOutput = tru
     return response;
 
 }
-/**
- * @typedef {Object} StorageCreateFileRequestParams
- * @property {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).
- * @property {string} fileId File ID. Choose a custom ID or generate a random ID with &#039;ID.unique()&#039;. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can&#039;t start with a special char. Max length is 36 chars.
- * @property {string} file Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).
- * @property {string[]} permissions An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- * @property {CallableFunction} onProgress
- */
-
-/**
- * @param {StorageCreateFileRequestParams} params
- */
-const storageCreateFile = async ({bucketId,fileId,file,permissions,parseOutput = true, overrideForCli = false, sdk = undefined,onProgress = () => {}}) => {
+interface StorageCreateFileRequestParams {
+    bucketId: string;
+    fileId: string;
+    file: string;
+    permissions?: string[];
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    onProgress?: (progress: number) => void;
+}
+
+export const storageCreateFile = async ({bucketId,fileId,file,permissions,parseOutput = true, overrideForCli = false, sdk = undefined,onProgress = () => {}}: StorageCreateFileRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
@@ -470,19 +441,16 @@ const storageCreateFile = async ({bucketId,fileId,file,permissions,parseOutput =
 
     return response;
 }
-/**
- * @typedef {Object} StorageGetFileRequestParams
- * @property {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).
- * @property {string} fileId File ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageGetFileRequestParams} params
- */
-const storageGetFile = async ({bucketId,fileId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface StorageGetFileRequestParams {
+    bucketId: string;
+    fileId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const storageGetFile = async ({bucketId,fileId,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: StorageGetFileRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -494,7 +462,7 @@ const storageGetFile = async ({bucketId,fileId,parseOutput = true, overrideForCl
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('storage', 'getFile', bucketId, fileId);
          } else {
             parse(response)
@@ -504,21 +472,17 @@ const storageGetFile = async ({bucketId,fileId,parseOutput = true, overrideForCl
     return response;
 
 }
-/**
- * @typedef {Object} StorageUpdateFileRequestParams
- * @property {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).
- * @property {string} fileId File unique ID.
- * @property {string} name Name of the file
- * @property {string[]} permissions An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageUpdateFileRequestParams} params
- */
-const storageUpdateFile = async ({bucketId,fileId,name,permissions,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageUpdateFileRequestParams {
+    bucketId: string;
+    fileId: string;
+    name?: string;
+    permissions?: string[];
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageUpdateFile = async ({bucketId,fileId,name,permissions,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageUpdateFileRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -544,19 +508,15 @@ const storageUpdateFile = async ({bucketId,fileId,name,permissions,parseOutput =
     return response;
 
 }
-/**
- * @typedef {Object} StorageDeleteFileRequestParams
- * @property {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).
- * @property {string} fileId File ID.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageDeleteFileRequestParams} params
- */
-const storageDeleteFile = async ({bucketId,fileId,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageDeleteFileRequestParams {
+    bucketId: string;
+    fileId: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageDeleteFile = async ({bucketId,fileId,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageDeleteFileRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -575,21 +535,17 @@ const storageDeleteFile = async ({bucketId,fileId,parseOutput = true, overrideFo
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetFileDownloadRequestParams
- * @property {string} bucketId Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
- * @property {string} fileId File ID.
- * @property {string} token File token for accessing this file.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- * @property {string} destination
- */
-
-/**
- * @param {StorageGetFileDownloadRequestParams} params
- */
-const storageGetFileDownload = async ({bucketId,fileId,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+interface StorageGetFileDownloadRequestParams {
+    bucketId: string;
+    fileId: string;
+    token?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    destination?: string;
+}
+
+export const storageGetFileDownload = async ({bucketId,fileId,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}: StorageGetFileDownloadRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -621,32 +577,28 @@ const storageGetFileDownload = async ({bucketId,fileId,token,parseOutput = true,
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetFilePreviewRequestParams
- * @property {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).
- * @property {string} fileId File ID
- * @property {number} width Resize preview image width, Pass an integer between 0 to 4000.
- * @property {number} height Resize preview image height, Pass an integer between 0 to 4000.
- * @property {ImageGravity} gravity Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right
- * @property {number} quality Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
- * @property {number} borderWidth Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.
- * @property {string} borderColor Preview image border color. Use a valid HEX color, no # is needed for prefix.
- * @property {number} borderRadius Preview image border radius in pixels. Pass an integer between 0 to 4000.
- * @property {number} opacity Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.
- * @property {number} rotation Preview image rotation in degrees. Pass an integer between -360 and 360.
- * @property {string} background Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.
- * @property {ImageFormat} output Output format type (jpeg, jpg, png, gif and webp).
- * @property {string} token File token for accessing this file.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- * @property {string} destination
- */
-
-/**
- * @param {StorageGetFilePreviewRequestParams} params
- */
-const storageGetFilePreview = async ({bucketId,fileId,width,height,gravity,quality,borderWidth,borderColor,borderRadius,opacity,rotation,background,output,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+interface StorageGetFilePreviewRequestParams {
+    bucketId: string;
+    fileId: string;
+    width?: number;
+    height?: number;
+    gravity?: ImageGravity;
+    quality?: number;
+    borderWidth?: number;
+    borderColor?: string;
+    borderRadius?: number;
+    opacity?: number;
+    rotation?: number;
+    background?: string;
+    output?: ImageFormat;
+    token?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    destination?: string;
+}
+
+export const storageGetFilePreview = async ({bucketId,fileId,width,height,gravity,quality,borderWidth,borderColor,borderRadius,opacity,rotation,background,output,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}: StorageGetFilePreviewRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -711,21 +663,17 @@ const storageGetFilePreview = async ({bucketId,fileId,width,height,gravity,quali
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetFileViewRequestParams
- * @property {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).
- * @property {string} fileId File ID.
- * @property {string} token File token for accessing this file.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- * @property {string} destination
- */
-
-/**
- * @param {StorageGetFileViewRequestParams} params
- */
-const storageGetFileView = async ({bucketId,fileId,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+interface StorageGetFileViewRequestParams {
+    bucketId: string;
+    fileId: string;
+    token?: string;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    destination?: string;
+}
+
+export const storageGetFileView = async ({bucketId,fileId,token,parseOutput = true, overrideForCli = false, sdk = undefined, destination}: StorageGetFileViewRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
@@ -757,18 +705,14 @@ const storageGetFileView = async ({bucketId,fileId,token,parseOutput = true, ove
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetUsageRequestParams
- * @property {UsageRange} range Date range.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageGetUsageRequestParams} params
- */
-const storageGetUsage = async ({range,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+interface StorageGetUsageRequestParams {
+    range?: UsageRange;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+}
+
+export const storageGetUsage = async ({range,parseOutput = true, overrideForCli = false, sdk = undefined}: StorageGetUsageRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/usage';
@@ -789,19 +733,16 @@ const storageGetUsage = async ({range,parseOutput = true, overrideForCli = false
     return response;
 
 }
-/**
- * @typedef {Object} StorageGetBucketUsageRequestParams
- * @property {string} bucketId Bucket ID.
- * @property {UsageRange} range Date range.
- * @property {boolean} overrideForCli
- * @property {boolean} parseOutput
- * @property {libClient | undefined} sdk
- */
-
-/**
- * @param {StorageGetBucketUsageRequestParams} params
- */
-const storageGetBucketUsage = async ({bucketId,range,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+interface StorageGetBucketUsageRequestParams {
+    bucketId: string;
+    range?: UsageRange;
+    overrideForCli?: boolean;
+    parseOutput?: boolean;
+    sdk?: Client;
+    console?: boolean;
+}
+
+export const storageGetBucketUsage = async ({bucketId,range,parseOutput = true, overrideForCli = false, sdk = undefined, console: showConsole}: StorageGetBucketUsageRequestParams): Promise<any> => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/storage/{bucketId}/usage'.replace('{bucketId}', bucketId);
@@ -816,7 +757,7 @@ const storageGetBucketUsage = async ({bucketId,range,parseOutput = true, overrid
     }, payload);
 
     if (parseOutput) {
-        if(console) {
+        if(showConsole) {
             showConsoleLink('storage', 'getBucketUsage', bucketId);
          } else {
             parse(response)
@@ -831,7 +772,7 @@ storage
     .description(`Get a list of all the storage buckets. You can use the query params to filter your results.`)
     .option(`--queries [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`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
-    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .option(`--console`, `Get the resource console url`)
     .action(actionRunner(storageListBuckets))
 
@@ -841,14 +782,14 @@ storage
     .requiredOption(`--bucket-id <bucket-id>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
     .requiredOption(`--name <name>`, `Bucket name`)
     .option(`--permissions [permissions...]`, `An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
-    .option(`--file-security [value]`, `Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--enabled [value]`, `Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--file-security [value]`, `Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--enabled [value]`, `Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .option(`--maximum-file-size <maximum-file-size>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
     .option(`--allowed-file-extensions [allowed-file-extensions...]`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
     .option(`--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`)
-    .option(`--encryption [value]`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--antivirus [value]`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--transformations [value]`, `Are image transformations enabled?`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--encryption [value]`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--antivirus [value]`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--transformations [value]`, `Are image transformations enabled?`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(storageCreateBucket))
 
 storage
@@ -864,14 +805,14 @@ storage
     .requiredOption(`--bucket-id <bucket-id>`, `Bucket unique ID.`)
     .requiredOption(`--name <name>`, `Bucket name`)
     .option(`--permissions [permissions...]`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).`)
-    .option(`--file-security [value]`, `Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--enabled [value]`, `Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--file-security [value]`, `Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https://appwrite.io/docs/permissions).`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--enabled [value]`, `Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .option(`--maximum-file-size <maximum-file-size>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
     .option(`--allowed-file-extensions [allowed-file-extensions...]`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
     .option(`--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`)
-    .option(`--encryption [value]`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--antivirus [value]`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, (value) => value === undefined ? true : parseBool(value))
-    .option(`--transformations [value]`, `Are image transformations enabled?`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--encryption [value]`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--antivirus [value]`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, (value: string | undefined) => value === undefined ? true : parseBool(value))
+    .option(`--transformations [value]`, `Are image transformations enabled?`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .action(actionRunner(storageUpdateBucket))
 
 storage
@@ -886,7 +827,7 @@ storage
     .requiredOption(`--bucket-id <bucket-id>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).`)
     .option(`--queries [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`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
-    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
+    .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value: string | undefined) => value === undefined ? true : parseBool(value))
     .option(`--console`, `Get the resource console url`)
     .action(actionRunner(storageListFiles))
 
@@ -975,21 +916,4 @@ storage
     .option(`--console`, `Get the resource console url`)
     .action(actionRunner(storageGetBucketUsage))
 
-module.exports = {
-    storage,
-    storageListBuckets,
-    storageCreateBucket,
-    storageGetBucket,
-    storageUpdateBucket,
-    storageDeleteBucket,
-    storageListFiles,
-    storageCreateFile,
-    storageGetFile,
-    storageUpdateFile,
-    storageDeleteFile,
-    storageGetFileDownload,
-    storageGetFilePreview,
-    storageGetFileView,
-    storageGetUsage,
-    storageGetBucketUsage
-};
+