appwrite-cli 13.6.0 → 14.0.0

package/lib/commands/services/databases.ts

@@ -314,7 +314,7 @@ databases
   .description(`Create a boolean attribute.
 `)
   .requiredOption(`--database-id <database-id>`, `Database ID.`)
-  .requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
+  .requiredOption(`--collection-id <collection-id>`, `Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).`)
   .requiredOption(`--key <key>`, `Attribute Key.`)
   .requiredOption(`--required <required>`, `Is attribute required?`, parseBool)
   .option(
@@ -801,6 +801,22 @@ databases
     ),
   );
 
+databases
+  .command(`update-relationship-attribute`)
+  .description(`Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
+`)
+  .requiredOption(`--database-id <database-id>`, `Database ID.`)
+  .requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
+  .requiredOption(`--key <key>`, `Attribute Key.`)
+  .option(`--on-delete <on-delete>`, `Constraints option`)
+  .option(`--new-key <new-key>`, `New Attribute Key.`)
+  .action(
+    actionRunner(
+      async ({ databaseId, collectionId, key, onDelete, newKey }) =>
+        parse(await (await getDatabasesClient()).updateRelationshipAttribute(databaseId, collectionId, key, onDelete, newKey)),
+    ),
+  );
+
 databases
   .command(`create-string-attribute`)
   .description(`Create a string attribute.
@@ -1005,22 +1021,6 @@ databases
     ),
   );
 
-databases
-  .command(`update-relationship-attribute`)
-  .description(`Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
-`)
-  .requiredOption(`--database-id <database-id>`, `Database ID.`)
-  .requiredOption(`--collection-id <collection-id>`, `Collection ID.`)
-  .requiredOption(`--key <key>`, `Attribute Key.`)
-  .option(`--on-delete <on-delete>`, `Constraints option`)
-  .option(`--new-key <new-key>`, `New Attribute Key.`)
-  .action(
-    actionRunner(
-      async ({ databaseId, collectionId, key, onDelete, newKey }) =>
-        parse(await (await getDatabasesClient()).updateRelationshipAttribute(databaseId, collectionId, key, onDelete, newKey)),
-    ),
-  );
-
 databases
   .command(`list-documents`)
   .description(`Get a list of all the user's documents in a given collection. You can use the query params to filter your results.`)
@@ -1034,10 +1034,11 @@ databases
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(`--ttl <ttl>`, `TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).`, parseInteger)
   .action(
     actionRunner(
-      async ({ databaseId, collectionId, queries, transactionId, total }) =>
-        parse(await (await getDatabasesClient()).listDocuments(databaseId, collectionId, queries, transactionId, total)),
+      async ({ databaseId, collectionId, queries, transactionId, total, ttl }) =>
+        parse(await (await getDatabasesClient()).listDocuments(databaseId, collectionId, queries, transactionId, total, ttl)),
     ),
   );
 

package/lib/commands/services/health.ts

@@ -64,6 +64,19 @@ health
     ),
   );
 
+health
+  .command(`get-console-pausing`)
+  .description(`Get console pausing health status. Monitors projects approaching the pause threshold to detect potential issues with console access tracking.
+`)
+  .option(`--threshold <threshold>`, `Percentage threshold of projects approaching pause. When hit (equal or higher), endpoint returns server error. Default value is 10.`, parseInteger)
+  .option(`--inactivity-days <inactivity-days>`, `Number of days of inactivity before a project is paused. Should match the plan's projectInactivityDays setting. Default value is 7.`, parseInteger)
+  .action(
+    actionRunner(
+      async ({ threshold, inactivityDays }) =>
+        parse(await (await getHealthClient()).getConsolePausing(threshold, inactivityDays)),
+    ),
+  );
+
 health
   .command(`get-db`)
   .description(`Check the Appwrite database servers are up and connection is successful.`)

package/lib/commands/services/messaging.ts

@@ -993,7 +993,7 @@ messaging
   .command(`list-subscribers`)
   .description(`Get a list of all subscribers from the current Appwrite project.`)
   .requiredOption(`--topic-id <topic-id>`, `Topic ID. The topic ID subscribed to.`)
