@mdfn/searchfn 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# `@mdfn/searchfn`
+
+Converts the canonical render/extraction model into stable records suitable for SearchFn indexing.

package/dist/index.cjs

@@ -0,0 +1,43 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  MDFN_SEARCHFN_VERSION: () => MDFN_SEARCHFN_VERSION,
+  createSearchRecords: () => createSearchRecords
+});
+module.exports = __toCommonJS(index_exports);
+var import_render = require("@mdfn/render");
+function createSearchRecords(documentId, document, maxChunkLength = 1600) {
+  const extracted = (0, import_render.extractDocument)(document, { maxChunkLength });
+  const links = extracted.links.map((link) => link.url);
+  const namespace = `${documentId.length}:${documentId}`;
+  return [
+    { id: `document:${namespace}`, documentId, kind: "document", ordinal: 0, text: extracted.plainText, headings: extracted.headings.map((heading) => heading.text), links },
+    ...extracted.chunks.map((chunk, index) => ({ id: `chunk:${namespace}:${index}`, documentId, kind: "chunk", ordinal: index, text: chunk.text, headings: chunk.headingPath, links: chunk.links.map((link) => link.url) }))
+  ];
+}
+var MDFN_SEARCHFN_VERSION = "0.1.0";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MDFN_SEARCHFN_VERSION,
+  createSearchRecords
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { MdfnDocument } from \"@mdfn/core\";\nimport { extractDocument } from \"@mdfn/render\";\n\nexport interface MdfnSearchRecord {\n  readonly id: string;\n  readonly documentId: string;\n  readonly kind: \"document\" | \"chunk\";\n  readonly ordinal: number;\n  readonly text: string;\n  readonly headings: readonly string[];\n  readonly links: readonly string[];\n}\n\nexport function createSearchRecords(documentId: string, document: MdfnDocument, maxChunkLength = 1600): readonly MdfnSearchRecord[] {\n  const extracted = extractDocument(document, { maxChunkLength });\n  const links = extracted.links.map((link) => link.url);\n  const namespace = `${documentId.length}:${documentId}`;\n  return [\n    { id: `document:${namespace}`, documentId, kind: \"document\", ordinal: 0, text: extracted.plainText, headings: extracted.headings.map((heading) => heading.text), links },\n    ...extracted.chunks.map((chunk, index) => ({ id: `chunk:${namespace}:${index}`, documentId, kind: \"chunk\" as const, ordinal: index, text: chunk.text, headings: chunk.headingPath, links: chunk.links.map((link) => link.url) })),\n  ];\n}\n\nexport const MDFN_SEARCHFN_VERSION = \"0.1.0\" as const;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,oBAAgC;AAYzB,SAAS,oBAAoB,YAAoB,UAAwB,iBAAiB,MAAmC;AAClI,QAAM,gBAAY,+BAAgB,UAAU,EAAE,eAAe,CAAC;AAC9D,QAAM,QAAQ,UAAU,MAAM,IAAI,CAAC,SAAS,KAAK,GAAG;AACpD,QAAM,YAAY,GAAG,WAAW,MAAM,IAAI,UAAU;AACpD,SAAO;AAAA,IACL,EAAE,IAAI,YAAY,SAAS,IAAI,YAAY,MAAM,YAAY,SAAS,GAAG,MAAM,UAAU,WAAW,UAAU,UAAU,SAAS,IAAI,CAAC,YAAY,QAAQ,IAAI,GAAG,MAAM;AAAA,IACvK,GAAG,UAAU,OAAO,IAAI,CAAC,OAAO,WAAW,EAAE,IAAI,SAAS,SAAS,IAAI,KAAK,IAAI,YAAY,MAAM,SAAkB,SAAS,OAAO,MAAM,MAAM,MAAM,UAAU,MAAM,aAAa,OAAO,MAAM,MAAM,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,EAAE;AAAA,EAClO;AACF;AAEO,IAAM,wBAAwB;","names":[]}

package/dist/index.d.cts

@@ -0,0 +1,15 @@
+import { MdfnDocument } from '@mdfn/core';
+
+interface MdfnSearchRecord {
+    readonly id: string;
+    readonly documentId: string;
+    readonly kind: "document" | "chunk";
+    readonly ordinal: number;
+    readonly text: string;
+    readonly headings: readonly string[];
+    readonly links: readonly string[];
+}
+declare function createSearchRecords(documentId: string, document: MdfnDocument, maxChunkLength?: number): readonly MdfnSearchRecord[];
+declare const MDFN_SEARCHFN_VERSION: "0.1.0";
+
+export { MDFN_SEARCHFN_VERSION, type MdfnSearchRecord, createSearchRecords };

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { MdfnDocument } from '@mdfn/core';
+
+interface MdfnSearchRecord {
+    readonly id: string;
+    readonly documentId: string;
+    readonly kind: "document" | "chunk";
+    readonly ordinal: number;
+    readonly text: string;
+    readonly headings: readonly string[];
+    readonly links: readonly string[];
+}
+declare function createSearchRecords(documentId: string, document: MdfnDocument, maxChunkLength?: number): readonly MdfnSearchRecord[];
+declare const MDFN_SEARCHFN_VERSION: "0.1.0";
+
+export { MDFN_SEARCHFN_VERSION, type MdfnSearchRecord, createSearchRecords };

