appwrite-cli 0.15.0 → 0.17.1

package/.github/workflows/npm-publish.yml

@@ -13,7 +13,6 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
       - name: Setup binfmt with QEMU
         run: | 
-          sudo apt update
           sudo apt install qemu binfmt-support qemu-user-static
           update-binfmts --display
       - name: Setup ldid

package/README.md

@@ -1,12 +1,12 @@
 # Appwrite Command Line SDK
 
 ![License](https://img.shields.io/github/license/appwrite/sdk-for-cli.svg?style=flat-square)
-![Version](https://img.shields.io/badge/api%20version-0.13.0-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.14.0-blue.svg?style=flat-square)
 [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator)
 [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite)
 [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version latest. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
+**This SDK is compatible with Appwrite server version 0.14.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-cli/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Command Line SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
 
@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-0.15.0
+0.17.1
 ```
 
 ### Install using prebuilt binaries
@@ -58,7 +58,7 @@ $ iwr -useb https://appwrite.io/cli/install.ps1 | iex
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-0.15.0
+0.17.1
 ```
 
 ## Getting Started 

package/docs/examples/account/update-status.md

@@ -0,0 +1 @@
+appwrite account updateStatus

package/docs/examples/teams/list-logs.md

@@ -0,0 +1,4 @@
+appwrite teams listLogs \
+        --teamId [TEAM_ID] \
+
+

package/docs/examples/users/get-memberships.md

@@ -0,0 +1,2 @@
+appwrite users getMemberships \
+        --userId [USER_ID]

package/install.ps1

@@ -13,14 +13,17 @@
 # You can use "View source" of this page to see the full script.
 
 # REPO
-$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.15.0/appwrite-cli-win-x64.exe"
-$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.15.0/appwrite-cli-win-arm64.exe"
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.17.1/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/0.17.1/appwrite-cli-win-arm64.exe"
+
+$APPWRITE_BINARY_NAME = "appwrite.exe"
 
 # Appwrite download directory
-$APPWRITE_DOWNLOAD_DIR = Join-Path -Path $env:TEMP -ChildPath "appwrite.exe"
+$APPWRITE_DOWNLOAD_DIR = Join-Path -Path $env:TEMP -ChildPath $APPWRITE_BINARY_NAME
 
 # Appwrite CLI location
 $APPWRITE_INSTALL_DIR = Join-Path -Path $env:LOCALAPPDATA -ChildPath "Appwrite"
+$APPWRITE_INSTALL_PATH = Join-Path -Path "$APPWRITE_INSTALL_DIR" -ChildPath "$APPWRITE_BINARY_NAME"
 
 $USER_PATH_ENV_VAR = [Environment]::GetEnvironmentVariable("PATH", "User")
 
@@ -58,9 +61,9 @@ function DownloadBinary {
     } else {
       Invoke-WebRequest -Uri $GITHUB_x64_URL -OutFile $APPWRITE_DOWNLOAD_DIR
     }
-   
 
-   Move-Item $APPWRITE_DOWNLOAD_DIR $APPWRITE_INSTALL_DIR
+    New-Item -ItemType Directory -Path $APPWRITE_INSTALL_DIR
+    Move-Item $APPWRITE_DOWNLOAD_DIR $APPWRITE_INSTALL_PATH
 }
 
 
@@ -71,6 +74,7 @@ function Install {
         Write-Host "Skipping to add Appwrite to User Path."
     } else {
         [System.Environment]::SetEnvironmentVariable("PATH", $USER_PATH_ENV_VAR + ";$APPWRITE_INSTALL_DIR", "User")
+        $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") 
     }
 }
 

package/install.sh

@@ -97,7 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    GITHUB_LATEST_VERSION="0.15.0"
+    GITHUB_LATEST_VERSION="0.17.1"
     GITHUB_FILE="appwrite-cli-${OS}-${ARCH}"
     GITHUB_URL="https://github.com/$GITHUB_REPOSITORY_NAME/releases/download/$GITHUB_LATEST_VERSION/$GITHUB_FILE"
 

package/lib/client.js

@@ -1,5 +1,6 @@
 const os = require('os');
 const axios = require("axios");
+const JSONbig = require("json-bigint")({ storeAsString: false });
 const FormData = require("form-data");
 const AppwriteException = require("./exception.js");
 const { globalConfig } = require("./config.js");
@@ -11,9 +12,9 @@ class Client {
     this.endpoint = 'https://HOSTNAME/v1';
     this.headers = {
       'content-type': '',
-      'x-sdk-version': 'appwrite:cli:0.15.0',
-      'User-Agent' : `AppwriteCLI/0.15.0 (${os.type()} ${os.version()}; ${os.arch()})`,
-      'X-Appwrite-Response-Format' : '0.13.0',
+      'x-sdk-version': 'appwrite:cli:0.17.1',
+      'User-Agent' : `AppwriteCLI/0.17.1 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'X-Appwrite-Response-Format' : '0.14.0',
     };
   }
 
@@ -180,11 +181,9 @@ class Client {
       params: method.toUpperCase() === "GET" ? params : {},
       headers: headers,
       data:
-        method.toUpperCase() === "GET" ||
-          contentType.startsWith("multipart/form-data")
-          ? formData
-          : params,
+        method.toUpperCase() === "GET" || contentType.startsWith("multipart/form-data") ? formData : params,
       json: contentType.startsWith("application/json"),
+      transformRequest: method.toUpperCase() === "GET" || contentType.startsWith("multipart/form-data") ? undefined : (data) =>  JSONbig.stringify(data),
       responseType: responseType,
     };
     try {

package/lib/commands/account.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
 const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -65,23 +68,6 @@ const accountCreate = async ({ userId, email, password, name, parseOutput = true
     return response;
 }
 
-const accountDelete = async ({ parseOutput = true, sdk = undefined}) => {
-
-    let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/account';
-    let payload = {};
-    let response = undefined;
-    response = await client.call('delete', path, {
-        'content-type': 'application/json',
-    }, payload);
-    
-    if (parseOutput) {
-        parse(response)
-        success()
-    }
-    return response;
-}
-
 const accountUpdateEmail = async ({ email, password, parseOutput = true, sdk = undefined}) => {
     /* @param {string} email */
     /* @param {string} password */
@@ -234,7 +220,7 @@ const accountUpdatePrefs = async ({ prefs, parseOutput = true, sdk = undefined})
     
     /** Body Params */
     if (typeof prefs !== 'undefined') {
-        payload['prefs'] = prefs;
+        payload['prefs'] = JSON.parse(prefs);
     }
 
     let response = undefined;
@@ -546,6 +532,23 @@ const accountDeleteSession = async ({ sessionId, parseOutput = true, sdk = undef
     return response;
 }
 
+const accountUpdateStatus = async ({ parseOutput = true, sdk = undefined}) => {
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/account/status';
+    let payload = {};
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const accountCreateVerification = async ({ url, parseOutput = true, sdk = undefined}) => {
     /* @param {string} url */
 
@@ -614,11 +617,6 @@ account
     .option(`--name <name>`, `User name. Max length: 128 chars.`)
     .action(actionRunner(accountCreate))
 
-account
-    .command(`delete`)
-    .description(`Delete a currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. This is done to avoid deleted accounts being overtaken by new users with the same email address. Any user-related resources like documents or storage files should be deleted separately.`)
-    .action(actionRunner(accountDelete))
-
 account
     .command(`updateEmail`)
     .description(`Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request. This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password. `)
@@ -646,7 +644,7 @@ account
 
 account
     .command(`updatePassword`)
-    .description(`Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth and Team Invites, oldPassword is optional.`)
+    .description(`Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.`)
     .requiredOption(`--password <password>`, `New user password. Must be at least 8 chars.`)
     .option(`--oldPassword <oldPassword>`, `Current user password. Must be at least 8 chars.`)
     .action(actionRunner(accountUpdatePassword))
@@ -718,10 +716,10 @@ account
 account
     .command(`createOAuth2Session`)
     .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.. `)
-    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, vk, yahoo, yammer, yandex, wordpress, stripe.`)
+    .requiredOption(`--provider <provider>`, `OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, bitbucket, bitly, box, discord, dropbox, facebook, github, gitlab, google, linkedin, microsoft, notion, okta, paypal, paypalSandbox, salesforce, slack, spotify, tradeshift, tradeshiftBox, twitch, zoom, yahoo, yammer, yandex, wordpress, stripe.`)
     .option(`--success <success>`, `URL to redirect back to your app after a successful login attempt.  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(`--failure <failure>`, `URL to redirect back to your app after a failed login attempt.  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(`--scopes <scopes...>`, `A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes.`)
+    .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 128 characters long.`)
     .action(actionRunner(accountCreateOAuth2Session))
 
 account
@@ -732,7 +730,7 @@ account
 
 account
     .command(`updateSession`)
-    .description(``)
+    .description(`Access tokens have limited lifespan and expire to mitigate security risks. If session was created using an OAuth provider, this route can be used to "refresh" the access token.`)
     .requiredOption(`--sessionId <sessionId>`, `Session ID. Use the string 'current' to update the current device session.`)
     .action(actionRunner(accountUpdateSession))
 
@@ -742,6 +740,11 @@ account
     .requiredOption(`--sessionId <sessionId>`, `Session ID. Use the string 'current' to delete the current device session.`)
     .action(actionRunner(accountDeleteSession))
 
+account
+    .command(`updateStatus`)
+    .description(`Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.`)
+    .action(actionRunner(accountUpdateStatus))
+
 account
     .command(`createVerification`)
     .description(`Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateVerification). The verification link sent to the user's email address is valid for 7 days.  Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. `)
@@ -760,7 +763,6 @@ module.exports = {
     account,
     accountGet,
     accountCreate,
-    accountDelete,
     accountUpdateEmail,
     accountCreateJWT,
     accountGetLogs,
@@ -780,6 +782,7 @@ module.exports = {
     accountGetSession,
     accountUpdateSession,
     accountDeleteSession,
+    accountUpdateStatus,
     accountCreateVerification,
     accountUpdateVerification
-};
+};

package/lib/commands/avatars.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
 const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -271,7 +274,7 @@ const avatarsGetQR = async ({ text, size, margin, download, parseOutput = true,
 
 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 /account/sessions endpoint. Use width, height and quality arguments to change the output settings.`)
+    .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](/docs/client/account#accountGetSessions) 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.`)
     .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)
@@ -281,7 +284,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.`)
+    .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.`)
     .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)
