appwrite-cli 2.0.1 → 3.0.0

package/lib/commands/proxy.js

@@ -0,0 +1,177 @@
+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 } = require('../utils.js');
+const { Command } = require('commander');
+const { sdkForProject, sdkForConsole } = require('../sdks')
+const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
+const { localConfig, globalConfig } = require("../config");
+
+const proxy = new Command("proxy").description(commandDescriptions['proxy']).configureHelp({
+    helpWidth: process.stdout.columns || 80
+  })
+
+const proxyListRules = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
+    /* @param {string[]} queries */
+    /* @param {string} search */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/proxy/rules';
+    let payload = {};
+
+    /** Query Params */
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
+    }
+    if (typeof search !== 'undefined') {
+        payload['search'] = search;
+    }
+    let response = undefined;
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const proxyCreateRule = async ({ domain, resourceType, resourceId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} domain */
+    /* @param {string} resourceType */
+    /* @param {string} resourceId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/proxy/rules';
+    let payload = {};
+    
+    /** Body Params */
+
+    if (typeof domain !== 'undefined') {
+        payload['domain'] = domain;
+    }
+
+
+    if (typeof resourceType !== 'undefined') {
+        payload['resourceType'] = resourceType;
+    }
+
+
+    if (typeof resourceId !== 'undefined') {
+        payload['resourceId'] = resourceId;
+    }
+
+    let response = undefined;
+    response = await client.call('post', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const proxyGetRule = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} ruleId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/proxy/rules/{ruleId}'.replace('{ruleId}', ruleId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const proxyDeleteRule = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} ruleId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/proxy/rules/{ruleId}'.replace('{ruleId}', ruleId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('delete', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const proxyUpdateRuleVerification = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} ruleId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let apiPath = '/proxy/rules/{ruleId}/verification'.replace('{ruleId}', ruleId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('patch', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+
+proxy
+    .command(`listRules`)
+    .description(`Get a list of all the proxy rules. 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/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url`)
+    .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
+    .action(actionRunner(proxyListRules))
+
+proxy
+    .command(`createRule`)
+    .description(`Create a new proxy rule.`)
+    .requiredOption(`--domain <domain>`, `Domain name.`)
+    .requiredOption(`--resourceType <resourceType>`, `Action definition for the rule. Possible values are "api", "function"`)
+    .option(`--resourceId <resourceId>`, `ID of resource for the action type. If resourceType is "api", leave empty. If resourceType is "function", provide ID of the function.`)
+    .action(actionRunner(proxyCreateRule))
+
+proxy
+    .command(`getRule`)
+    .description(`Get a proxy rule by its unique ID.`)
+    .requiredOption(`--ruleId <ruleId>`, `Rule ID.`)
+    .action(actionRunner(proxyGetRule))
+
+proxy
+    .command(`deleteRule`)
+    .description(`Delete a proxy rule by its unique ID.`)
+    .requiredOption(`--ruleId <ruleId>`, `Rule ID.`)
+    .action(actionRunner(proxyDeleteRule))
+
+proxy
+    .command(`updateRuleVerification`)
+    .description(``)
+    .requiredOption(`--ruleId <ruleId>`, `Rule ID.`)
+    .action(actionRunner(proxyUpdateRuleVerification))
+
+
+module.exports = {
+    proxy,
+    proxyListRules,
+    proxyCreateRule,
+    proxyGetRule,
+    proxyDeleteRule,
+    proxyUpdateRuleVerification
+};

package/lib/commands/storage.js

@@ -19,7 +19,7 @@ const storageListBuckets = async ({ queries, search, parseOutput = true, sdk = u
     /* @param {string} search */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets';
+    let apiPath = '/storage/buckets';
     let payload = {};
 
     /** Query Params */
@@ -30,7 +30,7 @@ const storageListBuckets = async ({ queries, search, parseOutput = true, sdk = u
         payload['search'] = search;
     }
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -54,7 +54,7 @@ const storageCreateBucket = async ({ bucketId, name, permissions, fileSecurity,
     /* @param {boolean} antivirus */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets';
+    let apiPath = '/storage/buckets';
     let payload = {};
     
     /** Body Params */
@@ -111,7 +111,7 @@ const storageCreateBucket = async ({ bucketId, name, permissions, fileSecurity,
     }
 
     let response = undefined;
-    response = await client.call('post', path, {
+    response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -126,10 +126,10 @@ const storageGetBucket = async ({ bucketId, parseOutput = true, sdk = undefined}
     /* @param {string} bucketId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
     let payload = {};
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -153,7 +153,7 @@ const storageUpdateBucket = async ({ bucketId, name, permissions, fileSecurity,
     /* @param {boolean} antivirus */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
     let payload = {};
     
     /** Body Params */
@@ -205,7 +205,7 @@ const storageUpdateBucket = async ({ bucketId, name, permissions, fileSecurity,
     }
 
     let response = undefined;
-    response = await client.call('put', path, {
+    response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -220,10 +220,10 @@ const storageDeleteBucket = async ({ bucketId, parseOutput = true, sdk = undefin
     /* @param {string} bucketId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/buckets/{bucketId}'.replace('{bucketId}', bucketId);
     let payload = {};
     let response = undefined;
-    response = await client.call('delete', path, {
+    response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -240,7 +240,7 @@ const storageListFiles = async ({ bucketId, queries, search, parseOutput = true,
     /* @param {string} search */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
     let payload = {};
 
     /** Query Params */
@@ -251,7 +251,7 @@ const storageListFiles = async ({ bucketId, queries, search, parseOutput = true,
         payload['search'] = search;
     }
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -269,7 +269,7 @@ const storageCreateFile = async ({ bucketId, fileId, file, permissions, parseOut
     /* @param {string[]} permissions */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/buckets/{bucketId}/files'.replace('{bucketId}', bucketId);
     let payload = {};
     
     /** Body Params */
@@ -295,7 +295,7 @@ const storageCreateFile = async ({ bucketId, fileId, file, permissions, parseOut
     if (size <= libClient.CHUNK_SIZE) {
         payload['file'] = fs.createReadStream(payload['file']);
 
-        response = await client.call('post', path, {
+        response = await client.call('post', apiPath, {
             'content-type': 'multipart/form-data',
         }, payload)
     } else {
@@ -311,7 +311,7 @@ const storageCreateFile = async ({ bucketId, fileId, file, permissions, parseOut
 
         if(fileId != 'unique()') {
             try {
-                response = await client.call('get', path + '/' + fileId, headers);
+                response = await client.call('get', apiPath + '/' + fileId, headers);
                 counter = response.chunksUploaded;
             } catch(e) {
             }
@@ -333,7 +333,7 @@ const storageCreateFile = async ({ bucketId, fileId, file, permissions, parseOut
             });
             payload['file'] = stream;
 
-            response = await client.call('post', path, headers, payload);
+            response = await client.call('post', apiPath, headers, payload);
 
             if (!id) {
                 id = response['$id'];
@@ -363,10 +363,10 @@ const storageGetFile = async ({ bucketId, fileId, parseOutput = true, sdk = unde
     /* @param {string} fileId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -377,16 +377,22 @@ const storageGetFile = async ({ bucketId, fileId, parseOutput = true, sdk = unde
     return response;
 }
 
-const storageUpdateFile = async ({ bucketId, fileId, permissions, parseOutput = true, sdk = undefined}) => {
+const storageUpdateFile = async ({ bucketId, fileId, name, permissions, parseOutput = true, sdk = undefined}) => {
     /* @param {string} bucketId */
     /* @param {string} fileId */
+    /* @param {string} name */
     /* @param {string[]} permissions */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
     
     /** Body Params */
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
     permissions = permissions === true ? [] : permissions;
 
     if (typeof permissions !== 'undefined') {
@@ -394,7 +400,7 @@ const storageUpdateFile = async ({ bucketId, fileId, permissions, parseOutput =
     }
 
     let response = undefined;
-    response = await client.call('put', path, {
+    response = await client.call('put', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -410,10 +416,10 @@ const storageDeleteFile = async ({ bucketId, fileId, parseOutput = true, sdk = u
     /* @param {string} fileId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
     let response = undefined;
-    response = await client.call('delete', path, {
+    response = await client.call('delete', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -429,14 +435,14 @@ const storageGetFileDownload = async ({ bucketId, fileId, parseOutput = true, sd
     /* @param {string} fileId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
-    path = `${globalConfig.getEndpoint()}${path}?${queryParams.toString()}`;
+    apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', path, {
+    const response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
@@ -464,7 +470,7 @@ const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity,
     /* @param {string} output */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
 
     /** Query Params */
@@ -504,9 +510,9 @@ const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity,
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
-    path = `${globalConfig.getEndpoint()}${path}?${queryParams.toString()}`;
+    apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', path, {
+    const response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
@@ -523,14 +529,14 @@ const storageGetFileView = async ({ bucketId, fileId, parseOutput = true, sdk =
     /* @param {string} fileId */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
+    let apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replace('{bucketId}', bucketId).replace('{fileId}', fileId);
     let payload = {};
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
-    path = `${globalConfig.getEndpoint()}${path}?${queryParams.toString()}`;
+    apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', path, {
+    const response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
@@ -546,7 +552,7 @@ const storageGetUsage = async ({ range, parseOutput = true, sdk = undefined}) =>
     /* @param {string} range */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/usage';
+    let apiPath = '/storage/usage';
     let payload = {};
 
     /** Query Params */
@@ -554,7 +560,7 @@ const storageGetUsage = async ({ range, parseOutput = true, sdk = undefined}) =>
         payload['range'] = range;
     }
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -570,7 +576,7 @@ const storageGetBucketUsage = async ({ bucketId, range, parseOutput = true, sdk
     /* @param {string} range */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/storage/{bucketId}/usage'.replace('{bucketId}', bucketId);
+    let apiPath = '/storage/{bucketId}/usage'.replace('{bucketId}', bucketId);
     let payload = {};
 
     /** Query Params */
@@ -578,7 +584,7 @@ const storageGetBucketUsage = async ({ bucketId, range, parseOutput = true, sdk
         payload['range'] = range;
     }
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
     
@@ -604,8 +610,8 @@ storage
     .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](/docs/permissions).`)
     .option(`--fileSecurity <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](/docs/permissions).`, parseBool)
-    .option(`--enabled <enabled>`, `Is bucket enabled?`, parseBool)
-    .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the '_APP_STORAGE_LIMIT' environment variable. [Learn more about storage environment variables](/docs/environment-variables#storage)`, parseInteger)
+    .option(`--enabled <enabled>`, `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.`, parseBool)
+    .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
     .option(`--allowedFileExtensions [allowedFileExtensions...]`, `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 <encryption>`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, parseBool)
@@ -625,8 +631,8 @@ storage
     .requiredOption(`--name <name>`, `Bucket name`)
     .option(`--permissions [permissions...]`, `An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).`)
     .option(`--fileSecurity <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](/docs/permissions).`, parseBool)
-    .option(`--enabled <enabled>`, `Is bucket enabled?`, parseBool)
-    .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](/docs/environment-variables#storage)`, parseInteger)
+    .option(`--enabled <enabled>`, `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.`, parseBool)
+    .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB.`, parseInteger)
     .option(`--allowedFileExtensions [allowedFileExtensions...]`, `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 <encryption>`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, parseBool)
@@ -668,6 +674,7 @@ storage
     .description(`Update a file by its unique ID. Only users with write permissions have access to update this resource.`)
     .requiredOption(`--bucketId <bucketId>`, `Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](/docs/server/storage#createBucket).`)
     .requiredOption(`--fileId <fileId>`, `File unique ID.`)
+    .option(`--name <name>`, `Name of the file`)
     .option(`--permissions [permissions...]`, `An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](/docs/permissions).`)
     .action(actionRunner(storageUpdateFile))