import {z} from 'zod' export type Identifier = string; export type GetApiV3CollectionsArgs = {workspace: Identifier}; export type GetApiV3CollectionsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const identifier = z.string(); export const organizationRole = z.enum(["admin", "member"]); export const paletteColorOptions = z.object({main: z.string(), light: z.string().optional(), dark: z.string().optional(), contrastText: z.string().optional()}); export const themeConfig = z.object({palette: z.object({mode: z.enum(["light", "dark"]).optional(), background: z.union([z.string(), z.object({default: z.string().optional(), paper: z.string().optional()})]).optional(), text: z.object({primary: z.string().optional(), secondary: z.string().optional(), disabled: z.string().optional()}).optional(), divider: z.string().optional(), primary: paletteColorOptions.optional(), secondary: paletteColorOptions.optional(), success: paletteColorOptions.optional(), annotation: paletteColorOptions.optional(), error: paletteColorOptions.optional(), info: paletteColorOptions.optional(), warning: paletteColorOptions.optional()}).optional(), typography: z.object({fontFamily: z.string().optional(), fontSize: z.union([z.string(), z.number()]).optional(), fontWeightRegular: z.string().optional(), fontWeightMedium: z.string().optional(), fontWeightBold: z.string().optional()}).optional(), borderRadius: z.number().optional(), fontUrl: z.string().optional()}); export const organization = z.object({identifier: z.string(), name: z.string(), userRole: organizationRole.nullable(), avatar: z.string().nullable(), resthookSignatureKey: z.string().nullable(), isTrial: z.boolean(), validationToolConfig: z.object({theme: themeConfig.optional(), hideActions: z.boolean().optional(), hideCollection: z.boolean().optional(), hideEditPages: z.boolean().optional(), hideExport: z.boolean().optional(), hideFilename: z.boolean().optional(), hideShowRawValues: z.boolean().optional(), hideReject: z.boolean().optional(), hideReparse: z.boolean().optional(), hideRunOcr: z.boolean().optional(), hideTags: z.boolean().optional(), hideWarnings: z.boolean().optional(), restrictDocumentSplitting: z.boolean().optional(), disableCurrencyFormatting: z.boolean().optional(), disableEditDocumentMetadata: z.boolean().optional(), disableManualAnnotationEditing: z.boolean().optional(), hideDocumentStatus: z.boolean().optional()}).nullable(), showCustomFieldCreation: z.boolean(), allowDataSourceRecordCreation: z.boolean()}); export const name = z.string(); export const extractorPropertiesIdentifier = z.string(); export const namePlural = z.string(); export const validatable = z.boolean(); export const isCustom = z.boolean(); export const createdDt = z.string(); export const annotationContentType = z.enum(["text", "integer", "float", "decimal", "date", "datetime", "daterange", "boolean", "enum", "location", "phonenumber", "json", "table", "expectedremuneration", "jobtitle", "language", "skill", "yearsexperience", "group", "table_deprecated", "url", "image", "docclf"]); export const fieldDeprecated: z.ZodType = z.object({label: z.string(), slug: z.string().nullable().optional(), fieldType: annotationContentType, dataSource: z.string().nullable().optional(), mapping: z.string().nullable().optional(), dataPoint: z.string(), mandatory: z.boolean().optional(), disabled: z.boolean().optional(), autoValidationThreshold: z.number().nullable().optional(), showDropdown: z.boolean().optional(), displayRawText: z.boolean().optional(), dropNull: z.boolean().optional(), displayEnumValue: z.boolean().optional(), fields: z.array(z.lazy(() => fieldDeprecated)).optional()}).and(z.record(z.string(), z.unknown())); export const fieldGroup = z.object({label: z.string(), fields: z.array(fieldDeprecated)}); export const extractor = z.object({identifier: z.string(), name: z.string(), namePlural: z.string(), baseExtractor: z.object({identifier: extractorPropertiesIdentifier, name: name, namePlural: namePlural, validatable: validatable, isCustom: isCustom.optional(), createdDt: createdDt.optional()}).nullable().optional(), organization: organization.optional(), category: z.string().nullable().optional(), validatable: z.boolean(), isCustom: z.boolean().optional(), fieldGroups: z.array(fieldGroup).nullable().optional(), createdDt: z.string().optional(), lastTrainedDt: z.string().nullable().optional()}); export const field: z.ZodType = z.object({label: z.string(), dataPoint: z.string(), fieldType: annotationContentType, dataSource: z.string().nullable().optional(), mapping: z.string().nullable().optional(), mandatory: z.boolean().optional(), autoValidationThreshold: z.number().gte(0).lte(1).nullable().optional(), enableAutoValidationThreshold: z.boolean().nullable().optional(), showDropdown: z.boolean().optional(), displayEnumValue: z.boolean().optional(), hideEnumDetail: z.boolean().optional(), dropNull: z.boolean().optional(), enabledChildFields: z.array(z.lazy(() => field)).optional(), disabledChildFields: z.array(z.lazy(() => field)).optional(), slug: z.string().nullable().optional(), displayRawText: z.boolean().optional(), fields: z.array(z.object({})).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const fieldCategory = z.object({label: z.string(), enabledFields: z.array(field), disabledFields: z.array(field)}); export const fieldsLayout = z.object({defaultCategory: fieldCategory, categories: z.array(fieldCategory)}); export const redactConfig = z.object({redactHeadshot: z.boolean().optional(), redactPersonalDetails: z.boolean().optional(), redactWorkDetails: z.boolean().optional(), redactReferees: z.boolean().optional(), redactEducationDetails: z.boolean().optional(), redactLocations: z.boolean().optional(), redactDates: z.boolean().optional(), redactGender: z.boolean().optional()}); export const extractorConfig = z.object({resumeRedact: redactConfig.optional()}).nullable(); export const collection = z.object({identifier: z.string(), name: z.string().optional(), workspace: z.object({identifier: identifier.optional(), organization: organization.optional(), name: name.optional()}).optional(), extractor: extractor.optional(), autoValidationThreshold: z.number().optional(), enableAutoValidationThreshold: z.boolean().optional(), autoValidateIfValidationRulesPass: z.boolean().optional(), fields: z.array(fieldGroup).nullable().optional(), fieldsLayout: fieldsLayout.optional(), fieldsConfigured: z.boolean().optional(), dateFormatPreference: z.enum(["DMY", "MDY", "YMD"]).nullable().optional(), dateFormatFromDocument: z.boolean().nullable().optional(), extractorConfig: extractorConfig.optional(), unvalidatedDocsCount: z.number().int().gte(0).nullable().optional(), confirmedDocsCount: z.number().int().gte(0).nullable().optional(), ingestEmail: z.string().optional(), tailoredExtractorRequested: z.boolean().optional(), allowOpenai: z.boolean().optional(), trainsExtractor: z.boolean().optional(), disableConfirmationIfValidationRulesFail: z.boolean().optional(), autoRefreshValidationResults: z.boolean().optional()}); export const getApiV3CollectionsResponse = z.array(collection); 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 }; /** * Get list of all collections * * GET /v3/collections */ export const getApiV3Collections = async (args: GetApiV3CollectionsArgs, options?: GetApiV3CollectionsOptions) => { const {baseUrl = "https://api.affinda.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.workspace != null) query.append("workspace", String(args.workspace)) if (ApiKeyAuth !== undefined) headers.set('authorization', `Bearer ${ApiKeyAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v3/collections${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(getApiV3CollectionsResponse, await res.json()) };