@@ -298,7 +301,7 @@ avatars
 
 avatars
     .command(`getFlag`)
-    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings.`)
+    .description(`You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. 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>`, `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)
@@ -308,16 +311,16 @@ avatars
 
 avatars
     .command(`getImage`)
-    .description(`Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.`)
+    .description(`Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.  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 400x400px. `)
     .requiredOption(`--url <url>`, `Image URL which you want to crop.`)
-    .option(`--width <width>`, `Resize preview image width, Pass an integer between 0 to 2000.`, parseInteger)
-    .option(`--height <height>`, `Resize preview image height, Pass an integer between 0 to 2000.`, parseInteger)
+    .option(`--width <width>`, `Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.`, parseInteger)
+    .option(`--height <height>`, `Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.`, parseInteger)
     .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(avatarsGetImage))
 
 avatars
     .command(`getInitials`)
-    .description(`Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.  You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.`)
+    .description(`Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.  You can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.  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. `)
     .option(`--name <name>`, `Full Name. When empty, current user name or email will be used. Max length: 128 chars.`)
     .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)
@@ -328,9 +331,9 @@ avatars
 
 avatars
     .command(`getQR`)
-    .description(`Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.`)
+    .description(`Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image. `)
     .requiredOption(`--text <text>`, `Plain text to be converted to QR code image.`)
