appwrite-cli 6.0.0-rc.7 → 6.0.0-rc.9

package/README.md

@@ -29,7 +29,7 @@ Once the installation is complete, you can verify the install using
 
 ```sh
 $ appwrite -v
-6.0.0-rc.7
+6.0.0-rc.9
 ```
 
 ### Install using prebuilt binaries
@@ -60,7 +60,7 @@ $ scoop install https://raw.githubusercontent.com/appwrite/sdk-for-cli/master/sc
 Once the installation completes, you can verify your install using
 ```
 $ appwrite -v
-6.0.0-rc.7
+6.0.0-rc.9
 ```
 
 ## Getting Started 

package/docs/examples/functions/create.md

@@ -20,3 +20,4 @@ appwrite functions create \
 
 
 
+

package/docs/examples/functions/list-specifications.md

@@ -0,0 +1 @@
+appwrite functions listSpecifications

package/docs/examples/functions/update.md

@@ -16,3 +16,4 @@ appwrite functions update \
 
 
 
+

package/install.ps1

@@ -13,8 +13,8 @@
 # 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/6.0.0-rc.7/appwrite-cli-win-x64.exe"
-$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.7/appwrite-cli-win-arm64.exe"
+$GITHUB_x64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.9/appwrite-cli-win-x64.exe"
+$GITHUB_arm64_URL = "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.9/appwrite-cli-win-arm64.exe"
 
 $APPWRITE_BINARY_NAME = "appwrite.exe"
 

package/install.sh

