docspack 1.0.0 → 1.2.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.
- package/README.md +31 -0
- package/dist/build.d.ts +23 -0
- package/dist/build.d.ts.map +1 -1
- package/dist/build.js +184 -96
- package/dist/build.js.map +1 -1
- package/dist/cli.js +91 -2
- package/dist/cli.js.map +1 -1
- package/dist/db.d.ts +40 -3
- package/dist/db.d.ts.map +1 -1
- package/dist/db.js +61 -2
- package/dist/db.js.map +1 -1
- package/dist/discovery.d.ts +6 -3
- package/dist/discovery.d.ts.map +1 -1
- package/dist/discovery.js +57 -11
- package/dist/discovery.js.map +1 -1
- package/dist/doctor.d.ts.map +1 -1
- package/dist/doctor.js +31 -10
- package/dist/doctor.js.map +1 -1
- package/dist/endpoints.d.ts +45 -0
- package/dist/endpoints.d.ts.map +1 -0
- package/dist/endpoints.js +155 -0
- package/dist/endpoints.js.map +1 -0
- package/dist/help.d.ts.map +1 -1
- package/dist/help.js +60 -5
- package/dist/help.js.map +1 -1
- package/dist/index.d.ts +4 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -3
- package/dist/index.js.map +1 -1
- package/dist/init/plan.js +4 -3
- package/dist/init/plan.js.map +1 -1
- package/dist/local.d.ts +67 -0
- package/dist/local.d.ts.map +1 -0
- package/dist/local.js +242 -0
- package/dist/local.js.map +1 -0
- package/dist/preview.d.ts.map +1 -1
- package/dist/preview.js +25 -7
- package/dist/preview.js.map +1 -1
- package/dist/search.d.ts +8 -0
- package/dist/search.d.ts.map +1 -1
- package/dist/search.js +44 -6
- package/dist/search.js.map +1 -1
- package/dist/spec.d.ts +15 -1
- package/dist/spec.d.ts.map +1 -1
- package/dist/spec.js +16 -2
- package/dist/spec.js.map +1 -1
- package/package.json +7 -5
- package/src/build.ts +221 -111
- package/src/cli.ts +96 -2
- package/src/db.ts +87 -5
- package/src/discovery.ts +62 -11
- package/src/doctor.ts +33 -8
- package/src/endpoints.ts +184 -0
- package/src/help.ts +60 -5
- package/src/index.ts +23 -1
- package/src/init/plan.ts +4 -3
- package/src/local.ts +335 -0
- package/src/preview.ts +38 -14
- package/src/search.ts +60 -6
- package/src/spec.ts +18 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export { type AgentFile, type AgentOptions, type AgentPlan, applyAgentSetup, planAgentSetup, type SurfaceKind, withBlock, } from "./agent.js";
|
|
2
2
|
export { type ArtifactPackage, readArtifact } from "./artifact.js";
|
|
3
|
-
export { type BuildOptions, type BuildResult, buildPackage } from "./build.js";
|
|
3
|
+
export { type BuildOptions, type BuildResult, buildPackage, LOCAL_VERSION, localPackageName, } from "./build.js";
|
|
4
4
|
export { type ChangedOptions, changedSurface, type SurfaceChange } from "./changed.js";
|
|
5
5
|
export { type BuildConfig, CONFIG_KEY, type FeedbackChannel, parseBuildConfig, parseFeedbackChannel, readBuildConfig, } from "./config.js";
|
|
6
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";
|
|
7
|
+
export { defaultStorePath, type IndexedChunk, type IndexedPackage, type IndexedSource, LOCAL_STORE_DIR, localStorePath, type PackageKind, type SearchHit, type SearchOptions, Store, type SymbolHit, silenceSqliteWarning, toFtsQuery, toPackageKind, } from "./db.js";
|
|
8
8
|
export { type DiscoveredLibrary, type DiscoveredPackage, type Discovery, discoverLibraries, discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
|
|
9
9
|
export { type DoctorOptions, type DoctorReport, type Finding, runDoctor, type Severity, } from "./doctor.js";
|
|
10
10
|
export { DocspackError } from "./errors.js";
|
|
@@ -19,12 +19,13 @@ export { type InitResult, type RunInitOptions, runInit } from "./init/run.js";
|
|
|
19
19
|
export { type ApplyOptions, applyPlan, renderTree, type WriteStatus, type WrittenFile, } from "./init/write.js";
|
|
20
20
|
export { type FindingKind, isFindingKind, KINDS } from "./kinds.js";
|
|
21
21
|
export { fetchableLinks, type LlmsTxtDocument, type LlmsTxtLink, type LlmsTxtSection, parseLlmsTxt, } from "./llms-txt.js";
|
|
22
|
+
export { type IndexLocalOptions, type IndexLocalResult, indexLocal, type RecallHit, type RecallOptions, type RecallResult, recallLocal, renderRecall, type StaleSource, } from "./local.js";
|
|
22
23
|
export { createMcpServer, type McpOptions, startMcpServer } from "./mcp.js";
|
|
23
24
|
export { type PreviewOptions, type PreviewResult, previewPackage } from "./preview.js";
|
|
24
25
|
export { type Choice, defaultStreams, Prompter, type PromptStreams } from "./prompt.js";
|
|
25
26
|
export { DEFAULT_LIMIT, DEFAULT_MAX_TOKENS, type QueryHit, type QueryOptions, type QueryResult, queryDocs, renderAnswer, splitPackageId, } from "./search.js";
|
|
26
27
|
export { AGENTS_SNIPPET, FEEDBACK_SNIPPET } from "./snippet.js";
|
|
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";
|
|
28
|
+
export { CHUNKS_DIR, type ChunkSpec, chunkId, DISCOVERABLE_NAMES, 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";
|
|
28
29
|
export { STOPWORDS } from "./stopwords.js";
|
|
29
30
|
export { type BlockedFinding, type BlockedReason, issueUrl, prepareSubmission, type RoutedFinding, renderBody, type SubmitOptions, type SubmitReport, } from "./submit.js";
|
|
30
31
|
export { declarationOf, type ExportedSymbol, hasJsdoc, type PublicSurface, readPublicSurface, } from "./surface.js";
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,EACL,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,YAAY,EACZ,aAAa,EACb,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,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,aAAa,EAClB,eAAe,EACf,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,EACL,KAAK,SAAS,EACd,oBAAoB,EACpB,UAAU,EACV,aAAa,GACd,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,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,UAAU,EACV,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,WAAW,EACX,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AACpB,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,kBAAkB,EAClB,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,10 +1,10 @@
|
|
|
1
1
|
export { applyAgentSetup, planAgentSetup, withBlock, } from "./agent.js";
|
|
2
2
|
export { readArtifact } from "./artifact.js";
|
|
3
|
-
export { buildPackage } from "./build.js";
|
|
3
|
+
export { buildPackage, LOCAL_VERSION, localPackageName, } from "./build.js";
|
|
4
4
|
export { changedSurface } from "./changed.js";
|
|
5
5
|
export { CONFIG_KEY, parseBuildConfig, parseFeedbackChannel, readBuildConfig, } from "./config.js";
|
|
6
6
|
export { identifiers, measureCoverage, } from "./coverage.js";
|
|
7
|
-
export { defaultStorePath, Store, silenceSqliteWarning, toFtsQuery, } from "./db.js";
|
|
7
|
+
export { defaultStorePath, LOCAL_STORE_DIR, localStorePath, Store, silenceSqliteWarning, toFtsQuery, toPackageKind, } from "./db.js";
|
|
8
8
|
export { discoverLibraries, discoverPackages, projectPackageIds, resolvePackageDir, } from "./discovery.js";
|
|
9
9
|
export { runDoctor, } from "./doctor.js";
|
|
10
10
|
export { DocspackError } from "./errors.js";
|
|
@@ -19,12 +19,13 @@ export { runInit } from "./init/run.js";
|
|
|
19
19
|
export { applyPlan, renderTree, } from "./init/write.js";
|
|
20
20
|
export { isFindingKind, KINDS } from "./kinds.js";
|
|
21
21
|
export { fetchableLinks, parseLlmsTxt, } from "./llms-txt.js";
|
|
22
|
+
export { indexLocal, recallLocal, renderRecall, } from "./local.js";
|
|
22
23
|
export { createMcpServer, startMcpServer } from "./mcp.js";
|
|
23
24
|
export { previewPackage } from "./preview.js";
|
|
24
25
|
export { defaultStreams, Prompter } from "./prompt.js";
|
|
25
26
|
export { DEFAULT_LIMIT, DEFAULT_MAX_TOKENS, queryDocs, renderAnswer, splitPackageId, } from "./search.js";
|
|
26
27
|
export { AGENTS_SNIPPET, FEEDBACK_SNIPPET } from "./snippet.js";
|
|
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";
|
|
28
|
+
export { CHUNKS_DIR, chunkId, DISCOVERABLE_NAMES, estimateTokens, formatDocumentedLibrary, isCommunityPackage, isDocsPackage, isVendorPackage, LLMS_DIR, MANIFEST_FILE, packageId, parseDocumentedLibrary, parseManifest, resolveChunkFile, SCHEMA_URL, SPEC_URL, serializeManifest, } from "./spec.js";
|
|
28
29
|
export { STOPWORDS } from "./stopwords.js";
|
|
29
30
|
export { issueUrl, prepareSubmission, renderBody, } from "./submit.js";
|
|
30
31
|
export { declarationOf, hasJsdoc, readPublicSurface, } from "./surface.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,
|
|
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,EAGL,YAAY,EACZ,aAAa,EACb,gBAAgB,GACjB,MAAM,YAAY,CAAC;AACpB,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,EAIhB,eAAe,EACf,cAAc,EAId,KAAK,EAEL,oBAAoB,EACpB,UAAU,EACV,aAAa,GACd,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,EAGL,UAAU,EAIV,WAAW,EACX,YAAY,GAEb,MAAM,YAAY,CAAC;AACpB,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,EACP,kBAAkB,EAElB,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/init/plan.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { posix } from "node:path";
|
|
2
2
|
import { DocspackError } from "../errors.js";
|
|
3
|
-
import { isCommunityPackage, isDocsPackage } from "../spec.js";
|
|
3
|
+
import { DISCOVERABLE_NAMES, isCommunityPackage, isDocsPackage } from "../spec.js";
|
|
4
4
|
import { docSeeds, gitignore, packageJson, readme, workflow } from "./templates.js";
|
|
5
5
|
const SLUG = /[^a-z0-9-]+/g;
|
|
6
6
|
/**
|
|
@@ -82,7 +82,7 @@ export function proposePackageName(detected, community) {
|
|
|
82
82
|
function assertPackageName(name) {
|
|
83
83
|
if (!isDocsPackage(name)) {
|
|
84
84
|
throw new DocspackError(`"${name}" is not a name docspack will discover`, {
|
|
85
|
-
hint:
|
|
85
|
+
hint: `Use one of ${DISCOVERABLE_NAMES}.`,
|
|
86
86
|
});
|
|
87
87
|
}
|
|
88
88
|
}
|
|
@@ -93,7 +93,8 @@ function resolveInput(options, detected, dir, notes) {
|
|
|
93
93
|
}
|
|
94
94
|
if (options.mirror !== undefined) {
|
|
95
95
|
if (!isCommunityPackage(options.name ?? "")) {
|
|
96
|
-
notes.push("A mirror republishes someone else's documentation; publish it under @docspack-community
|
|
96
|
+
notes.push("A mirror republishes someone else's documentation; publish it under @docspack-community, " +
|
|
97
|
+
"or as @yourscope/<name>-docspack if you own the scope — not as the vendor's own @vendor/docspack.");
|
|
97
98
|
}
|
|
98
99
|
return { kind: "mirror", value: options.mirror };
|
|
99
100
|
}
|
package/dist/init/plan.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/init/plan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/init/plan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEnF,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAqCpF,MAAM,IAAI,GAAG,cAAc,CAAC;AAE5B;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAoB,EAAE,QAAkB;IAC/D,MAAM,SAAS,GACb,OAAO,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC;IACtE,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;IACjF,CAAC;SAAM,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAClF,KAAK,CAAC,IAAI,CACR,WAAW,OAAO,YAAY,QAAQ,CAAC,WAAW,IAAI,yBAAyB,uCAAuC,CACvH,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAa,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC;IACpD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACnF,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAiB,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC;IAE1D,MAAM,KAAK,GAAkB;QAC3B;YACE,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,WAAW,CAAC;gBACpB,IAAI;gBACJ,OAAO;gBACP,GAAG,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACpF,GAAG,CAAC,QAAQ,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACjF,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACxE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC;gBAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;aACzC,CAAC;SACH;QACD,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE;KAC9C,CAAC;IAEF,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,IAAI,CACR,wIAAwI,CACzI,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,wCAAwC;YAC9C,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;SAC9C,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,kFAAkF,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,iBAAiB,KAAK,kCAAkC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,kBAAkB,CAAC,QAAkB,EAAE,SAAkB;IACvE,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC;IACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,aAAa,CAAC,mCAAmC,EAAE;YAC3D,IAAI,EAAE,0EAA0E;SACjF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7F,MAAM,IAAI,GAAG,IAAI;SACd,WAAW,EAAE;SACb,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC3B,IAAI,SAAS;QAAE,OAAO,uBAAuB,IAAI,EAAE,CAAC;IAEpD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtF,OAAO,IAAI,KAAK,WAAW,CAAC;AAC9B,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,aAAa,CAAC,IAAI,IAAI,wCAAwC,EAAE;YACxE,IAAI,EAAE,cAAc,kBAAkB,GAAG;SAC1C,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,OAAoB,EACpB,QAAkB,EAClB,GAAW,EACX,KAAe;IAEf,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CACnE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAC/B,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,aAAa,CAAC,iDAAiD,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CACR,2FAA2F;gBACzF,mGAAmG,CACtG,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;IACnD,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAC/B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC7E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;IAEvE,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,sBAAsB,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;QAClF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC3E,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,gCAAgC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC;QAChE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,MAAc,EAAE,GAAW;IACpD,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;IACrE,OAAO,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,cAAc,CAAC,KAGvB;IACC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAClC,KAAK,QAAQ;YACX,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QACjC;YACE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;IACtD,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAyC;IAC7D,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,cAAc,KAAK,CAAC,KAAK,EAAE,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC3B;YACE,OAAO,WAAW,KAAK,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;AACH,CAAC"}
|
package/dist/local.d.ts
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { type SearchHit, type Store } from "./db.js";
|
|
2
|
+
export interface IndexLocalOptions {
|
|
3
|
+
readonly cwd: string;
|
|
4
|
+
readonly store: Store;
|
|
5
|
+
/** Directory of Markdown to index. */
|
|
6
|
+
readonly from?: string;
|
|
7
|
+
/** JSON records to index, or `-` for standard input. */
|
|
8
|
+
readonly json?: string;
|
|
9
|
+
readonly name?: string;
|
|
10
|
+
/** Re-index even when no source has changed. */
|
|
11
|
+
readonly force?: boolean;
|
|
12
|
+
readonly onProgress?: (message: string) => void;
|
|
13
|
+
}
|
|
14
|
+
export interface IndexLocalResult {
|
|
15
|
+
readonly id: string;
|
|
16
|
+
readonly name: string;
|
|
17
|
+
readonly chunks: number;
|
|
18
|
+
readonly tokens: number;
|
|
19
|
+
readonly status: "indexed" | "unchanged";
|
|
20
|
+
readonly sources: number;
|
|
21
|
+
/** A corpus read from a stream: nothing on disk to compare it against later. */
|
|
22
|
+
readonly streamed: boolean;
|
|
23
|
+
readonly warnings: readonly string[];
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Indexes a working corpus into this project's own store.
|
|
27
|
+
*
|
|
28
|
+
* The payload is built in a temporary directory and thrown away. A published package is an
|
|
29
|
+
* artifact somebody installs; this is a cache of the reader's own files, and leaving a copy of it
|
|
30
|
+
* in the project would be one more thing to gitignore, review and let go stale.
|
|
31
|
+
*/
|
|
32
|
+
export declare function indexLocal(options: IndexLocalOptions): Promise<IndexLocalResult>;
|
|
33
|
+
export interface RecallHit extends SearchHit {
|
|
34
|
+
readonly name: string;
|
|
35
|
+
}
|
|
36
|
+
/** A source that no longer matches what was indexed from it. */
|
|
37
|
+
export interface StaleSource {
|
|
38
|
+
readonly path: string;
|
|
39
|
+
readonly reason: "changed" | "missing";
|
|
40
|
+
}
|
|
41
|
+
export interface RecallResult {
|
|
42
|
+
readonly hits: readonly RecallHit[];
|
|
43
|
+
readonly tokens: number;
|
|
44
|
+
/** Corpora present in the local store, whether or not they matched. */
|
|
45
|
+
readonly corpora: readonly string[];
|
|
46
|
+
readonly stale: readonly StaleSource[];
|
|
47
|
+
/** Corpora read from a stream, whose freshness cannot be checked. */
|
|
48
|
+
readonly streamed: readonly string[];
|
|
49
|
+
}
|
|
50
|
+
export interface RecallOptions {
|
|
51
|
+
readonly cwd: string;
|
|
52
|
+
readonly store: Store;
|
|
53
|
+
readonly query: string;
|
|
54
|
+
readonly limit?: number;
|
|
55
|
+
readonly maxTokens?: number;
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Answers from the working corpora in this project's store, and from nothing else.
|
|
59
|
+
*
|
|
60
|
+
* Kept separate from `queryDocs` rather than added to it as a flag. `ask` promises an answer from
|
|
61
|
+
* the versions this project installed, and the one line that keeps that promise is the `kinds`
|
|
62
|
+
* filter it passes; a flag that flipped it would put a corpus of somebody's notes one typo away
|
|
63
|
+
* from an answer about a dependency.
|
|
64
|
+
*/
|
|
65
|
+
export declare function recallLocal(options: RecallOptions): Promise<RecallResult>;
|
|
66
|
+
export declare function renderRecall(result: RecallResult, query: string): string;
|
|
67
|
+
//# sourceMappingURL=local.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../src/local.ts"],"names":[],"mappings":"AAKA,OAAO,EAIL,KAAK,SAAS,EACd,KAAK,KAAK,EACX,MAAM,SAAS,CAAC;AAajB,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,gFAAgF;IAChF,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA4DtF;AAED,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,gEAAgE;AAChE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;CACxC;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,SAAS,SAAS,EAAE,CAAC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,uEAAuE;IACvE,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,CA4B/E;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAqBxE"}
|
package/dist/local.js
ADDED
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
import { createHash } from "node:crypto";
|
|
2
|
+
import { mkdir, mkdtemp, readdir, readFile, rm, stat, writeFile } from "node:fs/promises";
|
|
3
|
+
import { tmpdir } from "node:os";
|
|
4
|
+
import { join, resolve } from "node:path";
|
|
5
|
+
import { buildPackage, LOCAL_VERSION, localPackageName, MARKDOWN } from "./build.js";
|
|
6
|
+
import { LOCAL_STORE_DIR, } from "./db.js";
|
|
7
|
+
import { DocspackError } from "./errors.js";
|
|
8
|
+
import { DEFAULT_LIMIT, DEFAULT_MAX_TOKENS } from "./search.js";
|
|
9
|
+
import { chunkId, estimateTokens, LLMS_DIR, MANIFEST_FILE, packageId, parseManifest, resolveChunkFile, } from "./spec.js";
|
|
10
|
+
/**
|
|
11
|
+
* Indexes a working corpus into this project's own store.
|
|
12
|
+
*
|
|
13
|
+
* The payload is built in a temporary directory and thrown away. A published package is an
|
|
14
|
+
* artifact somebody installs; this is a cache of the reader's own files, and leaving a copy of it
|
|
15
|
+
* in the project would be one more thing to gitignore, review and let go stale.
|
|
16
|
+
*/
|
|
17
|
+
export async function indexLocal(options) {
|
|
18
|
+
if (options.from === undefined && options.json === undefined) {
|
|
19
|
+
throw new DocspackError("Nothing to index", {
|
|
20
|
+
hint: "Pass --from <dir> for Markdown, or --from-json <file|-> for records.",
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
const name = options.name ?? localPackageName(options);
|
|
24
|
+
const id = packageId(name, LOCAL_VERSION);
|
|
25
|
+
const streamed = options.json === "-";
|
|
26
|
+
const sources = streamed ? [] : await fingerprint(options);
|
|
27
|
+
if (options.force !== true &&
|
|
28
|
+
!streamed &&
|
|
29
|
+
options.store.hasPackage(id) &&
|
|
30
|
+
unchanged(options.store.sourcesOf(id), sources)) {
|
|
31
|
+
return {
|
|
32
|
+
id,
|
|
33
|
+
name,
|
|
34
|
+
chunks: options.store.countChunks(id),
|
|
35
|
+
tokens: 0,
|
|
36
|
+
status: "unchanged",
|
|
37
|
+
sources: sources.length,
|
|
38
|
+
streamed,
|
|
39
|
+
warnings: [],
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
const work = await mkdtemp(join(tmpdir(), "docspack-local-"));
|
|
43
|
+
try {
|
|
44
|
+
options.onProgress?.(`indexing ${name}`);
|
|
45
|
+
const built = await buildPackage({
|
|
46
|
+
out: work,
|
|
47
|
+
local: true,
|
|
48
|
+
name,
|
|
49
|
+
version: LOCAL_VERSION,
|
|
50
|
+
...(options.from === undefined ? {} : { from: options.from }),
|
|
51
|
+
...(options.json === undefined ? {} : { json: options.json }),
|
|
52
|
+
});
|
|
53
|
+
const chunks = await readChunks(work, id);
|
|
54
|
+
options.store.indexPackage({ id, name, version: LOCAL_VERSION, kind: "local" }, chunks);
|
|
55
|
+
options.store.recordSources(id, sources);
|
|
56
|
+
await protectStore(options.cwd);
|
|
57
|
+
return {
|
|
58
|
+
id,
|
|
59
|
+
name,
|
|
60
|
+
chunks: chunks.length,
|
|
61
|
+
tokens: built.tokens,
|
|
62
|
+
status: "indexed",
|
|
63
|
+
sources: sources.length,
|
|
64
|
+
streamed,
|
|
65
|
+
warnings: built.warnings,
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
finally {
|
|
69
|
+
await rm(work, { recursive: true, force: true });
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Answers from the working corpora in this project's store, and from nothing else.
|
|
74
|
+
*
|
|
75
|
+
* Kept separate from `queryDocs` rather than added to it as a flag. `ask` promises an answer from
|
|
76
|
+
* the versions this project installed, and the one line that keeps that promise is the `kinds`
|
|
77
|
+
* filter it passes; a flag that flipped it would put a corpus of somebody's notes one typo away
|
|
78
|
+
* from an answer about a dependency.
|
|
79
|
+
*/
|
|
80
|
+
export async function recallLocal(options) {
|
|
81
|
+
const corpora = options.store.listPackages().filter((pkg) => pkg.kind === "local");
|
|
82
|
+
const hits = options.store
|
|
83
|
+
.search(options.query, {
|
|
84
|
+
kinds: ["local"],
|
|
85
|
+
limit: options.limit ?? DEFAULT_LIMIT,
|
|
86
|
+
maxTokens: options.maxTokens ?? DEFAULT_MAX_TOKENS,
|
|
87
|
+
})
|
|
88
|
+
.map((hit) => ({ ...hit, name: splitLocalName(hit.packageId) }));
|
|
89
|
+
const stale = [];
|
|
90
|
+
const streamed = [];
|
|
91
|
+
for (const corpus of corpora) {
|
|
92
|
+
const recorded = options.store.sourcesOf(corpus.id);
|
|
93
|
+
if (recorded.length === 0) {
|
|
94
|
+
streamed.push(corpus.name);
|
|
95
|
+
continue;
|
|
96
|
+
}
|
|
97
|
+
stale.push(...(await drifted(recorded)));
|
|
98
|
+
}
|
|
99
|
+
return {
|
|
100
|
+
hits,
|
|
101
|
+
tokens: hits.reduce((total, hit) => total + hit.tokens, 0),
|
|
102
|
+
corpora: corpora.map((corpus) => corpus.name),
|
|
103
|
+
stale,
|
|
104
|
+
streamed,
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
export function renderRecall(result, query) {
|
|
108
|
+
if (result.hits.length === 0) {
|
|
109
|
+
if (result.corpora.length === 0) {
|
|
110
|
+
return `Nothing has been indexed into this project's corpus. Run \`docspack index --from <dir>\` first.`;
|
|
111
|
+
}
|
|
112
|
+
return `Nothing in ${result.corpora.join(", ")} matched "${query}".`;
|
|
113
|
+
}
|
|
114
|
+
const sections = result.hits.map((hit) => [`## ${hit.chunkId}`, `Source: ${hit.name} — ${hit.filePath}`, "", hit.content].join("\n"));
|
|
115
|
+
// Before the passages, not after: a reader who acts on the first thing they read has to be told
|
|
116
|
+
// the text may be superseded before they read it, not once they already have.
|
|
117
|
+
if (result.stale.length > 0)
|
|
118
|
+
sections.unshift(staleNotice(result.stale));
|
|
119
|
+
if (result.streamed.length > 0) {
|
|
120
|
+
sections.push(`NOTE: ${result.streamed.join(", ")} was indexed from a stream, so whether it still matches its source cannot be checked here.`);
|
|
121
|
+
}
|
|
122
|
+
return sections.join("\n\n---\n\n");
|
|
123
|
+
}
|
|
124
|
+
function staleNotice(stale) {
|
|
125
|
+
const shown = stale.slice(0, 5).map((source) => source.path);
|
|
126
|
+
const rest = stale.length - shown.length;
|
|
127
|
+
const missing = stale.filter((source) => source.reason === "missing").length;
|
|
128
|
+
const tail = rest > 0 ? `, and ${String(rest)} more` : "";
|
|
129
|
+
const gone = missing > 0 ? ` ${String(missing)} of them no longer exist.` : "";
|
|
130
|
+
return `NOTE: the corpus is out of date. ${String(stale.length)} indexed ${stale.length === 1 ? "source has" : "sources have"} changed since it was built: ${shown.join(", ")}${tail}.${gone} The passages below may be superseded — run \`docspack index\` again before relying on them.`;
|
|
131
|
+
}
|
|
132
|
+
/** Which recorded sources no longer match what is on disk. */
|
|
133
|
+
async function drifted(recorded) {
|
|
134
|
+
const stale = [];
|
|
135
|
+
for (const source of recorded) {
|
|
136
|
+
let info;
|
|
137
|
+
try {
|
|
138
|
+
info = await stat(source.path);
|
|
139
|
+
}
|
|
140
|
+
catch {
|
|
141
|
+
stale.push({ path: source.path, reason: "missing" });
|
|
142
|
+
continue;
|
|
143
|
+
}
|
|
144
|
+
// Size and mtime first, and the hash only when one of them moved: a checkout or a formatter
|
|
145
|
+
// touches every file's mtime without changing a byte, and hashing a whole corpus on every
|
|
146
|
+
// query to find that out would make the cheap path the expensive one.
|
|
147
|
+
if (info.size === source.size && info.mtimeMs === Date.parse(source.mtime))
|
|
148
|
+
continue;
|
|
149
|
+
if ((await hashOf(source.path)) === source.hash)
|
|
150
|
+
continue;
|
|
151
|
+
stale.push({ path: source.path, reason: "changed" });
|
|
152
|
+
}
|
|
153
|
+
return stale;
|
|
154
|
+
}
|
|
155
|
+
/** What a corpus was built from, as it is right now. */
|
|
156
|
+
async function fingerprint(options) {
|
|
157
|
+
const paths = [];
|
|
158
|
+
if (options.from !== undefined) {
|
|
159
|
+
const root = resolve(options.from);
|
|
160
|
+
const found = await readdir(root, { recursive: true, withFileTypes: true }).catch(() => {
|
|
161
|
+
throw new DocspackError(`No such directory: ${options.from ?? ""}`, {
|
|
162
|
+
hint: "Pass --from <dir> to point at the Markdown you want indexed.",
|
|
163
|
+
});
|
|
164
|
+
});
|
|
165
|
+
paths.push(...found
|
|
166
|
+
.filter((entry) => entry.isFile() && MARKDOWN.test(entry.name))
|
|
167
|
+
.map((entry) => join(entry.parentPath, entry.name))
|
|
168
|
+
.sort());
|
|
169
|
+
}
|
|
170
|
+
if (options.json !== undefined && options.json !== "-")
|
|
171
|
+
paths.push(resolve(options.json));
|
|
172
|
+
const sources = [];
|
|
173
|
+
for (const path of paths) {
|
|
174
|
+
const info = await stat(path);
|
|
175
|
+
sources.push({
|
|
176
|
+
path,
|
|
177
|
+
size: info.size,
|
|
178
|
+
mtime: new Date(info.mtimeMs).toISOString(),
|
|
179
|
+
hash: await hashOf(path),
|
|
180
|
+
});
|
|
181
|
+
}
|
|
182
|
+
return sources;
|
|
183
|
+
}
|
|
184
|
+
function unchanged(recorded, current) {
|
|
185
|
+
if (recorded.length !== current.length)
|
|
186
|
+
return false;
|
|
187
|
+
const before = new Map(recorded.map((source) => [source.path, source.hash]));
|
|
188
|
+
return current.every((source) => before.get(source.path) === source.hash);
|
|
189
|
+
}
|
|
190
|
+
async function hashOf(path) {
|
|
191
|
+
return createHash("sha256")
|
|
192
|
+
.update(await readFile(path))
|
|
193
|
+
.digest("hex");
|
|
194
|
+
}
|
|
195
|
+
async function readChunks(dir, id) {
|
|
196
|
+
const llmsDir = join(dir, LLMS_DIR);
|
|
197
|
+
const manifest = parseManifest(JSON.parse(await readFile(join(llmsDir, MANIFEST_FILE), "utf8")), `${LLMS_DIR}/${MANIFEST_FILE}`);
|
|
198
|
+
const chunks = [];
|
|
199
|
+
for (const chunk of manifest.chunks) {
|
|
200
|
+
const content = (await readFile(resolveChunkFile(llmsDir, chunk.file), "utf8")).trim();
|
|
201
|
+
if (content.length === 0)
|
|
202
|
+
continue;
|
|
203
|
+
chunks.push({
|
|
204
|
+
chunkId: chunkId(id, chunk.id),
|
|
205
|
+
filePath: chunk.file,
|
|
206
|
+
tokens: chunk.tokens ?? estimateTokens(content),
|
|
207
|
+
content,
|
|
208
|
+
tags: [...chunk.tags, ...chunk.entities],
|
|
209
|
+
});
|
|
210
|
+
}
|
|
211
|
+
if (chunks.length === 0) {
|
|
212
|
+
throw new DocspackError("Nothing readable to index", {
|
|
213
|
+
hint: "The sources produced no chunks. Check they contain text.",
|
|
214
|
+
});
|
|
215
|
+
}
|
|
216
|
+
return chunks;
|
|
217
|
+
}
|
|
218
|
+
/**
|
|
219
|
+
* Keeps the store out of version control.
|
|
220
|
+
*
|
|
221
|
+
* The index is a plaintext copy of whatever was indexed, so committing it would put the corpus in
|
|
222
|
+
* the repository a second time — and for notes, an export or a query result, somewhere nobody
|
|
223
|
+
* thought to look for it. Written next to the store rather than in the project's own
|
|
224
|
+
* `.gitignore`, which is the project's file and not this tool's to edit.
|
|
225
|
+
*/
|
|
226
|
+
async function protectStore(cwd) {
|
|
227
|
+
const dir = join(cwd, LOCAL_STORE_DIR);
|
|
228
|
+
await mkdir(dir, { recursive: true });
|
|
229
|
+
const ignore = join(dir, ".gitignore");
|
|
230
|
+
try {
|
|
231
|
+
await readFile(ignore, "utf8");
|
|
232
|
+
}
|
|
233
|
+
catch {
|
|
234
|
+
await writeFile(ignore, "# The local index is a copy of your own sources. Do not commit it.\n*\n");
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
/** `@local/notes@0.0.0/chunk` carries the corpus name; the version is never interesting. */
|
|
238
|
+
function splitLocalName(packageId) {
|
|
239
|
+
const at = packageId.lastIndexOf("@");
|
|
240
|
+
return at <= 0 ? packageId : packageId.slice(0, at);
|
|
241
|
+
}
|
|
242
|
+
//# sourceMappingURL=local.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"local.js","sourceRoot":"","sources":["../src/local.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACrF,OAAO,EAGL,eAAe,GAGhB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EACL,OAAO,EACP,cAAc,EACd,QAAQ,EACR,aAAa,EACb,SAAS,EACT,aAAa,EACb,gBAAgB,GACjB,MAAM,WAAW,CAAC;AA2BnB;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAA0B;IACzD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC7D,MAAM,IAAI,aAAa,CAAC,kBAAkB,EAAE;YAC1C,IAAI,EAAE,sEAAsE;SAC7E,CAAC,CAAC;IACL,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,KAAK,GAAG,CAAC;IACtC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;IAE3D,IACE,OAAO,CAAC,KAAK,KAAK,IAAI;QACtB,CAAC,QAAQ;QACT,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAC/C,CAAC;QACD,OAAO;YACL,EAAE;YACF,IAAI;YACJ,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACrC,MAAM,EAAE,CAAC;YACT,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,OAAO,CAAC,MAAM;YACvB,QAAQ;YACR,QAAQ,EAAE,EAAE;SACb,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC9D,IAAI,CAAC;QACH,OAAO,CAAC,UAAU,EAAE,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC;YAC/B,GAAG,EAAE,IAAI;YACT,KAAK,EAAE,IAAI;YACX,IAAI;YACJ,OAAO,EAAE,aAAa;YACtB,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;YAC7D,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;SAC9D,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;QACxF,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACzC,MAAM,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEhC,OAAO;YACL,EAAE;YACF,IAAI;YACJ,MAAM,EAAE,MAAM,CAAC,MAAM;YACrB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,OAAO,CAAC,MAAM;YACvB,QAAQ;YACR,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AA8BD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,OAAsB;IACtD,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IACnF,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK;SACvB,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;QACrB,KAAK,EAAE,CAAC,OAAO,CAAC;QAChB,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,aAAa;QACrC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,kBAAkB;KACnD,CAAC;SACD,GAAG,CAAC,CAAC,GAAG,EAAa,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;IAE9E,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC3B,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,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,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC;QAC7C,KAAK;QACL,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAoB,EAAE,KAAa;IAC9D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChC,OAAO,iGAAiG,CAAC;QAC3G,CAAC;QACD,OAAO,cAAc,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC;IACvE,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACvC,CAAC,MAAM,GAAG,CAAC,OAAO,EAAE,EAAE,WAAW,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC3F,CAAC;IAEF,gGAAgG;IAChG,8EAA8E;IAC9E,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,QAAQ,CAAC,IAAI,CACX,SAAS,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,4FAA4F,CAChI,CAAC;IACJ,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,WAAW,CAAC,KAA6B;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IACzC,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,MAAM,CAAC;IAC7E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,MAAM,IAAI,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/E,OAAO,oCAAoC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc,gCAAgC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,IAAI,8FAA8F,CAAC;AAC7R,CAAC;AAED,8DAA8D;AAC9D,KAAK,UAAU,OAAO,CAAC,QAAkC;IACvD,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,IAAI,IAAsC,CAAC;QAC3C,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAAC,MAAM,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;YACrD,SAAS;QACX,CAAC;QACD,4FAA4F;QAC5F,0FAA0F;QAC1F,sEAAsE;QACtE,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;YAAE,SAAS;QACrF,IAAI,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,MAAM,CAAC,IAAI;YAAE,SAAS;QAC1D,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACvD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,wDAAwD;AACxD,KAAK,UAAU,WAAW,CAAC,OAA0B;IACnD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;YACrF,MAAM,IAAI,aAAa,CAAC,sBAAsB,OAAO,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE;gBAClE,IAAI,EAAE,8DAA8D;aACrE,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CACR,GAAG,KAAK;aACL,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC9D,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;aAClD,IAAI,EAAE,CACV,CAAC;IACJ,CAAC;IACD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,GAAG;QAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAE1F,MAAM,OAAO,GAAoB,EAAE,CAAC;IACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC;YACX,IAAI;YACJ,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE;YAC3C,IAAI,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC;SACzB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,SAAS,CAAC,QAAkC,EAAE,OAAiC;IACtF,IAAI,QAAQ,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACrD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7E,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5E,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,OAAO,UAAU,CAAC,QAAQ,CAAC;SACxB,MAAM,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC5B,MAAM,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,GAAW,EAAE,EAAU;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACpC,MAAM,QAAQ,GAAG,aAAa,CAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,MAAM,CAAC,CAAC,EAChE,GAAG,QAAQ,IAAI,aAAa,EAAE,CAC/B,CAAC;IAEF,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,CAAC,MAAM,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACvF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QACnC,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,OAAO,CAAC;YAC/C,OAAO;YACP,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC;SACzC,CAAC,CAAC;IACL,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,aAAa,CAAC,2BAA2B,EAAE;YACnD,IAAI,EAAE,0DAA0D;SACjE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,KAAK,UAAU,YAAY,CAAC,GAAW;IACrC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IACvC,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtC,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;IACvC,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,SAAS,CACb,MAAM,EACN,yEAAyE,CAC1E,CAAC;IACJ,CAAC;AACH,CAAC;AAED,4FAA4F;AAC5F,SAAS,cAAc,CAAC,SAAiB;IACvC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACtC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACtD,CAAC"}
|
package/dist/preview.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"preview.d.ts","sourceRoot":"","sources":["../src/preview.ts"],"names":[],"mappings":"AAKA,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,CA0FpF"}
|
package/dist/preview.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { readFile } from "node:fs/promises";
|
|
2
2
|
import { join } from "node:path";
|
|
3
3
|
import { Store } from "./db.js";
|
|
4
|
+
import { endpointIndex, matchEndpoints } from "./endpoints.js";
|
|
4
5
|
import { DocspackError } from "./errors.js";
|
|
5
6
|
import { DEFAULT_LIMIT, DEFAULT_MAX_TOKENS } from "./search.js";
|
|
6
7
|
import { chunkId, estimateTokens, formatDocumentedLibrary, isCommunityPackage, LLMS_DIR, MANIFEST_FILE, packageId, parseManifest, resolveChunkFile, } from "./spec.js";
|
|
@@ -49,19 +50,36 @@ export async function previewPackage(options) {
|
|
|
49
50
|
const store = Store.open(":memory:");
|
|
50
51
|
try {
|
|
51
52
|
store.indexPackage({ id, name: manifest.name, version: manifest.version }, chunks);
|
|
52
|
-
const
|
|
53
|
-
.search(options.query, {
|
|
54
|
-
limit: options.limit ?? DEFAULT_LIMIT,
|
|
55
|
-
maxTokens: options.maxTokens ?? DEFAULT_MAX_TOKENS,
|
|
56
|
-
})
|
|
57
|
-
.map((hit) => ({
|
|
53
|
+
const describe = (hit) => ({
|
|
58
54
|
...hit,
|
|
59
55
|
name: manifest.name,
|
|
60
56
|
version: manifest.version,
|
|
61
57
|
kind: "docs",
|
|
62
58
|
trusted: !isCommunityPackage(manifest.name),
|
|
63
59
|
...(documents.length === 0 ? {} : { documents }),
|
|
64
|
-
})
|
|
60
|
+
});
|
|
61
|
+
// The same endpoint pinning `queryDocs` does, because `preview` exists to show an author what an
|
|
62
|
+
// agent would receive. A preview that ranked where the real query path pins would send them
|
|
63
|
+
// chasing a retrieval problem they do not have.
|
|
64
|
+
const limit = options.limit ?? DEFAULT_LIMIT;
|
|
65
|
+
const maxTokens = options.maxTokens ?? DEFAULT_MAX_TOKENS;
|
|
66
|
+
const pinned = matchEndpoints(options.query, endpointIndex(manifest.chunks.map((chunk) => ({
|
|
67
|
+
chunkId: chunkId(id, chunk.id),
|
|
68
|
+
entities: chunk.entities,
|
|
69
|
+
}))))
|
|
70
|
+
.map((match) => store.chunk(match.chunkId))
|
|
71
|
+
.filter((chunk) => chunk !== undefined)
|
|
72
|
+
.map(describe);
|
|
73
|
+
const spent = pinned.reduce((total, hit) => total + hit.tokens, 0);
|
|
74
|
+
const pinnedIds = new Set(pinned.map((hit) => hit.chunkId));
|
|
75
|
+
const ranked = store
|
|
76
|
+
.search(options.query, {
|
|
77
|
+
limit: Math.max(1, limit - pinned.length),
|
|
78
|
+
maxTokens: Math.max(1, maxTokens - spent),
|
|
79
|
+
})
|
|
80
|
+
.filter((hit) => !pinnedIds.has(hit.chunkId))
|
|
81
|
+
.map(describe);
|
|
82
|
+
const hits = [...pinned, ...ranked];
|
|
65
83
|
return {
|
|
66
84
|
hits,
|
|
67
85
|
tokens: hits.reduce((total, hit) => total + hit.tokens, 0),
|
package/dist/preview.js.map
CHANGED
|
@@ -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,
|
|
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,EAAqC,KAAK,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/D,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;QAEnF,MAAM,QAAQ,GAAG,CAAC,GAAc,EAAY,EAAE,CAAC,CAAC;YAC9C,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,CAAC;QAEH,iGAAiG;QACjG,4FAA4F;QAC5F,gDAAgD;QAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,aAAa,CAAC;QAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,kBAAkB,CAAC;QAC1D,MAAM,MAAM,GAAG,cAAc,CAC3B,OAAO,CAAC,KAAK,EACb,aAAa,CACX,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC9B,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC;YAC9B,QAAQ,EAAE,KAAK,CAAC,QAAQ;SACzB,CAAC,CAAC,CACJ,CACF;aACE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;aAC1C,MAAM,CAAC,CAAC,KAAK,EAAsB,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC;aAC1D,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjB,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QAE5D,MAAM,MAAM,GAAG,KAAK;aACjB,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE;YACrB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;YACzC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;SAC1C,CAAC;aACD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aAC5C,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEjB,MAAM,IAAI,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;QACpC,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
|
@@ -52,6 +52,14 @@ export interface QueryResult {
|
|
|
52
52
|
* matched", which a ranker alone cannot tell apart — it always returns its best three.
|
|
53
53
|
*/
|
|
54
54
|
readonly undocumented: readonly string[];
|
|
55
|
+
/**
|
|
56
|
+
* Endpoints the question named that a documented operation answers, pinned rather than ranked.
|
|
57
|
+
*
|
|
58
|
+
* Reported so an answer can say *why* a chunk is first. A reader who asked about
|
|
59
|
+
* `GET /v1/charges/ch_3Ox7` and is shown `GET /v1/charges/{charge}` has been given the right
|
|
60
|
+
* chunk, and has to be told that the match was against a template.
|
|
61
|
+
*/
|
|
62
|
+
readonly endpoints: readonly string[];
|
|
55
63
|
}
|
|
56
64
|
export declare function queryDocs(options: QueryOptions): Promise<QueryResult>;
|
|
57
65
|
/**
|
package/dist/search.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAK7D,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;IACzC;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,wBAAsB,SAAS,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC,CAqE3E;AA4HD;;;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"}
|