import {z} from 'zod' export type ConnectorType = string; export type DataFlowRole = 'SOURCE' | 'DESTINATION'; export type OperationKind = 'READ' | 'WRITE' | 'UPDATE' | 'DELETE' | 'UPSERT' | 'QUERY' | 'SEARCH' | 'IMPORT' | 'EXPORT' | 'INVOKE' | 'DISCOVER' | 'VALIDATE'; export type GetApiConnectorsArgs = {connectorType?: ConnectorType | undefined, role?: DataFlowRole | undefined, operationKind?: OperationKind | undefined, page?: number | undefined, size?: number | undefined}; export type GetApiConnectorsOptions = {baseUrl?: string | undefined, bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const connectorInstanceId = z.string(); export const connectorPartyId = z.string(); export const connectorType = z.string(); export const connectorLifecycleStatus = z.enum(["DRAFT", "ACTIVE", "SUSPENDED", "RETIRED"]); export const connectorManagementMode = z.enum(["MANAGED", "EXTERNAL"]); export const connectorRuntimeMode = z.enum(["HOSTED", "REMOTE_AGENT", "EXTERNAL_CALLBACK"]); export const accessProtocol = z.enum(["HTTP", "HTTPS", "JDBC", "ODBC", "SFTP", "FILE", "S3", "AZURE_BLOB", "GCS", "KAFKA", "AMQP", "MQTT", "OIDC", "DIDCOMM", "VAULT", "INTERNAL", "CUSTOM"]); export const dataFlowRole = z.enum(["SOURCE", "DESTINATION"]); export const operationKind = z.enum(["READ", "WRITE", "UPDATE", "DELETE", "UPSERT", "QUERY", "SEARCH", "IMPORT", "EXPORT", "INVOKE", "DISCOVER", "VALIDATE"]); export const identityId = z.string(); export const stringMap = z.record(z.string(), z.string()); export const identifierId = z.string(); export const connectorIdentifier = z.object({identifierType: z.string(), value: z.string(), isPrimary: z.boolean().optional(), isVerified: z.boolean().optional(), metadata: stringMap.optional(), identifierId: identifierId}); export const connectorIdentity = z.object({identityId: identityId, identityRole: z.string(), displayName: z.string().optional(), isDefault: z.boolean(), identifiers: z.array(connectorIdentifier).optional()}); export const connectorEndpoint = z.object({endpointRole: z.string().optional(), accessProtocol: accessProtocol, uri: z.string().optional(), isPrimary: z.boolean().optional(), metadata: stringMap.optional(), endpointId: z.string()}); export const secretBindingMode = z.enum(["SECRET_REF", "VAULT_KEY", "EXTERNAL_SECRET_REF"]); export const connectorCredentialRef = z.object({bindingMode: secretBindingMode, credentialId: z.string().optional(), secretRef: z.string().optional(), externalSecretRef: z.string().optional(), credentialType: z.string().optional(), label: z.string().optional(), keyAlias: z.string().optional(), metadata: stringMap.optional()}); export const connectorConfigBindingRef = z.object({configBindingId: z.string().optional(), settingsScope: z.string().optional(), settingsKeyPrefix: z.string().optional(), metadata: stringMap.optional()}); export const egressPolicy = z.object({allowedHosts: z.array(z.string()).optional(), blockedHosts: z.array(z.string()).optional(), allowedCidrs: z.array(z.string()).optional(), allowedProtocols: z.array(accessProtocol).optional(), allowedPorts: z.array(z.number().int().gte(1).lte(65535)).optional(), blockPrivateNetworks: z.boolean().optional(), pinResolvedAddress: z.boolean().optional(), maxPayloadBytes: z.number().int().gte(0).optional(), requiresTenantBoundary: z.boolean().optional(), metadata: stringMap.optional()}); export const materializationMode = z.enum(["NONE", "CACHE", "PERSIST", "MIRROR", "INDEX"]); export const resourceDescriptorId = z.string(); 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 materializationPolicy = z.object({mode: materializationMode.optional(), ttlSeconds: z.number().int().gte(0).optional(), storageResourceDescriptorId: resourceDescriptorId.optional(), retention: retentionSpec.optional(), metadata: stringMap.optional()}); export const connectorInstance = z.object({connectorInstanceId: connectorInstanceId, partyId: connectorPartyId, displayName: z.string(), description: z.string().optional(), connectorType: connectorType, lifecycleStatus: connectorLifecycleStatus, managementMode: connectorManagementMode.optional(), runtimeMode: connectorRuntimeMode.optional(), defaultAccessProtocol: accessProtocol.optional(), supportedRoles: z.array(dataFlowRole), supportedOperations: z.array(operationKind).optional(), identities: z.array(connectorIdentity).optional(), endpoints: z.array(connectorEndpoint).optional(), credentials: z.array(connectorCredentialRef).optional(), configBindings: z.array(connectorConfigBindingRef).optional(), defaultEgressPolicy: egressPolicy.optional(), defaultMaterializationPolicy: materializationPolicy.optional(), metadata: stringMap.optional(), createdAt: z.string(), updatedAt: z.string()}); 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 connectorInstancePage = z.object({data: z.array(connectorInstance), 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 instances * * GET /connectors */ export const getApiConnectors = async (args: GetApiConnectorsArgs, options?: GetApiConnectorsOptions) => { 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.connectorType != null) query.append("connectorType", String(args.connectorType)) if (args.role != null) query.append("role", String(args.role)) if (args.operationKind != null) query.append("operationKind", String(args.operationKind)) 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(/\/+$/, '')}/connectors${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(connectorInstancePage, await res.json()) };