@@ -97,7 +97,7 @@ printSuccess() {
 downloadBinary() {
     echo "[2/4] Downloading executable for $OS ($ARCH) ..."
 
-    GITHUB_LATEST_VERSION="6.0.0-rc.7"
+    GITHUB_LATEST_VERSION="6.0.0-rc.9"
     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

@@ -16,8 +16,8 @@ class Client {
       'x-sdk-name': 'Command Line',
       'x-sdk-platform': 'console',
       'x-sdk-language': 'cli',
-      'x-sdk-version': '6.0.0-rc.7',
-      'user-agent' : `AppwriteCLI/6.0.0-rc.7 (${os.type()} ${os.version()}; ${os.arch()})`,
+      'x-sdk-version': '6.0.0-rc.9',
+      'user-agent' : `AppwriteCLI/6.0.0-rc.9 (${os.type()} ${os.version()}; ${os.arch()})`,
       'X-Appwrite-Response-Format' : '1.6.0',
     };
   }

package/lib/commands/functions.js

@@ -103,7 +103,8 @@ const functionsList = async ({queries,search,parseOutput = true, overrideForCli
  * @property {string} templateRepository Repository name of the template.
  * @property {string} templateOwner The name of the owner of the template.
  * @property {string} templateRootDirectory Path to function code in the template repo.
- * @property {string} templateBranch Production branch for the repo linked to the function template.
+ * @property {string} templateVersion Version (tag) for the repo linked to the function template.
+ * @property {string} specification Runtime specification for the function and builds.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -112,7 +113,7 @@ const functionsList = async ({queries,search,parseOutput = true, overrideForCli
 /**
  * @param {FunctionsCreateRequestParams} params
  */
-const functionsCreate = async ({functionId,name,runtime,execute,events,schedule,timeout,enabled,logging,entrypoint,commands,scopes,installationId,providerRepositoryId,providerBranch,providerSilentMode,providerRootDirectory,templateRepository,templateOwner,templateRootDirectory,templateBranch,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+const functionsCreate = async ({functionId,name,runtime,execute,events,schedule,timeout,enabled,logging,entrypoint,commands,scopes,installationId,providerRepositoryId,providerBranch,providerSilentMode,providerRootDirectory,templateRepository,templateOwner,templateRootDirectory,templateVersion,specification,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/functions';
@@ -180,8 +181,11 @@ const functionsCreate = async ({functionId,name,runtime,execute,events,schedule,
     if (typeof templateRootDirectory !== 'undefined') {
         payload['templateRootDirectory'] = templateRootDirectory;
     }
-    if (typeof templateBranch !== 'undefined') {
-        payload['templateBranch'] = templateBranch;
+    if (typeof templateVersion !== 'undefined') {
+        payload['templateVersion'] = templateVersion;
+    }
+    if (typeof specification !== 'undefined') {
+        payload['specification'] = specification;
     }
 
     let response = undefined;
@@ -228,6 +232,40 @@ const functionsListRuntimes = async ({parseOutput = true, overrideForCli = false
 
 }
 
+/**
+ * @typedef {Object} FunctionsListSpecificationsRequestParams
+ * @property {boolean} overrideForCli
+ * @property {boolean} parseOutput
+ * @property {libClient | undefined} sdk
+ */
+
+/**
+ * @param {FunctionsListSpecificationsRequestParams} params
+ */
+const functionsListSpecifications = async ({parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
+    let client = !sdk ? await sdkForProject() :
+    sdk;
+    let apiPath = '/functions/specifications';
+    let payload = {};
+
+    let response = undefined;
+
+    response = await client.call('get', apiPath, {
+        'content-type': 'application/json',
+    }, payload);
+
+    if (parseOutput) {
+        if(console) {
+            showConsoleLink('functions', 'listSpecifications');
+         } else {
+            parse(response)
+        }
+    }
+
+    return response;
+
+}
+
 /**
  * @typedef {Object} FunctionsListTemplatesRequestParams
  * @property {string[]} runtimes List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.
@@ -401,6 +439,7 @@ const functionsGet = async ({functionId,parseOutput = true, overrideForCli = fal
  * @property {string} providerBranch Production branch for the repo linked to the function
  * @property {boolean} providerSilentMode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.
  * @property {string} providerRootDirectory Path to function code in the linked repo.
+ * @property {string} specification Runtime specification for the function and builds.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -409,7 +448,7 @@ const functionsGet = async ({functionId,parseOutput = true, overrideForCli = fal
 /**
  * @param {FunctionsUpdateRequestParams} params
  */
-const functionsUpdate = async ({functionId,name,runtime,execute,events,schedule,timeout,enabled,logging,entrypoint,commands,scopes,installationId,providerRepositoryId,providerBranch,providerSilentMode,providerRootDirectory,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
+const functionsUpdate = async ({functionId,name,runtime,execute,events,schedule,timeout,enabled,logging,entrypoint,commands,scopes,installationId,providerRepositoryId,providerBranch,providerSilentMode,providerRootDirectory,specification,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
     let client = !sdk ? await sdkForProject() :
     sdk;
     let apiPath = '/functions/{functionId}'.replace('{functionId}', functionId);
@@ -465,6 +504,9 @@ const functionsUpdate = async ({functionId,name,runtime,execute,events,schedule,
     if (typeof providerRootDirectory !== 'undefined') {
         payload['providerRootDirectory'] = providerRootDirectory;
     }
+    if (typeof specification !== 'undefined') {
+        payload['specification'] = specification;
+    }
 
     let response = undefined;
 
@@ -514,7 +556,7 @@ const functionsDelete = async ({functionId,parseOutput = true, overrideForCli =
 /**
  * @typedef {Object} FunctionsListDeploymentsRequestParams
  * @property {string} functionId Function ID.
- * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands
+ * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
@@ -985,7 +1027,7 @@ const functionsListExecutions = async ({functionId,queries,search,parseOutput =
  * @property {string} xpath HTTP path of execution. Path can include query params. Default value is /
  * @property {ExecutionMethod} method HTTP method of execution. Default value is GET.
  * @property {object} headers HTTP headers of execution. Defaults to empty.
- * @property {string} scheduledAt Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.
+ * @property {string} scheduledAt Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.
  * @property {boolean} overrideForCli
  * @property {boolean} parseOutput
  * @property {libClient | undefined} sdk
@@ -1344,7 +1386,8 @@ functions
     .option(`--template-repository <template-repository>`, `Repository name of the template.`)
     .option(`--template-owner <template-owner>`, `The name of the owner of the template.`)
     .option(`--template-root-directory <template-root-directory>`, `Path to function code in the template repo.`)
-    .option(`--template-branch <template-branch>`, `Production branch for the repo linked to the function template.`)
+    .option(`--template-version <template-version>`, `Version (tag) for the repo linked to the function template.`)
+    .option(`--specification <specification>`, `Runtime specification for the function and builds.`)
     .action(actionRunner(functionsCreate))
 
 functions
@@ -1352,6 +1395,12 @@ functions
     .description(`Get a list of all runtimes that are currently active on your instance.`)
     .action(actionRunner(functionsListRuntimes))
 
+functions
+    .command(`list-specifications`)
+    .description(`List allowed function specifications for this instance. `)
+    .option(`--console`, `Get the resource console url`)
+    .action(actionRunner(functionsListSpecifications))
+
 functions
     .command(`list-templates`)
     .description(`List available function templates. You can use template details in [createFunction](/docs/references/cloud/server-nodejs/functions#create) method.`)
@@ -1402,6 +1451,7 @@ functions
     .option(`--provider-branch <provider-branch>`, `Production branch for the repo linked to the function`)
     .option(`--provider-silent-mode <provider-silent-mode>`, `Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.`, parseBool)
     .option(`--provider-root-directory <provider-root-directory>`, `Path to function code in the linked repo.`)
+    .option(`--specification <specification>`, `Runtime specification for the function and builds.`)
     .action(actionRunner(functionsUpdate))
 
 functions
@@ -1414,7 +1464,7 @@ functions
     .command(`list-deployments`)
     .description(`Get a list of all the project's code deployments. You can use the query params to filter your results.`)
     .requiredOption(`--function-id <function-id>`, `Function ID.`)
-    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands`)
+    .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size`)
     .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
     .option(`--console`, `Get the resource console url`)
     .action(actionRunner(functionsListDeployments))
@@ -1493,7 +1543,7 @@ functions
     .option(`--xpath <xpath>`, `HTTP path of execution. Path can include query params. Default value is /`)
     .option(`--method <method>`, `HTTP method of execution. Default value is GET.`)
     .option(`--headers <headers>`, `HTTP headers of execution. Defaults to empty.`)
-    .option(`--scheduled-at <scheduled-at>`, `Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future.`)
+    .option(`--scheduled-at <scheduled-at>`, `Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.`)
     .action(actionRunner(functionsCreateExecution))
 
 functions
@@ -1561,6 +1611,7 @@ module.exports = {
     functionsList,
     functionsCreate,
     functionsListRuntimes,
+    functionsListSpecifications,
     functionsListTemplates,
     functionsGetTemplate,
     functionsGetUsage,

package/lib/commands/init.js

@@ -192,6 +192,8 @@ const initTopic = async () => {
 };
 
 const initFunction = async () => {
+    process.chdir(localConfig.configDirectoryPath)
+
     // TODO: Add CI/CD support (ID, name, runtime)
     const answers = await inquirer.prompt(questionsCreateFunction)
     const functionFolder = path.join(process.cwd(), 'functions');
@@ -203,12 +205,13 @@ const initFunction = async () => {
     }
 
     const functionId = answers.id === 'unique()' ? ID.unique() : answers.id;
-    const functionDir = path.join(functionFolder, functionId);
+    const functionName = answers.name;
+    const functionDir = path.join(functionFolder, functionName);
     const templatesDir = path.join(functionFolder, `${functionId}-templates`);
     const runtimeDir = path.join(templatesDir, answers.runtime.name);
 
     if (fs.existsSync(functionDir)) {
-        throw new Error(`( ${functionId} ) already exists in the current directory. Please choose another name.`);
+        throw new Error(`( ${functionName} ) already exists in the current directory. Please choose another name.`);
     }
 
     if (!answers.runtime.entrypoint) {
@@ -285,7 +288,7 @@ const initFunction = async () => {
 
     fs.rmSync(templatesDir, { recursive: true, force: true });
 
-    const readmePath = path.join(process.cwd(), 'functions', functionId, 'README.md');
+    const readmePath = path.join(process.cwd(), 'functions', functionName, 'README.md');
     const readmeFile = fs.readFileSync(readmePath).toString();
     const newReadmeFile = readmeFile.split('\n');
     newReadmeFile[0] = `# ${answers.name}`;
@@ -306,7 +309,7 @@ const initFunction = async () => {
         entrypoint: answers.runtime.entrypoint || '',
         commands: answers.runtime.commands || '',
         ignore: answers.runtime.ignore || null,
-        path: `functions/${functionId}`,
+        path: `functions/${functionName}`,
     };
 
     localConfig.addFunction(data);

package/lib/commands/pull.js

@@ -57,6 +57,8 @@ const pullSettings = async () => {
 }
 
 const pullFunctions = async ({ code, withVariables }) => {
+    process.chdir(localConfig.configDirectoryPath)
+
     log("Fetching functions ...");
     let total = 0;
 
@@ -84,7 +86,7 @@ const pullFunctions = async ({ code, withVariables }) => {
 
         func['path'] = localFunction['path'];
         if (!localFunction['path']) {
-            func['path'] = `functions/${func.$id}`;
+            func['path'] = `functions/${func.name}`;
         }
         if (!withVariables) {
             delete func['vars'];
@@ -314,7 +316,7 @@ pull
 pull
     .command("function")
     .alias("functions")
-    .description("Pulling your Appwrite cloud function")
+    .description("Pull your Appwrite cloud function")
     .option("--no-code", "Don't pull the function's code")
     .option("--with-variables", `Pull function variables. ${chalk.red('recommend for testing purposes only')}`)
     .action(actionRunner(pullFunctions))
@@ -322,25 +324,25 @@ pull
 pull
     .command("collection")
     .alias("collections")
-    .description("Pulling your Appwrite collections")
+    .description("Pull your Appwrite collections")
     .action(actionRunner(pullCollection))
 
 pull
     .command("bucket")
     .alias("buckets")
-    .description("Pulling your Appwrite buckets")
+    .description("Pull your Appwrite buckets")
     .action(actionRunner(pullBucket))
 
 pull
     .command("team")
     .alias("teams")
-    .description("Pulling your Appwrite teams")
+    .description("Pull your Appwrite teams")
     .action(actionRunner(pullTeam))
 
 pull
     .command("topic")
     .alias("topics")
-    .description("Initialise your Appwrite messaging topics")
+    .description("Pull your Appwrite messaging topics")
     .action(actionRunner(pullMessagingTopic))
 
 module.exports = {

package/lib/commands/push.js

@@ -368,6 +368,7 @@ const getConfirmation = async () => {
     return false;
 
 };
+const isEmpty = (value) => (value === null || value === undefined || (typeof value === "string" && value.trim().length === 0) || (Array.isArray(value) && value.length === 0));
 
 const approveChanges = async (resource, resourceGetFunction, keys, resourceName, resourcePlural, skipKeys = [], secondId = '', secondResourceName = '') => {
     log('Checking for changes ...');
@@ -390,6 +391,11 @@ const approveChanges = async (resource, resourceGetFunction, keys, resourceName,
                 if (skipKeys.includes(key)) {
                     continue;
                 }
+
+                if (isEmpty(value) && isEmpty(localResource[key])) {
+                    continue;
+                }
+
                 if (Array.isArray(value) && Array.isArray(localResource[key])) {
                     if (JSON.stringify(value) !== JSON.stringify(localResource[key])) {
                         changes.push({
@@ -697,6 +703,10 @@ const deleteAttribute = async (collection, attribute, isIndex = false) => {
 }
 
 const compareAttribute = (remote, local, reason, key) => {
+    if (isEmpty(remote) && isEmpty(local)) {
+        return reason;
+    }
+
     if (Array.isArray(remote) && Array.isArray(local)) {
         if (JSON.stringify(remote) !== JSON.stringify(local)) {
             const bol = reason === '' ? '' : '\n';
@@ -993,6 +1003,8 @@ const pushSettings = async () => {
 }
 
 const pushFunction = async ({ functionId, async, code, withVariables } = { returnOnZero: false }) => {
+    process.chdir(localConfig.configDirectoryPath)
+
     const functionIds = [];
 
     if (functionId) {
@@ -1088,11 +1100,6 @@ const pushFunction = async ({ functionId, async, code, withVariables } = { retur
                 entrypoint: func.entrypoint,
                 commands: func.commands,
                 scopes: func.scopes,
-                providerRepositoryId: func.providerRepositoryId ?? "",
-                installationId: func.installationId ?? '',
-                providerBranch: func.providerBranch ?? '',
-                providerRootDirectory: func.providerRootDirectory ?? '',
-                providerSilentMode: func.providerSilentMode ?? false,
                 vars: JSON.stringify(response.vars),
                 parseOutput: false
             });
@@ -1710,9 +1717,9 @@ push
     .action(actionRunner(pushMessagingTopic));
 
 const deploy = new Command("deploy")
-    .description(commandDescriptions['push'])
+    .description('Removed. Use appwrite push instead')
     .action(actionRunner(async () => {
-        warn("Did you mean to run 'appwrite push' command?");
+        warn("appwrite deploy has been removed. Please use 'appwrite push' instead");
     }));
 
 module.exports = {

package/lib/config.js

@@ -123,10 +123,26 @@ class Config {
 
 class Local extends Config {
     static CONFIG_FILE_PATH = "appwrite.json";
+    configDirectoryPath = ""
 
     constructor(path = Local.CONFIG_FILE_PATH) {
-        let absolutePath = `${process.cwd()}/${path}`;
+        let currentPath = process.cwd();
+        let absolutePath = `${currentPath}/${path}`;
+
+        while (true) {
+            if (fs.existsSync(`${currentPath}/${path}`)) {
+                absolutePath = `${currentPath}/${path}`;
+                break
+            } else {
+                const parentDirectory = _path.dirname(currentPath);
+                if (parentDirectory === currentPath) { // we hit the top directory
+                    break;
+                }
+                currentPath = parentDirectory
+            }
+        }
         super(absolutePath);
+        this.configDirectoryPath =_path.dirname(absolutePath);
     }
 
     getFunctions() {

package/lib/parser.js

@@ -120,7 +120,7 @@ const parseError = (err) => {
             } catch {
             }
 
-            const version = '6.0.0-rc.7';
+            const version = '6.0.0-rc.9';
             const stepsToReproduce = `Running \`appwrite ${cliConfig.reportData.data.args.join(' ')}\``;
             const yourEnvironment = `CLI version: ${version}\nOperation System: ${os.type()}\nAppwrite version: ${appwriteVersion}\nIs Cloud: ${isCloud}`;
 

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": "6.0.0-rc.7",
+  "version": "6.0.0-rc.9",
   "license": "BSD-3-Clause",
   "main": "index.js",
   "bin": {

package/scoop/appwrite.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "6.0.0-rc.7",
+	"version": "6.0.0-rc.9",
 	"description": "The Appwrite CLI is a command-line application that allows you to interact with Appwrite and perform server-side tasks using your terminal.",
 	"homepage": "https://github.com/appwrite/sdk-for-cli",
 	"license": "BSD-3-Clause",
 	"architecture": {
 		"64bit": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.7/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.9/appwrite-cli-win-x64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-x64.exe",
@@ -15,7 +15,7 @@
 			]
 		},
 		"arm64": {
-			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.7/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/6.0.0-rc.9/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",