import {z} from 'zod' export type ConnectorRunStatus = 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'PARTIALLY_FAILED' | 'CANCELLED'; export type ConnectorRouteId = string; export type ConnectorInstanceId = string; export type ConnectorInvocationBindingId = string; export type LogicalConnectionBindingId = string; export type ConnectorExchangeMode = 'PLATFORM_INITIATED_PULL' | 'PLATFORM_INITIATED_PUSH' | 'EXTERNALLY_INITIATED_READ' | 'EXTERNALLY_INITIATED_WRITE' | 'SUBSCRIPTION_CALLBACK' | 'BIDIRECTIONAL_SYNC'; export type ConnectorOwnerSurface = 'OID4VCI' | 'OID4VP' | 'FORM' | 'PORTAL' | 'WORKFLOW' | 'APPLICATION'; export type GetApiRunsArgs = {status?: ConnectorRunStatus | undefined, routeId?: ConnectorRouteId | undefined, connectorInstanceId?: ConnectorInstanceId | undefined, invocationBindingId?: ConnectorInvocationBindingId | undefined, logicalConnectionBindingId?: LogicalConnectionBindingId | undefined, physicalConnectorInstanceId?: ConnectorInstanceId | undefined, exchangeMode?: ConnectorExchangeMode | undefined, protocolSurface?: ConnectorOwnerSurface | undefined, correlationId?: string | undefined, page?: number | undefined, size?: number | undefined}; export type GetApiRunsOptions = {baseUrl?: string | undefined, bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const connectorRunId = z.string(); export const connectorRouteId = z.string(); export const operationBindingId = z.string(); export const connectorInstanceId = z.string(); export const connectorInvocationBindingId = z.string(); export const logicalConnectionBindingId = z.string(); 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 retentionDeleteAction = z.enum(["DELETE", "ANONYMIZE", "PSEUDONYMIZE", "TOMBSTONE", "REVIEW"]); export const stringMap = z.record(z.string(), z.string()); 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 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 connectorProtocolEventContext = z.object({tenantId: z.string().optional(), organizationUnitId: z.string().optional(), brandId: z.string().optional(), legalEntityId: z.string().optional(), actor: partyRef.optional(), protocolSurface: z.enum(["OID4VCI", "OID4VP", "FORM", "PORTAL", "WORKFLOW", "APPLICATION"]).optional(), ownerReference: z.string().optional(), stage: z.string().optional(), sessionId: z.string().optional(), transactionId: z.string().optional(), correlationId: z.string().optional()}); export const connectorResourceId = z.string(); export const operationKind = z.enum(["READ", "WRITE", "UPDATE", "DELETE", "UPSERT", "QUERY", "SEARCH", "IMPORT", "EXPORT", "INVOKE", "DISCOVER", "VALIDATE"]); export const connectorRunStatus = z.enum(["QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "PARTIALLY_FAILED", "CANCELLED"]); export const apiError = z.object({code: z.string(), message: z.string(), details: z.record(z.string(), z.unknown()).optional()}); export const connectorRun = z.object({runId: connectorRunId, routeId: connectorRouteId.optional(), bindingId: operationBindingId.optional(), connectorInstanceId: connectorInstanceId.optional(), invocationBindingId: connectorInvocationBindingId.optional(), logicalConnectionBindingId: logicalConnectionBindingId.optional(), physicalConnectorInstanceId: connectorInstanceId.optional(), exchangeMode: connectorExchangeMode.optional(), dataDirection: connectorDataDirection.optional(), initiationSide: connectorInitiationSide.optional(), governance: connectorGovernanceEnvelope.optional(), partyAnchors: connectorPartyAnchorSet.optional(), protocolContext: connectorProtocolEventContext.optional(), connectorResourceId: connectorResourceId.optional(), operationKind: operationKind.optional(), triggerKind: z.enum(["INLINE", "ON_DEMAND", "SCHEDULED", "EVENT", "WEBHOOK", "PIPELINE"]).optional(), status: connectorRunStatus, startedAt: z.string(), finishedAt: z.string().optional(), itemCount: z.number().int().gte(0).optional(), successCount: z.number().int().gte(0).optional(), failureCount: z.number().int().gte(0).optional(), correlationId: z.string().optional(), error: apiError.optional(), metadata: stringMap.optional(), updatedAt: z.string().optional(), createdByUserId: z.string().optional(), updatedByUserId: z.string().optional(), deletedAt: z.string().optional()}); export const page = z.object({limit: z.number().int().gte(0), offset: z.number().int().gte(0), page: z.number().int().gte(0), size: z.number().int().gte(0), total: z.number().int().gte(0), totalPages: z.number().int().gte(0), hasMore: z.boolean()}); export const connectorRunPage = z.object({data: z.array(connectorRun), pagination: page}); 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 }; /** * List connector runs * * GET /runs */ export const getApiRuns = async (args: GetApiRunsArgs, options?: GetApiRunsOptions) => { const {baseUrl = "https://api.example.com/api/connector/v1", fetch: fetchFn = fetch, bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.status != null) query.append("status", String(args.status)) if (args.routeId != null) query.append("routeId", String(args.routeId)) if (args.connectorInstanceId != null) query.append("connectorInstanceId", String(args.connectorInstanceId)) if (args.invocationBindingId != null) query.append("invocationBindingId", String(args.invocationBindingId)) if (args.logicalConnectionBindingId != null) query.append("logicalConnectionBindingId", String(args.logicalConnectionBindingId)) if (args.physicalConnectorInstanceId != null) query.append("physicalConnectorInstanceId", String(args.physicalConnectorInstanceId)) if (args.exchangeMode != null) query.append("exchangeMode", String(args.exchangeMode)) if (args.protocolSurface != null) query.append("protocolSurface", String(args.protocolSurface)) if (args.correlationId != null) query.append("correlationId", String(args.correlationId)) if (args.page != null) query.append("page", String(args.page)) if (args.size != null) query.append("size", String(args.size)) if (bearer !== undefined) headers.set('authorization', `Bearer ${bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/runs${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(connectorRunPage, await res.json()) };