appwrite-cli 0.14.0 → 0.17.0

package/lib/commands/storage.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 childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -269,7 +272,7 @@ const storageListFiles = async ({ bucketId, search, limit, offset, cursor, curso
 const storageCreateFile = async ({ bucketId, fileId, file, read, write, parseOutput = true, sdk = undefined, onProgress = () => {}}) => {
     /* @param {string} bucketId */
     /* @param {string} fileId */
-    /* @param {File} file */
+    /* @param {string} file */
     /* @param {string[]} read */
     /* @param {string[]} write */
 
@@ -303,40 +306,57 @@ const storageCreateFile = async ({ bucketId, fileId, file, read, write, parseOut
 
         response = await client.call('post', path, {
             'content-type': 'multipart/form-data',
-        }, payload);
+        }, payload)
     } else {
         const streamFilePath = payload['file'];
         let id = undefined;
 
+        let counter = 0;
         const totalCounters = Math.ceil(size / libClient.CHUNK_SIZE);
 
-        for (let counter = 0; counter < totalCounters; counter++) {
-                const start = (counter * libClient.CHUNK_SIZE);
-                const end = Math.min((((counter * libClient.CHUNK_SIZE) + libClient.CHUNK_SIZE) - 1), size);
-                const headers = {
-                        'content-type': 'multipart/form-data',
-                        'content-range': 'bytes ' + start + '-' + end + '/' + size
-                };
-
-                if (id) {
-                        headers['x-appwrite-id'] = id;
-                }
-
-                const stream = fs.createReadStream(streamFilePath, {
-                        start,
-                        end
-                });
-                payload['file'] = stream;
+        const headers = {
+            'content-type': 'multipart/form-data',
+        };
+
+        if(fileId != 'unique()') {
+            try {
+                response = await client.call('get', path + '/' + fileId, headers);
+                counter = response.chunksUploaded;
+            } catch(e) {
+            }
+        }
+
+        for (counter; counter < totalCounters; counter++) {
+            const start = (counter * libClient.CHUNK_SIZE);
+            const end = Math.min((((counter * libClient.CHUNK_SIZE) + libClient.CHUNK_SIZE) - 1), size);
+
+            headers['content-range'] = 'bytes ' + start + '-' + end + '/' + size;
+
+            if (id) {
+                headers['x-appwrite-id'] = id;
+            }
+
+            const stream = fs.createReadStream(streamFilePath, {
+                start,
+                end
+            });
+            payload['file'] = stream;
 
-                response = await client.call('post', path, headers, payload);
+            response = await client.call('post', path, headers, payload);
 
-                if (!id) {
-                        id = response['$id'];
-                }
+            if (!id) {
+                id = response['$id'];
+            }
 
-                if (onProgress !== null) {
-                        onProgress(Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100);
-                }
+            if (onProgress !== null) {
+                onProgress({
+                    $id: response['$id'],
+                    progress: Math.min((counter+1) * libClient.CHUNK_SIZE, size) / size * 100,
+                    sizeUploaded: end+1,
+                    chunksTotal: response['chunksTotal'],
+                    chunksUploaded: response['chunksUploaded']
+                });
+            }
         }
     }
     
@@ -440,7 +460,7 @@ const storageGetFileDownload = async ({ bucketId, fileId, parseOutput = true, sd
     }
 }
 
-const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, parseOutput = true, sdk = undefined}) => {
+const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity, quality, borderWidth, borderColor, borderRadius, opacity, rotation, background, output, parseOutput = true, sdk = undefined, destination}) => {
     /* @param {string} bucketId */
     /* @param {string} fileId */
     /* @param {number} width */
@@ -493,16 +513,21 @@ const storageGetFilePreview = async ({ bucketId, fileId, width, height, gravity,
     if (typeof output !== 'undefined') {
         payload['output'] = output;
     }
-    let response = undefined;
-    response = await client.call('get', path, {
+    payload['project'] = localConfig.getProject().projectId
+    payload['key'] = globalConfig.getKey();
+    const queryParams = new URLSearchParams(payload);
+    path = `${globalConfig.getEndpoint()}${path}?${queryParams.toString()}`;
+
+    const response = await client.call('get', path, {
         'content-type': 'application/json',
-    }, payload);
-    
-    if (parseOutput) {
-        parse(response)
+    }, payload, 'arraybuffer');
+
+    fs.writeFileSync(destination, response);
+
+    if (parseOutput) { 
+        log(`File stored in ${destination}`)
         success()
     }
-    return response;
 }
 
 const storageGetFileView = async ({ bucketId, fileId, parseOutput = true, sdk = undefined, destination}) => {
@@ -598,7 +623,7 @@ storage
     .option(`--write <write...>`, `An array of strings with write permissions. By default no user is granted with any write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.`)
     .option(`--enabled <enabled>`, `Is bucket enabled?`, parseBool)
     .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self-hosted setups you can change the max limit by changing the '_APP_STORAGE_LIMIT' environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)`, parseInteger)
-    .option(`--allowedFileExtensions <allowedFileExtensions...>`, `Allowed file extensions`)
+    .option(`--allowedFileExtensions <allowedFileExtensions...>`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
     .option(`--encryption <encryption>`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, parseBool)
     .option(`--antivirus <antivirus>`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, parseBool)
     .action(actionRunner(storageCreateBucket))
@@ -619,7 +644,7 @@ storage
     .option(`--write <write...>`, `An array of strings with write permissions. By default inherits the existing write permissions. [learn more about permissions](/docs/permissions) and get a full list of available permissions.`)
     .option(`--enabled <enabled>`, `Is bucket enabled?`, parseBool)
     .option(`--maximumFileSize <maximumFileSize>`, `Maximum file size allowed in bytes. Maximum allowed value is 30MB. For self hosted version you can change the limit by changing _APP_STORAGE_LIMIT environment variable. [Learn more about storage environment variables](docs/environment-variables#storage)`, parseInteger)
-    .option(`--allowedFileExtensions <allowedFileExtensions...>`, `Allowed file extensions`)
+    .option(`--allowedFileExtensions <allowedFileExtensions...>`, `Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.`)
     .option(`--encryption <encryption>`, `Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled`, parseBool)
     .option(`--antivirus <antivirus>`, `Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled`, parseBool)
     .action(actionRunner(storageUpdateBucket))
@@ -699,6 +724,7 @@ storage
     .option(`--rotation <rotation>`, `Preview image rotation in degrees. Pass an integer between -360 and 360.`, parseInteger)
     .option(`--background <background>`, `Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.`)
     .option(`--output <output>`, `Output format type (jpeg, jpg, png, gif and webp).`)
+    .requiredOption(`--destination <path>`, `output file path.`)
     .action(actionRunner(storageGetFilePreview))
 
 storage
@@ -740,4 +766,4 @@ module.exports = {
     storageGetFileView,
     storageGetUsage,
     storageGetBucketUsage
-};
+};

package/lib/commands/teams.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 childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -147,6 +150,34 @@ const teamsDelete = async ({ teamId, parseOutput = true, sdk = undefined}) => {
     return response;
 }
 
+const teamsListLogs = async ({ teamId, limit, offset, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} teamId */
+    /* @param {number} limit */
+    /* @param {number} offset */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/teams/{teamId}/logs'.replace('{teamId}', teamId);
+    let payload = {};
+
+    /** Query Params */
+    if (typeof limit !== 'undefined') {
+        payload['limit'] = limit;
+    }
+    if (typeof offset !== 'undefined') {
+        payload['offset'] = offset;
+    }
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const teamsGetMemberships = async ({ teamId, search, limit, offset, cursor, cursorDirection, orderType, parseOutput = true, sdk = undefined}) => {
     /* @param {string} teamId */
     /* @param {string} search */
@@ -343,7 +374,7 @@ teams
     .description(`Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.`)
     .requiredOption(`--teamId <teamId>`, `Team 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>`, `Team name. Max length: 128 chars.`)
-    .option(`--roles <roles...>`, `Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.`)
+    .option(`--roles <roles...>`, `Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .action(actionRunner(teamsCreate))
 
 teams
@@ -365,6 +396,14 @@ teams
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
     .action(actionRunner(teamsDelete))
 
+teams
+    .command(`listLogs`)
+    .description(`Get the team activity logs list by its unique ID.`)
+    .requiredOption(`--teamId <teamId>`, `Team ID.`)
+    .option(`--limit <limit>`, `Maximum number of logs 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)
+    .action(actionRunner(teamsListLogs))
+
 teams
     .command(`getMemberships`)
     .description(`Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.`)
@@ -382,7 +421,7 @@ teams
     .description(`Invite a new member to join your team. If initiated from the client SDK, an email with a link to join the team will be sent to the member's email address and an account will be created for them should they not be signed up already. If initiated from server-side SDKs, the new member will automatically be added to the team.  Use the 'url' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the [Update Team Membership Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow the user to accept the invitation to the team.   Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URL's are the once from domains you have set when adding your platforms in the console interface.`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
     .requiredOption(`--email <email>`, `Email of the new team member.`)
-    .requiredOption(`--roles <roles...>`, `Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Max length for each role is 32 chars.`)
+    .requiredOption(`--roles <roles...>`, `Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .requiredOption(`--url <url>`, `URL to redirect the user back to your app from the invitation email.  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(`--name <name>`, `Name of the new team member. Max length: 128 chars.`)
     .action(actionRunner(teamsCreateMembership))
@@ -399,7 +438,7 @@ teams
     .description(`Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](/docs/permissions).`)
     .requiredOption(`--teamId <teamId>`, `Team ID.`)
     .requiredOption(`--membershipId <membershipId>`, `Membership ID.`)
-    .requiredOption(`--roles <roles...>`, `An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Max length for each role is 32 chars.`)
+    .requiredOption(`--roles <roles...>`, `An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
     .action(actionRunner(teamsUpdateMembershipRoles))
 
 teams
@@ -426,10 +465,11 @@ module.exports = {
     teamsGet,
     teamsUpdate,
     teamsDelete,
+    teamsListLogs,
     teamsGetMemberships,
     teamsCreateMembership,
     teamsGetMembership,
     teamsUpdateMembershipRoles,
     teamsDeleteMembership,
     teamsUpdateMembershipStatus
-};
+};

package/lib/commands/users.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 childProcess = require('child_process');
+const { getAllFiles } = require('../utils.js');
 const { Command } = require('commander');
 const { sdkForProject, sdkForConsole } = require('../sdks')
 const { parse, actionRunner, parseInteger, parseBool, commandDescriptions, success, log } = require('../parser')
@@ -207,6 +210,24 @@ const usersGetLogs = async ({ userId, limit, offset, parseOutput = true, sdk = u
     return response;
 }
 
+const usersGetMemberships = async ({ userId, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/{userId}/memberships'.replace('{userId}', userId);
+    let payload = {};
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const usersUpdateName = async ({ userId, name, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
     /* @param {string} name */
@@ -285,7 +306,7 @@ const usersUpdatePrefs = async ({ userId, prefs, parseOutput = true, sdk = undef
     
     /** Body Params */
     if (typeof prefs !== 'undefined') {
-        payload['prefs'] = prefs;
+        payload['prefs'] = JSON.parse(prefs);
     }
 
     let response = undefined;
@@ -441,7 +462,7 @@ users
 
 users
     .command(`delete`)
-    .description(`Delete a user by its unique ID.`)
+    .description(`Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](/docs/server/users#usersUpdateStatus) endpoint instead.`)
     .requiredOption(`--userId <userId>`, `User ID.`)
     .action(actionRunner(usersDelete))
 
@@ -460,6 +481,12 @@ users
     .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)
     .action(actionRunner(usersGetLogs))
 
+users
+    .command(`getMemberships`)
+    .description(`Get the user membership list by its unique ID.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .action(actionRunner(usersGetMemberships))
+
 users
     .command(`updateName`)
     .description(`Update the user name by its unique ID.`)
@@ -508,7 +535,7 @@ users
 
 users
     .command(`updateStatus`)
-    .description(`Update the user status by its unique ID.`)
+    .description(`Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.`)
     .requiredOption(`--userId <userId>`, `User ID.`)
     .requiredOption(`--status <status>`, `User Status. To activate the user pass 'true' and to block the user pass 'false'.`, parseBool)
     .action(actionRunner(usersUpdateStatus))
@@ -530,6 +557,7 @@ module.exports = {
     usersDelete,
     usersUpdateEmail,
     usersGetLogs,
+    usersGetMemberships,
     usersUpdateName,
     usersUpdatePassword,
     usersGetPrefs,
@@ -539,4 +567,4 @@ module.exports = {
     usersDeleteSession,
     usersUpdateStatus,
     usersUpdateVerification
-};
+};

package/lib/config.js

@@ -2,6 +2,7 @@ const os = require('os');
 const fs = require("fs");
 const _path = require("path");
 const process = require("process");
+const JSONbig = require("json-bigint")({ storeAsString: false });
 
 class Config {
     constructor(path) {
@@ -11,7 +12,8 @@ class Config {
 
     read() {
         try {
-            this.data = require(this.path);
+            const file = fs.readFileSync(this.path).toString();
+            this.data = JSONbig.parse(file);
         } catch (e) {
             // console.log(`${this.path} not found. Empty data`);
             this.data = {};
@@ -23,7 +25,7 @@ class Config {
         if (!fs.existsSync(dir)){
             fs.mkdirSync(dir, { recursive: true });
         }
-        fs.writeFileSync(this.path, JSON.stringify(this.data, null, 4));
+        fs.writeFileSync(this.path, JSONbig.stringify(this.data, null, 4));
     }
 
     get(key) {
@@ -46,7 +48,7 @@ class Config {
     }
 
     has(key) {
-        return this.data.hasOwnProperty(key);
+        return this.data[key] !== undefined;
     }
 
     keys() {
@@ -58,7 +60,7 @@ class Config {
     }
 
     toString() {
-        return JSON.stringify(this.data, null, 4);
+        return JSONbig.stringify(this.data, null, 4);
     }
 }
 

package/lib/questions.js

@@ -1,6 +1,39 @@
 const { localConfig } = require('./config');
 const { projectsList } = require('./commands/projects');
 const { functionsListRuntimes } = require('./commands/functions');
+const JSONbig = require("json-bigint")({ storeAsString: false });
+
+const getIgnores = (runtime) => {
+  const languge = runtime.split('-')[0];
+
+  switch (languge) {
+    case 'cpp':
+        return ['build', 'CMakeFiles', 'CMakeCaches.txt'];
+    case 'dart':
+      return ['.packages', '.dart_tool'];
+    case 'deno':
+      return [];
+    case 'dotnet':
+        return ['bin', 'obj', '.nuget'];
+    case 'java':
+    case 'kotlin':
+        return ['build'];
+    case 'node':
+      return ['node_modules', '.npm'];
+    case 'php':
+      return ['vendor'];
+    case 'python':
+      return ['__pypackages__'];
+    case 'ruby':
+      return ['vendor'];
+    case 'rust':
+      return ['target', 'debug', '*.rs.bk', '*.pdb'];
+    case 'swift':
+      return ['.build', '.swiftpm'];
+  }
+
+  return undefined;
+};
 
 const getEntrypoint = (runtime) => {
   const languge = runtime.split('-')[0];
@@ -117,7 +150,7 @@ const questionsInitFunction = [
       let choices = runtimes.map((runtime, idx) => {
         return {
           name: `${runtime.name} (${runtime['$id']})`,
-          value: { id: runtime['$id'], entrypoint: getEntrypoint(runtime['$id'])}
+          value: { id: runtime['$id'], entrypoint: getEntrypoint(runtime['$id']), ignore: getIgnores(runtime['$id'])},
         }
       })
       return choices;
@@ -185,7 +218,7 @@ const questionsDeployCollections = [
       let choices = collections.map((collection, idx) => {
         return {
           name: `${collection.name} (${collection['$id']})`,
-          value: collection
+          value: JSONbig.stringify(collection)
         }
       })
       return choices;

package/lib/sdks.js

@@ -7,7 +7,23 @@ const questionGetEndpoint = [
     type: "input",
     name: "endpoint",
     message: "Enter the endpoint of your Appwrite server",
-    default: "http://localhost/v1"
+    default: "http://localhost/v1",
+    async validate(value) {
+      if (!value) {
+        return "Please enter a valid endpoint.";
+      }
+      let client = new Client().setEndpoint(value);
+      try {
+        let response = await client.call('get', '/health/version');
+        if (response.version) {
+          return true;
+        } else {
+          throw new Error();
+        }
+      } catch (error) {
+        return "Invalid endpoint or your Appwrite server is not running as expected.";
+      }
+    }
   }
 ]
 

package/lib/utils.js

@@ -0,0 +1,19 @@
+const fs = require("fs");
+const path = require("path");
+
+function getAllFiles(folder) {
+    const files = [];
+    for(const pathDir of fs.readdirSync(folder)) {
+        const pathAbsolute = path.join(folder, pathDir);
+        if (fs.statSync(pathAbsolute).isDirectory()) {
+            files.push(...getAllFiles(pathAbsolute));
+        } else {
+            files.push(pathAbsolute);
+        }
+    }
+    return files;
+}
+
+module.exports = {
+    getAllFiles
+};

package/package.json

@@ -2,7 +2,7 @@
   "name": "appwrite-cli",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API",
-  "version": "0.14.0",
+  "version": "0.17.0",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {
@@ -22,12 +22,15 @@
     "windows-arm64": "pkg -t node16-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
   },
   "dependencies": {
-    "axios": "^0.24.0",
+    "axios": "^0.27.2",
     "chalk": "4.1.2",
-    "cli-table3": "^0.6.1",
-    "commander": "^8.3.0",
+    "cli-table3": "^0.6.2",
+    "commander": "^9.2.0",
     "form-data": "^4.0.0",
-    "inquirer": "^8.2.0"
+    "json-bigint": "^1.0.0",
+    "inquirer": "^8.2.4",
+    "tar": "^6.1.11",
+    "ignore": "^5.2.0"
   },
   "devDependencies": {
     "pkg": "5.5.1"

package/docs/examples/account/delete.md

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

package/docs/examples/health/get-queue-usage.md

@@ -1 +0,0 @@
-appwrite health getQueueUsage