import {z} from 'zod' export type LogicalConnectionBindingId = string; export type ConnectorInstanceId = string; 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 PartyRef = {partyId?: string | undefined, externalId?: string | undefined, partyType?: string | undefined, displayName?: string | undefined, metadata?: StringMap | undefined}; export type ConnectorDiscriminatorSource = 'LOGICAL_CONTEXT' | 'AUTHENTICATED_CONTEXT' | 'PAYLOAD_FIELD' | 'STATIC_VALUE'; export type ConnectorDiscriminatorPlacement = 'HEADER' | 'QUERY' | 'BODY_FIELD' | 'CONFIG' | 'METADATA'; export type ConnectorDiscriminatorRule = {source: ConnectorDiscriminatorSource, sourceKey: string, targetKey: string, placement: ConnectorDiscriminatorPlacement, required?: boolean | undefined, staticValue?: string | undefined}; export type ConnectorAuthOverlayMode = 'USE_PHYSICAL_BASE' | 'TENANT_SECRET_REF' | 'DELEGATED_OAUTH_CLIENT' | 'MTLS_IDENTITY' | 'CONNECTOR_CREDENTIAL_SELECTOR'; export type ConnectorAuthOverlay = {mode?: ConnectorAuthOverlayMode | undefined, secretRef?: string | undefined, oauthClientRef?: string | undefined, mtlsIdentityRef?: string | undefined, credentialSelector?: string | undefined}; export type OperationKind = 'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE'; export type LogicalConnectionGrant = {grantId: string, grantedToTenantId: TenantId, grantedBy?: PartyRef | undefined, allowedOperations?: Array | undefined, active?: boolean | undefined}; 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 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 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 ConnectorManagementMode = 'MANAGED' | 'EXTERNAL'; export type ConnectorRuntimeMode = 'HOSTED' | 'REMOTE_AGENT' | 'EXTERNAL_CALLBACK'; export type ConnectorDeploymentMode = 'MANAGED' | 'EXTERNAL' | 'HYBRID'; export type SystemCatalogProjectionMetadata = {operatorParty?: PartyRef | undefined, vendorSupplierParty?: PartyRef | undefined, deploymentRegion?: string | undefined, managementMode?: ConnectorManagementMode | undefined, runtimeMode?: ConnectorRuntimeMode | undefined, deploymentMode?: ConnectorDeploymentMode | undefined, dataCategoriesTouched?: Array | undefined, downstreamRecipients?: Array | undefined, processorRefs?: Array | undefined}; export type LogicalConnectionBinding = {logicalConnectionBindingId: LogicalConnectionBindingId, physicalConnectorInstanceId: ConnectorInstanceId, logicalContext: ConnectorLogicalContext, callerParty?: PartyRef | undefined, beneficiaryParty?: PartyRef | undefined, discriminatorRules?: Array | undefined, authOverlay?: ConnectorAuthOverlay | undefined, grants?: Array | undefined, allowedOperations?: Array | undefined, defaultSubsetMapping?: ConnectorSubsetMapping | undefined, defaultGovernance?: ConnectorGovernanceEnvelope | undefined, defaultMaterializationPolicy?: MaterializationPolicy | undefined, systemCatalog?: SystemCatalogProjectionMetadata | undefined}; export type LogicalConnectionBindingCreateRequest = {binding: LogicalConnectionBinding}; export type CreateApiLogicalBindingsArgs = {body: LogicalConnectionBindingCreateRequest}; export type CreateApiLogicalBindingsOptions = {baseUrl?: string | undefined, bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const logicalConnectionBindingId = z.string(); export const connectorInstanceId = z.string(); 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 partyRef = z.object({partyId: z.string().optional(), externalId: z.string().optional(), partyType: z.string().optional(), displayName: z.string().optional(), metadata: stringMap.optional()}); export const connectorDiscriminatorSource = z.enum(["LOGICAL_CONTEXT", "AUTHENTICATED_CONTEXT", "PAYLOAD_FIELD", "STATIC_VALUE"]); export const connectorDiscriminatorPlacement = z.enum(["HEADER", "QUERY", "BODY_FIELD", "CONFIG", "METADATA"]); export const connectorDiscriminatorRule = z.object({source: connectorDiscriminatorSource, sourceKey: z.string(), targetKey: z.string(), placement: connectorDiscriminatorPlacement, required: z.boolean().optional(), staticValue: z.string().optional()}); export const connectorAuthOverlayMode = z.enum(["USE_PHYSICAL_BASE", "TENANT_SECRET_REF", "DELEGATED_OAUTH_CLIENT", "MTLS_IDENTITY", "CONNECTOR_CREDENTIAL_SELECTOR"]); export const connectorAuthOverlay = z.object({mode: connectorAuthOverlayMode.optional(), secretRef: z.string().optional(), oauthClientRef: z.string().optional(), mtlsIdentityRef: z.string().optional(), credentialSelector: z.string().optional()}); export const operationKind = z.enum(["READ", "WRITE", "UPDATE", "DELETE", "UPSERT", "QUERY", "SEARCH", "IMPORT", "EXPORT", "INVOKE", "DISCOVER", "VALIDATE"]); export const logicalConnectionGrant = z.object({grantId: z.string(), grantedToTenantId: tenantId, grantedBy: partyRef.optional(), allowedOperations: z.array(operationKind).optional(), active: z.boolean().optional()}); 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 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 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 connectorManagementMode = z.enum(["MANAGED", "EXTERNAL"]); export const connectorRuntimeMode = z.enum(["HOSTED", "REMOTE_AGENT", "EXTERNAL_CALLBACK"]); export const connectorDeploymentMode = z.enum(["MANAGED", "EXTERNAL", "HYBRID"]); export const systemCatalogProjectionMetadata = z.object({operatorParty: partyRef.optional(), vendorSupplierParty: partyRef.optional(), deploymentRegion: z.string().optional(), managementMode: connectorManagementMode.optional(), runtimeMode: connectorRuntimeMode.optional(), deploymentMode: connectorDeploymentMode.optional(), dataCategoriesTouched: z.array(z.string()).optional(), downstreamRecipients: z.array(partyRef).optional(), processorRefs: z.array(partyRef).optional()}); export const logicalConnectionBinding = z.object({logicalConnectionBindingId: logicalConnectionBindingId, physicalConnectorInstanceId: connectorInstanceId, logicalContext: connectorLogicalContext, callerParty: partyRef.optional(), beneficiaryParty: partyRef.optional(), discriminatorRules: z.array(connectorDiscriminatorRule).optional(), authOverlay: connectorAuthOverlay.optional(), grants: z.array(logicalConnectionGrant).optional(), allowedOperations: z.array(operationKind).optional(), defaultSubsetMapping: connectorSubsetMapping.optional(), defaultGovernance: connectorGovernanceEnvelope.optional(), defaultMaterializationPolicy: materializationPolicy.optional(), systemCatalog: systemCatalogProjectionMetadata.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 logical connection binding * * POST /logical/bindings */ export const createApiLogicalBindings = async (args: CreateApiLogicalBindingsArgs, options?: CreateApiLogicalBindingsOptions) => { 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(/\/+$/, '')}/logical/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(logicalConnectionBinding, await res.json()) };