docorbit 0.1.0 → 0.1.2

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 (405) hide show
  1. package/README.md +29 -15
  2. package/bin/docorbit.js +2 -2
  3. package/dist/apps/cli/src/commands/add.d.ts +7 -0
  4. package/dist/apps/cli/src/commands/add.js +35 -0
  5. package/dist/apps/cli/src/commands/api.d.ts +2 -0
  6. package/dist/apps/cli/src/commands/api.js +35 -0
  7. package/dist/apps/cli/src/commands/context.d.ts +10 -0
  8. package/dist/apps/cli/src/commands/context.js +36 -0
  9. package/dist/apps/cli/src/commands/dashboard.d.ts +8 -0
  10. package/dist/apps/cli/src/commands/dashboard.js +43 -0
  11. package/dist/apps/cli/src/commands/diff.d.ts +2 -0
  12. package/dist/apps/cli/src/commands/diff.js +29 -0
  13. package/dist/apps/cli/src/commands/evaluate.d.ts +11 -0
  14. package/dist/apps/cli/src/commands/evaluate.js +101 -0
  15. package/dist/apps/cli/src/commands/examples.d.ts +2 -0
  16. package/dist/apps/cli/src/commands/examples.js +36 -0
  17. package/dist/apps/cli/src/commands/export.d.ts +11 -0
  18. package/dist/apps/cli/src/commands/export.js +72 -0
  19. package/dist/apps/cli/src/commands/impact.d.ts +2 -0
  20. package/dist/apps/cli/src/commands/impact.js +30 -0
  21. package/dist/apps/cli/src/commands/init.d.ts +5 -0
  22. package/dist/apps/cli/src/commands/init.js +52 -0
  23. package/dist/apps/cli/src/commands/inspect.d.ts +5 -0
  24. package/dist/apps/cli/src/commands/inspect.js +24 -0
  25. package/dist/apps/cli/src/commands/mcp.d.ts +8 -0
  26. package/dist/apps/cli/src/commands/mcp.js +49 -0
  27. package/dist/apps/cli/src/commands/pitfalls.d.ts +2 -0
  28. package/dist/apps/cli/src/commands/pitfalls.js +35 -0
  29. package/dist/apps/cli/src/commands/recipes.d.ts +2 -0
  30. package/dist/apps/cli/src/commands/recipes.js +33 -0
  31. package/dist/apps/cli/src/commands/search.d.ts +11 -0
  32. package/dist/apps/cli/src/commands/search.js +36 -0
  33. package/dist/apps/cli/src/commands/update.d.ts +6 -0
  34. package/dist/apps/cli/src/commands/update.js +53 -0
  35. package/dist/apps/cli/src/commands/verify.d.ts +2 -0
  36. package/dist/apps/cli/src/commands/verify.js +44 -0
  37. package/dist/apps/cli/src/formatters/colors.d.ts +21 -0
  38. package/dist/apps/cli/src/formatters/colors.js +22 -0
  39. package/dist/apps/cli/src/formatters/inspection.d.ts +3 -0
  40. package/dist/apps/cli/src/formatters/inspection.js +88 -0
  41. package/dist/apps/cli/src/formatters/knowledge.d.ts +5 -0
  42. package/dist/apps/cli/src/formatters/knowledge.js +229 -0
  43. package/dist/apps/cli/src/formatters/retrieval.d.ts +3 -0
  44. package/dist/apps/cli/src/formatters/retrieval.js +61 -0
  45. package/{apps/cli/src/formatters/terminal.ts → dist/apps/cli/src/formatters/terminal.d.ts} +0 -1
  46. package/dist/apps/cli/src/formatters/terminal.js +5 -0
  47. package/dist/apps/cli/src/formatters/verification.d.ts +4 -0
  48. package/dist/apps/cli/src/formatters/verification.js +102 -0
  49. package/dist/apps/cli/src/index.d.ts +1 -0
  50. package/dist/apps/cli/src/index.js +376 -0
  51. package/dist/packages/core/src/dashboard/server.d.ts +33 -0
  52. package/dist/packages/core/src/dashboard/server.js +267 -0
  53. package/dist/packages/core/src/dashboard/ui.d.ts +5 -0
  54. package/{packages/core/src/dashboard/ui.ts → dist/packages/core/src/dashboard/ui.js} +2 -2
  55. package/dist/packages/core/src/implementation-service.d.ts +73 -0
  56. package/dist/packages/core/src/implementation-service.js +325 -0
  57. package/{packages/core/src/index.ts → dist/packages/core/src/index.d.ts} +0 -1
  58. package/dist/packages/core/src/index.js +6 -0
  59. package/dist/packages/core/src/inspector.d.ts +22 -0
  60. package/dist/packages/core/src/inspector.js +38 -0
  61. package/dist/packages/core/src/pipeline.d.ts +45 -0
  62. package/dist/packages/core/src/pipeline.js +246 -0
  63. package/dist/packages/crawler/src/config.d.ts +2 -0
  64. package/dist/packages/crawler/src/config.js +10 -0
  65. package/dist/packages/crawler/src/fetcher.d.ts +31 -0
  66. package/dist/packages/crawler/src/fetcher.js +139 -0
  67. package/dist/packages/crawler/src/index.js +2 -0
  68. package/dist/packages/discovery/src/index.d.ts +11 -0
  69. package/dist/packages/discovery/src/index.js +29 -0
  70. package/dist/packages/discovery/src/provider.d.ts +12 -0
  71. package/dist/packages/discovery/src/provider.js +30 -0
  72. package/dist/packages/discovery/src/providers/generic.d.ts +7 -0
  73. package/dist/packages/discovery/src/providers/generic.js +94 -0
  74. package/dist/packages/discovery/src/providers/github.d.ts +7 -0
  75. package/dist/packages/discovery/src/providers/github.js +52 -0
  76. package/dist/packages/discovery/src/providers/llms-txt.d.ts +7 -0
  77. package/dist/packages/discovery/src/providers/llms-txt.js +60 -0
  78. package/dist/packages/discovery/src/providers/markdown.d.ts +7 -0
  79. package/dist/packages/discovery/src/providers/markdown.js +38 -0
  80. package/dist/packages/discovery/src/providers/openapi.d.ts +7 -0
  81. package/dist/packages/discovery/src/providers/openapi.js +77 -0
  82. package/dist/packages/discovery/src/providers/sitemap.d.ts +7 -0
  83. package/dist/packages/discovery/src/providers/sitemap.js +53 -0
  84. package/dist/packages/discovery/src/providers/skill.d.ts +7 -0
  85. package/dist/packages/discovery/src/providers/skill.js +46 -0
  86. package/dist/packages/discovery/src/ranker.d.ts +6 -0
  87. package/dist/packages/discovery/src/ranker.js +107 -0
  88. package/dist/packages/evaluation/src/dataset.d.ts +2 -0
  89. package/dist/packages/evaluation/src/dataset.js +944 -0
  90. package/dist/packages/evaluation/src/index.js +8 -0
  91. package/dist/packages/evaluation/src/runner.d.ts +7 -0
  92. package/dist/packages/evaluation/src/runner.js +196 -0
  93. package/dist/packages/evaluation/src/strategies/context7-runner.d.ts +24 -0
  94. package/dist/packages/evaluation/src/strategies/context7-runner.js +229 -0
  95. package/dist/packages/evaluation/src/strategies/docorbit-runner.d.ts +5 -0
  96. package/dist/packages/evaluation/src/strategies/docorbit-runner.js +210 -0
  97. package/dist/packages/evaluation/src/strategies/firecrawl-runner.d.ts +24 -0
  98. package/dist/packages/evaluation/src/strategies/firecrawl-runner.js +151 -0
  99. package/dist/packages/evaluation/src/strategies/web-search-runner.d.ts +32 -0
  100. package/dist/packages/evaluation/src/strategies/web-search-runner.js +161 -0
  101. package/dist/packages/evaluation/src/types.d.ts +15 -0
  102. package/dist/packages/evaluation/src/types.js +1 -0
  103. package/dist/packages/evaluation/src/version-matcher.d.ts +11 -0
  104. package/dist/packages/evaluation/src/version-matcher.js +61 -0
  105. package/dist/packages/export/src/agents-md.d.ts +19 -0
  106. package/dist/packages/export/src/agents-md.js +170 -0
  107. package/dist/packages/export/src/claude-md.d.ts +17 -0
  108. package/dist/packages/export/src/claude-md.js +118 -0
  109. package/dist/packages/export/src/docs-map.d.ts +14 -0
  110. package/dist/packages/export/src/docs-map.js +118 -0
  111. package/dist/packages/export/src/index.js +6 -0
  112. package/dist/packages/export/src/llms-txt.d.ts +15 -0
  113. package/dist/packages/export/src/llms-txt.js +73 -0
  114. package/dist/packages/export/src/service.d.ts +23 -0
  115. package/dist/packages/export/src/service.js +210 -0
  116. package/dist/packages/export/src/skill-md.d.ts +14 -0
  117. package/dist/packages/export/src/skill-md.js +107 -0
  118. package/{packages/mcp/src/index.ts → dist/packages/mcp/src/index.d.ts} +2 -35
  119. package/dist/packages/mcp/src/index.js +6 -0
  120. package/dist/packages/mcp/src/resources/index.d.ts +12 -0
  121. package/dist/packages/mcp/src/resources/index.js +165 -0
  122. package/dist/packages/mcp/src/server.d.ts +30 -0
  123. package/dist/packages/mcp/src/server.js +243 -0
  124. package/dist/packages/mcp/src/tools/analyze-impact.d.ts +6 -0
  125. package/dist/packages/mcp/src/tools/analyze-impact.js +64 -0
  126. package/dist/packages/mcp/src/tools/check-api.d.ts +6 -0
  127. package/dist/packages/mcp/src/tools/check-api.js +74 -0
  128. package/dist/packages/mcp/src/tools/diff-docs.d.ts +6 -0
  129. package/dist/packages/mcp/src/tools/diff-docs.js +58 -0
  130. package/dist/packages/mcp/src/tools/export-context.d.ts +6 -0
  131. package/dist/packages/mcp/src/tools/export-context.js +61 -0
  132. package/dist/packages/mcp/src/tools/find-api.d.ts +6 -0
  133. package/dist/packages/mcp/src/tools/find-api.js +91 -0
  134. package/dist/packages/mcp/src/tools/find-example.d.ts +6 -0
  135. package/dist/packages/mcp/src/tools/find-example.js +92 -0
  136. package/dist/packages/mcp/src/tools/find-pitfall.d.ts +6 -0
  137. package/dist/packages/mcp/src/tools/find-pitfall.js +85 -0
  138. package/dist/packages/mcp/src/tools/find-recipe.d.ts +6 -0
  139. package/dist/packages/mcp/src/tools/find-recipe.js +89 -0
  140. package/dist/packages/mcp/src/tools/get-doc.d.ts +6 -0
  141. package/dist/packages/mcp/src/tools/get-doc.js +118 -0
  142. package/dist/packages/mcp/src/tools/get-docs-map.d.ts +6 -0
  143. package/dist/packages/mcp/src/tools/get-docs-map.js +54 -0
  144. package/dist/packages/mcp/src/tools/get-version.d.ts +6 -0
  145. package/dist/packages/mcp/src/tools/get-version.js +104 -0
  146. package/dist/packages/mcp/src/tools/implementation-context.d.ts +6 -0
  147. package/dist/packages/mcp/src/tools/implementation-context.js +102 -0
  148. package/dist/packages/mcp/src/tools/index.d.ts +19 -0
  149. package/dist/packages/mcp/src/tools/index.js +41 -0
  150. package/dist/packages/mcp/src/tools/ingest-doc.d.ts +6 -0
  151. package/dist/packages/mcp/src/tools/ingest-doc.js +264 -0
  152. package/dist/packages/mcp/src/tools/list-sources.d.ts +6 -0
  153. package/dist/packages/mcp/src/tools/list-sources.js +76 -0
  154. package/dist/packages/mcp/src/tools/search-docs.d.ts +6 -0
  155. package/dist/packages/mcp/src/tools/search-docs.js +113 -0
  156. package/dist/packages/mcp/src/tools/types.d.ts +22 -0
  157. package/dist/packages/mcp/src/tools/types.js +1 -0
  158. package/dist/packages/mcp/src/transports/http.d.ts +31 -0
  159. package/dist/packages/mcp/src/transports/http.js +215 -0
  160. package/dist/packages/mcp/src/transports/stdio.d.ts +22 -0
  161. package/dist/packages/mcp/src/transports/stdio.js +86 -0
  162. package/{packages/mcp/src/transports/types.ts → dist/packages/mcp/src/transports/types.d.ts} +2 -3
  163. package/dist/packages/mcp/src/transports/types.js +1 -0
  164. package/dist/packages/mcp/src/types.d.ts +89 -0
  165. package/dist/packages/mcp/src/types.js +7 -0
  166. package/dist/packages/normalizer/src/example-indexer.d.ts +5 -0
  167. package/dist/packages/normalizer/src/example-indexer.js +200 -0
  168. package/dist/packages/normalizer/src/html.d.ts +13 -0
  169. package/dist/packages/normalizer/src/html.js +221 -0
  170. package/{packages/normalizer/src/index.ts → dist/packages/normalizer/src/index.d.ts} +0 -1
  171. package/dist/packages/normalizer/src/index.js +7 -0
  172. package/dist/packages/normalizer/src/llms.d.ts +3 -0
  173. package/dist/packages/normalizer/src/llms.js +71 -0
  174. package/dist/packages/normalizer/src/openapi/endpoint-parser.d.ts +11 -0
  175. package/dist/packages/normalizer/src/openapi/endpoint-parser.js +357 -0
  176. package/dist/packages/normalizer/src/openapi/schema-resolver.d.ts +10 -0
  177. package/dist/packages/normalizer/src/openapi/schema-resolver.js +82 -0
  178. package/dist/packages/normalizer/src/openapi.js +2 -0
  179. package/dist/packages/normalizer/src/page.d.ts +13 -0
  180. package/dist/packages/normalizer/src/page.js +150 -0
  181. package/dist/packages/normalizer/src/pitfall-extractor.d.ts +6 -0
  182. package/dist/packages/normalizer/src/pitfall-extractor.js +153 -0
  183. package/dist/packages/normalizer/src/slicer.d.ts +30 -0
  184. package/dist/packages/normalizer/src/slicer.js +360 -0
  185. package/dist/packages/retrieval/src/engine.d.ts +17 -0
  186. package/dist/packages/retrieval/src/engine.js +93 -0
  187. package/{packages/retrieval/src/index.ts → dist/packages/retrieval/src/index.d.ts} +0 -1
  188. package/dist/packages/retrieval/src/index.js +6 -0
  189. package/dist/packages/retrieval/src/intent.d.ts +6 -0
  190. package/dist/packages/retrieval/src/intent.js +39 -0
  191. package/dist/packages/retrieval/src/packer.d.ts +2 -0
  192. package/dist/packages/retrieval/src/packer.js +108 -0
  193. package/dist/packages/retrieval/src/recipe-engine.d.ts +18 -0
  194. package/dist/packages/retrieval/src/recipe-engine.js +265 -0
  195. package/dist/packages/retrieval/src/scorer.d.ts +13 -0
  196. package/dist/packages/retrieval/src/scorer.js +110 -0
  197. package/dist/packages/retrieval/src/weights.d.ts +3 -0
  198. package/dist/packages/retrieval/src/weights.js +28 -0
  199. package/dist/packages/security/src/annotations.d.ts +10 -0
  200. package/dist/packages/security/src/annotations.js +100 -0
  201. package/dist/packages/security/src/index.js +2 -0
  202. package/dist/packages/security/src/ssrf.d.ts +17 -0
  203. package/dist/packages/security/src/ssrf.js +132 -0
  204. package/dist/packages/shared/src/errors.d.ts +22 -0
  205. package/dist/packages/shared/src/errors.js +44 -0
  206. package/dist/packages/shared/src/hashing.d.ts +3 -0
  207. package/dist/packages/shared/src/hashing.js +21 -0
  208. package/dist/packages/shared/src/index.js +3 -0
  209. package/dist/packages/shared/src/types.d.ts +715 -0
  210. package/dist/packages/shared/src/types.js +1 -0
  211. package/dist/packages/storage/src/db.d.ts +11 -0
  212. package/dist/packages/storage/src/db.js +128 -0
  213. package/dist/packages/storage/src/index.js +10 -0
  214. package/dist/packages/storage/src/interfaces.d.ts +83 -0
  215. package/dist/packages/storage/src/interfaces.js +1 -0
  216. package/dist/packages/storage/src/repositories/api-repository.d.ts +16 -0
  217. package/dist/packages/storage/src/repositories/api-repository.js +169 -0
  218. package/dist/packages/storage/src/repositories/chunk-repository.d.ts +32 -0
  219. package/dist/packages/storage/src/repositories/chunk-repository.js +250 -0
  220. package/dist/packages/storage/src/repositories/example-repository.d.ts +16 -0
  221. package/dist/packages/storage/src/repositories/example-repository.js +158 -0
  222. package/dist/packages/storage/src/repositories/page-repository.d.ts +16 -0
  223. package/dist/packages/storage/src/repositories/page-repository.js +161 -0
  224. package/dist/packages/storage/src/repositories/pitfall-repository.d.ts +15 -0
  225. package/dist/packages/storage/src/repositories/pitfall-repository.js +144 -0
  226. package/dist/packages/storage/src/repositories/source-repository.d.ts +33 -0
  227. package/dist/packages/storage/src/repositories/source-repository.js +153 -0
  228. package/dist/packages/storage/src/repository.d.ts +92 -0
  229. package/dist/packages/storage/src/repository.js +157 -0
  230. package/dist/packages/storage/src/schema.d.ts +2 -0
  231. package/{packages/storage/src/schema.ts → dist/packages/storage/src/schema.js} +0 -3
  232. package/dist/packages/storage/src/search-tokens.d.ts +6 -0
  233. package/dist/packages/storage/src/search-tokens.js +26 -0
  234. package/dist/packages/verification/src/diff-engine.d.ts +18 -0
  235. package/dist/packages/verification/src/diff-engine.js +218 -0
  236. package/dist/packages/verification/src/extractor.d.ts +29 -0
  237. package/dist/packages/verification/src/extractor.js +302 -0
  238. package/dist/packages/verification/src/impact-scanner.d.ts +9 -0
  239. package/dist/packages/verification/src/impact-scanner.js +181 -0
  240. package/dist/packages/verification/src/index.js +5 -0
  241. package/dist/packages/verification/src/services.d.ts +55 -0
  242. package/dist/packages/verification/src/services.js +189 -0
  243. package/dist/packages/verification/src/verifier.d.ts +15 -0
  244. package/dist/packages/verification/src/verifier.js +315 -0
  245. package/dist/packages/workspace/src/detector.d.ts +7 -0
  246. package/dist/packages/workspace/src/detector.js +117 -0
  247. package/dist/packages/workspace/src/ecosystems/cargo.d.ts +10 -0
  248. package/dist/packages/workspace/src/ecosystems/cargo.js +69 -0
  249. package/dist/packages/workspace/src/ecosystems/composer.d.ts +7 -0
  250. package/dist/packages/workspace/src/ecosystems/composer.js +40 -0
  251. package/dist/packages/workspace/src/ecosystems/go.d.ts +7 -0
  252. package/dist/packages/workspace/src/ecosystems/go.js +49 -0
  253. package/{packages/workspace/src/ecosystems/index.ts → dist/packages/workspace/src/ecosystems/index.d.ts} +2 -24
  254. package/dist/packages/workspace/src/ecosystems/index.js +21 -0
  255. package/dist/packages/workspace/src/ecosystems/maven.d.ts +7 -0
  256. package/dist/packages/workspace/src/ecosystems/maven.js +28 -0
  257. package/dist/packages/workspace/src/ecosystems/npm.d.ts +10 -0
  258. package/dist/packages/workspace/src/ecosystems/npm.js +73 -0
  259. package/dist/packages/workspace/src/ecosystems/pub.d.ts +7 -0
  260. package/dist/packages/workspace/src/ecosystems/pub.js +34 -0
  261. package/dist/packages/workspace/src/ecosystems/pypi.d.ts +9 -0
  262. package/dist/packages/workspace/src/ecosystems/pypi.js +94 -0
  263. package/dist/packages/workspace/src/ecosystems/rubygems.d.ts +7 -0
  264. package/dist/packages/workspace/src/ecosystems/rubygems.js +25 -0
  265. package/dist/packages/workspace/src/ecosystems/types.d.ts +9 -0
  266. package/dist/packages/workspace/src/ecosystems/types.js +1 -0
  267. package/dist/packages/workspace/src/index.js +5 -0
  268. package/dist/packages/workspace/src/lockfile.d.ts +21 -0
  269. package/dist/packages/workspace/src/lockfile.js +153 -0
  270. package/dist/packages/workspace/src/resolver.d.ts +39 -0
  271. package/dist/packages/workspace/src/resolver.js +164 -0
  272. package/dist/packages/workspace/src/semver.d.ts +33 -0
  273. package/dist/packages/workspace/src/semver.js +235 -0
  274. package/package.json +13 -9
  275. package/apps/cli/bin/docorbit.js +0 -8
  276. package/apps/cli/src/commands/add.ts +0 -44
  277. package/apps/cli/src/commands/api.ts +0 -38
  278. package/apps/cli/src/commands/context.ts +0 -47
  279. package/apps/cli/src/commands/dashboard.ts +0 -55
  280. package/apps/cli/src/commands/diff.ts +0 -30
  281. package/apps/cli/src/commands/evaluate.ts +0 -133
  282. package/apps/cli/src/commands/examples.ts +0 -39
  283. package/apps/cli/src/commands/export.ts +0 -89
  284. package/apps/cli/src/commands/impact.ts +0 -31
  285. package/apps/cli/src/commands/init.ts +0 -69
  286. package/apps/cli/src/commands/inspect.ts +0 -30
  287. package/apps/cli/src/commands/mcp.ts +0 -72
  288. package/apps/cli/src/commands/pitfalls.ts +0 -38
  289. package/apps/cli/src/commands/recipes.ts +0 -35
  290. package/apps/cli/src/commands/search.ts +0 -48
  291. package/apps/cli/src/commands/update.ts +0 -73
  292. package/apps/cli/src/commands/verify.ts +0 -48
  293. package/apps/cli/src/formatters/colors.ts +0 -23
  294. package/apps/cli/src/formatters/inspection.ts +0 -102
  295. package/apps/cli/src/formatters/knowledge.ts +0 -272
  296. package/apps/cli/src/formatters/retrieval.ts +0 -74
  297. package/apps/cli/src/formatters/verification.ts +0 -126
  298. package/apps/cli/src/index.ts +0 -409
  299. package/packages/core/src/dashboard/server.ts +0 -314
  300. package/packages/core/src/implementation-service.ts +0 -451
  301. package/packages/core/src/inspector.ts +0 -71
  302. package/packages/core/src/pipeline.ts +0 -331
  303. package/packages/crawler/src/config.ts +0 -12
  304. package/packages/crawler/src/fetcher.ts +0 -185
  305. package/packages/discovery/src/index.ts +0 -31
  306. package/packages/discovery/src/provider.ts +0 -47
  307. package/packages/discovery/src/providers/generic.ts +0 -98
  308. package/packages/discovery/src/providers/github.ts +0 -61
  309. package/packages/discovery/src/providers/llms-txt.ts +0 -73
  310. package/packages/discovery/src/providers/markdown.ts +0 -48
  311. package/packages/discovery/src/providers/openapi.ts +0 -91
  312. package/packages/discovery/src/providers/sitemap.ts +0 -62
  313. package/packages/discovery/src/providers/skill.ts +0 -54
  314. package/packages/discovery/src/ranker.ts +0 -123
  315. package/packages/evaluation/src/dataset.ts +0 -963
  316. package/packages/evaluation/src/runner.ts +0 -241
  317. package/packages/evaluation/src/strategies/context7-runner.ts +0 -269
  318. package/packages/evaluation/src/strategies/docorbit-runner.ts +0 -228
  319. package/packages/evaluation/src/strategies/firecrawl-runner.ts +0 -172
  320. package/packages/evaluation/src/strategies/web-search-runner.ts +0 -194
  321. package/packages/evaluation/src/types.ts +0 -34
  322. package/packages/evaluation/src/version-matcher.ts +0 -73
  323. package/packages/export/src/agents-md.ts +0 -200
  324. package/packages/export/src/claude-md.ts +0 -141
  325. package/packages/export/src/docs-map.ts +0 -150
  326. package/packages/export/src/llms-txt.ts +0 -96
  327. package/packages/export/src/service.ts +0 -250
  328. package/packages/export/src/skill-md.ts +0 -128
  329. package/packages/mcp/src/resources/index.ts +0 -189
  330. package/packages/mcp/src/server.ts +0 -278
  331. package/packages/mcp/src/tools/analyze-impact.ts +0 -74
  332. package/packages/mcp/src/tools/check-api.ts +0 -86
  333. package/packages/mcp/src/tools/diff-docs.ts +0 -68
  334. package/packages/mcp/src/tools/export-context.ts +0 -73
  335. package/packages/mcp/src/tools/find-api.ts +0 -99
  336. package/packages/mcp/src/tools/find-example.ts +0 -100
  337. package/packages/mcp/src/tools/find-pitfall.ts +0 -94
  338. package/packages/mcp/src/tools/find-recipe.ts +0 -98
  339. package/packages/mcp/src/tools/get-doc.ts +0 -130
  340. package/packages/mcp/src/tools/get-docs-map.ts +0 -64
  341. package/packages/mcp/src/tools/get-version.ts +0 -118
  342. package/packages/mcp/src/tools/implementation-context.ts +0 -88
  343. package/packages/mcp/src/tools/index.ts +0 -59
  344. package/packages/mcp/src/tools/list-sources.ts +0 -85
  345. package/packages/mcp/src/tools/search-docs.ts +0 -123
  346. package/packages/mcp/src/tools/types.ts +0 -28
  347. package/packages/mcp/src/transports/http.ts +0 -256
  348. package/packages/mcp/src/transports/stdio.ts +0 -105
  349. package/packages/mcp/src/types.ts +0 -102
  350. package/packages/normalizer/src/example-indexer.ts +0 -240
  351. package/packages/normalizer/src/html.ts +0 -253
  352. package/packages/normalizer/src/llms.ts +0 -83
  353. package/packages/normalizer/src/openapi/endpoint-parser.ts +0 -406
  354. package/packages/normalizer/src/openapi/schema-resolver.ts +0 -111
  355. package/packages/normalizer/src/page.ts +0 -184
  356. package/packages/normalizer/src/pitfall-extractor.ts +0 -190
  357. package/packages/normalizer/src/slicer.ts +0 -455
  358. package/packages/retrieval/src/engine.ts +0 -120
  359. package/packages/retrieval/src/intent.ts +0 -43
  360. package/packages/retrieval/src/packer.ts +0 -145
  361. package/packages/retrieval/src/recipe-engine.ts +0 -313
  362. package/packages/retrieval/src/scorer.ts +0 -139
  363. package/packages/retrieval/src/weights.ts +0 -31
  364. package/packages/security/src/annotations.ts +0 -112
  365. package/packages/security/src/ssrf.ts +0 -153
  366. package/packages/shared/src/errors.ts +0 -53
  367. package/packages/shared/src/hashing.ts +0 -23
  368. package/packages/shared/src/types.ts +0 -881
  369. package/packages/storage/src/db.ts +0 -72
  370. package/packages/storage/src/interfaces.ts +0 -115
  371. package/packages/storage/src/repositories/api-repository.ts +0 -219
  372. package/packages/storage/src/repositories/chunk-repository.ts +0 -316
  373. package/packages/storage/src/repositories/example-repository.ts +0 -206
  374. package/packages/storage/src/repositories/page-repository.ts +0 -205
  375. package/packages/storage/src/repositories/pitfall-repository.ts +0 -188
  376. package/packages/storage/src/repositories/source-repository.ts +0 -205
  377. package/packages/storage/src/repository.ts +0 -256
  378. package/packages/storage/src/search-tokens.ts +0 -28
  379. package/packages/verification/src/diff-engine.ts +0 -258
  380. package/packages/verification/src/extractor.ts +0 -339
  381. package/packages/verification/src/impact-scanner.ts +0 -203
  382. package/packages/verification/src/services.ts +0 -238
  383. package/packages/verification/src/verifier.ts +0 -375
  384. package/packages/workspace/src/detector.ts +0 -143
  385. package/packages/workspace/src/ecosystems/cargo.ts +0 -84
  386. package/packages/workspace/src/ecosystems/composer.ts +0 -42
  387. package/packages/workspace/src/ecosystems/go.ts +0 -54
  388. package/packages/workspace/src/ecosystems/maven.ts +0 -34
  389. package/packages/workspace/src/ecosystems/npm.ts +0 -83
  390. package/packages/workspace/src/ecosystems/pub.ts +0 -40
  391. package/packages/workspace/src/ecosystems/pypi.ts +0 -100
  392. package/packages/workspace/src/ecosystems/rubygems.ts +0 -30
  393. package/packages/workspace/src/ecosystems/types.ts +0 -18
  394. package/packages/workspace/src/lockfile.ts +0 -194
  395. package/packages/workspace/src/resolver.ts +0 -234
  396. package/packages/workspace/src/semver.ts +0 -259
  397. /package/{packages/crawler/src/index.ts → dist/packages/crawler/src/index.d.ts} +0 -0
  398. /package/{packages/evaluation/src/index.ts → dist/packages/evaluation/src/index.d.ts} +0 -0
  399. /package/{packages/export/src/index.ts → dist/packages/export/src/index.d.ts} +0 -0
  400. /package/{packages/normalizer/src/openapi.ts → dist/packages/normalizer/src/openapi.d.ts} +0 -0
  401. /package/{packages/security/src/index.ts → dist/packages/security/src/index.d.ts} +0 -0
  402. /package/{packages/shared/src/index.ts → dist/packages/shared/src/index.d.ts} +0 -0
  403. /package/{packages/storage/src/index.ts → dist/packages/storage/src/index.d.ts} +0 -0
  404. /package/{packages/verification/src/index.ts → dist/packages/verification/src/index.d.ts} +0 -0
  405. /package/{packages/workspace/src/index.ts → dist/packages/workspace/src/index.d.ts} +0 -0
