appwrite-cli 4.2.0 → 4.2.2

package/lib/commands/proxy.js

@@ -9,130 +9,199 @@ 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 { File } = require('undici');
+const { ReadableStream } = require('stream/web');
+
+/**
+ * @param {fs.ReadStream} readStream
+ * @returns {ReadableStream}
+ */
+function convertReadStreamToReadableStream(readStream) {
+  return new ReadableStream({
+    start(controller) {
+      readStream.on("data", (chunk) => {
+        controller.enqueue(chunk);
+      });
+      readStream.on("end", () => {
+        controller.close();
+      });
+      readStream.on("error", (err) => {
+        controller.error(err);
+      });
+    },
+    cancel() {
+      readStream.destroy();
+    },
+  });
+}
 
 const proxy = new Command("proxy").description(commandDescriptions['proxy']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
-
+})
+
+/**
+ * @typedef {Object} ProxyListRulesRequestParams
+ * @property {string[]} 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
+ * @property {string} search Search term to filter your list results. Max length: 256 chars.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {ProxyListRulesRequestParams} params
+ */
 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;
 }
 
+/**
+ * @typedef {Object} ProxyCreateRuleRequestParams
+ * @property {string} domain Domain name.
+ * @property {string} resourceType Action definition for the rule. Possible values are "api", "function"
+ * @property {string} resourceId ID of resource for the action type. If resourceType is "api", leave empty. If resourceType is "function", provide ID of the function.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {ProxyCreateRuleRequestParams} params
+ */
 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 */
+/**
+ * @typedef {Object} ProxyGetRuleRequestParams
+ * @property {string} ruleId Rule ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {ProxyGetRuleRequestParams} params
+ */
+const proxyGetRule = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
     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 */
+/**
+ * @typedef {Object} ProxyDeleteRuleRequestParams
+ * @property {string} ruleId Rule ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {ProxyDeleteRuleRequestParams} params
+ */
+const proxyDeleteRule = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
     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 */
+/**
+ * @typedef {Object} ProxyUpdateRuleVerificationRequestParams
+ * @property {string} ruleId Rule ID.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {ProxyUpdateRuleVerificationRequestParams} params
+ */
+const proxyUpdateRuleVerification = async ({ ruleId, parseOutput = true, sdk = undefined}) => {
     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.`)
@@ -166,7 +235,6 @@ proxy
     .requiredOption(`--ruleId <ruleId>`, `Rule ID.`)
     .action(actionRunner(proxyUpdateRuleVerification))
 
-
 module.exports = {
     proxy,
     proxyListRules,
@@ -174,4 +242,4 @@ module.exports = {
     proxyGetRule,
     proxyDeleteRule,
     proxyUpdateRuleVerification
-};
+};