appwrite-cli 13.4.0 → 13.5.0

package/lib/commands/push.ts

@@ -24,7 +24,11 @@ import {
   type CollectionType,
 } from "./config.js";
 import { parseWithBetterErrors } from "./utils/error-formatter.js";
-import { createSettingsObject } from "../utils.js";
+import {
+  createSettingsObject,
+  checkDeployConditions,
+  arrayEqualsUnordered,
+} from "../utils.js";
 import { Spinner, SPINNER_DOTS } from "../spinner.js";
 import { paginate } from "../paginate.js";
 import { pushDeployment } from "./utils/deployment.js";
@@ -72,7 +76,6 @@ import {
   Client,
   Query,
 } from "@appwrite.io/console";
-import { checkDeployConditions } from "../utils.js";
 import { Pools } from "./utils/pools.js";
 import { Attributes, Collection } from "./utils/attributes.js";
 import {
@@ -98,6 +101,7 @@ export interface PushOptions {
   topics?: boolean;
   skipDeprecated?: boolean;
   skipConfirmation?: boolean;
+  force?: boolean;
   functionOptions?: {
     async?: boolean;
     code?: boolean;
@@ -200,207 +204,219 @@ export class Push {
     results: Record<string, any>;
     errors: any[];
   }> {
-    const { skipDeprecated = true } = options;
-    const results: Record<string, any> = {};
-    const allErrors: any[] = [];
-    const shouldPushAll = options.all === true;
-
-    // Push settings
-    if (
-      (shouldPushAll || options.settings) &&
-      (config.projectName || config.settings)
-    ) {
-      try {
-        this.log("Pushing settings ...");
-        await this.pushSettings({
-          projectId: config.projectId,
-          projectName: config.projectName,
-          settings: config.settings,
-        });
-        this.success(
-          `Successfully pushed ${chalk.bold("all")} project settings.`,
-        );
-        results.settings = { success: true };
-      } catch (e: any) {
-        allErrors.push(e);
-        results.settings = { success: false, error: e.message };
-      }
+    const previousForce = cliConfig.force;
+    if (options.force !== undefined) {
+      cliConfig.force = options.force;
     }
 
-    // Push buckets
-    if (
-      (shouldPushAll || options.buckets) &&
-      config.buckets &&
-      config.buckets.length > 0
-    ) {
-      try {
-        this.log("Pushing buckets ...");
-        const result = await this.pushBuckets(config.buckets);
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} buckets.`,
-        );
-        results.buckets = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.buckets = { successfullyPushed: 0, errors: [e] };
+    try {
+      const { skipDeprecated = true } = options;
+      const results: Record<string, any> = {};
+      const allErrors: any[] = [];
+      const shouldPushAll = options.all === true;
+
+      // Push settings
+      if (
+        (shouldPushAll || options.settings) &&
+        (config.projectName || config.settings)
+      ) {
+        try {
+          this.log("Pushing settings ...");
+          await this.pushSettings({
+            projectId: config.projectId,
+            projectName: config.projectName,
+            settings: config.settings,
+          });
+          this.success(
+            `Successfully pushed ${chalk.bold("all")} project settings.`,
+          );
+          results.settings = { success: true };
+        } catch (e: any) {
+          allErrors.push(e);
+          results.settings = { success: false, error: e.message };
+        }
       }
-    }
 
-    // Push teams
-    if (
-      (shouldPushAll || options.teams) &&
-      config.teams &&
-      config.teams.length > 0
-    ) {
-      try {
-        this.log("Pushing teams ...");
-        const result = await this.pushTeams(config.teams);
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} teams.`,
-        );
-        results.teams = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.teams = { successfullyPushed: 0, errors: [e] };
+      // Push buckets
+      if (
+        (shouldPushAll || options.buckets) &&
+        config.buckets &&
+        config.buckets.length > 0
+      ) {
+        try {
+          this.log("Pushing buckets ...");
+          const result = await this.pushBuckets(config.buckets);
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} buckets.`,
+          );
+          results.buckets = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.buckets = { successfullyPushed: 0, errors: [e] };
+        }
       }
-    }
 
-    // Push messaging topics
-    if (
-      (shouldPushAll || options.topics) &&
-      config.topics &&
-      config.topics.length > 0
-    ) {
-      try {
-        this.log("Pushing topics ...");
-        const result = await this.pushMessagingTopics(config.topics);
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} topics.`,
-        );
-        results.topics = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.topics = { successfullyPushed: 0, errors: [e] };
+      // Push teams
+      if (
+        (shouldPushAll || options.teams) &&
+        config.teams &&
+        config.teams.length > 0
+      ) {
+        try {
+          this.log("Pushing teams ...");
+          const result = await this.pushTeams(config.teams);
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} teams.`,
+          );
+          results.teams = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.teams = { successfullyPushed: 0, errors: [e] };
+        }
       }
-    }
 
-    // Push functions
-    if (
-      (shouldPushAll || options.functions) &&
-      config.functions &&
-      config.functions.length > 0
-    ) {
-      try {
-        this.log("Pushing functions ...");
-        const result = await this.pushFunctions(
-          config.functions,
-          options.functionOptions,
-        );
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} functions.`,
-        );
-        results.functions = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.functions = {
-          successfullyPushed: 0,
-          successfullyDeployed: 0,
-          failedDeployments: [],
-          errors: [e],
-        };
+      // Push messaging topics
+      if (
+        (shouldPushAll || options.topics) &&
+        config.topics &&
+        config.topics.length > 0
+      ) {
+        try {
+          this.log("Pushing topics ...");
+          const result = await this.pushMessagingTopics(config.topics);
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} topics.`,
+          );
+          results.topics = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.topics = { successfullyPushed: 0, errors: [e] };
+        }
       }
-    }
 
-    // Push sites
-    if (
-      (shouldPushAll || options.sites) &&
-      config.sites &&
-      config.sites.length > 0
-    ) {
-      try {
-        this.log("Pushing sites ...");
-        const result = await this.pushSites(config.sites, options.siteOptions);
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} sites.`,
-        );
-        results.sites = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.sites = {
-          successfullyPushed: 0,
-          successfullyDeployed: 0,
-          failedDeployments: [],
-          errors: [e],
-        };
+      // Push functions
+      if (
+        (shouldPushAll || options.functions) &&
+        config.functions &&
+        config.functions.length > 0
+      ) {
+        try {
+          this.log("Pushing functions ...");
+          const result = await this.pushFunctions(
+            config.functions,
+            options.functionOptions,
+          );
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} functions.`,
+          );
+          results.functions = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.functions = {
+            successfullyPushed: 0,
+            successfullyDeployed: 0,
+            failedDeployments: [],
+            errors: [e],
+          };
+        }
       }
-    }
 
-    // Push tables
-    if (
-      (shouldPushAll || options.tables) &&
-      config.tables &&
-      config.tables.length > 0
-    ) {
-      try {
-        this.log("Pushing tables ...");
-        const result = await this.pushTables(config.tables, {
-          attempts: options.tableOptions?.attempts,
-          skipConfirmation: options.skipConfirmation,
-        });
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} tables.`,
-        );
-        results.tables = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.tables = { successfullyPushed: 0, errors: [e] };
+      // Push sites
+      if (
+        (shouldPushAll || options.sites) &&
+        config.sites &&
+        config.sites.length > 0
+      ) {
+        try {
+          this.log("Pushing sites ...");
+          const result = await this.pushSites(
+            config.sites,
+            options.siteOptions,
+          );
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} sites.`,
+          );
+          results.sites = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.sites = {
+            successfullyPushed: 0,
+            successfullyDeployed: 0,
+            failedDeployments: [],
+            errors: [e],
+          };
+        }
       }
-    }
 
-    // Push collections (skipDeprecated only applies when pushing all, explicit collections option takes precedence)
-    if (
-      (options.collections || (shouldPushAll && !skipDeprecated)) &&
-      config.collections &&
-      config.collections.length > 0
-    ) {
-      try {
-        this.log("Pushing collections ...");
-        // Add database names to collections
-        const collectionsWithDbNames = config.collections.map(
-          (collection: any) => {
-            const database = config.databases?.find(
-              (db: any) => db.$id === collection.databaseId,
-            );
-            return {
-              ...collection,
-              databaseName: database?.name ?? collection.databaseId,
-            };
-          },
-        );
-        const result = await this.pushCollections(collectionsWithDbNames, {
-          skipConfirmation: options.skipConfirmation,
-        });
-        this.success(
-          `Successfully pushed ${chalk.bold(result.successfullyPushed)} collections.`,
-        );
-        results.collections = result;
-        allErrors.push(...result.errors);
-      } catch (e: any) {
-        allErrors.push(e);
-        results.collections = { successfullyPushed: 0, errors: [e] };
+      // Push tables
+      if (
+        (shouldPushAll || options.tables) &&
+        config.tables &&
+        config.tables.length > 0
+      ) {
+        try {
+          this.log("Pushing tables ...");
+          const result = await this.pushTables(config.tables, {
+            attempts: options.tableOptions?.attempts,
+            skipConfirmation: options.skipConfirmation,
+          });
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} tables.`,
+          );
+          results.tables = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.tables = { successfullyPushed: 0, errors: [e] };
+        }
       }
-    }
 
-    return {
-      results,
-      errors: allErrors,
-    };
+      // Push collections (skipDeprecated only applies when pushing all, explicit collections option takes precedence)
+      if (
+        (options.collections || (shouldPushAll && !skipDeprecated)) &&
+        config.collections &&
+        config.collections.length > 0
+      ) {
+        try {
+          this.log("Pushing collections ...");
+          // Add database names to collections
+          const collectionsWithDbNames = config.collections.map(
+            (collection: any) => {
+              const database = config.databases?.find(
+                (db: any) => db.$id === collection.databaseId,
+              );
+              return {
+                ...collection,
+                databaseName: database?.name ?? collection.databaseId,
+              };
+            },
+          );
+          const result = await this.pushCollections(collectionsWithDbNames, {
+            skipConfirmation: options.skipConfirmation,
+          });
+          this.success(
+            `Successfully pushed ${chalk.bold(result.successfullyPushed)} collections.`,
+          );
+          results.collections = result;
+          allErrors.push(...result.errors);
+        } catch (e: any) {
+          allErrors.push(e);
+          results.collections = { successfullyPushed: 0, errors: [e] };
+        }
+      }
+
+      return {
+        results,
+        errors: allErrors,
+      };
+    } finally {
+      cliConfig.force = previousForce;
+    }
   }
 
   public async pushSettings(config: {
@@ -489,13 +505,54 @@ export class Push {
     let successfullyPushed = 0;
     const errors: any[] = [];
 
+    const hasBucketChanges = (remoteBucket: any, localBucket: any): boolean => {
+      const scalarFields = [
+        "name",
+        "fileSecurity",
+        "enabled",
+        "maximumFileSize",
+        "encryption",
+        "antivirus",
+        "compression",
+      ] as const;
+
+      if (
+        scalarFields.some((field) => remoteBucket[field] !== localBucket[field])
+      ) {
+        return true;
+      }
+
+      if (
+        !arrayEqualsUnordered(
+          remoteBucket["$permissions"],
+          localBucket["$permissions"],
+        )
+      ) {
+        return true;
+      }
+
+      return !arrayEqualsUnordered(
+        remoteBucket.allowedFileExtensions,
+        localBucket.allowedFileExtensions,
+      );
+    };
+
     for (const bucket of buckets) {
       try {
         this.log(`Pushing bucket ${chalk.bold(bucket["name"])} ...`);
         const storageService = await getStorageService(this.projectClient);
 
         try {
-          await storageService.getBucket(bucket["$id"]);
+          const remoteBucket = await storageService.getBucket(bucket["$id"]);
+          const hasChanges = hasBucketChanges(remoteBucket, bucket);
+
+          if (!hasChanges) {
+            this.log(
+              `No changes detected for bucket ${chalk.bold(bucket["name"])}. Skipping.`,
+            );
+            continue;
+          }
+
           await storageService.updateBucket({
             bucketId: bucket["$id"],
             name: bucket.name,
@@ -508,6 +565,7 @@ export class Push {
             antivirus: bucket.antivirus,
             compression: bucket.compression,
           });
+          successfullyPushed++;
         } catch (e: unknown) {
           if (e instanceof AppwriteException && Number(e.code) === 404) {
             await storageService.createBucket({
@@ -522,12 +580,11 @@ export class Push {
               encryption: bucket.encryption,
               antivirus: bucket.antivirus,
             });
+            successfullyPushed++;
           } else {
             throw e;
           }
         }
-
-        successfullyPushed++;
       } catch (e: any) {
         errors.push(e);
         this.error(`Failed to push bucket ${bucket["name"]}: ${e.message}`);
@@ -1360,8 +1417,12 @@ export class Push {
   }> {
     const { attempts, skipConfirmation = false } = options;
     const pollMaxDebounces = attempts ?? POLL_DEFAULT_VALUE;
-    const pools = new Pools(pollMaxDebounces);
-    const attributes = new Attributes(pools, skipConfirmation);
+    const pools = new Pools(pollMaxDebounces, this.projectClient);
+    const attributes = new Attributes(
+      pools,
+      skipConfirmation,
+      this.projectClient,
+    );
 
     let tablesChanged = new Set();
     const errors: any[] = [];
@@ -1454,6 +1515,11 @@ export class Push {
         hadChanges = columnsResult.hasChanges || indexesResult.hasChanges;
 
         if (!hadChanges && columns.length <= 0 && indexes.length <= 0) {
+          if (!tablesChanged.has(table["$id"])) {
+            this.log(
+              `No changes detected for table ${chalk.bold(table["name"])}. Skipping.`,
+            );
+          }
           continue;
         }
       }
@@ -1493,8 +1559,12 @@ export class Push {
     errors: Error[];
   }> {
     const { skipConfirmation = false } = options;
-    const pools = new Pools(POLL_DEFAULT_VALUE);
-    const attributesHelper = new Attributes(pools, skipConfirmation);
+    const pools = new Pools(POLL_DEFAULT_VALUE, this.projectClient);
+    const attributesHelper = new Attributes(
+      pools,
+      skipConfirmation,
+      this.projectClient,
+    );
 
     const errors: Error[] = [];
 
@@ -1935,15 +2005,17 @@ const pushSite = async ({
     const { name, deployment, $id } = failed;
     const projectId = localConfig.getProject().projectId;
     const endpoint = localConfig.getEndpoint() || globalConfig.getEndpoint();
-    let region = '';
+    let region = "";
     try {
       const hostname = new URL(endpoint).hostname;
-      const firstSubdomain = hostname.split('.')[0];
+      const firstSubdomain = hostname.split(".")[0];
       if (firstSubdomain.length === 3) {
         region = firstSubdomain;
       }
     } catch {}
-    const projectSlug = region ? `project-${region}-${projectId}` : `project-${projectId}`;
+    const projectSlug = region
+      ? `project-${region}-${projectId}`
+      : `project-${projectId}`;
     const failUrl = `${globalConfig.getEndpoint().slice(0, -3)}/console/${projectSlug}/sites/site-${$id}/deployments/deployment-${deployment}`;
 
     error(
@@ -2074,15 +2146,17 @@ const pushFunction = async ({
     const { name, deployment, $id } = failed;
     const projectId = localConfig.getProject().projectId;
     const endpoint = localConfig.getEndpoint() || globalConfig.getEndpoint();
-    let region = '';
+    let region = "";
     try {
       const hostname = new URL(endpoint).hostname;
-      const firstSubdomain = hostname.split('.')[0];
+      const firstSubdomain = hostname.split(".")[0];
       if (firstSubdomain.length === 3) {
         region = firstSubdomain;
       }
     } catch {}
-    const projectSlug = region ? `project-${region}-${projectId}` : `project-${projectId}`;
+    const projectSlug = region
+      ? `project-${region}-${projectId}`
+      : `project-${projectId}`;
     const failUrl = `${globalConfig.getEndpoint().slice(0, -3)}/console/${projectSlug}/functions/function-${$id}/deployment-${deployment}`;
 
     error(
@@ -2316,12 +2390,13 @@ const pushCollection = async (): Promise<void> => {
     const localDatabase = localConfig.getDatabase(collection.databaseId);
     collection.databaseName = localDatabase.name ?? collection.databaseId;
   });
+  const projectClient = await sdkForProject();
 
   if (
     !(await approveChanges(
       collections,
       async (args: any) => {
-        const databasesService = await getDatabasesService();
+        const databasesService = await getDatabasesService(projectClient);
         return await databasesService.getCollection(
           args.databaseId,
           args.collectionId,

package/lib/commands/services/migrations.ts

@@ -29,7 +29,7 @@ export const migrations = new Command("migrations")
 migrations
   .command(`list`)
   .description(`List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.`)
-  .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: status, stage, source, destination, resources, statusCounters, resourceData, errors`)
+  .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: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors`)
   .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
   .option(
     `--total [value]`,

package/lib/commands/services/projects.ts

@@ -523,6 +523,57 @@ projects
     ),
   );
 
+projects
+  .command(`list-schedules`)
+  .description(`Get a list of all the project's schedules. You can use the query params to filter your results.`)
+  .requiredOption(`--project-id <project-id>`, `Project unique 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: resourceType, resourceId, projectId, schedule, active, region`)
+  .option(
+    `--total [value]`,
+    `When set to false, the total count returned will be 0 and will not be calculated.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .action(
+    actionRunner(
+      async ({ projectId, queries, total }) =>
+        parse(await (await getProjectsClient()).listSchedules(projectId, queries, total)),
+    ),
+  );
+
+projects
+  .command(`create-schedule`)
+  .description(`Create a new schedule for a resource.`)
+  .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
+  .requiredOption(`--resource-type <resource-type>`, `The resource type for the schedule. Possible values: function, execution, message.`)
+  .requiredOption(`--resource-id <resource-id>`, `The resource ID to associate with this schedule.`)
+  .requiredOption(`--schedule <schedule>`, `Schedule CRON expression.`)
+  .option(
+    `--active [value]`,
+    `Whether the schedule is active.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
+  .option(`--data <data>`, `Schedule data as a JSON string. Used to store resource-specific context needed for execution.`)
+  .action(
+    actionRunner(
+      async ({ projectId, resourceType, resourceId, schedule, active, data }) =>
+        parse(await (await getProjectsClient()).createSchedule(projectId, resourceType, resourceId, schedule, active, JSON.parse(data))),
+    ),
+  );
+
+projects
+  .command(`get-schedule`)
+  .description(`Get a schedule by its unique ID.`)
+  .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
+  .requiredOption(`--schedule-id <schedule-id>`, `Schedule ID.`)
+  .action(
+    actionRunner(
+      async ({ projectId, scheduleId }) =>
+        parse(await (await getProjectsClient()).getSchedule(projectId, scheduleId)),
+    ),
+  );
+
 projects
   .command(`update-service-status`)
   .description(`Update the status of a specific service. Use this endpoint to enable or disable a service in your project. `)