@x12i/catalox-docs 1.1.0

package/README.md

@@ -0,0 +1,31 @@
+# `@x12i/catalox-docs`
+
+Catalox documentation **knowledge SDK**. Install as a **devDependency only** — do not add to production service dependencies.
+
+```bash
+npm i -D @x12i/catalox-docs
+```
+
+```ts
+import { cataloxDocs } from "@x12i/catalox-docs";
+
+cataloxDocs.listUseCases();
+cataloxDocs.getUseCaseMarkdown("orient-catalox");
+cataloxDocs.getBookMarkdown("00-overview", "developers");
+cataloxDocs.listConcepts();
+cataloxDocs.getGuide("embed-catalox");
+cataloxDocs.searchKnowledge("mongo");
+cataloxDocs.manifest();
+```
+
+CLI:
+
+```bash
+npx catalox-docs list-use-cases
+npx catalox-docs use-case orient-catalox > pack.md
+npx catalox-docs book 00-overview developers > book.md
+```
+
+Depends on `@x12i/docify-core` / `@x12i/docify-sdk`. Human UI: build the content library with `npm run docs` from the Catalox repo (`catalox-docs/`). Deployed site: `https://docs.catalox.x12i.com`.
+
+Content lives in `catalox-docs/` (books, concepts/guides/scenarios, `data/*.json`, site-pages). Rebuild the embedded bundle with `npm run docs:build`.

package/bin/catalox-docs.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "../dist/cli.js";

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,56 @@
+#!/usr/bin/env node
+import { cataloxDocs } from "./index.js";
+const [cmd, id, audience] = process.argv.slice(2);
+function usage() {
+    console.error(`Usage:
+  catalox-docs use-case <id>          Print assembled use-case markdown
+  catalox-docs book <id> <audience>   Print book markdown
+  catalox-docs list-use-cases         List use case ids
+  catalox-docs list-books             List book ids
+`);
+}
+if (!cmd || cmd === "help" || cmd === "--help") {
+    usage();
+    process.exit(cmd ? 0 : 1);
+}
+if (cmd === "list-use-cases") {
+    for (const uc of cataloxDocs.listUseCases()) {
+        console.log(`${uc.id}\t${uc.title}`);
+    }
+    process.exit(0);
+}
+if (cmd === "list-books") {
+    for (const b of cataloxDocs.listBooks()) {
+        console.log(`${b.id}\t${b.title}\t${b.audiences.join(",")}`);
+    }
+    process.exit(0);
+}
+if (cmd === "use-case") {
+    if (!id) {
+        usage();
+        process.exit(1);
+    }
+    const md = cataloxDocs.getUseCaseMarkdown(id);
+    if (!md) {
+        console.error(`Unknown use case: ${id}`);
+        process.exit(1);
+    }
+    process.stdout.write(md);
+    process.exit(0);
+}
+if (cmd === "book") {
+    if (!id || !audience) {
+        usage();
+        process.exit(1);
+    }
+    const md = cataloxDocs.getBookMarkdown(id, audience);
+    if (!md) {
+        console.error(`Unknown book/audience: ${id} ${audience}`);
+        process.exit(1);
+    }
+    process.stdout.write(md);
+    process.exit(0);
+}
+usage();
+process.exit(1);
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAElD,SAAS,KAAK;IACZ,OAAO,CAAC,KAAK,CAAC;;;;;CAKf,CAAC,CAAC;AACH,CAAC;AAED,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;IAC/C,KAAK,EAAE,CAAC;IACR,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,IAAI,GAAG,KAAK,gBAAgB,EAAE,CAAC;IAC7B,KAAK,MAAM,EAAE,IAAI,WAAW,CAAC,YAAY,EAAE,EAAE,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,EAAE,EAAE,QAAqC,CAAC,CAAC;IAClF,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,KAAK,EAAE,CAAC;AACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC"}