@@ -1,73 +0,0 @@
1
- import { resolve } from 'node:path';
2
- import { DocOrbitDb, DocOrbitRepository } from '../../../../packages/storage/src/index.ts';
3
- import {
4
- detectWorkspaceDependencies,
5
- readDocsLock,
6
- updateDocsLock,
7
- writeDocsLock,
8
- } from '../../../../packages/workspace/src/index.ts';
9
- import { runInitCommand } from './init.ts';
10
-
11
- export interface UpdateCommandOptions {
12
- json?: boolean;
13
- dbPath?: string;
14
- projectDir?: string;
15
- }
16
-
17
- export async function runUpdateCommand(
18
- targetPackage?: string,
19
- options: UpdateCommandOptions = {}
20
- ): Promise<void> {
21
- const projectDir = resolve(options.projectDir || '.');
22
- const existingLock = readDocsLock(projectDir);
23
-
24
- if (!existingLock) {
25
- console.log(`No docs.lock found at ${projectDir}. Initializing first...`);
26
- await runInitCommand(projectDir, { json: options.json, dbPath: options.dbPath });
27
- return;
28
- }
29
-
30
- const dbPath = options.dbPath || '.docorbit/docorbit.db';
31
- const db = new DocOrbitDb(dbPath);
32
- const repository = new DocOrbitRepository(db);
33
-
34
- try {
35
- const scanResult = detectWorkspaceDependencies(projectDir);
36
- const updated = updateDocsLock(scanResult, repository, existingLock, targetPackage);
37
-
38
- writeDocsLock(projectDir, updated);
39
-
40
- if (options.json) {
41
- console.log(JSON.stringify(updated, null, 2));
42
- return;
43
- }
44
-
45
- console.log(`\n=== DocOrbit docs.lock Updated ===`);
46
- if (targetPackage) {
47
- console.log(`Target Package: ${targetPackage}`);
48
- } else {
49
- console.log(`Updated all resolved dependencies.`);
50
- }
51
-
52
- const lockedCount = Object.keys(updated.dependencies).length;
53
- console.log(`Total Locked Docs: ${lockedCount}\n`);
54
-
55
- console.log('-----------------------------------------------------------------------------');
56
- console.log('| Package | Project Ver | Doc Ver | Match | Confidence |');
57
- console.log('-----------------------------------------------------------------------------');
58
- for (const [key, dep] of Object.entries(updated.dependencies)) {
59
- const pkgPad = key.padEnd(21).slice(0, 21);
60
- const projPad = dep.resolvedDependencyVersion.padEnd(11).slice(0, 11);
61
- const docPad = dep.docVersion.padEnd(8).slice(0, 8);
62
- const matchPad = dep.matchType.padEnd(11).slice(0, 11);
63
- const confPad = (dep.confidence * 100).toFixed(0) + '%';
64
- console.log(`| ${pkgPad} | ${projPad} | ${docPad} | ${matchPad} | ${confPad.padEnd(10)} |`);
65
- }
66
- console.log('-----------------------------------------------------------------------------\n');
67
- } catch (err: unknown) {
68
- console.error(`DocOrbit Update Error: ${err instanceof Error ? err.message : String(err)}`);
69
- process.exit(1);
70
- } finally {
71
- db.close();
72
- }
73
- }
@@ -1,48 +0,0 @@
1
- import * as fs from 'node:fs';
2
- import { DocOrbitDb, DocOrbitRepository } from '../../../../packages/storage/src/index.ts';
3
- import { VerificationService } from '../../../../packages/verification/src/index.ts';
4
- import type { VerifyCommandOptions } from '../../../../packages/shared/src/index.ts';
5
- import { formatVerificationReport } from '../formatters/terminal.ts';
6
-
7
- export async function runVerifyCommand(codeOrFile: string = '', options: VerifyCommandOptions = {}): Promise<void> {
8
- if (!codeOrFile) {
9
- console.error('Error: "verify" command requires code snippet or file path as an argument.');
10
- process.exit(1);
11
- }
12
-
13
- let code = codeOrFile;
14
- let filePath: string | undefined;
15
-
16
- // Check if argument is a file path
17
- if (fs.existsSync(codeOrFile) && fs.statSync(codeOrFile).isFile()) {
18
- filePath = codeOrFile;
19
- code = fs.readFileSync(codeOrFile, 'utf8');
20
- }
21
-
22
- const dbPath = options.dbPath || '.docorbit/docorbit.db';
23
- const db = new DocOrbitDb(dbPath);
24
- const repo = new DocOrbitRepository(db);
25
-
26
- try {
27
- const service = new VerificationService(repo);
28
- const { result } = service.verifyCode({
29
- code,
30
- filePath,
31
- language: options.language,
32
- library: options.library,
33
- version: options.docVersion,
34
- projectDir: options.projectDir || process.cwd(),
35
- });
36
-
37
- if (options.json) {
38
- console.log(JSON.stringify(result, null, 2));
39
- } else {
40
- console.log(formatVerificationReport(result));
41
- }
42
- } catch (err: unknown) {
43
- console.error(`DocOrbit Verify Error: ${err instanceof Error ? err.message : String(err)}`);
44
- process.exit(1);
45
- } finally {
46
- db.close();
47
- }
48
- }
@@ -1,23 +0,0 @@
1
- // ANSI colors
2
- export const RESET = '\x1b[0m';
3
- export const BOLD = '\x1b[1m';
4
- export const DIM = '\x1b[2m';
5
- export const GREEN = '\x1b[32m';
6
- export const BLUE = '\x1b[34m';
7
- export const CYAN = '\x1b[36m';
8
- export const YELLOW = '\x1b[33m';
9
- export const RED = '\x1b[31m';
10
- export const MAGENTA = '\x1b[35m';
11
-
12
- export const c = {
13
- bold: (s: string) => `${BOLD}${s}${RESET}`,
14
- dim: (s: string) => `${DIM}${s}${RESET}`,
15
- green: (s: string) => `${GREEN}${s}${RESET}`,
16
- blue: (s: string) => `${BLUE}${s}${RESET}`,
17
- cyan: (s: string) => `${CYAN}${s}${RESET}`,
18
- yellow: (s: string) => `${YELLOW}${s}${RESET}`,
19
- red: (s: string) => `${RED}${s}${RESET}`,
20
- magenta: (s: string) => `${MAGENTA}${s}${RESET}`,
21
- gray: (s: string) => `${DIM}${s}${RESET}`,
22
- underline: (s: string) => `\x1b[4m${s}${RESET}`,
23
- };
@@ -1,102 +0,0 @@
1
- import type { InspectionReport, IngestionResult } from '../../../../packages/core/src/index.ts';
2
- import { RESET, BOLD, DIM, GREEN, BLUE, CYAN, YELLOW, RED, MAGENTA } from './colors.ts';
3
-
4
- export function formatInspectionReport(report: InspectionReport): string {
5
- const lines: string[] = [];
6
-
7
- lines.push('');
8
- lines.push(`${BOLD}${CYAN}DocOrbit${RESET} ${DIM}— Documentation Intelligence Report${RESET}`);
9
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
10
- lines.push(`${BOLD}Target URL:${RESET} ${BLUE}${report.targetUrl}${RESET}`);
11
- lines.push('');
12
-
13
- // Sources Table
14
- lines.push(`${BOLD}Discovered Sources (${report.summary.totalFound}):${RESET}`);
15
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
16
-
17
- if (report.sourcesDiscovered.length === 0) {
18
- lines.push(` ${YELLOW}No machine-readable sources discovered.${RESET}`);
19
- } else {
20
- for (const src of report.sourcesDiscovered) {
21
- const icon = src.status === 'valid' ? `${GREEN}✓${RESET}` : `${RED}✗${RESET}`;
22
- const typeStr = `[${src.type}]`.padEnd(16);
23
- const mr = src.machineReadable ? `${GREEN}machine-readable${RESET}` : `${DIM}human-html${RESET}`;
24
- const auth = `${src.authority}`;
25
- lines.push(` ${icon} ${BOLD}${typeStr}${RESET} ${mr.padEnd(26)} ${DIM}(${auth}, conf: ${Math.round(src.confidence * 100)}%)${RESET}`);
26
- lines.push(` ${DIM}↳ ${src.url}${RESET}`);
27
- }
28
- }
29
-
30
- lines.push('');
31
- lines.push(`${BOLD}Purpose-Based Source Recommendations:${RESET}`);
32
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
33
-
34
- const purposes = [
35
- { key: 'navigation', label: 'Navigation ' },
36
- { key: 'conceptual', label: 'Conceptual ' },
37
- { key: 'api', label: 'API Reference ' },
38
- { key: 'examples', label: 'Code Examples ' },
39
- { key: 'implementation', label: 'Implementation' },
40
- ] as const;
41
-
42
- for (const p of purposes) {
43
- const rec = report.recommendations[p.key];
44
- if (rec && rec.recommended) {
45
- lines.push(` ${CYAN}${p.label}${RESET} → ${GREEN}${rec.recommended.type}${RESET} ${DIM}(${rec.recommended.url})${RESET}`);
46
- } else {
47
- lines.push(` ${CYAN}${p.label}${RESET} → ${DIM}No dedicated source${RESET}`);
48
- }
49
- }
50
-
51
- lines.push('');
52
- lines.push(`${BOLD}Summary:${RESET}`);
53
- lines.push(` Machine-readable sources: ${GREEN}${report.summary.machineReadableCount}${RESET}`);
54
- lines.push(` Official sources: ${GREEN}${report.summary.officialCount}${RESET}`);
55
- lines.push(` OpenAPI detected: ${report.summary.hasOpenApi ? `${GREEN}Yes${RESET}` : `${DIM}No${RESET}`}`);
56
- lines.push(` llms.txt detected: ${report.summary.hasLlmsTxt ? `${GREEN}Yes${RESET}` : `${DIM}No${RESET}`}`);
57
- lines.push(` skill.md detected: ${report.summary.hasSkill ? `${GREEN}Yes${RESET}` : `${DIM}No${RESET}`}`);
58
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
59
- lines.push('');
60
-
61
- return lines.join('\n');
62
- }
63
-
64
- export function formatIngestionResult(result: IngestionResult): string {
65
- const lines: string[] = [];
66
-
67
- lines.push('');
68
- lines.push(`${BOLD}${GREEN}DocOrbit${RESET} ${DIM}— Documentation Ingested Successfully${RESET}`);
69
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
70
- lines.push(`${BOLD}Target URL:${RESET} ${BLUE}${result.targetUrl}${RESET}`);
71
- lines.push(`${BOLD}Snapshot ID:${RESET} ${MAGENTA}${result.snapshotId}${RESET}`);
72
- lines.push(`${BOLD}Duration:${RESET} ${result.durationMs}ms`);
73
- lines.push('');
74
-
75
- lines.push(`${BOLD}Ingested Pages (${result.pages.length}):${RESET}`);
76
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
77
-
78
- for (let i = 0; i < result.pages.length; i++) {
79
- const p = result.pages[i];
80
- const warnBadge = p.securityAnnotations.length > 0
81
- ? ` ${YELLOW}[${p.securityAnnotations.length} alert(s)]${RESET}`
82
- : '';
83
- lines.push(` ${BOLD}${i + 1}.${RESET} ${CYAN}${p.title}${RESET}${warnBadge}`);
84
- lines.push(` ${DIM}URL: ${p.url}${RESET}`);
85
- lines.push(` ${DIM}Tokens: ~${p.estimatedTokens} | Code blocks: ${p.codeExamples.length} | Hash: ${p.contentHash.slice(0, 8)}${RESET}`);
86
- }
87
-
88
- lines.push('');
89
- lines.push(`${BOLD}Ingestion Summary:${RESET}`);
90
- lines.push(` Total Pages: ${BOLD}${result.stats.totalPages}${RESET}`);
91
- lines.push(` Total Raw Bytes: ${(result.stats.totalBytes / 1024).toFixed(1)} KB`);
92
- lines.push(` Estimated Tokens: ~${result.stats.totalEstimatedTokens}`);
93
- lines.push(` Total Code Examples: ${result.stats.totalCodeExamples}`);
94
- lines.push(` Machine-readable types: ${result.stats.machineReadableSources}`);
95
- if (result.stats.totalChunks !== undefined) {
96
- lines.push(` Total Chunks: ${BOLD}${result.stats.totalChunks}${RESET}`);
97
- }
98
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
99
- lines.push('');
100
-
101
- return lines.join('\n');
102
- }
@@ -1,272 +0,0 @@
1
- import type {
2
- ApiEndpoint,
3
- IndexedExample,
4
- Pitfall,
5
- Recipe,
6
- } from '../../../../packages/shared/src/index.ts';
7
- import { RESET, BOLD, DIM, GREEN, BLUE, CYAN, YELLOW, RED, MAGENTA } from './colors.ts';
8
-
9
- export function formatApiEndpoints(
10
- endpoints: ApiEndpoint[],
11
- query?: string
12
- ): string {
13
- const lines: string[] = [];
14
-
15
- lines.push('');
16
- lines.push(`${BOLD}${CYAN}DocOrbit${RESET} ${DIM}— API Intelligence for: "${query || '*'}"${RESET}`);
17
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
18
-
19
- if (endpoints.length === 0) {
20
- lines.push(` ${YELLOW}No matching API endpoints found.${RESET}`);
21
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
22
- lines.push('');
23
- return lines.join('\n');
24
- }
25
-
26
- for (let i = 0; i < endpoints.length; i++) {
27
- const ep = endpoints[i];
28
- let methodColor = GREEN;
29
- if (ep.method === 'post') methodColor = BLUE;
30
- else if (ep.method === 'put') methodColor = YELLOW;
31
- else if (ep.method === 'delete') methodColor = RED;
32
- else if (ep.method === 'patch') methodColor = MAGENTA;
33
-
34
- const methodBadge = `${methodColor}${BOLD}[${ep.method.toUpperCase()}]${RESET}`;
35
- const depBadge = ep.deprecated ? ` ${RED}${BOLD}[DEPRECATED]${RESET}` : '';
36
- const verBadge = ep.docVersion ? ` ${DIM}(${ep.docVersion})${RESET}` : '';
37
-
38
- lines.push(` ${BOLD}${i + 1}.${RESET} ${methodBadge} ${BOLD}${CYAN}${ep.path}${RESET}${depBadge}${verBadge}`);
39
- if (ep.summary) {
40
- lines.push(` ${BOLD}${ep.summary}${RESET}`);
41
- }
42
- if (ep.description && ep.description !== ep.summary) {
43
- lines.push(` ${DIM}${ep.description.slice(0, 120)}${ep.description.length > 120 ? '...' : ''}${RESET}`);
44
- }
45
-
46
- if (ep.parameters.length > 0) {
47
- const paramStr = ep.parameters.map(p => {
48
- const req = p.required ? `${RED}*${RESET}` : '';
49
- return `${p.name}${req} (${p.in}:${p.type || 'any'})`;
50
- }).join(', ');
51
- lines.push(` ${DIM}Params: ${paramStr}${RESET}`);
52
- }
53
-
54
- if (ep.auth.length > 0) {
55
- const authStr = ep.auth.map(a => `${a.type}${a.scheme ? `:${a.scheme}` : ''}`).join(', ');
56
- lines.push(` ${DIM}Auth: ${authStr}${RESET}`);
57
- }
58
-
59
- if (ep.pagination) {
60
- lines.push(` ${DIM}Pagination: ${ep.pagination.type} (${ep.pagination.parameters.join(', ')})${RESET}`);
61
- }
62
-
63
- if (ep.errors.length > 0) {
64
- const errorCodes = ep.errors.map(e => e.statusCode).join(', ');
65
- lines.push(` ${DIM}Error Codes: ${errorCodes}${RESET}`);
66
- }
67
-
68
- if (ep.provenance?.sourceUrl) {
69
- lines.push(` ${DIM}Source: ${ep.provenance.sourceUrl}${RESET}`);
70
- }
71
- lines.push('');
72
- }
73
-
74
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
75
- lines.push('');
76
- return lines.join('\n');
77
- }
78
-
79
- export function formatIndexedExamples(
80
- examples: IndexedExample[],
81
- task?: string
82
- ): string {
83
- const lines: string[] = [];
84
-
85
- lines.push('');
86
- lines.push(`${BOLD}${CYAN}DocOrbit${RESET} ${DIM}— Code Example Intelligence for: "${task || '*'}"${RESET}`);
87
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
88
-
89
- if (examples.length === 0) {
90
- lines.push(` ${YELLOW}No matching code examples found.${RESET}`);
91
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
92
- lines.push('');
93
- return lines.join('\n');
94
- }
95
-
96
- for (let i = 0; i < examples.length; i++) {
97
- const ex = examples[i];
98
- const fwBadge = ex.framework ? ` ${MAGENTA}[${ex.framework}]${RESET}` : '';
99
- const langBadge = `${GREEN}[${ex.language}]${RESET}`;
100
- const verBadge = ex.docVersion ? ` ${DIM}(${ex.docVersion})${RESET}` : '';
101
- const authBadge = ex.sourceAuthority === 'official' ? `${BLUE}[official]${RESET}` : `${DIM}[community]${RESET}`;
102
-
103
- lines.push(` ${BOLD}${i + 1}.${RESET} ${CYAN}${ex.task}${RESET} ${langBadge}${fwBadge} ${authBadge}${verBadge}`);
104
- if (ex.relatedApi) {
105
- lines.push(` ${BOLD}Target API:${RESET} ${BLUE}${ex.relatedApi}${RESET}`);
106
- }
107
- if (ex.relatedSymbol) {
108
- lines.push(` ${BOLD}Symbol:${RESET} ${MAGENTA}${ex.relatedSymbol}${RESET}`);
109
- }
110
-
111
- lines.push(` ${DIM}┌── code snippet ──────────────────────────${RESET}`);
112
- const codeLines = ex.code.split('\n').slice(0, 15);
113
- for (const cl of codeLines) {
114
- lines.push(` ${DIM}│${RESET} ${cl}`);
115
- }
116
- if (ex.code.split('\n').length > 15) {
117
- lines.push(` ${DIM}│ ... (${ex.code.split('\n').length - 15} more lines)${RESET}`);
118
- }
119
- lines.push(` ${DIM}└──────────────────────────────────────────${RESET}`);
120
- lines.push(` ${DIM}Source: ${ex.sourceUrl}${RESET}`);
121
- lines.push('');
122
- }
123
-
124
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
125
- lines.push('');
126
- return lines.join('\n');
127
- }
128
-
129
- export function formatPitfalls(
130
- pitfalls: Pitfall[],
131
- task?: string
132
- ): string {
133
- const lines: string[] = [];
134
-
135
- lines.push('');
136
- lines.push(`${BOLD}${YELLOW}DocOrbit${RESET} ${DIM}— Pitfalls & Warnings for: "${task || '*'}"${RESET}`);
137
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
138
-
139
- if (pitfalls.length === 0) {
140
- lines.push(` ${GREEN}No matching pitfalls or warnings found.${RESET}`);
141
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
142
- lines.push('');
143
- return lines.join('\n');
144
- }
145
-
146
- for (let i = 0; i < pitfalls.length; i++) {
147
- const pf = pitfalls[i];
148
- let badgeColor = YELLOW;
149
- if (pf.kind === 'breaking_change' || pf.kind === 'removed' || pf.kind === 'security') {
150
- badgeColor = RED;
151
- } else if (pf.kind === 'deprecated') {
152
- badgeColor = MAGENTA;
153
- }
154
-
155
- const kindBadge = `${badgeColor}${BOLD}[${pf.kind.toUpperCase().replace(/_/g, ' ')}]${RESET}`;
156
- const verBadge = pf.docVersion ? ` ${DIM}(${pf.docVersion})${RESET}` : '';
157
-
158
- lines.push(` ${BOLD}${i + 1}.${RESET} ${kindBadge} ${BOLD}${pf.title}${RESET}${verBadge}`);
159
- if (pf.relatedApi) {
160
- lines.push(` ${DIM}Related API: ${BLUE}${pf.relatedApi}${RESET}`);
161
- }
162
- lines.push(` ${DIM}│${RESET} ${pf.content}`);
163
- if (pf.provenance?.sourceUrl) {
164
- lines.push(` ${DIM}Source: ${pf.provenance.sourceUrl}${RESET}`);
165
- }
166
- lines.push('');
167
- }
168
-
169
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
170
- lines.push('');
171
- return lines.join('\n');
172
- }
173
-
174
- export function formatRecipe(recipe: Recipe): string {
175
- const lines: string[] = [];
176
-
177
- const confidencePct = Math.round(recipe.confidence * 100);
178
- const confColor = confidencePct >= 70 ? GREEN : (confidencePct >= 40 ? YELLOW : RED);
179
-
180
- lines.push('');
181
- lines.push(`${BOLD}${GREEN}DocOrbit${RESET} ${DIM}— Implementation Recipe${RESET}`);
182
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
183
- lines.push(`${BOLD}Goal:${RESET} ${CYAN}${recipe.goal}${RESET}`);
184
- lines.push(`${BOLD}Confidence:${RESET} ${confColor}${confidencePct}%${RESET}`);
185
- if (recipe.docVersion) {
186
- lines.push(`${BOLD}Version:${RESET} ${MAGENTA}${recipe.docVersion}${RESET}`);
187
- }
188
- lines.push('');
189
-
190
- // Prerequisites
191
- lines.push(`${BOLD}Prerequisites (${recipe.prerequisites.length}):${RESET}`);
192
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
193
- if (recipe.prerequisites.length === 0) {
194
- lines.push(` ${DIM}No special prerequisites documented.${RESET}`);
195
- } else {
196
- for (const pre of recipe.prerequisites) {
197
- const badge = pre.evidenceLevel === 'documented_fact'
198
- ? `${GREEN}[FACT]${RESET}`
199
- : `${YELLOW}[INFERRED]${RESET}`;
200
- lines.push(` • ${badge} ${pre.text}`);
201
- }
202
- }
203
- lines.push('');
204
-
205
- // Ordered Implementation Steps
206
- lines.push(`${BOLD}Implementation Steps (${recipe.orderedSteps.length}):${RESET}`);
207
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
208
- for (const s of recipe.orderedSteps) {
209
- let badge = `${GREEN}[FACT]${RESET}`;
210
- if (s.evidenceLevel === 'inferred_relationship') badge = `${YELLOW}[INFERRED]${RESET}`;
211
- else if (s.evidenceLevel === 'missing_information') badge = `${RED}[MISSING]${RESET}`;
212
-
213
- lines.push(` ${BOLD}${s.step}.${RESET} ${badge} ${BOLD}${CYAN}${s.title}${RESET}`);
214
- if (s.apiEndpoint) {
215
- lines.push(` ${BOLD}API Endpoint:${RESET} ${BLUE}${s.apiEndpoint}${RESET}`);
216
- }
217
- lines.push(` ${s.description}`);
218
-
219
- if (s.exampleCode) {
220
- lines.push(` ${DIM}┌── example ────────────────────────────────${RESET}`);
221
- const codeLines = s.exampleCode.split('\n').slice(0, 10);
222
- for (const cl of codeLines) {
223
- lines.push(` ${DIM}│${RESET} ${cl}`);
224
- }
225
- if (s.exampleCode.split('\n').length > 10) {
226
- lines.push(` ${DIM}│ ... (${s.exampleCode.split('\n').length - 10} more lines)${RESET}`);
227
- }
228
- lines.push(` ${DIM}└──────────────────────────────────────────${RESET}`);
229
- }
230
-
231
- if (s.pitfalls && s.pitfalls.length > 0) {
232
- for (const pf of s.pitfalls) {
233
- lines.push(` ${YELLOW}⚠ ${pf}${RESET}`);
234
- }
235
- }
236
- if (s.sourceUrl) {
237
- lines.push(` ${DIM}Source: ${s.sourceUrl}${RESET}`);
238
- }
239
- lines.push('');
240
- }
241
-
242
- // Evidence-Based Validation Steps
243
- lines.push(`${BOLD}Validation Steps (${recipe.validationSteps.length}):${RESET}`);
244
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
245
- for (const vs of recipe.validationSteps) {
246
- let badge = `${GREEN}[FACT]${RESET}`;
247
- if (vs.evidenceLevel === 'inferred_relationship') badge = `${YELLOW}[INFERRED]${RESET}`;
248
- else if (vs.evidenceLevel === 'missing_information') badge = `${RED}[MISSING]${RESET}`;
249
-
250
- lines.push(` ${BOLD}${vs.step}.${RESET} ${badge} ${vs.description}`);
251
- if (vs.expectedResponse) {
252
- lines.push(` ${DIM}Expected Response:${RESET} ${vs.expectedResponse.slice(0, 100)}`);
253
- }
254
- if (vs.testPattern) {
255
- lines.push(` ${DIM}Test Pattern:${RESET} ${vs.testPattern.slice(0, 100)}`);
256
- }
257
- }
258
- lines.push('');
259
-
260
- // Sources consulted
261
- if (recipe.sources.length > 0) {
262
- lines.push(`${BOLD}Sources Consulted:${RESET}`);
263
- for (const src of recipe.sources) {
264
- lines.push(` ${DIM}• ${src}${RESET}`);
265
- }
266
- lines.push('');
267
- }
268
-
269
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
270
- lines.push('');
271
- return lines.join('\n');
272
- }
@@ -1,74 +0,0 @@
1
- import type { SearchResult, ContextPackage } from '../../../../packages/shared/src/index.ts';
2
- import { RESET, BOLD, DIM, GREEN, CYAN, YELLOW, MAGENTA } from './colors.ts';
3
-
4
- export function formatSearchResults(query: string, results: SearchResult[]): string {
5
- const lines: string[] = [];
6
-
7
- lines.push('');
8
- lines.push(`${BOLD}${CYAN}DocOrbit${RESET} ${DIM}— Search Results for: "${query}"${RESET}`);
9
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
10
-
11
- if (results.length === 0) {
12
- lines.push(` ${YELLOW}No matching documentation chunks found.${RESET}`);
13
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
14
- lines.push('');
15
- return lines.join('\n');
16
- }
17
-
18
- for (let i = 0; i < results.length; i++) {
19
- const res = results[i];
20
- const chunk = res.chunk;
21
- const breadcrumb = chunk.sectionPath.length > 0 ? chunk.sectionPath.join(' > ') : (chunk.title || 'General');
22
-
23
- lines.push(` ${BOLD}${i + 1}.${RESET} ${CYAN}${breadcrumb}${RESET} ${GREEN}(Score: ${res.score})${RESET}`);
24
- lines.push(` ${DIM}Type: ${chunk.chunkType} | Est. Tokens: ~${chunk.tokenEstimate} | Chunk: ${chunk.id}${RESET}`);
25
- if (res.matchReasons.length > 0) {
26
- lines.push(` ${DIM}Matches: ${res.matchReasons.join(' • ')}${RESET}`);
27
- }
28
- if (res.symbols.length > 0) {
29
- lines.push(` ${MAGENTA}Symbols: ${res.symbols.map(s => s.name).join(', ')}${RESET}`);
30
- }
31
-
32
- const preview = chunk.content.split('\n').filter(l => l.trim().length > 0).slice(0, 3).join('\n ');
33
- lines.push(` ${DIM}│${RESET} ${preview}`);
34
- lines.push('');
35
- }
36
-
37
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
38
- lines.push('');
39
- return lines.join('\n');
40
- }
41
-
42
- export function formatContextPackage(pkg: ContextPackage): string {
43
- const lines: string[] = [];
44
-
45
- lines.push('');
46
- lines.push(`${BOLD}${GREEN}DocOrbit${RESET} ${DIM}— Assembled Context Package${RESET}`);
47
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
48
- lines.push(`${BOLD}Task:${RESET} ${CYAN}${pkg.task}${RESET}`);
49
- lines.push(`${BOLD}Detected Intent:${RESET} ${MAGENTA}${pkg.detectedIntent}${RESET}`);
50
- lines.push(`${BOLD}Estimated Tokens:${RESET} ~${pkg.totalEstimatedTokens} / ${pkg.tokenBudget} (heuristic)`);
51
- lines.push(`${BOLD}Chunks Included:${RESET} ${pkg.chunks.length}`);
52
- lines.push(`${BOLD}Sources Cited:${RESET} ${pkg.sources.length > 0 ? pkg.sources.join(', ') : 'Local documentation'}`);
53
-
54
- if (pkg.warnings.length > 0) {
55
- lines.push('');
56
- lines.push(`${YELLOW}${BOLD}Advisories & Warnings (${pkg.warnings.length}):${RESET}`);
57
- for (const w of pkg.warnings) {
58
- lines.push(` ${YELLOW}⚠ ${w}${RESET}`);
59
- }
60
- }
61
-
62
- lines.push('');
63
- lines.push(`${BOLD}Package Markdown Preview:${RESET}`);
64
- lines.push(`${DIM}${'─'.repeat(64)}${RESET}`);
65
- const previewLines = pkg.markdown.split('\n').slice(0, 20);
66
- lines.push(previewLines.join('\n'));
67
- if (pkg.markdown.split('\n').length > 20) {
68
- lines.push(`\n${DIM}... (${pkg.markdown.split('\n').length - 20} more lines in full package)${RESET}`);
69
- }
70
- lines.push(`${DIM}${'═'.repeat(64)}${RESET}`);
71
- lines.push('');
72
-
73
- return lines.join('\n');
74
- }