import {z} from 'zod' export type GetApiV3ModelsArgs = {sort_by?: ('createdAt' | '-createdAt' | 'viewCount' | '-viewCount' | 'likedAt' | '-likedAt') | undefined, user?: string | undefined, tags?: Array | undefined, categories?: Array | undefined, liked_by?: string | undefined, max_face_count?: number | undefined, max_vertex_count?: number | undefined, published_since?: string | undefined, staffpicked?: boolean | undefined, downloadable?: boolean | undefined, animated?: boolean | undefined, has_sound?: boolean | undefined, restricted?: boolean | undefined, archives_flavours?: boolean | undefined, available_archive_type?: string | undefined, archives_max_size?: number | undefined, archives_max_face_count?: number | undefined, archives_max_vertex_count?: number | undefined, archives_max_texture_count?: number | undefined, archives_texture_max_resolution?: number | undefined}; export type GetApiV3ModelsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const tagRelated = z.object({slug: z.string().optional(), uri: z.string().optional()}); export const categoriesRelated = z.object({uri: z.string().optional(), uid: z.string().optional(), name: z.string().optional(), slug: z.string().optional()}); export const avatarRelated = z.object({images: z.array(z.object({url: z.string().optional(), width: z.number().int().optional(), height: z.number().int().optional(), size: z.number().int().optional()})).optional(), uid: z.string().optional(), uri: z.string().optional()}); export const userRelated = z.object({username: z.string().optional(), profileUrl: z.string().optional(), account: z.string().optional(), displayName: z.string().optional(), uid: z.string().optional(), uri: z.string().optional(), avatar: avatarRelated.optional()}); export const thumbnailsRelated = z.object({images: z.array(z.object({url: z.string().optional(), width: z.number().int().optional(), size: z.number().int().nullable().optional(), uid: z.string().optional(), height: z.number().int().optional()})).optional()}); export const archiveNested = z.object({faceCount: z.number().int().optional(), textureCount: z.number().int().optional(), size: z.number().int().optional(), vertexCount: z.number().int().optional(), textureMaxResolution: z.number().int().optional()}); export const modelList = z.object({uid: z.string().optional(), tags: z.array(tagRelated).optional(), viewerUrl: z.string().optional(), isProtected: z.boolean().optional(), price: z.number().int().optional(), categories: z.array(categoriesRelated).optional(), publishedAt: z.string().optional(), likeCount: z.number().int().optional(), commentCount: z.number().int().optional(), viewCount: z.number().int().optional(), vertexCount: z.number().int().optional(), user: userRelated.optional(), isDownloadable: z.boolean().optional(), description: z.string().nullable().optional(), animationCount: z.number().int().optional(), name: z.string().optional(), license: z.string().optional(), soundCount: z.number().int().optional(), isAgeRestricted: z.boolean().optional(), uri: z.string().optional(), faceCount: z.number().int().optional(), staffpickedAt: z.string().nullable().optional(), createdAt: z.string().optional(), thumbnails: thumbnailsRelated.optional(), embedUrl: z.string().optional(), archives: z.object({source: archiveNested.optional(), glb: archiveNested.optional(), usdz: archiveNested.optional(), gltf: archiveNested.optional()}).optional()}); export const modelResponse = z.object({results: z.array(modelList).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 }; /** * Returns a public, published list of models. * * GET /v3/models */ export const getApiV3Models = async (args: GetApiV3ModelsArgs, options?: GetApiV3ModelsOptions) => { const {baseUrl = "https://api.sketchfab.com", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.sort_by != null) query.append("sort_by", String(args.sort_by)) if (args.user != null) query.append("user", String(args.user)) for (const item of args.tags ?? []) query.append("tags", String(item)) for (const item of args.categories ?? []) query.append("categories", String(item)) if (args.liked_by != null) query.append("liked_by", String(args.liked_by)) if (args.max_face_count != null) query.append("max_face_count", String(args.max_face_count)) if (args.max_vertex_count != null) query.append("max_vertex_count", String(args.max_vertex_count)) if (args.published_since != null) query.append("published_since", String(args.published_since)) if (args.staffpicked != null) query.append("staffpicked", String(args.staffpicked)) if (args.downloadable != null) query.append("downloadable", String(args.downloadable)) if (args.animated != null) query.append("animated", String(args.animated)) if (args.has_sound != null) query.append("has_sound", String(args.has_sound)) if (args.restricted != null) query.append("restricted", String(args.restricted)) if (args.archives_flavours != null) query.append("archives_flavours", String(args.archives_flavours)) if (args.available_archive_type != null) query.append("available_archive_type", String(args.available_archive_type)) if (args.archives_max_size != null) query.append("archives_max_size", String(args.archives_max_size)) if (args.archives_max_face_count != null) query.append("archives_max_face_count", String(args.archives_max_face_count)) if (args.archives_max_vertex_count != null) query.append("archives_max_vertex_count", String(args.archives_max_vertex_count)) if (args.archives_max_texture_count != null) query.append("archives_max_texture_count", String(args.archives_max_texture_count)) if (args.archives_texture_max_resolution != null) query.append("archives_texture_max_resolution", String(args.archives_texture_max_resolution)) const url = `${baseUrl.replace(/\/+$/, '')}/v3/models${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(modelResponse, await res.json()) };