@finebi/finebi-cli 1.6.2 → 2.0.0

package/skills/finebi-cli-agent/scripts/finebi-cli/templates/web-app/tsconfig.json

@@ -1,4 +1,4 @@
-{
-  "compilerOptions": {"target":"ES2020","lib":["ES2020","DOM","DOM.Iterable"],"module":"ESNext","moduleResolution":"Bundler","jsx":"react-jsx","strict":true,"skipLibCheck":true,"esModuleInterop":true,"resolveJsonModule":true,"isolatedModules":true,"noEmit":true},
-  "include":["src","vite.config.ts"]
-}
+{
+  "compilerOptions": {"target":"ES2020","lib":["ES2020","DOM","DOM.Iterable"],"module":"ESNext","moduleResolution":"Bundler","jsx":"react-jsx","strict":true,"skipLibCheck":true,"esModuleInterop":true,"resolveJsonModule":true,"isolatedModules":true,"noEmit":true},
+  "include":["src","vite.config.ts"]
+}

package/skills/finebi-cli-agent/scripts/finebi-cli-runner.mjs

@@ -10,10 +10,10 @@ const scriptDirectory = dirname(fileURLToPath(import.meta.url));
 const bundledCliEntry = resolve(scriptDirectory, "finebi-cli", "src", "index.js");
 
 export async function run(argv = process.argv.slice(2), options = {}) {
-  const env = {...(options.env ?? process.env)};
-  if (!env.FINEBI_CLI_PATH?.trim() && existsSync(bundledCliEntry)) {
-    env.FINEBI_CLI_PATH = bundledCliEntry;
-  }
+  const env = {...(options.env ?? process.env)};
+  if (!env.FINEBI_CLI_PATH?.trim() && existsSync(bundledCliEntry)) {
+    env.FINEBI_CLI_PATH = bundledCliEntry;
+  }
   return runCore(argv, {...options, env});
 }
 

package/src/app.js

