@schift-io/knowledge-scope 0.1.0

package/dist/types/evaluation.d.ts

@@ -0,0 +1,20 @@
+import { type RetrievalEvaluationReport } from "./evaluation/contracts.js";
+export { RetrievalEvaluationError, retrievalDatasetSchema, retrievalCaptureSchema, retrievalReportSchema } from "./evaluation/contracts.js";
+export type { RetrievalDataset, RetrievalCapture, RetrievalEvaluationReport } from "./evaluation/contracts.js";
+/** Fingerprints the labels as well as snapshot and per-question input identities. */
+export declare function fingerprintRetrievalDataset(value: unknown): string;
+/** Offline label matching only. Citation equality does not prove URL liveness or source truth. */
+export declare function evaluateRetrieval(value: unknown): RetrievalEvaluationReport;
+/** Right minus left; null means that metric has no labeled denominator. No winner is inferred. */
+export declare function compareRetrievalReports(leftValue: unknown, rightValue: unknown): {
+    baselineAdapter: string;
+    candidateAdapter: string;
+    datasetFingerprint: string;
+    topK: number;
+    delta: {
+        recallAtK: number | null;
+        citationMatchRate: number | null;
+        forbiddenEvidenceCount: number;
+        decisionMatchRate: number;
+    };
+};

package/dist/types/index.d.ts

@@ -0,0 +1,26 @@
+export { createKnowledgeScopeApi, createRemoteKnowledgeScopeApplication, serveKnowledgeScopeApi, KnowledgeScopeApiError, } from "./api.js";
+export type { KnowledgeScopeApplicationPort, MountApplicationRequest, RunApplicationRequest, RunBatchApplicationRequest, AdmitApplicationRequest, UnmountApplicationRequest, ServedKnowledgeScopeApi, } from "./api.js";
+export { runKnowledgeScopeCli } from "./cli.js";
+export type { CliDependencies, CliStreams, PortableAuthoringPort } from "./cli.js";
+export { createCliDependencies, main } from "./main.js";
+export { GLOBAL_MAX_RESULT_BYTES, GLOBAL_MAX_RESULT_ROWS, KnowledgeScopeApplication, MAX_BINDINGS, MAX_CANDIDATES, } from "./application.js";
+export type { KnowledgeScopeApplicationOptions, KnowledgeScopeInspection, KnowledgeScopeRunResult, MountKnowledgeScopeInput, ProviderExecutionContext, ProviderExecutionPort, } from "./application.js";
+export { createPortableLock, loadPortableScope, verifyPortableLock, } from "./portable.js";
+export type { PortableKnowledgeScope } from "./portable.js";
+export { KNOWLEDGE_SCOPE_ERROR_CODES, KnowledgeScopeProductError, } from "./errors.js";
+export type { KnowledgeScopeErrorCode } from "./errors.js";
+export { createHttpProviderExecutionPort, HttpProviderAdapterError, normalizeDefaultOpenConnectorRow, } from "./adapters/provider-port.js";
+export type { HttpProviderExecutionOptions, HttpProviderRuntimeResolver, } from "./adapters/provider-port.js";
+export { ADAPTER_FAILURE_CODES } from "./adapters/types.js";
+export type { AdapterCapability, AdapterExecutionRequest, AdapterFailure, AdapterFailureCode, AdapterResult, AdapterSourceBinding, CitationFact, HttpRequest, HttpResponseLike, HttpTransport, OpenConnectorCapability, OpenConnectorNormalizedRow, OpenConnectorRowNormalizer, OpenConnectorRuntime, ProviderResultFact, SchemaValidationResult, SchemaValidator, SchiftSearchCapability, SchiftSearchRuntime, SourceClass, } from "./adapters/types.js";
+export { KnowledgeScopeStateStore } from "./state-store.js";
+export type { KnowledgeScopeStateStoreOptions, StateStoreFaults, } from "./state-store.js";
+export { KnowledgeScopeAuthorization } from "./authorization.js";
+export type { KnowledgeScopeAuthorizationOptions } from "./authorization.js";
+export type { JsonObject, JsonPrimitive, JsonValue } from "./json.js";
+export { createKnowledgeScopeClient, KnowledgeScopeClientError } from "./client.js";
+export type { KnowledgeScopeClient } from "./client.js";
+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";

package/dist/types/json.d.ts

