wiki-graph-sdk 0.8.0 → 0.8.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +46 -0
  2. package/dist/archives.cjs +98 -17
  3. package/dist/archives.cjs.map +1 -1
  4. package/dist/archives.d.ts +10 -2
  5. package/dist/archives.js +100 -17
  6. package/dist/archives.js.map +1 -1
  7. package/dist/conversions.cjs +23 -5
  8. package/dist/conversions.cjs.map +1 -1
  9. package/dist/conversions.d.ts +6 -1
  10. package/dist/conversions.js +24 -5
  11. package/dist/conversions.js.map +1 -1
  12. package/dist/default-worker.cjs +84 -21
  13. package/dist/default-worker.cjs.map +1 -1
  14. package/dist/default-worker.d.ts +1 -0
  15. package/dist/default-worker.js +88 -21
  16. package/dist/default-worker.js.map +1 -1
  17. package/dist/embedding.cjs +2 -1
  18. package/dist/embedding.cjs.map +1 -1
  19. package/dist/embedding.d.ts +4 -4
  20. package/dist/embedding.js +3 -1
  21. package/dist/embedding.js.map +1 -1
  22. package/dist/gc.cjs +52 -10
  23. package/dist/gc.cjs.map +1 -1
  24. package/dist/gc.d.ts +3 -0
  25. package/dist/gc.js +56 -10
  26. package/dist/gc.js.map +1 -1
  27. package/dist/host-pQiVAKEY.d.ts +10 -0
  28. package/dist/index.cjs +422 -57
  29. package/dist/index.cjs.map +1 -1
  30. package/dist/index.d.ts +33 -12
  31. package/dist/index.js +427 -59
  32. package/dist/index.js.map +1 -1
  33. package/dist/{jobs-xIm_kshM.d.ts → jobs-CRK-DZ40.d.ts} +5 -0
  34. package/dist/local-config.cjs +2 -1
  35. package/dist/local-config.cjs.map +1 -1
  36. package/dist/local-config.js +3 -1
  37. package/dist/local-config.js.map +1 -1
  38. package/dist/maintenance.cjs +2 -1
  39. package/dist/maintenance.cjs.map +1 -1
  40. package/dist/maintenance.d.ts +4 -1
  41. package/dist/maintenance.js +3 -1
  42. package/dist/maintenance.js.map +1 -1
  43. package/dist/node-platform.cjs +18 -4
  44. package/dist/node-platform.cjs.map +1 -1
  45. package/dist/node-platform.d.ts +12 -3
  46. package/dist/node-platform.js +18 -4
  47. package/dist/node-platform.js.map +1 -1
  48. package/dist/runtime-config.cjs +4 -3
  49. package/dist/runtime-config.cjs.map +1 -1
  50. package/dist/runtime-config.d.ts +4 -1
  51. package/dist/runtime-config.js +5 -3
  52. package/dist/runtime-config.js.map +1 -1
  53. package/dist/stage-BnWI3Rqt.d.ts +33 -0
  54. package/dist/stage.cjs +22 -12
  55. package/dist/stage.cjs.map +1 -1
  56. package/dist/stage.d.ts +2 -14
  57. package/dist/stage.js +23 -12
  58. package/dist/stage.js.map +1 -1
  59. package/dist/worker.cjs +83 -43
  60. package/dist/worker.cjs.map +1 -1
  61. package/dist/worker.d.ts +7 -2
  62. package/dist/worker.js +87 -43
  63. package/dist/worker.js.map +1 -1
  64. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -4,27 +4,29 @@ import { W as WikiGraphArchiveTarget } from './target-CZ7elwmj.js';
4
4
  export { a as WikiGraphArchiveOwnershipError } from './target-CZ7elwmj.js';
5
5
  import { LocalConfigSection, LocalConfigObject } from './local-config.js';
6
6
  export { LOCAL_CONFIG_SECTIONS, clearLocalConfigSection, deleteLocalConfigValue, maskLocalConfigSection, normalizeLocalConfigKey, parseLocalConfigSection, putLocalConfigValue, readLocalConfigSection, replaceLocalConfigSection, validateLocalConfigSection } from './local-config.js';