-  .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: name, provider, type, enabled`)
+  .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: targetId, topicId, userId, providerType`)
   .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
   .option(
     `--total [value]`,

package/lib/commands/services/projects.ts

@@ -270,6 +270,18 @@ projects
     ),
   );
 
+projects
+  .command(`update-console-access`)
+  .description(`Record console access to a project. This endpoint updates the last accessed timestamp for the project to track console activity.
+`)
+  .requiredOption(`--project-id <project-id>`, `Project ID`)
+  .action(
+    actionRunner(
+      async ({ projectId }) =>
+        parse(await (await getProjectsClient()).updateConsoleAccess(projectId)),
+    ),
+  );
+
 projects
   .command(`list-dev-keys`)
   .description(`List all the project\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'`)
@@ -639,6 +651,19 @@ projects
     ),
   );
 
+projects
+  .command(`update-status`)
+  .description(`Update the status of a project. Can be used to archive/restore projects, and to restore paused projects. When restoring a paused project, the console fingerprint header must be provided and the project must not be blocked for any reason other than inactivity.
+`)
+  .requiredOption(`--project-id <project-id>`, `Project ID`)
+  .requiredOption(`--status <status>`, `New status for the project`)
+  .action(
+    actionRunner(
+      async ({ projectId, status }) =>
+        parse(await (await getProjectsClient()).updateStatus(projectId, status)),
+    ),
+  );
+
 projects
   .command(`update-team`)
   .description(`Update the team ID of a project allowing for it to be transferred to another team.`)

package/lib/commands/services/sites.ts

@@ -243,14 +243,19 @@ sites
   .description(`Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.`)
   .requiredOption(`--site-id <site-id>`, `Site ID.`)
   .requiredOption(`--code <code>`, `Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.`)
-  .requiredOption(`--activate <activate>`, `Automatically activate the deployment when it is finished building.`, parseBool)
   .option(`--install-command <install-command>`, `Install Commands.`)
   .option(`--build-command <build-command>`, `Build Commands.`)
   .option(`--output-directory <output-directory>`, `Output Directory.`)
+  .option(
+    `--activate [value]`,
+    `Automatically activate the deployment when it is finished building.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ siteId, code, activate, installCommand, buildCommand, outputDirectory }) =>
-        parse(await (await getSitesClient()).createDeployment(siteId, code, activate, installCommand, buildCommand, outputDirectory)),
+      async ({ siteId, code, installCommand, buildCommand, outputDirectory, activate }) =>
+        parse(await (await getSitesClient()).createDeployment(siteId, code, installCommand, buildCommand, outputDirectory, activate)),
     ),
   );
 

package/lib/commands/services/tables-db.ts

@@ -1109,10 +1109,11 @@ tablesDB
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(`--ttl <ttl>`, `TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).`, parseInteger)
   .action(
     actionRunner(
-      async ({ databaseId, tableId, queries, transactionId, total }) =>
-        parse(await (await getTablesDBClient()).listRows(databaseId, tableId, queries, transactionId, total)),
+      async ({ databaseId, tableId, queries, transactionId, total, ttl }) =>
+        parse(await (await getTablesDBClient()).listRows(databaseId, tableId, queries, transactionId, total, ttl)),
     ),
   );
 

package/lib/commands/services/teams.ts

@@ -139,7 +139,7 @@ Use the \`url\` parameter to redirect the user from the invitation email to your
 Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.
 `)
   .requiredOption(`--team-id <team-id>`, `Team ID.`)
-  .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](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 32 characters long.`)
+  .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](https://appwrite.io/docs/permissions). Maximum of 100 roles are allowed, each 81 characters long.`)
   .option(`--email <email>`, `Email of the new team member.`)
   .option(`--user-id <user-id>`, `ID of the user to be added to a team.`)
   .option(`--phone <phone>`, `Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.`)