@@ -0,0 +1,17 @@
+export type JsonPrimitive = boolean | number | string | null;
+export type JsonValue = JsonPrimitive | readonly JsonValue[] | JsonObject;
+export type JsonObject = {
+    readonly [key: string]: JsonValue;
+};
+export declare const DEFAULT_MAX_JSON_BYTES = 1048576;
+export declare const DEFAULT_MAX_JSON_DEPTH = 16;
+export declare const DEFAULT_MAX_JSON_NODES = 100000;
+export declare const decodeUtf8Strict: (bytes: Uint8Array) => string;
+export type ParseJsonOptions = Readonly<{
+    maxBytes?: number;
+    maxDepth?: number;
+    maxNodes?: number;
+}>;
+export declare const parseJsonText: (text: string, _sourceName: string, options?: ParseJsonOptions) => JsonValue;
+export declare const canonicalJson: (value: unknown) => string;
+export declare const sha256Digest: (value: JsonValue) => Promise<string>;

package/dist/types/limits.d.ts

@@ -0,0 +1,10 @@
+export declare const MAX_BINDINGS = 64;
+export declare const MAX_CANDIDATES = 100;
+export declare const GLOBAL_MAX_RESULT_ROWS = 100;
+export declare const GLOBAL_MAX_RESULT_BYTES: number;
+/** Shared accumulator for one execution, including every operation and binding. */
+export declare class ExecutionBudget {
+    private rows;
+    private bytes;
+    consume(rows: number, bytes: number): void;
+}

package/dist/types/main.d.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+import { type ProviderExecutionPort } from "./application.js";
+import { type CliDependencies } from "./cli.js";
+export type KnowledgeScopeCliOptions = Readonly<{
+    provider?: ProviderExecutionPort;
+    home?: string;
+    environment?: Readonly<Record<string, string | undefined>>;
+}>;
+export declare const createCliDependencies: (options?: KnowledgeScopeCliOptions) => CliDependencies;
+export declare const main: (argv?: readonly string[]) => Promise<number>;

package/dist/types/onboarding-config.d.ts

@@ -0,0 +1,9 @@
+import type { JsonValue } from "./json.js";
+export type OnboardingEnvironment = Readonly<Record<string, string | undefined>>;
+export declare class OnboardingError extends Error {
+    readonly code: string;
+    readonly details: Readonly<Record<string, JsonValue>>;
+    readonly name = "OnboardingError";
+    constructor(code: string, details?: Readonly<Record<string, JsonValue>>);
+}
+export declare const searchConfiguration: (environment: OnboardingEnvironment) => readonly string[];

package/dist/types/portable.d.ts

@@ -0,0 +1,14 @@
+import { type KnowledgeScopeDefinition, type KnowledgeScopeLock } from "@schift-io/knowledge-scope/context-pack";
+import { type JsonValue } from "./json.js";
+export type PortableKnowledgeScope = Readonly<{
+    directory: string;
+    definition: KnowledgeScopeDefinition;
+    files: Readonly<Record<string, JsonValue>>;
+    lock?: KnowledgeScopeLock;
+}>;
+export type LoadPortableScopeOptions = Readonly<{
+    readLock?: boolean;
+}>;
+export declare const loadPortableScope: (directory: string, options?: LoadPortableScopeOptions) => Promise<PortableKnowledgeScope>;
+export declare const createPortableLock: (directory: string) => Promise<KnowledgeScopeLock>;
+export declare const verifyPortableLock: (directory: string) => Promise<boolean>;

package/dist/types/quickstart.d.ts

@@ -0,0 +1,10 @@
+import type { CliDependencies } from "./cli.js";
+import { type JsonValue } from "./json.js";
+import { type OnboardingEnvironment } from "./onboarding-config.js";
+export type QuickstartRequest = Readonly<{
+    directory: string;
+    index: string;
+    tenant: string;
+    query: string;
+}>;
+export declare const quickstart: (request: QuickstartRequest, dependencies: CliDependencies, environment: OnboardingEnvironment) => Promise<JsonValue>;

package/dist/types/schema-subset.d.ts

@@ -0,0 +1,9 @@
+import { type JsonValue } from "./json.js";
+export type SchemaValidationResult = Readonly<{
+    valid: true;
+}> | Readonly<{
+    valid: false;
+    path: string;
+    reason: string;
+}>;
+export declare const compileSchemaSubset: (rawSchema: unknown) => ((value: JsonValue) => SchemaValidationResult);