import {z} from 'zod' export type VehicleExtensionType = Array<'onboardCapabilities' | 'branding' | 'pictures'>; export type GetApiVehiclesVinArgs = {vin: string, locale?: string | undefined, extension?: VehicleExtensionType | undefined}; export type GetApiVehiclesVinOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, ClientId?: string | undefined, fetch?: typeof fetch | undefined}; export const onboardCapabilities = z.object({data: z.array(z.enum(["data:vehicle:devices:pnc", "data:telemetry", "data:telemetry:environment", "data:telemetry:privacy", "data:telemetry:vehicle", "data:telemetry:vehicle:ignition", "data:telemetry:vehicle:preconditioning", "data:telemetry:vehicle:energies", "data:telemetry:vehicle:engines", "data:telemetry:vehicle:doorsState", "data:telemetry:vehicle:powertrain", "data:telemetry:vehicle:battery", "data:telemetry:vehicle:safety", "data:telemetry:vehicle:odometer", "data:telemetry:vehicle:kinetic", "data:telemetry:vehicle:transmission", "data:telemetry:vehicle:adas", "data:telemetry:vehicle:lightingSystem", "data:telemetry:vehicle:maintenance", "data:telemetry:vehicle:drivingBehavior", "data:telemetry:vehicle:wipingBlades", "data:telemetry:vehicle:alarm", "data:position", "data:trip", "data:alert", "data:collision"])).optional(), remote: z.object({preconditioning: z.object({supported: z.boolean(), scopeName: z.literal("remote:preconditioning:write"), parameters: z.object({programs: z.object({size: z.number().int()}).optional(), immediate: z.boolean().optional()})}), charging: z.object({supported: z.boolean(), scopeName: z.literal("remote:charging:write"), parameters: z.object({immediate: z.object({start: z.boolean().optional(), stop: z.boolean().optional()}).optional(), schedule: z.object({programs: z.object({supported: z.boolean(), size: z.number().int().optional()}), nextDelayedTime: z.boolean()}).optional(), preferences: z.object({level: z.boolean().optional(), type: z.boolean().optional()}).optional()})}), door: z.object({supported: z.boolean(), scopeName: z.literal("remote:door:write")}), horn: z.object({supported: z.boolean(), scopeName: z.literal("remote:horn:write")}), lights: z.object({supported: z.boolean(), scopeName: z.literal("remote:lights:write")}), wakeup: z.object({supported: z.boolean(), scopeName: z.literal("remote:wakeup:write")}), navigation: z.object({supported: z.boolean(), scopeName: z.literal("remote:navigation:write")}), stolen: z.object({supported: z.boolean().optional()})}).optional()}); export const vehicleBranding = z.object({brand: z.string().optional(), label: z.string().optional()}); export const url = z.string(); export const vehiclePictures = z.array(url); export const vehicleExtension = z.object({onboardCapabilities: onboardCapabilities.optional(), branding: vehicleBranding.optional(), pictures: vehiclePictures.optional()}); export const vehicleCapabilities = z.object({vin: z.string(), motorization: z.enum(["Electric", "Hybrid", "Thermic", "Hydrogen"]).optional(), _embedded: z.object({extension: vehicleExtension.optional()}).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 }; /** * List of vehicles characteristics & capabilities * * GET /vehicles/{vin} */ export const getApiVehiclesVin = async (args: GetApiVehiclesVinArgs, options?: GetApiVehiclesVinOptions) => { const {baseUrl = "https://api-cert.groupe-psa.com/connectedcar/v3", fetch: fetchFn = fetch, BasicAuth, ClientId} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/hal+json ") if (args.locale != null) query.append("locale", String(args.locale)) for (const item of args.extension ?? []) query.append("extension", String(item)) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) if (ClientId !== undefined) query.set("client_id", ClientId) const url = `${baseUrl.replace(/\/+$/, '')}/vehicles/${encodeURIComponent(String(args.vin))}${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(vehicleCapabilities, await res.json()) };