@@ -1,157 +1,160 @@
-import {cp, mkdir, readdir, readFile, stat, writeFile} from "node:fs/promises";
-import {dirname, resolve} from "node:path";
-import {fileURLToPath} from "node:url";
-
-import {cliError} from "./errors.js";
-import {failure, success} from "./output.js";
-
-const TEMPLATE_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), "..", "templates", "web-app");
-const NAME_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/u;
-const WINDOWS_DEVICE_NAME = /^(?:con|prn|aux|nul|com[1-9]|lpt[1-9])$/iu;
-
-export async function handleApp(args, context = {}) {
-  const action = args[0];
-  if (action === "create") return createApp(args.slice(1), context);
-  if (action === "inspect") return inspectApp(args.slice(1));
-  return invalid("app", "App command is required.", ["finebi-cli app create --name <name> --path <parent>", "finebi-cli app inspect --path <project>"]);
-}
-
-export async function createApp(args, context = {}) {
-  const options = parseOptions(args, "app.create");
-  if (!options.ok) return options.error;
-  const {name, path: parentPath} = options.value;
-  if (!name || name.length > 214 || !NAME_PATTERN.test(name) || WINDOWS_DEVICE_NAME.test(name)) {
-    return invalid("app.create", "name must be a simple lowercase npm name (letters, digits, and single hyphens).", ["finebi-cli app create --name sales-dashboard --path <parent>"]);
-  }
-  if (!parentPath) {
-    return invalid("app.create", "path must be an existing parent directory.");
-  }
-  if (options.value.layout && !['overview','workbench','cockpit','retail'].includes(options.value.layout)) return invalid('app.create','layout must be overview, workbench, cockpit or retail.');
-  const parent = resolve(parentPath);
-  const destination = resolve(parent, name);
-  if (dirname(destination) !== parent) {
-    return invalid("app.create", "name must stay inside the selected parent directory.");
-  }
-  try {
-    if (!(await stat(parent)).isDirectory()) return invalid("app.create", "path must point to a directory.");
-  } catch (error) {
-    return invalid("app.create", error.code === "ENOENT" ? `Parent directory does not exist: ${parent}` : `Cannot inspect parent directory: ${error.message}`);
-  }
-  try {
-    const templateRoot = context.templateRoot ? resolve(context.templateRoot) : TEMPLATE_ROOT;
-    const templatePackage = JSON.parse(await readFile(resolve(templateRoot, "package.json"), "utf8"));
-    const templateConfigPath = resolve(templateRoot, "public", "app-config.json");
-    let config = {schemaVersion: "1", title: name, basePath: "/webroot/decision", layout: "overview", dashboardId: "", maxRows: 1000, pageSize: 8, widgets: [], filters: []};
-    try {
-      config = JSON.parse(await readFile(templateConfigPath, "utf8"));
-    } catch (error) {
-      if (error.code !== "ENOENT") throw error;
-    }
-    try {
-      await mkdir(destination, {recursive: false});
-    } catch (error) {
-      return invalid("app.create", error.code === "EEXIST" ? `Destination already exists: ${destination}` : `Cannot create destination: ${error.message}`);
-    }
-    await copyTemplateContents(templateRoot, destination);
-    if(options.value.layout) config.layout=options.value.layout;
-    if(config.layout==='cockpit') config.insights=true;
-    await mkdir(resolve(destination, "public"), {recursive: true});
-    await writeFile(resolve(destination, "package.json"), `${JSON.stringify({...templatePackage, name}, null, 2)}\n`, "utf8");
-    await writeFile(resolve(destination, "public", "app-config.json"), `${JSON.stringify({...config, templateVersion: templatePackage.version}, null, 2)}\n`, "utf8");
-    const lockPath = resolve(destination, "package-lock.json");
-    try {
-      const lock = JSON.parse(await readFile(lockPath, "utf8"));
-      lock.name = name;
-      if (lock.packages?.[""]) lock.packages[""].name = name;
-      await writeFile(lockPath, `${JSON.stringify(lock, null, 2)}\n`, "utf8");
-    } catch (error) {
-      if (error.code !== "ENOENT") throw error;
-    }
-    return success("app.create", {name, path: destination, templateVersion: templatePackage.version});
-  } catch (error) {
-    return invalid("app.create", `Could not create project: ${error.message}`);
-  }
-}
-
-async function copyTemplateContents(sourceRoot, destinationRoot, relativeDirectory = "") {
-  const sourceDirectory = resolve(sourceRoot, relativeDirectory);
-  const destinationDirectory = resolve(destinationRoot, relativeDirectory);
-  for (const entry of (await readdir(sourceDirectory, {withFileTypes: true})).sort((left, right) => left.name.localeCompare(right.name, "en"))) {
-    const relativePath = `${relativeDirectory}/${entry.name}`.replace(/^\//u, "");
-    if (!templatePathAllowed(relativePath)) continue;
-    const sourcePath = resolve(sourceDirectory, entry.name);
-    const destinationPath = resolve(destinationDirectory, entry.name);
-    if (entry.isDirectory()) {
-      await mkdir(destinationPath, {recursive: false});
-      await copyTemplateContents(sourceRoot, destinationRoot, relativePath);
-    } else if (entry.isFile()) {
-      await cp(sourcePath, destinationPath, {force: false, errorOnExist: true});
-    } else {
-      throw new Error(`Unsupported template entry: ${relativePath}`);
-    }
-  }
-}
-
-function templatePathAllowed(relative) {
-  const relativePath = relative.replaceAll("\\", "/");
-  const parts = relativePath.split("/").filter(Boolean);
-  const basename = parts.at(-1) || "";
-  return !parts.some(part => ["node_modules", "dist", "temp", ".git"].includes(part))
-    && basename !== ".env"
-    && (!basename.startsWith(".env.") || basename === ".env.example");
-}
-
-async function inspectApp(args) {
-  const options = parseOptions(args, "app.inspect");
-  if (!options.ok) return options.error;
-  const projectPath = options.value.path;
-  if (!projectPath) return invalid("app.inspect", "path must be a project directory.");
-  const project = resolve(projectPath);
-  try {
-    if (!(await stat(project)).isDirectory()) return invalid("app.inspect", "path must point to a project directory.");
-    const configPath = resolve(project, "public", "app-config.json");
-    const config = JSON.parse(await readFile(configPath, "utf8"));
-    if (!config || typeof config !== "object" || Array.isArray(config)) return invalid("app.inspect", "app-config.json must contain a JSON object.");
-    if (options.value.strict) {
-      const {configErrors}=await import('../templates/web-app/src/finebi/config.js');
-      const errors = configErrors(config);
-      if (errors.length) return failure("app.inspect", cliError("INVALID_ARGUMENT", {path: "public/app-config.json", message: errors.join(" ")}));
-    }
-    return success("app.inspect", {
-      path: project,
-      dashboardId: config.dashboardId ?? null,
-      layout: config.layout ?? null,
-      directoryEntryId: config.directoryEntryId || null,
-      widgets: Array.isArray(config.widgets) ? config.widgets.length : null,
-      templateVersion: config.templateVersion || null,
-      configValidated: options.value.strict === true,
-      remoteValidated: false,
-    });
-  } catch (error) {
-    return invalid("app.inspect", `Cannot read project configuration: ${error.message}`);
-  }
-}
-
-function parseOptions(args, command) {
-  const value = {};
-  for (let index = 0; index < args.length; index++) {
-    const option = args[index];
-    if (option === "--json") continue;
-    if (option === "--strict" && command === "app.inspect") {
-      if (value.strict) return {ok: false, error: invalid(command, "--strict must only be supplied once.")};
-      value.strict = true;
-      continue;
-    }
-    if (!["--name","--path",...(command==='app.create'?['--layout']:[])].includes(option)) return {ok: false, error: invalid(command, `Unsupported option: ${option}`)};
-    const key = option.slice(2);
-    const next = args[++index];
-    if (!next || next.startsWith("--")) return {ok: false, error: invalid(command, `${option} requires a value.`)};
-    if (value[key]) return {ok: false, error: invalid(command, `${option} must only be supplied once.`)};
-    value[key] = next;
-  }
-  return {ok: true, value};
-}
-
-function invalid(command, message, nextActions = []) {
-  return failure(command, cliError("INVALID_ARGUMENT", {path: command, message, nextActions}));
-}
+import {cp, mkdir, readdir, readFile, stat, writeFile} from "node:fs/promises";
+import {dirname, resolve} from "node:path";
+import {fileURLToPath} from "node:url";
+
+import {cliError} from "./errors.js";
+import {failure, success} from "./output.js";
+
+const TEMPLATE_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), "..", "templates", "web-app");
+const NAME_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/u;
+const WINDOWS_DEVICE_NAME = /^(?:con|prn|aux|nul|com[1-9]|lpt[1-9])$/iu;
+
+export async function handleApp(args, context = {}) {
+  const action = args[0];
+  if (action === "create") return createApp(args.slice(1), context);
+  if (action === "inspect") return inspectApp(args.slice(1));
+  return invalid("app", "App command is required.", ["finebi-cli app create --name <name> --path <parent>", "finebi-cli app inspect --path <project>"]);
+}
+
+export async function createApp(args, context = {}) {
+  const options = parseOptions(args, "app.create");
+  if (!options.ok) return options.error;
+  const {name, path: parentPath} = options.value;
+  if (!name || name.length > 214 || !NAME_PATTERN.test(name) || WINDOWS_DEVICE_NAME.test(name)) {
+    return invalid("app.create", "name must be a simple lowercase npm name (letters, digits, and single hyphens).", ["finebi-cli app create --name sales-dashboard --path <parent>"]);
+  }
+  if (!parentPath) {
+    return invalid("app.create", "path must be an existing parent directory.");
+  }
+  if (options.value.layout && !['overview','workbench','cockpit','retail'].includes(options.value.layout)) return invalid('app.create','layout must be overview, workbench, cockpit or retail.');
+  const parent = resolve(parentPath);
+  const destination = resolve(parent, name);
+  if (dirname(destination) !== parent) {
+    return invalid("app.create", "name must stay inside the selected parent directory.");
+  }
+  try {
+    if (!(await stat(parent)).isDirectory()) return invalid("app.create", "path must point to a directory.");
+  } catch (error) {
+    return invalid("app.create", error.code === "ENOENT" ? `Parent directory does not exist: ${parent}` : `Cannot inspect parent directory: ${error.message}`);
+  }
+  try {
+    const templateRoot = context.templateRoot ? resolve(context.templateRoot) : TEMPLATE_ROOT;
+    const templatePackage = JSON.parse(await readFile(resolve(templateRoot, "package.json"), "utf8"));
+    const gitignore = await readFile(resolve(templateRoot, "gitignore.template"), "utf8");
+    const templateConfigPath = resolve(templateRoot, "public", "app-config.json");
+    let config = {schemaVersion: "1", title: name, basePath: "/webroot/decision", layout: "overview", dashboardId: "", maxRows: 1000, pageSize: 8, widgets: [], filters: []};
+    try {
+      config = JSON.parse(await readFile(templateConfigPath, "utf8"));
+    } catch (error) {
+      if (error.code !== "ENOENT") throw error;
+    }
+    try {
+      await mkdir(destination, {recursive: false});
+    } catch (error) {
+      return invalid("app.create", error.code === "EEXIST" ? `Destination already exists: ${destination}` : `Cannot create destination: ${error.message}`);
+    }
+    await copyTemplateContents(templateRoot, destination);
+    await writeFile(resolve(destination, ".gitignore"), gitignore, "utf8");
+    if(options.value.layout) config.layout=options.value.layout;
+    if(config.layout==='cockpit') config.insights=true;
+    await mkdir(resolve(destination, "public"), {recursive: true});
+    await writeFile(resolve(destination, "package.json"), `${JSON.stringify({...templatePackage, name}, null, 2)}\n`, "utf8");
+    await writeFile(resolve(destination, "public", "app-config.json"), `${JSON.stringify({...config, templateVersion: templatePackage.version}, null, 2)}\n`, "utf8");
+    const lockPath = resolve(destination, "package-lock.json");
+    try {
+      const lock = JSON.parse(await readFile(lockPath, "utf8"));
+      lock.name = name;
+      if (lock.packages?.[""]) lock.packages[""].name = name;
+      await writeFile(lockPath, `${JSON.stringify(lock, null, 2)}\n`, "utf8");
+    } catch (error) {
+      if (error.code !== "ENOENT") throw error;
+    }
+    return success("app.create", {name, path: destination, templateVersion: templatePackage.version});
+  } catch (error) {
+    return invalid("app.create", `Could not create project: ${error.message}`);
+  }
+}
+
+async function copyTemplateContents(sourceRoot, destinationRoot, relativeDirectory = "") {
+  const sourceDirectory = resolve(sourceRoot, relativeDirectory);
+  const destinationDirectory = resolve(destinationRoot, relativeDirectory);
+  for (const entry of (await readdir(sourceDirectory, {withFileTypes: true})).sort((left, right) => left.name.localeCompare(right.name, "en"))) {
+    const relativePath = `${relativeDirectory}/${entry.name}`.replace(/^\//u, "");
+    if (relativePath === ".gitignore" || relativePath === "gitignore.template") continue;
+    if (!templatePathAllowed(relativePath)) continue;
+    const sourcePath = resolve(sourceDirectory, entry.name);
+    const destinationPath = resolve(destinationDirectory, entry.name);
+    if (entry.isDirectory()) {
+      await mkdir(destinationPath, {recursive: false});
+      await copyTemplateContents(sourceRoot, destinationRoot, relativePath);
+    } else if (entry.isFile()) {
+      await cp(sourcePath, destinationPath, {force: false, errorOnExist: true});
+    } else {
+      throw new Error(`Unsupported template entry: ${relativePath}`);
+    }
+  }
+}
+
+function templatePathAllowed(relative) {
+  const relativePath = relative.replaceAll("\\", "/");
+  const parts = relativePath.split("/").filter(Boolean);
+  const basename = parts.at(-1) || "";
+  return !parts.some(part => ["node_modules", "dist", "temp", ".git"].includes(part))
+    && basename !== ".env"
+    && (!basename.startsWith(".env.") || basename === ".env.example");
+}
+
+async function inspectApp(args) {
+  const options = parseOptions(args, "app.inspect");
+  if (!options.ok) return options.error;
+  const projectPath = options.value.path;
+  if (!projectPath) return invalid("app.inspect", "path must be a project directory.");
+  const project = resolve(projectPath);
+  try {
+    if (!(await stat(project)).isDirectory()) return invalid("app.inspect", "path must point to a project directory.");
+    const configPath = resolve(project, "public", "app-config.json");
+    const config = JSON.parse(await readFile(configPath, "utf8"));
+    if (!config || typeof config !== "object" || Array.isArray(config)) return invalid("app.inspect", "app-config.json must contain a JSON object.");
+    if (options.value.strict) {
+      const {configErrors}=await import('../templates/web-app/src/finebi/config.js');
+      const errors = configErrors(config);
+      if (errors.length) return failure("app.inspect", cliError("INVALID_ARGUMENT", {path: "public/app-config.json", message: errors.join(" ")}));
+    }
+    return success("app.inspect", {
+      path: project,
+      dashboardId: config.dashboardId ?? null,
+      layout: config.layout ?? null,
+      directoryEntryId: config.directoryEntryId || null,
+      widgets: Array.isArray(config.widgets) ? config.widgets.length : null,
+      templateVersion: config.templateVersion || null,
+      configValidated: options.value.strict === true,
+      remoteValidated: false,
+    });
+  } catch (error) {
+    return invalid("app.inspect", `Cannot read project configuration: ${error.message}`);
+  }
+}
+
+function parseOptions(args, command) {
+  const value = {};
+  for (let index = 0; index < args.length; index++) {
+    const option = args[index];
+    if (option === "--json") continue;
+    if (option === "--strict" && command === "app.inspect") {
+      if (value.strict) return {ok: false, error: invalid(command, "--strict must only be supplied once.")};
+      value.strict = true;
+      continue;
+    }
+    if (!["--name","--path",...(command==='app.create'?['--layout']:[])].includes(option)) return {ok: false, error: invalid(command, `Unsupported option: ${option}`)};
+    const key = option.slice(2);
+    const next = args[++index];
+    if (!next || next.startsWith("--")) return {ok: false, error: invalid(command, `${option} requires a value.`)};
+    if (value[key]) return {ok: false, error: invalid(command, `${option} must only be supplied once.`)};
+    value[key] = next;
+  }
+  return {ok: true, value};
+}
+
+function invalid(command, message, nextActions = []) {
+  return failure(command, cliError("INVALID_ARGUMENT", {path: command, message, nextActions}));
+}

package/src/config.js

@@ -56,23 +56,23 @@ export function writeConfigAtomically(path, config, options = {}) {
   }
 }
 
