import {z} from 'zod' export type QuizUpdateRequest = {name?: string | undefined, description_html?: string | undefined, passing_percentage_correct?: number | undefined, max_attempts?: number | undefined, require_correct_response?: boolean | undefined, randomize_questions?: boolean | undefined, limit_question_count?: number | undefined, randomize_answers?: boolean | undefined, show_results_on_failure?: boolean | undefined, show_question_feedback?: boolean | undefined, time_limit_seconds?: (number | null) | undefined, skip_start_screen?: (boolean | null) | undefined, alignment?: ('left' | 'center' | 'right') | undefined}; export type QuizBatchUpdateData = {type: 'quizzes', id: string, attributes: QuizUpdateRequest}; export type QuizBatchUpdateRequestEnvelope = {data: Array}; export type PatchApiV2QuizzesArgs = {body: QuizBatchUpdateRequestEnvelope}; export type PatchApiV2QuizzesOptions = {baseUrl: string, JWTAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const quizAttributes = z.object({name: z.string(), description_html: z.string().optional(), passing_percentage_correct: z.number().int(), max_attempts: z.number().int(), require_correct_response: z.boolean(), randomize_questions: z.boolean(), limit_question_count: z.number().int(), randomize_answers: z.boolean(), show_results_on_failure: z.boolean(), show_question_feedback: z.boolean(), time_limit_seconds: z.number().int().nullable().optional(), skip_start_screen: z.boolean().nullable().optional(), alignment: z.enum(["left", "center", "right"]), external_id: z.string(), created_at: z.string(), modified_at: z.string()}); export const quizResource = z.object({type: z.literal("quizzes").optional(), id: z.string(), attributes: quizAttributes, links: z.record(z.string(), z.unknown()).nullable().optional()}); export const batchSucceededItemQuizResource = z.object({status: z.literal("succeeded").optional(), id: z.string().nullable().optional(), result: quizResource}); export const batchItemError = z.object({code: z.enum(["duplicate_email", "duplicate_in_batch", "duplicate_name", "validation_error", "not_found", "internal_error", "not_in_domain", "already_enrolled", "already_published", "already_in_path"]), source: z.record(z.string(), z.unknown()).nullable().optional(), detail: z.string().nullable().optional()}); export const batchFailedItem = z.object({status: z.literal("failed").optional(), id: z.string().nullable().optional(), error: batchItemError}); export const batchSummary = z.object({total: z.number().int().gte(0), succeeded: z.number().int().gte(0), failed: z.number().int().gte(0)}); export const batchResultEnvelopeQuizResource = z.object({data: z.array(z.union([batchSucceededItemQuizResource, batchFailedItem])), summary: batchSummary}); 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 }; /** * Update quizzes * * PATCH /v2/quizzes/ */ export const patchApiV2Quizzes = async (args: PatchApiV2QuizzesArgs, options: PatchApiV2QuizzesOptions) => { const {baseUrl, fetch: fetchFn = fetch, JWTAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/vnd.api+json") if (JWTAuth !== undefined) headers.set('authorization', `Bearer ${JWTAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/quizzes/${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "PATCH", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(batchResultEnvelopeQuizResource, await res.json()) };