7
- import { W as WikiGraphJobRuntime, a as WikiGraphJobManager } from './jobs-xIm_kshM.js';
8
- export { b as WikiGraphJob, c as WikiGraphJobBackend, d as WikiGraphJobChapterReference, e as WikiGraphJobCreateOptions, f as WikiGraphJobEnqueueOptions, g as WikiGraphJobEnqueuePlan, h as WikiGraphJobEnqueueResult, i as WikiGraphJobEventListener, j as WikiGraphJobEventsOptions, k as WikiGraphJobListOptions, l as WikiGraphJobSnapshot, m as WikiGraphJobSubscriptionOptions } from './jobs-xIm_kshM.js';
9
- import { ContinuationCursor, QueryIndexScope, ArchiveSourceLocatorResult, ArchiveCollectionResult, ArchiveFindResult, ArchiveEvidence, ArchiveRelatedResult, WikiGraphLibraryRecord, WikiGraphLibraryArchiveRecord, ParsedWikiGraphLibraryUri, WikiGraphLibraryIndexState, rebuildWikiGraphLibraryIndex, ArchiveFindOptions, ArchiveCollectionOptions, readWikiGraphLibraryPage, ArchivePage, listRelatedWikiGraphLibraryObjects, listWikiGraphLibraryEvidence, ArchivePack } from 'wiki-graph-core';
10
- export { ArchiveBacklinkBucket, ArchiveBacklinks, ArchiveCollectionOptions, ArchiveCollectionResult, ArchiveEvidence, ArchiveEvidenceItem, ArchiveFindEvidencePreview, ArchiveFindHit, ArchiveFindOptions, ArchiveFindResult, ArchiveListItem, ArchivePack, ArchivePage, ArchiveRelatedResult, ArchiveSourceLocator, ArchiveSourceLocatorResult, ArchiveTriplePattern, BookMeta, BuildJobEvent, BuildJobProgressCounter, BuildJobTarget, ChapterDetails, ChapterEntry, ChapterStage, ChapterTree, ChapterTreeApplyResult, ContinuationCursor, DEFAULT_EXTRACTION_PROMPT, DEFAULT_KNOWLEDGE_GRAPH_RECALL_PROMPT, IndexArtifactKind, LLMPaymentRequiredError, LocatedWikiGraphUri, ParsedWikiGraphLibraryUri, QueryIndexScope, SearchIndexEmbeddingProvider, SourceArtifactInput, WIKI_GRAPH_URI_PREFIX, WikiGraphError, WikiGraphLLMOptions, WikiGraphLibraryIndexState, WikiGraphMaintenanceUpgradeResult, WikiGraphProgressCallback, WikiGraphProgressEvent, WikispineProvider, formatError, formatLocatedChapterResourceUri, formatLocatedChapterSourceCollectionUri, formatLocatedChapterUri, formatLocatedWikiGraphUri, formatWikiGraphCommandUri, formatWikiGraphLibraryUri, isSourceLocatorScopeUri, isWikiGraphLibraryUri, parseChapterPath, parseChapterTreeInput, parseChapterUriPath, parseLocatedWikiGraphUri, parseSourceTextJsonl, parseWikiGraphLibraryUri, parseWikiGraphUriSyntax, resolveExtractionPrompt, resolveKnowledgeGraphRecallPrompt } from 'wiki-graph-core';
7
+ import { W as WikiGraphJobRuntime, a as WikiGraphJobManager } from './jobs-CRK-DZ40.js';
8
+ export { b as WikiGraphJob, c as WikiGraphJobBackend, d as WikiGraphJobChapterReference, e as WikiGraphJobCreateOptions, f as WikiGraphJobEnqueueOptions, g as WikiGraphJobEnqueuePlan, h as WikiGraphJobEnqueueResult, i as WikiGraphJobEventListener, j as WikiGraphJobEventsOptions, k as WikiGraphJobListOptions, l as WikiGraphJobSnapshot, m as WikiGraphJobSubscriptionOptions } from './jobs-CRK-DZ40.js';
9
+ import { ContinuationCursor, QueryIndexScope, SearchIndexQueryMode, ArchiveSourceLocatorResult, ArchiveCollectionResult, ArchiveFindResult, ArchiveEvidence, ArchiveRelatedResult, WikiGraphLibraryRecord, WikiGraphLibraryArchiveRecord, ParsedWikiGraphLibraryUri, listWikiGraphLibraryEvidence, WikiGraphLibraryIndexState, rebuildWikiGraphLibraryIndex, ArchiveFindOptions, ArchiveCollectionOptions, readWikiGraphLibraryPage, ArchivePage, listRelatedWikiGraphLibraryObjects, ArchivePack } from 'wiki-graph-core';
10
+ export { ArchiveBacklinkBucket, ArchiveBacklinks, ArchiveCollectionOptions, ArchiveCollectionResult, ArchiveEvidence, ArchiveEvidenceItem, ArchiveFindEvidencePreview, ArchiveFindHit, ArchiveFindOptions, ArchiveFindResult, ArchiveListItem, ArchivePack, ArchivePage, ArchiveRelatedResult, ArchiveSourceLocator, ArchiveSourceLocatorResult, ArchiveTriplePattern, BookMeta, BuildJobEvent, BuildJobProgressCounter, BuildJobTarget, ChapterDetails, ChapterEntry, ChapterStage, ChapterTree, ChapterTreeApplyResult, ContinuationCursor, DEFAULT_EXTRACTION_PROMPT, DEFAULT_KNOWLEDGE_GRAPH_RECALL_PROMPT, Directory, File, FileReader, FileWriter, IndexArtifactKind, LLMPaymentRequiredError, LocatedWikiGraphUri, ParsedSourceLocatorFragment, ParsedWikiGraphLibraryUri, ParsedWikiGraphUri, QueryIndexScope, ReadonlyFile, SearchIndexEmbeddingProvider, SearchIndexQueryMode, SourceArtifactInput, WIKI_GRAPH_URI_PREFIX, WikiGraphError, WikiGraphLLMOptions, WikiGraphLibraryIndexState, WikiGraphMaintenanceUpgradeResult, WikiGraphPlatform, WikiGraphProgressCallback, WikiGraphProgressEvent, WikiGraphStorage, WikispineProvider, formatError, formatLocatedChapterResourceUri, formatLocatedChapterSourceCollectionUri, formatLocatedChapterUri, formatLocatedWikiGraphUri, formatSourceArtifactUri, formatSourceLocatorFragment, formatWikiGraphCommandUri, formatWikiGraphLibraryUri, isSourceLocatorScopeUri, isWikiGraphJobUri, isWikiGraphLibraryUri, isWikiGraphUri, parseChapterPath, parseChapterTreeInput, parseChapterUriPath, parseLocatedWikiGraphUri, parseSourceLocatorFragment, parseSourceTextJsonl, parseWikiGraphLibraryUri, parseWikiGraphUriSyntax, requireArchiveUri, requireLocatedObjectOrArchiveUri, requireLocatedObjectUri, resolveExtractionPrompt, resolveKnowledgeGraphRecallPrompt } from 'wiki-graph-core';
11
11
  import { WikiGraphConversionManager } from './conversions.js';
