openplanr 1.25.3 → 2.0.0

package/dist/services/connectors/connector-runtime.d.ts

@@ -0,0 +1,200 @@
+import type { LiveEvidenceSubmissionPreparationV2, LiveEvidenceSubmissionResultV2, OperateActorV2 } from '../operate/client.js';
+import type { ConnectorCheckpointCustodyV2 } from './checkpoint-custody.js';
+import type { ConnectorBoundsV2, ConnectorClassificationV2, ConnectorHealthProofV2, ConnectorRegistryV2, ConnectorSourceContractV2 } from './connector-registry.js';
+import type { ConnectorCredentialCustodyV2 } from './credential-custody.js';
+type JsonRecord = Readonly<Record<string, unknown>>;
+type Hash = `sha256:${string}`;
+declare const RESULT_EFFECTS: readonly ["provider-call", "operate-assignment-submit", "evidence-materialization"];
+export type ConnectorRuntimeOperationV2 = 'evidence.providers' | 'evidence.preview' | 'evidence.collect' | 'evidence.status';
+export type ConnectorRuntimeEffectV2 = Readonly<{
+    id: (typeof RESULT_EFFECTS)[number];
+    executed: boolean;
+}>;
+export type ConnectorRuntimeResultV2 = Readonly<{
+    ok: boolean;
+    operation: ConnectorRuntimeOperationV2;
+    effects: readonly ConnectorRuntimeEffectV2[];
+    authorityRequired: boolean;
+    ownerActionRequired: boolean;
+    nextAction: string;
+    data?: JsonRecord;
+    error?: Readonly<{
+        code: string;
+        problem: string;
+    }>;
+}>;
+export type ConnectorEvidenceRequestV2 = Readonly<{
+    kind: 'openplanr-live-evidence-request';
+    schemaVersion: '1.0.0';
+    assignmentId: string;
+    submissionId: string;
+    actor: OperateActorV2;
+    ownerActorId: string;
+    provider: Readonly<{
+        id: string;
+        version: string;
+    }>;
+    adapterVersion: string;
+    operation: string;
+    sourceContract: ConnectorSourceContractV2;
+    scope: Readonly<{
+        scopeId: string;
+        domainId: string;
+        domainVersion: string;
+    }>;
+    logicalCredentialRef: string;
+    consentRecordId: string;
+    accountIdentityHash: Hash;
+    selectors: readonly string[];
+    scopes: readonly string[];
+    queryHash: Hash;
+    window: Readonly<{
+        from: string;
+        to: string;
+    }>;
+    bounds: ConnectorBoundsV2;
+    classification: ConnectorClassificationV2;
+    sensitivity: ConnectorClassificationV2;
+    purpose: string;
+    consentExpiresAt: string;
+    claim: Readonly<{
+        localClaimId: string;
+        relation: 'supportedBy' | 'contradictedBy';
+        confidence: number;
+    }>;
+}>;
+export type ConnectorProtocolDocketV2 = Readonly<{
+    provider: Readonly<{
+        id: string;
+        version: string;
+    }>;
+    adapterVersion: string;
+    accountIdentityHash: Hash;
+    selectors: readonly string[];
+    effect: 'provider-call';
+    scopes: readonly string[];
+    queryHash: Hash;
+    window: Readonly<{
+        from: string;
+        to: string;
+    }>;
+    ceilings: ConnectorBoundsV2;
+    classification: ConnectorClassificationV2;
+    sensitivity: ConnectorClassificationV2;
+    purpose: string;
+    expiresAt: string;
+    changedRecordDiffHash: Hash | null;
+    consequences: readonly string[];
+    authorityBoundary: 'consent-is-not-access-authority';
+    choices: readonly ['approve', 'cancel'];
+    defaultChoice: null;
+    cancelEffect: 'none';
+}>;
+export type ConnectorProviderCallResultV2 = Readonly<{
+    status: 'materialized' | 'absent' | 'uncertain';
+    requestedAt: string;
+    capturedAt: string;
+    freshUntil: string;
+    health: ConnectorHealthProofV2;
+    payload: unknown;
+    absence?: Readonly<{
+        kind: 'missing-consent' | 'missing-credential' | 'stale' | 'unhealthy' | 'provider-unavailable' | 'rate-limited' | 'insufficient-evidence' | 'unsupported';
+        reasonCode: string;
+        required: boolean;
+        observedAt: string;
+        details: unknown;
+    }>;
+    providerCursor?: Uint8Array;
+}>;
+export type ConnectorProviderTransportV2 = Readonly<{
+    health(input: Readonly<{
+        request: ConnectorEvidenceRequestV2;
+        registration: JsonRecord;
+    }>): ConnectorHealthProofV2;
+    execute(input: Readonly<{
+        request: ConnectorEvidenceRequestV2;
+        registration: JsonRecord;
+        collection: string;
+        credential: Uint8Array;
+        expectedHealth: ConnectorHealthProofV2;
+    }>): Promise<ConnectorProviderCallResultV2>;
+}>;
+export type ConnectorRuntimeContractsV2 = Readonly<{
+    assertOperatingLiveEvidenceConsentRecordV2(record: unknown): JsonRecord;
+    assertOperatingConnectorCheckpointV2(record: unknown): JsonRecord;
+    assertOperatingLiveEvidenceIngestionV2(record: unknown, options?: JsonRecord): JsonRecord;
+    deriveOperatingLiveEvidenceRequestHashV2(input: JsonRecord): Hash;
+    deriveOperatingLiveEvidenceContentDigestV2(record: JsonRecord): Hash;
+    reduceOperatingConnectorCheckpointV2(current: unknown, event: unknown): JsonRecord;
+}>;
+export type ConnectorOperateBridgeV2 = Readonly<{
+    prepareLiveEvidenceSubmission(input: Readonly<{
+        assignmentId: string;
+        submissionId: string;
+        actor: OperateActorV2;
+    }>): Promise<LiveEvidenceSubmissionPreparationV2>;
+    acceptLiveEvidenceSubmission(input: Readonly<{
+        assignmentId: string;
+        submissionId: string;
+        actor: OperateActorV2;
+        preparationHash: string;
+        contentBase64: string;
+        custody: Readonly<{
+            issuedAssignment: JsonRecord;
+            liveProviderRegistration: JsonRecord;
+            baseEvidenceProvider: JsonRecord;
+            baseResolver: JsonRecord;
+            consentRecord: JsonRecord;
+            connectorCheckpoint: JsonRecord;
+            resultCheckpoint: JsonRecord;
+            checkpointHistory?: readonly JsonRecord[];
+        }>;
+    }>): Promise<LiveEvidenceSubmissionResultV2>;
+}>;
+export type ConnectorEvidenceRegistryV2 = Readonly<{
+    providers: readonly JsonRecord[];
+    resolvers: readonly JsonRecord[];
+}>;
+export declare class ConnectorRuntimeErrorV2 extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+export declare function assertConnectorEvidenceRequestV2(value: unknown): ConnectorEvidenceRequestV2;
+export declare class ConnectorRuntimeV2 {
+    #private;
+    constructor(input: Readonly<{
+        registry: ConnectorRegistryV2;
+        credentials: ConnectorCredentialCustodyV2;
+        checkpoints: ConnectorCheckpointCustodyV2;
+        contracts: ConnectorRuntimeContractsV2;
+        evidenceRegistry: ConnectorEvidenceRegistryV2;
+        operate: ConnectorOperateBridgeV2;
+        transport: ConnectorProviderTransportV2;
+        now?: () => number;
+    }>);
+    providers(): Promise<ConnectorRuntimeResultV2>;
+    preview(value: ConnectorEvidenceRequestV2): Promise<ConnectorRuntimeResultV2>;
+    status(value: ConnectorEvidenceRequestV2 | string): Promise<ConnectorRuntimeResultV2>;
+    collect(value: ConnectorEvidenceRequestV2, options?: Readonly<{
+        allowOwnerConfirmation?: boolean;
+    }>): Promise<ConnectorRuntimeResultV2>;
+}
+export declare function createConnectorRuntimeV2(input: ConstructorParameters<typeof ConnectorRuntimeV2>[0]): ConnectorRuntimeV2;
+export type BoundedConnectorFetchPolicyV2 = Readonly<{
+    providerId: string;
+    origin: string;
+    pathnameByOperation: Readonly<Record<string, string>>;
+    allowLoopback: boolean;
+    authorizationScheme: 'Bearer';
+    timeoutMs: number;
+}>;
+export declare function createBoundedFetchConnectorTransportV2(input: Readonly<{
+    policies: readonly BoundedConnectorFetchPolicyV2[];
+    fetchImpl?: typeof fetch;
+    now?: () => number;
+    resolveHost?: (hostname: string) => Promise<readonly Readonly<{
+        address: string;
+    }>[]>;
+}>): ConnectorProviderTransportV2;
+export {};
+//# sourceMappingURL=connector-runtime.d.ts.map

