@jcode.labs/ragmir 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +102 -0
  3. package/dist/access-log.d.ts +11 -0
  4. package/dist/access-log.d.ts.map +1 -0
  5. package/dist/access-log.js +145 -0
  6. package/dist/access-log.js.map +1 -0
  7. package/dist/chunking.d.ts +3 -0
  8. package/dist/chunking.d.ts.map +1 -0
  9. package/dist/chunking.js +58 -0
  10. package/dist/chunking.js.map +1 -0
  11. package/dist/cli.d.ts +3 -0
  12. package/dist/cli.d.ts.map +1 -0
  13. package/dist/cli.js +944 -0
  14. package/dist/cli.js.map +1 -0
  15. package/dist/config.d.ts +11 -0
  16. package/dist/config.d.ts.map +1 -0
  17. package/dist/config.js +224 -0
  18. package/dist/config.js.map +1 -0
  19. package/dist/defaults.d.ts +17 -0
  20. package/dist/defaults.d.ts.map +1 -0
  21. package/dist/defaults.js +59 -0
  22. package/dist/defaults.js.map +1 -0
  23. package/dist/destroy.d.ts +3 -0
  24. package/dist/destroy.d.ts.map +1 -0
  25. package/dist/destroy.js +16 -0
  26. package/dist/destroy.js.map +1 -0
  27. package/dist/doctor.d.ts +3 -0
  28. package/dist/doctor.d.ts.map +1 -0
  29. package/dist/doctor.js +117 -0
  30. package/dist/doctor.js.map +1 -0
  31. package/dist/embeddings.d.ts +9 -0
  32. package/dist/embeddings.d.ts.map +1 -0
  33. package/dist/embeddings.js +110 -0
  34. package/dist/embeddings.js.map +1 -0
  35. package/dist/evaluate.d.ts +3 -0
  36. package/dist/evaluate.d.ts.map +1 -0
  37. package/dist/evaluate.js +97 -0
  38. package/dist/evaluate.js.map +1 -0
  39. package/dist/files.d.ts +16 -0
  40. package/dist/files.d.ts.map +1 -0
  41. package/dist/files.js +388 -0
  42. package/dist/files.js.map +1 -0
  43. package/dist/gitignore.d.ts +3 -0
  44. package/dist/gitignore.d.ts.map +1 -0
  45. package/dist/gitignore.js +27 -0
  46. package/dist/gitignore.js.map +1 -0
  47. package/dist/guards.d.ts +2 -0
  48. package/dist/guards.d.ts.map +1 -0
  49. package/dist/guards.js +4 -0
  50. package/dist/guards.js.map +1 -0
  51. package/dist/index.d.ts +25 -0
  52. package/dist/index.d.ts.map +1 -0
  53. package/dist/index.js +20 -0
  54. package/dist/index.js.map +1 -0
  55. package/dist/ingest.d.ts +4 -0
  56. package/dist/ingest.d.ts.map +1 -0
  57. package/dist/ingest.js +268 -0
  58. package/dist/ingest.js.map +1 -0
  59. package/dist/init.d.ts +2 -0
  60. package/dist/init.d.ts.map +1 -0
  61. package/dist/init.js +33 -0
  62. package/dist/init.js.map +1 -0
  63. package/dist/mcp.d.ts +8 -0
  64. package/dist/mcp.d.ts.map +1 -0
  65. package/dist/mcp.js +189 -0
  66. package/dist/mcp.js.map +1 -0
  67. package/dist/package-manager.d.ts +11 -0
  68. package/dist/package-manager.d.ts.map +1 -0
  69. package/dist/package-manager.js +93 -0
  70. package/dist/package-manager.js.map +1 -0
  71. package/dist/parsing.d.ts +12 -0
  72. package/dist/parsing.d.ts.map +1 -0
  73. package/dist/parsing.js +307 -0
  74. package/dist/parsing.js.map +1 -0
  75. package/dist/query.d.ts +5 -0
  76. package/dist/query.d.ts.map +1 -0
  77. package/dist/query.js +180 -0
  78. package/dist/query.js.map +1 -0
  79. package/dist/redaction.d.ts +7 -0
  80. package/dist/redaction.d.ts.map +1 -0
  81. package/dist/redaction.js +93 -0
  82. package/dist/redaction.js.map +1 -0
  83. package/dist/research.d.ts +9 -0
  84. package/dist/research.d.ts.map +1 -0
  85. package/dist/research.js +335 -0
  86. package/dist/research.js.map +1 -0
  87. package/dist/security.d.ts +3 -0
  88. package/dist/security.d.ts.map +1 -0
  89. package/dist/security.js +106 -0
  90. package/dist/security.js.map +1 -0
  91. package/dist/semantic-config.d.ts +9 -0
  92. package/dist/semantic-config.d.ts.map +1 -0
  93. package/dist/semantic-config.js +35 -0
  94. package/dist/semantic-config.js.map +1 -0
  95. package/dist/setup.d.ts +32 -0
  96. package/dist/setup.d.ts.map +1 -0
  97. package/dist/setup.js +74 -0
  98. package/dist/setup.js.map +1 -0
  99. package/dist/skill.d.ts +66 -0
  100. package/dist/skill.d.ts.map +1 -0
  101. package/dist/skill.js +652 -0
  102. package/dist/skill.js.map +1 -0
  103. package/dist/sources.d.ts +16 -0
  104. package/dist/sources.d.ts.map +1 -0
  105. package/dist/sources.js +71 -0
  106. package/dist/sources.js.map +1 -0
  107. package/dist/store.d.ts +13 -0
  108. package/dist/store.d.ts.map +1 -0
  109. package/dist/store.js +94 -0
  110. package/dist/store.js.map +1 -0
  111. package/dist/text.d.ts +3 -0
  112. package/dist/text.d.ts.map +1 -0
  113. package/dist/text.js +10 -0
  114. package/dist/text.js.map +1 -0
  115. package/dist/types.d.ts +322 -0
  116. package/dist/types.d.ts.map +1 -0
  117. package/dist/types.js +2 -0
  118. package/dist/types.js.map +1 -0
  119. package/dist/version.d.ts +2 -0
  120. package/dist/version.d.ts.map +1 -0
  121. package/dist/version.js +2 -0
  122. package/dist/version.js.map +1 -0
  123. package/examples/library-api-demo/README.md +42 -0
  124. package/examples/library-api-demo/run.mjs +61 -0
  125. package/examples/sovereign-rag-demo/.ragmir/config.json +22 -0
  126. package/examples/sovereign-rag-demo/.ragmir/sources.txt +2 -0
  127. package/examples/sovereign-rag-demo/README.md +95 -0
  128. package/examples/sovereign-rag-demo/golden-queries.json +29 -0
  129. package/examples/sovereign-rag-demo/raw/dataset-inventory.csv +5 -0
  130. package/examples/sovereign-rag-demo/raw/facility-scan.heic +3 -0
  131. package/examples/sovereign-rag-demo/raw/incident-timeline.jsonl +4 -0
  132. package/examples/sovereign-rag-demo/raw/operations-brief.md +16 -0
  133. package/examples/sovereign-rag-demo/raw/review-notes.evidence +11 -0
  134. package/examples/sovereign-rag-demo/raw/security-policy.yaml +14 -0
  135. package/package.json +87 -0
  136. package/skills/ragmir/SKILL.md +366 -0
  137. package/skills/ragmir-audio-summary/SKILL.md +150 -0
  138. package/skills/ragmir-audio-summary/forge-voice.sh +150 -0
  139. package/skills/ragmir-audio-summary/split-lines.py +13 -0
  140. package/skills/ragmir-audio-summary/xtts-voice.py +46 -0
  141. package/skills/ragmir-legal-dossier/SKILL.md +143 -0
  142. package/skills/ragmir-markdown-report/SKILL.md +110 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Jean-Baptiste Thery and JCode Labs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,102 @@