package/dist/index.js

@@ -0,0 +1,17 @@
+// src/index.ts
+import { extractDocument } from "@mdfn/render";
+function createSearchRecords(documentId, document, maxChunkLength = 1600) {
+  const extracted = extractDocument(document, { maxChunkLength });
+  const links = extracted.links.map((link) => link.url);
+  const namespace = `${documentId.length}:${documentId}`;
+  return [
+    { id: `document:${namespace}`, documentId, kind: "document", ordinal: 0, text: extracted.plainText, headings: extracted.headings.map((heading) => heading.text), links },
+    ...extracted.chunks.map((chunk, index) => ({ id: `chunk:${namespace}:${index}`, documentId, kind: "chunk", ordinal: index, text: chunk.text, headings: chunk.headingPath, links: chunk.links.map((link) => link.url) }))
+  ];
+}
+var MDFN_SEARCHFN_VERSION = "0.1.0";
+export {
+  MDFN_SEARCHFN_VERSION,
+  createSearchRecords
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { MdfnDocument } from \"@mdfn/core\";\nimport { extractDocument } from \"@mdfn/render\";\n\nexport interface MdfnSearchRecord {\n  readonly id: string;\n  readonly documentId: string;\n  readonly kind: \"document\" | \"chunk\";\n  readonly ordinal: number;\n  readonly text: string;\n  readonly headings: readonly string[];\n  readonly links: readonly string[];\n}\n\nexport function createSearchRecords(documentId: string, document: MdfnDocument, maxChunkLength = 1600): readonly MdfnSearchRecord[] {\n  const extracted = extractDocument(document, { maxChunkLength });\n  const links = extracted.links.map((link) => link.url);\n  const namespace = `${documentId.length}:${documentId}`;\n  return [\n    { id: `document:${namespace}`, documentId, kind: \"document\", ordinal: 0, text: extracted.plainText, headings: extracted.headings.map((heading) => heading.text), links },\n    ...extracted.chunks.map((chunk, index) => ({ id: `chunk:${namespace}:${index}`, documentId, kind: \"chunk\" as const, ordinal: index, text: chunk.text, headings: chunk.headingPath, links: chunk.links.map((link) => link.url) })),\n  ];\n}\n\nexport const MDFN_SEARCHFN_VERSION = \"0.1.0\" as const;\n"],"mappings":";AACA,SAAS,uBAAuB;AAYzB,SAAS,oBAAoB,YAAoB,UAAwB,iBAAiB,MAAmC;AAClI,QAAM,YAAY,gBAAgB,UAAU,EAAE,eAAe,CAAC;AAC9D,QAAM,QAAQ,UAAU,MAAM,IAAI,CAAC,SAAS,KAAK,GAAG;AACpD,QAAM,YAAY,GAAG,WAAW,MAAM,IAAI,UAAU;AACpD,SAAO;AAAA,IACL,EAAE,IAAI,YAAY,SAAS,IAAI,YAAY,MAAM,YAAY,SAAS,GAAG,MAAM,UAAU,WAAW,UAAU,UAAU,SAAS,IAAI,CAAC,YAAY,QAAQ,IAAI,GAAG,MAAM;AAAA,IACvK,GAAG,UAAU,OAAO,IAAI,CAAC,OAAO,WAAW,EAAE,IAAI,SAAS,SAAS,IAAI,KAAK,IAAI,YAAY,MAAM,SAAkB,SAAS,OAAO,MAAM,MAAM,MAAM,UAAU,MAAM,aAAa,OAAO,MAAM,MAAM,IAAI,CAAC,SAAS,KAAK,GAAG,EAAE,EAAE;AAAA,EAClO;AACF;AAEO,IAAM,wBAAwB;","names":[]}

package/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@mdfn/searchfn", "version": "0.1.0", "description": "Deterministic search extraction records for mdfn documents", "type": "module",
+  "main": "dist/index.cjs", "module": "dist/index.js", "types": "dist/index.d.ts", "exports": { ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js", "require": "./dist/index.cjs" } },
+  "scripts": { "build": "tsup src/index.ts --format esm,cjs --dts --sourcemap --clean", "test": "vitest run", "typecheck": "tsc --noEmit -p tsconfig.json", "lint": "tsc --noEmit -p tsconfig.json", "prepack": "npm run build" },
+  "dependencies": { "@mdfn/core": "0.1.0", "@mdfn/render": "0.1.0" }, "devDependencies": { "@mdfn/markdown": "0.1.0", "tsup": "^8.0.0", "typescript": "^5.3.0", "vitest": "3.2.4" },
+  "files": ["dist", "README.md"], "sideEffects": false, "license": "MIT", "engines": { "node": ">=20 <25" }, "repository": { "type": "git", "url": "git+https://github.com/21nCo/super-functions.git", "directory": "mdfn/searchfn" }, "publishConfig": { "access": "public" },
+  "mdfn": { "status": "optional", "layer": "bridge", "schemaVersion": 1 }
+}