appwrite-cli 13.3.2 → 13.5.0

package/lib/commands/services/databases.ts

@@ -640,10 +640,16 @@ databases
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, collectionId, key, required, xdefault, array }) =>
-        parse(await (await getDatabasesClient()).createLongtextAttribute(databaseId, collectionId, key, required, xdefault, array)),
+      async ({ databaseId, collectionId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getDatabasesClient()).createLongtextAttribute(databaseId, collectionId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -679,10 +685,16 @@ databases
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, collectionId, key, required, xdefault, array }) =>
-        parse(await (await getDatabasesClient()).createMediumtextAttribute(databaseId, collectionId, key, required, xdefault, array)),
+      async ({ databaseId, collectionId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getDatabasesClient()).createMediumtextAttribute(databaseId, collectionId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -851,10 +863,16 @@ databases
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, collectionId, key, required, xdefault, array }) =>
-        parse(await (await getDatabasesClient()).createTextAttribute(databaseId, collectionId, key, required, xdefault, array)),
+      async ({ databaseId, collectionId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getDatabasesClient()).createTextAttribute(databaseId, collectionId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -930,10 +948,16 @@ databases
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, collectionId, key, size, required, xdefault, array }) =>
-        parse(await (await getDatabasesClient()).createVarcharAttribute(databaseId, collectionId, key, size, required, xdefault, array)),
+      async ({ databaseId, collectionId, key, size, required, xdefault, array, encrypt }) =>
+        parse(await (await getDatabasesClient()).createVarcharAttribute(databaseId, collectionId, key, size, required, xdefault, array, encrypt)),
     ),
   );
 

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

@@ -350,6 +350,7 @@ projects
   .command(`list-keys`)
   .description(`Get a list of all API keys from the current project. `)
   .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: expire, accessedAt, name, scopes`)
   .option(
     `--total [value]`,
     `When set to false, the total count returned will be 0 and will not be calculated.`,
@@ -358,8 +359,8 @@ projects
   )
   .action(
     actionRunner(
-      async ({ projectId, total }) =>
-        parse(await (await getProjectsClient()).listKeys(projectId, total)),
+      async ({ projectId, queries, total }) =>
+        parse(await (await getProjectsClient()).listKeys(projectId, queries, total)),
     ),
   );
 
@@ -369,11 +370,12 @@ projects
   .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
   .requiredOption(`--name <name>`, `Key name. Max length: 128 chars.`)
   .requiredOption(`--scopes [scopes...]`, `Key scopes list. Maximum of 100 scopes are allowed.`)
+  .option(`--key-id <key-id>`, `Key ID. Choose a custom ID or generate a random ID with \`ID.unique()\`. 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.`)
   .option(`--expire <expire>`, `Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.`)
   .action(
     actionRunner(
-      async ({ projectId, name, scopes, expire }) =>
-        parse(await (await getProjectsClient()).createKey(projectId, name, scopes, expire)),
+      async ({ projectId, name, scopes, keyId, expire }) =>
+        parse(await (await getProjectsClient()).createKey(projectId, name, scopes, keyId, expire)),
     ),
   );
 
