import {z} from 'zod' export type GetApiDevicesArgs = {deviceName?: string | undefined, os?: string | undefined, osVersion?: string | undefined, deviceType?: string | undefined}; export type GetApiDevicesOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const deviceDescriptor = z.object({id: z.string(), name: z.string(), modelNumber: z.string().optional(), manufacturer: z.array(z.string()).optional(), os: z.enum(["ANDROID", "IOS"]), osVersion: z.string(), apiLevel: z.number().int().optional(), abiType: z.string().optional(), screenSize: z.number().optional(), resolutionWidth: z.number().int().optional(), resolutionHeight: z.number().int().optional(), dpi: z.number().int().optional(), dpiName: z.string().optional(), pixelsPerPoint: z.number().int().optional(), isTablet: z.boolean().optional(), isArm: z.boolean().optional(), isPrivate: z.boolean().optional(), hasOnScreenButtons: z.boolean().optional(), internalOrientation: z.enum(["PORTRAIT", "LANDSCAPE"]).optional(), defaultOrientation: z.enum(["PORTRAIT", "LANDSCAPE"]).optional(), ramSize: z.number().int().optional(), internalStorageSize: z.number().int().optional(), sdCardSize: z.number().int().optional(), cpuCores: z.number().int().optional(), cpuFrequency: z.number().int().optional(), cpuType: z.enum(["ARM", "X86"]).optional(), deviceFamily: z.enum(["ANY", "IPHONE", "IPAD"]).optional(), supportsMockLocations: z.boolean().optional(), supportsAppiumWebAppTesting: z.boolean().optional(), supportsGlobalProxy: z.boolean().optional(), supportsMinicapSocketConnection: z.boolean().optional(), supportsManualWebTesting: z.boolean().optional(), supportsMultiTouch: z.boolean().optional(), supportsXcuiTest: z.boolean().optional(), isKeyGuardDisabled: z.boolean().optional(), isRooted: z.boolean().optional(), isAlternativeIoEnabled: z.boolean().optional()}); export const getApiDevicesResponse = z.array(deviceDescriptor); 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 }; /** * List all device descriptors elegible for AccessAPI * * GET /devices */ export const getApiDevices = async (args: GetApiDevicesArgs, options?: GetApiDevicesOptions) => { const {baseUrl = "https://api.us-west-1.saucelabs.com/rdc/v2", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.deviceName != null) query.append("deviceName", String(args.deviceName)) if (args.os != null) query.append("os", String(args.os)) if (args.osVersion != null) query.append("osVersion", String(args.osVersion)) if (args.deviceType != null) query.append("deviceType", String(args.deviceType)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/devices${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(getApiDevicesResponse, await res.json()) };