12
12
  export { WikiGraphConversionFormat, WikiGraphConversionInput, WikiGraphConversionOptions, WikiGraphConversionResult, WikiGraphSourceFormat } from './conversions.js';
13
13
  export { WikiGraphQueueWorkerOptions, requireKnowledgeGraphWikispineConfig, runWikiGraphQueueWorker } from './default-worker.js';
14
14
  export { DANGEROUS_RUNTIME_ENV_NAMES, WikiGraphEntryEnvPolicy, WikiGraphEntryRuntimeContext, WikiGraphEntryRuntimeOptions, createEntryRuntimeContext } from './entry-context.js';
15
- export { QueryEmbeddingResult, WikiGraphEmbeddingConfig, WikiGraphEmbeddingProvider, buildSearchIndexEmbeddingProvider, embedQueryText, embedQueryTextWithLocalConfig, readWikiGraphEmbeddingConfig } from './embedding.js';
15
+ export { QueryEmbeddingResult, WikiGraphEmbeddingConfig, WikiGraphEmbeddingProviderName, buildSearchIndexEmbeddingProvider, embedQueryText, embedQueryTextWithLocalConfig, readWikiGraphEmbeddingConfig } from './embedding.js';
16
+ import { W as WikiGraphSDKHost } from './host-pQiVAKEY.js';
16
17
  export { buildWikiGraphLLMOptions } from './llm.js';