@@ -170,7 +170,7 @@ teams
 `)
   .requiredOption(`--team-id <team-id>`, `Team ID.`)
   .requiredOption(`--membership-id <membership-id>`, `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). Maximum of 100 roles are allowed, each 32 characters long.`)
+  .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 81 characters long.`)
   .action(
     actionRunner(
       async ({ teamId, membershipId, roles }) =>

package/lib/commands/types.ts

@@ -83,6 +83,16 @@ interface TypesOptions {
   strict: boolean;
 }
 
+type TypeAttribute = Record<string, unknown> & {
+  relatedTable?: string;
+};
+
+type TypeDataItem = Record<string, unknown> & {
+  name: string;
+  attributes?: TypeAttribute[];
+  columns?: TypeAttribute[];
+};
+
 const typesCommand = actionRunner(
   async (rawOutputDirectory: string, { language, strict }: TypesOptions) => {
     if (language === "auto") {
@@ -126,13 +136,11 @@ const typesCommand = actionRunner(
     }
 
     // Try tables first, fallback to collections
-    let tables = localConfig.getTables();
-    let collections: any[] = [];
-    let dataSource = "tables";
+    const tables = localConfig.getTables();
+    let collections: TypeDataItem[] = [];
 
     if (tables.length === 0) {
       collections = localConfig.getCollections();
-      dataSource = "collections";
 
       if (collections.length === 0) {
         const configFileName = path.basename(localConfig.path);
@@ -143,7 +151,8 @@ const typesCommand = actionRunner(
     }
 
     // Use tables if available, otherwise use collections
-    let dataItems: any[] = tables.length > 0 ? tables : collections;
+    let dataItems: TypeDataItem[] =
+      tables.length > 0 ? (tables as TypeDataItem[]) : collections;
     const itemType = tables.length > 0 ? "tables" : "collections";
 
     // Normalize tables data: rename 'columns' to 'attributes' for template compatibility
@@ -152,7 +161,7 @@ const typesCommand = actionRunner(
         const { columns, ...rest } = table;
         return {
           ...rest,
-          attributes: (columns || []).map((column: any) => {
+          attributes: (columns || []).map((column: TypeAttribute) => {
             if (column.relatedTable) {
               const { relatedTable, ...columnRest } = column;
               return {
@@ -167,14 +176,15 @@ const typesCommand = actionRunner(
     }
 
     log(
-      `Found ${dataItems.length} ${itemType}: ${dataItems.map((c: any) => c.name).join(", ")}`,
+      `Found ${dataItems.length} ${itemType}: ${dataItems.map((c) => c.name).join(", ")}`,
     );
 
     // Use columns if available, otherwise use attributes
     const resourceType = tables.length > 0 ? "columns" : "attributes";
 
     const totalAttributes = dataItems.reduce(
-      (count: number, item: any) => count + (item.attributes || []).length,
+      (count: number, item: TypeDataItem) =>
+        count + (item.attributes || []).length,
       0,
     );
     log(`Found ${totalAttributes} ${resourceType} across all ${itemType}`);

package/lib/commands/update.ts

@@ -3,7 +3,11 @@ import { Command } from "commander";
 import chalk from "chalk";
 import inquirer from "inquirer";
 import { success, log, warn, error, hint, actionRunner } from "../parser.js";
-import { getLatestVersion, compareVersions } from "../utils.js";
+import {
+  getLatestVersion,
+  compareVersions,
+  getErrorMessage,
+} from "../utils.js";
 import {
   GITHUB_RELEASES_URL,
   NPM_PACKAGE_NAME,
@@ -12,6 +16,8 @@ import {
 import packageJson from "../../package.json" with { type: "json" };
 const { version } = packageJson;
 
+type ExecCommandOptions = Exclude<Parameters<typeof spawn>[2], undefined>;
+
 /**
  * Check if the CLI was installed via npm
  */
@@ -36,7 +42,7 @@ const isInstalledViaNpm = (): boolean => {
     }
 
     return false;
-  } catch (e) {
+  } catch (_e) {
     return false;
   }
 };
@@ -51,7 +57,7 @@ const isInstalledViaHomebrew = (): boolean => {
       scriptPath.includes("/opt/homebrew/") ||
       scriptPath.includes("/usr/local/Cellar/")
     );
-  } catch (e) {
+  } catch (_e) {
     return false;
   }
 };
@@ -62,7 +68,7 @@ const isInstalledViaHomebrew = (): boolean => {
 const execCommand = (
   command: string,
   args: string[] = [],
-  options: any = {},
+  options: ExecCommandOptions = {},
 ): Promise<void> => {
   return new Promise((resolve, reject) => {
     const child = spawn(command, args, {
@@ -94,17 +100,16 @@ const updateViaNpm = async (): Promise<void> => {
     console.log("");
     success("Updated to latest version via npm!");
     hint("Run 'appwrite --version' to verify the new version.");
-  } catch (e: any) {
-    if (
-      e.message.includes("EEXIST") ||
-      e.message.includes("file already exists")
-    ) {
+  } catch (e: unknown) {
+    const message = getErrorMessage(e);
+
+    if (message.includes("EEXIST") || message.includes("file already exists")) {
       console.log("");
       success("Latest version is already installed via npm!");
       hint("The CLI is up to date. Run 'appwrite --version' to verify.");
     } else {
       console.log("");
-      error(`Failed to update via npm: ${e.message}`);
+      error(`Failed to update via npm: ${message}`);
       hint(`Try running: npm install -g ${NPM_PACKAGE_NAME}@latest --force`);
     }
   }
@@ -119,17 +124,19 @@ const updateViaHomebrew = async (): Promise<void> => {
     console.log("");
     success("Updated to latest version via Homebrew!");
     hint("Run 'appwrite --version' to verify the new version.");
-  } catch (e: any) {
+  } catch (e: unknown) {
+    const message = getErrorMessage(e);
+
     if (
-      e.message.includes("already installed") ||
-      e.message.includes("up-to-date")
+      message.includes("already installed") ||
+      message.includes("up-to-date")
     ) {
       console.log("");
       success("Latest version is already installed via Homebrew!");
       hint("The CLI is up to date. Run 'appwrite --version' to verify.");
     } else {
       console.log("");
-      error(`Failed to update via Homebrew: ${e.message}`);
+      error(`Failed to update via Homebrew: ${message}`);
       hint("Try running: brew upgrade appwrite");
     }
   }
@@ -230,9 +237,10 @@ const updateCli = async ({ manual }: UpdateOptions = {}): Promise<void> => {
     } else {
       await chooseUpdateMethod(latestVersion);
     }
-  } catch (e: any) {
+  } catch (e: unknown) {
+    const message = getErrorMessage(e);
     console.log("");
-    error(`Failed to check for updates: ${e.message}`);
+    error(`Failed to check for updates: ${message}`);
     hint(`You can manually check for updates at: ${GITHUB_RELEASES_URL}`);
   }
 };

package/lib/commands/utils/attributes.ts

@@ -76,7 +76,7 @@ export class Attributes {
       return answers.changes;
     }
 
-    let answers = await inquirer.prompt(questionPushChanges);
+    const answers = await inquirer.prompt(questionPushChanges);
 
     if (answers.changes !== "YES" && answers.changes !== "NO") {
       answers.changes = await fixConfirmation();
@@ -148,9 +148,9 @@ export class Attributes {
     const keyName = `${chalk.yellow(local.key)} in ${collection.name} (${collection["$id"]})`;
     const action = chalk.cyan(recreating ? "recreating" : "changing");
     let reason = "";
-    let attribute = recreating ? remote : local;
+    const attribute = recreating ? remote : local;
 
-    for (let key of Object.keys(remote)) {
+    for (const key of Object.keys(remote)) {
       if (!KeysAttributes.has(key)) {
         continue;
       }
@@ -737,7 +737,7 @@ export class Attributes {
     log(`Creating indexes ...`);
 
     const databasesService = await getDatabasesService(this.client);
-    for (let index of indexes) {
+    for (const index of indexes) {
       await databasesService.createIndex({
         databaseId: collection["databaseId"],
         collectionId: collection["$id"],
@@ -769,7 +769,7 @@ export class Attributes {
   ): Promise<void> => {
     log(`Creating attributes ...`);
 
-    for (let attribute of attributes) {
+    for (const attribute of attributes) {
       if (attribute.side !== "child") {
         await this.createAttribute(
           collection["databaseId"],
@@ -803,7 +803,7 @@ export class Attributes {
   ): Promise<void> => {
     log(`Creating columns ...`);
 
-    for (let column of columns) {
+    for (const column of columns) {
       if (column.side !== "child") {
         await this.createAttribute(table["databaseId"], table["$id"], column);
       }

package/lib/commands/utils/change-approval.ts

@@ -1,5 +1,6 @@
 import chalk from "chalk";
 import inquirer from "inquirer";
+import { AppwriteException } from "@appwrite.io/console";
 import { cliConfig, success, warn, log, drawTable } from "../../parser.js";
 import { whitelistKeys } from "../../config.js";
 import {
@@ -10,7 +11,7 @@ import {
 /**
  * Check if a value is considered empty
  */
-export const isEmpty = (value: any): boolean =>
+export const isEmpty = (value: unknown): boolean =>
   value === null ||
   value === undefined ||
   (typeof value === "string" && value.trim().length === 0) ||
@@ -33,7 +34,7 @@ export const getConfirmation = async (): Promise<boolean> => {
     return answers.changes;
   }
 
-  let answers = await inquirer.prompt(questionPushChanges);
+  const answers = await inquirer.prompt(questionPushChanges);
 
   if (answers.changes !== "YES" && answers.changes !== "NO") {
     answers.changes = await fixConfirmation();
@@ -57,9 +58,9 @@ interface ObjectChange {
   local: string;
 }
 
-type ComparableValue = boolean | number | string | any[] | undefined;
+type ComparableValue = boolean | number | string | unknown[] | undefined;
 
-export const getObjectChanges = <T extends Record<string, any>>(
+export const getObjectChanges = <T extends Record<string, unknown>>(
   remote: T,
   local: T,
   index: keyof T,
@@ -110,8 +111,10 @@ export const getObjectChanges = <T extends Record<string, any>>(
  * Compares local resources with remote resources and prompts user for confirmation
  */
 export const approveChanges = async (
-  resource: any[],
-  resourceGetFunction: Function,
+  resource: Array<Record<string, unknown>>,
+  resourceGetFunction: (
+    options: Record<string, unknown>,
+  ) => Promise<Record<string, unknown>>,
   keys: Set<string>,
   resourceName: string,
   resourcePlural: string,
@@ -120,12 +123,12 @@ export const approveChanges = async (
   secondResourceName: string = "",
 ): Promise<boolean> => {
   log("Checking for changes ...");
-  const changes: any[] = [];
+  const changes: Array<Record<string, unknown>> = [];
 
   await Promise.all(
     resource.map(async (localResource) => {
       try {
-        const options: Record<string, any> = {
+        const options: Record<string, unknown> = {
           [resourceName]: localResource["$id"],
         };
 
@@ -135,7 +138,7 @@ export const approveChanges = async (
 
         const remoteResource = await resourceGetFunction(options);
 
-        for (let [key, value] of Object.entries(
+        for (const [key, value] of Object.entries(
           whitelistKeys(remoteResource, keys),
         )) {
           if (skipKeys.includes(key)) {
@@ -146,28 +149,32 @@ export const approveChanges = async (
             continue;
           }
 
-          if (Array.isArray(value) && Array.isArray(localResource[key])) {
-            if (JSON.stringify(value) !== JSON.stringify(localResource[key])) {
+          const localValue = localResource[key];
+
+          if (Array.isArray(value) && Array.isArray(localValue)) {
+            if (JSON.stringify(value) !== JSON.stringify(localValue)) {
               changes.push({
                 id: localResource["$id"],
                 key,
                 remote: chalk.red((value as string[]).join("\n")),
-                local: chalk.green(localResource[key].join("\n")),
+                local: chalk.green(
+                  localValue.map((entry) => String(entry)).join("\n"),
+                ),
               });
             }
-          } else if (value !== localResource[key]) {
+          } else if (value !== localValue) {
             changes.push({
               id: localResource["$id"],
               key,
-              remote: chalk.red(value),
-              local: chalk.green(localResource[key]),
+              remote: chalk.red(String(value ?? "")),
+              local: chalk.green(String(localValue ?? "")),
             });
           }
         }
-      } catch (e: any) {
-        if (Number(e.code) !== 404) {
-          throw e;
-        }
+      } catch (e: unknown) {
+        const isNotFound =
+          e instanceof AppwriteException && Number(e.code) === 404;
+        if (!isNotFound) throw e;
       }
     }),
   );