docspack 0.4.0 → 1.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 (79) hide show
  1. package/dist/agent.d.ts +48 -0
  2. package/dist/agent.d.ts.map +1 -0
  3. package/dist/agent.js +243 -0
  4. package/dist/agent.js.map +1 -0
  5. package/dist/artifact.d.ts +32 -0
  6. package/dist/artifact.d.ts.map +1 -0
  7. package/dist/artifact.js +78 -0
  8. package/dist/artifact.js.map +1 -0
  9. package/dist/build.d.ts.map +1 -1
  10. package/dist/build.js +17 -0
  11. package/dist/build.js.map +1 -1
  12. package/dist/changed.d.ts +31 -0
  13. package/dist/changed.d.ts.map +1 -0
  14. package/dist/changed.js +71 -0
  15. package/dist/changed.js.map +1 -0
  16. package/dist/cli.js +131 -10
  17. package/dist/cli.js.map +1 -1
  18. package/dist/coverage.d.ts +35 -0
  19. package/dist/coverage.d.ts.map +1 -0
  20. package/dist/coverage.js +64 -0
  21. package/dist/coverage.js.map +1 -0
  22. package/dist/db.d.ts +38 -2
  23. package/dist/db.d.ts.map +1 -1
  24. package/dist/db.js +109 -6
  25. package/dist/db.js.map +1 -1
  26. package/dist/discovery.d.ts +14 -0
  27. package/dist/discovery.d.ts.map +1 -1
  28. package/dist/discovery.js +31 -6
  29. package/dist/discovery.js.map +1 -1
  30. package/dist/doctor.d.ts.map +1 -1
  31. package/dist/doctor.js +44 -0
  32. package/dist/doctor.js.map +1 -1
  33. package/dist/help.d.ts.map +1 -1
  34. package/dist/help.js +65 -4
  35. package/dist/help.js.map +1 -1
  36. package/dist/index.d.ts +8 -3
  37. package/dist/index.d.ts.map +1 -1
  38. package/dist/index.js +7 -2
  39. package/dist/index.js.map +1 -1
  40. package/dist/mcp.d.ts.map +1 -1
  41. package/dist/mcp.js +3 -0
  42. package/dist/mcp.js.map +1 -1
  43. package/dist/preview.d.ts.map +1 -1
  44. package/dist/preview.js +1 -0
  45. package/dist/preview.js.map +1 -1
  46. package/dist/search.d.ts +14 -1
  47. package/dist/search.d.ts.map +1 -1
  48. package/dist/search.js +108 -21
  49. package/dist/search.js.map +1 -1
  50. package/dist/surface.d.ts +45 -0
  51. package/dist/surface.d.ts.map +1 -0
  52. package/dist/surface.js +208 -0
  53. package/dist/surface.js.map +1 -0
  54. package/dist/sync.d.ts +8 -1
  55. package/dist/sync.d.ts.map +1 -1
  56. package/dist/sync.js +50 -1
  57. package/dist/sync.js.map +1 -1
  58. package/dist/verify.d.ts +9 -0
  59. package/dist/verify.d.ts.map +1 -1
  60. package/dist/verify.js +1 -1
  61. package/dist/verify.js.map +1 -1
  62. package/package.json +1 -1
  63. package/src/agent.ts +308 -0
  64. package/src/artifact.ts +110 -0
  65. package/src/build.ts +19 -0
  66. package/src/changed.ts +99 -0
  67. package/src/cli.ts +167 -10
  68. package/src/coverage.ts +96 -0
  69. package/src/db.ts +168 -7
  70. package/src/discovery.ts +40 -5
  71. package/src/doctor.ts +52 -0
  72. package/src/help.ts +65 -4
  73. package/src/index.ts +30 -0
  74. package/src/mcp.ts +3 -0
  75. package/src/preview.ts +1 -0
  76. package/src/search.ts +148 -22
  77. package/src/surface.ts +265 -0
  78. package/src/sync.ts +66 -2
  79. package/src/verify.ts +1 -1
package/dist/help.js CHANGED
@@ -13,12 +13,21 @@ export const COMMANDS = [
13
13
  summary: "Index the docs packages this project depends on",
14
14
  group: "core",
15
15
  usage: "docspack sync [options]",
16
- options: [["--force", "re-index packages already in the store"]],
16
+ options: [
17
+ ["--force", "re-index packages already in the store"],
18
+ ["--no-artifacts", "skip the declarations derived from installed libraries"],
19
+ ],
17
20
  detail: [
18
21
  "Reads node_modules and indexes every @vendor/docspack and @docspack-community/<name>",
19
22
  "package this project declares. Makes no network requests.",
23
+ "",
24
+ "It also reads each installed library's own type declarations and indexes one entry per",
25
+ "exported name. Half of a well-documented library's exports are mentioned in no",
26
+ "documentation anyone published, and those declarations are the only local answer for",
27
+ "them. They are looked up by name, never ranked against prose, so they cannot crowd out",
28
+ "the documentation that does exist.",
20
29
  ],
21
- examples: ["docspack sync", "docspack sync --force"],
30
+ examples: ["docspack sync", "docspack sync --force", "docspack sync --no-artifacts"],
22
31
  },
