import {z} from 'zod' export type GetApiApiPlansPlanIdArgs = {planId: string}; export type GetApiApiPlansPlanIdOptions = {baseUrl: string, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const planMobileDevice = z.object({deviceArn: z.string().optional(), deviceName: z.string().optional(), os: z.string().nullable().optional(), formFactor: z.string().optional(), userDeviceId: z.string().optional()}); export const caseAppInfo = z.object({uploadArn: z.string(), uploadType: z.enum(["own_app", "existing", "sample"]), appName: z.string().nullable(), bundleId: z.string().optional()}); export const planMobilePlatformConfig = z.object({devices: z.array(planMobileDevice), uploadArn: z.string().optional(), uploadType: z.enum(["own_app", "existing", "sample"]).optional(), appName: z.string().optional(), bundleId: z.string().optional(), apps: z.array(caseAppInfo).optional()}); export const planMobileConfig = z.object({ios: planMobilePlatformConfig.nullable().optional(), android: planMobilePlatformConfig.nullable().optional()}); export const planDesktopDevice = z.object({userDeviceId: z.string(), name: z.string(), platform: z.enum(["windows", "macos", "linux"]), os: z.string().nullable()}); export const planDesktopConfig = z.object({devices: z.array(planDesktopDevice)}); export const planDetail = z.object({id: z.string(), projectId: z.string(), title: z.string(), description: z.string().nullable().optional(), apiEnabled: z.boolean(), executionMode: z.enum(["parallel", "sequential"]), stopOnFailure: z.boolean(), deviceMode: z.enum(["pool", "matrix"]), mobileConfig: planMobileConfig.nullable(), desktopConfig: planDesktopConfig.nullable(), variables: z.array(z.object({name: z.string(), value: z.string(), isSecret: z.boolean()})), caseCount: z.number().int(), archivedAt: z.string().nullable().optional(), createdAt: z.string(), updatedAt: z.string(), createdBy: z.object({id: z.string().optional(), name: z.string().nullable().optional(), email: z.string().optional()}).nullable().optional(), project: z.object({id: z.string().optional(), name: z.string().optional()}).nullable().optional(), cases: z.array(z.object({id: z.string(), order: z.number().int(), type: z.enum(["web", "mobile", "desktop", "multi_device"]), title: z.string().nullable(), lastStatus: z.string().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 }; /** * Get a test plan * * GET /api/plans/{planId} */ export const getApiApiPlansPlanId = async (args: GetApiApiPlansPlanIdArgs, options: GetApiApiPlansPlanIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKeyAuth !== undefined) headers.set("x-api-key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/plans/${encodeURIComponent(String(args.planId))}${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(planDetail, await res.json()) };