@x12i/docify-sdk 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# @x12i/docify-sdk
+
+`createEbooksSdk(bundle)` — query catalog, use cases, and embedded markdown. Product packages wire a Memorix (or other) content bundle and publish as a **devDependency** knowledge SDK.

package/dist/create-sdk.d.ts

@@ -0,0 +1,36 @@
+import type { AgentManifest, Audience, Book, Catalog, ChapterEntry, SiteConfig, UseCase, UseCasesFile } from "@x12i/docify-core";
+export type EbooksBundle = {
+    catalog: Catalog;
+    useCases: UseCasesFile;
+    site: SiteConfig;
+    manifest: AgentManifest;
+    /** Relative path → markdown/string content embedded in the knowledge package. */
+    files: Record<string, string>;
+};
+export type ListUseCasesFilter = {
+    audience?: Audience;
+    tag?: string;
+    q?: string;
+};
+export type EbooksSdk = {
+    catalog: Catalog;
+    useCases: UseCase[];
+    site: SiteConfig;
+    listUseCases(filter?: ListUseCasesFilter): UseCase[];
+    getUseCase(id: string): UseCase | undefined;
+    getUseCaseMarkdown(id: string): string | undefined;
+    listBooks(filter?: {
+        audience?: Audience;
+    }): Book[];
+    getBook(id: string): Book | undefined;
+    getBookMarkdown(bookId: string, audience: Audience): string | undefined;
+    getChapterIndex(bookId: string, audience: Audience): ChapterEntry[] | undefined;
+    getChapterMarkdown(bookId: string, audience: Audience, chapterSlug: string): string | undefined;
+    search(query: string): {
+        useCases: UseCase[];
+        books: Book[];
+    };
+    manifest(): AgentManifest;
+};
+export declare function createEbooksSdk(bundle: EbooksBundle): EbooksSdk;
+//# sourceMappingURL=create-sdk.d.ts.map

package/dist/create-sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-sdk.d.ts","sourceRoot":"","sources":["../src/create-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,UAAU,EACV,OAAO,EACP,YAAY,EACb,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,YAAY,CAAC;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,iFAAiF;IACjF,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,IAAI,EAAE,UAAU,CAAC;IACjB,YAAY,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,EAAE,CAAC;IACrD,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IAC5C,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IACnD,SAAS,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,IAAI,EAAE,CAAC;IACpD,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;IACxE,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,YAAY,EAAE,GAAG,SAAS,CAAC;IAChF,kBAAkB,CAChB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,MAAM,GAClB,MAAM,GAAG,SAAS,CAAC;IACtB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;QAAC,KAAK,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAC9D,QAAQ,IAAI,aAAa,CAAC;CAC3B,CAAC;AAMF,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAgG/D"}

package/dist/create-sdk.js

@@ -0,0 +1,94 @@
+function matchQ(hay, q) {
+    return hay.toLowerCase().includes(q.toLowerCase());
+}
+export function createEbooksSdk(bundle) {
+    const useCases = bundle.useCases.useCases;
+    const books = bundle.catalog.books;
+    const file = (rel) => rel ? bundle.files[rel] ?? bundle.files[`/${rel}`] : undefined;
+    return {
+        catalog: bundle.catalog,
+        useCases,
+        site: bundle.site,
+        listUseCases(filter = {}) {
+            return useCases.filter((uc) => {
+                if (filter.audience && !uc.audiences.includes(filter.audience))
+                    return false;
+                if (filter.tag && !uc.tags.includes(filter.tag))
+                    return false;
+                if (filter.q) {
+                    const blob = `${uc.id} ${uc.title} ${uc.goal} ${uc.tags.join(" ")}`;
+                    if (!matchQ(blob, filter.q))
+                        return false;
+                }
+                return true;
+            });
+        },
+        getUseCase(id) {
+            return useCases.find((u) => u.id === id);
+        },
+        getUseCaseMarkdown(id) {
+            const entry = bundle.manifest.useCases.find((u) => u.id === id);
+            return file(entry?.md);
+        },
+        listBooks(filter = {}) {
+            return books.filter((b) => {
+                if (filter.audience && !b.audiences.includes(filter.audience))
+                    return false;
+                return true;
+            });
+        },
+        getBook(id) {
+            return books.find((b) => b.id === id);
+        },
+        getBookMarkdown(bookId, audience) {
+            const entry = bundle.manifest.books.find((b) => b.id === bookId);
+            return file(entry?.md[audience]);
+        },
+        getChapterIndex(bookId, audience) {
+            const entry = bundle.manifest.books.find((b) => b.id === bookId);
+            const raw = file(entry?.chapters[audience]);
+            if (!raw)
+                return undefined;
+            return JSON.parse(raw);
+        },
+        getChapterMarkdown(bookId, audience, chapterSlug) {
+            const md = this.getBookMarkdown(bookId, audience);
+            if (!md)
+                return undefined;
+            const lines = md.replace(/\r\n/g, "\n").split("\n");
+            let capturing = false;
+            const out = [];
+            let currentSlug = "";
+            // lazy import-free slugify inline
+            const slugify = (s) => s
+                .toLowerCase()
+                .replace(/[^a-z0-9]+/g, "-")
+                .replace(/^-+|-+$/g, "");
+            for (const line of lines) {
+                const m = /^##\s+(.+?)\s*$/.exec(line);
+                if (m) {
+                    currentSlug = slugify(m[1]);
+                    capturing = currentSlug === chapterSlug;
+                    if (capturing)
+                        continue;
+                    if (out.length)
+                        break;
+                    continue;
+                }
+                if (capturing)
+                    out.push(line);
+            }
+            return out.length ? out.join("\n").trim() : undefined;
+        },
+        search(query) {
+            return {
+                useCases: this.listUseCases({ q: query }),
+                books: books.filter((b) => matchQ(`${b.id} ${b.title} ${b.blurb} ${b.tags.join(" ")}`, query)),
+            };
+        },
+        manifest() {
+            return bundle.manifest;
+        },
+    };
+}
+//# sourceMappingURL=create-sdk.js.map

package/dist/create-sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-sdk.js","sourceRoot":"","sources":["../src/create-sdk.ts"],"names":[],"mappings":"AA8CA,SAAS,MAAM,CAAC,GAAW,EAAE,CAAS;IACpC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAoB;IAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAEnC,MAAM,IAAI,GAAG,CAAC,GAAuB,EAAE,EAAE,CACvC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAEjE,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ;QACR,IAAI,EAAE,MAAM,CAAC,IAAI;QAEjB,YAAY,CAAC,MAAM,GAAG,EAAE;YACtB,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE;gBAC5B,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAC7E,IAAI,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAC9D,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC;oBACb,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;wBAAE,OAAO,KAAK,CAAC;gBAC5C,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC;QAED,UAAU,CAAC,EAAE;YACX,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3C,CAAC;QAED,kBAAkB,CAAC,EAAE;YACnB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YAChE,OAAO,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACzB,CAAC;QAED,SAAS,CAAC,MAAM,GAAG,EAAE;YACnB,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;gBACxB,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAAE,OAAO,KAAK,CAAC;gBAC5E,OAAO,IAAI,CAAC;YACd,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,CAAC,EAAE;YACR,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACxC,CAAC;QAED,eAAe,CAAC,MAAM,EAAE,QAAQ;YAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;YACjE,OAAO,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,CAAC;QAED,eAAe,CAAC,MAAM,EAAE,QAAQ;YAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;YACjE,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5C,IAAI,CAAC,GAAG;gBAAE,OAAO,SAAS,CAAC;YAC3B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAmB,CAAC;QAC3C,CAAC;QAED,kBAAkB,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW;YAC9C,MAAM,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAClD,IAAI,CAAC,EAAE;gBAAE,OAAO,SAAS,CAAC;YAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACpD,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,MAAM,GAAG,GAAa,EAAE,CAAC;YACzB,IAAI,WAAW,GAAG,EAAE,CAAC;YACrB,kCAAkC;YAClC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,EAAE,CAC5B,CAAC;iBACE,WAAW,EAAE;iBACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;iBAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvC,IAAI,CAAC,EAAE,CAAC;oBACN,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC5B,SAAS,GAAG,WAAW,KAAK,WAAW,CAAC;oBACxC,IAAI,SAAS;wBAAE,SAAS;oBACxB,IAAI,GAAG,CAAC,MAAM;wBAAE,MAAM;oBACtB,SAAS;gBACX,CAAC;gBACD,IAAI,SAAS;oBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;YACD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACxD,CAAC;QAED,MAAM,CAAC,KAAK;YACV,OAAO;gBACL,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC;gBACzC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CACxB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CACnE;aACF,CAAC;QACJ,CAAC;QAED,QAAQ;YACN,OAAO,MAAM,CAAC,QAAQ,CAAC;QACzB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createEbooksSdk, createEbooksSdk as createDocifySdk, type EbooksBundle, type EbooksBundle as DocifyBundle, type EbooksSdk, type EbooksSdk as DocifySdk, type ListUseCasesFilter, } from "./create-sdk.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,IAAI,eAAe,EAClC,KAAK,YAAY,EACjB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,SAAS,EACd,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,kBAAkB,GACxB,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createEbooksSdk, createEbooksSdk as createDocifySdk, } from "./create-sdk.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,eAAe,IAAI,eAAe,GAMnC,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@x12i/docify-sdk",
+  "version": "1.0.0",
+  "description": "createDocifySdk(bundle) \u2014 knowledge SDK factory for x12i docify products.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@x12i/docify-core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "license": "exellix-license"
+}