import {z} from 'zod' export type GetApiDataQualityV1RulesArgs = {after?: string | undefined, size?: number | undefined, sort?: string | undefined}; export type GetApiDataQualityV1RulesOptions = {baseUrl?: string | undefined, JWT?: string | undefined, fetch?: typeof fetch | undefined}; export const paginationMetadata = z.object({next: z.string().optional(), total: z.number().int().optional()}); export const dqThresholdUrn = z.string(); export const correlationIdResponse = z.string(); export const dqThresholdResponse = z.object({severity: z.string().optional(), value: z.number().int().gte(0).lte(100).optional(), urn: dqThresholdUrn, correlationId: correlationIdResponse.optional()}); export const groupUrn = z.string(); export const ruleInputGroupUrn = z.string(); export const inputAttributeDataType = z.string(); export const ruleAttributeUrn = z.string(); export const ruleInputAttributeResponse = z.object({name: z.string().optional(), description: z.string().optional(), dataType: inputAttributeDataType.optional(), order: z.number().int().optional(), urn: ruleAttributeUrn.optional(), correlationId: correlationIdResponse.optional(), hideDq: z.boolean().optional()}); export const ruleInputGroupResponse = z.object({name: z.string().optional(), order: z.number().int().optional(), urn: ruleInputGroupUrn.optional(), correlationId: correlationIdResponse.optional(), inputs: z.record(z.string(), ruleInputAttributeResponse).optional(), joined: z.boolean().optional()}); export const dqDimensionUrn = z.string(); export const dqDimensionResultUrn = z.string(); export const ruleFallback = z.object({resultUrn: dqDimensionResultUrn.optional(), score: z.number().int().optional(), explanation: z.string().optional()}); export const ruleConditionExpression = z.object({stringExpression: z.string().optional()}); export const ruleConditionUrn = z.string(); export const ruleConditionResponse = z.object({order: z.number().int().optional(), name: z.string().optional(), resultUrn: dqDimensionResultUrn.optional(), expression: ruleConditionExpression.optional(), score: z.number().int().optional(), urn: ruleConditionUrn, correlationId: correlationIdResponse.optional(), aggregated: z.boolean().optional(), enabled: z.boolean().optional()}); export const ruleInputAttributeRef = z.object({inputGroupName: z.string().optional(), attributeName: z.string()}); export const groupByInputResponse = z.union([z.object({correlationId: correlationIdResponse.optional(), attribute: ruleInputAttributeRef, variable: z.string().optional()}), z.object({correlationId: correlationIdResponse.optional(), attribute: ruleInputAttributeRef.optional(), variable: z.string()})]); export const ruleImplementationResponse = z.object({ruleType: z.string().optional(), dqDimensionUrn: dqDimensionUrn.optional(), fallback: ruleFallback.optional(), conditions: z.record(z.string(), ruleConditionResponse).optional(), groupByInputs: z.record(z.string(), groupByInputResponse).optional()}); export const ruleParameterUrn = z.string(); export const ruleParameterResponse = z.object({name: z.string().optional(), order: z.number().int().optional(), dataType: inputAttributeDataType.optional(), extendedType: z.string().optional(), urn: ruleParameterUrn, correlationId: correlationIdResponse.optional()}); export const ruleVariableUrn = z.string(); export const dqTransformationUrn = z.string(); export const dqTransformationInstanceResponse = z.object({order: z.number().int().optional(), transformationUrn: dqTransformationUrn, correlationId: correlationIdResponse.optional()}); export const ruleVariableResponse = z.object({name: z.string().optional(), variableType: z.string().optional(), input: ruleInputAttributeRef.optional(), urn: ruleVariableUrn, correlationId: correlationIdResponse.optional(), expression: z.string().optional(), transformations: z.record(z.string(), dqTransformationInstanceResponse).optional()}); export const ruleUrn = z.string(); export const ruleResponse = z.object({draftType: z.string(), name: z.string().optional(), description: z.string().nullable().optional(), defaultDqThreshold: dqThresholdResponse.nullable().optional(), stewardship: z.object({groupUrn: groupUrn.optional()}).nullable().optional(), inputGroups: z.record(z.string(), ruleInputGroupResponse).nullable().optional(), implementation: ruleImplementationResponse.nullable().optional(), parameters: z.record(z.string(), ruleParameterResponse).nullable().optional(), variables: z.record(z.string(), ruleVariableResponse).nullable().optional(), urn: ruleUrn}); export const getApiDataQualityV1RulesResponse = z.object({meta: paginationMetadata, data: z.array(ruleResponse)}); 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 rules * * GET /data-quality/v1/rules */ export const getApiDataQualityV1Rules = async (args: GetApiDataQualityV1RulesArgs, options?: GetApiDataQualityV1RulesOptions) => { const {baseUrl = "https://your-environment.ataccama.one/api", fetch: fetchFn = fetch, JWT} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.after != null) query.append("after", String(args.after)) if (args.size != null) query.append("size", String(args.size)) if (args.sort != null) query.append("sort", String(args.sort)) if (JWT !== undefined) headers.set('authorization', `Bearer ${JWT}`) const url = `${baseUrl.replace(/\/+$/, '')}/data-quality/v1/rules${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(getApiDataQualityV1RulesResponse, await res.json()) };