@schift-io/knowledge-scope 0.1.0

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

@@ -0,0 +1,297 @@
+import { z } from "zod";
+export declare const CapabilityExecutionRequestSchema: z.ZodReadonly<z.ZodObject<{
+    installationId: z.ZodBranded<z.ZodString, "InstallationId">;
+    operationId: z.ZodString;
+    effectiveScope: z.ZodReadonly<z.ZodObject<{
+        tenant: z.ZodString;
+        namespace: z.ZodOptional<z.ZodString>;
+        subject: z.ZodOptional<z.ZodString>;
+        session: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        tenant: string;
+        namespace?: string | undefined;
+        subject?: string | undefined;
+        session?: string | undefined;
+    }, {
+        tenant: string;
+        namespace?: string | undefined;
+        subject?: string | undefined;
+        session?: string | undefined;
+    }>>;
+    input: z.ZodEffects<z.ZodType<import("./canonical.js").JsonValue, z.ZodTypeDef, import("./canonical.js").JsonValue>, import("./canonical.js").JsonValue, import("./canonical.js").JsonValue>;
+    filters: z.ZodOptional<z.ZodReadonly<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodType<import("./canonical.js").JsonValue, z.ZodTypeDef, import("./canonical.js").JsonValue>, import("./canonical.js").JsonValue, import("./canonical.js").JsonValue>>>>;
+    expectedRevision: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    operationId: string;
+    installationId: string & z.BRAND<"InstallationId">;
+    effectiveScope: Readonly<{
+        tenant: string;
+        namespace?: string | undefined;
+        subject?: string | undefined;
+        session?: string | undefined;
+    }>;
+    input: import("./canonical.js").JsonValue;
+    filters?: Readonly<Record<string, import("./canonical.js").JsonValue>> | undefined;
+    expectedRevision?: number | undefined;
+}, {
+    operationId: string;
+    installationId: string;
+    effectiveScope: Readonly<{
+        tenant: string;
+        namespace?: string | undefined;
+        subject?: string | undefined;
+        session?: string | undefined;
+    }>;
+    input: import("./canonical.js").JsonValue;
+    filters?: Readonly<Record<string, import("./canonical.js").JsonValue>> | undefined;
+    expectedRevision?: number | undefined;
+}>>;
+export declare const ProviderResultSchema: z.ZodReadonly<z.ZodObject<{
+    resultId: z.ZodString;
+    srn: z.ZodOptional<z.ZodString>;
+    revision: z.ZodString;
+    freshness: z.ZodOptional<z.ZodString>;
+    payload: z.ZodEffects<z.ZodType<import("./canonical.js").JsonValue, z.ZodTypeDef, import("./canonical.js").JsonValue>, import("./canonical.js").JsonValue, import("./canonical.js").JsonValue>;
+    citation: z.ZodOptional<z.ZodReadonly<z.ZodObject<{
+        uri: z.ZodString;
+        label: z.ZodOptional<z.ZodString>;
+    }, "strict", z.ZodTypeAny, {
+        uri: string;
+        label?: string | undefined;
+    }, {
+        uri: string;
+        label?: string | undefined;
+    }>>>;
+    providerScopes: z.ZodReadonly<z.ZodEffects<z.ZodArray<z.ZodString, "many">, string[], string[]>>;
+    providerEvidence: z.ZodReadonly<z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+        kind: z.ZodLiteral<"records_operation">;
+        operationId: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "records_operation";
+        operationId: string;
+    }, {
+        kind: "records_operation";
+        operationId: string;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"open_connector_action">;
+        connectorRef: z.ZodString;
+        actionId: z.ZodString;
+        connectorRunId: z.ZodString;
+        actionCorrelationId: z.ZodString;
+        auditPersisted: z.ZodBoolean;
+    }, "strict", z.ZodTypeAny, {
+        kind: "open_connector_action";
+        actionId: string;
+        connectorRef: string;
+        connectorRunId: string;
+        actionCorrelationId: string;
+        auditPersisted: boolean;
+    }, {
+        kind: "open_connector_action";
+        actionId: string;
+        connectorRef: string;
+        connectorRunId: string;
+        actionCorrelationId: string;
+        auditPersisted: boolean;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"schift_search">;
+        indexRef: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        kind: "schift_search";
+        indexRef: string;
+    }, {
+        kind: "schift_search";
+        indexRef: string;
+    }>, z.ZodObject<{
+        kind: z.ZodLiteral<"web_search">;
+        provider: z.ZodEnum<["customer", "schift"]>;
+    }, "strict", z.ZodTypeAny, {
+        kind: "web_search";
+        provider: "customer" | "schift";
+    }, {
+        kind: "web_search";
+        provider: "customer" | "schift";
+    }>]>>;
+}, "strict", z.ZodTypeAny, {
+    revision: string;
+    providerScopes: readonly string[];
+    providerEvidence: Readonly<{
+        kind: "records_operation";
+        operationId: string;
+    }> | Readonly<{
+        kind: "open_connector_action";
+        actionId: string;
+        connectorRef: string;
+        connectorRunId: string;
+        actionCorrelationId: string;
+        auditPersisted: boolean;
+    }> | Readonly<{
+        kind: "schift_search";
+        indexRef: string;
+    }> | Readonly<{
+        kind: "web_search";
+        provider: "customer" | "schift";
+    }>;
+    payload: import("./canonical.js").JsonValue;
+    resultId: string;
+    freshness?: string | undefined;
+    srn?: string | undefined;
+    citation?: Readonly<{
+        uri: string;
+        label?: string | undefined;
+    }> | undefined;
+}, {
+    revision: string;
+    providerScopes: readonly string[];
+    providerEvidence: Readonly<{
+        kind: "records_operation";
+        operationId: string;
+    }> | Readonly<{
+        kind: "open_connector_action";
+        actionId: string;
+        connectorRef: string;
+        connectorRunId: string;
+        actionCorrelationId: string;
+        auditPersisted: boolean;
+    }> | Readonly<{
+        kind: "schift_search";
+        indexRef: string;
+    }> | Readonly<{
+        kind: "web_search";
+        provider: "customer" | "schift";
+    }>;
+    payload: import("./canonical.js").JsonValue;
+    resultId: string;
+    freshness?: string | undefined;
+    srn?: string | undefined;
+    citation?: Readonly<{
+        uri: string;
+        label?: string | undefined;
+    }> | undefined;
+}>>;
+declare const AdmissionReasonSchema: z.ZodEnum<["installation_not_mounted", "installation_id_mismatch", "definition_digest_mismatch", "mount_revision_mismatch", "authorization_decision_untrusted", "scope_authority_mismatch", "effective_scope_invalid", "source_binding_not_found", "source_class_mismatch", "provider_ref_mismatch", "operation_not_bound", "capability_not_found", "permission_mode_unsupported", "permission_mode_mismatch", "source_authority_not_allowed", "must_not_use", "context_policy_no_match", "provider_scopes_missing", "provider_evidence_mismatch", "connector_ref_mismatch", "connector_action_mismatch", "connector_run_missing", "connector_audit_missing", "citation_required", "freshness_required", "freshness_in_future", "source_stale"]>;
+export declare const CandidateAdmissionReceiptSchema: z.ZodReadonly<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+    status: z.ZodLiteral<"accepted">;
+    candidateSrn: z.ZodString;
+    matchedPolicy: z.ZodEnum<["mustConsider", "mayConsider"]>;
+    matchedRuleIds: z.ZodReadonly<z.ZodArray<z.ZodString, "many">>;
+    authorityRank: z.ZodNumber;
+}, "strict", z.ZodTypeAny, {
+    status: "accepted";
+    candidateSrn: string;
+    matchedPolicy: "mustConsider" | "mayConsider";
+    matchedRuleIds: readonly string[];
+    authorityRank: number;
+}, {
+    status: "accepted";
+    candidateSrn: string;
+    matchedPolicy: "mustConsider" | "mayConsider";
+    matchedRuleIds: readonly string[];
+    authorityRank: number;
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"denied">;
+    candidateSrn: z.ZodString;
+    reasonCode: z.ZodEnum<["installation_not_mounted", "installation_id_mismatch", "definition_digest_mismatch", "mount_revision_mismatch", "authorization_decision_untrusted", "scope_authority_mismatch", "effective_scope_invalid", "source_binding_not_found", "source_class_mismatch", "provider_ref_mismatch", "operation_not_bound", "capability_not_found", "permission_mode_unsupported", "permission_mode_mismatch", "source_authority_not_allowed", "must_not_use", "context_policy_no_match", "provider_scopes_missing", "provider_evidence_mismatch", "connector_ref_mismatch", "connector_action_mismatch", "connector_run_missing", "connector_audit_missing", "citation_required", "freshness_required", "freshness_in_future", "source_stale"]>;
+}, "strict", z.ZodTypeAny, {
+    status: "denied";
+    candidateSrn: string;
+    reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+}, {
+    status: "denied";
+    candidateSrn: string;
+    reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+}>]>>;
+export declare const ScopeRequirementReceiptSchema: z.ZodReadonly<z.ZodObject<{
+    status: z.ZodEnum<["ready", "insufficient_evidence"]>;
+    requirements: z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodObject<{
+        requirementId: z.ZodString;
+        requiredEvidence: z.ZodNumber;
+        observedEvidence: z.ZodNumber;
+        satisfied: z.ZodBoolean;
+    }, "strict", z.ZodTypeAny, {
+        requirementId: string;
+        requiredEvidence: number;
+        observedEvidence: number;
+        satisfied: boolean;
+    }, {
+        requirementId: string;
+        requiredEvidence: number;
+        observedEvidence: number;
+        satisfied: boolean;
+    }>>, "many">>;
+    candidateReceipts: z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+        status: z.ZodLiteral<"accepted">;
+        candidateSrn: z.ZodString;
+        matchedPolicy: z.ZodEnum<["mustConsider", "mayConsider"]>;
+        matchedRuleIds: z.ZodReadonly<z.ZodArray<z.ZodString, "many">>;
+        authorityRank: z.ZodNumber;
+    }, "strict", z.ZodTypeAny, {
+        status: "accepted";
+        candidateSrn: string;
+        matchedPolicy: "mustConsider" | "mayConsider";
+        matchedRuleIds: readonly string[];
+        authorityRank: number;
+    }, {
+        status: "accepted";
+        candidateSrn: string;
+        matchedPolicy: "mustConsider" | "mayConsider";
+        matchedRuleIds: readonly string[];
+        authorityRank: number;
+    }>, z.ZodObject<{
+        status: z.ZodLiteral<"denied">;
+        candidateSrn: z.ZodString;
+        reasonCode: z.ZodEnum<["installation_not_mounted", "installation_id_mismatch", "definition_digest_mismatch", "mount_revision_mismatch", "authorization_decision_untrusted", "scope_authority_mismatch", "effective_scope_invalid", "source_binding_not_found", "source_class_mismatch", "provider_ref_mismatch", "operation_not_bound", "capability_not_found", "permission_mode_unsupported", "permission_mode_mismatch", "source_authority_not_allowed", "must_not_use", "context_policy_no_match", "provider_scopes_missing", "provider_evidence_mismatch", "connector_ref_mismatch", "connector_action_mismatch", "connector_run_missing", "connector_audit_missing", "citation_required", "freshness_required", "freshness_in_future", "source_stale"]>;
+    }, "strict", z.ZodTypeAny, {
+        status: "denied";
+        candidateSrn: string;
+        reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+    }, {
+        status: "denied";
+        candidateSrn: string;
+        reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+    }>]>>, "many">>;
+}, "strict", z.ZodTypeAny, {
+    status: "ready" | "insufficient_evidence";
+    requirements: readonly Readonly<{
+        requirementId: string;
+        requiredEvidence: number;
+        observedEvidence: number;
+        satisfied: boolean;
+    }>[];
+    candidateReceipts: readonly (Readonly<{
+        status: "accepted";
+        candidateSrn: string;
+        matchedPolicy: "mustConsider" | "mayConsider";
+        matchedRuleIds: readonly string[];
+        authorityRank: number;
+    }> | Readonly<{
+        status: "denied";
+        candidateSrn: string;
+        reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+    }>)[];
+}, {
+    status: "ready" | "insufficient_evidence";
+    requirements: readonly Readonly<{
+        requirementId: string;
+        requiredEvidence: number;
+        observedEvidence: number;
+        satisfied: boolean;
+    }>[];
+    candidateReceipts: readonly (Readonly<{
+        status: "accepted";
+        candidateSrn: string;
+        matchedPolicy: "mustConsider" | "mayConsider";
+        matchedRuleIds: readonly string[];
+        authorityRank: number;
+    }> | Readonly<{
+        status: "denied";
+        candidateSrn: string;
+        reasonCode: "installation_not_mounted" | "installation_id_mismatch" | "definition_digest_mismatch" | "mount_revision_mismatch" | "authorization_decision_untrusted" | "scope_authority_mismatch" | "effective_scope_invalid" | "source_binding_not_found" | "source_class_mismatch" | "provider_ref_mismatch" | "operation_not_bound" | "capability_not_found" | "permission_mode_unsupported" | "permission_mode_mismatch" | "source_authority_not_allowed" | "must_not_use" | "context_policy_no_match" | "provider_scopes_missing" | "provider_evidence_mismatch" | "connector_ref_mismatch" | "connector_action_mismatch" | "connector_run_missing" | "connector_audit_missing" | "citation_required" | "freshness_required" | "freshness_in_future" | "source_stale";
+    }>)[];
+}>>;
+export type CapabilityExecutionRequest = z.infer<typeof CapabilityExecutionRequestSchema>;
+export type ProviderResult = z.infer<typeof ProviderResultSchema>;
+export type CandidateAdmissionReceipt = z.infer<typeof CandidateAdmissionReceiptSchema>;
+export type ScopeRequirementReceipt = z.infer<typeof ScopeRequirementReceiptSchema>;
+export type AdmissionDenialReason = z.infer<typeof AdmissionReasonSchema>;
+export {};

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

