import {z} from 'zod' export type ConnectorInstanceId = string; export type SchemaDriftPolicy = 'IGNORE' | 'WARN' | 'FAIL'; export type StringMap = {[key: string]: string}; export type DiscoverResourcesRequest = {includeFields?: boolean | undefined, includeOperations?: boolean | undefined, schemaDriftPolicy?: SchemaDriftPolicy | undefined, filters?: StringMap | undefined}; export type CreateApiConnectorsConnectorInstanceIdDiscoveryrunsArgs = {connectorInstanceId: ConnectorInstanceId, body: DiscoverResourcesRequest}; export type CreateApiConnectorsConnectorInstanceIdDiscoveryrunsOptions = {baseUrl?: string | undefined, bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const connectorInstanceId = z.string(); export const resourceKind = z.enum(["OBJECT", "TABULAR", "DOCUMENT", "CLAIM_SET", "GRAPH", "EVENT_STREAM", "FILE", "SECRET", "CONFIGURATION", "CREDENTIAL", "PRESENTATION", "CUSTOM"]); export const representationKind = z.enum(["JSON", "JSON_LD", "XML", "CSV", "PARQUET", "AVRO", "RDF", "JWT", "SD_JWT", "CBOR", "BINARY", "TEXT", "CUSTOM"]); export const shapeKind = z.enum(["SCHEMA", "OPENAPI_SCHEMA", "JSON_SCHEMA", "RDF_SHAPE", "SQL_TABLE", "CSV_HEADER", "CLAIMS_SCHEMA", "FREEFORM"]); export const contractKind = z.enum(["OPENAPI", "JSON_SCHEMA", "SQL_SCHEMA", "RDF_SCHEMA", "CSV_PROFILE", "OIDC_DISCOVERY", "VAULT_POLICY", "CUSTOM"]); export const stringMap = z.record(z.string(), z.string()); export const contractRef = z.object({contractKind: contractKind, uri: z.string().optional(), version: z.string().optional(), contentHash: z.string().optional(), metadata: stringMap.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 fieldDescriptorId = z.string(); export const resourceDescriptorId = z.string(); export const resourceDescriptor = z.object({displayName: z.string(), description: z.string().optional(), resourceKind: resourceKind, representationKind: representationKind, shapeKind: shapeKind.optional(), contract: contractRef.optional(), fields: z.array(z.object({fieldPath: z.string(), displayName: z.string().optional(), valueType: z.string(), required: z.boolean().optional(), multiValued: z.boolean().optional(), semanticAttributeId: z.string().optional(), sensitivity: z.string().optional(), retention: retentionSpec.optional(), metadata: stringMap.optional(), fieldDescriptorId: fieldDescriptorId})).optional(), metadata: stringMap.optional(), resourceDescriptorId: resourceDescriptorId, createdAt: z.string(), updatedAt: z.string()}); export const operationKind = z.enum(["READ", "WRITE", "UPDATE", "DELETE", "UPSERT", "QUERY", "SEARCH", "IMPORT", "EXPORT", "INVOKE", "DISCOVER", "VALIDATE"]); export const schemaDriftPolicy = z.enum(["IGNORE", "WARN", "FAIL"]); export const schemaDriftFinding = z.object({resourceDescriptorId: resourceDescriptorId, externalResourceName: z.string().optional(), expectedContentHash: z.string(), discoveredContentHash: z.string(), expectedContractVersion: z.string().optional(), discoveredContractVersion: z.string().optional(), policy: schemaDriftPolicy.optional(), detectedAt: z.string().optional(), message: z.string().optional(), metadata: stringMap.optional()}); export const discoveredResource = z.object({externalResourceName: z.string().optional(), resourceKind: resourceKind.optional(), representationKind: representationKind.optional(), suggestedDescriptor: resourceDescriptor.optional(), supportedOperations: z.array(operationKind).optional(), schemaDrift: schemaDriftFinding.optional(), metadata: stringMap.optional()}); export const discoveryResult = z.object({connectorInstanceId: connectorInstanceId, resources: z.array(discoveredResource), schemaDrift: z.array(schemaDriftFinding).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 }; /** * Discover connector resources * * POST /connectors/{connectorInstanceId}/discoveryruns */ export const createApiConnectorsConnectorInstanceIdDiscoveryruns = async (args: CreateApiConnectorsConnectorInstanceIdDiscoveryrunsArgs, options?: CreateApiConnectorsConnectorInstanceIdDiscoveryrunsOptions) => { 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(/\/+$/, '')}/connectors/${encodeURIComponent(String(args.connectorInstanceId))}/discoveryruns${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(discoveryResult, await res.json()) };