@schift-io/knowledge-scope 0.1.0 → 0.2.0

package/dist/types/authorization.d.ts

@@ -90,6 +90,15 @@ export declare const AuthorizationSubjectSchema: import("zod").ZodReadonly<impor
     }, {
         kind: "schift_search";
         indexRef: string;
+    }>, import("zod").ZodObject<{
+        kind: import("zod").ZodLiteral<"local_documents">;
+        indexRef: import("zod").ZodString;
+    }, "strict", import("zod").ZodTypeAny, {
+        kind: "local_documents";
+        indexRef: string;
+    }, {
+        kind: "local_documents";
+        indexRef: string;
     }>, import("zod").ZodObject<{
         kind: import("zod").ZodLiteral<"web_search">;
         provider: import("zod").ZodEnum<["customer", "schift"]>;
@@ -148,6 +157,9 @@ export declare const AuthorizationSubjectSchema: import("zod").ZodReadonly<impor
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";
@@ -194,6 +206,9 @@ export declare const AuthorizationSubjectSchema: import("zod").ZodReadonly<impor
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";

package/dist/types/cli.d.ts

@@ -1,5 +1,6 @@
 import { type KnowledgeScopeApplicationPort, type MountApplicationRequest, type ServedKnowledgeScopeApi } from "./api.js";
 import { type JsonValue } from "./json.js";
+import { type LocalDocumentImportPort } from "./local-quickstart.js";
 import { type OnboardingEnvironment } from "./onboarding-config.js";
 export type PortableAuthoringPort = Readonly<{
     validate: (directory: string) => Promise<JsonValue>;
@@ -8,6 +9,7 @@ export type PortableAuthoringPort = Readonly<{
 }>;
 export type CliDependencies = Readonly<{
     environment?: OnboardingEnvironment;
+    localDocuments?: LocalDocumentImportPort;
     authoring: PortableAuthoringPort;
     embedded: KnowledgeScopeApplicationPort;
     remote: (apiUrl: string) => KnowledgeScopeApplicationPort;

package/dist/types/context-pack/knowledge-scope-execution.d.ts

@@ -102,6 +102,15 @@ export declare const ProviderResultSchema: z.ZodReadonly<z.ZodObject<{
     }, {
         kind: "schift_search";
         indexRef: string;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"local_documents">;
+        indexRef: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "local_documents";
+        indexRef: string;
+    }, {
+        kind: "local_documents";
+        indexRef: string;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"web_search">;
         provider: z.ZodEnum<["customer", "schift"]>;
@@ -128,6 +137,9 @@ export declare const ProviderResultSchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";
@@ -156,6 +168,9 @@ export declare const ProviderResultSchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";

package/dist/types/context-pack/knowledge-scope-mount.d.ts

@@ -167,6 +167,15 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }, {
             kind: "schift_search";
             indexRef: string;
+        }>, z.ZodObject<{
+            kind: z.ZodLiteral<"local_documents">;
+            indexRef: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            kind: "local_documents";
+            indexRef: string;
+        }, {
+            kind: "local_documents";
+            indexRef: string;
         }>, z.ZodObject<{
             kind: z.ZodLiteral<"web_search">;
             provider: z.ZodEnum<["customer", "schift"]>;
@@ -216,6 +225,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -243,6 +255,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -697,6 +712,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -799,6 +817,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -901,6 +922,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1003,6 +1027,9 @@ export declare const KnowledgeScopePackSchema: z.ZodReadonly<z.ZodEffects<z.ZodO
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";

package/dist/types/context-pack/knowledge-scope.d.ts

@@ -31,6 +31,15 @@ export declare const QueryProviderSchema: z.ZodReadonly<z.ZodDiscriminatedUnion<
 }, {
     kind: "schift_search";
     indexRef: string;
+}>, z.ZodObject<{
+    kind: z.ZodLiteral<"local_documents">;
+    indexRef: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    kind: "local_documents";
+    indexRef: string;
+}, {
+    kind: "local_documents";
+    indexRef: string;
 }>, z.ZodObject<{
     kind: z.ZodLiteral<"web_search">;
     provider: z.ZodEnum<["customer", "schift"]>;
@@ -73,6 +82,15 @@ export declare const QueryCapabilitySchema: z.ZodReadonly<z.ZodObject<{
     }, {
         kind: "schift_search";
         indexRef: string;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"local_documents">;
+        indexRef: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "local_documents";
+        indexRef: string;
+    }, {
+        kind: "local_documents";
+        indexRef: string;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"web_search">;
         provider: z.ZodEnum<["customer", "schift"]>;
@@ -122,6 +140,9 @@ export declare const QueryCapabilitySchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";
@@ -149,6 +170,9 @@ export declare const QueryCapabilitySchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";
@@ -211,6 +235,15 @@ export declare const KnowledgeScopeDefinitionBaseSchema: z.ZodObject<{
         }, {
             kind: "schift_search";
             indexRef: string;
+        }>, z.ZodObject<{
+            kind: z.ZodLiteral<"local_documents">;
+            indexRef: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            kind: "local_documents";
+            indexRef: string;
+        }, {
+            kind: "local_documents";
+            indexRef: string;
         }>, z.ZodObject<{
             kind: z.ZodLiteral<"web_search">;
             provider: z.ZodEnum<["customer", "schift"]>;
@@ -260,6 +293,9 @@ export declare const KnowledgeScopeDefinitionBaseSchema: z.ZodObject<{
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -287,6 +323,9 @@ export declare const KnowledgeScopeDefinitionBaseSchema: z.ZodObject<{
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -644,6 +683,9 @@ export declare const KnowledgeScopeDefinitionBaseSchema: z.ZodObject<{
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -725,6 +767,9 @@ export declare const KnowledgeScopeDefinitionBaseSchema: z.ZodObject<{
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -833,6 +878,15 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }, {
             kind: "schift_search";
             indexRef: string;
+        }>, z.ZodObject<{
+            kind: z.ZodLiteral<"local_documents">;
+            indexRef: z.ZodString;
+        }, "strict", z.ZodTypeAny, {
+            kind: "local_documents";
+            indexRef: string;
+        }, {
+            kind: "local_documents";
+            indexRef: string;
         }>, z.ZodObject<{
             kind: z.ZodLiteral<"web_search">;
             provider: z.ZodEnum<["customer", "schift"]>;
@@ -882,6 +936,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -909,6 +966,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1266,6 +1326,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1347,6 +1410,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1428,6 +1494,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1509,6 +1578,9 @@ export declare const KnowledgeScopeDefinitionSchema: z.ZodReadonly<z.ZodEffects<
         }> | Readonly<{
             kind: "schift_search";
             indexRef: string;
+        }> | Readonly<{
+            kind: "local_documents";
+            indexRef: string;
         }> | Readonly<{
             kind: "web_search";
             provider: "customer" | "schift";
@@ -1711,6 +1783,15 @@ export declare const CandidateEnvelopeSchema: z.ZodReadonly<z.ZodObject<{
     }, {
         kind: "schift_search";
         indexRef: string;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"local_documents">;
+        indexRef: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "local_documents";
+        indexRef: string;
+    }, {
+        kind: "local_documents";
+        indexRef: string;
     }>, z.ZodObject<{
         kind: z.ZodLiteral<"web_search">;
         provider: z.ZodEnum<["customer", "schift"]>;
@@ -1767,6 +1848,9 @@ export declare const CandidateEnvelopeSchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";
@@ -1818,6 +1902,9 @@ export declare const CandidateEnvelopeSchema: z.ZodReadonly<z.ZodObject<{
     }> | Readonly<{
         kind: "schift_search";
         indexRef: string;
+    }> | Readonly<{
+        kind: "local_documents";
+        indexRef: string;
     }> | Readonly<{
         kind: "web_search";
         provider: "customer" | "schift";

package/dist/types/index.d.ts

@@ -24,3 +24,4 @@ export type { RecordsOperationExecutor } from "./adapters/provider-port.js";
 export type { OpenConnectorInputMapper, TrustedEffectiveScope } from "./adapters/types.js";
 export { evaluateRetrieval, compareRetrievalReports, fingerprintRetrievalDataset, RetrievalEvaluationError } from "./evaluation.js";
 export type { RetrievalDataset, RetrievalCapture, RetrievalEvaluationReport } from "./evaluation.js";
+export { LocalDocumentStore, LocalDocumentError, LOCAL_LIMITS } from "./local-documents/index.js";

package/dist/types/local-documents/files.d.ts

@@ -0,0 +1,32 @@
+import { type Stats } from "node:fs";
+export declare class LocalDocumentError extends Error {
+    readonly code: "local_source_invalid" | "local_limit_exceeded" | "local_snapshot_invalid" | "local_scope_invalid";
+    readonly name = "LocalDocumentError";
+    constructor(code: "local_source_invalid" | "local_limit_exceeded" | "local_snapshot_invalid" | "local_scope_invalid");
+}
+export declare const LOCAL_LIMITS: {
+    readonly files: 100;
+    readonly fileBytes: 1048576;
+    readonly totalBytes: 8388608;
+    readonly snapshotBytes: 16777216;
+    readonly chunks: 4000;
+    readonly entries: 2000;
+    readonly depth: 16;
+    readonly chunkCharacters: 2000;
+};
+type FileIdentity = Readonly<Pick<Stats, "dev" | "ino" | "size" | "mtimeMs" | "ctimeMs" | "nlink">>;
+type DirectoryIdentity = Readonly<{
+    path: string;
+    dev: number;
+    ino: number;
+}>;
+export type CollectedFile = Readonly<{
+    path: string;
+    root: string;
+    identity: FileIdentity;
+    ancestors: readonly DirectoryIdentity[];
+}>;
+export declare const mapLocalFileError: (error: unknown, ownerOnly: boolean) => never;
+export declare const readBounded: (source: string | CollectedFile, maxBytes: number, ownerOnly?: boolean) => Promise<string>;
+export declare const collectFiles: (source: string) => Promise<readonly CollectedFile[]>;
+export {};

package/dist/types/local-documents/index.d.ts

@@ -0,0 +1,17 @@
+import { type ProviderResult } from "@schift-io/knowledge-scope/context-pack";
+import type { ProviderExecutionContext } from "../application-execution.js";
+import type { KnowledgeScopeStateStoreOptions } from "../state-store.js";
+export { LocalDocumentError, LOCAL_LIMITS } from "./files.js";
+/** Private snapshots belong to the local filesystem owner, not a multi-user ACL service. */
+export declare class LocalDocumentStore {
+    readonly home: string;
+    constructor(options?: KnowledgeScopeStateStoreOptions);
+    private directory;
+    ingest(sourcePath: string): Promise<Readonly<{
+        indexRef: string;
+        documentCount: number;
+        chunkCount: number;
+    }>>;
+    private read;
+    execute(context: ProviderExecutionContext): Promise<readonly ProviderResult[]>;
+}

package/dist/types/local-documents/snapshot.d.ts

@@ -0,0 +1,47 @@
+import { z } from "zod";
+export declare const SnapshotSchema: z.ZodReadonly<z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    capturedAt: z.ZodString;
+    documents: z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodObject<{
+        uri: z.ZodString;
+        text: z.ZodString;
+        revision: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        revision: string;
+        uri: string;
+        text: string;
+    }, {
+        revision: string;
+        uri: string;
+        text: string;
+    }>>, "many">>;
+}, "strict", z.ZodTypeAny, {
+    version: 1;
+    capturedAt: string;
+    documents: readonly Readonly<{
+        revision: string;
+        uri: string;
+        text: string;
+    }>[];
+}, {
+    version: 1;
+    capturedAt: string;
+    documents: readonly Readonly<{
+        revision: string;
+        uri: string;
+        text: string;
+    }>[];
+}>>;
+export type Snapshot = z.infer<typeof SnapshotSchema>;
+export type Chunk = Readonly<{
+    document: Snapshot["documents"][number];
+    text: string;
+    lineStart: number;
+    lineEnd: number;
+    id: string;
+}>;
+export declare const digest: (value: string) => string;
+export declare const snapshotId: (snapshot: Snapshot) => string;
+export declare const buildSnapshot: (source: string) => Promise<Snapshot>;
+export declare const chunksFor: (snapshot: Snapshot) => readonly Chunk[];
+export declare const lexicalTerms: (text: string) => readonly string[];

package/dist/types/local-query.d.ts

@@ -0,0 +1,6 @@
+import type { KnowledgeScopeApplicationPort } from "./api.js";
+import type { JsonValue } from "./json.js";
+export declare const queryProject: (request: Readonly<{
+    installationId: string;
+    query: string;
+}>, application: KnowledgeScopeApplicationPort) => Promise<JsonValue>;

package/dist/types/local-quickstart.d.ts

@@ -0,0 +1,15 @@
+import type { CliDependencies } from "./cli.js";
+import { type JsonValue } from "./json.js";
+export type LocalDocumentImportPort = Readonly<{
+    ingest: (sourcePath: string) => Promise<Readonly<{
+        indexRef: string;
+        documentCount: number;
+        chunkCount: number;
+    }>>;
+}>;
+export declare const localQuickstart: (request: Readonly<{
+    directory: string;
+    source: string;
+    tenant: string;
+    query: string;
+}>, dependencies: CliDependencies) => Promise<JsonValue>;