appwrite-cli 5.0.3 → 6.0.0-rc.1

package/lib/commands/assistant.js

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -42,6 +42,7 @@ const assistant = new Command("assistant").description(commandDescriptions['assi
 /**
  * @typedef {Object} AssistantChatRequestParams
  * @property {string} prompt Prompt. A string containing questions asked to the AI assistant.
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -49,8 +50,9 @@ const assistant = new Command("assistant").description(commandDescriptions['assi
 /**
  * @param {AssistantChatRequestParams} params
  */
-const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const assistantChat = async ({prompt,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/console/assistant';
     let payload = {};
     if (typeof prompt !== 'undefined') {
@@ -67,8 +69,9 @@ const assistantChat = async ({ prompt, parseOutput = true, sdk = undefined}) =>
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 assistant
@@ -80,4 +83,4 @@ assistant
 module.exports = {
     assistant,
     assistantChat
-};
+};

package/lib/commands/avatars.js

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -45,6 +45,7 @@ const avatars = new Command("avatars").description(commandDescriptions['avatars'
  * @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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -53,8 +54,9 @@ const avatars = new Command("avatars").description(commandDescriptions['avatars'
 /**
  * @param {AvatarsGetBrowserRequestParams} params
  */
-const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetBrowser = async ({code,width,height,quality,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/browsers/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -66,10 +68,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -77,22 +81,27 @@ const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = t
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
  * @typedef {Object} AvatarsGetCreditCardRequestParams
- * @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 {CreditCard} code Credit Card Code. Possible values: amex, argencard, cabal, cencosud, 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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -101,8 +110,9 @@ const avatarsGetBrowser = async ({ code, width, height, quality, parseOutput = t
 /**
  * @param {AvatarsGetCreditCardRequestParams} params
  */
-const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetCreditCard = async ({code,width,height,quality,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/credit-cards/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -114,10 +124,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -125,19 +137,24 @@ const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -146,17 +163,20 @@ const avatarsGetCreditCard = async ({ code, width, height, quality, parseOutput
 /**
  * @param {AvatarsGetFaviconRequestParams} params
  */
-const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetFavicon = async ({url,parseOutput = true, overrideForCli = false, 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -164,14 +184,18 @@ const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, des
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -180,6 +204,7 @@ const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, des
  * @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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -188,8 +213,9 @@ const avatarsGetFavicon = async ({ url, parseOutput = true, sdk = undefined, des
 /**
  * @param {AvatarsGetFlagRequestParams} params
  */
-const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetFlag = async ({code,width,height,quality,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/flags/{code}'.replace('{code}', code);
     let payload = {};
     if (typeof width !== 'undefined') {
@@ -201,10 +227,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -212,14 +240,18 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -227,6 +259,7 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
  * @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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -235,8 +268,9 @@ const avatarsGetFlag = async ({ code, width, height, quality, parseOutput = true
 /**
  * @param {AvatarsGetImageRequestParams} params
  */
-const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetImage = async ({url,width,height,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/image';
     let payload = {};
     if (typeof url !== 'undefined') {
@@ -248,10 +282,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -259,14 +295,18 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -275,6 +315,7 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
  * @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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -283,8 +324,9 @@ const avatarsGetImage = async ({ url, width, height, parseOutput = true, sdk = u
 /**
  * @param {AvatarsGetInitialsRequestParams} params
  */
-const avatarsGetInitials = async ({ name, width, height, background, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetInitials = async ({name,width,height,background,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/initials';
     let payload = {};
     if (typeof name !== 'undefined') {
@@ -299,10 +341,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -310,14 +354,18 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 /**
@@ -326,6 +374,7 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
  * @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} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  * @property {string} destination
@@ -334,8 +383,9 @@ const avatarsGetInitials = async ({ name, width, height, background, parseOutput
 /**
  * @param {AvatarsGetQRRequestParams} params
  */
-const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true, sdk = undefined, destination}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const avatarsGetQR = async ({text,size,margin,download,parseOutput = true, overrideForCli = false, sdk = undefined, destination}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/avatars/qr';
     let payload = {};
     if (typeof text !== 'undefined') {
@@ -350,10 +400,12 @@ 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()}`;
+    if (!overrideForCli) {
+        payload['project'] = localConfig.getProject().projectId
+        payload['key'] = globalConfig.getKey();
+        const queryParams = new URLSearchParams(payload);
+        apiPath = `${globalConfig.getEndpoint()}${apiPath}?${queryParams.toString()}`;
+    }
 
     let response = undefined;
 
@@ -361,14 +413,18 @@ const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true,
         'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
-    fs.writeFileSync(destination, response);
+    if (overrideForCli) {
+        response = Buffer.from(response);
+    }
 
+    fs.writeFileSync(destination, response);
     if (parseOutput) {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 avatars
@@ -384,7 +440,7 @@ avatars
 avatars
     .command(`getCreditCard`)
     .description(`The credit card endpoint will return you the icon of the credit card provider you need. 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. `)
-    .requiredOption(`--code <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.`)
+    .requiredOption(`--code <code>`, `Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.`)
     .option(`--width <width>`, `Image width. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--height <height>`, `Image height. Pass an integer between 0 to 2000. Defaults to 100.`, parseInteger)
     .option(`--quality <quality>`, `Image quality. Pass an integer between 0 to 100. Defaults to 100.`, parseInteger)
@@ -446,4 +502,4 @@ module.exports = {
     avatarsGetImage,
     avatarsGetInitials,
     avatarsGetQR
-};
+};

package/lib/commands/console.js

@@ -4,7 +4,7 @@ const tar = require("tar");
 const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
-const { getAllFiles } = require('../utils.js');
+const { getAllFiles, showConsoleLink } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -41,6 +41,7 @@ const console = new Command("console").description(commandDescriptions['console'
 
 /**
  * @typedef {Object} ConsoleVariablesRequestParams
+ * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
  */
@@ -48,8 +49,9 @@ const console = new Command("console").description(commandDescriptions['console'
 /**
  * @param {ConsoleVariablesRequestParams} params
  */
-const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
-    let client = !sdk ? await sdkForProject() : sdk;
+const consoleVariables = async ({parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
     let apiPath = '/console/variables';
     let payload = {};
 
@@ -63,8 +65,9 @@ const consoleVariables = async ({ parseOutput = true, sdk = undefined}) => {
         parse(response)
         success()
     }
-    
+
     return response;
+
 }
 
 console
@@ -75,4 +78,4 @@ console
 module.exports = {
     console,
     consoleVariables
-};
+};