import {z} from 'zod' export type DataEditingScanRequest = {dataset_name: string, version?: (string | null) | undefined, columns?: (Array | null) | undefined, threshold?: number | undefined}; export type CreateApiV1DataEditingScanPiiArgs = {body: DataEditingScanRequest}; export type CreateApiV1DataEditingScanPiiOptions = {baseUrl: string, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const pIIFinding = z.object({row_index: z.number().int(), column: z.string(), entity_type: z.string(), text: z.string(), start: z.number().int(), end: z.number().int(), score: z.number()}); export const scanPhaseTimings = z.object({resolve_ms: z.number(), load_ms: z.number(), prepare_ms: z.number(), scan_ms: z.number(), pre_scan_ms: z.number()}); export const dataEditingScanResponse = z.object({success: z.boolean(), dataset_name: z.string(), dataset_version: z.string(), scan_type: z.enum(["pii", "phd"]), scan_status: z.enum(["scanned", "degraded", "unavailable"]), unscanned_cells: z.number().int(), total_cells: z.number().int(), findings_count: z.number().int(), affected_rows: z.number().int(), findings: z.array(pIIFinding), phases: scanPhaseTimings.nullable().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 }; /** * Scan For Pii * * POST /v1/data-editing/scan-pii * * Also accepts auth: BearerAuth */ export const createApiV1DataEditingScanPii = async (args: CreateApiV1DataEditingScanPiiArgs, options: CreateApiV1DataEditingScanPiiOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("X-API-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/data-editing/scan-pii${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(dataEditingScanResponse, await res.json()) };