@openpkg-ts/cli 0.6.0 → 0.6.2

package/dist/bin/openpkg.js

@@ -9,7 +9,7 @@ import { Command as Command12 } from "commander";
 // package.json
 var package_default = {
   name: "@openpkg-ts/cli",
-  version: "0.6.0",
+  version: "0.6.2",
   description: "CLI for OpenPkg TypeScript API extraction and documentation generation",
   homepage: "https://github.com/ryanwaits/openpkg-ts#readme",
   repository: {
@@ -32,14 +32,14 @@ var package_default = {
     test: "bun test"
   },
   dependencies: {
-    "@openpkg-ts/adapters": "^0.3.3",
-    "@openpkg-ts/sdk": "^0.34.0",
+    "@openpkg-ts/adapters": "^0.3.5",
+    "@openpkg-ts/sdk": "^0.35.0",
     commander: "^14.0.0"
   },
   devDependencies: {
     "@types/bun": "latest",
     "@types/node": "^20.0.0",
-    bunup: "latest"
+    bunup: "^0.16.20"
   },
   publishConfig: {
     access: "public"
@@ -344,11 +344,15 @@ import * as path5 from "node:path";
 import { loadSpec as loadSpec4, query, toReact } from "@openpkg-ts/sdk";
 import { Command as Command5 } from "commander";
 async function readStdin() {
-  const chunks = [];
-  for await (const chunk of process.stdin) {
-    chunks.push(chunk);
+  try {
+    const chunks = [];
+    for await (const chunk of process.stdin) {
+      chunks.push(chunk);
+    }
+    return Buffer.concat(chunks).toString("utf-8");
+  } catch (err) {
+    throw new Error(`stdin read failed: ${err instanceof Error ? err.message : String(err)}`);
   }
-  return Buffer.concat(chunks).toString("utf-8");
 }
 function getExtension(format) {
   switch (format) {
@@ -362,14 +366,33 @@ function getExtension(format) {
       return ".md";
   }
 }
+var VALID_KINDS = [
+  "function",
+  "class",
+  "variable",
+  "interface",
+  "type",
+  "enum",
+  "module",
+  "namespace",
+  "reference",
+  "external"
+];
 function applyFilters(spec, options) {
   let qb = query(spec);
   if (options.kind) {
-    const kinds = options.kind.split(",").map((k) => k.trim());
+    const kinds = options.kind.split(",").map((k) => k.trim()).filter(Boolean);
+    const invalid = kinds.filter((k) => !VALID_KINDS.includes(k));
+    if (invalid.length) {
+      throw new Error(`Invalid kind(s): ${invalid.join(", ")}. Valid: ${VALID_KINDS.join(", ")}`);
+    }
     qb = qb.byKind(...kinds);
   }
   if (options.tag) {
-    const tags = options.tag.split(",").map((t) => t.trim());
+    const tags = options.tag.split(",").map((t) => t.trim()).filter(Boolean);
+    if (tags.length === 0) {
+      throw new Error("--tag requires at least one non-empty tag");
+    }
     qb = qb.byTag(...tags);
   }
   if (options.search) {
@@ -414,6 +437,13 @@ function createGenerateCommand() {
   return new Command5("generate").description("Generate documentation from OpenPkg spec").argument("<spec>", "Path to openpkg.json spec file (use - for stdin)").option("-o, --output <path>", "Output file or directory (default: stdout)").option("-f, --format <format>", "Output format: md, json, html, react (default: md)", "md").option("--split", "Output one file per export (requires --output as directory)").option("-e, --export <name>", "Generate docs for a single export by name").option("-a, --adapter <name>", "Use adapter for generation (default: raw)").option("--collapse-unions <n>", "Collapse unions with more than N members").option("-k, --kind <kinds>", "Filter by kind(s), comma-separated").option("-t, --tag <tags>", "Filter by tag(s), comma-separated").option("-s, --search <term>", "Search name and description").option("--deprecated", "Only include deprecated exports").option("--no-deprecated", "Exclude deprecated exports").option("--variant <variant>", "React layout variant: full (single page) or index (links)", "full").option("--components-path <path>", "React components import path", "@/components/api").action(async (specPath, options) => {
     const format = options.format || "md";
     try {
+      if (options.collapseUnions) {
+        const n = parseInt(options.collapseUnions, 10);
+        if (Number.isNaN(n) || n < 1) {
+          console.error(JSON.stringify({ error: "--collapse-unions must be a positive integer" }));
+          process.exit(1);
+        }
+      }
       if (options.adapter && options.adapter !== "raw") {
         let getAdapter;
         try {
@@ -436,14 +466,24 @@ function createGenerateCommand() {
         let spec2;
         if (specPath === "-") {
           const input = await readStdin();
-          spec2 = JSON.parse(input);
+          try {
+            spec2 = JSON.parse(input);
+          } catch (err) {
+            const msg = err instanceof SyntaxError ? err.message : String(err);
+            throw new Error(`Invalid JSON in stdin: ${msg}`);
+          }
         } else {
           const specFile = path5.resolve(specPath);
           if (!fs5.existsSync(specFile)) {
             console.error(JSON.stringify({ error: `Spec file not found: ${specFile}` }));
             process.exit(1);
           }
-          spec2 = JSON.parse(fs5.readFileSync(specFile, "utf-8"));
+          try {
+            spec2 = JSON.parse(fs5.readFileSync(specFile, "utf-8"));
+          } catch (err) {
+            const msg = err instanceof SyntaxError ? err.message : String(err);
+            throw new Error(`Invalid JSON in ${specPath}: ${msg}`);
+          }
         }
         spec2 = applyFilters(spec2, options);
         await adapter.generate(spec2, path5.resolve(options.output));
@@ -453,14 +493,24 @@ function createGenerateCommand() {
       let spec;
       if (specPath === "-") {
         const input = await readStdin();
-        spec = JSON.parse(input);
+        try {
+          spec = JSON.parse(input);
+        } catch (err) {
+          const msg = err instanceof SyntaxError ? err.message : String(err);
+          throw new Error(`Invalid JSON in stdin: ${msg}`);
+        }
       } else {
         const specFile = path5.resolve(specPath);
         if (!fs5.existsSync(specFile)) {
           console.error(JSON.stringify({ error: `Spec file not found: ${specFile}` }));
           process.exit(1);
         }
-        spec = JSON.parse(fs5.readFileSync(specFile, "utf-8"));
+        try {
+          spec = JSON.parse(fs5.readFileSync(specFile, "utf-8"));
+        } catch (err) {
+          const msg = err instanceof SyntaxError ? err.message : String(err);
+          throw new Error(`Invalid JSON in ${specPath}: ${msg}`);
+        }
       }
       spec = applyFilters(spec, options);
       const docs = loadSpec4(spec);
@@ -511,8 +561,14 @@ Next: Add components with 'openpkg docs add function-section'`);
         }
         const exports = docs.getAllExports();
         for (const exp of exports) {
-          const filename = `${exp.name}${getExtension(format)}`;
+          const filename = path5.basename(`${exp.name}${getExtension(format)}`);
           const filePath = path5.join(outDir, filename);
+          const resolvedPath = path5.resolve(filePath);
+          const resolvedOutDir = path5.resolve(outDir);
+          if (!resolvedPath.startsWith(resolvedOutDir + path5.sep)) {
+            console.error(JSON.stringify({ error: `Path traversal detected: ${exp.name}` }));
+            process.exit(1);
+          }
           const content = renderExport(docs, exp.id, format, collapseUnionThreshold);
           fs5.writeFileSync(filePath, content);
         }
@@ -545,7 +601,11 @@ function loadComponentsJson() {
   const configPath = path6.resolve(COMPONENTS_JSON);
   if (!fs6.existsSync(configPath))
     return null;
-  return JSON.parse(fs6.readFileSync(configPath, "utf-8"));
+  try {
+    return JSON.parse(fs6.readFileSync(configPath, "utf-8"));
+  } catch {
+    return null;
+  }
 }
 function createInitCommand() {
   return new Command6("init").description("Add @openpkg registry to components.json for shadcn CLI").option("--registry <url>", "Custom registry URL", REGISTRY_URL).action(async (options) => {
@@ -673,7 +733,7 @@ import {
 } from "@openpkg-ts/sdk";
 import { getValidationErrors } from "@openpkg-ts/spec";
 import { Command as Command11 } from "commander";
-var VALID_KINDS = [
+var VALID_KINDS2 = [
   "function",
   "class",
   "variable",
@@ -687,8 +747,24 @@ var VALID_KINDS = [
 ];
 function loadSpec6(filePath) {
   const resolved = path8.resolve(filePath);
-  const content = fs8.readFileSync(resolved, "utf-8");
-  return JSON.parse(content);
+  let content;
+  let spec;
+  try {
+    content = fs8.readFileSync(resolved, "utf-8");
+  } catch (err) {
+    throw new Error(`Failed to read spec file: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  try {
+    spec = JSON.parse(content);
+  } catch (err) {
+    throw new Error(`Invalid JSON in spec file: ${err instanceof Error ? err.message : String(err)}`);
+  }
+  const errors = getValidationErrors(spec);
+  if (errors.length > 0) {
+    const details = errors.slice(0, 5).map((e) => `${e.instancePath || "/"}: ${e.message}`).join("; ");
+    throw new Error(`Invalid OpenPkg spec: ${details}`);
+  }
+  return spec;
 }
 function parseList(val) {
   if (!val)
@@ -696,9 +772,9 @@ function parseList(val) {
   return val.split(",").map((s) => s.trim()).filter(Boolean);
 }
 function validateKinds(kinds) {
-  const invalid = kinds.filter((k) => !VALID_KINDS.includes(k));
+  const invalid = kinds.filter((k) => !VALID_KINDS2.includes(k));
   if (invalid.length > 0) {
-    throw new Error(`Invalid kind(s): ${invalid.join(", ")}. Valid kinds: ${VALID_KINDS.join(", ")}`);
+    throw new Error(`Invalid kind(s): ${invalid.join(", ")}. Valid kinds: ${VALID_KINDS2.join(", ")}`);
   }
   return kinds;
 }
@@ -712,7 +788,7 @@ function formatDiagnostics(diagnostics) {
   }));
 }
 function createSnapshotSubcommand() {
-  return new Command11("snapshot").description("Generate full OpenPkg spec from TypeScript entry point").argument("<entry>", "Entry point file path").option("-o, --output <file>", "Output file (default: openpkg.json)", "openpkg.json").option("--max-depth <n>", "Max type depth (default: 4)", "4").option("--skip-resolve", "Skip external type resolution").option("--runtime", "Enable Standard Schema runtime extraction").option("--only <exports>", "Filter exports (comma-separated)").option("--ignore <exports>", "Ignore exports (comma-separated)").option("--verify", "Exit 1 if any exports fail").option("--verbose", "Show detailed output").option("--include-private", "Include private/protected class members").option("--external-include <patterns...>", "Resolve re-exports from these packages").option("--external-exclude <patterns...>", "Never resolve from these packages").option("--external-depth <n>", "Max transitive depth for external resolution", "1").action(async (entry, options) => {
+  return new Command11("snapshot").description("Generate full OpenPkg spec from TypeScript entry point").argument("<entry>", "Entry point file path").option("-o, --output <file>", "Output file (default: openpkg.json)", "openpkg.json").option("--max-depth <n>", "Max type depth (default: 4)", "4").option("--skip-resolve", "Skip external type resolution").option("--runtime", "Enable Standard Schema runtime extraction").option("--only <exports>", "Filter exports (comma-separated)").option("--ignore <exports>", "Ignore exports (comma-separated)").option("--verify", "Exit 1 if any exports fail").option("--verbose", "Show detailed output").option("--quiet", "Suppress extraction warnings").option("--strict", "Exit 1 if any extraction warnings").option("--include-private", "Include private/protected class members").option("--external-include <patterns...>", "Resolve re-exports from these packages").option("--external-exclude <patterns...>", "Never resolve from these packages").option("--external-depth <n>", "Max transitive depth for external resolution", "1").action(async (entry, options) => {
     const entryFile = path8.resolve(entry);
     const entryDir = path8.dirname(entryFile);
     const fileConfig = loadConfig(entryDir);
@@ -755,6 +831,21 @@ function createSnapshotSubcommand() {
         ...externalExports.length > 0 && { external: { count: externalExports.length } }
       };
       console.error(JSON.stringify(summary, null, 2));
+      const extractionWarnings = result.runtimeSchemas?.warnings ?? [];
+      if (extractionWarnings.length > 0 && !options.quiet) {
+        console.error(`
+Skipped ${extractionWarnings.length} schema(s) with extraction errors:`);
+        for (const w of extractionWarnings) {
+          console.error(`  - ${w.exportName ?? "unknown"}: ${w.code} - ${w.message}`);
+        }
+      }
+      if (options.strict && extractionWarnings.length > 0) {
+        console.error(JSON.stringify({
+          error: "Extraction warnings present (--strict mode)",
+          warnings: extractionWarnings
+        }, null, 2));
+        process.exit(1);
+      }
       if (options.verify && result.verification && result.verification.failed > 0) {
         console.error(JSON.stringify({
           error: "Export verification failed",
@@ -940,34 +1031,26 @@ program.addCommand(createBreakingCommand());
 program.addCommand(createChangelogCommand());
 program.addCommand(createSemverCommand());
 var specCmd = program.commands.find((c) => c.name() === "spec");
-var snapshotAlias = new Command12("snapshot").description("(alias) → openpkg spec snapshot").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "snapshot").parseAsync(args, { from: "user" });
-});
-program.addCommand(snapshotAlias);
-var listAlias = new Command12("list").description("(alias) → openpkg spec list").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "list").parseAsync(args, { from: "user" });
-});
-program.addCommand(listAlias);
-var getAlias = new Command12("get").description("(alias) → openpkg spec get").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "get").parseAsync(args, { from: "user" });
-});
-program.addCommand(getAlias);
-var validateAlias = new Command12("validate").description("(alias) → openpkg spec validate").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "validate").parseAsync(args, { from: "user" });
-});
-program.addCommand(validateAlias);
-var filterAlias = new Command12("filter").description("(alias) → openpkg spec filter").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "filter").parseAsync(args, { from: "user" });
-});
-program.addCommand(filterAlias);
-var diagnosticsAlias = new Command12("diagnostics").description("(alias) → openpkg spec lint").allowUnknownOption().allowExcessArguments().action(async () => {
-  const args = process.argv.slice(3);
-  await specCmd.commands.find((c) => c.name() === "lint").parseAsync(args, { from: "user" });
-});
-program.addCommand(diagnosticsAlias);
+if (!specCmd) {
+  throw new Error("Internal error: spec command not found");
+}
+function getSubcommand(parent, name) {
+  const cmd = parent.commands.find((c) => c.name() === name);
+  if (!cmd) {
+    throw new Error(`Internal error: ${name} subcommand not found`);
+  }
+  return cmd;
+}
+function createAlias(aliasName, targetName, description) {
+  return new Command12(aliasName).description(description).allowUnknownOption().allowExcessArguments().action(async () => {
+    const args = process.argv.slice(3);
+    await getSubcommand(specCmd, targetName).parseAsync(args, { from: "user" });
+  });
+}
+program.addCommand(createAlias("snapshot", "snapshot", "(alias) → openpkg spec snapshot"));
+program.addCommand(createAlias("list", "list", "(alias) → openpkg spec list"));
+program.addCommand(createAlias("get", "get", "(alias) → openpkg spec get"));
+program.addCommand(createAlias("validate", "validate", "(alias) → openpkg spec validate"));
+program.addCommand(createAlias("filter", "filter", "(alias) → openpkg spec filter"));
+program.addCommand(createAlias("diagnostics", "lint", "(alias) → openpkg spec lint"));
 program.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/cli",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "description": "CLI for OpenPkg TypeScript API extraction and documentation generation",
   "homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
   "repository": {
@@ -23,14 +23,14 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@openpkg-ts/adapters": "^0.3.3",
-    "@openpkg-ts/sdk": "^0.34.0",
+    "@openpkg-ts/adapters": "^0.3.5",
+    "@openpkg-ts/sdk": "^0.35.0",
     "commander": "^14.0.0"
   },
   "devDependencies": {
     "@types/bun": "latest",
     "@types/node": "^20.0.0",
-    "bunup": "latest"
+    "bunup": "^0.16.20"
   },
   "publishConfig": {
     "access": "public"