import {z} from 'zod' export type GetApiTemplatesIdFieldsArgs = {id: string}; export type GetApiTemplatesIdFieldsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const dateFormatRules = z.object({dateFormat: z.enum(["MM/dd/yyyy", "dd/MM/yyyy", "yyyy-MM-dd", "MMMM dd, yyyy", "MMM dd, yyyy", "dd MMMM yyyy"]).optional(), fontSize: z.number().int().gte(8).lte(48).optional()}); export const fieldValidationRules = z.record(z.string(), z.unknown()).nullable(); export const templateField = z.object({id: z.string(), type: z.enum(["text", "signature", "date", "checkbox", "dropdown", "radio_buttons", "number", "text_area", "file", "initial", "stamp", "approval_signature", "approval_checkmark", "approval_date"]), required: z.boolean().optional(), recipient_id: z.string().nullable().optional(), variable_name: z.string().nullable().optional(), variable_defined_name: z.string().nullable().optional(), position: z.object({x: z.number().gte(0).lte(100).optional(), y: z.number().gte(0).lte(100).optional(), width: z.number().gte(0).lte(100).optional(), height: z.number().gte(0).lte(100).optional()}).optional(), page_number: z.number().int().gte(1).nullable(), dropdown_options: z.union([z.array(z.string()), z.object({})]).nullable().optional(), multi_group_id: z.string().nullable().optional(), date_default: z.string().nullable().optional(), date_signing_default: z.boolean().optional(), format_rules: dateFormatRules.optional(), validation_rules: fieldValidationRules.optional(), read_only: z.boolean().optional(), read_only_value: z.string().nullable().optional()}); export const templateFieldListResponse = z.object({results: z.array(templateField)}); 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 template fields * * GET /templates/{id}/fields */ export const getApiTemplatesIdFields = async (args: GetApiTemplatesIdFieldsArgs, options?: GetApiTemplatesIdFieldsOptions) => { const {baseUrl = "https://api.firma.dev/functions/v1/signing-request-api", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("Authorization", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/templates/${encodeURIComponent(String(args.id))}/fields${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(templateFieldListResponse, await res.json()) };