1
+ # Ragmir Core Package
2
+
3
+ `@jcode.labs/ragmir` is Ragmir Core, the technical core package for Ragmir, an open-source local RAG
4
+ library, CLI, and MCP server. It indexes your specs, docs, and code locally and gives your AI agents
5
+ only the useful cited passages, over MCP, without burning tokens on your whole repo.
6
+
7
+ **Full documentation:** https://github.com/jcode-works/jcode-ragmir#readme
8
+
9
+ This npm README is intentionally short because package READMEs are displayed separately on npm. The
10
+ GitHub root README is the canonical product documentation.
11
+
12
+ ## What It Does
13
+
14
+ Ragmir lets a Node.js repository keep a local knowledge base next to its private documents. It indexes
15
+ supported local files, stores the generated retrieval index in the target repository, and exposes the
16
+ same evidence through:
17
+
18
+ - the `ragmir` CLI (`kb` remains a legacy alias);
19
+ - a TypeScript library API;
20
+ - a local MCP stdio server for compatible AI agents;
21
+ - portable agent skills copied by `ragmir setup`, including audio, Markdown-report, and legal-dossier
22
+ workflows.
23
+
24
+ Ragmir does not send documents to a hosted RAG service and does not generate final LLM answers in
25
+ core. It returns cited retrieval context so the agent or model you trust can write from local
26
+ evidence.
27
+
28
+ ## Use It For
29
+
30
+ - private project, legal, operational, research, or institutional dossiers;
31
+ - codebase and architecture context retrieval;
32
+ - local-first agent workflows with bounded MCP access;
33
+ - cited summaries, audits, briefs, and decision support.
34
+
35
+ ## Install
36
+
37
+ ```bash
38
+ npm install --save-dev @jcode.labs/ragmir
39
+ ```
40
+
41
+ ## Quick Start
42
+
43
+ ```bash
44
+ npx ragmir setup
45
+ npx ragmir install-agent --agents claude,codex,kimi,opencode,cline
46
+ npx ragmir doctor --fix
47
+
48
+ # Claude Code
49
+ claude mcp add-json --scope local ragmir "$(cat .ragmir/claude-mcp-server.json)"
50
+
51
+ # Codex
52
+ cat .ragmir/codex-mcp.toml
53
+
54
+ # Kimi Code CLI
55
+ kimi --mcp-config-file .ragmir/kimi-mcp.json
56
+
57
+ # OpenCode
58
+ cat .ragmir/opencode.jsonc
59
+
60
+ # Cline
61
+ cat .ragmir/cline-mcp.json
62
+ ```
63
+
64
+ Use `npx ragmir setup --agents claude,codex --mcp-command ./scripts/serve-mcp.sh` when a
65
+ repository should generate only selected MCP helpers or launch through a local wrapper.
66
+
67
+ By default, Ragmir keeps local config, raw documents, generated indexes, access logs, models, reports,
68
+ audio, and agent helper files under a single ignored `.ragmir/` project folder. It reports
69
+ unsupported/skipped files during ingestion and reports supported files that produced no extractable
70
+ text. `ragmir setup` adds the matching Git ignore entry for local Ragmir state.
71
+
72
+ The primary workflow is agent-first: Claude Code, Codex, Kimi, OpenCode, Cline, or another
73
+ MCP-capable assistant asks Ragmir for cited local context, then writes or reasons from those
74
+ citations. For terminal checks, use `npx ragmir search "your question"` or
75
+ `npx ragmir ask "your question"`. For broader implementation or review work, use
76
+ `npx ragmir research "your topic" --compact` before asking the agent to synthesize.
77
+
78
+ Run `npx ragmir doctor --fix` later to repair missing setup or rebuild stale indexes.
79
+ For better semantic Q&A, run `npx ragmir models pull --enable`, then run
80
+ `npx ragmir ingest --rebuild`.
81
+
82
+ ## Entry Points
83
+
84
+ - CLI: `ragmir`
85
+ - Library import: `@jcode.labs/ragmir`
86
+ - MCP server: `npx ragmir serve-mcp`
87
+ - Bundled skills: `npx ragmir setup` or `npx ragmir install-skill`
88
+
89
+ The public TypeScript API reference is maintained in the root repository at
90
+ [`docs/api-reference.md`](https://github.com/jcode-works/jcode-ragmir/blob/main/docs/api-reference.md).
91
+
92
+ ## Main Agent Setup
93
+
94
+ After `npx ragmir setup`, use `npx ragmir install-agent --agents claude`, `--agents kimi`,
95
+ `--agents cline`, or a comma-separated list for native agent skill discovery. Native agent folders
96
+ link back to `.ragmir/skills/` by default so there is one original skill source. Ragmir Core also
97
+ generates MCP helpers for Claude Code, Codex, Kimi, OpenCode, and Cline under `.ragmir/`. See the
98
+ canonical GitHub README for the full agent demo.
99
+
100
+ ## License
101
+
102
+ MIT (c) Jean-Baptiste Thery.
@@ -0,0 +1,11 @@
1
+ import type { AccessLogAction, AccessLogUsageOptions, AccessLogUsageReport, Config } from "./types.js";
2
+ export interface AccessLogEvent {
3
+ action: AccessLogAction;
4
+ query?: string;
5
+ topK?: number;
6
+ resultCount?: number;
7
+ redactions?: number;
8
+ }
9
+ export declare function recordAccess(config: Config, event: AccessLogEvent): Promise<void>;
10
+ export declare function accessLogUsageReport(options?: AccessLogUsageOptions): Promise<AccessLogUsageReport>;
11
+ //# sourceMappingURL=access-log.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"access-log.d.ts","sourceRoot":"","sources":["../src/access-log.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,MAAM,EACP,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,eAAe,CAAA;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAqBD,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAWvF;AAED,wBAAsB,oBAAoB,CACxC,OAAO,GAAE,qBAA0B,GAClC,OAAO,CAAC,oBAAoB,CAAC,CAuD/B"}
@@ -0,0 +1,145 @@
1
+ import { createHash } from "node:crypto";
2
+ import { existsSync } from "node:fs";
3
+ import { appendFile, mkdir, readFile } from "node:fs/promises";
4
+ import path from "node:path";
5
+ import { loadConfig } from "./config.js";
6
+ const ACCESS_LOG_ACTIONS = [
7
+ "ingest",
8
+ "search",
9
+ "ask",
10
+ "research",
11
+ "evaluate",
12
+ "destroy-index",
13
+ ];
14
+ const ACCESS_LOG_ACTION_SET = new Set(ACCESS_LOG_ACTIONS);
15
+ const DEFAULT_USAGE_REPORT_DAYS = 7;
16
+ const MILLISECONDS_PER_DAY = 24 * 60 * 60 * 1000;
17
+ export async function recordAccess(config, event) {
18
+ if (!config.accessLog) {
19
+ return;
20
+ }
21
+ try {
22
+ await mkdir(path.dirname(config.accessLogPath), { recursive: true });
23
+ await appendFile(config.accessLogPath, `${JSON.stringify(toLogLine(event))}\n`, "utf8");
24
+ }
25
+ catch {
26
+ // Access logging is best-effort so read-only workspaces do not block local use.
27
+ }
28
+ }
29
+ export async function accessLogUsageReport(options = {}) {
30
+ const config = await loadConfig(String(options.cwd ?? process.cwd()));
31
+ const days = normalizeUsageReportDays(options.days);
32
+ const until = new Date();
33
+ const since = new Date(until.getTime() - days * MILLISECONDS_PER_DAY);
34
+ const eventsByAction = emptyEventsByAction();
35
+ const queryHashes = new Set();
36
+ let totalEvents = 0;
37
+ let invalidLines = 0;
38
+ let resultCountTotal = 0;
39
+ let resultCountEvents = 0;
40
+ let lastEventAt = null;
41
+ if (existsSync(config.accessLogPath)) {
42
+ const lines = (await readFile(config.accessLogPath, "utf8")).split(/\r?\n/u).filter(Boolean);
43
+ for (const line of lines) {
44
+ const event = parseAccessLogLine(line);
45
+ if (!event) {
46
+ invalidLines += 1;
47
+ continue;
48
+ }
49
+ const timestamp = Date.parse(event.timestamp);
50
+ if (!Number.isFinite(timestamp) ||
51
+ timestamp < since.getTime() ||
52
+ timestamp > until.getTime()) {
53
+ continue;
54
+ }
55
+ totalEvents += 1;
56
+ eventsByAction[event.action] += 1;
57
+ if (event.queryHash) {
58
+ queryHashes.add(event.queryHash);
59
+ }
60
+ if (typeof event.resultCount === "number") {
61
+ resultCountTotal += event.resultCount;
62
+ resultCountEvents += 1;
63
+ }
64
+ if (lastEventAt === null || event.timestamp > lastEventAt) {
65
+ lastEventAt = event.timestamp;
66
+ }
67
+ }
68
+ }
69
+ return {
70
+ accessLogEnabled: config.accessLog,
71
+ since: since.toISOString(),
72
+ until: until.toISOString(),
73
+ totalEvents,
74
+ invalidLines,
75
+ eventsByAction,
76
+ uniqueQueryHashes: queryHashes.size,
77
+ averageResultCount: resultCountEvents === 0 ? null : resultCountTotal / resultCountEvents,
78
+ lastEventAt,
79
+ };
80
+ }
81
+ function toLogLine(event) {
82
+ return {
83
+ timestamp: new Date().toISOString(),
84
+ action: event.action,
85
+ queryHash: event.query ? hashQuery(event.query) : undefined,
86
+ topK: event.topK,
87
+ resultCount: event.resultCount,
88
+ redactions: event.redactions,
89
+ };
90
+ }
91
+ function hashQuery(query) {
92
+ return createHash("sha256").update(query).digest("hex");
93
+ }
94
+ function emptyEventsByAction() {
95
+ return {
96
+ ingest: 0,
97
+ search: 0,
98
+ ask: 0,
99
+ research: 0,
100
+ evaluate: 0,
101
+ "destroy-index": 0,
102
+ };
103
+ }
104
+ function normalizeUsageReportDays(days) {
105
+ if (days === undefined) {
106
+ return DEFAULT_USAGE_REPORT_DAYS;
107
+ }
108
+ if (!Number.isInteger(days) || days <= 0) {
109
+ throw new Error("usage-report days must be a positive integer.");
110
+ }
111
+ return days;
112
+ }
113
+ function parseAccessLogLine(line) {
114
+ try {
115
+ const parsed = JSON.parse(line);
116
+ if (!isAccessLogLine(parsed)) {
117
+ return null;
118
+ }
119
+ return parsed;
120
+ }
121
+ catch {
122
+ return null;
123
+ }
124
+ }
125
+ function isAccessLogLine(value) {
126
+ return (typeof value === "object" &&
127
+ value !== null &&
128
+ hasTimestamp(value) &&
129
+ hasAction(value) &&
130
+ hasOptionalQueryHash(value) &&
131
+ hasOptionalResultCount(value));
132
+ }
133
+ function hasTimestamp(value) {
134
+ return "timestamp" in value && typeof value.timestamp === "string";
135
+ }
136
+ function hasAction(value) {
137
+ return ("action" in value && typeof value.action === "string" && ACCESS_LOG_ACTION_SET.has(value.action));
138
+ }
139
+ function hasOptionalQueryHash(value) {
140
+ return !("queryHash" in value) || typeof value.queryHash === "string";
141
+ }
142
+ function hasOptionalResultCount(value) {
143
+ return !("resultCount" in value) || typeof value.resultCount === "number";
144
+ }
145
+ //# sourceMappingURL=access-log.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"access-log.js","sourceRoot":"","sources":["../src/access-log.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAuBxC,MAAM,kBAAkB,GAAsB;IAC5C,QAAQ;IACR,QAAQ;IACR,KAAK;IACL,UAAU;IACV,UAAU;IACV,eAAe;CAChB,CAAA;AACD,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAS,kBAAkB,CAAC,CAAA;AACjE,MAAM,yBAAyB,GAAG,CAAC,CAAA;AACnC,MAAM,oBAAoB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;AAEhD,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,KAAqB;IACtE,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtB,OAAM;IACR,CAAC;IAED,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACpE,MAAM,UAAU,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACzF,CAAC;IAAC,MAAM,CAAC;QACP,gFAAgF;IAClF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,UAAiC,EAAE;IAEnC,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;IACrE,MAAM,IAAI,GAAG,wBAAwB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IACnD,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAA;IACxB,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,oBAAoB,CAAC,CAAA;IACrE,MAAM,cAAc,GAAG,mBAAmB,EAAE,CAAA;IAC5C,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;IACrC,IAAI,WAAW,GAAG,CAAC,CAAA;IACnB,IAAI,YAAY,GAAG,CAAC,CAAA;IACpB,IAAI,gBAAgB,GAAG,CAAC,CAAA;IACxB,IAAI,iBAAiB,GAAG,CAAC,CAAA;IACzB,IAAI,WAAW,GAAkB,IAAI,CAAA;IAErC,IAAI,UAAU,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QAC5F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;YACtC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,YAAY,IAAI,CAAC,CAAA;gBACjB,SAAQ;YACV,CAAC;YACD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YAC7C,IACE,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC3B,SAAS,GAAG,KAAK,CAAC,OAAO,EAAE;gBAC3B,SAAS,GAAG,KAAK,CAAC,OAAO,EAAE,EAC3B,CAAC;gBACD,SAAQ;YACV,CAAC;YACD,WAAW,IAAI,CAAC,CAAA;YAChB,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACjC,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;gBACpB,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC1C,gBAAgB,IAAI,KAAK,CAAC,WAAW,CAAA;gBACrC,iBAAiB,IAAI,CAAC,CAAA;YACxB,CAAC;YACD,IAAI,WAAW,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,GAAG,WAAW,EAAE,CAAC;gBAC1D,WAAW,GAAG,KAAK,CAAC,SAAS,CAAA;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,gBAAgB,EAAE,MAAM,CAAC,SAAS;QAClC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;QAC1B,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;QAC1B,WAAW;QACX,YAAY;QACZ,cAAc;QACd,iBAAiB,EAAE,WAAW,CAAC,IAAI;QACnC,kBAAkB,EAAE,iBAAiB,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,gBAAgB,GAAG,iBAAiB;QACzF,WAAW;KACZ,CAAA;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAqB;IACtC,OAAO;QACL,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;QAC3D,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;KAC7B,CAAA;AACH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACzD,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,MAAM,EAAE,CAAC;QACT,MAAM,EAAE,CAAC;QACT,GAAG,EAAE,CAAC;QACN,QAAQ,EAAE,CAAC;QACX,QAAQ,EAAE,CAAC;QACX,eAAe,EAAE,CAAC;KACnB,CAAA;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,IAAwB;IACxD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,yBAAyB,CAAA;IAClC,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IAClE,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAY;IACtC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,KAAc;IACrC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,YAAY,CAAC,KAAK,CAAC;QACnB,SAAS,CAAC,KAAK,CAAC;QAChB,oBAAoB,CAAC,KAAK,CAAC;QAC3B,sBAAsB,CAAC,KAAK,CAAC,CAC9B,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,OAAO,WAAW,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAA;AACpE,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,OAAO,CACL,QAAQ,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CACjG,CAAA;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAa;IACzC,OAAO,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAA;AACvE,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAa;IAC3C,OAAO,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,CAAA;AAC3E,CAAC"}
@@ -0,0 +1,3 @@
1
+ import type { ParsedDocument, TextChunk } from "./types.js";
2
+ export declare function chunkDocument(document: ParsedDocument, chunkSize: number, chunkOverlap: number): TextChunk[];
3
+ //# sourceMappingURL=chunking.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chunking.d.ts","sourceRoot":"","sources":["../src/chunking.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAM3D,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,GACnB,SAAS,EAAE,CAqCb"}
@@ -0,0 +1,58 @@
1
+ import { createHash } from "node:crypto";
2
+ const PARAGRAPH_BREAK_MIN_RATIO = 0.45;
3
+ const SENTENCE_BREAK_MIN_RATIO = 0.55;
4
+ const WHITESPACE_BREAK_MIN_RATIO = 0.75;
5
+ export function chunkDocument(document, chunkSize, chunkOverlap) {
6
+ if (!document.text) {
7
+ return [];
8
+ }
9
+ const chunks = [];
10
+ let cursor = 0;
11
+ let chunkIndex = 0;
12
+ while (cursor < document.text.length) {
13
+ const end = chooseChunkEnd(document.text, cursor, chunkSize);
14
+ const text = document.text.slice(cursor, end).trim();
15
+ if (text) {
16
+ const id = createHash("sha256")
17
+ .update(`${document.file.relativePath}:${chunkIndex}:${text}`)
18
+ .digest("hex");
19
+ chunks.push({
20
+ id,
21
+ source: document.file.source,
22
+ relativePath: document.file.relativePath,
23
+ chunkIndex,
24
+ text,
25
+ checksum: document.file.checksum,
26
+ bytes: document.file.bytes,
27
+ mtimeMs: document.file.mtimeMs,
28
+ });
29
+ chunkIndex += 1;
30
+ }
31
+ if (end >= document.text.length) {
32
+ break;
33
+ }
34
+ cursor = Math.max(end - chunkOverlap, cursor + 1);
35
+ }
36
+ return chunks;
37
+ }
38
+ function chooseChunkEnd(text, cursor, chunkSize) {
39
+ const hardEnd = Math.min(cursor + chunkSize, text.length);
40
+ if (hardEnd === text.length) {
41
+ return hardEnd;
42
+ }
43
+ const window = text.slice(cursor, hardEnd);
44
+ const paragraphBreak = window.lastIndexOf("\n\n");
45
+ if (paragraphBreak > chunkSize * PARAGRAPH_BREAK_MIN_RATIO) {
46
+ return cursor + paragraphBreak;
47
+ }
48
+ const sentenceBreak = Math.max(window.lastIndexOf(". "), window.lastIndexOf("? "), window.lastIndexOf("! "));
49
+ if (sentenceBreak > chunkSize * SENTENCE_BREAK_MIN_RATIO) {
50
+ return cursor + sentenceBreak + 1;
51
+ }
52
+ const whitespace = window.lastIndexOf(" ");
53
+ if (whitespace > chunkSize * WHITESPACE_BREAK_MIN_RATIO) {
54
+ return cursor + whitespace;
55
+ }
56
+ return hardEnd;
57
+ }
58
+ //# sourceMappingURL=chunking.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chunking.js","sourceRoot":"","sources":["../src/chunking.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGxC,MAAM,yBAAyB,GAAG,IAAI,CAAA;AACtC,MAAM,wBAAwB,GAAG,IAAI,CAAA;AACrC,MAAM,0BAA0B,GAAG,IAAI,CAAA;AAEvC,MAAM,UAAU,aAAa,CAC3B,QAAwB,EACxB,SAAiB,EACjB,YAAoB;IAEpB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnB,OAAO,EAAE,CAAA;IACX,CAAC;IAED,MAAM,MAAM,GAAgB,EAAE,CAAA;IAC9B,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,IAAI,UAAU,GAAG,CAAC,CAAA;IAElB,OAAO,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAA;QAC5D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;QAEpD,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC;iBAC5B,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,YAAY,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;iBAC7D,MAAM,CAAC,KAAK,CAAC,CAAA;YAChB,MAAM,CAAC,IAAI,CAAC;gBACV,EAAE;gBACF,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;gBAC5B,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY;gBACxC,UAAU;gBACV,IAAI;gBACJ,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ;gBAChC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK;gBAC1B,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO;aAC/B,CAAC,CAAA;YACF,UAAU,IAAI,CAAC,CAAA;QACjB,CAAC;QAED,IAAI,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAK;QACP,CAAC;QACD,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,YAAY,EAAE,MAAM,GAAG,CAAC,CAAC,CAAA;IACnD,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,MAAc,EAAE,SAAiB;IACrE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACzD,IAAI,OAAO,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC1C,MAAM,cAAc,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACjD,IAAI,cAAc,GAAG,SAAS,GAAG,yBAAyB,EAAE,CAAC;QAC3D,OAAO,MAAM,GAAG,cAAc,CAAA;IAChC,CAAC;IAED,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAC5B,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EACxB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,EACxB,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CACzB,CAAA;IACD,IAAI,aAAa,GAAG,SAAS,GAAG,wBAAwB,EAAE,CAAC;QACzD,OAAO,MAAM,GAAG,aAAa,GAAG,CAAC,CAAA;IACnC,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IAC1C,IAAI,UAAU,GAAG,SAAS,GAAG,0BAA0B,EAAE,CAAC;QACxD,OAAO,MAAM,GAAG,UAAU,CAAA;IAC5B,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}
package/dist/cli.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ export {};
3
+ //# sourceMappingURL=cli.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}