@dsh-libing/knowledge-base 0.1.0

package/lib/contract.js

@@ -0,0 +1,18 @@
+/** JSON responses shared with the browser; imports stay free of Host and filesystem modules. */
+import { z } from 'zod';
+import { jobSchema, registrySchema, librarySchema, publishedDocumentSchema, reportSchema } from "./data.js";
+export const publicJobSchema = jobSchema.omit({ schema: true, overlays: true }).extend({ outputPath: z.string().nullable(), reused: z.boolean().optional() });
+export const locationSchema = z.object({ kbPath: z.string(), revision: z.string().nullable(), wikiPath: z.string().nullable(), indexPath: z.string().nullable() });
+export const libraryViewSchema = librarySchema.extend({ location: locationSchema, summary: z.object({ revision: z.string().nullable(), documentCount: z.number(), chunkCount: z.number(), coverageIncomplete: z.boolean() }) });
+export const stateSchema = z.object({ hostVersion: z.string(), kbs: z.array(libraryViewSchema), deletedKbs: z.array(librarySchema), activities: registrySchema.shape.activities, jobs: z.array(publicJobSchema), dataRoot: z.string(), config: z.object({ chunkTargetChars: z.number(), visionProvider: z.string(), visionModel: z.string(), maxInputBytes: z.number() }) });
+export const treeDocumentSchema = publishedDocumentSchema.extend({ chunks: z.array(publishedDocumentSchema.shape.chunks.element.omit({ segments: true, anchors: true })), figures: z.array(publishedDocumentSchema.shape.figures.element.extend({ expectedHash: z.string().optional() })) });
+export const treeSchema = z.object({ kbId: z.string(), revision: z.string(), location: locationSchema.optional(), previewJobId: z.string().optional(), coverageIncomplete: z.boolean(), report: reportSchema, documents: z.array(treeDocumentSchema) });
+export const readSchema = z.object({ kbId: z.string(), chunkId: z.string(), revision: z.string(), text: z.string(), complete: z.boolean(), truncated: z.boolean().optional(), previewJobId: z.string().optional(),
+    continuation: z.object({ segmentIndex: z.number(), offset: z.number() }).nullable(), assetRefs: z.array(z.string()), relatedChunks: z.array(z.string()), warnings: z.array(z.string()),
+    source: z.object({ docId: z.string(), title: z.string(), sourceVersion: z.string(), sourceHash: z.string(), revision: z.string(), headingPath: z.array(z.string()), path: z.string(), contentHash: z.string(),
+        sourceFormat: z.literal('pdf').optional(), pageCount: z.number().optional(), selectedPages: publishedDocumentSchema.shape.selectedPages, pageRange: z.array(z.number()).optional(), scope: z.string().optional(), locations: z.array(z.object({ page: z.number(), pageLabel: z.string().nullable().optional(), method: z.string(), bbox: z.array(z.number()).nullable(), caption: z.string().optional() })).optional(), locationsTruncated: z.boolean().optional() }) });
+export const searchResultSchema = z.object({ kbId: z.string(), revision: z.string(), query: z.string(), totalCandidates: z.number(), truncated: z.boolean(), candidates: z.array(z.object({ chunkId: z.string(), title: z.string(), summary: z.string(), fullChars: z.number(), reviewStatus: z.string() })), evidence: z.array(z.unknown()), warnings: z.array(z.object({ docId: z.string().optional(), chunkId: z.string().optional(), kind: z.string().optional(), message: z.string() })) });
+export const modelsSchema = z.object({ providers: z.array(z.object({ id: z.string(), name: z.string(), models: z.array(z.object({ id: z.string(), name: z.string(), inputModalities: z.array(z.string()).optional() })), error: z.string().optional() })) });
+export const schemaResultSchema = z.object({ content: z.string(), hash: z.string() });
+export const inspectSchema = z.object({ sourceFormat: z.literal('pdf'), pageCount: z.number(), outlineCount: z.number(), samples: z.array(z.object({ page: z.number(), chars: z.number(), hasGraphics: z.boolean(), possibleOcr: z.boolean(), hasStructure: z.boolean() })), possibleOcr: z.boolean(), note: z.string() });
+export const uploadResultSchema = z.object({ receiptId: z.string(), filename: z.string(), bytes: z.number() });