@zenstackhq/cli 3.0.0-beta.24 → 3.0.0-beta.26

package/dist/index.js

@@ -13,7 +13,7 @@ var __export = (target, all) => {
 
 // src/index.ts
 import { ZModelLanguageMetaData } from "@zenstackhq/language";
-import colors8 from "colors";
+import colors9 from "colors";
 import { Command, CommanderError, Option } from "commander";
 
 // src/actions/check.ts
@@ -105,7 +105,8 @@ __name(generateTempPrismaSchema, "generateTempPrismaSchema");
 function getPkgJsonConfig(startPath) {
   const result = {
     schema: void 0,
-    output: void 0
+    output: void 0,
+    seed: void 0
   };
   const pkgJsonFile = findUp([
     "package.json"
@@ -120,8 +121,9 @@ function getPkgJsonConfig(startPath) {
     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);
+    result.schema = pkgJson.zenstack.schema && typeof pkgJson.zenstack.schema === "string" ? path.resolve(path.dirname(pkgJsonFile), pkgJson.zenstack.schema) : void 0;
+    result.output = pkgJson.zenstack.output && typeof pkgJson.zenstack.output === "string" ? path.resolve(path.dirname(pkgJsonFile), pkgJson.zenstack.output) : void 0;
+    result.seed = typeof pkgJson.zenstack.seed === "string" && pkgJson.zenstack.seed ? pkgJson.zenstack.seed : void 0;
   }
   return result;
 }
@@ -144,6 +146,14 @@ function findUp(names, cwd = process.cwd(), multiple = false, result = []) {
   return findUp(names, up, multiple, result);
 }
 __name(findUp, "findUp");
+async function requireDataSourceUrl(schemaFile) {
+  const zmodel = await loadSchemaDocument(schemaFile);
+  const dataSource = zmodel.declarations.find(isDataSource);
+  if (!dataSource?.fields.some((f) => f.name === "url")) {
+    throw new CliError(`The schema's "datasource" must have a "url" field to use this command.`);
+  }
+}
+__name(requireDataSourceUrl, "requireDataSourceUrl");
 
 // src/actions/check.ts
 async function run(options) {
@@ -212,6 +222,7 @@ async function run2(command, options) {
 __name(run2, "run");
 async function runPush(options) {
   const schemaFile = getSchemaFile(options.schema);
+  await requireDataSourceUrl(schemaFile);
   const prismaSchemaFile = await generateTempPrismaSchema(schemaFile);
   try {
     const cmd = [
@@ -617,8 +628,38 @@ __name(run6, "run");
 // src/actions/migrate.ts
 import fs7 from "fs";
 import path7 from "path";
-async function run7(command, options) {
+
+// src/actions/seed.ts
+import colors7 from "colors";
+import { execaCommand } from "execa";
+async function run7(options, args) {
+  const pkgJsonConfig = getPkgJsonConfig(process.cwd());
+  if (!pkgJsonConfig.seed) {
+    if (!options.noWarnings) {
+      console.warn(colors7.yellow("No seed script defined in package.json. Skipping seeding."));
+    }
+    return;
+  }
+  const command = `${pkgJsonConfig.seed}${args.length > 0 ? " " + args.join(" ") : ""}`;
+  if (options.printStatus) {
+    console.log(colors7.gray(`Running seed script "${command}"...`));
+  }
+  try {
+    await execaCommand(command, {
+      stdout: "inherit",
+      stderr: "inherit"
+    });
+  } catch (err) {
+    console.error(colors7.red(err instanceof Error ? err.message : String(err)));
+    throw new CliError("Failed to seed the database. Please check the error message above for details.");
+  }
+}
+__name(run7, "run");
+
+// src/actions/migrate.ts
+async function run8(command, options) {
   const schemaFile = getSchemaFile(options.schema);
+  await requireDataSourceUrl(schemaFile);
   const prismaSchemaDir = options.migrations ? path7.dirname(options.migrations) : void 0;
   const prismaSchemaFile = await generateTempPrismaSchema(schemaFile, prismaSchemaDir);
   try {
@@ -645,13 +686,14 @@ async function run7(command, options) {
     }
   }
 }
-__name(run7, "run");
+__name(run8, "run");
 function runDev(prismaSchemaFile, options) {
   try {
     const cmd = [
       "migrate dev",
       ` --schema "${prismaSchemaFile}"`,
       " --skip-generate",
+      " --skip-seed",
       options.name ? ` --name "${options.name}"` : "",
       options.createOnly ? " --create-only" : ""
     ].join("");
@@ -661,18 +703,25 @@ function runDev(prismaSchemaFile, options) {
   }
 }
 __name(runDev, "runDev");
-function runReset(prismaSchemaFile, options) {
+async function runReset(prismaSchemaFile, options) {
   try {
     const cmd = [
       "migrate reset",
       ` --schema "${prismaSchemaFile}"`,
       " --skip-generate",
+      " --skip-seed",
       options.force ? " --force" : ""
     ].join("");
     execPrisma(cmd);
   } catch (err) {
     handleSubProcessError2(err);
   }
+  if (!options.skipSeed) {
+    await run7({
+      noWarnings: true,
+      printStatus: true
+    }, []);
+  }
 }
 __name(runReset, "runReset");
 function runDeploy(prismaSchemaFile, _options) {
@@ -859,7 +908,7 @@ function getMachineId() {
 __name(getMachineId, "getMachineId");
 
 // src/utils/version-utils.ts
-import colors7 from "colors";
+import colors8 from "colors";
 import fs11 from "fs";
 import path8 from "path";
 import { fileURLToPath as fileURLToPath2 } from "url";
@@ -884,7 +933,7 @@ async function checkNewVersion() {
     return;
   }
   if (latestVersion && currVersion && semver.gt(latestVersion, currVersion)) {
-    console.log(`A newer version ${colors7.cyan(latestVersion)} is available.`);
+    console.log(`A newer version ${colors8.cyan(latestVersion)} is available.`);
   }
 }
 __name(checkNewVersion, "checkNewVersion");
@@ -1013,7 +1062,7 @@ var generateAction = /* @__PURE__ */ __name(async (options) => {
   await telemetry.trackCommand("generate", () => run4(options));
 }, "generateAction");
 var migrateAction = /* @__PURE__ */ __name(async (subCommand, options) => {
-  await telemetry.trackCommand(`migrate ${subCommand}`, () => run7(subCommand, options));
+  await telemetry.trackCommand(`migrate ${subCommand}`, () => run8(subCommand, options));
 }, "migrateAction");
 var dbAction = /* @__PURE__ */ __name(async (subCommand, options) => {
   await telemetry.trackCommand(`db ${subCommand}`, () => run2(subCommand, options));
@@ -1030,10 +1079,13 @@ var checkAction = /* @__PURE__ */ __name(async (options) => {
 var formatAction = /* @__PURE__ */ __name(async (options) => {
   await telemetry.trackCommand("format", () => run3(options));
 }, "formatAction");
+var seedAction = /* @__PURE__ */ __name(async (options, args) => {
+  await telemetry.trackCommand("db seed", () => run7(options, args));
+}, "seedAction");
 function createProgram() {
   const program = new Command("zen").alias("zenstack").helpOption("-h, --help", "Show this help message").version(getVersion(), "-v --version", "Show CLI version");
   const schemaExtensions = ZModelLanguageMetaData.fileExtensions.join(", ");
-  program.description(`${colors8.bold.blue("\u03B6")} ZenStack is the data layer for modern TypeScript apps.
+  program.description(`${colors9.bold.blue("\u03B6")} ZenStack is the data layer for modern TypeScript apps.
 
 Documentation: https://zenstack.dev/docs/3.x`).showHelpAfterError().showSuggestionAfterError();
   const schemaOption = new Option("--schema <file>", `schema file (with extension ${schemaExtensions}). Defaults to "zenstack/schema.zmodel" unless specified in package.json.`);
@@ -1042,12 +1094,22 @@ Documentation: https://zenstack.dev/docs/3.x`).showHelpAfterError().showSuggesti
   const migrateCommand = program.command("migrate").description("Run database schema migration related tasks.");
   const migrationsOption = new Option("--migrations <path>", 'path that contains the "migrations" directory');
   migrateCommand.command("dev").addOption(schemaOption).addOption(noVersionCheckOption).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).addOption(noVersionCheckOption).description("Reset your database and apply all migrations, all data will be lost").action((options) => migrateAction("reset", options));
+  migrateCommand.command("reset").addOption(schemaOption).addOption(new Option("--force", "skip the confirmation prompt")).addOption(migrationsOption).addOption(new Option("--skip-seed", "skip seeding the database after reset")).addOption(noVersionCheckOption).description("Reset your database and apply all migrations, all data will be lost").addHelpText("after", "\nIf there is a seed script defined in package.json, it will be run after the reset. Use --skip-seed to skip it.").action((options) => migrateAction("reset", options));
   migrateCommand.command("deploy").addOption(schemaOption).addOption(noVersionCheckOption).addOption(migrationsOption).description("Deploy your pending migrations to your production/staging database").action((options) => migrateAction("deploy", options));
   migrateCommand.command("status").addOption(schemaOption).addOption(noVersionCheckOption).addOption(migrationsOption).description("Check the status of your database migrations").action((options) => migrateAction("status", options));
   migrateCommand.command("resolve").addOption(schemaOption).addOption(noVersionCheckOption).addOption(migrationsOption).addOption(new Option("--applied <migration>", "record a specific migration as applied")).addOption(new Option("--rolled-back <migration>", "record a specific migration as rolled back")).description("Resolve issues with database migrations in deployment databases").action((options) => migrateAction("resolve", options));
   const dbCommand = program.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(noVersionCheckOption).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));
+  dbCommand.command("seed").description("Seed the database").allowExcessArguments(true).addHelpText("after", `
+Seed script is configured under the "zenstack.seed" field in package.json.
+E.g.:
+{
+    "zenstack": {
+        "seed": "ts-node ./zenstack/seed.ts"
+    }
+}
+
+Arguments following -- are passed to the seed script. E.g.: "zen db seed -- --users 10"`).addOption(noVersionCheckOption).action((options, command) => seedAction(options, command.args));
   program.command("info").description("Get information of installed ZenStack packages").argument("[path]", "project path", ".").addOption(noVersionCheckOption).action(infoAction);
   program.command("init").description("Initialize an existing project for ZenStack").argument("[path]", "project path", ".").addOption(noVersionCheckOption).action(initAction);
   program.command("check").description("Check a ZModel schema for syntax or semantic errors").addOption(schemaOption).addOption(noVersionCheckOption).action(checkAction);
@@ -1073,10 +1135,10 @@ async function main() {
     if (e instanceof CommanderError) {
       exitCode = e.exitCode;
     } else if (e instanceof CliError) {
-      console.error(colors8.red(e.message));
+      console.error(colors9.red(e.message));
       exitCode = 1;
     } else {
-      console.error(colors8.red(`Unhandled error: ${e}`));
+      console.error(colors9.red(`Unhandled error: ${e}`));
       exitCode = 1;
     }
   }