import {z} from 'zod' export type GetApiV1ElementsDataArgs = {page?: number | undefined, limit?: number | undefined}; export type GetApiV1ElementsDataOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const elementsTags = z.array(z.string()).nullable(); export const elementsCheckGroup = z.object({name: z.string(), tags: elementsTags.optional(), activated: z.boolean()}).nullable(); export const elementsPerformanceStat = z.object({currentPeriod: z.number().nullable().optional()}); export const elementsPeriodMetrics = z.object({availability: elementsPerformanceStat.optional(), responseTimeP95: elementsPerformanceStat.optional(), responseTimeP99: elementsPerformanceStat.optional()}); export const elementsResponseTimes = z.object({avg: z.number().nullable().optional(), p95: z.number().nullable().optional(), p99: z.number().nullable().optional()}); export const elementsMetrics = z.object({"1dSuccessRatio": z.number().optional(), "1d": elementsPeriodMetrics.optional(), responseTimes: elementsResponseTimes.optional()}).nullable(); export const elementsCheckStatus = z.object({hasFailures: z.boolean(), hasErrors: z.boolean().nullable().optional(), isDegraded: z.boolean(), created_at: z.string().nullable().optional(), updated_at: z.string().nullable().optional(), metrics: elementsMetrics.optional()}).nullable(); export const elementsCheck = z.object({id: z.string(), name: z.string(), checkType: z.string(), frequency: z.number().nullable().optional(), activated: z.boolean(), muted: z.boolean(), tags: elementsTags.optional(), created_at: z.string().nullable(), isSample: z.boolean().nullable().optional(), group: elementsCheckGroup.optional(), status: elementsCheckStatus.optional()}); export const elementsResults = z.array(elementsCheck); export const elementsSummary = z.object({total: z.number().int(), totalPassing: z.number().int(), totalFailing: z.number().int(), totalDegraded: z.number().int(), totalDeactivated: z.number().int()}); export const elementsDataResponse = z.object({results: elementsResults, summary: elementsSummary}); 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 }; /** * Read a bounded check snapshot allowed by an Elements token * * GET /v1/elements-data */ export const getApiV1ElementsData = async (args: GetApiV1ElementsDataArgs, options?: GetApiV1ElementsDataOptions) => { const {baseUrl = "https://api.checklyhq.com", fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.limit != null) query.append("limit", String(args.limit)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/elements-data${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(elementsDataResponse, await res.json()) };