import {z} from 'zod' export type GetApiDocumentsArgs = {limit?: number | undefined, offset?: number | undefined, language?: ('en' | 'ja' | 'zh-hans') | undefined, dcpDocumentIdStartsWith?: string | undefined, productId?: string | undefined, type?: string | undefined, subType?: string | undefined, category?: string | undefined, documentRevisionDateStart?: string | undefined, documentRevisionDateEnd?: string | undefined}; export type GetApiDocumentsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const document = z.object({agileId: z.string().optional(), dcpDocumentId: z.string().optional(), url: z.string().optional(), category: z.array(z.object({level: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]).optional(), title: z.string().optional()})).optional(), product: z.array(z.object({productId: z.string().optional(), type: z.enum(["Product", "Board & Kit", "Software Tool"]).optional(), title: z.string().optional(), nid: z.string().optional(), uuid: z.string().optional(), language: z.string().optional()})).optional(), title: z.string().optional(), type: z.string().optional(), subType: z.array(z.string()).optional(), fileType: z.string().optional(), secureDocument: z.boolean().optional(), revisionDate: z.string().optional(), wwwUpdateDate: z.string().optional(), language: z.string().optional(), nid: z.string().optional(), uuid: z.string().optional(), translation: z.array(z.object({language: z.string().optional(), dcpDocumentId: z.string().optional(), agileId: z.string().optional(), title: z.string().optional(), href: z.string().optional()})).optional(), published: z.boolean().optional(), featured: z.boolean().optional(), relationship: z.string().optional(), filename: z.string().optional(), disclaimer: z.array(z.object({dcpDocumentId: z.string().optional(), agileId: z.string().optional(), language: z.string().optional(), title: z.string().optional(), href: z.string().optional()})).optional(), myrenesasDocument: z.boolean().optional()}); export const getApiDocumentsResponse = z.object({data: z.array(document).optional(), pagination: z.object({offset: z.number().int().optional(), limit: z.number().int().optional(), total: z.number().int().optional(), has_more: z.boolean().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 }; /** * Get All Documents * * GET /documents */ export const getApiDocuments = async (args: GetApiDocumentsArgs, options?: GetApiDocumentsOptions) => { const {baseUrl = "https://api.renesas.com/web-data/v1", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.language != null) query.append("language", String(args.language)) if (args.dcpDocumentIdStartsWith != null) query.append("dcpDocumentIdStartsWith", String(args.dcpDocumentIdStartsWith)) if (args.productId != null) query.append("productId", String(args.productId)) if (args.type != null) query.append("type", String(args.type)) if (args.subType != null) query.append("subType", String(args.subType)) if (args.category != null) query.append("category", String(args.category)) if (args.documentRevisionDateStart != null) query.append("documentRevisionDateStart", String(args.documentRevisionDateStart)) if (args.documentRevisionDateEnd != null) query.append("documentRevisionDateEnd", String(args.documentRevisionDateEnd)) if (ApiKeyAuth !== undefined) headers.set("x-api-key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/documents${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(getApiDocumentsResponse, await res.json()) };