appwrite-cli 0.16.0 → 0.18.1

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 { 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 */
@@ -257,6 +278,31 @@ const usersUpdatePassword = async ({ userId, password, parseOutput = true, sdk =
     return response;
 }
 
+const usersUpdatePhone = async ({ userId, number, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} number */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/{userId}/phone'.replace('{userId}', userId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof number !== 'undefined') {
+        payload['number'] = number;
+    }
+
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 const usersGetPrefs = async ({ userId, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
 
@@ -380,7 +426,7 @@ const usersUpdateStatus = async ({ userId, status, parseOutput = true, sdk = und
     return response;
 }
 
-const usersUpdateVerification = async ({ userId, emailVerification, parseOutput = true, sdk = undefined}) => {
+const usersUpdateEmailVerification = async ({ userId, emailVerification, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
     /* @param {boolean} emailVerification */
 
@@ -405,6 +451,31 @@ const usersUpdateVerification = async ({ userId, emailVerification, parseOutput
     return response;
 }
 
+const usersUpdatePhoneVerification = async ({ userId, phoneVerification, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {boolean} phoneVerification */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/{userId}/verification/phone'.replace('{userId}', userId);
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof phoneVerification !== 'undefined') {
+        payload['phoneVerification'] = phoneVerification;
+    }
+
+    let response = undefined;
+    response = await client.call('patch', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
 
 users
     .command(`list`)
@@ -413,7 +484,7 @@ users
     .option(`--limit <limit>`, `Maximum number of users 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 param to manage pagination. [learn more about pagination](https://appwrite.io/docs/pagination)`, parseInteger)
     .option(`--cursor <cursor>`, `ID of the user used as the starting point for the query, excluding the user 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(`--cursorDirection <cursorDirection>`, `Direction of the cursor, can be either 'before' or 'after'.`)
     .option(`--orderType <orderType>`, `Order result by ASC or DESC order.`)
     .action(actionRunner(usersList))
 
@@ -441,7 +512,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 +531,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.`)
@@ -474,6 +551,13 @@ users
     .requiredOption(`--password <password>`, `New user password. Must be at least 8 chars.`)
     .action(actionRunner(usersUpdatePassword))
 
+users
+    .command(`updatePhone`)
+    .description(`Update the user phone by its unique ID.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .requiredOption(`--number <number>`, `User phone number.`)
+    .action(actionRunner(usersUpdatePhone))
+
 users
     .command(`getPrefs`)
     .description(`Get the user preferences by its unique ID.`)
@@ -508,17 +592,24 @@ 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))
 
 users
-    .command(`updateVerification`)
+    .command(`updateEmailVerification`)
     .description(`Update the user email verification status by its unique ID.`)
     .requiredOption(`--userId <userId>`, `User ID.`)
     .requiredOption(`--emailVerification <emailVerification>`, `User email verification status.`, parseBool)
-    .action(actionRunner(usersUpdateVerification))
+    .action(actionRunner(usersUpdateEmailVerification))
+
+users
+    .command(`updatePhoneVerification`)
+    .description(`Update the user phone verification status by its unique ID.`)
+    .requiredOption(`--userId <userId>`, `User ID.`)
+    .requiredOption(`--phoneVerification <phoneVerification>`, `User phone verification status.`, parseBool)
+    .action(actionRunner(usersUpdatePhoneVerification))
 
 
 module.exports = {
@@ -530,13 +621,16 @@ module.exports = {
     usersDelete,
     usersUpdateEmail,
     usersGetLogs,
+    usersGetMemberships,
     usersUpdateName,
     usersUpdatePassword,
+    usersUpdatePhone,
     usersGetPrefs,
     usersUpdatePrefs,
     usersGetSessions,
     usersDeleteSessions,
     usersDeleteSession,
     usersUpdateStatus,
-    usersUpdateVerification
+    usersUpdateEmailVerification,
+    usersUpdatePhoneVerification
 };

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/parser.js

@@ -150,7 +150,7 @@ const logo = "\n    _                            _ _           ___   __   _____
 const commandDescriptions = {
     "account": `The account command allows you to authenticate and manage a user account.`,
     "avatars": `The avatars command aims to help you complete everyday tasks related to your app image, icons, and avatars.`,
-    "database": `The database command allows you to create structured collections of documents, query and filter lists of documents.`,
+    "databases": `The databases command allows you to create structured collections of documents, query and filter lists of documents.`,
     "deploy": `The deploy command provides a convenient wrapper for deploying your functions and collections.`,
     "functions": `The functions command allows you view, create and manage your Cloud Functions.`,
     "health": `The health command allows you to both validate and monitor your Appwrite server's health.`,

package/lib/questions.js

@@ -1,6 +1,40 @@
 const { localConfig } = require('./config');
 const { projectsList } = require('./commands/projects');
 const { functionsListRuntimes } = require('./commands/functions');
+const { databasesList } = require('./commands/databases');
+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];
@@ -22,6 +56,14 @@ const getEntrypoint = (runtime) => {
       return 'main.rs';
     case 'swift':
       return 'Sources/swift-5.5/main.swift';
+    case 'cpp':
+      return 'src/index.cc';
+    case 'dotnet':
+      return 'src/Index.cs';
+    case 'java':
+      return 'src/Index.java';
+    case 'kotlin':
+      return 'src/Index.kt';
   }
 
   return undefined;
@@ -67,6 +109,15 @@ const questionsInitProject = [
       return answers.start == "new";
     },
   },
+  {
+    type: "input",
+    name: "id",
+    message: "What ID would you like to have for your project?",
+    default: "myAwesomeProject",
+    when(answers) {
+      return answers.start == "new";
+    },
+  },
   {
     type: "list",
     name: "project",
@@ -105,6 +156,12 @@ const questionsInitFunction = [
     message: "What would you like to name your function?",
     default: "My Awesome Function"
   },
+  {
+    type: "input",
+    name: "id",
+    message: "What ID would you like to have for your function?",
+    default: "myAwesomeFunction"
+  },
   {
     type: "list",
     name: "runtime",
@@ -117,7 +174,32 @@ 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;
+    }
+  }
+];
+
+const questionsInitCollection = [
+  {
+    type: "checkbox",
+    name: "databases",
+    message: "From which database would you like to init collections?",
+    choices: async () => {
+      let response = await databasesList({
+        parseOutput: false
+      })
+      let databases = response["databases"]
+
+      if(databases.length <= 0) {
+        throw new Error("No databases found. Please create one in project console.")
+      }
+      let choices = databases.map((database, idx) => {
+        return {
+          name: `${database.name} (${database.$id})`,
+          value: database.$id
         }
       })
       return choices;
@@ -163,8 +245,8 @@ const questionsDeployFunctions = [
       }
       let choices = functions.map((func, idx) => {
         return {
-          name: `${func.name} (${func['$id']})`,
-          value: func
+          name: `${func.name} (${func.$id})`,
+          value: func.$id
         }
       })
       return choices;
@@ -185,7 +267,7 @@ const questionsDeployCollections = [
       let choices = collections.map((collection, idx) => {
         return {
           name: `${collection.name} (${collection['$id']})`,
-          value: collection
+          value: collection.$id
         }
       })
       return choices;
@@ -217,6 +299,7 @@ module.exports = {
   questionsInitProject,
   questionsLogin,
   questionsInitFunction,
+  questionsInitCollection,
   questionsDeployFunctions,
   questionsDeployCollections,
   questionsGetEntrypoint

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.16.0",
+  "version": "0.18.1",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {
@@ -22,13 +22,15 @@
     "windows-arm64": "pkg -t node16-win-arm64 -o build/appwrite-cli-win-arm64.exe package.json"
   },
   "dependencies": {
-    "axios": "^0.26.1",
+    "axios": "^0.27.2",
     "chalk": "4.1.2",
-    "cli-table3": "^0.6.1",
-    "commander": "^9.0.0",
+    "cli-table3": "^0.6.2",
+    "commander": "^9.2.0",
     "form-data": "^4.0.0",
-    "inquirer": "^8.2.1",
-    "tar": "^6.1.11"
+    "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/database/delete-attribute.md

@@ -1,3 +0,0 @@
-appwrite database deleteAttribute \
-        --collectionId [COLLECTION_ID] \
-        --key ''

package/docs/examples/database/delete-collection.md

@@ -1,2 +0,0 @@
-appwrite database deleteCollection \
-        --collectionId [COLLECTION_ID]

package/docs/examples/database/delete-index.md

@@ -1,3 +0,0 @@
-appwrite database deleteIndex \
-        --collectionId [COLLECTION_ID] \
-        --key ''

package/docs/examples/database/get-attribute.md

@@ -1,3 +0,0 @@
-appwrite database getAttribute \
-        --collectionId [COLLECTION_ID] \
-        --key ''

package/docs/examples/database/get-collection-usage.md

@@ -1,3 +0,0 @@
-appwrite database getCollectionUsage \
-        --collectionId [COLLECTION_ID] \
-

package/docs/examples/database/get-collection.md

@@ -1,2 +0,0 @@
-appwrite database getCollection \
-        --collectionId [COLLECTION_ID]

package/docs/examples/database/get-index.md

@@ -1,3 +0,0 @@
-appwrite database getIndex \
-        --collectionId [COLLECTION_ID] \
-        --key ''

package/docs/examples/database/get-usage.md

@@ -1,2 +0,0 @@
-appwrite database getUsage \
-

package/docs/examples/database/list-attributes.md

@@ -1,2 +0,0 @@
-appwrite database listAttributes \
-        --collectionId [COLLECTION_ID]

package/docs/examples/database/list-collection-logs.md

@@ -1,4 +0,0 @@
-appwrite database listCollectionLogs \
-        --collectionId [COLLECTION_ID] \
-
-

package/docs/examples/database/list-collections.md

@@ -1,7 +0,0 @@
-appwrite database listCollections \
-
-
-
-
-
-

package/docs/examples/database/list-documents.md

@@ -1,9 +0,0 @@
-appwrite database listDocuments \
-        --collectionId [COLLECTION_ID] \
-
-
-
-
-
-
-

package/docs/examples/database/list-indexes.md

@@ -1,2 +0,0 @@
-appwrite database listIndexes \
-        --collectionId [COLLECTION_ID]

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

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