17
18
  import { WikiGraphMaintenanceManager } from './maintenance.js';
18
19
  export { WikiGraphLegacyMigrationResult, WikiGraphMaintenanceTarget } from './maintenance.js';
19
- export { NodeDirectory, NodeFile, createNodeTemplateEnvironment, createNodeWikiGraphStorage, ensureNodeWikiGraphPlatform, getNodeResourcePath, installNodeWikiGraphPlatform, nodeWikiGraphPlatform, withNodeWikiGraphStorage, writeNodeFileHandle } from './node-platform.js';
20
+ export { NodeDirectory, NodeFile, NodeWikiGraphPlatformOptions, NodeWikiGraphStorageOptions, createNodeTemplateEnvironment, createNodeWikiGraphPlatform, createNodeWikiGraphStorage, ensureNodeWikiGraphPlatform, getNodeResourcePath, installNodeWikiGraphPlatform, nodeWikiGraphPlatform, withNodeWikiGraphStorage, writeNodeFileHandle } from './node-platform.js';
20
21
  export { DEFAULT_GENERATION_JOB_CONCURRENCY, DEFAULT_GENERATION_REQUEST_CONCURRENCY, GenerationConcurrency, GenerationPerformanceHint, GenerationPlanningCost, createGenerationPerformanceHints, formatGenerationPlanningDuration, formatGenerationPlanningModel, planGenerationTask } from './planning.js';
21
- export { HostedProviderScope, WikiGraphProvider, WikiGraphRuntimeConfig, loadWikiGraphRuntimeConfig, resolveHostedProviderEndpoint, resolveWikispineConfig } from './runtime-config.js';
22
- export { createStageLLM, loadRequiredStageConfig } from './stage.js';
22
+ import { W as WikiGraphSDKProviders } from './stage-BnWI3Rqt.js';
23
+ export { a as WikiGraphEmbeddingProvider, b as WikiGraphLLMMessage, c as WikiGraphLLMProvider, d as WikiGraphLLMProviderEvent, e as WikiGraphLLMProviderOptions, f as createStageLLM, l as loadRequiredStageConfig, r as resolveWikiGraphLLMJSON } from './stage-BnWI3Rqt.js';
24
+ export { HostedProviderScope, WikiGraphLLMConfig, WikiGraphProvider, WikiGraphRuntimeConfig, loadWikiGraphRuntimeConfig, resolveHostedProviderEndpoint, resolveWikispineConfig } from './runtime-config.js';
23
25
  export { nodeWikispineCommandRunner } from './wikispine.js';
24
26
  import 'zod';
27
+ import 'wiki-graph-core/platform';
25
28
  import 'node:fs/promises';
26
29
  import 'nunjucks';
27
- import 'wiki-graph-core/platform';
28
30
 
