appwrite-cli 0.18.5 → 1.0.0-RC2

package/lib/commands/users.js

@@ -12,39 +12,67 @@ const { localConfig, globalConfig } = require("../config");
 
 const users = new Command("users").description(commandDescriptions['users'])
 
-const usersList = async ({ search, limit, offset, cursor, cursorDirection, orderType, parseOutput = true, sdk = undefined}) => {
+const usersList = async ({ queries, search, parseOutput = true, sdk = undefined}) => {
+    /* @param {string[]} queries */
     /* @param {string} search */
-    /* @param {number} limit */
-    /* @param {number} offset */
-    /* @param {string} cursor */
-    /* @param {string} cursorDirection */
-    /* @param {string} orderType */
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/users';
     let payload = {};
 
     /** Query Params */
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
+    }
     if (typeof search !== 'undefined') {
         payload['search'] = search;
     }
-    if (typeof limit !== 'undefined') {
-        payload['limit'] = limit;
+    let response = undefined;
+    response = await client.call('get', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreate = async ({ userId, email, phone, password, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} phone */
+    /* @param {string} password */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
     }
-    if (typeof offset !== 'undefined') {
-        payload['offset'] = offset;
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
     }
-    if (typeof cursor !== 'undefined') {
-        payload['cursor'] = cursor;
+
+    if (typeof phone !== 'undefined') {
+        payload['phone'] = phone;
     }
-    if (typeof cursorDirection !== 'undefined') {
-        payload['cursorDirection'] = cursorDirection;
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
     }
-    if (typeof orderType !== 'undefined') {
-        payload['orderType'] = orderType;
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
     }
+
     let response = undefined;
-    response = await client.call('get', path, {
+    response = await client.call('post', path, {
         'content-type': 'application/json',
     }, payload);
     
@@ -55,14 +83,289 @@ const usersList = async ({ search, limit, offset, cursor, cursorDirection, order
     return response;
 }
 
-const usersCreate = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
+const usersCreateArgon2User = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
     /* @param {string} email */
     /* @param {string} password */
     /* @param {string} name */
 
     let client = !sdk ? await sdkForProject() : sdk;
-    let path = '/users';
+    let path = '/users/argon2';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreateBcryptUser = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/bcrypt';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreateMD5User = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/md5';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreatePHPassUser = async ({ userId, email, password, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/phpass';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreateScryptUser = async ({ userId, email, password, passwordSalt, passwordCpu, passwordMemory, passwordParallel, passwordLength, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} passwordSalt */
+    /* @param {number} passwordCpu */
+    /* @param {number} passwordMemory */
+    /* @param {number} passwordParallel */
+    /* @param {number} passwordLength */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/scrypt';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof passwordSalt !== 'undefined') {
+        payload['passwordSalt'] = passwordSalt;
+    }
+
+    if (typeof passwordCpu !== 'undefined') {
+        payload['passwordCpu'] = passwordCpu;
+    }
+
+    if (typeof passwordMemory !== 'undefined') {
+        payload['passwordMemory'] = passwordMemory;
+    }
+
+    if (typeof passwordParallel !== 'undefined') {
+        payload['passwordParallel'] = passwordParallel;
+    }
+
+    if (typeof passwordLength !== 'undefined') {
+        payload['passwordLength'] = passwordLength;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreateScryptModifiedUser = async ({ userId, email, password, passwordSalt, passwordSaltSeparator, passwordSignerKey, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} passwordSalt */
+    /* @param {string} passwordSaltSeparator */
+    /* @param {string} passwordSignerKey */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/scrypt-modified';
+    let payload = {};
+    
+    /** Body Params */
+    if (typeof userId !== 'undefined') {
+        payload['userId'] = userId;
+    }
+
+    if (typeof email !== 'undefined') {
+        payload['email'] = email;
+    }
+
+    if (typeof password !== 'undefined') {
+        payload['password'] = password;
+    }
+
+    if (typeof passwordSalt !== 'undefined') {
+        payload['passwordSalt'] = passwordSalt;
+    }
+
+    if (typeof passwordSaltSeparator !== 'undefined') {
+        payload['passwordSaltSeparator'] = passwordSaltSeparator;
+    }
+
+    if (typeof passwordSignerKey !== 'undefined') {
+        payload['passwordSignerKey'] = passwordSignerKey;
+    }
+
+    if (typeof name !== 'undefined') {
+        payload['name'] = name;
+    }
+
+    let response = undefined;
+    response = await client.call('post', path, {
+        'content-type': 'application/json',
+    }, payload);
+    
+    if (parseOutput) {
+        parse(response)
+        success()
+    }
+    return response;
+}
+
+const usersCreateSHAUser = async ({ userId, email, password, passwordVersion, name, parseOutput = true, sdk = undefined}) => {
+    /* @param {string} userId */
+    /* @param {string} email */
+    /* @param {string} password */
+    /* @param {string} passwordVersion */
+    /* @param {string} name */
+
+    let client = !sdk ? await sdkForProject() : sdk;
+    let path = '/users/sha';
     let payload = {};
     
     /** Body Params */
@@ -78,6 +381,10 @@ const usersCreate = async ({ userId, email, password, name, parseOutput = true,
         payload['password'] = password;
     }
 
+    if (typeof passwordVersion !== 'undefined') {
+        payload['passwordVersion'] = passwordVersion;
+    }
+
     if (typeof name !== 'undefined') {
         payload['name'] = name;
     }
@@ -182,21 +489,17 @@ const usersUpdateEmail = async ({ userId, email, parseOutput = true, sdk = undef
     return response;
 }
 
-const usersGetLogs = async ({ userId, limit, offset, parseOutput = true, sdk = undefined}) => {
+const usersGetLogs = async ({ userId, queries, parseOutput = true, sdk = undefined}) => {
     /* @param {string} userId */
-    /* @param {number} limit */
-    /* @param {number} offset */
+    /* @param {string[]} queries */
 
     let client = !sdk ? await sdkForProject() : sdk;
     let path = '/users/{userId}/logs'.replace('{userId}', userId);
     let payload = {};
 
     /** Query Params */
-    if (typeof limit !== 'undefined') {
-        payload['limit'] = limit;
-    }
-    if (typeof offset !== 'undefined') {
-        payload['offset'] = offset;
+    if (typeof queries !== 'undefined') {
+        payload['queries'] = queries;
     }
     let response = undefined;
     response = await client.call('get', path, {
@@ -480,23 +783,92 @@ const usersUpdatePhoneVerification = async ({ userId, phoneVerification, parseOu
 users
     .command(`list`)
     .description(`Get a list of all the project's users. You can use the query params to filter your results.`)
+    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
-    .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, can be either 'before' or 'after'.`)
-    .option(`--orderType <orderType>`, `Order result by ASC or DESC order.`)
     .action(actionRunner(usersList))
 
 users
     .command(`create`)
     .description(`Create a new user.`)
     .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
-    .requiredOption(`--password <password>`, `User password. Must be at least 8 chars.`)
+    .option(`--email <email>`, `User email.`)
+    .option(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
+    .option(`--password <password>`, `Plain text user password. Must be at least 8 chars.`)
     .option(`--name <name>`, `User name. Max length: 128 chars.`)
     .action(actionRunner(usersCreate))
 
+users
+    .command(`createArgon2User`)
+    .description(`Create a new user. Password provided must be hashed with the [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using Argon2.`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateArgon2User))
+
+users
+    .command(`createBcryptUser`)
+    .description(`Create a new user. Password provided must be hashed with the [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using Bcrypt.`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateBcryptUser))
+
+users
+    .command(`createMD5User`)
+    .description(`Create a new user. Password provided must be hashed with the [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using MD5.`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateMD5User))
+
+users
+    .command(`createPHPassUser`)
+    .description(`Create a new user. Password provided must be hashed with the [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using PHPass.`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreatePHPassUser))
+
+users
+    .command(`createScryptUser`)
+    .description(`Create a new user. Password provided must be hashed with the [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using Scrypt.`)
+    .requiredOption(`--passwordSalt <passwordSalt>`, `Optional salt used to hash password.`)
+    .requiredOption(`--passwordCpu <passwordCpu>`, `Optional CPU cost used to hash password.`, parseInteger)
+    .requiredOption(`--passwordMemory <passwordMemory>`, `Optional memory cost used to hash password.`, parseInteger)
+    .requiredOption(`--passwordParallel <passwordParallel>`, `Optional parallelization cost used to hash password.`, parseInteger)
+    .requiredOption(`--passwordLength <passwordLength>`, `Optional hash length used to hash password.`, parseInteger)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateScryptUser))
+
+users
+    .command(`createScryptModifiedUser`)
+    .description(`Create a new user. Password provided must be hashed with the [Scrypt Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using Scrypt Modified.`)
+    .requiredOption(`--passwordSalt <passwordSalt>`, `Salt used to hash password.`)
+    .requiredOption(`--passwordSaltSeparator <passwordSaltSeparator>`, `Salt separator used to hash password.`)
+    .requiredOption(`--passwordSignerKey <passwordSignerKey>`, `Signer key used to hash password.`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateScryptModifiedUser))
+
+users
+    .command(`createSHAUser`)
+    .description(`Create a new user. Password provided must be hashed with the [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use the [POST /users](/docs/server/users#usersCreate) endpoint to create users with a plain text password.`)
+    .requiredOption(`--userId <userId>`, `User 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(`--email <email>`, `User email.`)
+    .requiredOption(`--password <password>`, `User password hashed using SHA.`)
+    .option(`--passwordVersion <passwordVersion>`, `Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512/224', 'sha512/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'`)
+    .option(`--name <name>`, `User name. Max length: 128 chars.`)
+    .action(actionRunner(usersCreateSHAUser))
+
 users
     .command(`getUsage`)
     .description(``)
@@ -527,8 +899,7 @@ users
     .command(`getLogs`)
     .description(`Get the user activity logs list by its unique ID.`)
     .requiredOption(`--userId <userId>`, `User 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)
+    .option(`--queries <queries...>`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Only supported methods are limit and offset`)
     .action(actionRunner(usersGetLogs))
 
 users
@@ -616,6 +987,13 @@ module.exports = {
     users,
     usersList,
     usersCreate,
+    usersCreateArgon2User,
+    usersCreateBcryptUser,
+    usersCreateMD5User,
+    usersCreatePHPassUser,
+    usersCreateScryptUser,
+    usersCreateScryptModifiedUser,
+    usersCreateSHAUser,
     usersGetUsage,
     usersGet,
     usersDelete,

package/lib/questions.js

@@ -160,7 +160,7 @@ const questionsInitFunction = [
     type: "input",
     name: "id",
     message: "What ID would you like to have for your function?",
-    default: "myAwesomeFunction"
+    default: "unique()"
   },
   {
     type: "list",

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.18.5",
+  "version": "1.0.0-RC2",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {