docspack 0.0.1 → 0.1.0

package/dist/verify.js

@@ -0,0 +1,291 @@
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+import { readBuildConfig } from "./config.js";
+import { discoverPackages, resolvePackageDir } from "./discovery.js";
+import { DocspackError } from "./errors.js";
+import { readExportSurface } from "./exports.js";
+import { chunkId, LLMS_DIR, MANIFEST_FILE, parseManifest } from "./spec.js";
+/** Below this length a name is too generic to reason about. */
+const MIN_SYMBOL = 4;
+/**
+ * Names that appear in documentation everywhere and belong to the language or the platform
+ * rather than to any library.
+ */
+const UNIVERSAL = new Set([
+    "console",
+    "log",
+    "error",
+    "warn",
+    "then",
+    "catch",
+    "finally",
+    "await",
+    "async",
+    "json",
+    "stringify",
+    "parse",
+    "length",
+    "process",
+    "env",
+    "module",
+    "exports",
+    "require",
+    "import",
+    "default",
+    "window",
+    "document",
+    "fetch",
+    "response",
+    "request",
+]);
+/**
+ * Receivers that belong to the language or the runtime. `document.cookie` and `stream.Duplex`
+ * are documentation about the platform, and the library they appear in did not declare them.
+ */
+const PLATFORM = new Set([
+    "array",
+    "buffer",
+    "console",
+    "crypto",
+    "document",
+    "fs",
+    "global",
+    "globalthis",
+    "intl",
+    "json",
+    "math",
+    "navigator",
+    "number",
+    "object",
+    "os",
+    "path",
+    "process",
+    "promise",
+    "reflect",
+    "regexp",
+    "stream",
+    "string",
+    "symbol",
+    "url",
+    "window",
+]);
+/** `wrangler.jsonc` is a filename that survives the entity regex, not a member access. */
+const EXTENSIONS = new Set([
+    "cjs",
+    "css",
+    "html",
+    "js",
+    "json",
+    "jsonc",
+    "lock",
+    "md",
+    "mdx",
+    "mjs",
+    "toml",
+    "ts",
+    "tsx",
+    "txt",
+    "yaml",
+    "yml",
+]);
+/**
+ * Checks the identifiers documentation names against what the documented library declares.
+ *
+ * A finding is only produced when a name is absent *and* a very similar name exists — that is
+ * the signature of a rename. An absent name with nothing like it is far more likely to come
+ * from an example about some other library, so it is counted and ignored rather than reported.
+ * Precision matters more than recall here: a check that cries wolf is worse than no check.
+ */
+export async function verifyProject(options) {
+    const packages = options.packageDir === undefined
+        ? await verifyInstalled(options.cwd)
+        : [await verifyOne(options.cwd, options.packageDir)];
+    return { packages, ok: packages.every((pkg) => pkg.findings.length === 0) };
+}
+async function verifyInstalled(cwd) {
+    const { packages } = await discoverPackages(cwd);
+    const results = [];
+    for (const pkg of packages) {
+        results.push(await verifyPackage(cwd, pkg.id, pkg.dir, pkg.manifest));
+    }
+    return results;
+}
+async function verifyOne(cwd, packageDir) {
+    let manifest;
+    try {
+        const raw = await readFile(join(packageDir, LLMS_DIR, MANIFEST_FILE), "utf8");
+        manifest = parseManifest(JSON.parse(raw), `${LLMS_DIR}/${MANIFEST_FILE}`);
+    }
+    catch {
+        throw new DocspackError(`No ${LLMS_DIR}/${MANIFEST_FILE} in ${packageDir}`, {
+            hint: "Run `docspack build` first.",
+        });
+    }
+    return verifyPackage(cwd, `${manifest.name}@${manifest.version}`, packageDir, manifest);
+}
+async function verifyPackage(cwd, id, packageDir, manifest) {
+    const empty = { id, checked: 0, matched: 0, unrecognised: 0, findings: [] };
+    const { documents } = await readBuildConfig(packageDir);
+    if (documents === undefined) {
+        return {
+            ...empty,
+            status: "skipped",
+            reason: `declares no "docspack.documents", so there is nothing to check against`,
+        };
+    }
+    const libraryDir = (await resolvePackageDir(documents, packageDir)) ?? (await resolvePackageDir(documents, cwd));
+    if (libraryDir === undefined) {
+        return { ...empty, status: "skipped", documents, reason: `${documents} is not installed` };
+    }
+    const surface = await readExportSurface(libraryDir);
+    if (surface === undefined || surface.names.size === 0) {
+        return {
+            ...empty,
+            status: "skipped",
+            documents,
+            reason: `${documents} ships no type declarations to check against`,
+        };
+    }
+    const declared = new Set([...surface.names].map(normalize));
+    const findings = [];
+    let checked = 0;
+    let matched = 0;
+    let unrecognised = 0;
+    for (const chunk of manifest.chunks) {
+        for (const entity of chunk.entities) {
+            const symbol = checkableSymbol(entity);
+            if (symbol === undefined)
+                continue;
+            checked += 1;
+            // Case and leading underscores differ between documentation and declarations often
+            // enough that treating them as drift is wrong.
+            if (declared.has(normalize(symbol))) {
+                matched += 1;
+                continue;
+            }
+            const suggestion = nearestName(symbol, surface);
+            if (suggestion === undefined) {
+                unrecognised += 1;
+                continue;
+            }
+            findings.push({
+                chunkId: chunkId(id, chunk.id),
+                file: chunk.file,
+                entity,
+                symbol,
+                suggestion,
+            });
+        }
+    }
+    return { id, status: "verified", documents, checked, matched, unrecognised, findings };
+}
+/**
+ * The name worth checking in an entity like `client.setKey()`, or nothing when the entity is
+ * not about the library at all: a filename, a platform API, or a name too generic to place.
+ */
+function checkableSymbol(entity) {
+    const parts = entity.replace(/\(\)$/, "").split(".");
+    const symbol = parts[parts.length - 1] ?? entity;
+    const receiver = parts.length > 1 ? (parts[parts.length - 2] ?? "") : "";
+    if (symbol.length < MIN_SYMBOL)
+        return undefined;
+    if (EXTENSIONS.has(symbol.toLowerCase()))
+        return undefined;
+    if (UNIVERSAL.has(symbol.toLowerCase()))
+        return undefined;
+    if (PLATFORM.has(receiver.toLowerCase()))
+        return undefined;
+    return symbol;
+}
+/** Case and leading underscores are styling, not identity, when comparing two names. */
+function normalize(name) {
+    return name.replace(/^_+/, "").toLowerCase();
+}
+/**
+ * The declared name a symbol was most likely renamed from, or nothing if no declared name
+ * resembles it closely enough to say so.
+ *
+ * Two shapes count, and only two. A near-identical spelling of the same leading word, which
+ * catches typos and small edits; and a qualifier inserted between the same first and last word
+ * — `setKey` against `setApiKey` — which is what most real renames look like. Everything else
+ * is left alone. In particular a differing first word is never a match: `includeLanguages` and
+ * `excludeLanguages` are two edits apart and mean opposite things.
+ */
+function nearestName(symbol, surface) {
+    const lower = normalize(symbol);
+    const words = camelWords(symbol);
+    let best;
+    let bestDistance = Number.POSITIVE_INFINITY;
+    for (const candidate of surface.names) {
+        if (candidate.length < MIN_SYMBOL)
+            continue;
+        const candidateWords = camelWords(candidate);
+        if (isRequalified(words, candidateWords))
+            return candidate;
+        if (candidateWords[0] !== words[0])
+            continue;
+        const other = normalize(candidate);
+        if (Math.abs(other.length - lower.length) > 4)
+            continue;
+        const distance = editDistance(lower, other, 3);
+        if (distance < bestDistance) {
+            bestDistance = distance;
+            best = candidate;
+        }
+    }
+    if (best === undefined || bestDistance > 2)
+        return undefined;
+    // A two-character difference between two short names is coincidence more often than a rename.
+    if (bestDistance === 2 && symbol.length < 8)
+        return undefined;
+    return best;
+}
+/** `setApiKey` becomes `["set", "api", "key"]`. */
+function camelWords(name) {
+    return name
+        .replace(/([a-z0-9])([A-Z])/g, "$1 $2")
+        .split(/[\s_$-]+/)
+        .filter((word) => word.length > 0)
+        .map((word) => word.toLowerCase());
+}
+/**
+ * True when the two names are the same multi-word name with a qualifier inserted, in either
+ * direction. Requiring the first and last word to match, and both names to have at least two
+ * words, is what keeps this from firing on every method that happens to start with `get`.
+ */
+function isRequalified(a, b) {
+    const [shorter, longer] = a.length <= b.length ? [a, b] : [b, a];
+    if (shorter.length < 2 || longer.length <= shorter.length)
+        return false;
+    if (shorter[0] !== longer[0])
+        return false;
+    if (shorter[shorter.length - 1] !== longer[longer.length - 1])
+        return false;
+    let index = 0;
+    for (const word of longer) {
+        if (word === shorter[index])
+            index += 1;
+    }
+    return index === shorter.length;
+}
+/** Levenshtein distance, abandoned once it passes `limit`. */
+function editDistance(a, b, limit) {
+    if (Math.abs(a.length - b.length) > limit)
+        return limit + 1;
+    let previous = Array.from({ length: b.length + 1 }, (_, index) => index);
+    for (let i = 1; i <= a.length; i += 1) {
+        const current = [i];
+        let rowBest = i;
+        for (let j = 1; j <= b.length; j += 1) {
+            const cost = a[i - 1] === b[j - 1] ? 0 : 1;
+            const value = Math.min((current[j - 1] ?? 0) + 1, (previous[j] ?? 0) + 1, (previous[j - 1] ?? 0) + cost);
+            current.push(value);
+            rowBest = Math.min(rowBest, value);
+        }
+        if (rowBest > limit)
+            return limit + 1;
+        previous = current;
+    }
+    return previous[b.length] ?? limit + 1;
+}
+//# sourceMappingURL=verify.js.map

package/dist/verify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify.js","sourceRoot":"","sources":["../src/verify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAsB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAwB,aAAa,EAAE,MAAM,WAAW,CAAC;AAyClG,+DAA+D;AAC/D,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB;;;GAGG;AACH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC;IACxB,SAAS;IACT,KAAK;IACL,OAAO;IACP,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,OAAO;IACP,OAAO;IACP,MAAM;IACN,WAAW;IACX,OAAO;IACP,QAAQ;IACR,SAAS;IACT,KAAK;IACL,QAAQ;IACR,SAAS;IACT,SAAS;IACT,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,UAAU;IACV,OAAO;IACP,UAAU;IACV,SAAS;CACV,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACvB,OAAO;IACP,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,UAAU;IACV,IAAI;IACJ,QAAQ;IACR,YAAY;IACZ,MAAM;IACN,MAAM;IACN,MAAM;IACN,WAAW;IACX,QAAQ;IACR,QAAQ;IACR,IAAI;IACJ,MAAM;IACN,SAAS;IACT,SAAS;IACT,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,KAAK;IACL,QAAQ;CACT,CAAC,CAAC;AAEH,0FAA0F;AAC1F,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC;IACzB,KAAK;IACL,KAAK;IACL,MAAM;IACN,IAAI;IACJ,MAAM;IACN,OAAO;IACP,MAAM;IACN,IAAI;IACJ,KAAK;IACL,KAAK;IACL,MAAM;IACN,IAAI;IACJ,KAAK;IACL,KAAK;IACL,MAAM;IACN,KAAK;CACN,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAsB;IACxD,MAAM,QAAQ,GACZ,OAAO,CAAC,UAAU,KAAK,SAAS;QAC9B,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC;QACpC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAEzD,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;AAC9E,CAAC;AAED,KAAK,UAAU,eAAe,CAAC,GAAW;IACxC,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACjD,MAAM,OAAO,GAAsB,EAAE,CAAC;IAEtC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,MAAM,aAAa,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,GAAW,EAAE,UAAkB;IACtD,IAAI,QAAyB,CAAC;IAC9B,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;QAC9E,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,aAAa,CAAC,MAAM,QAAQ,IAAI,aAAa,OAAO,UAAU,EAAE,EAAE;YAC1E,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,aAAa,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;AAC1F,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,GAAW,EACX,EAAU,EACV,UAAkB,EAClB,QAAyB;IAEzB,MAAM,KAAK,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAE5E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,eAAe,CAAC,UAAU,CAAC,CAAC;IACxD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO;YACL,GAAG,KAAK;YACR,MAAM,EAAE,SAAS;YACjB,MAAM,EAAE,wEAAwE;SACjF,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GACd,CAAC,MAAM,iBAAiB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,iBAAiB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;IAChG,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,SAAS,mBAAmB,EAAE,CAAC;IAC7F,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACpD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACtD,OAAO;YACL,GAAG,KAAK;YACR,MAAM,EAAE,SAAS;YACjB,SAAS;YACT,MAAM,EAAE,GAAG,SAAS,8CAA8C;SACnE,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACpC,MAAM,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,MAAM,KAAK,SAAS;gBAAE,SAAS;YAEnC,OAAO,IAAI,CAAC,CAAC;YACb,mFAAmF;YACnF,+CAA+C;YAC/C,IAAI,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC,CAAC;gBACb,SAAS;YACX,CAAC;YAED,MAAM,UAAU,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAChD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,YAAY,IAAI,CAAC,CAAC;gBAClB,SAAS;YACX,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC;gBACZ,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC9B,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,MAAM;gBACN,MAAM;gBACN,UAAU;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;AACzF,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,MAAc;IACrC,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,MAAM,CAAC;IACjD,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEzE,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU;QAAE,OAAO,SAAS,CAAC;IACjD,IAAI,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IAC3D,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1D,IAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAAE,OAAO,SAAS,CAAC;IAC3D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,wFAAwF;AACxF,SAAS,SAAS,CAAC,IAAY;IAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/C,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,WAAW,CAAC,MAAc,EAAE,OAAsB;IACzD,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,IAAI,IAAwB,CAAC;IAC7B,IAAI,YAAY,GAAG,MAAM,CAAC,iBAAiB,CAAC;IAE5C,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACtC,IAAI,SAAS,CAAC,MAAM,GAAG,UAAU;YAAE,SAAS;QAC5C,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,aAAa,CAAC,KAAK,EAAE,cAAc,CAAC;YAAE,OAAO,SAAS,CAAC;QAE3D,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC;YAAE,SAAS;QAC7C,MAAM,KAAK,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC;YAAE,SAAS;QAExD,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/C,IAAI,QAAQ,GAAG,YAAY,EAAE,CAAC;YAC5B,YAAY,GAAG,QAAQ,CAAC;YACxB,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,IAAI,IAAI,KAAK,SAAS,IAAI,YAAY,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC7D,8FAA8F;IAC9F,IAAI,YAAY,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,mDAAmD;AACnD,SAAS,UAAU,CAAC,IAAY;IAC9B,OAAO,IAAI;SACR,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,KAAK,CAAC,UAAU,CAAC;SACjB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;;;GAIG;AACH,SAAS,aAAa,CAAC,CAAoB,EAAE,CAAoB;IAC/D,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxE,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAC3C,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAE5E,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,IAAI,KAAK,OAAO,CAAC,KAAK,CAAC;YAAE,KAAK,IAAI,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC;AAClC,CAAC;AAED,8DAA8D;AAC9D,SAAS,YAAY,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa;IACvD,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,KAAK;QAAE,OAAO,KAAK,GAAG,CAAC,CAAC;IAE5D,IAAI,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;IACzE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CACpB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EACzB,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EACtB,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAC9B,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,OAAO,GAAG,KAAK;YAAE,OAAO,KAAK,GAAG,CAAC,CAAC;QACtC,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IACD,OAAO,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AACzC,CAAC"}

package/package.json

@@ -1,9 +1,64 @@
 {
   "name": "docspack",
-  "version": "0.0.1",
-  "description": "Local, version-locked AI documentation package manager. (Work in progress)",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "Local, version-locked documentation packages for AI agents, indexed in SQLite and served over MCP.",
+  "keywords": [
+    "ai",
+    "agents",
+    "mcp",
+    "documentation",
+    "docs",
+    "llms.txt",
+    "sqlite",
+    "fts5",
+    "context",
+    "cli"
+  ],
+  "homepage": "https://github.com/docspack/docspack#readme",
+  "bugs": "https://github.com/docspack/docspack/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/docspack/docspack.git",
+    "directory": "packages/docspack"
+  },
+  "license": "MIT",
+  "type": "module",
   "bin": {
-    "docspack": "./bin/cli.js"
+    "docspack": "./bin/docspack.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "bin",
+    "dist",
+    "README.md",
+    "src"
+  ],
+  "engines": {
+    "node": ">=22.5.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "1.30.0",
+    "turndown": "7.2.4",
+    "zod": "4.4.3",
+    "@docspack/registry": "^0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "26.2.0",
+    "@types/turndown": "5.0.6",
+    "typescript": "6.0.3",
+    "vitest": "4.1.10",
+    "@docspack/config": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check-types": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json",
+    "test": "vitest run"
   }
-}
+}