-    .option(`--size <size>`, `QR code size. Pass an integer between 0 to 1000. Defaults to 400.`, parseInteger)
+    .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)
     .requiredOption(`--destination <path>`, `output file path.`)
@@ -346,4 +349,4 @@ module.exports = {
     avatarsGetImage,
     avatarsGetInitials,
     avatarsGetQR
-};
+};

package/lib/commands/database.js

@@ -1,7 +1,10 @@
 const fs = require('fs');
+const pathLib = require('path');
 const tar = require("tar");
+const ignore = require("ignore");
 const { promisify } = require('util');
 const libClient = require('../client.js');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -648,7 +651,7 @@ const databaseCreateDocument = async ({ collectionId, documentId, data, read, wr
     }
 
     if (typeof data !== 'undefined') {
-        payload['data'] = data;
+        payload['data'] = JSON.parse(data);
     }
 
     if (typeof read !== 'undefined') {
@@ -703,7 +706,7 @@ const databaseUpdateDocument = async ({ collectionId, documentId, data, read, wr
     
     /** Body Params */
     if (typeof data !== 'undefined') {
-        payload['data'] = data;
+        payload['data'] = JSON.parse(data);
     }
 
     if (typeof read !== 'undefined') {
@@ -962,7 +965,7 @@ database
     .description(`Create a new Collection.`)
     .requiredOption(`--collectionId <collectionId>`, `Unique Id. Choose your own unique ID or pass the string "unique()" to auto generate it. 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(`--name <name>`, `Collection name. Max length: 128 chars.`)
-    .requiredOption(`--permission <permission>`, `Permissions type model to use for reading documents in this collection. You can use collection-level permission set once on the collection using the 'read' and 'write' params, or you can set document-level permission where each document read and write params will decide who has access to read and write to each document individually. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
+    .requiredOption(`--permission <permission>`, `Specifies the permissions model used in this collection, which accepts either 'collection' or 'document'. For 'collection' level permission, the permissions specified in read and write params are applied to all documents in the collection. For 'document' level permissions, read and write permissions are specified in each document. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .requiredOption(`--read <read...>`, `An array of strings with read permissions. By default no user is granted with any read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .requiredOption(`--write <write...>`, `An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .action(actionRunner(databaseCreateCollection))
@@ -1021,7 +1024,7 @@ database
     .description(``)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--key <key>`, `Attribute Key.`)
-    .requiredOption(`--elements <elements...>`, `Array of elements in enumerated type. Uses length of longest element to determine size.`)
+    .requiredOption(`--elements <elements...>`, `Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 1024 characters long.`)
     .requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
     .option(`--xdefault <xdefault>`, `Default value for attribute when not provided. Cannot be set when attribute is required.`)
     .option(`--array <array>`, `Is attribute an array?`, parseBool)
@@ -1100,13 +1103,13 @@ database
     .command(`listDocuments`)
     .description(`Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's documents. [Learn more about different API modes](/docs/admin).`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
-    .option(`--queries <queries...>`, `Array of query strings.`)
+    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/database#querying-documents). Maximum of 100 queries are allowed, each 128 characters long.`)
     .option(`--limit <limit>`, `Maximum number of documents to return in response. By default will return maximum 25 results. Maximum of 100 results allowed per request.`, parseInteger)
     .option(`--offset <offset>`, `Offset value. The default value is 0. Use this value to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
     .option(`--cursor <cursor>`, `ID of the document used as the starting point for the query, excluding the document itself. Should be used for efficient pagination when working with large sets of data. [learn more about pagination](https://appwrite.io/docs/pagination)`)
     .option(`--cursorDirection <cursorDirection>`, `Direction of the cursor.`)
-    .option(`--orderAttributes <orderAttributes...>`, `Array of attributes used to sort results.`)
-    .option(`--orderTypes <orderTypes...>`, `Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order.`)
+    .option(`--orderAttributes <orderAttributes...>`, `Array of attributes used to sort results. Maximum of 100 order attributes are allowed, each 128 characters long.`)
+    .option(`--orderTypes <orderTypes...>`, `Array of order directions for sorting attribtues. Possible values are DESC for descending order, or ASC for ascending order. Maximum of 100 order types are allowed.`)
     .action(actionRunner(databaseListDocuments))
 
 database
@@ -1131,14 +1134,14 @@ database
     .description(`Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID.`)
     .requiredOption(`--documentId <documentId>`, `Document ID.`)
-    .requiredOption(`--data <data>`, `Document data as JSON object.`)
+    .requiredOption(`--data <data>`, `Document data as JSON object. Include only attribute and value pairs to be updated.`)
     .option(`--read <read...>`, `An array of strings with read permissions. By default inherits the existing read permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .option(`--write <write...>`, `An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](https://appwrite.io/docs/permissions) and get a full list of available permissions.`)
     .action(actionRunner(databaseUpdateDocument))
 
 database
     .command(`deleteDocument`)
-    .description(`Delete a document by its unique ID. This endpoint deletes only the parent documents, its attributes and relations to other documents. Child documents **will not** be deleted.`)
+    .description(`Delete a document by its unique ID.`)
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--documentId <documentId>`, `Document ID.`)
     .action(actionRunner(databaseDeleteDocument))
@@ -1164,8 +1167,8 @@ database
     .requiredOption(`--collectionId <collectionId>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/database#createCollection).`)
     .requiredOption(`--key <key>`, `Index Key.`)
     .requiredOption(`--type <type>`, `Index type.`)
-    .requiredOption(`--attributes <attributes...>`, `Array of attributes to index.`)
-    .option(`--orders <orders...>`, `Array of index orders.`)
+    .requiredOption(`--attributes <attributes...>`, `Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.`)
+    .option(`--orders <orders...>`, `Array of index orders. Maximum of 100 orders are allowed.`)
     .action(actionRunner(databaseCreateIndex))
 
 database
@@ -1235,4 +1238,4 @@ module.exports = {
     databaseListCollectionLogs,
     databaseGetUsage,
     databaseGetCollectionUsage
-};
+};

package/lib/commands/deploy.js

@@ -1,4 +1,5 @@
 const inquirer = require("inquirer");
+const JSONbig = require("json-bigint")({ storeAsString: false });
 const { Command } = require("commander");
 const { localConfig } = require("../config");
 const { questionsDeployFunctions, questionsGetEntrypoint, questionsDeployCollections } = require("../questions");
@@ -148,7 +149,7 @@ const deployFunction = async () => {
     let response = {};
 
     let answers = await inquirer.prompt(questionsDeployFunctions)
-    let functions = answers.functions
+    let functions = answers.functions.map((func) => JSONbig.parse(func))
 
     for (let func of functions) {
         log(`Deploying function ${func.name} ( ${func['$id']} )`)
@@ -167,7 +168,7 @@ const deployFunction = async () => {
                 functionId: func['$id'],
                 name: func.name,
                 execute: func.execute,
-                vars: response.vars,
+                vars: JSON.stringify(response.vars),
                 events: func.events,
                 schedule: func.schedule,
                 timeout: func.timeout,
@@ -181,7 +182,7 @@ const deployFunction = async () => {
                     name: func.name,
                     runtime: func.runtime,
                     execute: func.execute,
-                    vars: func.vars,
+                    vars: JSON.stringify(func.vars),
                     events: func.events,
                     schedule: func.schedule,
                     timeout: func.timeout,
@@ -319,7 +320,7 @@ const createAttribute = async (collectionId, attribute) => {
 const deployCollection = async () => {
     let response = {};
     let answers = await inquirer.prompt(questionsDeployCollections[0])
-    let collections = answers.collections
+    let collections = answers.collections.map((collection) => JSONbig.parse(collection));
 
     for (let collection of collections) {
         log(`Deploying collection ${collection.name} ( ${collection['$id']} )`)