appwrite-cli 6.2.3 → 8.0.0

package/lib/commands/account.js

@@ -58,7 +58,6 @@ const accountGet = async ({parseOutput = true, overrideForCli = false, sdk = und
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -210,7 +209,6 @@ const accountListIdentities = async ({queries,parseOutput = true, overrideForCli
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -305,7 +303,6 @@ const accountListLogs = async ({queries,parseOutput = true, overrideForCli = fal
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -538,7 +535,6 @@ const accountListMfaFactors = async ({parseOutput = true, overrideForCli = false
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -568,7 +564,6 @@ const accountGetMfaRecoveryCodes = async ({parseOutput = true, overrideForCli =
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -768,7 +763,6 @@ const accountGetPrefs = async ({parseOutput = true, overrideForCli = false, sdk
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -912,7 +906,6 @@ const accountListSessions = async ({parseOutput = true, overrideForCli = false,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -1065,7 +1058,7 @@ const accountUpdateMagicURLSession = async ({userId,secret,parseOutput = true, o
 
 /**
  * @typedef {Object} AccountCreateOAuth2SessionRequestParams
- * @property {OAuthProvider} provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+ * @property {OAuthProvider} provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
  * @property {string} success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
  * @property {string} failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
  * @property {string[]} scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1095,7 +1088,6 @@ const accountCreateOAuth2Session = async ({provider,success,failure,scopes,parse
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -1202,7 +1194,6 @@ const accountGetSession = async ({sessionId,parseOutput = true, overrideForCli =
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -1503,7 +1494,7 @@ const accountCreateMagicURLToken = async ({userId,email,url,phrase,parseOutput =
 
 /**
  * @typedef {Object} AccountCreateOAuth2TokenRequestParams
- * @property {OAuthProvider} provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
+ * @property {OAuthProvider} provider OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.
  * @property {string} success URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
  * @property {string} failure URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.
  * @property {string[]} scopes A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.
@@ -1533,7 +1524,6 @@ const accountCreateOAuth2Token = async ({provider,success,failure,scopes,parseOu
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -1775,7 +1765,7 @@ account
 account
     .command(`update-mfa`)
     .description(`Enable or disable MFA on an account.`)
-    .requiredOption(`--mfa <mfa>`, `Enable or disable MFA.`, parseBool)
+    .requiredOption(`--mfa [value]`, `Enable or disable MFA.`, (value) => value === undefined ? true : parseBool(value))
     .action(actionRunner(accountUpdateMFA))
 
 account
@@ -1909,7 +1899,7 @@ account
 account
     .command(`create-o-auth-2-session`)
     .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.  If there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits). `)
-    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.`)
+    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--scopes [scopes...]`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.`)
@@ -1978,7 +1968,7 @@ account
     .description(`Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).`)
     .requiredOption(`--user-id <user-id>`, `User ID. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
     .requiredOption(`--email <email>`, `User email.`)
-    .option(`--phrase <phrase>`, `Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.`, parseBool)
+    .option(`--phrase [value]`, `Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.`, (value) => value === undefined ? true : parseBool(value))
     .action(actionRunner(accountCreateEmailToken))
 
 account
@@ -1987,13 +1977,13 @@ account
     .requiredOption(`--user-id <user-id>`, `Unique Id. Choose a custom ID or generate a random ID with 'ID.unique()'. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.`)
     .requiredOption(`--email <email>`, `User email.`)
     .option(`--url <url>`, `URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
-    .option(`--phrase <phrase>`, `Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.`, parseBool)
+    .option(`--phrase [value]`, `Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.`, (value) => value === undefined ? true : parseBool(value))
     .action(actionRunner(accountCreateMagicURLToken))
 
 account
     .command(`create-o-auth-2-token`)
     .description(`Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.   If authentication succeeds, 'userId' and 'secret' of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) endpoint.  A user is limited to 10 active sessions at a time by default. [Learn more about session limits](https://appwrite.io/docs/authentication-security#limits).`)
-    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.`)
+    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https://cheatsheetseries.owasp.org/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.`)
     .option(`--scopes [scopes...]`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.`)

package/lib/commands/avatars.js

@@ -44,7 +44,7 @@ const avatars = new Command("avatars").description(commandDescriptions['avatars'
  * @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 {number} quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -78,7 +78,6 @@ const avatarsGetBrowser = async ({code,width,height,quality,parseOutput = true,
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -99,7 +98,7 @@ const avatarsGetBrowser = async ({code,width,height,quality,parseOutput = true,
  * @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, rupay.
  * @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 {number} quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -133,7 +132,6 @@ const avatarsGetCreditCard = async ({code,width,height,quality,parseOutput = tru
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -179,7 +177,6 @@ const avatarsGetFavicon = async ({url,parseOutput = true, overrideForCli = false
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -200,7 +197,7 @@ const avatarsGetFavicon = async ({url,parseOutput = true, overrideForCli = false
  * @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 {number} quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -234,7 +231,6 @@ const avatarsGetFlag = async ({code,width,height,quality,parseOutput = true, ove
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -288,7 +284,6 @@ const avatarsGetImage = async ({url,width,height,parseOutput = true, overrideFor
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -346,7 +341,6 @@ const avatarsGetInitials = async ({name,width,height,background,parseOutput = tr
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -404,7 +398,6 @@ const avatarsGetQR = async ({text,size,margin,download,parseOutput = true, overr
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload, 'arraybuffer');
 
     if (overrideForCli) {
@@ -426,7 +419,7 @@ avatars
     .requiredOption(`--code <code>`, `Browser Code.`)
     .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)
+    .option(`--quality <quality>`, `Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.`, parseInteger)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetBrowser))
 
@@ -436,7 +429,7 @@ avatars
     .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, rupay.`)
     .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)
+    .option(`--quality <quality>`, `Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.`, parseInteger)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetCreditCard))
 
@@ -453,7 +446,7 @@ avatars
     .requiredOption(`--code <code>`, `Country Code. ISO Alpha-2 country code format.`)
     .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)
+    .option(`--quality <quality>`, `Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.`, parseInteger)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetFlag))
 
@@ -482,7 +475,7 @@ avatars
     .requiredOption(`--text <text>`, `Plain text to be converted to QR code image.`)
     .option(`--size <size>`, `QR code size. Pass an integer between 1 to 1000. Defaults to 400.`, parseInteger)
     .option(`--margin <margin>`, `Margin from edge. Pass an integer between 0 to 10. Defaults to 1.`, parseInteger)
-    .option(`--download <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.`, parseBool)
+    .option(`--download [value]`, `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.`, (value) => value === undefined ? true : parseBool(value))
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetQR))
 

package/lib/commands/console.js

@@ -39,6 +39,47 @@ const console = new Command("console").description(commandDescriptions['console'
     helpWidth: process.stdout.columns || 80
 })
 
+/**
+ * @typedef {Object} ConsoleGetResourceRequestParams
+ * @property {string} value Resource value.
+ * @property {ConsoleResourceType} type Resource type.
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {ConsoleGetResourceRequestParams} params
+ */
+const consoleGetResource = async ({value,type,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/console/resources';
+    let payload = {};
+    if (typeof value !== 'undefined') {
+        payload['value'] = value;
+    }
+    if (typeof type !== 'undefined') {
+        payload['type'] = type;
+    }
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('console', 'getResource');
+         } else {
+            parse(response)
+        }
+    }
+
+    return response;
+
+}
+
 /**
  * @typedef {Object} ConsoleVariablesRequestParams
  * @property {boolean} overrideForCli
@@ -58,7 +99,6 @@ const consoleVariables = async ({parseOutput = true, overrideForCli = false, sdk
     let response = undefined;
 
     response = await client.call('get', apiPath, {
-        'content-type': 'application/json',
     }, payload);
 
     if (parseOutput) {
@@ -69,6 +109,14 @@ const consoleVariables = async ({parseOutput = true, overrideForCli = false, sdk
 
 }
 
+console
+    .command(`get-resource`)
+    .description(`Check if a resource ID is available.`)
+    .requiredOption(`--value <value>`, `Resource value.`)
+    .requiredOption(`--type <type>`, `Resource type.`)
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(consoleGetResource))
+
 console
     .command(`variables`)
     .description(`Get all Environment Variables that are relevant for the console.`)
@@ -76,5 +124,6 @@ console
 
 module.exports = {
     console,
+    consoleGetResource,
     consoleVariables
 };