appwrite-cli 13.0.0 → 13.1.0-rc.1

package/lib/config.ts

@@ -2,8 +2,8 @@ import os from "os";
 import fs from "fs";
 import _path from "path";
 import process from "process";
-import JSONbig from "json-bigint";
 import type { Models } from "@appwrite.io/console";
+import type { z } from "zod";
 import type {
   BucketType,
   CollectionType,
@@ -15,6 +15,20 @@ import type {
   TeamType,
   TopicType,
 } from "./commands/config.js";
+import {
+  SiteSchema,
+  FunctionSchema,
+  DatabaseSchema,
+  CollectionSchema,
+  AttributeSchema,
+  IndexSchema,
+  TableSchema,
+  ColumnSchema,
+  IndexTableSchema,
+  TopicSchema,
+  TeamSchema,
+  BucketSchema,
+} from "./commands/config.js";
 import type {
   SessionData,
   ConfigData,
@@ -22,142 +36,38 @@ import type {
   GlobalConfigData,
 } from "./types.js";
 import { createSettingsObject } from "./utils.js";
-import { SDK_TITLE_LOWER } from "./constants.js";
-
-const JSONBigInt = JSONbig({ useNativeBigInt: true });
+import { EXECUTABLE_NAME } from "./constants.js";
+import { JSONBig } from "./json.js";
+
+/**
+ * Extract keys from a Zod object schema.
+ * Handles both plain ZodObject and ZodEffects (schemas with refinements).
+ */
+function getSchemaKeys(schema: z.ZodTypeAny): Set<string> {
+  // For ZodEffects (created by .refine(), .superRefine(), .transform())
+  if ("def" in schema && "schema" in (schema.def as any)) {
+    return getSchemaKeys((schema.def as any).schema);
+  }
+  // For ZodObject
+  if ("shape" in schema) {
+    return new Set(Object.keys((schema as any).shape));
+  }
+  return new Set();
+}
 
 const KeysVars = new Set(["key", "value"]);
-const KeysSite = new Set([
-  "path",
-  "$id",
-  "name",
-  "enabled",
-  "logging",
-  "timeout",
-  "framework",
-  "buildRuntime",
-  "adapter",
-  "installCommand",
-  "buildCommand",
-  "outputDirectory",
-  "fallbackFile",
-  "specification",
-  "vars",
-]);
-const KeysFunction = new Set([
-  "path",
-  "$id",
-  "execute",
-  "name",
-  "enabled",
-  "logging",
-  "runtime",
-  "specification",
-  "scopes",
-  "events",
-  "schedule",
-  "timeout",
-  "entrypoint",
-  "commands",
-  "vars",
-]);
-const KeysDatabase = new Set(["$id", "name", "enabled"]);
-const KeysCollection = new Set([
-  "$id",
-  "$permissions",
-  "databaseId",
-  "name",
-  "enabled",
-  "documentSecurity",
-  "attributes",
-  "indexes",
-]);
-const KeysTable = new Set([
-  "$id",
-  "$permissions",
-  "databaseId",
-  "name",
-  "enabled",
-  "rowSecurity",
-  "columns",
-  "indexes",
-]);
-const KeysStorage = new Set([
-  "$id",
-  "$permissions",
-  "fileSecurity",
-  "name",
-  "enabled",
-  "maximumFileSize",
-  "allowedFileExtensions",
-  "compression",
-  "encryption",
-  "antivirus",
-]);
-const KeysTopics = new Set(["$id", "name", "subscribe"]);
-const KeysTeams = new Set(["$id", "name"]);
-const KeysAttributes = new Set([
-  "key",
-  "type",
-  "required",
-  "array",
-  "size",
-  "default",
-  // integer and float
-  "min",
-  "max",
-  // email, enum, URL, IP, and datetime
-  "format",
-  // enum
-  "elements",
-  // relationship
-  "relatedCollection",
-  "relationType",
-  "twoWay",
-  "twoWayKey",
-  "onDelete",
-  "side",
-  // Indexes
-  "attributes",
-  "orders",
-  // Strings
-  "encrypt",
-]);
-const KeysColumns = new Set([
-  "key",
-  "type",
-  "required",
-  "array",
-  "size",
-  "default",
-  // integer and float
-  "min",
-  "max",
-  // email, enum, URL, IP, and datetime
-  "format",
-  // enum
-  "elements",
-  // relationship
-  "relatedTable",
-  "relationType",
-  "twoWay",
-  "twoWayKey",
-  "onDelete",
-  "side",
-  // Indexes
-  "columns",
-  "orders",
-  // Strings
-  "encrypt",
-]);
-const KeyIndexes = new Set(["key", "type", "status", "attributes", "orders"]);
-const KeyIndexesColumns = new Set([
-  "key",
-  "type",
-  "status",
-  "columns",
-  "orders",
-]);
+const KeysSite = getSchemaKeys(SiteSchema);
+const KeysFunction = getSchemaKeys(FunctionSchema);
+const KeysDatabase = getSchemaKeys(DatabaseSchema);
+const KeysCollection = getSchemaKeys(CollectionSchema);
+const KeysTable = getSchemaKeys(TableSchema);
+const KeysStorage = getSchemaKeys(BucketSchema);
+const KeysTopics = getSchemaKeys(TopicSchema);
+const KeysTeams = getSchemaKeys(TeamSchema);
+const KeysAttributes = getSchemaKeys(AttributeSchema);
+const KeysColumns = getSchemaKeys(ColumnSchema);
+const KeyIndexes = getSchemaKeys(IndexSchema);
+const KeyIndexesColumns = getSchemaKeys(IndexTableSchema);
 
 const CONFIG_KEY_ORDER = [
   "projectId",
@@ -235,7 +145,7 @@ class Config<T extends ConfigData = ConfigData> {
   read(): void {
     try {
       const file = fs.readFileSync(this.path).toString();
-      this.data = JSONBigInt.parse(file);
+      this.data = JSONBig.parse(file);
     } catch (e) {
       this.data = {} as T;
     }
@@ -246,7 +156,7 @@ class Config<T extends ConfigData = ConfigData> {
     if (!fs.existsSync(dir)) {
       fs.mkdirSync(dir, { recursive: true });
     }
-    fs.writeFileSync(this.path, JSONBigInt.stringify(this.data, null, 4), {
+    fs.writeFileSync(this.path, JSONBig.stringify(this.data, null, 4), {
       mode: 0o600,
     });
   }
@@ -285,7 +195,7 @@ class Config<T extends ConfigData = ConfigData> {
   }
 
   toString(): string {
-    return JSONBigInt.stringify(this.data, null, 4);
+    return JSONBig.stringify(this.data, null, 4);
   }
 
   protected _getDBEntities(entityType: string): Entity[] {
@@ -342,8 +252,8 @@ class Config<T extends ConfigData = ConfigData> {
 }
 
 class Local extends Config<ConfigType> {
-  static CONFIG_FILE_PATH = `${SDK_TITLE_LOWER}.config.json`;
-  static CONFIG_FILE_PATH_LEGACY = `${SDK_TITLE_LOWER}.json`;
+  static CONFIG_FILE_PATH = `${EXECUTABLE_NAME}.config.json`;
+  static CONFIG_FILE_PATH_LEGACY = `${EXECUTABLE_NAME}.json`;
   configDirectoryPath = "";
 
   constructor(
@@ -367,7 +277,7 @@ class Local extends Config<ConfigType> {
       fs.mkdirSync(dir, { recursive: true });
     }
     const orderedData = orderConfigKeys(this.data);
-    fs.writeFileSync(this.path, JSONBigInt.stringify(orderedData, null, 4), {
+    fs.writeFileSync(this.path, JSONBig.stringify(orderedData, null, 4), {
       mode: 0o600,
     });
   }
@@ -774,7 +684,7 @@ class Local extends Config<ConfigType> {
 }
 
 class Global extends Config<GlobalConfigData> {
-  static CONFIG_FILE_PATH = `.${SDK_TITLE_LOWER}/prefs.json`;
+  static CONFIG_FILE_PATH = `.${EXECUTABLE_NAME}/prefs.json`;
 
   static PREFERENCE_CURRENT = "current" as const;
   static PREFERENCE_ENDPOINT = "endpoint" as const;

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.0.0';
+export const SDK_VERSION = '13.1.0-rc.1';
 export const SDK_NAME = 'Command Line';
 export const SDK_PLATFORM = 'console';
 export const SDK_LANGUAGE = 'cli';

package/lib/json.ts

@@ -0,0 +1,28 @@
+import JSONbigModule from "json-bigint";
+import { BigNumber } from "bignumber.js";
+
+const JSONbigParser = JSONbigModule({ storeAsString: false });
+const JSONbigSerializer = JSONbigModule({ useNativeBigInt: true });
+
+const MAX_SAFE = BigInt(Number.MAX_SAFE_INTEGER);
+const MIN_SAFE = BigInt(Number.MIN_SAFE_INTEGER);
+
+function reviver(_key: string, value: any): any {
+  if (BigNumber.isBigNumber(value)) {
+    if (value.isInteger()) {
+      const str = value.toFixed();
+      const bi = BigInt(str);
+      if (bi >= MIN_SAFE && bi <= MAX_SAFE) {
+        return Number(str);
+      }
+      return bi;
+    }
+    return value.toNumber();
+  }
+  return value;
+}
+
+export const JSONBig = {
+  parse: (text: string) => JSONbigParser.parse(text, reviver),
+  stringify: JSONbigSerializer.stringify,
+};

package/lib/utils.ts

@@ -5,6 +5,7 @@ import childProcess from "child_process";
 import chalk from "chalk";
 import { fetch } from "undici";
 import type { Models } from "@appwrite.io/console";
+import { z } from "zod";
 import { localConfig, globalConfig } from "./config.js";
 import type { SettingsType } from "./commands/config.js";
 import { NPM_REGISTRY_URL, DEFAULT_ENDPOINT } from "./constants.js";
@@ -154,240 +155,64 @@ export const checkDeployConditions = (localConfig: any): void => {
   }
 };
 
-export function showConsoleLink(
-  serviceName: string,
-  action: string,
-  ...ids: string[]
-): void {
-  const projectId = localConfig.getProject().projectId;
-
-  const url = new URL(globalConfig.getEndpoint().replace("/v1", "/console"));
-  url.pathname += `/project-${projectId}`;
-  action = action.toLowerCase();
-
-  switch (serviceName) {
-    case "account":
-      url.pathname = url.pathname.replace(`/project-${projectId}`, "");
-      url.pathname += getAccountPath(action);
-      break;
-    case "databases":
-      url.pathname += getDatabasePath(action, ids);
-      break;
-    case "functions":
-      url.pathname += getFunctionsPath(action, ids);
-      break;
-    case "messaging":
-      url.pathname += getMessagingPath(action, ids);
-      break;
-    case "projects":
-      url.pathname = url.pathname.replace(`/project-${projectId}`, "");
-      url.pathname += getProjectsPath(action, ids);
-      break;
-    case "storage":
-      url.pathname += getBucketsPath(action, ids);
-      break;
-    case "teams":
-      url.pathname += getTeamsPath(action, ids);
-      break;
-    case "organizations":
-      url.pathname += getOrganizationsPath(action, ids);
-      break;
-    case "users":
-      url.pathname += getUsersPath(action, ids);
-      break;
-    default:
-      return;
-  }
-
-  console.log(
-    `${chalk.green.bold("✓ Success:")} ${chalk.green(url.toString())}`,
-  );
-}
-
-function getAccountPath(action: string): string {
-  let path = "/account";
-
-  if (action === "listsessions") {
-    path += "/sessions";
-  }
-
-  return path;
-}
-
-function getDatabasePath(action: string, ids: string[]): string {
-  let path = "/databases";
-
-  if (
-    [
-      "get",
-      "listcollections",
-      "getcollection",
-      "listattributes",
-      "listdocuments",
-      "getdocument",
-      "listindexes",
-      "getdatabaseusage",
-    ].includes(action)
-  ) {
-    path += `/database-${ids[0]}`;
-  }
-
-  if (action === "getdatabaseusage") {
-    path += `/usage`;
-  }
-
-  if (
-    [
-      "getcollection",
-      "listattributes",
-      "listdocuments",
-      "getdocument",
-      "listindexes",
-    ].includes(action)
-  ) {
-    path += `/collection-${ids[1]}`;
-  }
-
-  if (action === "listattributes") {
-    path += "/attributes";
-  }
-  if (action === "listindexes") {
-    path += "/indexes";
-  }
-  if (action === "getdocument") {
-    path += `/document-${ids[2]}`;
-  }
-
-  return path;
-}
-
-function getFunctionsPath(action: string, ids: string[]): string {
-  let path = "/functions";
-
-  if (action !== "list") {
-    path += `/function-${ids[0]}`;
-  }
-
-  if (action === "getdeployment") {
-    path += `/deployment-${ids[1]}`;
-  }
-
-  if (action === "getexecution" || action === "listexecution") {
-    path += `/executions`;
-  }
-  if (action === "getfunctionusage") {
-    path += `/usage`;
-  }
-
-  return path;
-}
-
-function getMessagingPath(action: string, ids: string[]): string {
-  let path = "/messaging";
-
-  if (["getmessage", "listmessagelogs"].includes(action)) {
-    path += `/message-${ids[0]}`;
-  }
-
-  if (["listproviders", "getprovider"].includes(action)) {
-    path += `/providers`;
-  }
-
-  if (action === "getprovider") {
-    path += `/provider-${ids[0]}`;
-  }
-
-  if (["listtopics", "gettopic"].includes(action)) {
-    path += `/topics`;
-  }
-
-  if (action === "gettopic") {
-    path += `/topic-${ids[0]}`;
-  }
-
-  return path;
-}
-
-function getProjectsPath(action: string, ids: string[]): string {
-  let path = "";
-
-  if (action !== "list") {
-    path += `/project-${ids[0]}`;
-  }
-
-  if (["listkeys", "getkey"].includes(action)) {
-    path += "/overview/keys";
-  }
-
-  if (["listplatforms", "getplatform"].includes(action)) {
-    path += "/overview/platforms";
-  }
-
-  if (["listwebhooks", "getwebhook"].includes(action)) {
-    path += "/settings/webhooks";
-  }
-
-  if (["getplatform", "getkey", "getwebhook"].includes(action)) {
-    path += `/${ids[1]}`;
-  }
-
-  return path;
+export function isCloud(): boolean {
+  const endpoint = globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
+  const hostname = new URL(endpoint).hostname;
+  return hostname.endsWith("appwrite.io");
 }
 
-function getBucketsPath(action: string, ids: string[]): string {
-  let path = "/storage";
-
-  if (action !== "listbuckets") {
-    path += `/bucket-${ids[0]}`;
-  }
-
-  if (action === "getbucketusage") {
-    path += `/usage`;
-  }
-
-  if (action === "getfile") {
-    path += `/file-${ids[1]}`;
+/**
+ * Filters an object to only include fields defined in a Zod object schema.
+ * Uses the schema's shape to determine allowed keys.
+ *
+ * @param data - The data to filter
+ * @param schema - A Zod object schema with a shape property
+ * @returns The filtered data with only schema-defined fields
+ */
+export function filterBySchema<T extends z.ZodObject<z.ZodRawShape>>(
+  data: Record<string, unknown>,
+  schema: T,
+): z.infer<T> {
+  const allowedKeys = Object.keys(schema.shape);
+  const result: Record<string, unknown> = {};
+
+  for (const key of allowedKeys) {
+    if (key in data) {
+      result[key] = data[key];
+    }
   }
 
-  return path;
+  return result as z.infer<T>;
 }
 
-function getTeamsPath(action: string, ids: string[]): string {
-  let path = "/auth/teams";
-
-  if (action !== "list") {
-    path += `/team-${ids[0]}`;
-  }
-
-  return path;
+export function toPascalCase(str: string): string {
+  return str
+    .replace(/[-_\s]+(.)?/g, (_, char) => (char ? char.toUpperCase() : ""))
+    .replace(/^(.)/, (char) => char.toUpperCase());
 }
 
-function getOrganizationsPath(action: string, ids: string[]): string {
-  let path = `/organization-${ids[0]}`;
-
-  if (action === "list") {
-    path = "/account/organizations";
-  }
-
-  return path;
+export function toUpperSnakeCase(str: string): string {
+  return str
+    .replace(/([a-z])([A-Z])/g, "$1_$2")
+    .replace(/[-\s]+/g, "_")
+    .toUpperCase();
 }
 
-function getUsersPath(action: string, ids: string[]): string {
-  let path = "/auth";
+export function sanitizeEnumKey(key: string): string {
+  let sanitized = toUpperSnakeCase(key)
+    .replace(/[^A-Z0-9_]/gi, "_") // Replace non-alphanumeric with underscores
+    .replace(/_+/g, "_") // Collapse consecutive underscores
+    .replace(/^_+|_+$/g, ""); // Trim leading/trailing underscores
 
-  if (action !== "list") {
-    path += `/user-${ids[0]}`;
+  // Prefix with underscore if starts with a digit
+  if (/^[0-9]/.test(sanitized)) {
+    sanitized = "_" + sanitized;
   }
 
-  if (action === "listsessions") {
-    path += "sessions";
+  // Fallback if empty after sanitization
+  if (!sanitized) {
+    sanitized = "_VALUE";
   }
 
-  return path;
-}
-
-export function isCloud(): boolean {
-  const endpoint = globalConfig.getEndpoint() || DEFAULT_ENDPOINT;
-  const hostname = new URL(endpoint).hostname;
-  return hostname.endsWith("appwrite.io");
+  return sanitized;
 }

package/package.json

@@ -3,7 +3,7 @@
   "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.0.0",
+  "version": "13.1.0-rc.1",
   "license": "BSD-3-Clause",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -28,7 +28,8 @@
     "windows-arm64": "bun run build && esbuild dist/cli.js --bundle --platform=node --format=cjs --outfile=dist/bundle.cjs --external:@appwrite.io/console --external:fsevents && pkg dist/bundle.cjs -t node18-win-arm64 -o build/appwrite-cli-win-arm64.exe"
   },
   "dependencies": {
-    "@appwrite.io/console": "^2.1.0",
+    "@appwrite.io/console": "^2.1.3",
+    "bignumber.js": "^9.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.0.0",
+	"version": "13.1.0-rc.1",
 	"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.0.0/appwrite-cli-win-x64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/13.1.0-rc.1/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.0.0/appwrite-cli-win-arm64.exe",
+			"url": "https://github.com/appwrite/sdk-for-cli/releases/download/13.1.0-rc.1/appwrite-cli-win-arm64.exe",
 			"bin": [
 				[
 					"appwrite-cli-win-arm64.exe",

package/dist/lib/commands/db.d.ts

@@ -1,34 +0,0 @@
-import { ConfigType } from "./config.js";
-export interface GenerateOptions {
-    strict?: boolean;
-}
-export interface GenerateResult {
-    dbContent: string;
-    typesContent: string;
-}
-export declare class Db {
-    private getType;
-    private toPascalCase;
-    private toCamelCase;
-    private toUpperSnakeCase;
-    private generateCollectionType;
-    private generateEnums;
-    private generateTypesFile;
-    private getAppwriteDependency;
-    private generateDbFile;
-    /**
-     * Generates TypeScript code for Appwrite database collections and types based on the provided configuration.
-     *
-     * This method returns generated content as strings:
-     *   1. A types string containing TypeScript interfaces for each collection.
-     *   2. A database client string with helper methods for CRUD operations on each collection.
-     *
-     * @param config - The Appwrite project configuration, including collections and project details.
-     * @param options - Optional settings for code generation:
-     *   - strict: Whether to use strict naming conventions for collections (default: false).
-     * @returns A Promise that resolves with an object containing dbContent and typesContent strings.
-     * @throws If the configuration is missing a projectId or contains no collections.
-     */
-    generate(config: ConfigType, options?: GenerateOptions): Promise<GenerateResult>;
-}
-//# sourceMappingURL=db.d.ts.map

package/dist/lib/commands/db.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"db.d.ts","sourceRoot":"","sources":["../../../lib/commands/db.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,aAAa,CAAC;AAK1D,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,EAAE;IACb,OAAO,CAAC,OAAO;IA0Df,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,WAAW;IAMnB,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,sBAAsB;IAqB9B,OAAO,CAAC,aAAa;IA2BrB,OAAO,CAAC,iBAAiB;IA6BzB,OAAO,CAAC,qBAAqB;IAyB7B,OAAO,CAAC,cAAc;IAqFtB;;;;;;;;;;;;OAYG;IACU,QAAQ,CACnB,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,cAAc,CAAC;CA4B3B"}