import {z} from 'zod' export type GetApiRestApi3DashboardDashboardIdGadgetArgs = {dashboardId: number, moduleKey?: Array | undefined, uri?: Array | undefined, gadgetId?: Array | undefined}; export type GetApiRestApi3DashboardDashboardIdGadgetOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const dashboardGadgetPosition = z.object({"The column position of the gadget.": z.number().int(), "The row position of the gadget.": z.number().int()}); export const dashboardGadget = z.object({color: z.enum(["blue", "red", "yellow", "green", "cyan", "purple", "gray", "white"]), id: z.number().int(), moduleKey: z.string().optional(), position: dashboardGadgetPosition, title: z.string(), uri: z.string().optional()}); export const dashboardGadgetResponse = z.object({gadgets: z.array(dashboardGadget)}); 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 gadgets * * GET /rest/api/3/dashboard/{dashboardId}/gadget * * Also accepts auth: OAuth2 */ export const getApiRestApi3DashboardDashboardIdGadget = async (args: GetApiRestApi3DashboardDashboardIdGadgetArgs, options?: GetApiRestApi3DashboardDashboardIdGadgetOptions) => { 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") for (const item of args.moduleKey ?? []) query.append("moduleKey", String(item)) for (const item of args.uri ?? []) query.append("uri", String(item)) for (const item of args.gadgetId ?? []) query.append("gadgetId", String(item)) if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/rest/api/3/dashboard/${encodeURIComponent(String(args.dashboardId))}/gadget${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(dashboardGadgetResponse, await res.json()) };