charness 0.0.0-stage → 3.1.0

package/dist/connectors/jira/client.d.ts

@@ -0,0 +1,522 @@
+import { z } from 'zod';
+import { type AdfAttributeValue, type AdfDocument } from './adf';
+/**
+ * @description The Jira Cloud REST v3 client of the Jira connector (plan J4,
+ * D13/D14): Node `fetch`, basic auth (the AI account's email + API token), a
+ * 30 s timeout per attempt, every response validated by a schema.
+ *
+ * Retries:
+ *  - 429 — Jira refused the request, so ANY request is retried after its
+ *    `Retry-After` (capped at 60 s), at most 3 attempts;
+ *  - 5xx / network error / timeout — retried with a jittered backoff, but only
+ *    for a request that is safe to repeat. A comment POST is never repeated: when
+ *    its request may have reached Jira (a timeout, a connection dropped
+ *    mid-response, a 5xx, an unreadable 2xx) `addComment` reports
+ *    `deliveryUnknown` instead (R18) — a second POST would post the answer
+ *    twice — and only a failure before anything was sent is an error;
+ *  - 401 / 403 — never retried: {@link JiraAuthError}, which the poller turns
+ *    into one loud line and a stop.
+ *
+ * Errors carry the method, the path and Jira's own messages — never the token.
+ */
+export declare const jiraRequestTimeoutMs = 30000;
+export declare const jiraMaxAttempts = 3;
+export declare const jiraRetryAfterCapMs = 60000;
+/** Backoff before the 2nd and 3rd attempt of a retryable 5xx / network failure. */
+export declare const jiraBackoffMs: readonly [1000, 4000];
+/** Up to this share is added at random to a backoff, so clients that failed together do not retry together. */
+export declare const jiraBackoffJitterRatio = 0.5;
+/** Jira's own page size for comments; the page actually returned decides where the next one starts. */
+export declare const jiraCommentPageSize = 100;
+/** Jira's largest changelog page. */
+export declare const jiraChangelogPageSize = 100;
+/** The most members of a group one `group/member` page holds; the page actually returned decides where the next one starts. */
+export declare const jiraGroupMemberPageSize = 50;
+/** The credentials were refused (401) or lack the permission (403). Never retried. */
+export declare class JiraAuthError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly requestPath: string;
+    constructor(status: number, method: string, requestPath: string);
+}
+/** Any other failed request, after its retries. `status` is 0 when no HTTP status applies: a network failure, a timeout, a response that is not the promised JSON. */
+export declare class JiraHttpError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly requestPath: string;
+    constructor(status: number, method: string, requestPath: string, detail: string);
+}
+declare const accountSchema: z.ZodObject<{
+    accountId: z.ZodString;
+    accountType: z.ZodOptional<z.ZodString>;
+    displayName: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const changelogHistorySchema: z.ZodObject<{
+    id: z.ZodString;
+    created: z.ZodString;
+    author: z.ZodOptional<z.ZodObject<{
+        accountId: z.ZodString;
+        accountType: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    items: z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        fieldId: z.ZodOptional<z.ZodString>;
+        from: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const commentSchema: z.ZodObject<{
+    id: z.ZodString;
+    author: z.ZodOptional<z.ZodObject<{
+        accountId: z.ZodString;
+        accountType: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    created: z.ZodString;
+    updated: z.ZodOptional<z.ZodString>;
+    updateAuthor: z.ZodOptional<z.ZodObject<{
+        accountId: z.ZodString;
+        accountType: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    visibility: z.ZodOptional<z.ZodObject<{
+        type: z.ZodString;
+        value: z.ZodString;
+        identifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    jsdPublic: z.ZodOptional<z.ZodBoolean>;
+    body: z.ZodOptional<z.ZodNullable<z.ZodType<import("./adf").AdfNode, unknown, z.core.$ZodTypeInternals<import("./adf").AdfNode, unknown>>>>;
+    renderedBody: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** An issue as another issue points at it: its parent, a sub-task, the far end of a link. */
+declare const issueReferenceSchema: z.ZodObject<{
+    key: z.ZodString;
+    fields: z.ZodOptional<z.ZodObject<{
+        summary: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const issueLinkSchema: z.ZodObject<{
+    type: z.ZodObject<{
+        inward: z.ZodString;
+        outward: z.ZodString;
+    }, z.core.$strip>;
+    inwardIssue: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        fields: z.ZodOptional<z.ZodObject<{
+            summary: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    outwardIssue: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+        fields: z.ZodOptional<z.ZodObject<{
+            summary: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const attachmentSchema: z.ZodObject<{
+    id: z.ZodString;
+    filename: z.ZodString;
+    mimeType: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodNumber>;
+    created: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodObject<{
+        accountId: z.ZodString;
+        accountType: z.ZodOptional<z.ZodString>;
+        displayName: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const issueSchema: z.ZodObject<{
+    id: z.ZodString;
+    key: z.ZodString;
+    fields: z.ZodObject<{
+        summary: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+        }, z.core.$strip>>;
+        issuetype: z.ZodOptional<z.ZodObject<{
+            name: z.ZodString;
+            hierarchyLevel: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        priority: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>>;
+        parent: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            key: z.ZodString;
+            fields: z.ZodOptional<z.ZodObject<{
+                summary: z.ZodOptional<z.ZodString>;
+                status: z.ZodOptional<z.ZodObject<{
+                    name: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+        subtasks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            fields: z.ZodOptional<z.ZodObject<{
+                summary: z.ZodOptional<z.ZodString>;
+                status: z.ZodOptional<z.ZodObject<{
+                    name: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+        issuelinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodObject<{
+                inward: z.ZodString;
+                outward: z.ZodString;
+            }, z.core.$strip>;
+            inwardIssue: z.ZodOptional<z.ZodObject<{
+                key: z.ZodString;
+                fields: z.ZodOptional<z.ZodObject<{
+                    summary: z.ZodOptional<z.ZodString>;
+                    status: z.ZodOptional<z.ZodObject<{
+                        name: z.ZodString;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+            outwardIssue: z.ZodOptional<z.ZodObject<{
+                key: z.ZodString;
+                fields: z.ZodOptional<z.ZodObject<{
+                    summary: z.ZodOptional<z.ZodString>;
+                    status: z.ZodOptional<z.ZodObject<{
+                        name: z.ZodString;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+        fixVersions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>>;
+        labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        components: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>>;
+        attachment: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            filename: z.ZodString;
+            mimeType: z.ZodOptional<z.ZodString>;
+            size: z.ZodOptional<z.ZodNumber>;
+            created: z.ZodOptional<z.ZodString>;
+            author: z.ZodOptional<z.ZodObject<{
+                accountId: z.ZodString;
+                accountType: z.ZodOptional<z.ZodString>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>>;
+        assignee: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            accountId: z.ZodString;
+            accountType: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        reporter: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            accountId: z.ZodString;
+            accountType: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        creator: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            accountId: z.ZodString;
+            accountType: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        created: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodType<import("./adf").AdfNode, unknown, z.core.$ZodTypeInternals<import("./adf").AdfNode, unknown>>>>;
+    }, z.core.$strip>;
+    renderedFields: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strip>>;
+    changelog: z.ZodOptional<z.ZodObject<{
+        startAt: z.ZodNumber;
+        maxResults: z.ZodNumber;
+        total: z.ZodNumber;
+        histories: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            created: z.ZodString;
+            author: z.ZodOptional<z.ZodObject<{
+                accountId: z.ZodString;
+                accountType: z.ZodOptional<z.ZodString>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>;
+            items: z.ZodArray<z.ZodObject<{
+                field: z.ZodString;
+                fieldId: z.ZodOptional<z.ZodString>;
+                from: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const searchResultSchema: z.ZodObject<{
+    issues: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        key: z.ZodString;
+        fields: z.ZodObject<{
+            summary: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+            }, z.core.$strip>>;
+            issuetype: z.ZodOptional<z.ZodObject<{
+                name: z.ZodString;
+                hierarchyLevel: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strip>>;
+            priority: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                name: z.ZodString;
+            }, z.core.$strip>>>;
+            parent: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                key: z.ZodString;
+                fields: z.ZodOptional<z.ZodObject<{
+                    summary: z.ZodOptional<z.ZodString>;
+                    status: z.ZodOptional<z.ZodObject<{
+                        name: z.ZodString;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            subtasks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                key: z.ZodString;
+                fields: z.ZodOptional<z.ZodObject<{
+                    summary: z.ZodOptional<z.ZodString>;
+                    status: z.ZodOptional<z.ZodObject<{
+                        name: z.ZodString;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            issuelinks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                type: z.ZodObject<{
+                    inward: z.ZodString;
+                    outward: z.ZodString;
+                }, z.core.$strip>;
+                inwardIssue: z.ZodOptional<z.ZodObject<{
+                    key: z.ZodString;
+                    fields: z.ZodOptional<z.ZodObject<{
+                        summary: z.ZodOptional<z.ZodString>;
+                        status: z.ZodOptional<z.ZodObject<{
+                            name: z.ZodString;
+                        }, z.core.$strip>>;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+                outwardIssue: z.ZodOptional<z.ZodObject<{
+                    key: z.ZodString;
+                    fields: z.ZodOptional<z.ZodObject<{
+                        summary: z.ZodOptional<z.ZodString>;
+                        status: z.ZodOptional<z.ZodObject<{
+                            name: z.ZodString;
+                        }, z.core.$strip>>;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            fixVersions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+            }, z.core.$strip>>>;
+            labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            components: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+            }, z.core.$strip>>>;
+            attachment: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                filename: z.ZodString;
+                mimeType: z.ZodOptional<z.ZodString>;
+                size: z.ZodOptional<z.ZodNumber>;
+                created: z.ZodOptional<z.ZodString>;
+                author: z.ZodOptional<z.ZodObject<{
+                    accountId: z.ZodString;
+                    accountType: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>>;
+            assignee: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                accountId: z.ZodString;
+                accountType: z.ZodOptional<z.ZodString>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            reporter: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                accountId: z.ZodString;
+                accountType: z.ZodOptional<z.ZodString>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            creator: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                accountId: z.ZodString;
+                accountType: z.ZodOptional<z.ZodString>;
+                displayName: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>>>;
+            created: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodNullable<z.ZodType<import("./adf").AdfNode, unknown, z.core.$ZodTypeInternals<import("./adf").AdfNode, unknown>>>>;
+        }, z.core.$strip>;
+        renderedFields: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+        changelog: z.ZodOptional<z.ZodObject<{
+            startAt: z.ZodNumber;
+            maxResults: z.ZodNumber;
+            total: z.ZodNumber;
+            histories: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                created: z.ZodString;
+                author: z.ZodOptional<z.ZodObject<{
+                    accountId: z.ZodString;
+                    accountType: z.ZodOptional<z.ZodString>;
+                    displayName: z.ZodOptional<z.ZodString>;
+                }, z.core.$strip>>;
+                items: z.ZodArray<z.ZodObject<{
+                    field: z.ZodString;
+                    fieldId: z.ZodOptional<z.ZodString>;
+                    from: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    nextPageToken: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    isLast: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const changelogPageSchema: z.ZodObject<{
+    startAt: z.ZodNumber;
+    maxResults: z.ZodNumber;
+    total: z.ZodNumber;
+    isLast: z.ZodOptional<z.ZodBoolean>;
+    values: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        created: z.ZodString;
+        author: z.ZodOptional<z.ZodObject<{
+            accountId: z.ZodString;
+            accountType: z.ZodOptional<z.ZodString>;
+            displayName: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        items: z.ZodArray<z.ZodObject<{
+            field: z.ZodString;
+            fieldId: z.ZodOptional<z.ZodString>;
+            from: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            to: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+declare const projectStatusSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+declare const remoteLinkSchema: z.ZodObject<{
+    object: z.ZodObject<{
+        url: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+declare const fieldDefinitionsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>>;
+/** `GET /group/bulk`: the groups of that name, each with the id that survives a rename. */
+declare const groupPageSchema: z.ZodObject<{
+    values: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        groupId: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type JiraAccount = z.infer<typeof accountSchema>;
+export type JiraChangelogHistory = z.infer<typeof changelogHistorySchema>;
+/** `rawFields` (every returned field's value as Jira sent it, by id) is filled in by `getIssue` only, never by a search. */
+export type JiraIssue = z.infer<typeof issueSchema> & {
+    rawFields?: Record<string, AdfAttributeValue>;
+};
+export type JiraComment = z.infer<typeof commentSchema>;
+export type JiraAttachment = z.infer<typeof attachmentSchema>;
+export type JiraIssueReference = z.infer<typeof issueReferenceSchema>;
+export type JiraIssueLink = z.infer<typeof issueLinkSchema>;
+export type JiraRemoteLink = z.infer<typeof remoteLinkSchema>;
+/** A field as `GET /field` lists it: its id and its display name. */
+export type JiraFieldDefinition = z.infer<typeof fieldDefinitionsSchema>[number];
+export type JiraSearchResult = z.infer<typeof searchResultSchema>;
+export type JiraChangelogPage = z.infer<typeof changelogPageSchema>;
+/** A status as `GET /project/{key}/statuses` lists it. */
+export type JiraProjectStatus = z.infer<typeof projectStatusSchema>;
+/** A group as `GET /group/bulk` lists it: its name and the id that stays when the name changes. */
+export type JiraGroup = z.infer<typeof groupPageSchema>['values'][number];
+/** @name JiraSearchRequest @description `POST /rest/api/3/search/jql` (D13). */
+export interface JiraSearchRequest {
+    jql: string;
+    fields: string[];
+    isChangelogExpanded: boolean;
+    maxResults: number;
+    nextPageToken?: string;
+}
+/**
+ * @name JiraCommentPostResult
+ * @description `created` — Jira returned the new comment's id; `deliveryUnknown`
+ * — the request may have created the comment but the response did not say so
+ * (R18). The answer sink reads the issue's comments to decide, never re-posts.
+ */
+export type JiraCommentPostResult = {
+    outcome: 'created';
+    id: string;
+} | {
+    outcome: 'deliveryUnknown';
+    reason: string;
+};
+export interface JiraClientOptions {
+    /** `https://<site>.atlassian.net`, or a loopback server in tests. */
+    baseUrl: string;
+    email: string;
+    apiToken: string;
+    fetchImpl?: typeof fetch;
+    sleepImpl?: (ms: number) => Promise<void>;
+    /** In [0, 1); the backoff jitter's source. */
+    randomImpl?: () => number;
+    timeoutMs?: number;
+    /** How long a download may deliver no data before it is aborted; defaults to {@link jiraDownloadStallTimeoutMs}. */
+    downloadStallTimeoutMs?: number;
+}
+export interface JiraClient {
+    getMyself(): Promise<{
+        accountId: string;
+    }>;
+    searchIssues(request: JiraSearchRequest): Promise<JiraSearchResult>;
+    /** A page of the issue's changelog, oldest first (Jira's order); `maxResults` defaults to Jira's own page size. */
+    getChangelogPage(issueKey: string, startAt: number, maxResults?: number): Promise<JiraChangelogPage>;
+    /** `expand` is Jira's own (`renderedFields`). The result carries every returned field's raw value (`rawFields`). */
+    getIssue(issueKey: string, fields: string[], expand?: string): Promise<JiraIssue>;
+    /** EVERY comment of the issue, oldest first, read page by page, each with its rendered HTML. */
+    getComments(issueKey: string): Promise<JiraComment[]>;
+    getRemoteLinks(issueKey: string): Promise<JiraRemoteLink[]>;
+    /** The site's fields (system and custom), to name an `extraFields` id and to tell an unknown one. */
+    getFields(): Promise<JiraFieldDefinition[]>;
+    /**
+     * Stream attachment `attachmentId`'s original into the NEW file `destinationPath` (any size, never held in
+     * memory); resolves the byte count. Fails with {@link JiraAuthError} on 401/403 and {@link JiraHttpError}
+     * otherwise (a stall included, status 0); the file is removed on failure.
+     */
+    downloadAttachment(attachmentId: string, destinationPath: string): Promise<number>;
+    addComment(issueKey: string, body: AdfDocument): Promise<JiraCommentPostResult>;
+    /** The issue's newest comments, newest first — R18's read-back after a post of unknown outcome. */
+    getRecentComments(issueKey: string, maxResults: number): Promise<JiraComment[]>;
+    assignIssue(issueKey: string, accountId: string): Promise<void>;
+    getProjectStatuses(projectKey: string): Promise<JiraProjectStatus[]>;
+    /** The group named EXACTLY `groupName`, or `null` when the site has none. Needs the Browse users and groups permission. */
+    getGroupByName(groupName: string): Promise<JiraGroup | null>;
+    /**
+     * EVERY active member of the group `groupId`, read page by page. A group that does not exist is a
+     * {@link JiraHttpError} with `status` 404; a missing permission is a {@link JiraAuthError}.
+     */
+    getGroupMembers(groupId: string): Promise<JiraAccount[]>;
+}
+/** One page of a read paged by `startAt`, as {@link checkIsLastOffsetPage} judges it. */
+export interface JiraOffsetPage {
+    isLast?: boolean;
+    total?: number;
+    pageItemCount: number;
+    /** Everything read so far, this page included. */
+    readItemCount: number;
+    /** The `maxResults` asked for. */
+    pageSize: number;
+}
+/** An empty page always ends a `startAt` read; else `isLast` does when Jira sends it, else `total`, else a page shorter than asked. */
+export declare function checkIsLastOffsetPage(page: JiraOffsetPage): boolean;
+export declare function createJiraClient(options: JiraClientOptions): JiraClient;
+export {};
+//# sourceMappingURL=client.d.ts.map

package/dist/connectors/jira/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/connectors/jira/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAuC,KAAK,iBAAiB,EAAE,KAAK,WAAW,EAAE,MAAM,OAAO,CAAC;AAEtG;;;;;;;;;;;;;;;;;;GAkBG;AAEH,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAC3C,eAAO,MAAM,eAAe,IAAI,CAAC;AACjC,eAAO,MAAM,mBAAmB,QAAS,CAAC;AAC1C,mFAAmF;AACnF,eAAO,MAAM,aAAa,uBAA0B,CAAC;AACrD,+GAA+G;AAC/G,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAC1C,uGAAuG;AACvG,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,qCAAqC;AACrC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AACzC,+HAA+H;AAC/H,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAW1C,sFAAsF;AACtF,qBAAa,aAAc,SAAQ,KAAK;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM;gBAArE,MAAM,EAAE,MAAM,EAAW,MAAM,EAAE,MAAM,EAAW,WAAW,EAAE,MAAM;CAI3F;AAaD,sKAAsK;AACtK,qBAAa,aAAc,SAAQ,KAAK;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM;IAAE,QAAQ,CAAC,WAAW,EAAE,MAAM;gBAArE,MAAM,EAAE,MAAM,EAAW,MAAM,EAAE,MAAM,EAAW,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAI3G;AAED,QAAA,MAAM,aAAa;;;;iBAMjB,CAAC;AAeH,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;iBAK1B,CAAC;AASH,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;iBAcjB,CAAC;AAOH,6FAA6F;AAC7F,QAAA,MAAM,oBAAoB;;;;;;;;iBAMxB,CAAC;AAEH,QAAA,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;iBAInB,CAAC;AAEH,QAAA,MAAM,gBAAgB;;;;;;;;;;;iBAOpB,CAAC;AAwBH,QAAA,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAYf,CAAC;AAEH,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKtB,CAAC;AAEH,QAAA,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;iBAMvB,CAAC;AAEH,QAAA,MAAM,mBAAmB;;;iBAAiD,CAAC;AAQ3E,QAAA,MAAM,gBAAgB;;;;;iBAEpB,CAAC;AAKH,QAAA,MAAM,sBAAsB;;;kBAA0D,CAAC;AAEvF,2FAA2F;AAC3F,QAAA,MAAM,eAAe;;;;;iBAEnB,CAAC;AAWH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACxD,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC1E,4HAA4H;AAC5H,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAAE,CAAC;AACxG,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AACxD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC9D,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AAC5D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAC9D,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AACjF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAClE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACpE,0DAA0D;AAC1D,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AACpE,mGAAmG;AACnG,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,gFAAgF;AAChF,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAAE,OAAO,EAAE,SAAS,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,iBAAiB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAExH,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oHAAoH;IACpH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAyDD,MAAM,WAAW,UAAU;IACzB,SAAS,IAAI,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC5C,YAAY,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpE,mHAAmH;IACnH,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrG,oHAAoH;IACpH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAClF,gGAAgG;IAChG,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IACtD,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC5D,qGAAqG;IACrG,SAAS,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC5C;;;;OAIG;IACH,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnF,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAChF,mGAAmG;IACnG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAChF,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IACrE,2HAA2H;IAC3H,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;IAC7D;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC1D;AAED,yFAAyF;AACzF,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,uIAAuI;AACvI,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAInE;AAeD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CA8NvE"}