appwrite-cli 4.2.0 → 4.2.1

package/lib/commands/assistant.js

@@ -9,33 +9,68 @@ 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 assistant = new Command("assistant").description(commandDescriptions['assistant']).configureHelp({
     helpWidth: process.stdout.columns || 80
   })
 
-const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) => {
-    /* @param {string} prompt */
+/**
+ * @typedef {Object} AssistantChatRequestParams
+ * @property {string} prompt Prompt. A string containing questions asked to the AI assistant.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {AssistantChatRequestParams} params
+ */
+const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/console/assistant';
     let payload = {};
-    
-    /** Body Params */
-
     if (typeof prompt !== 'undefined') {
         payload['prompt'] = prompt;
     }
 
+
     let response = undefined;
+    
     response = await client.call('post', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
@@ -49,5 +84,5 @@ assistant
 
 module.exports = {
     assistant,
-    assistantChat
-};
+    assistantChat    
+};

package/lib/commands/avatars.js

@@ -9,22 +9,55 @@ 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 avatars = new Command("avatars").description(commandDescriptions['avatars']).configureHelp({
     helpWidth: process.stdout.columns || 80
   })
 
+/**
+ * @typedef {Object} AvatarsGetBrowserRequestParams
+ * @property {string} code Browser Code.
+ * @property {number} width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetBrowserRequestParams} params
+ */
 const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} code */
-    /* @param {number} width */
-    /* @param {number} height */
-    /* @param {number} quality */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
     let payload = {};
-
-    /** Query Params */
     if (typeof width !== 'undefined') {
         payload['width'] = width;
     }
@@ -34,34 +67,47 @@ const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = t
     if (typeof quality !== 'undefined') {
         payload['quality'] = quality;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetCreditCardRequestParams
+ * @property {string} code Credit Card Code. Possible values: amex, argencard, cabal, censosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.
+ * @property {number} width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetCreditCardRequestParams} params
+ */
 const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} code */
-    /* @param {number} width */
-    /* @param {number} height */
-    /* @param {number} quality */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
     let payload = {};
-
-    /** Query Params */
     if (typeof width !== 'undefined') {
         payload['width'] = width;
     }
@@ -71,62 +117,88 @@ const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput
     if (typeof quality !== 'undefined') {
         payload['quality'] = quality;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetFaviconRequestParams
+ * @property {string} url Website URL which you want to fetch the favicon from.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetFaviconRequestParams} params
+ */
 const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} url */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/favicon';
     let payload = {};
-
-    /** Query Params */
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetFlagRequestParams
+ * @property {string} code Country Code. ISO Alpha-2 country code format.
+ * @property {number} width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} quality Image quality. Pass an integer between 0 to 100. Defaults to 100.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetFlagRequestParams} params
+ */
 const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} code */
-    /* @param {number} width */
-    /* @param {number} height */
-    /* @param {number} quality */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/flags/{code}'.replace('{code}', code);
     let payload = {};
-
-    /** Query Params */
     if (typeof width !== 'undefined') {
         payload['width'] = width;
     }
@@ -136,33 +208,46 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
     if (typeof quality !== 'undefined') {
         payload['quality'] = quality;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetImageRequestParams
+ * @property {string} url Image URL which you want to crop.
+ * @property {number} width Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.
+ * @property {number} height Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetImageRequestParams} params
+ */
 const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} url */
-    /* @param {number} width */
-    /* @param {number} height */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/image';
     let payload = {};
-
-    /** Query Params */
     if (typeof url !== 'undefined') {
         payload['url'] = url;
     }
@@ -172,34 +257,47 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
     if (typeof height !== 'undefined') {
         payload['height'] = height;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetInitialsRequestParams
+ * @property {string} name Full Name. When empty, current user name or email will be used. Max length: 128 chars.
+ * @property {number} width Image width. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {number} height Image height. Pass an integer between 0 to 2000. Defaults to 100.
+ * @property {string} background Changes background color. By default a random color will be picked and stay will persistent to the given name.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetInitialsRequestParams} params
+ */
 const avatarsGetInitials = async ({ name, width, height, background, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} name */
-    /* @param {number} width */
-    /* @param {number} height */
-    /* @param {string} background */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/initials';
     let payload = {};
-
-    /** Query Params */
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -212,34 +310,47 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
     if (typeof background !== 'undefined') {
         payload['background'] = background;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
+/**
+ * @typedef {Object} AvatarsGetQRRequestParams
+ * @property {string} text Plain text to be converted to QR code image.
+ * @property {number} size QR code size. Pass an integer between 1 to 1000. Defaults to 400.
+ * @property {number} margin Margin from edge. Pass an integer between 0 to 10. Defaults to 1.
+ * @property {boolean} download Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+* @property {string} destination
+ */
+
+/**
+ * @param {AvatarsGetQRRequestParams} params
+ */
 const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true, sdk = undefined, destination}) => {
-    /* @param {string} text */
-    /* @param {number} size */
-    /* @param {number} margin */
-    /* @param {boolean} download */
-
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/avatars/qr';
     let payload = {};
-
-    /** Query Params */
     if (typeof text !== 'undefined') {
         payload['text'] = text;
     }
@@ -252,21 +363,26 @@ const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true,
     if (typeof download !== 'undefined') {
         payload['download'] = download;
     }
+
     payload['project'] = localConfig.getProject().projectId
     payload['key'] = globalConfig.getKey();
     const queryParams = new URLSearchParams(payload);
     apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
 
-    const response = await client.call('get', apiPath, {
+    let response = undefined;
+    
+    response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-
-    if (parseOutput) { 
-        log(`File stored in ${destination}`)
+    
+    if (parseOutput) {
+        parse(response)
         success()
     }
+    
+    return response;
 }
 
 
@@ -339,11 +455,11 @@ avatars
 
 module.exports = {
     avatars,
-    avatarsGetBrowser,
-    avatarsGetCreditCard,
-    avatarsGetFavicon,
-    avatarsGetFlag,
-    avatarsGetImage,
-    avatarsGetInitials,
-    avatarsGetQR
-};
+    avatarsGetBrowser,    
+    avatarsGetCreditCard,    
+    avatarsGetFavicon,    
+    avatarsGetFlag,    
+    avatarsGetImage,    
+    avatarsGetInitials,    
+    avatarsGetQR    
+};

package/lib/commands/console.js

@@ -9,25 +9,64 @@ 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 console = new Command("console").description(commandDescriptions['console']).configureHelp({
     helpWidth: process.stdout.columns || 80
   })
 
-const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
+/**
+ * @typedef {Object} ConsoleVariablesRequestParams
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
 
+/**
+ * @param {ConsoleVariablesRequestParams} params
+ */
+const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
+    
     let apiPath = '/console/variables';
     let payload = {};
+
+
     let response = undefined;
+    
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload);
+
     
     if (parseOutput) {
         parse(response)
         success()
     }
+    
     return response;
 }
 
@@ -40,5 +79,5 @@ console
 
 module.exports = {
     console,
-    consoleVariables
-};
+    consoleVariables    
+};