29
31
  interface WikiGraphProviderTestResult {
30
32
  readonly durationMs: number;
@@ -74,8 +76,10 @@ interface WikiGraphContinuationContext {
74
76
  readonly ids?: readonly string[];
75
77
  readonly indexScope: QueryIndexScope;
76
78
  readonly libraryQuery?: "archive-members" | "objects";
79
+ readonly match?: "all" | "any";
77
80
  readonly order?: "doc-asc" | "doc-desc";
78
81
  readonly query?: string;
82
+ readonly queryMode?: SearchIndexQueryMode;
79
83
  readonly role?: "any" | "object" | "self" | "subject" | undefined;
80
84
  readonly skipUnindexed?: boolean;
81
85
  readonly sourceContext?: number;
@@ -127,6 +131,8 @@ declare class WikiGraphContinuationManager {
127
131
 
128
132
  type WikiGraphLibraryTarget = ParsedWikiGraphLibraryUri | string;
129
133
  type WikiGraphLibrarySearchOptions = Omit<ArchiveFindOptions, "embeddingProvider">;
134
+ type WikiGraphLibraryRelatedOptions = Omit<NonNullable<Parameters<typeof listRelatedWikiGraphLibraryObjects>[2]>, "embeddingProvider">;
135
+ type WikiGraphLibraryEvidenceOptions = Omit<NonNullable<Parameters<typeof listWikiGraphLibraryEvidence>[2]>, "embeddingProvider">;
130
136
  type WikiGraphLibraryPageOptions = Omit<Parameters<typeof readWikiGraphLibraryPage>[2], "wikimediaResolver"> & {
131
137
  readonly signal?: AbortSignal;
132
138
  };
@@ -143,6 +149,15 @@ interface WikiGraphLibraryReplaceArchiveOptions {
143
149
  readonly inputPath: string;
144
150
  readonly target: WikiGraphLibraryTarget;
145
151
  }
152
+ interface WikiGraphLibraryArchiveContent {
153
+ readonly mediaType: "application/vnd.wiki-graph.archive";
154
+ readonly size: number;
155
+ readonly stream: AsyncIterable<Uint8Array>;
156
+ readonly uri: string;
157
+ }
158
+ interface WikiGraphLibraryArchiveReadOptions {
159
+ readonly signal?: AbortSignal;
160
+ }
146
161
  interface WikiGraphLibrarySnapshot extends Omit<WikiGraphLibraryRecord, "folder" | "staging"> {
147
162
  readonly folderPath: string;
148
163
  }
@@ -162,6 +177,7 @@ declare class WikiGraphLibraryManager {
162
177
  remove(target: WikiGraphLibraryTarget): Promise<WikiGraphLibrarySnapshot>;
163
178
  scan(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryScanSnapshot>;
164
179
  getArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveSnapshot>;
180
+ readArchive<T>(target: WikiGraphLibraryTarget, consume: (content: WikiGraphLibraryArchiveContent) => Promise<T> | T, options?: WikiGraphLibraryArchiveReadOptions): Promise<T>;
165
181
  moveArchive(options: WikiGraphLibraryMoveArchiveOptions): Promise<WikiGraphLibraryArchiveSnapshot>;
166
182
  removeArchive(target: WikiGraphLibraryTarget): Promise<WikiGraphLibraryArchiveSnapshot>;
167
183
  replaceArchive(options: WikiGraphLibraryReplaceArchiveOptions): Promise<WikiGraphLibraryArchiveSnapshot>;
@@ -178,8 +194,8 @@ declare class WikiGraphLibraryManager {
178
194
  objects(target: WikiGraphLibraryTarget, options?: ArchiveCollectionOptions): Promise<ArchiveCollectionResult>;
179
195
  archiveMembers(target: WikiGraphLibraryTarget, options?: ArchiveCollectionOptions): Promise<ArchiveCollectionResult>;
180
196
  page(target: WikiGraphLibraryTarget, objectUri: string, options?: WikiGraphLibraryPageOptions): Promise<ArchivePage>;
181
- related(target: WikiGraphLibraryTarget, objectUri: string, options?: Parameters<typeof listRelatedWikiGraphLibraryObjects>[2]): Promise<ArchiveRelatedResult>;
182
- evidence(target: WikiGraphLibraryTarget, objectUri: string, options?: Parameters<typeof listWikiGraphLibraryEvidence>[2]): Promise<ArchiveEvidence>;
197
+ related(target: WikiGraphLibraryTarget, objectUri: string, options?: WikiGraphLibraryRelatedOptions): Promise<ArchiveRelatedResult>;
198
+ evidence(target: WikiGraphLibraryTarget, objectUri: string, options?: WikiGraphLibraryEvidenceOptions): Promise<ArchiveEvidence>;
183
199
  pack(target: WikiGraphLibraryTarget, objectUri: string, budget?: number): Promise<ArchivePack>;
184
200
  list(): Promise<readonly WikiGraphLibrary[]>;
185
201
  }
@@ -198,16 +214,21 @@ interface WikiGraphSDKRuntimeContext {
198
214
  readonly cwd: string;
199
215
  readonly env: NodeJS.ProcessEnv;
200
216
  readonly envPolicy: WikiGraphSDKEnvPolicy;
217
+ readonly host?: WikiGraphSDKHost;
218
+ readonly providers?: WikiGraphSDKProviders;
201
219
  readonly stateDir?: string | undefined;
202
220
  }
203
221
  declare function withWikiGraphSDKRuntimeContext<T>(context: WikiGraphSDKRuntimeContext, operation: () => Promise<T> | T): Promise<T>;
204
222
  declare function getWikiGraphSDKRuntimeContext(): WikiGraphSDKRuntimeContext;
205
223
  declare function getWikiGraphSDKStateDir(): string | undefined;
224
+ declare function getWikiGraphSDKProviders(): WikiGraphSDKProviders;
206
225
 
207
226
  interface WikiGraphSDKOptions {
208
227
  readonly cwd?: string;
209
228
  readonly env?: NodeJS.ProcessEnv;
210
229
  readonly envPolicy?: WikiGraphSDKEnvPolicy;
230
+ readonly host?: WikiGraphSDKHost;
231
+ readonly providers?: WikiGraphSDKProviders;
211
232
  readonly stateDir?: string;
212
233
  }
213
234
  declare class WikiGraphSDK implements WikiGraphJobRuntime {
@@ -227,4 +248,4 @@ declare class WikiGraphSDK implements WikiGraphJobRuntime {
227
248
  }
228
249
  declare function createWikiGraphSDK(options?: WikiGraphSDKOptions): WikiGraphSDK;
229
250
 
230
- export { LocalConfigObject, LocalConfigSection, WikiGraphArchiveManager, WikiGraphArchiveTarget, WikiGraphConfigManager, type WikiGraphContinuationContext, WikiGraphContinuationManager, type WikiGraphContinuationOptions, type WikiGraphContinuationPage, WikiGraphConversionManager, WikiGraphJobManager, WikiGraphJobRuntime, WikiGraphLibrary, type WikiGraphLibraryAddArchiveOptions, type WikiGraphLibraryArchiveSnapshot, WikiGraphLibraryManager, type WikiGraphLibraryMoveArchiveOptions, type WikiGraphLibraryPageOptions, type WikiGraphLibraryReplaceArchiveOptions, type WikiGraphLibraryScanSnapshot, type WikiGraphLibrarySearchOptions, type WikiGraphLibrarySnapshot, type WikiGraphLibraryTarget, WikiGraphMaintenanceManager, type WikiGraphProviderTestResult, WikiGraphSDK, type WikiGraphSDKEnvPolicy, type WikiGraphSDKOptions, type WikiGraphSDKRuntimeContext, createWikiGraphSDK, getWikiGraphSDKRuntimeContext, getWikiGraphSDKStateDir, withWikiGraphSDKRuntimeContext };
251
+ export { LocalConfigObject, LocalConfigSection, WikiGraphArchiveManager, WikiGraphArchiveTarget, WikiGraphConfigManager, type WikiGraphContinuationContext, WikiGraphContinuationManager, type WikiGraphContinuationOptions, type WikiGraphContinuationPage, WikiGraphConversionManager, WikiGraphJobManager, WikiGraphJobRuntime, WikiGraphLibrary, type WikiGraphLibraryAddArchiveOptions, type WikiGraphLibraryArchiveContent, type WikiGraphLibraryArchiveReadOptions, type WikiGraphLibraryArchiveSnapshot, type WikiGraphLibraryEvidenceOptions, WikiGraphLibraryManager, type WikiGraphLibraryMoveArchiveOptions, type WikiGraphLibraryPageOptions, type WikiGraphLibraryRelatedOptions, type WikiGraphLibraryReplaceArchiveOptions, type WikiGraphLibraryScanSnapshot, type WikiGraphLibrarySearchOptions, type WikiGraphLibrarySnapshot, type WikiGraphLibraryTarget, WikiGraphMaintenanceManager, type WikiGraphProviderTestResult, WikiGraphSDK, type WikiGraphSDKEnvPolicy, WikiGraphSDKHost, type WikiGraphSDKOptions, WikiGraphSDKProviders, type WikiGraphSDKRuntimeContext, createWikiGraphSDK, getWikiGraphSDKProviders, getWikiGraphSDKRuntimeContext, getWikiGraphSDKStateDir, withWikiGraphSDKRuntimeContext };