23
32
  {
24
33
  name: "ask",
@@ -30,6 +39,10 @@ export const COMMANDS = [
30
39
  "Answers from the installed versions, in the Markdown an agent should read. Exits 0 when",
31
40
  "chunks were returned, 3 when a docs package is installed but not indexed, and 4 when",
32
41
  "everything installed is indexed and nothing matched.",
42
+ "",
43
+ "When the question names something an installed library exports and no documentation",
44
+ "mentions, the answer leads with that name's declaration from the installed build and says",
45
+ "the documentation does not cover it. Ranking alone cannot tell that apart from a match.",
33
46
  ],
34
47
  examples: [
35
48
  'docspack ask "how do I verify a webhook signature"',
@@ -49,9 +62,57 @@ export const COMMANDS = [
49
62
  name: "list",
50
63
  summary: "Show this project's docs packages and their index state",
51
64
  group: "core",
52
- usage: "docspack list",
65
+ usage: "docspack list [options]",
66
+ options: [["--coverage", "how much of each documented library's exports the prose mentions"]],
67
+ detail: [
68
+ "Coverage is mechanical: the exported names a library declares, against the names its",
69
+ "documentation mentions anywhere. It is reported, never gated on — a page listing every",
70
+ "export and explaining none would score full marks.",
71
+ ],
72
+ examples: ["docspack list", "docspack list --coverage", "docspack list --json"],
73
+ },
74
+ {
75
+ name: "agent",
76
+ summary: "Wire docspack into the agent tooling this project already uses",
77
+ group: "core",
78
+ usage: "docspack agent <install|check> [options]",
79
+ options: [
80
+ ["--feedback", "also include recording documentation problems"],
81
+ ["--hooks", "add a SessionStart hook that keeps the index in step"],
82
+ ["--mcp", "add the MCP server to .mcp.json"],
83
+ ["--dry-run", "print what would be written and write nothing"],
84
+ ],
85
+ detail: [
86
+ "`install` writes a marked block into AGENTS.md or CLAUDE.md — whichever the project",
87
+ "already has — and a skill into .claude/skills/docspack/ when the project uses Claude",
88
+ "Code. Everything outside the markers is left alone, and re-running rewrites the block",
89
+ "rather than appending a second copy.",
90
+ "",
91
+ "`check` writes nothing and exits non-zero when the wiring is missing or out of date, so",
92
+ "CI notices a pasted instruction that has drifted from what the tool now does.",
93
+ ],
94
+ examples: [
95
+ "docspack agent install",
96
+ "docspack agent install --feedback --hooks",
97
+ "docspack agent check",
98
+ ],
99
+ },
100
+ {
101
+ name: "changed",
102
+ summary: "What a library's exports gained and lost between two versions",
103
+ group: "core",
104
+ usage: "docspack changed <library>[@version]",
53
105
  options: [],
54
- examples: ["docspack list", "docspack list --json"],
106
+ detail: [
107
+ "Compares two versions already in the global store, which is shared by every project on",
108
+ "this machine, so nothing is fetched. Without a version it compares what is installed here",
109
+ "against the most recently indexed other version.",
110
+ "",
111
+ "Upgrades are overwhelmingly additive: the useful answer is what exists now that an older",
112
+ "release did not have, and which of those names no documentation here mentions — the ones",
113
+ "a model can know from neither its training data nor the vendor's pages.",
114
+ ],
115
+ examples: ["docspack changed hono", "docspack changed hono@4.0.0"],
55
116
  },
56
117
  {
57
118
  name: "verify",
package/dist/help.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAuBhE,MAAM,KAAK,GAAG,CAAC,CAAC;AAChB,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB,MAAM,aAAa,GAA2C;IAC5D,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;IACpE,CAAC,aAAa,EAAE,qCAAqC,KAAK,GAAG,CAAC;IAC9D,CAAC,kBAAkB,EAAE,6CAA6C,UAAU,GAAG,CAAC;IAChF,CAAC,OAAO,EAAE,+CAA+C,CAAC;CAC3D,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAA2B;IAC9C;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,iDAAiD;QAC1D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,yBAAyB;QAChC,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,wCAAwC,CAAC,CAAC;QAChE,MAAM,EAAE;YACN,sFAAsF;YACtF,2DAA2D;SAC5D;QACD,QAAQ,EAAE,CAAC,eAAe,EAAE,uBAAuB,CAAC;KACrD;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,4DAA4D;QACrE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE;YACN,yFAAyF;YACzF,sFAAsF;YACtF,sDAAsD;SACvD;QACD,QAAQ,EAAE;YACR,oDAAoD;YACpD,6DAA6D;SAC9D;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,wDAAwD;QACjE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,yBAAyB;QAChC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,CAAC,gFAAgF,CAAC;QAC1F,QAAQ,EAAE,CAAC,mCAAmC,CAAC;KAChD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,eAAe;QACtB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC,eAAe,EAAE,sBAAsB,CAAC;KACpD;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,sDAAsD;QAC/D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE,CAAC,CAAC,mBAAmB,EAAE,2DAA2D,CAAC,CAAC;QAC7F,MAAM,EAAE;YACN,yFAAyF;YACzF,2FAA2F;YAC3F,6FAA6F;YAC7F,qCAAqC;SACtC;QACD,QAAQ,EAAE,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;KACxD;IACD;QACE,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,sDAAsD;QAC7D,OAAO,EAAE;YACP,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,YAAY,EAAE,kCAAkC,CAAC;YAClD,CAAC,mBAAmB,EAAE,6BAA6B,CAAC;YACpD,CAAC,mBAAmB,EAAE,+CAA+C,CAAC;YACtE,CAAC,iBAAiB,EAAE,4BAA4B,CAAC;YACjD,CAAC,gBAAgB,EAAE,gCAAgC,CAAC;YACpD,CAAC,mBAAmB,EAAE,wDAAwD,CAAC;YAC/E,CAAC,OAAO,EAAE,gCAAgC,CAAC;SAC5C;QACD,MAAM,EAAE;YACN,sFAAsF;YACtF,mDAAmD;YACnD,EAAE;YACF,qFAAqF;YACrF,kFAAkF;YAClF,sFAAsF;SACvF;QACD,QAAQ,EAAE;YACR,mIAAmI;YACnI,wBAAwB;YACxB,0BAA0B;YAC1B,wCAAwC;SACzC;KACF;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,EAAE;QACX,MAAM,EAAE;YACN,uFAAuF;YACvF,sFAAsF;YACtF,mEAAmE;SACpE;QACD,QAAQ,EAAE,CAAC,cAAc,CAAC;KAC3B;IACD;QACE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,sDAAsD;QAC/D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,kBAAkB;QACzB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC,kBAAkB,EAAE,qDAAqD,CAAC;KACtF;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,gCAAgC;QACvC,OAAO,EAAE;YACP,CAAC,WAAW,EAAE,uDAAuD,CAAC;YACtE,CAAC,WAAW,EAAE,uCAAuC,CAAC;YACtD,CAAC,mBAAmB,EAAE,qCAAqC,CAAC;YAC5D,CAAC,aAAa,EAAE,oCAAoC,CAAC;YACrD,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;YAC/C,CAAC,YAAY,EAAE,uBAAuB,CAAC;YACvC,CAAC,eAAe,EAAE,2BAA2B,CAAC;YAC9C,CAAC,YAAY,EAAE,eAAe,CAAC;YAC/B,CAAC,eAAe,EAAE,mCAAmC,CAAC;YACtD,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;YACxC,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,kBAAkB,EAAE,yBAAyB,CAAC;YAC/C,CAAC,aAAa,EAAE,yCAAyC,CAAC;YAC1D,CAAC,SAAS,EAAE,oCAAoC,CAAC;SAClD;QACD,MAAM,EAAE;YACN,mFAAmF;YACnF,0FAA0F;SAC3F;QACD,QAAQ,EAAE;YACR,eAAe;YACf,yDAAyD;YACzD,+CAA+C;SAChD;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,4CAA4C;QACrD,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,mCAAmC;QAC1C,OAAO,EAAE;YACP,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,kBAAkB,EAAE,kDAAkD,CAAC;YACxE,CAAC,eAAe,EAAE,mCAAmC,CAAC;YACtD,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;YACxC,CAAC,aAAa,EAAE,mDAAmD,CAAC;YACpE,CAAC,aAAa,EAAE,iDAAiD,CAAC;YAClE,CAAC,wBAAwB,EAAE,+CAA+C,CAAC;YAC3E,CAAC,wBAAwB,EAAE,yDAAyD,CAAC;YACrF,CAAC,iBAAiB,EAAE,wDAAwD,CAAC;SAC9E;QACD,MAAM,EAAE;YACN,wFAAwF;YACxF,2FAA2F;YAC3F,2FAA2F;YAC3F,iEAAiE;YACjE,EAAE;YACF,sFAAsF;SACvF;QACD,QAAQ,EAAE;YACR,gBAAgB;YAChB,wEAAwE;YACxE,iFAAiF;YACjF,yCAAyC;SAC1C;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE;YACP,CAAC,UAAU,EAAE,uCAAuC,CAAC;YACrD,CAAC,YAAY,EAAE,2CAA2C,CAAC;YAC3D,CAAC,mBAAmB,EAAE,qCAAqC,CAAC;SAC7D;QACD,MAAM,EAAE;YACN,oFAAoF;YACpF,2FAA2F;YAC3F,oFAAoF;SACrF;QACD,QAAQ,EAAE,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,wBAAwB,CAAC;KACpF;IACD;QACE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,oCAAoC;QAC3C,OAAO,EAAE;YACP,CAAC,mBAAmB,EAAE,kCAAkC,CAAC;YACzD,CAAC,aAAa,EAAE,qCAAqC,KAAK,GAAG,CAAC;YAC9D,CAAC,kBAAkB,EAAE,6CAA6C,UAAU,GAAG,CAAC;SACjF;QACD,MAAM,EAAE;YACN,wFAAwF;YACxF,8EAA8E;SAC/E;QACD,QAAQ,EAAE,CAAC,0CAA0C,CAAC;KACvD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,8CAA8C;QACvD,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,wCAAwC;QAC/C,OAAO,EAAE;YACP,CAAC,mBAAmB,EAAE,kCAAkC,CAAC;YACzD,CAAC,aAAa,EAAE,6DAA6D,KAAK,GAAG,CAAC;YACtF,CAAC,kBAAkB,EAAE,0CAA0C,UAAU,GAAG,CAAC;YAC7E,CAAC,oBAAoB,EAAE,oDAAoD,CAAC;SAC7E;QACD,MAAM,EAAE;YACN,2FAA2F;YAC3F,EAAE;YACF,sFAAsF;YACtF,qEAAqE;YACrE,EAAE;YACF,uFAAuF;YACvF,sFAAsF;YACtF,oEAAoE;SACrE;QACD,QAAQ,EAAE;YACR,mCAAmC;YACnC,qDAAqD;YACrD,oDAAoD;SACrD;KACF;CACF,CAAC;AAEF,MAAM,cAAc,GAA2C;IAC7D,CAAC,gBAAgB,EAAE,uBAAuB,CAAC;IAC3C,CAAC,aAAa,EAAE,8BAA8B,CAAC;IAC/C,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IACrC,CAAC,aAAa,EAAE,mBAAmB,CAAC;IACpC,CAAC,YAAY,EAAE,qCAAqC,CAAC;IACrD,CAAC,eAAe,EAAE,kBAAkB,CAAC;CACtC,CAAC;AAEF,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,CAA4B;IACzD,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC;AAClD,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,eAAe,CAAC,OAAoB;IAClD,MAAM,MAAM,GAAa;QACvB,YAAY,OAAO,CAAC,IAAI,MAAM,OAAO,CAAC,OAAO,EAAE;QAC/C,EAAE;QACF,OAAO;QACP,KAAK,OAAO,CAAC,KAAK,EAAE;KACrB,CAAC;IAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,CAAC,IAAI,CACT,EAAE,EACF,gBAAgB,EAChB,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAC1B,EAAE,EACF,UAAU,EACV,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,EACpD,EAAE,CACH,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,UAAkB,EAAE,OAAe;IACnF,MAAM,KAAK,GAAG,CAAC,KAA2B,EAAU,EAAE,CACpD,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;SAClD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;SACtD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,OAAO;;;;;;;EAOP,KAAK,CAAC,MAAM,CAAC;;;EAGb,KAAK,CAAC,WAAW,CAAC;;;;;;;;;;;;;EAalB,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;EAKtD,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;EAMxD,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;yBAEX,SAAS;;;;;;MAM5B,UAAU;;MAEV,OAAO;;;;;;;;;;;CAWZ,CAAC;AACF,CAAC"}
1
+ {"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAuBhE,MAAM,KAAK,GAAG,CAAC,CAAC;AAChB,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB,MAAM,aAAa,GAA2C;IAC5D,CAAC,mBAAmB,EAAE,6CAA6C,CAAC;IACpE,CAAC,aAAa,EAAE,qCAAqC,KAAK,GAAG,CAAC;IAC9D,CAAC,kBAAkB,EAAE,6CAA6C,UAAU,GAAG,CAAC;IAChF,CAAC,OAAO,EAAE,+CAA+C,CAAC;CAC3D,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAA2B;IAC9C;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,iDAAiD;QAC1D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,yBAAyB;QAChC,OAAO,EAAE;YACP,CAAC,SAAS,EAAE,wCAAwC,CAAC;YACrD,CAAC,gBAAgB,EAAE,wDAAwD,CAAC;SAC7E;QACD,MAAM,EAAE;YACN,sFAAsF;YACtF,2DAA2D;YAC3D,EAAE;YACF,wFAAwF;YACxF,gFAAgF;YAChF,sFAAsF;YACtF,wFAAwF;YACxF,oCAAoC;SACrC;QACD,QAAQ,EAAE,CAAC,eAAe,EAAE,uBAAuB,EAAE,8BAA8B,CAAC;KACrF;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,4DAA4D;QACrE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE;YACN,yFAAyF;YACzF,sFAAsF;YACtF,sDAAsD;YACtD,EAAE;YACF,qFAAqF;YACrF,2FAA2F;YAC3F,yFAAyF;SAC1F;QACD,QAAQ,EAAE;YACR,oDAAoD;YACpD,6DAA6D;SAC9D;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,wDAAwD;QACjE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,yBAAyB;QAChC,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,CAAC,gFAAgF,CAAC;QAC1F,QAAQ,EAAE,CAAC,mCAAmC,CAAC;KAChD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,yDAAyD;QAClE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,yBAAyB;QAChC,OAAO,EAAE,CAAC,CAAC,YAAY,EAAE,kEAAkE,CAAC,CAAC;QAC7F,MAAM,EAAE;YACN,sFAAsF;YACtF,wFAAwF;YACxF,oDAAoD;SACrD;QACD,QAAQ,EAAE,CAAC,eAAe,EAAE,0BAA0B,EAAE,sBAAsB,CAAC;KAChF;IACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,gEAAgE;QACzE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,0CAA0C;QACjD,OAAO,EAAE;YACP,CAAC,YAAY,EAAE,+CAA+C,CAAC;YAC/D,CAAC,SAAS,EAAE,sDAAsD,CAAC;YACnE,CAAC,OAAO,EAAE,iCAAiC,CAAC;YAC5C,CAAC,WAAW,EAAE,+CAA+C,CAAC;SAC/D;QACD,MAAM,EAAE;YACN,qFAAqF;YACrF,sFAAsF;YACtF,uFAAuF;YACvF,sCAAsC;YACtC,EAAE;YACF,yFAAyF;YACzF,+EAA+E;SAChF;QACD,QAAQ,EAAE;YACR,wBAAwB;YACxB,2CAA2C;YAC3C,sBAAsB;SACvB;KACF;IACD;QACE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,+DAA+D;QACxE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,sCAAsC;QAC7C,OAAO,EAAE,EAAE;QACX,MAAM,EAAE;YACN,wFAAwF;YACxF,2FAA2F;YAC3F,kDAAkD;YAClD,EAAE;YACF,0FAA0F;YAC1F,0FAA0F;YAC1F,yEAAyE;SAC1E;QACD,QAAQ,EAAE,CAAC,uBAAuB,EAAE,6BAA6B,CAAC;KACnE;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,sDAAsD;QAC/D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE,CAAC,CAAC,mBAAmB,EAAE,2DAA2D,CAAC,CAAC;QAC7F,MAAM,EAAE;YACN,yFAAyF;YACzF,2FAA2F;YAC3F,6FAA6F;YAC7F,qCAAqC;SACtC;QACD,QAAQ,EAAE,CAAC,iBAAiB,EAAE,wBAAwB,CAAC;KACxD;IACD;QACE,IAAI,EAAE,UAAU;QAChB,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,sDAAsD;QAC7D,OAAO,EAAE;YACP,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,YAAY,EAAE,kCAAkC,CAAC;YAClD,CAAC,mBAAmB,EAAE,6BAA6B,CAAC;YACpD,CAAC,mBAAmB,EAAE,+CAA+C,CAAC;YACtE,CAAC,iBAAiB,EAAE,4BAA4B,CAAC;YACjD,CAAC,gBAAgB,EAAE,gCAAgC,CAAC;YACpD,CAAC,mBAAmB,EAAE,wDAAwD,CAAC;YAC/E,CAAC,OAAO,EAAE,gCAAgC,CAAC;SAC5C;QACD,MAAM,EAAE;YACN,sFAAsF;YACtF,mDAAmD;YACnD,EAAE;YACF,qFAAqF;YACrF,kFAAkF;YAClF,sFAAsF;SACvF;QACD,QAAQ,EAAE;YACR,mIAAmI;YACnI,wBAAwB;YACxB,0BAA0B;YAC1B,wCAAwC;SACzC;KACF;IACD;QACE,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,cAAc;QACrB,OAAO,EAAE,EAAE;QACX,MAAM,EAAE;YACN,uFAAuF;YACvF,sFAAsF;YACtF,mEAAmE;SACpE;QACD,QAAQ,EAAE,CAAC,cAAc,CAAC;KAC3B;IACD;QACE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,sDAAsD;QAC/D,KAAK,EAAE,MAAM;QACb,KAAK,EAAE,kBAAkB;QACzB,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,CAAC,kBAAkB,EAAE,qDAAqD,CAAC;KACtF;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,2DAA2D;QACpE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,gCAAgC;QACvC,OAAO,EAAE;YACP,CAAC,WAAW,EAAE,uDAAuD,CAAC;YACtE,CAAC,WAAW,EAAE,uCAAuC,CAAC;YACtD,CAAC,mBAAmB,EAAE,qCAAqC,CAAC;YAC5D,CAAC,aAAa,EAAE,oCAAoC,CAAC;YACrD,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;YAC/C,CAAC,YAAY,EAAE,uBAAuB,CAAC;YACvC,CAAC,eAAe,EAAE,2BAA2B,CAAC;YAC9C,CAAC,YAAY,EAAE,eAAe,CAAC;YAC/B,CAAC,eAAe,EAAE,mCAAmC,CAAC;YACtD,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;YACxC,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,kBAAkB,EAAE,yBAAyB,CAAC;YAC/C,CAAC,aAAa,EAAE,yCAAyC,CAAC;YAC1D,CAAC,SAAS,EAAE,oCAAoC,CAAC;SAClD;QACD,MAAM,EAAE;YACN,mFAAmF;YACnF,0FAA0F;SAC3F;QACD,QAAQ,EAAE;YACR,eAAe;YACf,yDAAyD;YACzD,+CAA+C;SAChD;KACF;IACD;QACE,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,4CAA4C;QACrD,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,mCAAmC;QAC1C,OAAO,EAAE;YACP,CAAC,cAAc,EAAE,kCAAkC,CAAC;YACpD,CAAC,kBAAkB,EAAE,kDAAkD,CAAC;YACxE,CAAC,eAAe,EAAE,mCAAmC,CAAC;YACtD,CAAC,mBAAmB,EAAE,iBAAiB,CAAC;YACxC,CAAC,aAAa,EAAE,mDAAmD,CAAC;YACpE,CAAC,aAAa,EAAE,iDAAiD,CAAC;YAClE,CAAC,wBAAwB,EAAE,+CAA+C,CAAC;YAC3E,CAAC,wBAAwB,EAAE,yDAAyD,CAAC;YACrF,CAAC,iBAAiB,EAAE,wDAAwD,CAAC;SAC9E;QACD,MAAM,EAAE;YACN,wFAAwF;YACxF,2FAA2F;YAC3F,2FAA2F;YAC3F,iEAAiE;YACjE,EAAE;YACF,sFAAsF;SACvF;QACD,QAAQ,EAAE;YACR,gBAAgB;YAChB,wEAAwE;YACxE,iFAAiF;YACjF,yCAAyC;SAC1C;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE;YACP,CAAC,UAAU,EAAE,uCAAuC,CAAC;YACrD,CAAC,YAAY,EAAE,2CAA2C,CAAC;YAC3D,CAAC,mBAAmB,EAAE,qCAAqC,CAAC;SAC7D;QACD,MAAM,EAAE;YACN,oFAAoF;YACpF,2FAA2F;YAC3F,oFAAoF;SACrF;QACD,QAAQ,EAAE,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,wBAAwB,CAAC;KACpF;IACD;QACE,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,0DAA0D;QACnE,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,oCAAoC;QAC3C,OAAO,EAAE;YACP,CAAC,mBAAmB,EAAE,kCAAkC,CAAC;YACzD,CAAC,aAAa,EAAE,qCAAqC,KAAK,GAAG,CAAC;YAC9D,CAAC,kBAAkB,EAAE,6CAA6C,UAAU,GAAG,CAAC;SACjF;QACD,MAAM,EAAE;YACN,wFAAwF;YACxF,8EAA8E;SAC/E;QACD,QAAQ,EAAE,CAAC,0CAA0C,CAAC;KACvD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,8CAA8C;QACvD,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,wCAAwC;QAC/C,OAAO,EAAE;YACP,CAAC,mBAAmB,EAAE,kCAAkC,CAAC;YACzD,CAAC,aAAa,EAAE,6DAA6D,KAAK,GAAG,CAAC;YACtF,CAAC,kBAAkB,EAAE,0CAA0C,UAAU,GAAG,CAAC;YAC7E,CAAC,oBAAoB,EAAE,oDAAoD,CAAC;SAC7E;QACD,MAAM,EAAE;YACN,2FAA2F;YAC3F,EAAE;YACF,sFAAsF;YACtF,qEAAqE;YACrE,EAAE;YACF,uFAAuF;YACvF,sFAAsF;YACtF,oEAAoE;SACrE;QACD,QAAQ,EAAE;YACR,mCAAmC;YACnC,qDAAqD;YACrD,oDAAoD;SACrD;KACF;CACF,CAAC;AAEF,MAAM,cAAc,GAA2C;IAC7D,CAAC,gBAAgB,EAAE,uBAAuB,CAAC;IAC3C,CAAC,aAAa,EAAE,8BAA8B,CAAC;IAC/C,CAAC,QAAQ,EAAE,yBAAyB,CAAC;IACrC,CAAC,aAAa,EAAE,mBAAmB,CAAC;IACpC,CAAC,YAAY,EAAE,qCAAqC,CAAC;IACrD,CAAC,eAAe,EAAE,kBAAkB,CAAC;CACtC,CAAC;AAEF,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED,MAAM,KAAK,GAAG,EAAE,CAAC;AAEjB,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,WAAW,CAA4B;IACzD,OAAO,KAAK,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC;AAClD,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,eAAe,CAAC,OAAoB;IAClD,MAAM,MAAM,GAAa;QACvB,YAAY,OAAO,CAAC,IAAI,MAAM,OAAO,CAAC,OAAO,EAAE;QAC/C,EAAE;QACF,OAAO;QACP,KAAK,OAAO,CAAC,KAAK,EAAE;KACrB,CAAC;IAEF,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,MAAM,CAAC,IAAI,CACT,EAAE,EACF,gBAAgB,EAChB,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAC1B,EAAE,EACF,UAAU,EACV,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,OAAO,EAAE,CAAC,EACpD,EAAE,CACH,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,SAAiB,EAAE,UAAkB,EAAE,OAAe;IACnF,MAAM,KAAK,GAAG,CAAC,KAA2B,EAAU,EAAE,CACpD,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC;SAClD,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;SACtD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,OAAO;;;;;;;EAOP,KAAK,CAAC,MAAM,CAAC;;;EAGb,KAAK,CAAC,WAAW,CAAC;;;;;;;;;;;;;EAalB,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;EAKtD,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;EAMxD,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;yBAEX,SAAS;;;;;;MAM5B,UAAU;;MAEV,OAAO;;;;;;;;;;;CAWZ,CAAC;AACF,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,7 +1,11 @@
1
+ export { type AgentFile, type AgentOptions, type AgentPlan, applyAgentSetup, planAgentSetup, type SurfaceKind, withBlock, } from "./agent.js";
2
+ export { type ArtifactPackage, readArtifact } from "./artifact.js";
1
3
  export { type BuildOptions, type BuildResult, buildPackage } from "./build.js";
4
+ export { type ChangedOptions, changedSurface, type SurfaceChange } from "./changed.js";
2
5
  export { type BuildConfig, CONFIG_KEY, type FeedbackChannel, parseBuildConfig, parseFeedbackChannel, readBuildConfig, } from "./config.js";
3
- export { defaultStorePath, type IndexedChunk, type IndexedPackage, type SearchHit, type SearchOptions, Store, silenceSqliteWarning, toFtsQuery, } from "./db.js";
4
- export { type DiscoveredPackage, type Discovery, discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
6
+ export { type CoverageOptions, type CoverageReport, identifiers, type LibraryCoverage, measureCoverage, } from "./coverage.js";
7
+ export { defaultStorePath, type IndexedChunk, type IndexedPackage, type PackageKind, type SearchHit, type SearchOptions, Store, type SymbolHit, silenceSqliteWarning, toFtsQuery, } from "./db.js";
8
+ export { type DiscoveredLibrary, type DiscoveredPackage, type Discovery, discoverLibraries, discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
5
9
  export { type DoctorOptions, type DoctorReport, type Finding, runDoctor, type Severity, } from "./doctor.js";
6
10
  export { DocspackError } from "./errors.js";
7
11
  export { type EvalCase, type EvalCaseResult, type EvalOptions, type EvalReport, evaluatePackage, parseEvalSet, readEvalSet, } from "./eval.js";
@@ -23,6 +27,7 @@ export { AGENTS_SNIPPET, FEEDBACK_SNIPPET } from "./snippet.js";
23
27
  export { CHUNKS_DIR, type ChunkSpec, chunkId, type DocumentedLibrary, estimateTokens, formatDocumentedLibrary, isCommunityPackage, isDocsPackage, isVendorPackage, LLMS_DIR, MANIFEST_FILE, type PackageManifest, packageId, parseDocumentedLibrary, parseManifest, resolveChunkFile, SCHEMA_URL, SPEC_URL, serializeManifest, } from "./spec.js";
24
28
  export { STOPWORDS } from "./stopwords.js";
25
29
  export { type BlockedFinding, type BlockedReason, issueUrl, prepareSubmission, type RoutedFinding, renderBody, type SubmitOptions, type SubmitReport, } from "./submit.js";
30
+ export { declarationOf, type ExportedSymbol, hasJsdoc, type PublicSurface, readPublicSurface, } from "./surface.js";
26
31
  export { type SyncedPackage, type SyncOptions, type SyncResult, type SyncStatus, syncProject, } from "./sync.js";
27
- export { type DriftFinding, type VerifiedPackage, type VerifyOptions, type VerifyReport, type VerifyStatus, verifyProject, } from "./verify.js";
32
+ export { type DriftFinding, documentedLibraries, type VerifiedPackage, type VerifyOptions, type VerifyReport, type VerifyStatus, verifyProject, } from "./verify.js";
28
33
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EACL,KAAK,WAAW,EAChB,UAAU,EACV,KAAK,eAAe,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,EACL,oBAAoB,EACpB,UAAU,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,SAAS,EACT,KAAK,QAAQ,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,eAAe,EACf,YAAY,EACZ,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EACL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,UAAU,EACV,YAAY,EACZ,aAAa,EACb,KAAK,eAAe,EACpB,YAAY,EACZ,aAAa,EACb,KAAK,aAAa,EAClB,YAAY,EACZ,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,QAAQ,EACR,KAAK,WAAW,EAChB,eAAe,EACf,eAAe,EACf,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,KAAK,QAAQ,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACrF,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,QAAQ,EACR,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,KAAK,YAAY,EACjB,SAAS,EACT,UAAU,EACV,KAAK,WAAW,EAChB,KAAK,WAAW,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EACL,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAE,KAAK,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,KAAK,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,SAAS,EACT,YAAY,EACZ,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,OAAO,EACP,KAAK,iBAAiB,EACtB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,QAAQ,EACR,aAAa,EACb,KAAK,eAAe,EACpB,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,iBAAiB,GAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,QAAQ,EACR,iBAAiB,EACjB,KAAK,aAAa,EAClB,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,aAAa,GACd,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,eAAe,EACf,cAAc,EACd,KAAK,WAAW,EAChB,SAAS,GACV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAE,KAAK,cAAc,EAAE,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EACL,KAAK,WAAW,EAChB,UAAU,EACV,KAAK,eAAe,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,WAAW,EACX,KAAK,eAAe,EACpB,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,gBAAgB,EAChB,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,EACL,KAAK,SAAS,EACd,oBAAoB,EACpB,UAAU,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,SAAS,EACT,KAAK,QAAQ,GACd,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,eAAe,EACf,YAAY,EACZ,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,aAAa,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EACL,KAAK,UAAU,EACf,KAAK,SAAS,EACd,UAAU,EACV,YAAY,EACZ,aAAa,EACb,KAAK,eAAe,EACpB,YAAY,EACZ,aAAa,EACb,KAAK,aAAa,EAClB,YAAY,EACZ,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,QAAQ,EACR,KAAK,WAAW,EAChB,eAAe,EACf,eAAe,EACf,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,KAAK,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,KAAK,QAAQ,EAAE,aAAa,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACrF,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,QAAQ,EACR,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,KAAK,YAAY,EACjB,SAAS,EACT,UAAU,EACV,KAAK,WAAW,EAChB,KAAK,WAAW,GACjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EACL,cAAc,EACd,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAE,KAAK,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAE,KAAK,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AACxF,OAAO,EACL,aAAa,EACb,kBAAkB,EAClB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,SAAS,EACT,YAAY,EACZ,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,UAAU,EACV,KAAK,SAAS,EACd,OAAO,EACP,KAAK,iBAAiB,EACtB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,QAAQ,EACR,aAAa,EACb,KAAK,eAAe,EACpB,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,iBAAiB,GAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,QAAQ,EACR,iBAAiB,EACjB,KAAK,aAAa,EAClB,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,YAAY,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EACb,KAAK,cAAc,EACnB,QAAQ,EACR,KAAK,aAAa,EAClB,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,KAAK,YAAY,EACjB,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,aAAa,GACd,MAAM,aAAa,CAAC"}
package/dist/index.js CHANGED
@@ -1,7 +1,11 @@
1
+ export { applyAgentSetup, planAgentSetup, withBlock, } from "./agent.js";
2
+ export { readArtifact } from "./artifact.js";
1
3
  export { buildPackage } from "./build.js";
4
+ export { changedSurface } from "./changed.js";
2
5
  export { CONFIG_KEY, parseBuildConfig, parseFeedbackChannel, readBuildConfig, } from "./config.js";
6
+ export { identifiers, measureCoverage, } from "./coverage.js";
3
7
  export { defaultStorePath, Store, silenceSqliteWarning, toFtsQuery, } from "./db.js";
4
- export { discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
8
+ export { discoverLibraries, discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
5
9
  export { runDoctor, } from "./doctor.js";
6
10
  export { DocspackError } from "./errors.js";
7
11
  export { evaluatePackage, parseEvalSet, readEvalSet, } from "./eval.js";
@@ -23,6 +27,7 @@ export { AGENTS_SNIPPET, FEEDBACK_SNIPPET } from "./snippet.js";
23
27
  export { CHUNKS_DIR, chunkId, estimateTokens, formatDocumentedLibrary, isCommunityPackage, isDocsPackage, isVendorPackage, LLMS_DIR, MANIFEST_FILE, packageId, parseDocumentedLibrary, parseManifest, resolveChunkFile, SCHEMA_URL, SPEC_URL, serializeManifest, } from "./spec.js";
24
28
  export { STOPWORDS } from "./stopwords.js";
25
29
  export { issueUrl, prepareSubmission, renderBody, } from "./submit.js";
30
+ export { declarationOf, hasJsdoc, readPublicSurface, } from "./surface.js";
26
31
  export { syncProject, } from "./sync.js";
27
- export { verifyProject, } from "./verify.js";
32
+ export { documentedLibraries, verifyProject, } from "./verify.js";
28
33
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuC,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EAEL,UAAU,EAEV,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,gBAAgB,EAKhB,KAAK,EACL,oBAAoB,EACpB,UAAU,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EAGL,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAIL,SAAS,GAEV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAKL,eAAe,EACf,YAAY,EACZ,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAsB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAGL,UAAU,EACV,YAAY,EACZ,aAAa,EAEb,YAAY,EACZ,aAAa,EAEb,YAAY,EACZ,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,QAAQ,EAER,eAAe,EACf,eAAe,EACf,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAkB,UAAU,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAiB,aAAa,EAAuB,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAOL,QAAQ,EACR,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAwC,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAEL,SAAS,EACT,UAAU,GAGX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAoB,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EACL,cAAc,EAId,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAmB,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAA2C,cAAc,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAe,cAAc,EAAE,QAAQ,EAAsB,MAAM,aAAa,CAAC;AACxF,OAAO,EACL,aAAa,EACb,kBAAkB,EAIlB,SAAS,EACT,YAAY,EACZ,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,UAAU,EAEV,OAAO,EAEP,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,QAAQ,EACR,aAAa,EAEb,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,iBAAiB,GAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAGL,QAAQ,EACR,iBAAiB,EAEjB,UAAU,GAGX,MAAM,aAAa,CAAC;AACrB,OAAO,EAKL,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAML,aAAa,GACd,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,eAAe,EACf,cAAc,EAEd,SAAS,GACV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAwB,YAAY,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAuC,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAuB,cAAc,EAAsB,MAAM,cAAc,CAAC;AACvF,OAAO,EAEL,UAAU,EAEV,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,aAAa,CAAC;AACrB,OAAO,EAGL,WAAW,EAEX,eAAe,GAChB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,gBAAgB,EAMhB,KAAK,EAEL,oBAAoB,EACpB,UAAU,GACX,MAAM,SAAS,CAAC;AACjB,OAAO,EAIL,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAIL,SAAS,GAEV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAKL,eAAe,EACf,YAAY,EACZ,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAsB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACrE,OAAO,EAGL,UAAU,EACV,YAAY,EACZ,aAAa,EAEb,YAAY,EACZ,aAAa,EAEb,YAAY,EACZ,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,QAAQ,EAER,eAAe,EACf,eAAe,EACf,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,OAAO,EAAkB,UAAU,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAiB,aAAa,EAAuB,MAAM,kBAAkB,CAAC;AACrF,OAAO,EAOL,QAAQ,EACR,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAwC,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAEL,SAAS,EACT,UAAU,GAGX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAoB,aAAa,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EACL,cAAc,EAId,YAAY,GACb,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAmB,cAAc,EAAE,MAAM,UAAU,CAAC;AAC5E,OAAO,EAA2C,cAAc,EAAE,MAAM,cAAc,CAAC;AACvF,OAAO,EAAe,cAAc,EAAE,QAAQ,EAAsB,MAAM,aAAa,CAAC;AACxF,OAAO,EACL,aAAa,EACb,kBAAkB,EAIlB,SAAS,EACT,YAAY,EACZ,cAAc,GACf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EACL,UAAU,EAEV,OAAO,EAEP,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,eAAe,EACf,QAAQ,EACR,aAAa,EAEb,SAAS,EACT,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,UAAU,EACV,QAAQ,EACR,iBAAiB,GAClB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAGL,QAAQ,EACR,iBAAiB,EAEjB,UAAU,GAGX,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EAEb,QAAQ,EAER,iBAAiB,GAClB,MAAM,cAAc,CAAC;AACtB,OAAO,EAKL,WAAW,GACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAEL,mBAAmB,EAKnB,aAAa,GACd,MAAM,aAAa,CAAC"}
package/dist/mcp.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGpE,OAAO,EAAoB,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAMvD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AA4BD,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CA6I9D;AAED,qGAAqG;AACrG,wBAAsB,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAMvE"}
1
+ {"version":3,"file":"mcp.d.ts","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGpE,OAAO,EAAoB,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAMvD,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AA+BD,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CA6I9D;AAED,qGAAqG;AACrG,wBAAsB,cAAc,CAAC,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAMvE"}
package/dist/mcp.js CHANGED
@@ -11,6 +11,9 @@ const DESCRIPTION = [
11
11
  "Returns Markdown excerpts from local, version-matched documentation packages.",
12
12
  "Prefer this over recalling API details from memory: the local copy matches the",
13
13
  "exact dependency versions in this project.",
14
+ "When the question names something an installed library exports that no",
15
+ "documentation mentions, the answer leads with that name's declaration from the",
16
+ "installed build and says the documentation does not cover it.",
14
17
  ].join(" ");
15
18
  /**
16
19
  * A tool description is the only thing shaping how a model uses it, so this one carries the
package/dist/mcp.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"mcp.js","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAc,MAAM,SAAS,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAYzF,MAAM,WAAW,GAAG;IAClB,oEAAoE;IACpE,+EAA+E;IAC/E,gFAAgF;IAChF,4CAA4C;CAC7C,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG;IACzB,gFAAgF;IAChF,kFAAkF;IAClF,2EAA2E;IAC3E,4EAA4E;IAC5E,+EAA+E;IAC/E,2EAA2E;IAC3E,4EAA4E;IAC5E,4EAA4E;IAC5E,2EAA2E;IAC3E,oDAAoD;CACrD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEZ,MAAM,UAAU,eAAe,CAAC,OAAmB;IACjD,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAC9C;QACE,YAAY,EACV,gFAAgF;YAChF,iFAAiF;YACjF,yEAAyE;YACzE,gFAAgF;YAChF,6BAA6B;KAChC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,kBAAkB,EAClB;QACE,KAAK,EAAE,2BAA2B;QAClC,WAAW,EAAE,WAAW;QACxB,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,+CAA+C,CAAC;YAClF,aAAa,EAAE,CAAC;iBACb,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,mEAAmE,CAAC;SACjF;QACD,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE;KAC1D,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE;QACjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC;gBAC7B,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK;gBACL,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC;gBACzD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;gBACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;aACnD,CAAC,CAAC;YACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QACrF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,sCAAsC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;qBACrG;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,qBAAqB,EACrB;QACE,KAAK,EAAE,gCAAgC;QACvC,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE;YACX,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,4HAA4H,CAC7H;YACH,IAAI,EAAE,CAAC;iBACJ,IAAI,CAAC,KAAK,CAAC;iBACX,QAAQ,CACP,yKAAyK,CAC1K;YACH,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,iGAAiG,CAClG;YACH,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,0EAA0E,CAAC;YACvF,MAAM,EAAE,CAAC;iBACN,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,uDAAuD,CAAC;YACpE,KAAK,EAAE,CAAC;iBACL,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,sHAAsH,CACvH;SACJ;QACD,sFAAsF;QACtF,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,KAAK;YACrB,aAAa,EAAE,KAAK;SACrB;KACF,EACD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7D,IAAI,CAAC;YACH,uFAAuF;YACvF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC;gBAC3C,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ;gBACR,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;gBAC/C,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;gBAC3C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;aAC1C,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE;4BACJ,MAAM;gCACJ,CAAC,CAAC,2DAA2D,OAAO,CAAC,IAAI,SAAS;gCAClF,CAAC,CAAC,YAAY,OAAO,CAAC,WAAW,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;4BACtE,8EAA8E;yBAC/E,CAAC,IAAI,CAAC,GAAG,CAAC;qBACZ;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,sFAAsF;YACtF,sFAAsF;YACtF,+CAA+C;YAC/C,MAAM,IAAI,GAAG,KAAK,YAAY,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACrE,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,IAAI,GACR,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC,CAAC,iBAAiB,OAAO,KAAK,IAAI,EAAE,CAAC;YACxF,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC5E,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAmB;IACtD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IACxC,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,yBAAyB,OAAO,CAAC,SAAS,IAAI,gBAAgB,EAAE,QAAQ,OAAO,CAAC,GAAG,IAAI,CACxF,CAAC;IACF,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACnD,CAAC"}
1
+ {"version":3,"file":"mcp.js","sourceRoot":"","sources":["../src/mcp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAc,MAAM,SAAS,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAYzF,MAAM,WAAW,GAAG;IAClB,oEAAoE;IACpE,+EAA+E;IAC/E,gFAAgF;IAChF,4CAA4C;IAC5C,wEAAwE;IACxE,gFAAgF;IAChF,+DAA+D;CAChE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEZ;;;;;GAKG;AACH,MAAM,kBAAkB,GAAG;IACzB,gFAAgF;IAChF,kFAAkF;IAClF,2EAA2E;IAC3E,4EAA4E;IAC5E,+EAA+E;IAC/E,2EAA2E;IAC3E,4EAA4E;IAC5E,4EAA4E;IAC5E,2EAA2E;IAC3E,oDAAoD;CACrD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEZ,MAAM,UAAU,eAAe,CAAC,OAAmB;IACjD,MAAM,MAAM,GAAG,IAAI,SAAS,CAC1B,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAC9C;QACE,YAAY,EACV,gFAAgF;YAChF,iFAAiF;YACjF,yEAAyE;YACzE,gFAAgF;YAChF,6BAA6B;KAChC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,kBAAkB,EAClB;QACE,KAAK,EAAE,2BAA2B;QAClC,WAAW,EAAE,WAAW;QACxB,WAAW,EAAE;YACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,+CAA+C,CAAC;YAClF,aAAa,EAAE,CAAC;iBACb,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,mEAAmE,CAAC;SACjF;QACD,WAAW,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE;KAC1D,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE;QACjC,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC;gBAC7B,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,KAAK;gBACL,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC;gBACzD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;gBACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;aACnD,CAAC,CAAC;YACH,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;QACrF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,sCAAsC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;qBACrG;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,qBAAqB,EACrB;QACE,KAAK,EAAE,gCAAgC;QACvC,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EAAE;YACX,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,4HAA4H,CAC7H;YACH,IAAI,EAAE,CAAC;iBACJ,IAAI,CAAC,KAAK,CAAC;iBACX,QAAQ,CACP,yKAAyK,CAC1K;YACH,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,iGAAiG,CAClG;YACH,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,0EAA0E,CAAC;YACvF,MAAM,EAAE,CAAC;iBACN,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,uDAAuD,CAAC;YACpE,KAAK,EAAE,CAAC;iBACL,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,sHAAsH,CACvH;SACJ;QACD,sFAAsF;QACtF,WAAW,EAAE;YACX,YAAY,EAAE,KAAK;YACnB,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,KAAK;YACrB,aAAa,EAAE,KAAK;SACrB;KACF,EACD,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7D,IAAI,CAAC;YACH,uFAAuF;YACvF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC;gBAC3C,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ;gBACR,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC;gBAC/C,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;gBAC3C,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;aAC1C,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE;4BACJ,MAAM;gCACJ,CAAC,CAAC,2DAA2D,OAAO,CAAC,IAAI,SAAS;gCAClF,CAAC,CAAC,YAAY,OAAO,CAAC,WAAW,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG;4BACtE,8EAA8E;yBAC/E,CAAC,IAAI,CAAC,GAAG,CAAC;qBACZ;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,sFAAsF;YACtF,sFAAsF;YACtF,+CAA+C;YAC/C,MAAM,IAAI,GAAG,KAAK,YAAY,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACrE,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,MAAM,IAAI,GACR,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC,CAAC,iBAAiB,OAAO,KAAK,IAAI,EAAE,CAAC;YACxF,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC5E,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAmB;IACtD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IACxC,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,yBAAyB,OAAO,CAAC,SAAS,IAAI,gBAAgB,EAAE,QAAQ,OAAO,CAAC,GAAG,IAAI,CACxF,CAAC;IACF,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;AACnD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAIA,OAAO,EAAqC,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAa/E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAkEpF"}
1
+ {"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAIA,OAAO,EAAqC,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAa/E,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC,CAmEpF"}
package/dist/preview.js CHANGED
@@ -58,6 +58,7 @@ export async function previewPackage(options) {
58
58
  ...hit,
59
59
  name: manifest.name,
60
60
  version: manifest.version,
61
+ kind: "docs",
61
62
  trusted: !isCommunityPackage(manifest.name),
62
63
  ...(documents.length === 0 ? {} : { documents }),
63
64
  }));
@@ -1 +1 @@
1
- {"version":3,"file":"preview.js","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAqB,KAAK,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAiB,MAAM,aAAa,CAAC;AAC/E,OAAO,EACL,OAAO,EACP,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,SAAS,EACT,aAAa,EACb,gBAAgB,GACjB,MAAM,WAAW,CAAC;AAenB;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB;IAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAE5C,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,aAAa,CAAC,MAAM,QAAQ,IAAI,aAAa,OAAO,OAAO,CAAC,GAAG,EAAE,EAAE;YAC3E,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC,CAAC;IAChF,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAE1E,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,CAAC,MAAM,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACpF,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACpC,MAAM,CAAC,IAAI,CAAC;YACV,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9B,QAAQ,EAAE,KAAK,CAAC,IAAI;YACpB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC;YAChD,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,aAAa,CAAC,oCAAoC,EAAE;YAC5D,IAAI,EAAE,6CAA6C;SACpD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC;QACH,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,KAAK;aACf,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;YACrB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;YACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;SACnD,CAAC;aACD,GAAG,CACF,CAAC,GAAG,EAAY,EAAE,CAAC,CAAC;YAClB,GAAG,GAAG;YACN,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,OAAO,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3C,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;SACjD,CAAC,CACH,CAAC;QAEJ,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"preview.js","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAqB,KAAK,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAiB,MAAM,aAAa,CAAC;AAC/E,OAAO,EACL,OAAO,EACP,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,SAAS,EACT,aAAa,EACb,gBAAgB,GACjB,MAAM,WAAW,CAAC;AAenB;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,OAAuB;IAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAE5C,IAAI,GAAW,CAAC;IAChB,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,aAAa,CAAC,MAAM,QAAQ,IAAI,aAAa,OAAO,OAAO,CAAC,GAAG,EAAE,EAAE;YAC3E,IAAI,EAAE,6BAA6B;SACpC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC,CAAC;IAChF,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtD,MAAM,SAAS,GAAG,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IAE1E,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,IAAI,QAAgB,CAAC;QACrB,IAAI,CAAC;YACH,QAAQ,GAAG,CAAC,MAAM,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACpF,CAAC;QAAC,MAAM,CAAC;YACP,SAAS;QACX,CAAC;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACpC,MAAM,CAAC,IAAI,CAAC;YACV,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9B,QAAQ,EAAE,KAAK,CAAC,IAAI;YACpB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC;YAChD,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC;SACzC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,aAAa,CAAC,oCAAoC,EAAE;YAC5D,IAAI,EAAE,6CAA6C;SACpD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACrC,IAAI,CAAC;QACH,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;QACnF,MAAM,IAAI,GAAG,KAAK;aACf,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;YACrB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;YACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;SACnD,CAAC;aACD,GAAG,CACF,CAAC,GAAG,EAAY,EAAE,CAAC,CAAC;YAClB,GAAG,GAAG;YACN,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,CAAC,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC;YAC3C,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;SACjD,CAAC,CACH,CAAC;QAEJ,OAAO;YACL,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,KAAK,CAAC,KAAK,EAAE,CAAC;IAChB,CAAC;AACH,CAAC"}
package/dist/search.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import type { SearchHit, Store } from "./db.js";
1
+ import type { PackageKind, SearchHit, Store } from "./db.js";
2
2
  /** Ceiling on how much context one query may return, per the blueprint's context-exhaustion rule. */
3
3
  export declare const DEFAULT_MAX_TOKENS = 3000;
4
4
  export declare const DEFAULT_LIMIT = 3;
@@ -15,11 +15,18 @@ export interface QueryOptions {
15
15
  * sees documentation for a version this project does not use.
16
16
  */
17
17
  readonly scoped?: boolean;
18
+ /**
19
+ * Answer a question that names an exported symbol from the installed library's own
20
+ * declarations when the documentation does not mention it. On by default.
21
+ */
22
+ readonly artifacts?: boolean;
18
23
  }
19
24
  export interface QueryHit extends SearchHit {
20
25
  readonly name: string;
21
26
  readonly version: string;
22
27
  readonly trusted: boolean;
28
+ /** Whether this text was published as documentation or derived from the installed build. */
29
+ readonly kind: PackageKind;
23
30
  /**
24
31
  * Libraries this chunk documents, from its manifest. A docs package version cannot always
25
32
  * imply this — a monorepo documents many libraries at many versions from one surface — so the
@@ -39,6 +46,12 @@ export interface QueryResult {
39
46
  * covers this question".
40
47
  */
41
48
  readonly unindexed: readonly string[];
49
+ /**
50
+ * Names the question used that an installed library exports and no documentation mentions.
51
+ * This is the difference between "the documentation does not cover this" and "nothing
52
+ * matched", which a ranker alone cannot tell apart — it always returns its best three.
53
+ */
54
+ readonly undocumented: readonly string[];
42
55
  }
43
56
  export declare function queryDocs(options: QueryOptions): Promise<QueryResult>;
44
57
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAIhD,qGAAqG;AACrG,eAAO,MAAM,kBAAkB,OAAO,CAAC;AACvC,eAAO,MAAM,aAAa,IAAI,CAAC;AAE/B,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yFAAyF;IACzF,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iEAAiE;IACjE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAoD3E;AAMD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CA6BvE;AAED,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAI5E"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAI7D,qGAAqG;AACrG,eAAO,MAAM,kBAAkB,OAAO,CAAC;AACvC,eAAO,MAAM,aAAa,IAAI,CAAC;AAW/B,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,yFAAyF;IACzF,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,QAAS,SAAQ,SAAS;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,4FAA4F;IAC5F,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAC;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,iEAAiE;IACjE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAwD3E;AA4FD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CA6BvE;AAgBD,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAI5E"}
package/dist/search.js CHANGED
@@ -1,8 +1,15 @@
1
- import { discoverPackages } from "./discovery.js";
1
+ import { discoverLibraries, discoverPackages } from "./discovery.js";
2
2
  import { chunkId, formatDocumentedLibrary, isCommunityPackage } from "./spec.js";
3
3
  /** Ceiling on how much context one query may return, per the blueprint's context-exhaustion rule. */
4
4
  export const DEFAULT_MAX_TOKENS = 3000;
5
5
  export const DEFAULT_LIMIT = 3;
6
+ /**
7
+ * How many declarations one answer may carry. A question names one or two things; more than
8
+ * that and the names are incidental, and pinning them would spend the budget on noise.
9
+ */
10
+ const MAX_DECLARATIONS = 2;
11
+ /** Below this a token is too short to be a name worth looking up: `c`, `id`. */
12
+ const MIN_SYMBOL = 3;
6
13
  export async function queryDocs(options) {
7
14
  const scoped = options.scoped !== false;
8
15
  const installed = scoped ? (await discoverPackages(options.cwd)).packages : undefined;
@@ -26,32 +33,99 @@ export async function queryDocs(options) {
26
33
  documented.set(chunkId(pkg.id, chunk.id), chunk.documents.map(formatDocumentedLibrary));
27
34
  }
28
35
  }
29
- const hits = options.store
36
+ const maxTokens = options.maxTokens ?? DEFAULT_MAX_TOKENS;
37
+ const prose = options.store
30
38
  .search(options.query, {
31
39
  ...(packageIds === undefined ? {} : { packageIds }),
32
40
  ...(options.packageFilter === undefined
33
41
  ? {}
34
42
  : { packageFilter: `%${options.packageFilter}%` }),
35
43
  limit: options.limit ?? DEFAULT_LIMIT,
36
- maxTokens: options.maxTokens ?? DEFAULT_MAX_TOKENS,
44
+ maxTokens,
45
+ // Declarations are addressed by name, never ranked against prose: a library exports far
46
+ // more names than its documentation has pages, and ranking them together would answer
47
+ // every question with type machinery.
48
+ kinds: ["docs"],
37
49
  })
38
- .map((hit) => {
39
- const { name, version } = splitPackageId(hit.packageId);
40
- // The chunk's own libraries win: they are the narrower, and therefore the truer, claim.
41
- const documents = documented.get(hit.chunkId) ?? documented.get(hit.packageId);
42
- return {
43
- ...hit,
44
- name,
45
- version,
46
- trusted: !isCommunityPackage(name),
47
- ...(documents === undefined ? {} : { documents }),
48
- };
49
- });
50
+ .map((hit) => toQueryHit(hit, "docs", documented));
51
+ const { declarations, undocumented } = options.artifacts === false
52
+ ? { declarations: [], undocumented: [] }
53
+ : await findDeclarations(options, prose, maxTokens);
54
+ // Declarations first: for an agent about to write a call, the signature at the installed
55
+ // version is the load-bearing line, and the prose explains it afterwards.
56
+ const hits = [...declarations, ...prose];
50
57
  return {
51
58
  hits,
52
59
  tokens: hits.reduce((total, hit) => total + hit.tokens, 0),
53
60
  untrusted: hits.some((hit) => !hit.trusted),
54
61
  unindexed,
62
+ undocumented,
63
+ };
64
+ }
65
+ /**
66
+ * Looks up the names a question used against the symbols the installed libraries export.
67
+ *
68
+ * Matching is case-sensitive on purpose. Someone asking about an API writes it as it is spelled,
69
+ * because they read it in a stack trace or an editor; matching loosely would let "how do I use
70
+ * data" pin hono's `Data` type ahead of the page that answers the question.
71
+ */
72
+ async function findDeclarations(options, prose, maxTokens) {
73
+ const scope = options.scoped === false
74
+ ? undefined
75
+ : (await discoverLibraries(options.cwd)).map((library) => `${library.name}@${library.version}`);
76
+ const declarations = [];
77
+ const undocumented = [];
78
+ let spent = prose.reduce((total, hit) => total + hit.tokens, 0);
79
+ for (const term of symbolTerms(options.query)) {
80
+ if (declarations.length >= MAX_DECLARATIONS)
81
+ break;
82
+ const found = options.store
83
+ .lookupSymbol(term, scope)
84
+ .filter((hit) => options.packageFilter === undefined || hit.packageId.includes(options.packageFilter));
85
+ if (found.length === 0)
86
+ continue;
87
+ // The documentation covers it, so the prose that just came back is the better answer.
88
+ if (prose.some((hit) => mentions(hit.content, term)))
89
+ continue;
90
+ undocumented.push(term);
91
+ // The name is exported and undocumented either way; whether a declaration can be shown for
92
+ // it is a separate question, and a package can export a name it declares nowhere readable.
93
+ const first = found[0];
94
+ if (first === undefined || first.chunkId.length === 0)
95
+ continue;
96
+ const chunk = options.store.chunk(first.chunkId);
97
+ if (chunk === undefined)
98
+ continue;
99
+ if (declarations.length > 0 && spent + chunk.tokens > maxTokens)
100
+ break;
101
+ declarations.push(toQueryHit(chunk, "artifact", new Map()));
102
+ spent += chunk.tokens;
103
+ }
104
+ return { declarations, undocumented };
105
+ }
106
+ /** Identifier-shaped words in a question, longest first so the specific name is tried first. */
107
+ function symbolTerms(query) {
108
+ const terms = query.match(/[A-Za-z_$][\w$]*/g) ?? [];
109
+ const unique = [...new Set(terms.filter((term) => term.length >= MIN_SYMBOL))];
110
+ return unique.sort((a, b) => b.length - a.length);
111
+ }
112
+ function mentions(content, name) {
113
+ return new RegExp(`(^|[^A-Za-z0-9_$])${escapeRegex(name)}([^A-Za-z0-9_$]|$)`).test(content);
114
+ }
115
+ function escapeRegex(value) {
116
+ return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
117
+ }
118
+ function toQueryHit(hit, kind, documented) {
119
+ const { name, version } = splitPackageId(hit.packageId);
120
+ // The chunk's own libraries win: they are the narrower, and therefore the truer, claim.
121
+ const documents = documented.get(hit.chunkId) ?? documented.get(hit.packageId);
122
+ return {
123
+ ...hit,
124
+ name,
125
+ version,
126
+ kind,
127
+ trusted: !isCommunityPackage(name),
128
+ ...(documents === undefined ? {} : { documents }),
55
129
  };
56
130
  }
57
131
  const UNTRUSTED_NOTICE = "NOTE: results marked (community) come from an unverified @docspack-community package. " +
@@ -77,17 +151,30 @@ export function renderAnswer(result, query) {
77
151
  const describes = hit.documents === undefined || hit.documents.length === 0
78
152
  ? ""
79
153
  : ` · documents ${hit.documents.join(", ")}`;
80
- return [
81
- `## ${hit.chunkId}${trust}`,
82
- `Source: ${hit.name}@${hit.version} — ${hit.filePath}${describes}`,
83
- "",
84
- hit.content,
85
- ].join("\n");
154
+ const source = hit.kind === "artifact"
155
+ ? `Source: ${hit.name}@${hit.version} — declared in ${hit.filePath}, read from the installed package`
156
+ : `Source: ${hit.name}@${hit.version} — ${hit.filePath}${describes}`;
157
+ return [`## ${hit.chunkId}${trust}`, source, "", hit.content].join("\n");
86
158
  });
159
+ if (result.undocumented.length > 0)
160
+ sections.push(undocumentedNotice(result));
87
161
  if (result.untrusted)
88
162
  sections.push(UNTRUSTED_NOTICE);
89
163
  return sections.join("\n\n---\n\n");
90
164
  }
165
+ /**
166
+ * Saying what the documentation does *not* cover. A ranker always returns its best three matches
167
+ * and "best" is not "relevant", so without this an answer about a name nobody documented looks
168
+ * exactly like an answer about one they did.
169
+ */
170
+ function undocumentedNotice(result) {
171
+ const names = result.undocumented.map((name) => `\`${name}\``).join(", ");
172
+ const plural = result.undocumented.length === 1 ? "is" : "are";
173
+ const declared = result.hits.some((hit) => hit.kind === "artifact");
174
+ return declared
175
+ ? `NOTE: ${names} ${plural} exported by the installed library but mentioned in no documentation package here. The declaration above is the installed build's own, not prose anyone wrote.`
176
+ : `NOTE: ${names} ${plural} exported by the installed library but mentioned in no documentation package here.`;
177
+ }
91
178
  /** Splits `@stripe/docspack@2025.4.1` into its name and version. */
92
179
  export function splitPackageId(id) {
93
180
  const at = id.lastIndexOf("@");
@@ -1 +1 @@
1
- {"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEjF,qGAAqG;AACrG,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AA2C/B,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAqB;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IACtF,MAAM,UAAU,GAAG,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;SAChC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAExB,+FAA+F;IAC/F,2FAA2F;IAC3F,8FAA8F;IAC9F,uFAAuF;IACvF,MAAM,UAAU,GAAG,IAAI,GAAG,EAA6B,CAAC;IACxD,KAAK,MAAM,GAAG,IAAI,SAAS,IAAI,EAAE,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAC5E,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK;SACvB,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;QACrB,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;QACnD,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC;QACpD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;QACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;KACnD,CAAC;SACD,GAAG,CAAC,CAAC,GAAG,EAAY,EAAE;QACrB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxD,wFAAwF;QACxF,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/E,OAAO;YACL,GAAG,GAAG;YACN,IAAI;YACJ,OAAO;YACP,OAAO,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC;YAClC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;SAClD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QAC3C,SAAS;KACV,CAAC;AACJ,CAAC;AAED,MAAM,gBAAgB,GACpB,wFAAwF;IACxF,6DAA6D,CAAC;AAEhE;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAmB,EAAE,KAAa;IAC7D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,0FAA0F;QAC1F,kFAAkF;QAClF,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,mCAAmC,KAAK,UAAU,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,oEAAoE,CAAC;QAC3M,CAAC;QACD,OAAO,mCAAmC,KAAK,kEAAkE,CAAC;IACpH,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;QAChD,2FAA2F;QAC3F,mFAAmF;QACnF,kFAAkF;QAClF,MAAM,SAAS,GACb,GAAG,CAAC,SAAS,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YACvD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,gBAAgB,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,OAAO;YACL,MAAM,GAAG,CAAC,OAAO,GAAG,KAAK,EAAE;YAC3B,WAAW,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,MAAM,GAAG,CAAC,QAAQ,GAAG,SAAS,EAAE;YAClE,EAAE;YACF,GAAG,CAAC,OAAO;SACZ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtD,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACtC,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,cAAc,CAAC,EAAU;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9C,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC9D,CAAC"}
1
+ {"version":3,"file":"search.js","sourceRoot":"","sources":["../src/search.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAEjF,qGAAqG;AACrG,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC;AAE/B;;;GAGG;AACH,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B,gFAAgF;AAChF,MAAM,UAAU,GAAG,CAAC,CAAC;AAwDrB,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,OAAqB;IACnD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,KAAK,KAAK,CAAC;IACxC,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IACtF,MAAM,UAAU,GAAG,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC;SAChC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SAClD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAExB,+FAA+F;IAC/F,2FAA2F;IAC3F,8FAA8F;IAC9F,uFAAuF;IACvF,MAAM,UAAU,GAAG,IAAI,GAAG,EAA6B,CAAC;IACxD,KAAK,MAAM,GAAG,IAAI,SAAS,IAAI,EAAE,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpD,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;QACjE,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAC5E,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC1F,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;IAC1D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK;SACxB,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;QACrB,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;QACnD,GAAG,CAAC,OAAO,CAAC,aAAa,KAAK,SAAS;YACrC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,EAAE,aAAa,EAAE,IAAI,OAAO,CAAC,aAAa,GAAG,EAAE,CAAC;QACpD,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;QACrC,SAAS;QACT,wFAAwF;QACxF,sFAAsF;QACtF,sCAAsC;QACtC,KAAK,EAAE,CAAC,MAAM,CAAC;KAChB,CAAC;SACD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC;IAErD,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAClC,OAAO,CAAC,SAAS,KAAK,KAAK;QACzB,CAAC,CAAC,EAAE,YAAY,EAAE,EAAgB,EAAE,YAAY,EAAE,EAAc,EAAE;QAClE,CAAC,CAAC,MAAM,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;IAExD,yFAAyF;IACzF,0EAA0E;IAC1E,MAAM,IAAI,GAAG,CAAC,GAAG,YAAY,EAAE,GAAG,KAAK,CAAC,CAAC;IAEzC,OAAO;QACL,IAAI;QACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1D,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QAC3C,SAAS;QACT,YAAY;KACb,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,gBAAgB,CAC7B,OAAqB,EACrB,KAA0B,EAC1B,SAAiB;IAEjB,MAAM,KAAK,GACT,OAAO,CAAC,MAAM,KAAK,KAAK;QACtB,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,CAAC,MAAM,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CACxC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE,CAClD,CAAC;IAER,MAAM,YAAY,GAAe,EAAE,CAAC;IACpC,MAAM,YAAY,GAAa,EAAE,CAAC;IAClC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEhE,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9C,IAAI,YAAY,CAAC,MAAM,IAAI,gBAAgB;YAAE,MAAM;QAEnD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK;aACxB,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC;aACzB,MAAM,CACL,CAAC,GAAG,EAAE,EAAE,CACN,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CACvF,CAAC;QACJ,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAEjC,sFAAsF;QACtF,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAAE,SAAS;QAC/D,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExB,2FAA2F;QAC3F,2FAA2F;QAC3F,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAChE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACjD,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,SAAS;YAAE,MAAM;QAEvE,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5D,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC;IACxB,CAAC;IAED,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;AACxC,CAAC;AAED,gGAAgG;AAChG,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAC;IACrD,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,QAAQ,CAAC,OAAe,EAAE,IAAY;IAC7C,OAAO,IAAI,MAAM,CAAC,qBAAqB,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC9F,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,KAAK,CAAC,OAAO,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,UAAU,CACjB,GAAc,EACd,IAAiB,EACjB,UAAkD;IAElD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACxD,wFAAwF;IACxF,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/E,OAAO;QACL,GAAG,GAAG;QACN,IAAI;QACJ,OAAO;QACP,IAAI;QACJ,OAAO,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC;QAClC,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC;KAClD,CAAC;AACJ,CAAC;AAED,MAAM,gBAAgB,GACpB,wFAAwF;IACxF,6DAA6D,CAAC;AAEhE;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAmB,EAAE,KAAa;IAC7D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,0FAA0F;QAC1F,kFAAkF;QAClF,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,mCAAmC,KAAK,UAAU,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,oEAAoE,CAAC;QAC3M,CAAC;QACD,OAAO,mCAAmC,KAAK,kEAAkE,CAAC;IACpH,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACvC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;QAChD,2FAA2F;QAC3F,mFAAmF;QACnF,kFAAkF;QAClF,MAAM,SAAS,GACb,GAAG,CAAC,SAAS,KAAK,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC;YACvD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,gBAAgB,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,MAAM,MAAM,GACV,GAAG,CAAC,IAAI,KAAK,UAAU;YACrB,CAAC,CAAC,WAAW,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,kBAAkB,GAAG,CAAC,QAAQ,mCAAmC;YACrG,CAAC,CAAC,WAAW,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,MAAM,GAAG,CAAC,QAAQ,GAAG,SAAS,EAAE,CAAC;QACzE,OAAO,CAAC,MAAM,GAAG,CAAC,OAAO,GAAG,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9E,IAAI,MAAM,CAAC,SAAS;QAAE,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACtD,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACtC,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,MAAmB;IAC7C,MAAM,KAAK,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC/D,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACpE,OAAO,QAAQ;QACb,CAAC,CAAC,SAAS,KAAK,IAAI,MAAM,gKAAgK;QAC1L,CAAC,CAAC,SAAS,KAAK,IAAI,MAAM,oFAAoF,CAAC;AACnH,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,cAAc,CAAC,EAAU;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,EAAE,IAAI,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9C,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;AAC9D,CAAC"}
@@ -0,0 +1,45 @@
1
+ /**
2
+ * One name a library publishes, and how a caller reaches it.
3
+ *
4
+ * This is a narrower reading of a package than [`readExportSurface`](./exports.ts), which
5
+ * collects every identifier in every `.d.ts` so that `verify` accuses as little as possible.
6
+ * Here the opposite is wanted: only what an entry point actually exports, because these names
7
+ * become answers, and an answer about a library's private type helps nobody.
8
+ */
9
+ export interface ExportedSymbol {
10
+ readonly name: string;
11
+ /** What a caller writes to import it, e.g. `hono/jwt`. */
12
+ readonly from: string;
13
+ /** Declaration file the name was read from, relative to the package root. */
14
+ readonly file: string;
15
+ }
16
+ export interface PublicSurface {
17
+ readonly name: string;
18
+ readonly version: string;
19
+ /** Subpaths of the `exports` map that resolve to a declaration file. */
20
+ readonly entryPoints: number;
21
+ readonly symbols: ReadonlyMap<string, ExportedSymbol>;
22
+ }
23
+ /**
24
+ * Reads what a library exports, starting from its `exports` map. Returns nothing when the
25
+ * package ships no type declarations, which is not an error: most of a project's dependencies
26
+ * are not the ones anybody asks questions about.
27
+ */
28
+ export declare function readPublicSurface(dir: string): Promise<PublicSurface | undefined>;
29
+ /**
30
+ * Every declaration in one file, with the JSDoc comment above it when there is one, keyed by the
31
+ * name it declares.
32
+ *
33
+ * One pass over the file rather than one per name. A generated declaration file can be megabytes
34
+ * and export hundreds of names, and scanning it once per name made indexing TypeScript itself
35
+ * take longer than everything else in a sync put together.
36
+ */
37
+ export declare function declarationsIn(source: string, limit?: number): Map<string, string>;
38
+ /**
39
+ * The declaration of one name, with the JSDoc comment above it when there is one. This is the
40
+ * text that answers a question the prose never covered.
41
+ */
42
+ export declare function declarationOf(source: string, name: string, limit?: number): string | undefined;
43
+ /** True when the declaration `declarationOf` returned carries a JSDoc comment. */
44
+ export declare function hasJsdoc(declaration: string): boolean;
45
+ //# sourceMappingURL=surface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"surface.d.ts","sourceRoot":"","sources":["../src/surface.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACvD;AA6BD;;;;GAIG;AACH,wBAAsB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAsBvF;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,SAAoB,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAY7F;AAqBD;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,KAAK,SAAoB,GACxB,MAAM,GAAG,SAAS,CAEpB;AAED,kFAAkF;AAClF,wBAAgB,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAErD"}