import {z} from 'zod' export type GetApiRestApi2FieldFieldIdScreensArgs = {fieldId: string, startAt?: number | undefined, maxResults?: number | undefined, expand?: string | undefined}; export type GetApiRestApi2FieldFieldIdScreensOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const avatarUrlsBean = z.object({"16x16": z.string().optional(), "24x24": z.string().optional(), "32x32": z.string().optional(), "48x48": z.string().optional()}); export const updatedProjectCategory = z.object({description: z.string().optional(), id: z.string().optional(), name: z.string().optional(), self: z.string().optional()}); export const projectDetails = z.object({avatarUrls: avatarUrlsBean.optional(), id: z.string().optional(), key: z.string().optional(), name: z.string().optional(), projectCategory: updatedProjectCategory.optional(), projectTypeKey: z.enum(["software", "service_desk", "business", "product_discovery"]).optional(), self: z.string().optional(), simplified: z.boolean().optional()}); export const scope = z.object({project: projectDetails.optional(), type: z.enum(["PROJECT", "TEMPLATE"]).optional()}).and(z.record(z.string(), z.unknown())); export const screenableTab = z.object({id: z.number().int().optional(), name: z.string()}); export const screenWithTab = z.object({description: z.string().optional(), id: z.number().int().optional(), name: z.string().optional(), scope: scope.optional(), tab: screenableTab.optional()}); export const pageBeanScreenWithTab = z.object({isLast: z.boolean().optional(), maxResults: z.number().int().optional(), nextPage: z.string().optional(), self: z.string().optional(), startAt: z.number().int().optional(), total: z.number().int().optional(), values: z.array(screenWithTab).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 screens for a field * * GET /rest/api/2/field/{fieldId}/screens * * Also accepts auth: OAuth2 */ export const getApiRestApi2FieldFieldIdScreens = async (args: GetApiRestApi2FieldFieldIdScreensArgs, options?: GetApiRestApi2FieldFieldIdScreensOptions) => { const {baseUrl = "https://your-domain.atlassian.net", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.startAt != null) query.append("startAt", String(args.startAt)) if (args.maxResults != null) query.append("maxResults", String(args.maxResults)) if (args.expand != null) query.append("expand", String(args.expand)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/rest/api/2/field/${encodeURIComponent(String(args.fieldId))}/screens${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(pageBeanScreenWithTab, await res.json()) };