package/dist/services/connectors/connector-runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector-runtime.d.ts","sourceRoot":"","sources":["../../../src/services/connectors/connector-runtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,mCAAmC,EACnC,8BAA8B,EAC9B,cAAc,EACf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAE5E,OAAO,KAAK,EAEV,iBAAiB,EACjB,yBAAyB,EACzB,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EAC1B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAEV,4BAA4B,EAE7B,MAAM,yBAAyB,CAAC;AAGjC,KAAK,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACpD,KAAK,IAAI,GAAG,UAAU,MAAM,EAAE,CAAC;AAU/B,QAAA,MAAM,cAAc,qFAIT,CAAC;AAEZ,MAAM,MAAM,2BAA2B,GACnC,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;IAC9C,EAAE,EAAE,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;IACpC,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;IAC9C,EAAE,EAAE,OAAO,CAAC;IACZ,SAAS,EAAE,2BAA2B,CAAC;IACvC,OAAO,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAC7C,iBAAiB,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,EAAE,QAAQ,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD,CAAC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAAC;IAChD,IAAI,EAAE,iCAAiC,CAAC;IACxC,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpD,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,yBAAyB,CAAC;IAC1C,KAAK,EAAE,QAAQ,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9E,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,QAAQ,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,MAAM,EAAE,iBAAiB,CAAC;IAC1B,cAAc,EAAE,yBAAyB,CAAC;IAC1C,WAAW,EAAE,yBAAyB,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,aAAa,GAAG,gBAAgB,CAAC;QAC3C,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;CACJ,CAAC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAAC;IAC/C,QAAQ,EAAE,QAAQ,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACpD,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,eAAe,CAAC;IACxB,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,QAAQ,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,cAAc,EAAE,yBAAyB,CAAC;IAC1C,WAAW,EAAE,yBAAyB,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,qBAAqB,EAAE,IAAI,GAAG,IAAI,CAAC;IACnC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,iBAAiB,EAAE,iCAAiC,CAAC;IACrD,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxC,aAAa,EAAE,IAAI,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC,CAAC;AAEH,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAAC;IACnD,MAAM,EAAE,cAAc,GAAG,QAAQ,GAAG,WAAW,CAAC;IAChD,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,QAAQ,CAAC;QACjB,IAAI,EACA,iBAAiB,GACjB,oBAAoB,GACpB,OAAO,GACP,WAAW,GACX,sBAAsB,GACtB,cAAc,GACd,uBAAuB,GACvB,aAAa,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,OAAO,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC,CAAC;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,QAAQ,CAAC;IAClD,MAAM,CACJ,KAAK,EAAE,QAAQ,CAAC;QACd,OAAO,EAAE,0BAA0B,CAAC;QACpC,YAAY,EAAE,UAAU,CAAC;KAC1B,CAAC,GACD,sBAAsB,CAAC;IAC1B,OAAO,CACL,KAAK,EAAE,QAAQ,CAAC;QACd,OAAO,EAAE,0BAA0B,CAAC;QACpC,YAAY,EAAE,UAAU,CAAC;QACzB,UAAU,EAAE,MAAM,CAAC;QACnB,UAAU,EAAE,UAAU,CAAC;QACvB,cAAc,EAAE,sBAAsB,CAAC;KACxC,CAAC,GACD,OAAO,CAAC,6BAA6B,CAAC,CAAC;CAC3C,CAAC,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAAC;IACjD,0CAA0C,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;IACxE,oCAAoC,CAAC,MAAM,EAAE,OAAO,GAAG,UAAU,CAAC;IAClE,sCAAsC,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAC1F,wCAAwC,CAAC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAClE,0CAA0C,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IACrE,oCAAoC,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,UAAU,CAAC;CACpF,CAAC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,QAAQ,CAAC;IAC9C,6BAA6B,CAC3B,KAAK,EAAE,QAAQ,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,cAAc,CAAC;KACvB,CAAC,GACD,OAAO,CAAC,mCAAmC,CAAC,CAAC;IAChD,4BAA4B,CAC1B,KAAK,EAAE,QAAQ,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,EAAE,cAAc,CAAC;QACtB,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,QAAQ,CAAC;YAChB,gBAAgB,EAAE,UAAU,CAAC;YAC7B,wBAAwB,EAAE,UAAU,CAAC;YACrC,oBAAoB,EAAE,UAAU,CAAC;YACjC,YAAY,EAAE,UAAU,CAAC;YACzB,aAAa,EAAE,UAAU,CAAC;YAC1B,mBAAmB,EAAE,UAAU,CAAC;YAChC,gBAAgB,EAAE,UAAU,CAAC;YAC7B,iBAAiB,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;SAC3C,CAAC,CAAC;KACJ,CAAC,GACD,OAAO,CAAC,8BAA8B,CAAC,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAAC;IACjD,SAAS,EAAE,SAAS,UAAU,EAAE,CAAC;IACjC,SAAS,EAAE,SAAS,UAAU,EAAE,CAAC;CAClC,CAAC,CAAC;AAWH,qBAAa,uBAAwB,SAAQ,KAAK;IAE9C,QAAQ,CAAC,IAAI,EAAE,MAAM;gBAAZ,IAAI,EAAE,MAAM,EACrB,OAAO,EAAE,MAAM;CAKlB;AA0DD,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CA0H3F;AAoLD,qBAAa,kBAAkB;;gBAW3B,KAAK,EAAE,QAAQ,CAAC;QACd,QAAQ,EAAE,mBAAmB,CAAC;QAC9B,WAAW,EAAE,4BAA4B,CAAC;QAC1C,WAAW,EAAE,4BAA4B,CAAC;QAC1C,SAAS,EAAE,2BAA2B,CAAC;QACvC,gBAAgB,EAAE,2BAA2B,CAAC;QAC9C,OAAO,EAAE,wBAAwB,CAAC;QAClC,SAAS,EAAE,4BAA4B,CAAC;QACxC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;KACpB,CAAC;IAYE,SAAS,IAAI,OAAO,CAAC,wBAAwB,CAAC;IAmB9C,OAAO,CAAC,KAAK,EAAE,0BAA0B,GAAG,OAAO,CAAC,wBAAwB,CAAC;IA6B7E,MAAM,CAAC,KAAK,EAAE,0BAA0B,GAAG,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAqSrF,OAAO,CACX,KAAK,EAAE,0BAA0B,EACjC,OAAO,GAAE,QAAQ,CAAC;QAAE,sBAAsB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAM,GAC3D,OAAO,CAAC,wBAAwB,CAAC;CA2lBrC;AAED,wBAAgB,wBAAwB,CACtC,KAAK,EAAE,qBAAqB,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,GACzD,kBAAkB,CAEpB;AAED,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAAC;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,QAAQ,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC,CAAC;AAwHH,wBAAgB,sCAAsC,CACpD,KAAK,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,SAAS,6BAA6B,EAAE,CAAC;IACnD,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,QAAQ,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC,CAAC;CACvF,CAAC,GACD,4BAA4B,CAmI9B"}