-export function resolveConfig(flags = {}, env = process.env, fileConfig = readConfig()) {
-  const baseUrl = firstNonEmpty(flags.baseUrl, env.FINEBI_BASE_URL, fileConfig.baseUrl);
-  const sameServer = sameBaseUrl(baseUrl, fileConfig.baseUrl);
-  const explicitToken = firstNonEmpty(flags.token, env.FINEBI_AUTH_TOKEN);
-  const savedAuth = sameServer ? fileConfig.auth : undefined;
-  const token = firstNonEmpty(explicitToken, savedAuth?.token, sameServer ? fileConfig.token : undefined);
+export function resolveConfig(flags = {}, env = process.env, fileConfig = readConfig()) {
+  const baseUrl = firstNonEmpty(flags.baseUrl, env.FINEBI_BASE_URL, fileConfig.baseUrl);
+  const sameServer = sameBaseUrl(baseUrl, fileConfig.baseUrl);
+  const explicitToken = firstNonEmpty(flags.token, env.FINEBI_AUTH_TOKEN);
+  const savedAuth = sameServer ? fileConfig.auth : undefined;
+  const token = firstNonEmpty(explicitToken, savedAuth?.token, sameServer ? fileConfig.token : undefined);
   return normalizeConfig({
     ...fileConfig,
-    baseUrl,
+    baseUrl,
     timeoutMs: parsePositiveInt(firstNonEmpty(flags.timeoutMs, env.FINEBI_TIMEOUT_MS), fileConfig.timeoutMs),
     capabilityTtlMs: parsePositiveInt(
       firstNonEmpty(flags.capabilityTtlMs, env.FINEBI_CAPABILITY_TTL_MS),
       fileConfig.capabilityTtlMs,
     ),
     auth: {
-      ...(explicitToken ? {} : savedAuth),
-      token,
+      ...(explicitToken ? {} : savedAuth),
+      token,
     },
   });
 }
@@ -81,10 +81,10 @@ export function updateConfigValue(config, key, value, now = () => new Date().toI
   const next = normalizeConfig(config);
   switch (key) {
     case "base-url":
-      if (next.baseUrl !== value) {
-        next.capabilityCacheInvalidatedAt = now();
-        delete next.auth;
-        delete next.token;
+      if (next.baseUrl !== value) {
+        next.capabilityCacheInvalidatedAt = now();
+        delete next.auth;
+        delete next.token;
       }
       next.baseUrl = value;
       return next;
@@ -128,7 +128,7 @@ function defaultConfig() {
   };
 }
 
-export function normalizeConfig(config) {
+export function normalizeConfig(config) {
   return {
     ...config,
     timeoutMs: parsePositiveInt(config.timeoutMs, DEFAULT_TIMEOUT_MS),
@@ -136,14 +136,14 @@ export function normalizeConfig(config) {
   };
 }
 
-function sanitizeConfig(config) {
-  if (config.schemaVersion === 2) {
-    return {
-      schemaVersion: 2,
-      currentProfile: config.currentProfile,
-      profiles: Object.fromEntries(Object.entries(config.profiles).map(([name, profile]) => [name, sanitizeConfig(normalizeConfig(profile))])),
-    };
-  }
+function sanitizeConfig(config) {
+  if (config.schemaVersion === 2) {
+    return {
+      schemaVersion: 2,
+      currentProfile: config.currentProfile,
+      profiles: Object.fromEntries(Object.entries(config.profiles).map(([name, profile]) => [name, sanitizeConfig(normalizeConfig(profile))])),
+    };
+  }
   const { token: _legacyToken, ...rest } = config;
   const auth = config.auth
     ? {
@@ -166,11 +166,11 @@ function sanitizeConfig(config) {
     ...rest,
     auth,
   };
-}
-
-export function sameBaseUrl(left, right) {
-  return (left || "").replace(/\/+$/, "") === (right || "").replace(/\/+$/, "");
-}
+}
+
+export function sameBaseUrl(left, right) {
+  return (left || "").replace(/\/+$/, "") === (right || "").replace(/\/+$/, "");
+}
 
 function firstNonEmpty(...values) {
   return values.find((value) => typeof value === "string" && value.trim().length > 0)?.trim();