import {z} from 'zod' export type GetApiRestAgile10BoardBoardIdBacklogArgs = {boardId: number, startAt?: number | undefined, maxResults?: number | undefined, jql?: string | undefined, validateQuery?: boolean | undefined, fields?: Array> | undefined, expand?: string | undefined}; export type GetApiRestAgile10BoardBoardIdBacklogOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const linkGroup: z.ZodType = z.object({groups: z.array(z.lazy(() => linkGroup)).optional(), header: z.object({href: z.string().optional(), iconClass: z.string().optional(), id: z.string().optional(), label: z.string().optional(), styleClass: z.string().optional(), title: z.string().optional(), weight: z.number().int().optional()}).optional(), id: z.string().optional(), links: z.array(z.object({href: z.string().optional(), iconClass: z.string().optional(), id: z.string().optional(), label: z.string().optional(), styleClass: z.string().optional(), title: z.string().optional(), weight: z.number().int().optional()})).optional(), styleClass: z.string().optional(), weight: z.number().int().optional()}); export const operations = z.object({linkGroups: z.array(linkGroup).optional()}).and(z.record(z.string(), z.unknown())); export const issueBean = z.object({changelog: z.object({histories: z.array(z.object({author: z.object({accountId: z.string().max(128).optional(), accountType: z.string().optional(), active: z.boolean().optional(), avatarUrls: z.object({"16x16": z.string().optional(), "24x24": z.string().optional(), "32x32": z.string().optional(), "48x48": z.string().optional()}).optional(), displayName: z.string().optional(), emailAddress: z.string().optional(), key: z.string().optional(), name: z.string().optional(), self: z.string().optional(), timeZone: z.string().optional()}).optional(), created: z.string().optional(), historyMetadata: z.object({activityDescription: z.string().optional(), activityDescriptionKey: z.string().optional(), actor: z.object({avatarUrl: z.string().optional(), displayName: z.string().optional(), displayNameKey: z.string().optional(), id: z.string().optional(), type: z.string().optional(), url: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional(), cause: z.object({avatarUrl: z.string().optional(), displayName: z.string().optional(), displayNameKey: z.string().optional(), id: z.string().optional(), type: z.string().optional(), url: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional(), description: z.string().optional(), descriptionKey: z.string().optional(), emailDescription: z.string().optional(), emailDescriptionKey: z.string().optional(), extraData: z.record(z.string(), z.string()).optional(), generator: z.object({avatarUrl: z.string().optional(), displayName: z.string().optional(), displayNameKey: z.string().optional(), id: z.string().optional(), type: z.string().optional(), url: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional(), type: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional(), id: z.string().optional(), items: z.array(z.object({field: z.string().optional(), fieldId: z.string().optional(), fieldtype: z.string().optional(), from: z.string().optional(), fromString: z.string().optional(), to: z.string().optional(), toString: z.string().optional()})).optional()})).optional(), maxResults: z.number().int().optional(), startAt: z.number().int().optional(), total: z.number().int().optional()}).optional(), editmeta: z.object({fields: z.record(z.string(), z.object({allowedValues: z.array(z.unknown()).optional(), autoCompleteUrl: z.string().optional(), configuration: z.record(z.string(), z.unknown()).optional(), defaultValue: z.unknown(), hasDefaultValue: z.boolean().optional(), key: z.string(), name: z.string(), operations: z.array(z.string()), required: z.boolean(), schema: z.object({configuration: z.record(z.string(), z.unknown()).optional(), custom: z.string().optional(), customId: z.number().int().optional(), items: z.string().optional(), system: z.string().optional(), type: z.string()})})).optional()}).optional(), expand: z.string().optional(), fields: z.record(z.string(), z.unknown()).optional(), fieldsToInclude: z.object({actuallyIncluded: z.array(z.string()).optional(), excluded: z.array(z.string()).optional(), included: z.array(z.string()).optional()}).optional(), id: z.string().optional(), key: z.string().optional(), names: z.record(z.string(), z.string()).optional(), operations: operations.optional(), properties: z.record(z.string(), z.unknown()).optional(), renderedFields: z.record(z.string(), z.unknown()).optional(), schema: z.record(z.string(), z.object({configuration: z.record(z.string(), z.unknown()).optional(), custom: z.string().optional(), customId: z.number().int().optional(), items: z.string().optional(), system: z.string().optional(), type: z.string()})).optional(), self: z.string().optional(), transitions: z.array(z.object({expand: z.string().optional(), fields: z.record(z.string(), z.object({allowedValues: z.array(z.unknown()).optional(), autoCompleteUrl: z.string().optional(), configuration: z.record(z.string(), z.unknown()).optional(), defaultValue: z.unknown(), hasDefaultValue: z.boolean().optional(), key: z.string(), name: z.string(), operations: z.array(z.string()), required: z.boolean(), schema: z.object({configuration: z.record(z.string(), z.unknown()).optional(), custom: z.string().optional(), customId: z.number().int().optional(), items: z.string().optional(), system: z.string().optional(), type: z.string()})})).optional(), hasScreen: z.boolean().optional(), id: z.string().optional(), isAvailable: z.boolean().optional(), isConditional: z.boolean().optional(), isGlobal: z.boolean().optional(), isInitial: z.boolean().optional(), looped: z.boolean().optional(), name: z.string().optional(), to: z.object({description: z.string().optional(), iconUrl: z.string().optional(), id: z.string().optional(), name: z.string().optional(), scope: z.object({project: z.object({avatarUrls: z.object({"16x16": z.string().optional(), "24x24": z.string().optional(), "32x32": z.string().optional(), "48x48": z.string().optional()}).optional(), id: z.string().optional(), key: z.string().optional(), name: z.string().optional(), projectCategory: z.object({description: z.string().optional(), id: z.string().optional(), name: z.string().optional(), self: z.string().optional()}).optional(), projectTypeKey: z.enum(["software", "service_desk", "business"]).optional(), self: z.string().optional(), simplified: z.boolean().optional()}).optional(), type: z.enum(["PROJECT", "TEMPLATE"]).optional()}).and(z.record(z.string(), z.unknown())).optional(), self: z.string().optional(), statusCategory: z.object({colorName: z.string().optional(), id: z.number().int().optional(), key: z.string().optional(), name: z.string().optional(), self: z.string().optional()}).and(z.record(z.string(), z.unknown())).optional()}).and(z.record(z.string(), z.unknown())).optional()}).and(z.record(z.string(), z.unknown()))).optional(), versionedRepresentations: z.record(z.string(), z.record(z.string(), z.unknown())).optional()}); export const searchResults = z.object({expand: z.string().optional(), issues: z.array(issueBean).optional(), maxResults: z.number().int().optional(), names: z.record(z.string(), z.string()).optional(), schema: z.record(z.string(), z.object({configuration: z.record(z.string(), z.unknown()).optional(), custom: z.string().optional(), customId: z.number().int().optional(), items: z.string().optional(), system: z.string().optional(), type: z.string()})).optional(), startAt: z.number().int().optional(), total: z.number().int().optional(), warningMessages: z.array(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 }; /** * Get issues for backlog * * GET /rest/agile/1.0/board/{boardId}/backlog * * Also accepts auth: OAuth2 */ export const getApiRestAgile10BoardBoardIdBacklog = async (args: GetApiRestAgile10BoardBoardIdBacklogArgs, options?: GetApiRestAgile10BoardBoardIdBacklogOptions) => { 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.jql != null) query.append("jql", String(args.jql)) if (args.validateQuery != null) query.append("validateQuery", String(args.validateQuery)) for (const item of args.fields ?? []) query.append("fields", String(item)) 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/agile/1.0/board/${encodeURIComponent(String(args.boardId))}/backlog${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(searchResults, await res.json()) };