@zenstackhq/cli 3.0.0-alpha.2 → 3.0.0-alpha.20

package/dist/index.js

@@ -1,86 +1,13 @@
 var __defProp = Object.defineProperty;
-var __getOwnPropNames = Object.getOwnPropertyNames;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
-  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
-}) : x)(function(x) {
-  if (typeof require !== "undefined") return require.apply(this, arguments);
-  throw Error('Dynamic require of "' + x + '" is not supported');
-});
-var __commonJS = (cb, mod) => function __require2() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-};
-
-// package.json
-var require_package = __commonJS({
-  "package.json"(exports, module) {
-    module.exports = {
-      name: "@zenstackhq/cli",
-      publisher: "zenstack",
-      displayName: "ZenStack CLI",
-      description: "FullStack database toolkit with built-in access control and automatic API generation.",
-      version: "3.0.0-alpha.2",
-      type: "module",
-      author: {
-        name: "ZenStack Team"
-      },
-      homepage: "https://zenstack.dev",
-      license: "MIT",
-      keywords: [
-        "orm",
-        "fullstack",
-        "react",
-        "typescript",
-        "data modeling"
-      ],
-      bin: {
-        zenstack: "bin/cli"
-      },
-      scripts: {
-        build: "tsup-node",
-        watch: "tsup-node --watch",
-        lint: "eslint src --ext ts",
-        test: "vitest",
-        pack: "pnpm pack"
-      },
-      dependencies: {
-        "@types/node": "^20.0.0",
-        "@zenstackhq/language": "workspace:*",
-        "@zenstackhq/sdk": "workspace:*",
-        "async-exit-hook": "^2.0.1",
-        colors: "1.4.0",
-        commander: "^8.3.0",
-        langium: "~3.3.0",
-        ora: "^5.4.1",
-        "package-manager-detector": "^1.3.0",
-        "tiny-invariant": "^1.3.3",
-        "ts-pattern": "^4.3.0"
-      },
-      peerDependencies: {
-        prisma: "^6.0.0",
-        typescript: "^5.0.0"
-      },
-      devDependencies: {
-        "@types/async-exit-hook": "^2.0.0",
-        "@types/better-sqlite3": "^7.6.13",
-        "@types/semver": "^7.3.13",
-        "@types/tmp": "^0.2.6",
-        "@zenstackhq/runtime": "workspace:*",
-        "@zenstackhq/testtools": "workspace:*",
-        "better-sqlite3": "^11.8.1",
-        tmp: "^0.2.3"
-      }
-    };
-  }
-});
 
 // src/index.ts
 import { ZModelLanguageMetaData } from "@zenstackhq/language";
-import colors5 from "colors";
-import { Command, Option } from "commander";
+import colors6 from "colors";
+import { Command, CommanderError, Option } from "commander";
 
 // src/actions/db.ts
-import path2 from "node:path";
+import fs2 from "fs";
 
 // src/utils/exec-utils.ts
 import { execSync as _exec } from "child_process";
