import {z} from 'zod' export type ConnectorInvocationBindingId = string; export type ConnectorOwnerSurface = 'OID4VCI' | 'OID4VP' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'APPLICATION'; export type ConnectorInvocationStage = 'OID4VCI_START' | 'OID4VCI_AUTHORIZATION' | 'OID4VCI_PRE_AUTHORIZED' | 'OID4VCI_TOKEN' | 'OID4VCI_CREDENTIAL_REQUEST' | 'OID4VCI_DEFERRED' | 'OID4VCI_PRE_ISSUE' | 'OID4VCI_POST_ISSUANCE' | 'OID4VCI_NOTIFICATION_RECEIPT' | 'OID4VP_AFTER_VALIDATION' | 'OID4VP_PRE_REQUEST_ENRICHMENT' | 'FORM_LIFECYCLE' | 'FORM_ACTION_START' | 'FORM_ACTION_COMPLETE' | 'FORM_FIELD_LOOKUP' | 'FORM_SUBMIT' | 'PORTAL_FLOW' | 'WORKFLOW_STEP_EXECUTION'; export type ConnectorInvocationRole = 'ENRICHMENT_SOURCE' | 'EXPORT_DESTINATION' | 'VAULT_RETENTION' | 'NOTIFICATION' | 'BIDIRECTIONAL_SYNC' | 'ROUTE_ORCHESTRATION'; export type ConnectorRouteId = string; export type ConnectorInstanceId = string; export type OperationBindingId = string; export type ConnectorInvocationTarget = {routeId?: ConnectorRouteId | undefined, connectorId?: ConnectorInstanceId | undefined, operationBindingId?: OperationBindingId | undefined}; export type ConnectorExchangeMode = 'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC'; export type ConnectorDataDirection = 'INBOUND' | 'OUTBOUND' | 'BIDIRECTIONAL'; export type ConnectorInitiationSide = 'PLATFORM' | 'EXTERNAL' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC'; export type SemanticReference = {referenceType: string, referenceId: string, iri?: string | undefined, version?: string | undefined}; export type ConnectorFieldSelector = {canonicalFieldPath?: string | undefined, connectorField?: string | undefined, protocolClaimPath?: string | undefined, dcqlCredentialQueryId?: string | undefined, dcqlClaimId?: string | undefined, formFieldPath?: string | undefined, proofRef?: string | undefined, statusRef?: string | undefined, tokenRef?: string | undefined, sourceFieldPath?: string | undefined, dataProductFieldScope?: string | undefined, contractAgreementTargetRef?: string | undefined, semanticReference?: SemanticReference | undefined, required?: boolean | undefined}; export type ConnectorFieldMapping = {source: ConnectorFieldSelector, target: ConnectorFieldSelector, required?: boolean | undefined}; export type ConnectorSubsetMapping = {inputFields?: Array | undefined, selectedFields?: Array | undefined, producedFields?: Array | undefined, outputMappings?: Array | undefined, sourceProvenanceFields?: Array | undefined, qualityStatusFields?: Array | undefined, redactionProfileId?: string | undefined, minimizationProfileId?: string | undefined}; export type TenantId = string; export type StringMap = {[key: string]: string}; export type ConnectorLogicalContext = {tenantId: TenantId, organizationUnitId?: string | undefined, brandId?: string | undefined, legalEntityId?: string | undefined, channel?: string | undefined, productId?: string | undefined, discriminators?: StringMap | undefined}; export type LogicalConnectionBindingId = string; export type ConnectorExecutionTiming = 'INLINE_REQUIRED' | 'INLINE_OPTIONAL' | 'DEFERRED_ASYNC' | 'DURABLE_OUTBOX'; export type ConnectorFailureEffect = 'FAIL_PROTOCOL' | 'CONTINUE_WITHOUT_EFFECT' | 'DEAD_LETTER' | 'QUARANTINE' | 'RETRY_ONLY'; export type RetryPolicy = {maxAttempts?: number | undefined, backoffMillis?: number | undefined, deadLetterEnabled?: boolean | undefined}; export type ConnectorInvocationExecutionPolicy = {timing?: ConnectorExecutionTiming | undefined, failureEffect?: ConnectorFailureEffect | undefined, timeoutMillis?: number | undefined, syncWaitWindowMillis?: number | undefined, retryPolicy?: RetryPolicy | undefined, idempotencyKey?: string | undefined, correlationId?: string | undefined}; export type RetentionDeleteAction = 'DELETE' | 'ANONYMIZE' | 'PSEUDONYMIZE' | 'TOMBSTONE' | 'REVIEW'; export type RetentionSpec = {purpose?: string | undefined, legalBasis?: string | undefined, retentionPeriod?: string | undefined, deleteAction?: RetentionDeleteAction | undefined, metadata?: StringMap | undefined}; export type ConnectorIntegrityReference = {originalPayloadHash?: string | undefined, canonicalPayloadHash?: string | undefined, transformationHash?: string | undefined, evidenceRef?: string | undefined, vaultRef?: string | undefined, signatureRef?: string | undefined, sealRef?: string | undefined, timestampRef?: string | undefined, sourceAuthenticityVerdict?: string | undefined, outputManifestHash?: string | undefined}; export type ConnectorGovernanceEnvelope = {classification?: string | undefined, sensitivity?: string | undefined, specialCategory?: boolean | undefined, legalBasis?: string | undefined, purpose?: string | undefined, b2bUsagePurpose?: string | undefined, frameworkAgreementRef?: string | undefined, contractReference?: string | undefined, minimizationStatus?: ('NOT_EVALUATED' | 'MINIMIZED' | 'REDACTED' | 'FULL_DATASET' | 'EXCESSIVE') | undefined, retentionProfileId?: string | undefined, retention?: RetentionSpec | undefined, crossBorderRestriction?: ('NONE' | 'SAME_COUNTRY' | 'EEA_ONLY' | 'APPROVED_COUNTRIES' | 'CONTRACT_REQUIRED' | 'BLOCKED') | undefined, encryptionRequirement?: ('NONE' | 'IN_TRANSIT' | 'AT_REST' | 'AT_REST_AND_IN_TRANSIT' | 'CUSTOMER_MANAGED_KEY') | undefined, dpiaRequired?: boolean | undefined, integrity?: ConnectorIntegrityReference | undefined, policyDecisionId?: string | undefined, relianceVerdict?: ('NOT_EVALUATED' | 'RELIABLE' | 'CONDITIONAL' | 'NOT_RELIABLE') | undefined, auditCategory?: ('PROTOCOL_ISSUANCE' | 'PROTOCOL_VERIFICATION' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'DATASPACE' | 'INDUSTRIAL' | 'EXTERNAL_EXCHANGE' | 'VAULT' | 'SYSTEM_CATALOG') | undefined}; export type ConnectorVaultRetentionProfile = 'ISSUANCE_PROOF' | 'CANONICAL_SUBJECT_DATA' | 'RECEIVED_CUSTOMER_DATA'; export type PartyRef = {partyId?: string | undefined, externalId?: string | undefined, partyType?: string | undefined, displayName?: string | undefined, metadata?: StringMap | undefined}; export type ConnectorPartyAnchor = {role?: string | undefined, party?: PartyRef | undefined, relationships?: Array<{[key: string]: unknown}> | undefined}; export type ConnectorPartyAnchorSet = {anchors?: Array | undefined, relationshipCandidates?: Array<{[key: string]: unknown}> | undefined, projectionCandidates?: Array<{[key: string]: unknown}> | undefined}; export type MaterializationMode = 'NONE' | 'CACHE' | 'PERSIST' | 'MIRROR' | 'INDEX'; export type ResourceDescriptorId = string; export type MaterializationPolicy = {mode?: MaterializationMode | undefined, ttlSeconds?: number | undefined, storageResourceDescriptorId?: ResourceDescriptorId | undefined, retention?: RetentionSpec | undefined, metadata?: StringMap | undefined}; export type ConnectorInvocationBinding = {invocationBindingId: ConnectorInvocationBindingId, ownerSurface: ConnectorOwnerSurface, ownerReference: string, stage: ConnectorInvocationStage, role: ConnectorInvocationRole, target: ConnectorInvocationTarget, exchangeMode: ConnectorExchangeMode, dataDirection?: ConnectorDataDirection | undefined, initiationSide?: ConnectorInitiationSide | undefined, subsetMapping?: ConnectorSubsetMapping | undefined, logicalContext: ConnectorLogicalContext, logicalConnectionBindingId?: LogicalConnectionBindingId | undefined, physicalConnectorInstanceId?: ConnectorInstanceId | undefined, executionPolicy?: ConnectorInvocationExecutionPolicy | undefined, governance?: ConnectorGovernanceEnvelope | undefined, vaultProfile?: ConnectorVaultRetentionProfile | undefined, partyAnchors?: ConnectorPartyAnchorSet | undefined, materializationPolicy?: MaterializationPolicy | undefined, metadata?: StringMap | undefined}; export type ConnectorInvocationBindingCreateRequest = {binding: ConnectorInvocationBinding}; export type CreateApiInvocationBindingsArgs = {body: ConnectorInvocationBindingCreateRequest}; export type CreateApiInvocationBindingsOptions = {baseUrl?: string | undefined, bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const connectorInvocationBindingId = z.string(); export const connectorOwnerSurface = z.enum(["OID4VCI", "OID4VP", "FORM", "PORTAL", "WORKFLOW", "APPLICATION"]); export const connectorInvocationStage = z.enum(["OID4VCI_START", "OID4VCI_AUTHORIZATION", "OID4VCI_PRE_AUTHORIZED", "OID4VCI_TOKEN", "OID4VCI_CREDENTIAL_REQUEST", "OID4VCI_DEFERRED", "OID4VCI_PRE_ISSUE", "OID4VCI_POST_ISSUANCE", "OID4VCI_NOTIFICATION_RECEIPT", "OID4VP_AFTER_VALIDATION", "OID4VP_PRE_REQUEST_ENRICHMENT", "FORM_LIFECYCLE", "FORM_ACTION_START", "FORM_ACTION_COMPLETE", "FORM_FIELD_LOOKUP", "FORM_SUBMIT", "PORTAL_FLOW", "WORKFLOW_STEP_EXECUTION"]); export const connectorInvocationRole = z.enum(["ENRICHMENT_SOURCE", "EXPORT_DESTINATION", "VAULT_RETENTION", "NOTIFICATION", "BIDIRECTIONAL_SYNC", "ROUTE_ORCHESTRATION"]); export const connectorRouteId = z.string(); export const connectorInstanceId = z.string(); export const operationBindingId = z.string(); export const connectorInvocationTarget = z.object({routeId: connectorRouteId.optional(), connectorId: connectorInstanceId.optional(), operationBindingId: operationBindingId.optional()}); export const connectorExchangeMode = z.enum(["PLATFORM_INITIATED_PULL", "PLATFORM_INITIATED_PUSH", "EXTERNALLY_INITIATED_READ", "EXTERNALLY_INITIATED_WRITE", "SUBSCRIPTION_CALLBACK", "BIDIRECTIONAL_SYNC"]); export const connectorDataDirection = z.enum(["INBOUND", "OUTBOUND", "BIDIRECTIONAL"]); export const connectorInitiationSide = z.enum(["PLATFORM", "EXTERNAL", "SUBSCRIPTION_CALLBACK", "BIDIRECTIONAL_SYNC"]); export const semanticReference = z.object({referenceType: z.string(), referenceId: z.string(), iri: z.string().optional(), version: z.string().optional()}); export const connectorFieldSelector = z.object({canonicalFieldPath: z.string().optional(), connectorField: z.string().optional(), protocolClaimPath: z.string().optional(), dcqlCredentialQueryId: z.string().optional(), dcqlClaimId: z.string().optional(), formFieldPath: z.string().optional(), proofRef: z.string().optional(), statusRef: z.string().optional(), tokenRef: z.string().optional(), sourceFieldPath: z.string().optional(), dataProductFieldScope: z.string().optional(), contractAgreementTargetRef: z.string().optional(), semanticReference: semanticReference.optional(), required: z.boolean().optional()}); export const connectorFieldMapping = z.object({source: connectorFieldSelector, target: connectorFieldSelector, required: z.boolean().optional()}); export const connectorSubsetMapping = z.object({inputFields: z.array(connectorFieldSelector).optional(), selectedFields: z.array(connectorFieldSelector).optional(), producedFields: z.array(connectorFieldSelector).optional(), outputMappings: z.array(connectorFieldMapping).optional(), sourceProvenanceFields: z.array(connectorFieldSelector).optional(), qualityStatusFields: z.array(connectorFieldSelector).optional(), redactionProfileId: z.string().optional(), minimizationProfileId: z.string().optional()}); export const tenantId = z.string(); export const stringMap = z.record(z.string(), z.string()); export const connectorLogicalContext = z.object({tenantId: tenantId, organizationUnitId: z.string().optional(), brandId: z.string().optional(), legalEntityId: z.string().optional(), channel: z.string().optional(), productId: z.string().optional(), discriminators: stringMap.optional()}); export const logicalConnectionBindingId = z.string(); export const connectorExecutionTiming = z.enum(["INLINE_REQUIRED", "INLINE_OPTIONAL", "DEFERRED_ASYNC", "DURABLE_OUTBOX"]); export const connectorFailureEffect = z.enum(["FAIL_PROTOCOL", "CONTINUE_WITHOUT_EFFECT", "DEAD_LETTER", "QUARANTINE", "RETRY_ONLY"]); export const retryPolicy = z.object({maxAttempts: z.number().int().gte(0).optional(), backoffMillis: z.number().int().gte(0).optional(), deadLetterEnabled: z.boolean().optional()}); export const connectorInvocationExecutionPolicy = z.object({timing: connectorExecutionTiming.optional(), failureEffect: connectorFailureEffect.optional(), timeoutMillis: z.number().int().gte(0).optional(), syncWaitWindowMillis: z.number().int().gte(0).optional(), retryPolicy: retryPolicy.optional(), idempotencyKey: z.string().optional(), correlationId: z.string().optional()}); export const retentionDeleteAction = z.enum(["DELETE", "ANONYMIZE", "PSEUDONYMIZE", "TOMBSTONE", "REVIEW"]); export const retentionSpec = z.object({purpose: z.string().optional(), legalBasis: z.string().optional(), retentionPeriod: z.string().optional(), deleteAction: retentionDeleteAction.optional(), metadata: stringMap.optional()}); export const connectorIntegrityReference = z.object({originalPayloadHash: z.string().optional(), canonicalPayloadHash: z.string().optional(), transformationHash: z.string().optional(), evidenceRef: z.string().optional(), vaultRef: z.string().optional(), signatureRef: z.string().optional(), sealRef: z.string().optional(), timestampRef: z.string().optional(), sourceAuthenticityVerdict: z.string().optional(), outputManifestHash: z.string().optional()}); export const connectorGovernanceEnvelope = z.object({classification: z.string().optional(), sensitivity: z.string().optional(), specialCategory: z.boolean().optional(), legalBasis: z.string().optional(), purpose: z.string().optional(), b2bUsagePurpose: z.string().optional(), frameworkAgreementRef: z.string().optional(), contractReference: z.string().optional(), minimizationStatus: z.enum(["NOT_EVALUATED", "MINIMIZED", "REDACTED", "FULL_DATASET", "EXCESSIVE"]).optional(), retentionProfileId: z.string().optional(), retention: retentionSpec.optional(), crossBorderRestriction: z.enum(["NONE", "SAME_COUNTRY", "EEA_ONLY", "APPROVED_COUNTRIES", "CONTRACT_REQUIRED", "BLOCKED"]).optional(), encryptionRequirement: z.enum(["NONE", "IN_TRANSIT", "AT_REST", "AT_REST_AND_IN_TRANSIT", "CUSTOMER_MANAGED_KEY"]).optional(), dpiaRequired: z.boolean().optional(), integrity: connectorIntegrityReference.optional(), policyDecisionId: z.string().optional(), relianceVerdict: z.enum(["NOT_EVALUATED", "RELIABLE", "CONDITIONAL", "NOT_RELIABLE"]).optional(), auditCategory: z.enum(["PROTOCOL_ISSUANCE", "PROTOCOL_VERIFICATION", "FORM", "PORTAL", "WORKFLOW", "DATASPACE", "INDUSTRIAL", "EXTERNAL_EXCHANGE", "VAULT", "SYSTEM_CATALOG"]).optional()}); export const connectorVaultRetentionProfile = z.enum(["ISSUANCE_PROOF", "CANONICAL_SUBJECT_DATA", "RECEIVED_CUSTOMER_DATA"]); export const partyRef = z.object({partyId: z.string().optional(), externalId: z.string().optional(), partyType: z.string().optional(), displayName: z.string().optional(), metadata: stringMap.optional()}); export const connectorPartyAnchor = z.object({role: z.string().optional(), party: partyRef.optional(), relationships: z.array(z.record(z.string(), z.unknown())).optional()}); export const connectorPartyAnchorSet = z.object({anchors: z.array(connectorPartyAnchor).optional(), relationshipCandidates: z.array(z.record(z.string(), z.unknown())).optional(), projectionCandidates: z.array(z.record(z.string(), z.unknown())).optional()}); export const materializationMode = z.enum(["NONE", "CACHE", "PERSIST", "MIRROR", "INDEX"]); export const resourceDescriptorId = z.string(); export const materializationPolicy = z.object({mode: materializationMode.optional(), ttlSeconds: z.number().int().gte(0).optional(), storageResourceDescriptorId: resourceDescriptorId.optional(), retention: retentionSpec.optional(), metadata: stringMap.optional()}); export const connectorInvocationBinding = z.object({invocationBindingId: connectorInvocationBindingId, ownerSurface: connectorOwnerSurface, ownerReference: z.string(), stage: connectorInvocationStage, role: connectorInvocationRole, target: connectorInvocationTarget, exchangeMode: connectorExchangeMode, dataDirection: connectorDataDirection.optional(), initiationSide: connectorInitiationSide.optional(), subsetMapping: connectorSubsetMapping.optional(), logicalContext: connectorLogicalContext, logicalConnectionBindingId: logicalConnectionBindingId.optional(), physicalConnectorInstanceId: connectorInstanceId.optional(), executionPolicy: connectorInvocationExecutionPolicy.optional(), governance: connectorGovernanceEnvelope.optional(), vaultProfile: connectorVaultRetentionProfile.optional(), partyAnchors: connectorPartyAnchorSet.optional(), materializationPolicy: materializationPolicy.optional(), metadata: stringMap.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Create a connector invocation binding * * POST /invocation/bindings */ export const createApiInvocationBindings = async (args: CreateApiInvocationBindingsArgs, options?: CreateApiInvocationBindingsOptions) => { const {baseUrl = "https://api.example.com/api/connector/v1", fetch: fetchFn = fetch, bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (bearer !== undefined) headers.set('authorization', `Bearer ${bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/invocation/bindings${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(connectorInvocationBinding, await res.json()) };