import {z} from 'zod' export type GetApiV1BadgeAssertionBadgeAssertionIdOpenBadgesArgs = {badge_assertion_id: number, version?: string | undefined, format?: string | undefined, 'X-Access-Token'?: (string | null) | undefined}; export type GetApiV1BadgeAssertionBadgeAssertionIdOpenBadgesOptions = {baseUrl: string, OAuth2PasswordBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const openBadgeRecipient = z.object({type: z.string().optional(), hashed: z.boolean().optional(), salt: z.string().nullable().optional(), identity: z.string()}); export const openBadgeImage = z.object({id: z.string()}); export const openBadgeCriteria = z.object({id: z.string(), narrative: z.string()}); export const openBadgeIssuer = z.object({id: z.string(), "@context": z.string().optional(), type: z.string().optional(), name: z.string(), url: z.string(), email: z.string(), description: z.string().nullable().optional(), image: z.string().nullable().optional()}); export const openBadgeAlignment = z.object({targetName: z.string(), targetUrl: z.string(), targetDescription: z.string(), targetFramework: z.string().nullable().optional(), targetCode: z.string().nullable().optional()}); export const openBadge = z.object({"@context": z.string().optional(), type: z.string().optional(), id: z.string().optional(), name: z.string().optional(), description: z.string().optional(), image: openBadgeImage.nullable().optional(), criteria: openBadgeCriteria.nullable().optional(), tags: z.array(z.string()).nullable().optional(), issuer: openBadgeIssuer, alignment: z.array(openBadgeAlignment).nullable().optional()}); export const openBadgeVerification = z.object({type: z.string().optional(), url: z.string()}); export const evidenceType = z.enum(["UrlEvidence", "PlainTextEvidence", "IdEvidence", "KeyValueGroupEvidence"]); export const openBadgeAssertionEvidence = z.object({type: evidenceType.nullable(), id: z.string().nullable(), narrative: z.string().nullable(), name: z.string().nullable(), description: z.string().nullable(), genre: z.string().nullable(), audience: z.string().nullable()}); export const openBadgeAssertion = z.object({id: z.string(), "@context": z.string().optional(), type: z.string().optional(), recipient: openBadgeRecipient, badge: openBadge, verification: openBadgeVerification, issuedOn: z.string(), image: openBadgeImage.nullable().optional(), evidence: z.array(openBadgeAssertionEvidence).nullable().optional(), narrative: z.string().nullable().optional(), expires: z.string().nullable().optional(), revoked: z.boolean().optional(), revocationReason: 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 }; /** * Read Open Badge Assertion * * GET /v1/badge_assertion/{badge_assertion_id}/open_badges */ export const getApiV1BadgeAssertionBadgeAssertionIdOpenBadges = async (args: GetApiV1BadgeAssertionBadgeAssertionIdOpenBadgesArgs, options: GetApiV1BadgeAssertionBadgeAssertionIdOpenBadgesOptions) => { const {baseUrl, fetch: fetchFn = fetch, OAuth2PasswordBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.version != null) query.append("version", String(args.version)) if (args.format != null) query.append("format", String(args.format)) if (args['X-Access-Token'] != null) headers.set("X-Access-Token", String(args['X-Access-Token'])) if (OAuth2PasswordBearer !== undefined) headers.set('authorization', `Bearer ${OAuth2PasswordBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/badge_assertion/${encodeURIComponent(String(args.badge_assertion_id))}/open_badges${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(openBadgeAssertion, await res.json()) };