@@ -105,7 +32,12 @@ function execPackage(cmd, options) {
 __name(execPackage, "execPackage");
 
 // src/actions/action-utils.ts
-import fs from "node:fs";
+import { loadDocument } from "@zenstackhq/language";
+import { isDataSource } from "@zenstackhq/language/ast";
+import { PrismaSchemaGenerator } from "@zenstackhq/sdk";
+import colors from "colors";
+import fs from "fs";
+import path from "path";
 
 // src/cli-error.ts
 var CliError = class extends Error {
@@ -115,8 +47,6 @@ var CliError = class extends Error {
 };
 
 // src/actions/action-utils.ts
-import { loadDocument } from "@zenstackhq/language";
-import colors from "colors";
 function getSchemaFile(file) {
   if (file) {
     if (!fs.existsSync(file)) {
@@ -124,6 +54,13 @@ function getSchemaFile(file) {
     }
     return file;
   }
+  const pkgJsonConfig = getPkgJsonConfig(process.cwd());
+  if (pkgJsonConfig.schema) {
+    if (!fs.existsSync(pkgJsonConfig.schema)) {
+      throw new CliError(`Schema file not found: ${pkgJsonConfig.schema}`);
+    }
+    return pkgJsonConfig.schema;
+  }
   if (fs.existsSync("./zenstack/schema.zmodel")) {
     return "./zenstack/schema.zmodel";
   } else if (fs.existsSync("./schema.zmodel")) {
@@ -136,12 +73,14 @@ __name(getSchemaFile, "getSchemaFile");
 async function loadSchemaDocument(schemaFile) {
   const loadResult = await loadDocument(schemaFile);
   if (!loadResult.success) {
-    console.error(colors.red("Error loading schema:"));
     loadResult.errors.forEach((err) => {
       console.error(colors.red(err));
     });
-    throw new CliError("Failed to load schema");
+    throw new CliError("Schema contains errors. See above for details.");
   }
+  loadResult.warnings.forEach((warn) => {
+    console.warn(colors.yellow(warn));
+  });
   return loadResult.model;
 }
 __name(loadSchemaDocument, "loadSchemaDocument");
@@ -153,37 +92,149 @@ function handleSubProcessError(err) {
   }
 }
 __name(handleSubProcessError, "handleSubProcessError");
+async function generateTempPrismaSchema(zmodelPath, folder) {
+  const model = await loadSchemaDocument(zmodelPath);
+  if (!model.declarations.some(isDataSource)) {
+    throw new CliError("Schema must define a datasource");
+  }
+  const prismaSchema = await new PrismaSchemaGenerator(model).generate();
+  if (!folder) {
+    folder = path.dirname(zmodelPath);
+  }
+  const prismaSchemaFile = path.resolve(folder, "~schema.prisma");
+  fs.writeFileSync(prismaSchemaFile, prismaSchema);
+  return prismaSchemaFile;
+}
+__name(generateTempPrismaSchema, "generateTempPrismaSchema");
+function getPkgJsonConfig(startPath) {
+  const result = {
+    schema: void 0,
+    output: void 0
+  };
+  const pkgJsonFile = findUp([
+    "package.json"
+  ], startPath, false);
+  if (!pkgJsonFile) {
+    return result;
+  }
+  let pkgJson = void 0;
+  try {
+    pkgJson = JSON.parse(fs.readFileSync(pkgJsonFile, "utf8"));
+  } catch {
+    return result;
+  }
+  if (pkgJson.zenstack && typeof pkgJson.zenstack === "object") {
+    result.schema = pkgJson.zenstack.schema && path.resolve(path.dirname(pkgJsonFile), pkgJson.zenstack.schema);
+    result.output = pkgJson.zenstack.output && path.resolve(path.dirname(pkgJsonFile), pkgJson.zenstack.output);
+  }
+  return result;
+}
+__name(getPkgJsonConfig, "getPkgJsonConfig");
+function findUp(names, cwd = process.cwd(), multiple = false, result = []) {
+  if (!names.some((name) => !!name)) {
+    return void 0;
+  }
+  const target = names.find((name) => fs.existsSync(path.join(cwd, name)));
+  if (multiple === false && target) {
+    return path.join(cwd, target);
+  }
+  if (target) {
+    result.push(path.join(cwd, target));
+  }
+  const up = path.resolve(cwd, "..");
+  if (up === cwd) {
+    return multiple && result.length > 0 ? result : void 0;
+  }
+  return findUp(names, up, multiple, result);
+}
+__name(findUp, "findUp");
+
+// src/actions/db.ts
+async function run(command, options) {
+  switch (command) {
+    case "push":
+      await runPush(options);
+      break;
+  }
+}
+__name(run, "run");
+async function runPush(options) {
+  const schemaFile = getSchemaFile(options.schema);
+  const prismaSchemaFile = await generateTempPrismaSchema(schemaFile);
+  try {
+    const cmd = [
+      "prisma db push",
+      ` --schema "${prismaSchemaFile}"`,
+      options.acceptDataLoss ? " --accept-data-loss" : "",
+      options.forceReset ? " --force-reset" : "",
+      " --skip-generate"
+    ].join("");
+    try {
+      await execPackage(cmd);
+    } catch (err) {
+      handleSubProcessError(err);
+    }
+  } finally {
+    if (fs2.existsSync(prismaSchemaFile)) {
+      fs2.unlinkSync(prismaSchemaFile);
+    }
+  }
+}
+__name(runPush, "runPush");
 
 // src/actions/generate.ts
+import { invariant } from "@zenstackhq/common-helpers";
 import { isPlugin } from "@zenstackhq/language/ast";
-import { PrismaSchemaGenerator, TsSchemaGenerator } from "@zenstackhq/sdk";
+import { PrismaSchemaGenerator as PrismaSchemaGenerator2, TsSchemaGenerator } from "@zenstackhq/sdk";
 import colors2 from "colors";
-import fs2 from "node:fs";
-import path from "node:path";
-import invariant from "tiny-invariant";
-async function run(options) {
+import fs3 from "fs";
+import path2 from "path";
+async function run2(options) {
+  const start = Date.now();
   const schemaFile = getSchemaFile(options.schema);
   const model = await loadSchemaDocument(schemaFile);
-  const outputPath = options.output ?? path.dirname(schemaFile);
-  const tsSchemaFile = path.join(outputPath, "schema.ts");
-  await new TsSchemaGenerator().generate(schemaFile, [], tsSchemaFile);
+  const outputPath = getOutputPath(options, schemaFile);
+  const tsSchemaFile = path2.join(outputPath, "schema.ts");
+  await new TsSchemaGenerator().generate(schemaFile, [], outputPath);
   await runPlugins(model, outputPath, tsSchemaFile);
-  const prismaSchema = await new PrismaSchemaGenerator(model).generate();
-  fs2.writeFileSync(path.join(outputPath, "schema.prisma"), prismaSchema);
+  if (options.savePrismaSchema) {
+    const prismaSchema = await new PrismaSchemaGenerator2(model).generate();
+    let prismaSchemaFile = path2.join(outputPath, "schema.prisma");
+    if (typeof options.savePrismaSchema === "string") {
+      prismaSchemaFile = path2.resolve(outputPath, options.savePrismaSchema);
+      fs3.mkdirSync(path2.dirname(prismaSchemaFile), {
+        recursive: true
+      });
+    }
+    fs3.writeFileSync(prismaSchemaFile, prismaSchema);
+  }
   if (!options.silent) {
-    console.log(colors2.green("Generation completed successfully."));
+    console.log(colors2.green(`Generation completed successfully in ${Date.now() - start}ms.`));
     console.log(`You can now create a ZenStack client with it.
 
-\`\`\`
+\`\`\`ts
 import { ZenStackClient } from '@zenstackhq/runtime';
 import { schema } from '${outputPath}/schema';
 
-const client = new ZenStackClient(schema);
-\`\`\`
-`);
+const client = new ZenStackClient(schema, {
+    dialect: { ... }
+});
+\`\`\``);
   }
 }
-__name(run, "run");
+__name(run2, "run");
+function getOutputPath(options, schemaFile) {
+  if (options.output) {
+    return options.output;
+  }
+  const pkgJsonConfig = getPkgJsonConfig(process.cwd());
+  if (pkgJsonConfig.output) {
+    return pkgJsonConfig.output;
+  } else {
+    return path2.dirname(schemaFile);
+  }
+}
+__name(getOutputPath, "getOutputPath");
 async function runPlugins(model, outputPath, tsSchemaFile) {
   const plugins = model.declarations.filter(isPlugin);
   for (const plugin of plugins) {
@@ -205,36 +256,9 @@ async function runPlugins(model, outputPath, tsSchemaFile) {
 }
 __name(runPlugins, "runPlugins");
 
-// src/actions/db.ts
-async function run2(command, options) {
-  const schemaFile = getSchemaFile(options.schema);
-  await run({
-    schema: schemaFile,
-    silent: true
-  });
-  const prismaSchemaFile = path2.join(path2.dirname(schemaFile), "schema.prisma");
-  switch (command) {
-    case "push":
-      await runPush(prismaSchemaFile, options);
-      break;
-  }
-}
-__name(run2, "run");
-async function runPush(prismaSchemaFile, options) {
-  const cmd = `prisma db push --schema "${prismaSchemaFile}"${options.acceptDataLoss ? " --accept-data-loss" : ""}${options.forceReset ? " --force-reset" : ""} --skip-generate`;
-  try {
-    await execPackage(cmd, {
-      stdio: "inherit"
-    });
-  } catch (err) {
-    handleSubProcessError(err);
-  }
-}
-__name(runPush, "runPush");
-
 // src/actions/info.ts
 import colors3 from "colors";
-import path3 from "node:path";
+import path3 from "path";
 async function run3(projectPath) {
   const packages = await getZenStackPackages(projectPath);
   if (!packages) {
@@ -263,7 +287,7 @@ async function getZenStackPackages(projectPath) {
         type: "json"
       }
     })).default;
-  } catch (err) {
+  } catch {
     return [];
   }
   const packages = Array.from(new Set([
@@ -294,8 +318,8 @@ __name(getZenStackPackages, "getZenStackPackages");
 
 // src/actions/init.ts
 import colors4 from "colors";
-import fs3 from "node:fs";
-import path4 from "node:path";
+import fs4 from "fs";
+import path4 from "path";
 import ora from "ora";
 import { detect, resolveCommand } from "package-manager-detector";
 
@@ -370,11 +394,11 @@ async function run4(projectPath) {
     }
   }
   const generationFolder = "zenstack";
-  if (!fs3.existsSync(path4.join(projectPath, generationFolder))) {
-    fs3.mkdirSync(path4.join(projectPath, generationFolder));
+  if (!fs4.existsSync(path4.join(projectPath, generationFolder))) {
+    fs4.mkdirSync(path4.join(projectPath, generationFolder));
   }
-  if (!fs3.existsSync(path4.join(projectPath, generationFolder, "schema.zmodel"))) {
-    fs3.writeFileSync(path4.join(projectPath, generationFolder, "schema.zmodel"), STARTER_ZMODEL);
+  if (!fs4.existsSync(path4.join(projectPath, generationFolder, "schema.zmodel"))) {
+    fs4.writeFileSync(path4.join(projectPath, generationFolder, "schema.zmodel"), STARTER_ZMODEL);
   } else {
     console.log(colors4.yellow("Schema file already exists. Skipping generation of sample."));
   }
@@ -385,35 +409,44 @@ async function run4(projectPath) {
 __name(run4, "run");
 
 // src/actions/migrate.ts
-import path5 from "node:path";
+import fs5 from "fs";
+import path5 from "path";
 async function run5(command, options) {
   const schemaFile = getSchemaFile(options.schema);
-  await run({
-    schema: schemaFile,
-    silent: true
-  });
-  const prismaSchemaFile = path5.join(path5.dirname(schemaFile), "schema.prisma");
-  switch (command) {
-    case "dev":
-      await runDev(prismaSchemaFile, options);
-      break;
-    case "reset":
-      await runReset(prismaSchemaFile, options);
-      break;
-    case "deploy":
-      await runDeploy(prismaSchemaFile, options);
-      break;
-    case "status":
-      await runStatus(prismaSchemaFile, options);
-      break;
+  const prismaSchemaDir = options.migrations ? path5.dirname(options.migrations) : void 0;
+  const prismaSchemaFile = await generateTempPrismaSchema(schemaFile, prismaSchemaDir);
+  try {
+    switch (command) {
+      case "dev":
+        await runDev(prismaSchemaFile, options);
+        break;
+      case "reset":
+        await runReset(prismaSchemaFile, options);
+        break;
+      case "deploy":
+        await runDeploy(prismaSchemaFile, options);
+        break;
+      case "status":
+        await runStatus(prismaSchemaFile, options);
+        break;
+    }
+  } finally {
+    if (fs5.existsSync(prismaSchemaFile)) {
+      fs5.unlinkSync(prismaSchemaFile);
+    }
   }
 }
 __name(run5, "run");
-async function runDev(prismaSchemaFile, _options) {
+async function runDev(prismaSchemaFile, options) {
   try {
-    await execPackage(`prisma migrate dev --schema "${prismaSchemaFile}" --skip-generate`, {
-      stdio: "inherit"
-    });
+    const cmd = [
+      "prisma migrate dev",
+      ` --schema "${prismaSchemaFile}"`,
+      " --skip-generate",
+      options.name ? ` --name ${options.name}` : "",
+      options.createOnly ? " --create-only" : ""
+    ].join("");
+    await execPackage(cmd);
   } catch (err) {
     handleSubProcessError2(err);
   }
@@ -421,9 +454,12 @@ async function runDev(prismaSchemaFile, _options) {
 __name(runDev, "runDev");
 async function runReset(prismaSchemaFile, options) {
   try {
-    await execPackage(`prisma migrate reset --schema "${prismaSchemaFile}"${options.force ? " --force" : ""}`, {
-      stdio: "inherit"
-    });
+    const cmd = [
+      "prisma migrate reset",
+      ` --schema "${prismaSchemaFile}"`,
+      options.force ? " --force" : ""
+    ].join("");
+    await execPackage(cmd);
   } catch (err) {
     handleSubProcessError2(err);
   }
@@ -431,9 +467,11 @@ async function runReset(prismaSchemaFile, options) {
 __name(runReset, "runReset");
 async function runDeploy(prismaSchemaFile, _options) {
   try {
-    await execPackage(`prisma migrate deploy --schema "${prismaSchemaFile}"`, {
-      stdio: "inherit"
-    });
+    const cmd = [
+      "prisma migrate deploy",
+      ` --schema "${prismaSchemaFile}"`
+    ].join("");
+    await execPackage(cmd);
   } catch (err) {
     handleSubProcessError2(err);
   }
@@ -441,9 +479,7 @@ async function runDeploy(prismaSchemaFile, _options) {
 __name(runDeploy, "runDeploy");
 async function runStatus(prismaSchemaFile, _options) {
   try {
-    await execPackage(`prisma migrate status --schema "${prismaSchemaFile}"`, {
-      stdio: "inherit"
-    });
+    await execPackage(`prisma migrate status --schema "${prismaSchemaFile}"`);
   } catch (err) {
     handleSubProcessError2(err);
   }
@@ -458,29 +494,43 @@ function handleSubProcessError2(err) {
 }
 __name(handleSubProcessError2, "handleSubProcessError");
 
+// src/actions/validate.ts
+import colors5 from "colors";
+async function run6(options) {
+  const schemaFile = getSchemaFile(options.schema);
+  try {
+    await loadSchemaDocument(schemaFile);
+    console.log(colors5.green("\u2713 Schema validation completed successfully."));
+  } catch (error) {
+    console.error(colors5.red("\u2717 Schema validation failed."));
+    throw error;
+  }
+}
+__name(run6, "run");
+
 // src/utils/version-utils.ts
+import fs6 from "fs";
+import path6 from "path";
+import { fileURLToPath } from "url";
 function getVersion() {
   try {
-    return __require("../package.json").version;
+    const _dirname = typeof __dirname !== "undefined" ? __dirname : path6.dirname(fileURLToPath(import.meta.url));
+    return JSON.parse(fs6.readFileSync(path6.join(_dirname, "../package.json"), "utf8")).version;
   } catch {
-    try {
-      return require_package().version;
-    } catch {
-      return void 0;
-    }
+    return void 0;
   }
 }
 __name(getVersion, "getVersion");
 
 // src/index.ts
 var generateAction = /* @__PURE__ */ __name(async (options) => {
-  await run(options);
+  await run2(options);
 }, "generateAction");
 var migrateAction = /* @__PURE__ */ __name(async (command, options) => {
   await run5(command, options);
 }, "migrateAction");
 var dbAction = /* @__PURE__ */ __name(async (command, options) => {
-  await run2(command, options);
+  await run(command, options);
 }, "dbAction");
 var infoAction = /* @__PURE__ */ __name(async (projectPath) => {
   await run3(projectPath);
@@ -488,29 +538,45 @@ var infoAction = /* @__PURE__ */ __name(async (projectPath) => {
 var initAction = /* @__PURE__ */ __name(async (projectPath) => {
   await run4(projectPath);
 }, "initAction");
+var validateAction = /* @__PURE__ */ __name(async (options) => {
+  await run6(options);
+}, "validateAction");
 function createProgram() {
   const program2 = new Command("zenstack");
   program2.version(getVersion(), "-v --version", "display CLI version");
   const schemaExtensions = ZModelLanguageMetaData.fileExtensions.join(", ");
-  program2.description(`${colors5.bold.blue("\u03B6")} ZenStack is a Prisma power pack for building full-stack apps.
+  program2.description(`${colors6.bold.blue("\u03B6")} ZenStack is a database access toolkit for TypeScript apps.
 
 Documentation: https://zenstack.dev.`).showHelpAfterError().showSuggestionAfterError();
   const schemaOption = new Option("--schema <file>", `schema file (with extension ${schemaExtensions}). Defaults to "schema.zmodel" unless specified in package.json.`);
-  program2.command("generate").description("Run code generation.").addOption(schemaOption).addOption(new Option("-o, --output <path>", "default output directory for core plugins")).action(generateAction);
+  program2.command("generate").description("Run code generation.").addOption(schemaOption).addOption(new Option("--silent", "do not print any output")).addOption(new Option("--save-prisma-schema [path]", "save a Prisma schema file, by default into the output directory")).addOption(new Option("-o, --output <path>", "default output directory for core plugins")).action(generateAction);
   const migrateCommand = program2.command("migrate").description("Update the database schema with migrations.");
-  migrateCommand.command("dev").addOption(schemaOption).addOption(new Option("-n, --name <name>", "migration name")).addOption(new Option("--create-only", "only create migration, do not apply")).description("Create a migration from changes in schema and apply it to the database.").action((options) => migrateAction("dev", options));
-  migrateCommand.command("reset").addOption(schemaOption).addOption(new Option("--force", "skip the confirmation prompt")).description("Reset your database and apply all migrations, all data will be lost.").action((options) => migrateAction("reset", options));
-  migrateCommand.command("deploy").addOption(schemaOption).description("Deploy your pending migrations to your production/staging database.").action((options) => migrateAction("deploy", options));
-  migrateCommand.command("status").addOption(schemaOption).description("check the status of your database migrations.").action((options) => migrateAction("status", options));
+  const migrationsOption = new Option("--migrations <path>", "path for migrations");
+  migrateCommand.command("dev").addOption(schemaOption).addOption(new Option("-n, --name <name>", "migration name")).addOption(new Option("--create-only", "only create migration, do not apply")).addOption(migrationsOption).description("Create a migration from changes in schema and apply it to the database.").action((options) => migrateAction("dev", options));
+  migrateCommand.command("reset").addOption(schemaOption).addOption(new Option("--force", "skip the confirmation prompt")).addOption(migrationsOption).description("Reset your database and apply all migrations, all data will be lost.").action((options) => migrateAction("reset", options));
+  migrateCommand.command("deploy").addOption(schemaOption).addOption(migrationsOption).description("Deploy your pending migrations to your production/staging database.").action((options) => migrateAction("deploy", options));
+  migrateCommand.command("status").addOption(schemaOption).addOption(migrationsOption).description("check the status of your database migrations.").action((options) => migrateAction("status", options));
   const dbCommand = program2.command("db").description("Manage your database schema during development.");
   dbCommand.command("push").description("Push the state from your schema to your database").addOption(schemaOption).addOption(new Option("--accept-data-loss", "ignore data loss warnings")).addOption(new Option("--force-reset", "force a reset of the database before push")).action((options) => dbAction("push", options));
   program2.command("info").description("Get information of installed ZenStack and related packages.").argument("[path]", "project path", ".").action(infoAction);
   program2.command("init").description("Initialize an existing project for ZenStack.").argument("[path]", "project path", ".").action(initAction);
+  program2.command("validate").description("Validate a ZModel schema.").addOption(schemaOption).action(validateAction);
   return program2;
 }
 __name(createProgram, "createProgram");
 var program = createProgram();
-program.parse(process.argv);
+program.parseAsync().catch((err) => {
+  if (err instanceof CliError) {
+    console.error(colors6.red(err.message));
+    process.exit(1);
+  } else if (err instanceof CommanderError) {
+    process.exit(err.exitCode);
+  } else {
+    console.error(colors6.red("An unexpected error occurred:"));
+    console.error(err);
+    process.exit(1);
+  }
+});
 export {
   createProgram
 };