schema validation

Author: ChiragAgg5k

index.ts

@@ -46,6 +46,9 @@ import { tokens } from "./lib/commands/services/tokens.js";
 import { users } from "./lib/commands/services/users.js";
 import { vcs } from "./lib/commands/services/vcs.js";
 import searchList from "inquirer-search-list";
+import { Push } from "./lib/commands/push.js";
+import { Pull } from "./lib/commands/pull.js";
+import { Schema } from "./lib/commands/schema.js";
 
 inquirer.registerPrompt("search-list", searchList);
 
@@ -166,3 +169,5 @@ if (process.argv.includes("-v") || process.argv.includes("--version")) {
 
   process.stdout.columns = oldWidth;
 }
+
+export { Schema, Push, Pull };

lib/commands/push.ts

@@ -75,8 +75,18 @@ import { checkAndApplyTablesDBChanges } from "./utils/database-sync.js";
 const POLL_DEBOUNCE = 2000; // Milliseconds
 const POLL_DEFAULT_VALUE = 30;
 
-interface PushResourcesOptions {
+export interface PushOptions {
   skipDeprecated?: boolean;
+  functionOptions?: {
+    async?: boolean;
+    code?: boolean;
+    withVariables?: boolean;
+  };
+  siteOptions?: {
+    async?: boolean;
+    code?: boolean;
+    withVariables?: boolean;
+  };
 }
 
 interface PushSiteOptions {
@@ -108,20 +118,7 @@ export class Push {
 
   public async pushResources(
     config: ConfigType,
-    options: {
-      skipDeprecated?: boolean;
-      functionOptions?: {
-        async?: boolean;
-        code?: boolean;
-        withVariables?: boolean;
-      };
-      siteOptions?: {
-        async?: boolean;
-        code?: boolean;
-        withVariables?: boolean;
-      };
-      attempts?: number;
-    } = { skipDeprecated: true },
+    options: PushOptions = { skipDeprecated: true },
   ): Promise<{
     results: Record<string, any>;
     errors: any[];
@@ -228,7 +225,7 @@ export class Push {
     if (config.tables && config.tables.length > 0) {
       try {
         log("Pushing tables ...");
-        const result = await this.pushTables(config.tables, options.attempts);
+        const result = await this.pushTables(config.tables);
         results.tables = result;
         allErrors.push(...result.errors);
       } catch (e: any) {
@@ -257,10 +254,7 @@ export class Push {
             };
           },
         );
-        const result = await this.pushCollections(
-          collectionsWithDbNames,
-          options.attempts,
-        );
+        const result = await this.pushCollections(collectionsWithDbNames);
         results.collections = result;
         allErrors.push(...result.errors);
       } catch (e: any) {
@@ -1275,14 +1269,11 @@ export class Push {
     };
   }
 
-  public async pushCollections(
-    collections: any[],
-    attempts?: number,
-  ): Promise<{
+  public async pushCollections(collections: any[]): Promise<{
     successfullyPushed: number;
     errors: any[];
   }> {
-    const pools = new Pools(attempts ?? POLL_DEFAULT_VALUE);
+    const pools = new Pools(POLL_DEFAULT_VALUE);
     const attributes = new Attributes(pools);
 
     const errors: any[] = [];
@@ -1438,7 +1429,9 @@ async function createPushInstance(): Promise<Push> {
 
 const pushResources = async ({
   skipDeprecated = false,
-}: PushResourcesOptions = {}): Promise<void> => {
+}: {
+  skipDeprecated?: boolean;
+} = {}): Promise<void> => {
   if (cliConfig.all) {
     checkDeployConditions(localConfig);
 
@@ -1966,9 +1959,7 @@ const pushTable = async ({
   }
 };
 
-const pushCollection = async ({
-  attempts,
-}: PushTableOptions = {}): Promise<void> => {
+const pushCollection = async ({}: PushTableOptions = {}): Promise<void> => {
   warn(
     "appwrite push collection has been deprecated. Please consider using 'appwrite push tables' instead",
   );
@@ -2029,7 +2020,7 @@ const pushCollection = async ({
   log("Pushing collections ...");
 
   const pushInstance = await createPushInstance();
-  const result = await pushInstance.pushCollections(collections, attempts);
+  const result = await pushInstance.pushCollections(collections);
 
   const { successfullyPushed, errors } = result;
 

lib/commands/schema.ts

@@ -0,0 +1,100 @@
+import { Client } from "@appwrite.io/console";
+import type { ConfigType } from "./config.js";
+import { ConfigSchema } from "./config.js";
+import { Pull, PullOptions } from "./pull.js";
+import { Push, PushOptions } from "./push.js";
+import { parseWithBetterErrors } from "./utils/error-formatter.js";
+import JSONbig from "json-bigint";
+import * as fs from "fs";
+
+const JSONBig = JSONbig({ storeAsString: false });
+
+export class Schema {
+  private pullCommand: Pull;
+  private pushCommand: Push;
+
+  constructor({
+    projectClient,
+    consoleClient,
+  }: {
+    projectClient: Client;
+    consoleClient: Client;
+  }) {
+    this.pullCommand = new Pull(projectClient, consoleClient);
+    this.pushCommand = new Push(projectClient, consoleClient);
+  }
+
+  /**
+   * Validates the provided configuration object against the schema.
+   *
+   * @param config - The configuration object to validate.
+   * @returns The validated and possibly transformed configuration object.
+   * @throws If the configuration does not match the schema.
+   */
+  public validate(config: ConfigType): ConfigType {
+    return parseWithBetterErrors<ConfigType>(
+      ConfigSchema,
+      config,
+      "Configuration schema validation",
+      config,
+    );
+  }
+
+  /**
+   * Pulls the current schema and resources from the remote Appwrite project.
+   *
+   * @param config - The local configuration object.
+   * @param options - Optional settings for the pull operation.
+   * @returns A Promise that resolves to the updated configuration object reflecting the remote state.
+   */
+  public async pull(
+    config: ConfigType,
+    options: PullOptions = { all: true },
+  ): Promise<ConfigType> {
+    return await this.pullCommand.pullResources(config, options);
+  }
+
+  /**
+   * Pushes the local configuration and schema to the remote Appwrite project.
+   * Optionally syncs the config file by pulling the updated state from the server after push.
+   *
+   * @param config - The local configuration object to push.
+   * @param options - Optional settings for the push operation. Use `force: true` to allow destructive changes.
+   * @param configPath - Optional path to the config file. If provided, the config will be synced after push.
+   * @returns A Promise that resolves when the push operation is complete.
+   * @throws {DestructiveChangeError} When destructive changes are detected and force is not enabled.
+   */
+  public async push(
+    config: ConfigType,
+    options: PushOptions,
+    configPath?: string,
+  ): Promise<void> {
+    await this.pushCommand.pushResources(config, options);
+
+    if (configPath) {
+      const updatedConfig = await this.pullCommand.pullResources(config);
+      this.write(updatedConfig, configPath);
+    }
+  }
+
+  /**
+   * Reads the configuration object from a file.
+   *
+   * @param path - The path to the file to read.
+   * @returns The configuration object.
+   */
+  public read(path: string): ConfigType {
+    return JSONBig.parse(fs.readFileSync(path, "utf8")) as ConfigType;
+  }
+
+  /**
+   * Writes the configuration object to a file.
+   *
+   * @param config - The configuration object to write.
+   * @param path - The path to the file to write.
+   * @returns void
+   */
+  public write(config: ConfigType, path: string): void {
+    fs.writeFileSync(path, JSONBig.stringify(config, null, 4));
+  }
+}