import {z} from 'zod' export type GetApiResourcesIdUpdatesArgs = {page?: number | undefined}; export type GetApiResourcesIdUpdatesOptions = {baseUrl?: string | undefined, XFOAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const attachment = z.object({filename: z.string().optional(), file_size: z.number().int().optional(), height: z.number().int().optional(), width: z.number().int().optional(), thumbnail_url: z.string().optional(), retina_thumbnail_url: z.string().optional(), direct_url: z.string().optional(), is_video: z.boolean().optional(), is_audio: z.boolean().optional(), attachment_id: z.number().int().optional(), content_type: z.string().optional(), content_id: z.number().int().optional(), attach_date: z.number().int().optional(), view_count: z.number().int().optional()}); export const xFRMResourcePrefix = z.object({prefix_id: z.number().int().optional(), title: z.string().optional(), description: z.string().optional(), usage_help: z.string().optional(), is_usable: z.boolean().optional(), prefix_group_id: z.number().int().optional(), display_order: z.number().int().optional(), materialized_order: z.number().int().optional()}); export const xFRMCategory = z.object({prefixes: z.array(xFRMResourcePrefix).optional(), custom_fields: z.array(z.object({})).optional(), can_add: z.boolean().optional(), can_upload_images: z.boolean().optional(), view_url: z.string().optional(), resource_category_id: z.number().int().optional(), title: z.string().optional(), description: z.string().optional(), resource_count: z.number().int().optional(), last_update: z.number().int().optional(), last_resource_title: z.string().optional(), last_resource_id: z.number().int().optional(), allow_local: z.boolean().optional(), allow_external: z.boolean().optional(), allow_commercial_external: z.boolean().optional(), allow_fileless: z.boolean().optional(), min_tags: z.number().int().optional(), enable_versioning: z.boolean().optional(), enable_support_url: z.boolean().optional(), parent_category_id: z.number().int().optional(), display_order: z.number().int().optional()}); export const user = z.object({about: z.string().optional(), activity_visible: z.boolean().optional(), age: z.number().int().optional(), alert_optout: z.array(z.unknown()).optional(), allow_post_profile: z.string().optional(), allow_receive_news_feed: z.string().optional(), allow_send_personal_conversation: z.string().optional(), allow_view_identities: z.string().optional(), allow_view_profile: z.string().optional(), avatar_urls: z.object({}).optional(), profile_banner_urls: z.object({}).optional(), can_ban: z.boolean().optional(), can_converse: z.boolean().optional(), can_edit: z.boolean().optional(), can_follow: z.boolean().optional(), can_ignore: z.boolean().optional(), can_post_profile: z.boolean().optional(), can_view_profile: z.boolean().optional(), can_view_profile_posts: z.boolean().optional(), can_warn: z.boolean().optional(), content_show_signature: z.boolean().optional(), creation_watch_state: z.string().optional(), custom_fields: z.object({}).optional(), custom_title: z.string().optional(), dob: z.object({}).optional(), email: z.string().optional(), email_on_conversation: z.boolean().optional(), gravatar: z.string().optional(), interaction_watch_state: z.boolean().optional(), is_admin: z.boolean().optional(), is_banned: z.boolean().optional(), is_discouraged: z.boolean().optional(), is_followed: z.boolean().optional(), is_ignored: z.boolean().optional(), is_moderator: z.boolean().optional(), is_super_admin: z.boolean().optional(), last_activity: z.number().int().optional(), location: z.string().optional(), push_on_conversation: z.boolean().optional(), push_optout: z.array(z.unknown()).optional(), receive_admin_email: z.boolean().optional(), secondary_group_ids: z.array(z.unknown()).optional(), show_dob_date: z.boolean().optional(), show_dob_year: z.boolean().optional(), signature: z.string().optional(), timezone: z.string().optional(), use_tfa: z.boolean().optional(), user_group_id: z.number().int().optional(), user_state: z.string().optional(), user_title: z.string().optional(), visible: z.boolean().optional(), warning_points: z.number().int().optional(), website: z.string().optional(), view_url: z.string().optional(), user_id: z.number().int().optional(), username: z.string().optional(), message_count: z.number().int().optional(), question_solution_count: z.number().int().optional(), register_date: z.number().int().optional(), trophy_points: z.number().int().optional(), is_staff: z.boolean().optional(), reaction_score: z.number().int().optional(), vote_score: z.number().int().optional()}); export const xFRMResourceItem = z.object({username: z.string().optional(), description: z.string().optional(), description_parsed: z.string().optional(), description_attach_count: z.number().int().optional(), DescriptionAttachments: z.array(attachment).optional(), reaction_score: z.number().int().optional(), update_count: z.number().int().optional(), review_count: z.number().int().optional(), current_download_url: z.string().optional(), current_files: z.array(z.object({})).optional(), external_purchase_url: z.string().optional(), is_watching: z.boolean().optional(), icon_url: z.string().optional(), version: z.string().optional(), custom_fields: z.object({}).optional(), tags: z.array(z.string()).optional(), prefix: z.string().optional(), can_edit: z.boolean().optional(), can_edit_tags: z.boolean().optional(), can_edit_icon: z.boolean().optional(), can_soft_delete: z.boolean().optional(), can_hard_delete: z.boolean().optional(), can_download: z.boolean().optional(), can_view_description_attachments: z.boolean().optional(), view_url: z.string().optional(), resource_id: z.number().int().optional(), title: z.string().optional(), tag_line: z.string().optional(), user_id: z.number().int().optional(), resource_state: z.string().optional(), resource_type: z.string().optional(), resource_date: z.number().int().optional(), resource_category_id: z.number().int().optional(), external_url: z.string().optional(), price: z.number().optional(), currency: z.string().optional(), view_count: z.number().int().optional(), download_count: z.number().int().optional(), rating_count: z.number().int().optional(), rating_avg: z.number().optional(), rating_weighted: z.number().optional(), last_update: z.number().int().optional(), alt_support_url: z.string().optional(), prefix_id: z.number().int().optional(), featured: z.boolean().optional(), Category: xFRMCategory.optional(), User: user.optional()}); export const xFRMResourceUpdate = z.object({Resource: xFRMResourceItem.optional(), Attachments: z.array(attachment).optional(), message_parsed: z.string().optional(), can_edit: z.boolean().optional(), can_soft_delete: z.boolean().optional(), can_hard_delete: z.boolean().optional(), can_react: z.boolean().optional(), can_view_attachments: z.boolean().optional(), view_url: z.string().optional(), is_reacted_to: z.boolean().optional(), visitor_reaction_id: z.number().int().optional(), resource_update_id: z.number().int().optional(), resource_id: z.number().int().optional(), title: z.string().optional(), message: z.string().optional(), message_state: z.string().optional(), post_date: z.number().int().optional(), attach_count: z.number().int().optional(), warning_message: z.string().optional(), last_edit_date: z.number().int().optional(), reaction_score: z.number().int().optional()}); export const pagination = z.object({current_page: z.number().int().optional(), last_page: z.number().int().optional(), per_page: z.number().int().optional(), shown: z.number().int().optional(), total: z.number().int().optional()}); export const getApiResourcesIdUpdatesResponse = z.object({updates: z.array(xFRMResourceUpdate).optional(), pagination: pagination.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 a page of updates for the specified resource * * GET /resources/{id}/updates * * Also accepts auth: XF-Api-Key */ export const getApiResourcesIdUpdates = async (args: GetApiResourcesIdUpdatesArgs, options?: GetApiResourcesIdUpdatesOptions) => { const {baseUrl = "https://example.com/api", fetch: fetchFn = fetch, XFOAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (XFOAuth2 !== undefined) headers.set('authorization', `Bearer ${XFOAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/resources/${encodeURIComponent(String(args.id))}/updates${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(getApiResourcesIdUpdatesResponse, await res.json()) };