@@ -0,0 +1,71 @@
+import { z } from "zod";
+import type { JsonValue } from "./canonical.js";
+import type { KnowledgeScopeDefinition } from "./knowledge-scope.js";
+import type { Sha256Digest } from "./scalars.js";
+export declare const KnowledgeScopeLockSchema: z.ZodReadonly<z.ZodEffects<z.ZodObject<{
+    schemaVersion: z.ZodLiteral<"knowledge-scope-lock.schift.dev/v0.1">;
+    packId: z.ZodBranded<z.ZodString, "PackId">;
+    version: z.ZodBranded<z.ZodString, "SemanticVersion">;
+    definitionDigest: z.ZodBranded<z.ZodString, "Sha256Digest">;
+    files: z.ZodReadonly<z.ZodArray<z.ZodReadonly<z.ZodObject<{
+        path: z.ZodEffects<z.ZodString, string, string>;
+        digest: z.ZodBranded<z.ZodString, "Sha256Digest">;
+    }, "strict", z.ZodTypeAny, {
+        path: string;
+        digest: string & z.BRAND<"Sha256Digest">;
+    }, {
+        path: string;
+        digest: string;
+    }>>, "many">>;
+} & {
+    lockDigest: z.ZodBranded<z.ZodString, "Sha256Digest">;
+}, "strict", z.ZodTypeAny, {
+    packId: string & z.BRAND<"PackId">;
+    version: string & z.BRAND<"SemanticVersion">;
+    definitionDigest: string & z.BRAND<"Sha256Digest">;
+    schemaVersion: "knowledge-scope-lock.schift.dev/v0.1";
+    files: readonly Readonly<{
+        path: string;
+        digest: string & z.BRAND<"Sha256Digest">;
+    }>[];
+    lockDigest: string & z.BRAND<"Sha256Digest">;
+}, {
+    packId: string;
+    version: string;
+    definitionDigest: string;
+    schemaVersion: "knowledge-scope-lock.schift.dev/v0.1";
+    files: readonly Readonly<{
+        path: string;
+        digest: string;
+    }>[];
+    lockDigest: string;
+}>, {
+    packId: string & z.BRAND<"PackId">;
+    version: string & z.BRAND<"SemanticVersion">;
+    definitionDigest: string & z.BRAND<"Sha256Digest">;
+    schemaVersion: "knowledge-scope-lock.schift.dev/v0.1";
+    files: readonly Readonly<{
+        path: string;
+        digest: string & z.BRAND<"Sha256Digest">;
+    }>[];
+    lockDigest: string & z.BRAND<"Sha256Digest">;
+}, {
+    packId: string;
+    version: string;
+    definitionDigest: string;
+    schemaVersion: "knowledge-scope-lock.schift.dev/v0.1";
+    files: readonly Readonly<{
+        path: string;
+        digest: string;
+    }>[];
+    lockDigest: string;
+}>>;
+export type KnowledgeScopeLock = z.infer<typeof KnowledgeScopeLockSchema>;
+export type KnowledgeScopeFileValues = Readonly<Record<string, JsonValue>>;
+export declare class KnowledgeScopeLockError extends Error {
+    readonly code: "invalid_file_inventory" | "definition_file_mismatch" | "non_portable_number";
+    constructor(code: KnowledgeScopeLockError["code"], message: string);
+}
+export declare const digestKnowledgeScopeDefinition: (definition: KnowledgeScopeDefinition) => Promise<Sha256Digest>;
+export declare const buildKnowledgeScopeLock: (definition: KnowledgeScopeDefinition, files: KnowledgeScopeFileValues) => Promise<KnowledgeScopeLock>;
+export declare const verifyKnowledgeScopeLock: (definition: KnowledgeScopeDefinition, files: KnowledgeScopeFileValues, lock: KnowledgeScopeLock) => Promise<boolean>;