appwrite-cli 4.2.1 → 5.0.0

package/lib/commands/assistant.js

@@ -37,7 +37,7 @@ function convertReadStreamToReadableStream(readStream) {
 
 const assistant = new Command("assistant").description(commandDescriptions['assistant']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} AssistantChatRequestParams
@@ -51,21 +51,18 @@ const assistant = new Command("assistant").description(commandDescriptions['assi
  */
 const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/console/assistant';
     let payload = {};
     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()
@@ -74,15 +71,13 @@ const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) =>
     return response;
 }
 
-
 assistant
     .command(`chat`)
     .description(``)
     .requiredOption(`--prompt <prompt>`, `Prompt. A string containing questions asked to the AI assistant.`)
     .action(actionRunner(assistantChat))
 
-
 module.exports = {
     assistant,
-    assistantChat    
+    assistantChat
 };

package/lib/commands/avatars.js

@@ -37,17 +37,17 @@ function convertReadStreamToReadableStream(readStream) {
 
 const avatars = new Command("avatars").description(commandDescriptions['avatars']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} AvatarsGetBrowserRequestParams
- * @property {string} code Browser Code.
+ * @property {Browser} 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
+ * @property {string} destination
  */
 
 /**
@@ -55,7 +55,6 @@ const avatars = new Command("avatars").description(commandDescriptions['avatars'
  */
 const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -67,20 +66,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -91,13 +89,13 @@ const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = t
 
 /**
  * @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 {CreditCard} 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
+ * @property {string} destination
  */
 
 /**
@@ -105,7 +103,6 @@ const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = t
  */
 const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -117,20 +114,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -144,7 +140,7 @@ const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput
  * @property {string} url Website URL which you want to fetch the favicon from.
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
-* @property {string} destination
+ * @property {string} destination
  */
 
 /**
@@ -152,26 +148,24 @@ const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput
  */
 const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/favicon';
     let payload = {};
     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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -182,13 +176,13 @@ const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, des
 
 /**
  * @typedef {Object} AvatarsGetFlagRequestParams
- * @property {string} code Country Code. ISO Alpha-2 country code format.
+ * @property {Flag} 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
+ * @property {string} destination
  */
 
 /**
@@ -196,7 +190,6 @@ const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, des
  */
 const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/flags/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -208,20 +201,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -237,7 +229,7 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
  * @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
+ * @property {string} destination
  */
 
 /**
@@ -245,7 +237,6 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
  */
 const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/image';
     let payload = {};
     if (typeof url !== 'undefined') {
@@ -257,20 +248,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -287,7 +277,7 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
  * @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
+ * @property {string} destination
  */
 
 /**
@@ -295,7 +285,6 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
  */
 const avatarsGetInitials = async ({ name, width, height, background, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/initials';
     let payload = {};
     if (typeof name !== 'undefined') {
@@ -310,20 +299,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -340,7 +328,7 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
  * @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
+ * @property {string} destination
  */
 
 /**
@@ -348,7 +336,6 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
  */
 const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true, sdk = undefined, destination}) => {
     let client = !sdk ? await sdkForProject() : sdk;
-    
     let apiPath = '/avatars/qr';
     let payload = {};
     if (typeof text !== 'undefined') {
@@ -363,20 +350,19 @@ 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()}`;
 
     let response = undefined;
-    
+
     response = await client.call('get', apiPath, {
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     fs.writeFileSync(destination, response);
-    
+
     if (parseOutput) {
         parse(response)
         success()
@@ -385,7 +371,6 @@ const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true,
     return response;
 }
 
-
 avatars
     .command(`getBrowser`)
     .description(`You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.  When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.`)
@@ -452,14 +437,13 @@ avatars
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetQR))
 
-
 module.exports = {
     avatars,
-    avatarsGetBrowser,    
-    avatarsGetCreditCard,    
-    avatarsGetFavicon,    
-    avatarsGetFlag,    
-    avatarsGetImage,    
-    avatarsGetInitials,    
-    avatarsGetQR    
+    avatarsGetBrowser,
+    avatarsGetCreditCard,
+    avatarsGetFavicon,
+    avatarsGetFlag,
+    avatarsGetImage,
+    avatarsGetInitials,
+    avatarsGetQR
 };

package/lib/commands/console.js

@@ -37,7 +37,7 @@ function convertReadStreamToReadableStream(readStream) {
 
 const console = new Command("console").description(commandDescriptions['console']).configureHelp({
     helpWidth: process.stdout.columns || 80
-  })
+})
 
 /**
  * @typedef {Object} ConsoleVariablesRequestParams
@@ -50,18 +50,15 @@ const console = new Command("console").description(commandDescriptions['console'
  */
 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()
@@ -70,14 +67,12 @@ const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
-
 console
     .command(`variables`)
     .description(`Get all Environment Variables that are relevant for the console.`)
     .action(actionRunner(consoleVariables))
 
-
 module.exports = {
     console,
-    consoleVariables    
+    consoleVariables
 };