@@ -521,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. `)

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

@@ -639,10 +639,16 @@ tablesDB
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, tableId, key, required, xdefault, array }) =>
-        parse(await (await getTablesDBClient()).createLongtextColumn(databaseId, tableId, key, required, xdefault, array)),
+      async ({ databaseId, tableId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getTablesDBClient()).createLongtextColumn(databaseId, tableId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -678,10 +684,16 @@ tablesDB
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, tableId, key, required, xdefault, array }) =>
-        parse(await (await getTablesDBClient()).createMediumtextColumn(databaseId, tableId, key, required, xdefault, array)),
+      async ({ databaseId, tableId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getTablesDBClient()).createMediumtextColumn(databaseId, tableId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -850,10 +862,16 @@ tablesDB
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, tableId, key, required, xdefault, array }) =>
-        parse(await (await getTablesDBClient()).createTextColumn(databaseId, tableId, key, required, xdefault, array)),
+      async ({ databaseId, tableId, key, required, xdefault, array, encrypt }) =>
+        parse(await (await getTablesDBClient()).createTextColumn(databaseId, tableId, key, required, xdefault, array, encrypt)),
     ),
   );
 
@@ -929,10 +947,16 @@ tablesDB
     (value: string | undefined) =>
       value === undefined ? true : parseBool(value),
   )
+  .option(
+    `--encrypt [value]`,
+    `Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.`,
+    (value: string | undefined) =>
+      value === undefined ? true : parseBool(value),
+  )
   .action(
     actionRunner(
-      async ({ databaseId, tableId, key, size, required, xdefault, array }) =>
-        parse(await (await getTablesDBClient()).createVarcharColumn(databaseId, tableId, key, size, required, xdefault, array)),
+      async ({ databaseId, tableId, key, size, required, xdefault, array, encrypt }) =>
+        parse(await (await getTablesDBClient()).createVarcharColumn(databaseId, tableId, key, size, required, xdefault, array, encrypt)),
     ),
   );
 

package/lib/commands/utils/attributes.ts

@@ -4,6 +4,7 @@ import { KeysAttributes } from "../../config.js";
 import { log, success, error, cliConfig, drawTable } from "../../parser.js";
 import { Pools } from "./pools.js";
 import inquirer from "inquirer";
+import type { Client } from "@appwrite.io/console";
 
 const changeableKeys = [
   "status",
@@ -53,9 +54,11 @@ const questionPushChangesConfirmation = [
 export class Attributes {
   private pools: Pools;
   private skipConfirmation: boolean;
+  private client?: Client;
 
-  constructor(pools?: Pools, skipConfirmation = false) {
-    this.pools = pools || new Pools();
+  constructor(pools?: Pools, skipConfirmation = false, client?: Client) {
+    this.client = client;
+    this.pools = pools || new Pools(undefined, client);
     this.skipConfirmation = skipConfirmation;
   }
 
@@ -197,7 +200,7 @@ export class Attributes {
     collectionId: string,
     attribute: any,
   ): Promise<any> => {
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     switch (attribute.type) {
       case "string":
         switch (attribute.format) {
@@ -373,7 +376,7 @@ export class Attributes {
     collectionId: string,
     attribute: any,
   ): Promise<any> => {
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     switch (attribute.type) {
       case "string":
         switch (attribute.format) {
@@ -533,7 +536,7 @@ export class Attributes {
       `Deleting ${isIndex ? "index" : "attribute"} ${attribute.key} of ${collection.name} ( ${collection["$id"]} )`,
     );
 
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     if (isIndex) {
       await databasesService.deleteIndex(
         collection["databaseId"],
@@ -733,7 +736,7 @@ export class Attributes {
   ): Promise<void> => {
     log(`Creating indexes ...`);
 
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     for (let index of indexes) {
       await databasesService.createIndex({
         databaseId: collection["databaseId"],

package/lib/commands/utils/pools.ts

@@ -1,14 +1,17 @@
 import { getDatabasesService } from "../../services.js";
 import { paginate } from "../../paginate.js";
 import { log } from "../../parser.js";
+import type { Client } from "@appwrite.io/console";
 
 export class Pools {
   private STEP_SIZE = 100; // Resources
   private POLL_DEBOUNCE = 2000; // Milliseconds
   private pollMaxDebounces = 30;
   private POLL_DEFAULT_VALUE = 30;
+  private client?: Client;
 
-  constructor(pollMaxDebounces?: number) {
+  constructor(pollMaxDebounces?: number, client?: Client) {
+    this.client = client;
     if (pollMaxDebounces) {
       this.pollMaxDebounces = pollMaxDebounces;
     }
@@ -23,7 +26,7 @@ export class Pools {
       return false;
     }
 
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     const response = await databasesService.listAttributes(
       databaseId,
       collectionId,
@@ -62,7 +65,7 @@ export class Pools {
       return false;
     }
 
-    const databasesService = await getDatabasesService();
+    const databasesService = await getDatabasesService(this.client);
     const response = await databasesService.listIndexes(
       databaseId,
       collectionId,
@@ -117,7 +120,7 @@ export class Pools {
 
     const { attributes } = await paginate(
       async (args: any) => {
-        const databasesService = await getDatabasesService();
+        const databasesService = await getDatabasesService(this.client);
         return await databasesService.listAttributes({
           databaseId: args.databaseId,
           collectionId: args.collectionId,
@@ -175,7 +178,7 @@ export class Pools {
 
     const { attributes } = await paginate(
       async (args: any) => {
-        const databasesService = await getDatabasesService();
+        const databasesService = await getDatabasesService(this.client);
         return await databasesService.listAttributes(
           args.databaseId,
           args.collectionId,
@@ -243,7 +246,7 @@ export class Pools {
 
     const { indexes } = await paginate(
       async (args: any) => {
-        const databasesService = await getDatabasesService();
+        const databasesService = await getDatabasesService(this.client);
         return await databasesService.listIndexes(
           args.databaseId,
           args.collectionId,

package/lib/constants.ts

@@ -1,7 +1,7 @@
 // SDK
 export const SDK_TITLE = 'Appwrite';
 export const SDK_TITLE_LOWER = 'appwrite';
-export const SDK_VERSION = '13.3.2';
+export const SDK_VERSION = '13.5.0';
 export const SDK_NAME = 'Command Line';
 export const SDK_PLATFORM = 'console';
 export const SDK_LANGUAGE = 'cli';

package/lib/json.ts

@@ -1,5 +1,4 @@
 import JSONbigModule from "json-bigint";
-import { BigNumber } from "bignumber.js";
 
 const JSONbigParser = JSONbigModule({ storeAsString: false });
 const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
@@ -7,8 +6,19 @@ const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
 const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
 const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
 
+function isBigNumber(value: any): boolean {
+  return (
+    value !== null &&
+    typeof value === "object" &&
+    value._isBigNumber === true &&
+    typeof value.isInteger === "function" &&
+    typeof value.toFixed === "function" &&
+    typeof value.toNumber === "function"
+  );
+}
+
 function reviver(_key: string, value: any): any {
-  if (BigNumber.isBigNumber(value)) {
+  if (isBigNumber(value)) {
     if (value.isInteger()) {
       const str = value.toFixed();
       const bi = BigInt(str);

package/lib/utils.ts

@@ -160,6 +160,21 @@ export function isCloud(): boolean {
   return hostname.endsWith("appwrite.io");
 }
 
+export function arrayEqualsUnordered(left: unknown, right: unknown): boolean {
+  const a = Array.isArray(left)
+    ? [...left].map((item) => String(item)).sort()
+    : [];
+  const b = Array.isArray(right)
+    ? [...right].map((item) => String(item)).sort()
+    : [];
+
+  if (a.length !== b.length) {
+    return false;
+  }
+
+  return a.every((value, index) => value === b[index]);
+}
+
 /**
  * Filters an object to only include fields defined in a Zod object schema.
  * Uses the schema's shape to determine allowed keys.

package/package.json

@@ -3,10 +3,23 @@
   "type": "module",
   "homepage": "https://appwrite.io/support",
   "description": "Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API",
-  "version": "13.3.2",
+  "version": "13.5.0",
   "license": "BSD-3-Clause",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
   "bin": {
     "appwrite": "dist/cli.cjs"
   },
@@ -17,8 +30,9 @@
   "scripts": {
     "build": "npm run build:types && npm run build:runtime",
     "build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
-    "build:runtime": "npm run build:lib:runtime && npm run build:cli",
-    "build:lib:runtime": "esbuild index.ts --bundle --platform=node --target=node18 --format=esm --loader:.hbs=text --outfile=dist/index.js",
+    "build:runtime": "npm run build:lib:esm && npm run build:lib:cjs && npm run build:cli",
+    "build:lib:esm": "esbuild index.ts --bundle --platform=node --target=node18 --format=esm --loader:.hbs=text --outfile=dist/index.js",
+    "build:lib:cjs": "esbuild index.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --outfile=dist/index.cjs",
     "build:cli": "esbuild cli.ts --bundle --platform=node --target=node18 --format=cjs --loader:.hbs=text --external:fsevents --outfile=dist/cli.cjs",
     "format": "prettier --write \"**/*.{js,ts,json,md}\"",
     "generate": "tsx scripts/generate-commands.ts",
@@ -32,8 +46,7 @@
     "windows-arm64": "esbuild cli.ts --bundle --loader:.hbs=text --platform=node --target=node18 --format=esm --external:fsevents --outfile=dist/bundle-win-arm64.mjs && pkg dist/bundle-win-arm64.mjs -t node18-win-arm64 -o build/appwrite-cli-win-arm64.exe"
   },
   "dependencies": {
-    "@appwrite.io/console": "^2.2.0",
-    "bignumber.js": "^9.0.0",
+    "@appwrite.io/console": "^3.0.0",
     "chalk": "4.1.2",
     "chokidar": "^3.6.0",
     "cli-progress": "^3.12.0",

package/scoop/appwrite.config.json

@@ -1,12 +1,12 @@
 {
 	"$schema": "https://raw.githubusercontent.com/ScoopInstaller/Scoop/master/schema.json",
-	"version": "13.3.2",
+	"version": "13.5.0",
 	"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/13.3.2/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/13.5.0/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/13.3.2/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/13.5.0/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",