import {z} from 'zod' export type GetApiExamsResultsSchoolSummaryArgs = {includeOtherCentres: boolean, year?: (number | null) | undefined, bypassLockdown: boolean, page: number, pageSize: number, includes?: (Array | null) | undefined, sort?: (string | null) | undefined, filter?: (string | null) | undefined}; export type GetApiExamsResultsSchoolSummaryOptions = {baseUrl?: string | undefined, JWTBearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const examGradeCountView = z.object({level: z.string().nullable().optional(), grade: z.string().nullable().optional(), count: z.number().int().optional(), percent: z.number().optional(), cumulativePercent: z.number().optional(), order: z.number().int().optional()}); export const examLevelSummaryView = z.object({level: z.string().nullable().optional(), entries: z.number().int().optional(), candidates: z.number().int().optional(), unclassified: z.number().int().optional(), topGradeCount: z.number().int().optional(), topGradePercent: z.number().optional(), highGradeCount: z.number().int().optional(), highGradePercent: z.number().optional(), passCount: z.number().int().optional(), passPercent: z.number().optional(), averagePoints: z.number().optional(), topGradeLabel: z.string().nullable().optional(), highGradeLabel: z.string().nullable().optional(), passLabel: z.string().nullable().optional()}); export const examSubjectSummaryView = z.object({level: z.string().nullable().optional(), subject: z.string().nullable().optional(), entries: z.number().int().optional(), topGradeCount: z.number().int().optional(), topGradePercent: z.number().optional(), passCount: z.number().int().optional(), passPercent: z.number().optional(), averagePoints: z.number().optional()}); export const examCandidateBandView = z.object({topGrades: z.number().int().optional(), candidates: z.number().int().optional()}); export const examCandidateSummaryView = z.object({level: z.string().nullable().optional(), candidates: z.number().int().optional(), averageEntries: z.number().optional(), averagePointsPerCandidate: z.number().optional(), averagePointsPerEntry: z.number().optional(), cleanSweepCandidates: z.number().int().optional(), cleanSweepPercent: z.number().optional(), noTopGradeCandidates: z.number().int().optional(), topGradeSpread: z.array(examCandidateBandView).optional()}); export const examHouseSummaryView = z.object({level: z.string().nullable().optional(), house: z.string().nullable().optional(), entries: z.number().int().optional(), candidates: z.number().int().optional(), topGradeCount: z.number().int().optional(), topGradePercent: z.number().optional(), passCount: z.number().int().optional(), passPercent: z.number().optional(), averagePoints: z.number().optional()}); export const examYearTrendView = z.object({year: z.number().int().optional(), level: z.string().nullable().optional(), entries: z.number().int().optional(), topGradePercent: z.number().optional(), passPercent: z.number().optional(), averagePoints: z.number().optional()}); export const examSetting = z.object({id: z.number().int().optional(), examType: z.string().nullable().optional(), visibleToStudents: z.string().nullable().optional(), visibleToStaff: z.string().nullable().optional(), visibleToParents: z.string().nullable().optional(), dateToDisplay: z.string().optional(), saving: z.boolean().optional(), currentlyVisible: z.boolean().optional()}); export const meta = z.object({page: z.number().int().optional(), pageSize: z.number().int().optional(), total: z.number().int().optional()}); export const getSchoolExamResultsSummaryResponse = z.object({year: z.number().int().nullable().optional(), availableYears: z.array(z.number().int()).optional(), gradeDistribution: z.array(examGradeCountView).optional(), levelSummaries: z.array(examLevelSummaryView).optional(), subjectSummaries: z.array(examSubjectSummaryView).optional(), candidateSummaries: z.array(examCandidateSummaryView).optional(), houseSummaries: z.array(examHouseSummaryView).optional(), yearTrend: z.array(examYearTrendView).optional(), examSettings: z.array(examSetting).optional(), lockdownBypassed: z.boolean().optional(), hiddenLevels: z.array(z.string()).optional(), currentDateTime: z.string().nullable().optional(), currentDateTimeUtc: z.string().nullable().optional(), meta: meta.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 }; /** * Get whole-School exam analytics * * GET /Exams/Results/School/Summary */ export const getApiExamsResultsSchoolSummary = async (args: GetApiExamsResultsSchoolSummaryArgs, options?: GetApiExamsResultsSchoolSummaryOptions) => { const {baseUrl = "https://api.tonbridge.school", fetch: fetchFn = fetch, JWTBearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.includeOtherCentres != null) query.append("includeOtherCentres", String(args.includeOtherCentres)) if (args.year != null) query.append("year", String(args.year)) if (args.bypassLockdown != null) query.append("bypassLockdown", String(args.bypassLockdown)) if (args.page != null) query.append("page", String(args.page)) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) for (const item of args.includes ?? []) query.append("includes", String(item)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.filter != null) query.append("filter", String(args.filter)) if (JWTBearerAuth !== undefined) headers.set('authorization', `Bearer ${JWTBearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/Exams/Results/School/Summary${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(getSchoolExamResultsSummaryResponse, await res.json()) };