@zenstackhq/cli 3.4.0-beta.3 → 3.4.0

package/dist/index.cjs

@@ -53,6 +53,8 @@ var CliError = class extends Error {
 };
 
 // src/actions/action-utils.ts
+var import_terminal_link = __toESM(require("terminal-link"), 1);
+var import_zod = require("zod");
 function getSchemaFile(file) {
   if (file) {
     if (!import_node_fs.default.existsSync(file)) {
@@ -228,6 +230,58 @@ async function getZenStackPackages(searchPath) {
   return result.filter((p) => !!p);
 }
 __name(getZenStackPackages, "getZenStackPackages");
+var FETCH_CLI_MAX_TIME = 1e3;
+var CLI_CONFIG_ENDPOINT = "https://zenstack.dev/config/cli-v3.json";
+var usageTipsSchema = import_zod.z.object({
+  notifications: import_zod.z.array(import_zod.z.object({
+    title: import_zod.z.string(),
+    url: import_zod.z.url().optional(),
+    active: import_zod.z.boolean()
+  }))
+});
+function startUsageTipsFetch() {
+  let fetchedData = void 0;
+  let fetchComplete = false;
+  const start = Date.now();
+  const controller = new AbortController();
+  fetch(CLI_CONFIG_ENDPOINT, {
+    headers: {
+      accept: "application/json"
+    },
+    signal: controller.signal
+  }).then(async (res) => {
+    if (!res.ok) return;
+    const data = await res.json();
+    const parseResult = usageTipsSchema.safeParse(data);
+    if (parseResult.success) {
+      fetchedData = parseResult.data;
+    }
+  }).catch(() => {
+  }).finally(() => {
+    fetchComplete = true;
+  });
+  return async () => {
+    const elapsed = Date.now() - start;
+    if (!fetchComplete && elapsed < FETCH_CLI_MAX_TIME) {
+      await new Promise((resolve) => setTimeout(resolve, FETCH_CLI_MAX_TIME - elapsed));
+    }
+    if (!fetchComplete) {
+      controller.abort();
+      return;
+    }
+    if (!fetchedData) return;
+    const activeItems = fetchedData.notifications.filter((item) => item.active);
+    if (activeItems.length > 0) {
+      const item = activeItems[Math.floor(Math.random() * activeItems.length)];
+      if (item.url) {
+        console.log((0, import_terminal_link.default)(item.title, item.url));
+      } else {
+        console.log(item.title);
+      }
+    }
+  };
+}
+__name(startUsageTipsFetch, "startUsageTipsFetch");
 
 // src/actions/check.ts
 async function run(options) {
@@ -2200,8 +2254,8 @@ var sqlite = {
     return void 0;
   },
   async introspect(connectionString, _options) {
-    const SQLite2 = (await import("better-sqlite3")).default;
-    const db = new SQLite2(connectionString, {
+    const SQLite = (await import("better-sqlite3")).default;
+    const db = new SQLite(connectionString, {
       readonly: true
     });
     try {
@@ -2898,13 +2952,14 @@ var import_common_helpers2 = require("@zenstackhq/common-helpers");
 var import_language4 = require("@zenstackhq/language");
 var import_ast5 = require("@zenstackhq/language/ast");
 var import_utils7 = require("@zenstackhq/language/utils");
+var import_chokidar = require("chokidar");
 var import_colors6 = __toESM(require("colors"), 1);
 var import_jiti = require("jiti");
 var import_node_fs6 = __toESM(require("fs"), 1);
 var import_node_path5 = __toESM(require("path"), 1);
 var import_node_url = require("url");
-var import_chokidar = require("chokidar");
 var import_ora2 = __toESM(require("ora"), 1);
+var import_semver = __toESM(require("semver"), 1);
 
 // src/plugins/index.ts
 var plugins_exports = {};
@@ -2959,25 +3014,30 @@ var plugin2 = {
     if (importWithFileExtension && typeof importWithFileExtension !== "string") {
       throw new Error('The "importWithFileExtension" option must be a string if specified.');
     }
+    const generateModelTypes = pluginOptions["generateModels"] !== false;
+    const generateInputTypes = pluginOptions["generateInput"] !== false;
     await new import_sdk3.TsSchemaGenerator().generate(model, {
       outDir,
       lite,
       liteOnly,
-      importWithFileExtension
+      importWithFileExtension,
+      generateModelTypes,
+      generateInputTypes
     });
   }
 };
 var typescript_default = plugin2;
 
 // src/actions/generate.ts
-var import_semver = __toESM(require("semver"), 1);
 async function run4(options) {
   try {
     await checkForMismatchedPackages(process.cwd());
   } catch (err) {
     console.warn(import_colors6.default.yellow(`Failed to check for mismatched ZenStack packages: ${err}`));
   }
+  const maybeShowUsageTips = options.tips && !options.silent && !options.watch ? startUsageTipsFetch() : void 0;
   const model = await pureGenerate(options, false);
+  await maybeShowUsageTips?.();
   if (options.watch) {
     const logsEnabled = !options.silent;
     if (logsEnabled) {
@@ -3095,12 +3155,18 @@ async function runPlugins(schemaFile, model, outputPath, options) {
     if (cliPlugin) {
       const pluginOptions = getPluginOptions(plugin3);
       if (provider === "@core/typescript") {
-        if (pluginOptions["lite"] === void 0) {
+        if (options.lite !== void 0) {
           pluginOptions["lite"] = options.lite;
         }
-        if (pluginOptions["liteOnly"] === void 0) {
+        if (options.liteOnly !== void 0) {
           pluginOptions["liteOnly"] = options.liteOnly;
         }
+        if (options.generateModels !== void 0) {
+          pluginOptions["generateModels"] = options.generateModels;
+        }
+        if (options.generateInput !== void 0) {
+          pluginOptions["generateInput"] = options.generateInput;
+        }
       }
       processedPlugins.push({
         cliPlugin,
@@ -3113,7 +3179,9 @@ async function runPlugins(schemaFile, model, outputPath, options) {
       plugin: typescript_default,
       options: {
         lite: options.lite,
-        liteOnly: options.liteOnly
+        liteOnly: options.liteOnly,
+        generateModels: options.generateModels,
+        generateInput: options.generateInput
       }
     }
   ];
@@ -3531,14 +3599,11 @@ var import_postgres = require("@zenstackhq/orm/dialects/postgres");
 var import_sqlite2 = require("@zenstackhq/orm/dialects/sqlite");
 var import_api = require("@zenstackhq/server/api");
 var import_express = require("@zenstackhq/server/express");
-var import_better_sqlite3 = __toESM(require("better-sqlite3"), 1);
 var import_colors11 = __toESM(require("colors"), 1);
 var import_cors = __toESM(require("cors"), 1);
 var import_express2 = __toESM(require("express"), 1);
 var import_jiti2 = require("jiti");
-var import_mysql22 = require("mysql2");
 var import_node_path9 = __toESM(require("path"), 1);
-var import_pg2 = require("pg");
 
 // src/utils/version-utils.ts
 var import_colors10 = __toESM(require("colors"), 1);
@@ -3548,7 +3613,7 @@ var import_node_url2 = require("url");
 var import_semver2 = __toESM(require("semver"), 1);
 var import_meta2 = {};
 var CHECK_VERSION_TIMEOUT = 2e3;
-var VERSION_CHECK_TAG = "next";
+var VERSION_CHECK_TAG = "latest";
 function getVersion() {
   try {
     const _dirname = typeof __dirname !== "undefined" ? __dirname : import_node_path8.default.dirname((0, import_node_url2.fileURLToPath)(import_meta2.url));
@@ -3614,7 +3679,7 @@ async function run9(options) {
     databaseUrl = evaluateUrl(schemaUrl);
   }
   const provider = (0, import_utils8.getStringLiteral)(dataSource?.fields.find((f) => f.name === "provider")?.value);
-  const dialect = createDialect(provider, databaseUrl, outputPath);
+  const dialect = await createDialect(provider, databaseUrl, outputPath);
   const jiti = (0, import_jiti2.createJiti)(import_meta3.url);
   const schemaModule = await jiti.import(import_node_path9.default.join(outputPath, "schema"));
   const schema = schemaModule.schema;
@@ -3674,9 +3739,15 @@ function redactDatabaseUrl(url) {
   }
 }
 __name(redactDatabaseUrl, "redactDatabaseUrl");
-function createDialect(provider, databaseUrl, outputPath) {
+async function createDialect(provider, databaseUrl, outputPath) {
   switch (provider) {
     case "sqlite": {
+      let SQLite;
+      try {
+        SQLite = (await import("better-sqlite3")).default;
+      } catch {
+        throw new CliError(`Package "better-sqlite3" is required for SQLite support. Please install it with: npm install better-sqlite3`);
+      }
       let resolvedUrl = databaseUrl.trim();
       if (resolvedUrl.startsWith("file:")) {
         const filePath = resolvedUrl.substring("file:".length);
@@ -3686,21 +3757,35 @@ function createDialect(provider, databaseUrl, outputPath) {
       }
       console.log(import_colors11.default.gray(`Connecting to SQLite database at: ${resolvedUrl}`));
       return new import_sqlite2.SqliteDialect({
-        database: new import_better_sqlite3.default(resolvedUrl)
+        database: new SQLite(resolvedUrl)
       });
     }
-    case "postgresql":
+    case "postgresql": {
+      let PgPool;
+      try {
+        PgPool = (await import("pg")).Pool;
+      } catch {
+        throw new CliError(`Package "pg" is required for PostgreSQL support. Please install it with: npm install pg`);
+      }
       console.log(import_colors11.default.gray(`Connecting to PostgreSQL database at: ${redactDatabaseUrl(databaseUrl)}`));
       return new import_postgres.PostgresDialect({
-        pool: new import_pg2.Pool({
+        pool: new PgPool({
           connectionString: databaseUrl
         })
       });
-    case "mysql":
+    }
+    case "mysql": {
+      let createMysqlPool;
+      try {
+        createMysqlPool = (await import("mysql2")).createPool;
+      } catch {
+        throw new CliError(`Package "mysql2" is required for MySQL support. Please install it with: npm install mysql2`);
+      }
       console.log(import_colors11.default.gray(`Connecting to MySQL database at: ${redactDatabaseUrl(databaseUrl)}`));
       return new import_mysql2.MysqlDialect({
-        pool: (0, import_mysql22.createPool)(databaseUrl)
+        pool: createMysqlPool(databaseUrl)
       });
+    }
     default:
       throw new CliError(`Unsupported database provider: ${provider}`);
   }
@@ -3764,7 +3849,7 @@ var import_node_fs13 = __toESM(require("fs"), 1);
 var os2 = __toESM(require("os"), 1);
 
 // src/constants.ts
-var TELEMETRY_TRACKING_TOKEN = "<TELEMETRY_TRACKING_TOKEN>";
+var TELEMETRY_TRACKING_TOKEN = "74944eb779d7d3b4ce185be843fde9fc";
 
 // src/utils/is-ci.ts
 var import_node_process = require("process");
@@ -4025,6 +4110,17 @@ var seedAction = /* @__PURE__ */ __name(async (options, args) => {
 var proxyAction = /* @__PURE__ */ __name(async (options) => {
   await telemetry.trackCommand("proxy", () => run9(options));
 }, "proxyAction");
+function triStateBooleanOption(flag, description) {
+  return new import_commander.Option(flag, description).choices([
+    "true",
+    "false"
+  ]).argParser((value) => {
+    if (value === void 0 || value === "true") return true;
+    if (value === "false") return false;
+    throw new CliError(`Invalid value for ${flag}: ${value}`);
+  });
+}
+__name(triStateBooleanOption, "triStateBooleanOption");
 function createProgram() {
   const program = new import_commander.Command("zen").alias("zenstack").helpOption("-h, --help", "Show this help message").version(getVersion(), "-v --version", "Show CLI version");
   const schemaExtensions = import_language5.ZModelLanguageMetaData.fileExtensions.join(", ");
@@ -4033,7 +4129,8 @@ function createProgram() {
 Documentation: https://zenstack.dev/docs`).showHelpAfterError().showSuggestionAfterError();
   const schemaOption = new import_commander.Option("--schema <file>", `schema file (with extension ${schemaExtensions}). Defaults to "zenstack/schema.zmodel" unless specified in package.json.`);
   const noVersionCheckOption = new import_commander.Option("--no-version-check", "do not check for new version");
-  program.command("generate").description("Run code generation plugins").addOption(schemaOption).addOption(noVersionCheckOption).addOption(new import_commander.Option("-o, --output <path>", "default output directory for code generation")).addOption(new import_commander.Option("-w, --watch", "enable watch mode").default(false)).addOption(new import_commander.Option("--lite", "also generate a lite version of schema without attributes").default(false)).addOption(new import_commander.Option("--lite-only", "only generate lite version of schema without attributes").default(false)).addOption(new import_commander.Option("--silent", "suppress all output except errors").default(false)).action(generateAction);
+  const noTipsOption = new import_commander.Option("--no-tips", "do not show usage tips");
+  program.command("generate").description("Run code generation plugins").addOption(schemaOption).addOption(noVersionCheckOption).addOption(noTipsOption).addOption(new import_commander.Option("-o, --output <path>", "default output directory for code generation")).addOption(new import_commander.Option("-w, --watch", "enable watch mode").default(false)).addOption(triStateBooleanOption("--lite [boolean]", "also generate a lite version of schema without attributes, defaults to false")).addOption(triStateBooleanOption("--lite-only [boolean]", "only generate lite version of schema without attributes, defaults to false")).addOption(triStateBooleanOption("--generate-models [boolean]", "generate models.ts file, defaults to true")).addOption(triStateBooleanOption("--generate-input [boolean]", "generate input.ts file, defaults to true")).addOption(new import_commander.Option("--silent", "suppress all output except errors").default(false)).action(generateAction);
   const migrateCommand = program.command("migrate").description("Run database schema migration related tasks.");
   const migrationsOption = new import_commander.Option("--migrations <path>", 'path that contains the "migrations" directory');
   migrateCommand.command("dev").addOption(schemaOption).addOption(noVersionCheckOption).addOption(new import_commander.Option("-n, --name <name>", "migration name")).addOption(new import_commander.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));