import {z} from 'zod' export type GetApiTeamTeamKeyMediaYearArgs = {'If-None-Match'?: string | undefined, team_key: string, year: number}; export type GetApiTeamTeamKeyMediaYearOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const mediaAvatar = z.object({type: z.literal("avatar"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({base64Image: z.string()}).optional()}); export const mediaCdPhotoThread = z.object({type: z.literal("cdphotothread"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({image_partial: z.string()}).optional()}); export const mediaCdThread = z.object({type: z.literal("cd-thread"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({thread_title: z.string(), image_url: z.string().nullable()}).optional()}); export const mediaGrabCad = z.object({type: z.literal("grabcad"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({model_created: z.string().nullable(), model_description: z.string().nullable(), model_image: z.string(), model_name: z.string()}).optional()}); export const mediaNoDetails = z.object({type: z.enum(["youtube", "imgur", "facebook-profile", "youtube-channel", "twitter-profile", "github-profile", "instagram-profile", "periscope-profile", "gitlab-profile", "instagram-image", "external-link"]), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({}).optional()}); export const mediaOnshape = z.object({type: z.literal("onshape"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({model_created: z.string().nullable(), model_description: z.string().nullable(), model_image: z.string(), model_name: z.string()}).optional()}); export const mediaSmugmugAlbum = z.object({type: z.literal("smugmug-album"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({cover_url: z.string(), cover_url_med: z.string(), cover_url_sm: z.string(), image_count: z.number().int(), title: z.string(), web_uri: z.string()}).optional()}); export const mediaSmugmugPhoto = z.object({type: z.literal("smugmug-photo"), foreign_key: z.string(), preferred: z.boolean().optional(), team_keys: z.array(z.string()), direct_url: z.string().optional(), view_url: z.string().optional(), details: z.object({caption: z.string(), image_url: z.string(), image_url_med: z.string(), image_url_sm: z.string(), title: z.string(), web_uri: z.string()}).optional()}); export const media = z.discriminatedUnion("type", [mediaAvatar, mediaCdPhotoThread, mediaCdThread, mediaGrabCad, mediaNoDetails, mediaOnshape, mediaSmugmugAlbum, mediaSmugmugPhoto]); export const getApiTeamTeamKeyMediaYearResponse = z.array(media); 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 }; /** * Gets a list of Media (videos / pictures) for the given team and year. * * GET /team/{team_key}/media/{year} */ export const getApiTeamTeamKeyMediaYear = async (args: GetApiTeamTeamKeyMediaYearArgs, options?: GetApiTeamTeamKeyMediaYearOptions) => { const {baseUrl = "https://www.thebluealliance.com/api/v3", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['If-None-Match'] != null) headers.set("If-None-Match", String(args['If-None-Match'])) if (apiKey !== undefined) headers.set("X-TBA-Auth-Key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/team/${encodeURIComponent(String(args.team_key))}/media/${encodeURIComponent(String(args.year))}${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(getApiTeamTeamKeyMediaYearResponse, await res.json()) };