import {z} from 'zod' export type DashboardGadgetPosition = {'The column position of the gadget.': number, 'The row position of the gadget.': number}; export type DashboardGadgetSettings = {color?: string | undefined, ignoreUriAndModuleKeyValidation?: boolean | undefined, moduleKey?: string | undefined, position?: DashboardGadgetPosition | undefined, title?: string | undefined, uri?: string | undefined}; export type CreateApiRestApi3DashboardDashboardIdGadgetArgs = {dashboardId: number, body: DashboardGadgetSettings}; export type CreateApiRestApi3DashboardDashboardIdGadgetOptions = {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 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 }; /** * Add gadget to dashboard * * POST /rest/api/3/dashboard/{dashboardId}/gadget * * Also accepts auth: OAuth2 */ export const createApiRestApi3DashboardDashboardIdGadget = async (args: CreateApiRestApi3DashboardDashboardIdGadgetArgs, options?: CreateApiRestApi3DashboardDashboardIdGadgetOptions) => { const {baseUrl = "https://your-domain.atlassian.net", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") 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: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(dashboardGadget, await res.json()) };