import {z} from 'zod' export type GetApiTestplanArgs = {q?: string | undefined}; export type GetApiTestplanOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const testPlan = z.object({id: z.number().int().gte(0).optional(), title: z.string().optional(), is_deleted: z.boolean().optional(), project_id: z.number().int().gte(0).optional(), created_at: z.string().optional(), created_by: z.number().optional(), modified_at: z.string().optional(), modified_by: z.number().optional(), deleted_at: z.string().optional(), deleted_by: z.number().optional(), description: z.string().optional(), $testrun_count: z.number().optional(), $last_testrun_created: z.object({}).optional(), $open_testrun_count: z.number().optional(), $query_count: z.number().optional()}); export const getApiTestplanResponse = z.object({data: z.array(testPlan), meta: z.object({count: z.number().int(), limit: z.number().int().optional(), offset: z.number().int(), totalCount: z.number().int().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 }; /** * Find 'TestPlan' entities using the specified (query) parameters * * GET /testplan */ export const getApiTestplan = async (args: GetApiTestplanArgs, options?: GetApiTestplanOptions) => { const {baseUrl = "https://app.testiny.io/api/v1", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.q != null) query.append("q", String(args.q)) if (ApiKeyAuth !== undefined) headers.set("X-Api-Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/testplan${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(getApiTestplanResponse, await res.json()) };