jira-datacenter-api-client 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,1929 @@
+/**
+ * A Jira project version (release).
+ */
+interface JiraVersion {
+    /** URL of the version resource */
+    self?: string;
+    /** Numeric string ID */
+    id?: string;
+    /** Version name */
+    name: string;
+    /** Version description */
+    description?: string;
+    /** Whether this version has been archived */
+    archived?: boolean;
+    /** Whether this version has been released */
+    released?: boolean;
+    /** Release date in `YYYY-MM-DD` format */
+    releaseDate?: string;
+    /** Whether the release date is overdue */
+    overdue?: boolean;
+    /** User-facing release date string */
+    userReleaseDate?: string;
+    /** Project ID this version belongs to */
+    projectId?: number;
+}
+/**
+ * Issue counts associated with a version.
+ */
+interface JiraVersionIssueCounts {
+    /** URL of the resource */
+    self: string;
+    /** Number of issues that use this version in the fixVersions field */
+    issuesFixedCount: number;
+    /** Number of issues that use this version in the affectedVersions field */
+    issuesAffectedCount: number;
+    /** Number of issues with a Fix Version of this version whose status is done */
+    issueCountWithCustomFieldsShowingVersion: number;
+    /** URL to query for a custom field showing this version */
+    customFieldUsage: Array<{
+        fieldName: string;
+        customFieldId: number;
+        issueCountWithVersionInCustomField: number;
+    }>;
+}
+/**
+ * Unresolved issue count for a version.
+ */
+interface JiraVersionUnresolvedIssueCount {
+    /** URL of the resource */
+    self: string;
+    /** Number of unresolved issues fixed in this version */
+    issuesUnresolvedCount: number;
+}
+
+/**
+ * Query parameters for user search.
+ */
+interface UserSearchParams {
+    /** Username to search for */
+    username?: string;
+    /** Maximum number of results to return */
+    maxResults?: number;
+    /** Index of the first result (0-based) */
+    startAt?: number;
+}
+/**
+ * A Jira user.
+ */
+interface JiraUser {
+    /** URL of the user resource */
+    self: string;
+    /** Unique key identifying the user */
+    key: string;
+    /** Username */
+    name: string;
+    /** Email address */
+    emailAddress: string;
+    /** Full display name */
+    displayName: string;
+    /** Whether the user account is active */
+    active: boolean;
+    /** User's time zone (e.g. `'America/New_York'`) */
+    timeZone?: string;
+    /** Avatar URLs keyed by size (e.g. `'16x16'`, `'48x48'`) */
+    avatarUrls?: Record<string, string>;
+    /** Groups the user belongs to */
+    groups?: {
+        size: number;
+        items: Array<{
+            name: string;
+            self: string;
+        }>;
+    };
+}
+
+/**
+ * A Jira project component.
+ */
+interface JiraComponent {
+    /** URL of the component resource */
+    self?: string;
+    /** Numeric string ID */
+    id?: string;
+    /** Component name */
+    name: string;
+    /** Component description */
+    description?: string;
+    /** The user designated as the component lead */
+    lead?: JiraUser;
+    /** Assignee type for issues created with this component */
+    assigneeType?: 'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED';
+    /** The auto-assigned user for this component */
+    assignee?: JiraUser;
+    /** The real assignee for this component */
+    realAssignee?: JiraUser;
+    /** Whether the real assignee is enabled */
+    realAssigneeType?: string;
+    /** Whether the component is enabled */
+    isAssigneeTypeValid?: boolean;
+    /** Project key this component belongs to */
+    project?: string;
+    /** Project ID this component belongs to */
+    projectId?: number;
+}
+
+/**
+ * The category a status belongs to (e.g. To Do, In Progress, Done).
+ */
+interface JiraStatusCategory {
+    /** URL of the status category resource */
+    self: string;
+    /** Numeric ID */
+    id: number;
+    /** Machine-readable key (e.g. `'new'`, `'indeterminate'`, `'done'`) */
+    key: string;
+    /** Human-readable name */
+    name: string;
+    /** Display color name */
+    colorName?: string;
+}
+/**
+ * A Jira workflow status.
+ */
+interface JiraStatus {
+    /** URL of the status resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Status name */
+    name: string;
+    /** Status description */
+    description?: string;
+    /** URL of the status icon */
+    iconUrl?: string;
+    /** The category this status belongs to */
+    statusCategory?: JiraStatusCategory;
+}
+
+/**
+ * A Jira issue priority.
+ */
+interface JiraPriority {
+    /** URL of the priority resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Priority name (e.g. `'Highest'`, `'High'`, `'Medium'`, `'Low'`, `'Lowest'`) */
+    name: string;
+    /** Priority description */
+    description?: string;
+    /** URL of the priority icon */
+    iconUrl?: string;
+    /** Hex status color */
+    statusColor?: string;
+}
+
+/**
+ * A Jira issue type (e.g. Story, Bug, Task, Epic).
+ */
+interface JiraIssueType {
+    /** URL of the issue type resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Issue type name */
+    name: string;
+    /** Issue type description */
+    description?: string;
+    /** URL of the issue type icon */
+    iconUrl?: string;
+    /** Whether this issue type is a sub-task */
+    subtask: boolean;
+    /** Hierarchy level (0 = standard, -1 = subtask, 1 = epic) */
+    hierarchyLevel?: number;
+    /** Avatar ID for this issue type */
+    avatarId?: number;
+}
+
+/**
+ * A file attachment on a Jira issue.
+ */
+interface JiraAttachment {
+    /** URL of the attachment resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Original file name */
+    filename: string;
+    /** User who uploaded the attachment */
+    author?: JiraUser;
+    /** ISO 8601 date the attachment was created */
+    created: string;
+    /** File size in bytes */
+    size: number;
+    /** MIME type */
+    mimeType: string;
+    /** URL to download the attachment content */
+    content: string;
+    /** URL to the thumbnail (images only) */
+    thumbnail?: string;
+}
+
+/**
+ * The type of a link between two Jira issues.
+ */
+interface JiraIssueLinkType {
+    /** URL of the link type resource */
+    self?: string;
+    /** Numeric string ID */
+    id: string;
+    /** Machine-readable name (e.g. `'Blocks'`) */
+    name: string;
+    /** Inward description (e.g. `'is blocked by'`) */
+    inward: string;
+    /** Outward description (e.g. `'blocks'`) */
+    outward: string;
+}
+/**
+ * A minimal reference to a Jira issue (used inside link objects).
+ */
+interface JiraIssueRef {
+    /** URL of the issue resource */
+    self: string;
+    /** Issue key (e.g. `'PROJ-42'`) */
+    key: string;
+    /** Issue ID */
+    id: string;
+    /** Basic issue fields */
+    fields?: {
+        summary: string;
+        status?: {
+            name: string;
+            iconUrl?: string;
+        };
+        priority?: {
+            name: string;
+            iconUrl?: string;
+        };
+        issuetype?: {
+            name: string;
+            iconUrl?: string;
+            subtask: boolean;
+        };
+    };
+}
+/**
+ * A link between two Jira issues.
+ */
+interface JiraIssueLink {
+    /** URL of the link resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** The link type */
+    type: JiraIssueLinkType;
+    /** The inward linked issue (the issue referenced by the link) */
+    inwardIssue?: JiraIssueRef;
+    /** The outward linked issue (the issue that is the target of the link) */
+    outwardIssue?: JiraIssueRef;
+}
+
+/**
+ * Common query parameters for paginated endpoints.
+ */
+interface PaginationParams {
+    /** Index of the first item to return (0-based). Default: 0 */
+    startAt?: number;
+    /** Maximum number of items to return. Default varies by endpoint */
+    maxResults?: number;
+}
+/**
+ * Generic paged response returned by list endpoints.
+ *
+ * @template T - The type of items in the page
+ */
+interface PagedResponse<T> {
+    /** Index of the first item in this page */
+    startAt: number;
+    /** Maximum number of items requested */
+    maxResults: number;
+    /** Total number of items matching the query */
+    total: number;
+    /** Whether this is the last page (used by Agile endpoints) */
+    isLast?: boolean;
+    /** The items in this page */
+    values: T[];
+}
+
+/**
+ * Query parameters for listing issue comments.
+ */
+interface CommentsParams extends PaginationParams {
+    /** Field to order results by (e.g. `'created'`) */
+    orderBy?: string;
+    /** Fields to expand (e.g. `'renderedBody'`) */
+    expand?: string;
+}
+/**
+ * A comment on a Jira issue.
+ */
+interface JiraComment {
+    /** URL of the comment resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** User who created the comment */
+    author?: JiraUser;
+    /** Comment body text */
+    body: string;
+    /** Rendered HTML body (when `expand=renderedBody` is used) */
+    renderedBody?: string;
+    /** User who last updated the comment */
+    updateAuthor?: JiraUser;
+    /** ISO 8601 date the comment was created */
+    created: string;
+    /** ISO 8601 date the comment was last updated */
+    updated: string;
+    /** Visibility restriction for the comment */
+    visibility?: JiraCommentVisibility;
+}
+/**
+ * Visibility restriction on a comment.
+ */
+interface JiraCommentVisibility {
+    /** Restriction type: `'role'` or `'group'` */
+    type: 'role' | 'group';
+    /** Role or group name */
+    value: string;
+}
+/**
+ * Paged wrapper returned by `GET /rest/api/latest/issue/{key}/comment`.
+ */
+interface JiraCommentResponse {
+    /** Comments in this page */
+    comments: JiraComment[];
+    /** Index of the first comment */
+    startAt: number;
+    /** Maximum number of comments returned */
+    maxResults: number;
+    /** Total number of comments */
+    total: number;
+}
+
+/**
+ * Query parameters for listing issue worklogs.
+ */
+interface WorklogsParams extends PaginationParams {
+    /** Fields to expand */
+    expand?: string;
+}
+/**
+ * A worklog entry on a Jira issue.
+ */
+interface JiraWorklog {
+    /** URL of the worklog resource */
+    self: string;
+    /** User who created the worklog */
+    author?: JiraUser;
+    /** User who last updated the worklog */
+    updateAuthor?: JiraUser;
+    /** Comment / description of work done */
+    comment?: string;
+    /** ISO 8601 date the worklog was created */
+    created: string;
+    /** ISO 8601 date the worklog was last updated */
+    updated: string;
+    /** ISO 8601 date/time when the work was started */
+    started: string;
+    /** Time spent in Jira notation (e.g. `'3h 30m'`) */
+    timeSpent: string;
+    /** Time spent in seconds */
+    timeSpentSeconds: number;
+    /** Numeric string ID of the worklog */
+    id: string;
+    /** Numeric string ID of the issue */
+    issueId: string;
+    /** Visibility restriction */
+    visibility?: {
+        type: 'role' | 'group';
+        value: string;
+    };
+}
+/**
+ * Paged wrapper returned by `GET /rest/api/latest/issue/{key}/worklog`.
+ */
+interface JiraWorklogResponse {
+    /** Worklogs in this page */
+    worklogs: JiraWorklog[];
+    /** Index of the first worklog */
+    startAt: number;
+    /** Maximum number of worklogs returned */
+    maxResults: number;
+    /** Total number of worklogs */
+    total: number;
+}
+
+/**
+ * Query parameters for listing projects.
+ */
+interface ProjectsParams {
+    /** Fields to expand (e.g. `'description,lead,issueTypes,url,projectKeys'`) */
+    expand?: string;
+    /** Filter by project IDs */
+    recent?: number;
+}
+/**
+ * A minimal project reference used inside other objects.
+ */
+interface JiraProjectRef {
+    /** URL of the project resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Project key */
+    key: string;
+    /** Project name */
+    name: string;
+    /** Avatar URLs */
+    avatarUrls?: Record<string, string>;
+}
+/**
+ * A Jira project.
+ */
+interface JiraProject {
+    /** URL of the project resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Project key (e.g. `'PROJ'`) */
+    key: string;
+    /** Project name */
+    name: string;
+    /** Project description */
+    description?: string;
+    /** Project type key (e.g. `'software'`, `'business'`, `'service_desk'`) */
+    projectTypeKey?: string;
+    /** Whether this is a simplified (next-gen) project */
+    simplified?: boolean;
+    /** Project lead */
+    lead?: JiraUser;
+    /** Assignee type for new issues */
+    assigneeType?: 'PROJECT_LEAD' | 'UNASSIGNED';
+    /** Avatar URLs keyed by size */
+    avatarUrls?: Record<string, string>;
+    /** Issue types available in this project */
+    issueTypes?: JiraIssueType[];
+    /** Components defined in this project */
+    components?: JiraComponent[];
+    /** Versions defined in this project */
+    versions?: JiraVersion[];
+    /** Project roles keyed by role name, values are role URLs */
+    roles?: Record<string, string>;
+    /** Project links */
+    links?: Record<string, unknown>;
+    /** Project URL (homepage) */
+    url?: string;
+    /** Email used for email-to-issue */
+    email?: string;
+    /** Whether issues in the project can be viewed by anonymous users */
+    isPrivate?: boolean;
+}
+/**
+ * A status entry returned by `GET /rest/api/latest/project/{key}/statuses`.
+ */
+interface JiraProjectStatus {
+    /** URL of the issue type resource */
+    self: string;
+    /** Issue type ID */
+    id: string;
+    /** Issue type name */
+    name: string;
+    /** Whether the issue type is a subtask */
+    subtask: boolean;
+    /** Statuses available for this issue type */
+    statuses: JiraStatus[];
+}
+/**
+ * A role in a Jira project.
+ */
+interface JiraProjectRole {
+    /** URL of the role resource */
+    self: string;
+    /** Role name */
+    name: string;
+    /** Numeric role ID */
+    id: number;
+    /** Role description */
+    description?: string;
+    /** Actors (users and groups) with this role */
+    actors?: JiraProjectRoleActor[];
+}
+/**
+ * An actor (user or group) in a project role.
+ */
+interface JiraProjectRoleActor {
+    /** Numeric ID */
+    id: number;
+    /** Display name */
+    displayName: string;
+    /** Actor type: `'atlassian-user-role-actor'` or `'atlassian-group-role-actor'` */
+    type: string;
+    /** Actor name (username or group name) */
+    name: string;
+    /** Avatar URL (for user actors) */
+    avatarUrl?: string;
+}
+
+/**
+ * Vote information for a Jira issue.
+ */
+interface JiraVotes {
+    /** URL of the votes resource */
+    self: string;
+    /** Total number of votes */
+    votes: number;
+    /** Whether the authenticated user has voted */
+    hasVoted: boolean;
+    /** Users who have voted (only returned when expanding votes) */
+    voters?: JiraUser[];
+}
+
+/**
+ * Watcher information for a Jira issue.
+ */
+interface JiraWatchers {
+    /** URL of the watchers resource */
+    self: string;
+    /** Whether the authenticated user is watching the issue */
+    isWatching: boolean;
+    /** Total number of watchers */
+    watchCount: number;
+    /** Users watching the issue (only returned when expanding watchers) */
+    watchers?: JiraUser[];
+}
+
+/**
+ * Query parameters for fetching an issue.
+ */
+interface IssueParams {
+    /** Comma-separated list of fields to include (e.g. `'summary,status,assignee'`).
+     *  Use `'*all'` for all fields. Default: all navigable fields. */
+    fields?: string;
+    /** Fields to expand (e.g. `'changelog,renderedFields,transitions'`) */
+    expand?: string;
+    /** Properties to include */
+    properties?: string;
+    /** Whether to update the view count */
+    updateHistory?: boolean;
+}
+/**
+ * Time tracking information on a Jira issue.
+ */
+interface JiraTimeTracking {
+    /** Original estimate in Jira notation (e.g. `'2h 30m'`) */
+    originalEstimate?: string;
+    /** Remaining estimate in Jira notation */
+    remainingEstimate?: string;
+    /** Time spent in Jira notation */
+    timeSpent?: string;
+    /** Original estimate in seconds */
+    originalEstimateSeconds?: number;
+    /** Remaining estimate in seconds */
+    remainingEstimateSeconds?: number;
+    /** Time spent in seconds */
+    timeSpentSeconds?: number;
+}
+/**
+ * A minimal subtask reference used inside issue fields.
+ */
+interface JiraSubtask {
+    /** URL of the issue resource */
+    self: string;
+    /** Issue key */
+    key: string;
+    /** Issue ID */
+    id: string;
+    /** Basic subtask fields */
+    fields: {
+        summary: string;
+        status: JiraStatus;
+        priority?: JiraPriority;
+        issuetype: JiraIssueType;
+    };
+}
+/**
+ * A resolution object on a Jira issue.
+ */
+interface JiraResolution {
+    /** URL of the resolution resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Resolution name (e.g. `'Fixed'`, `'Won\'t Fix'`) */
+    name: string;
+    /** Resolution description */
+    description?: string;
+}
+/**
+ * The core issue fields returned by the Jira REST API.
+ *
+ * Common system fields are typed explicitly; custom fields
+ * and any other keys are accessible via the index signature.
+ */
+interface JiraIssueFields {
+    /** Issue summary */
+    summary: string;
+    /** Issue description */
+    description?: string | null;
+    /** Current workflow status */
+    status: JiraStatus;
+    /** Issue type */
+    issuetype: JiraIssueType;
+    /** Issue priority */
+    priority?: JiraPriority | null;
+    /** Assigned user */
+    assignee?: JiraUser | null;
+    /** Reporter user */
+    reporter?: JiraUser | null;
+    /** Creator user */
+    creator?: JiraUser | null;
+    /** The project this issue belongs to */
+    project: JiraProjectRef;
+    /** ISO 8601 creation timestamp */
+    created: string;
+    /** ISO 8601 last update timestamp */
+    updated: string;
+    /** ISO 8601 resolution timestamp */
+    resolutiondate?: string | null;
+    /** Resolution */
+    resolution?: JiraResolution | null;
+    /** Labels */
+    labels?: string[];
+    /** Components */
+    components?: JiraComponent[];
+    /** Fix versions */
+    fixVersions?: JiraVersion[];
+    /** Affected versions */
+    versions?: JiraVersion[];
+    /** Sub-tasks */
+    subtasks?: JiraSubtask[];
+    /** Parent issue (for sub-tasks or issues in epics) */
+    parent?: JiraIssueRef | null;
+    /** Issue links */
+    issuelinks?: JiraIssueLink[];
+    /** File attachments */
+    attachment?: JiraAttachment[];
+    /** Embedded comment page */
+    comment?: JiraCommentResponse;
+    /** Embedded worklog page */
+    worklog?: JiraWorklogResponse;
+    /** Time tracking */
+    timetracking?: JiraTimeTracking;
+    /** Votes */
+    votes?: JiraVotes;
+    /** Watches */
+    watches?: JiraWatchers;
+    /** Due date in `YYYY-MM-DD` format */
+    duedate?: string | null;
+    /** Environment description */
+    environment?: string | null;
+    /** Any additional fields (custom fields, etc.) */
+    [key: string]: unknown;
+}
+/**
+ * A Jira issue.
+ */
+interface JiraIssue {
+    /** Numeric string ID */
+    id: string;
+    /** Issue key (e.g. `'PROJ-42'`) */
+    key: string;
+    /** URL of the issue resource */
+    self: string;
+    /** Issue fields */
+    fields: JiraIssueFields;
+}
+
+/**
+ * Query parameters for listing issue changelog entries.
+ */
+interface ChangelogParams extends PaginationParams {
+}
+/**
+ * A single field change within a changelog entry.
+ */
+interface JiraChangelogItem {
+    /** The field that was changed */
+    field: string;
+    /** Whether the change was to a `jira` or `custom` field */
+    fieldtype: 'jira' | 'custom';
+    /** Field ID */
+    fieldId?: string;
+    /** Previous string value */
+    from?: string | null;
+    /** Previous display value */
+    fromString?: string | null;
+    /** New string value */
+    to?: string | null;
+    /** New display value */
+    toString?: string | null;
+}
+/**
+ * A single changelog history entry representing a set of changes made at one point in time.
+ */
+interface JiraChangelogEntry {
+    /** Numeric string ID of this history entry */
+    id: string;
+    /** User who made the changes */
+    author: JiraUser;
+    /** ISO 8601 date the change was made */
+    created: string;
+    /** The list of individual field changes */
+    items: JiraChangelogItem[];
+}
+/**
+ * Paged response returned by `GET /rest/api/latest/issue/{key}/changelog`.
+ */
+interface JiraChangelogResponse {
+    /** Index of the first entry */
+    startAt: number;
+    /** Maximum number of entries returned */
+    maxResults: number;
+    /** Total number of changelog entries */
+    total: number;
+    /** Changelog entries in this page */
+    histories: JiraChangelogEntry[];
+}
+
+/**
+ * Query parameters for listing issue transitions.
+ */
+interface TransitionsParams {
+    /** Transition ID to return a single transition */
+    transitionId?: string;
+    /** Fields to expand */
+    expand?: string;
+    /** Whether to skip remapping of issues during transition */
+    skipRemoteOnlyCondition?: boolean;
+}
+/**
+ * A workflow transition available for a Jira issue.
+ */
+interface JiraTransition {
+    /** Transition ID */
+    id: string;
+    /** Transition name */
+    name: string;
+    /** The status the issue will move to */
+    to: JiraStatus;
+    /** Whether this transition has a screen associated with it */
+    hasScreen: boolean;
+    /** Whether this is a global transition (appears from any status) */
+    isGlobal: boolean;
+    /** Whether this is the initial transition */
+    isInitial: boolean;
+    /** Whether this transition is conditionally available */
+    isAvailable?: boolean;
+    /** Whether this is a conditional transition */
+    isConditional?: boolean;
+    /** Whether the transition is looped */
+    isLooped?: boolean;
+    /** Fields required by the transition screen */
+    fields?: Record<string, JiraTransitionField>;
+}
+/**
+ * A field required by a transition screen.
+ */
+interface JiraTransitionField {
+    /** Whether the field is required */
+    required: boolean;
+    /** Field schema information */
+    schema?: {
+        type: string;
+        system?: string;
+        custom?: string;
+        customId?: number;
+    };
+    /** Field name */
+    name: string;
+    /** Field key */
+    key?: string;
+    /** Whether the field has a default value */
+    hasDefaultValue?: boolean;
+    /** Allowed values for the field */
+    allowedValues?: unknown[];
+}
+
+/**
+ * A remote link (e.g. to a web URL) associated with a Jira issue.
+ */
+interface JiraRemoteLink {
+    /** URL of the remote link resource */
+    self: string;
+    /** Numeric ID */
+    id: number;
+    /** Global unique ID used for deduplication across systems */
+    globalId?: string;
+    /** Application info for the linked external system */
+    application?: {
+        type?: string;
+        name?: string;
+    };
+    /** Relationship description (e.g. `'is implemented by'`) */
+    relationship?: string;
+    /** The linked remote object */
+    object: JiraRemoteLinkObject;
+}
+/**
+ * The remote object referenced by a {@link JiraRemoteLink}.
+ */
+interface JiraRemoteLinkObject {
+    /** URL of the remote resource */
+    url: string;
+    /** Title of the remote resource */
+    title: string;
+    /** Summary / description */
+    summary?: string;
+    /** Icon for the remote resource */
+    icon?: {
+        url16x16?: string;
+        title?: string;
+        link?: string;
+    };
+    /** Status of the remote resource */
+    status?: {
+        resolved?: boolean;
+        icon?: {
+            url16x16?: string;
+            title?: string;
+            link?: string;
+        };
+    };
+}
+
+/** @internal */
+type RequestFn = <T>(path: string, params?: Record<string, string | number | boolean>, options?: {
+    apiPath?: string;
+}) => Promise<T>;
+/**
+ * Represents a Jira issue resource with chainable async methods.
+ *
+ * Implements `PromiseLike<JiraIssue>` so it can be awaited directly
+ * to fetch the issue, while also exposing sub-resource methods.
+ *
+ * @example
+ * ```typescript
+ * // Await directly to get issue info
+ * const issue = await jiraClient.issue('PROJ-42');
+ *
+ * // Get issue with specific fields
+ * const issue = await jiraClient.issue('PROJ-42').get({ fields: 'summary,status,assignee' });
+ *
+ * // Get comments
+ * const comments = await jiraClient.issue('PROJ-42').comments();
+ *
+ * // Get worklogs
+ * const worklogs = await jiraClient.issue('PROJ-42').worklogs();
+ *
+ * // Get changelog
+ * const changelog = await jiraClient.issue('PROJ-42').changelog();
+ *
+ * // Get available transitions
+ * const transitions = await jiraClient.issue('PROJ-42').transitions();
+ *
+ * // Get remote links
+ * const remoteLinks = await jiraClient.issue('PROJ-42').remotelinks();
+ *
+ * // Get votes
+ * const votes = await jiraClient.issue('PROJ-42').votes();
+ *
+ * // Get watchers
+ * const watchers = await jiraClient.issue('PROJ-42').watchers();
+ * ```
+ */
+declare class IssueResource implements PromiseLike<JiraIssue> {
+    private readonly request;
+    private readonly basePath;
+    /** @internal */
+    constructor(request: RequestFn, issueIdOrKey: string);
+    /**
+     * Allows the resource to be awaited directly, resolving with the issue.
+     * Delegates to {@link IssueResource.get}.
+     */
+    then<TResult1 = JiraIssue, TResult2 = never>(onfulfilled?: ((value: JiraIssue) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
+    /**
+     * Fetches the issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}`
+     *
+     * @param params - Optional: `fields`, `expand`, `properties`, `updateHistory`
+     * @returns The issue object
+     */
+    get(params?: IssueParams): Promise<JiraIssue>;
+    /**
+     * Fetches comments for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/comment`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `orderBy`, `expand`
+     * @returns A paged response of comments
+     */
+    comments(params?: CommentsParams): Promise<JiraCommentResponse>;
+    /**
+     * Fetches a single comment by ID.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/comment/{id}`
+     *
+     * @param commentId - The numeric comment ID
+     * @returns The comment object
+     */
+    comment(commentId: string | number): Promise<JiraComment>;
+    /**
+     * Fetches worklogs for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/worklog`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `expand`
+     * @returns A paged response of worklogs
+     */
+    worklogs(params?: WorklogsParams): Promise<JiraWorklogResponse>;
+    /**
+     * Fetches a single worklog by ID.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/worklog/{id}`
+     *
+     * @param worklogId - The numeric worklog ID
+     * @returns The worklog object
+     */
+    worklog(worklogId: string | number): Promise<JiraWorklog>;
+    /**
+     * Fetches the changelog for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/changelog`
+     *
+     * @param params - Optional: `startAt`, `maxResults`
+     * @returns A paged response of changelog entries
+     */
+    changelog(params?: ChangelogParams): Promise<JiraChangelogResponse>;
+    /**
+     * Fetches the available workflow transitions for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/transitions`
+     *
+     * @param params - Optional: `transitionId`, `expand`, `skipRemoteOnlyCondition`
+     * @returns An object containing the list of transitions
+     */
+    transitions(params?: TransitionsParams): Promise<{
+        transitions: JiraTransition[];
+    }>;
+    /**
+     * Fetches the remote links (external URLs) for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/remotelink`
+     *
+     * @param globalId - Optional global ID to filter by a specific remote link
+     * @returns An array of remote links
+     */
+    remotelinks(globalId?: string): Promise<JiraRemoteLink[]>;
+    /**
+     * Fetches the vote information for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/votes`
+     *
+     * @returns The votes object
+     */
+    votes(): Promise<JiraVotes>;
+    /**
+     * Fetches the watcher information for this issue.
+     *
+     * `GET /rest/api/latest/issue/{issueIdOrKey}/watchers`
+     *
+     * @returns The watchers object
+     */
+    watchers(): Promise<JiraWatchers>;
+}
+
+/**
+ * Represents a Jira project resource with chainable async methods.
+ *
+ * Implements `PromiseLike<JiraProject>` so it can be awaited directly
+ * to fetch the project, while also exposing sub-resource methods.
+ *
+ * @example
+ * ```typescript
+ * // Await directly to get project info
+ * const project = await jiraClient.project('PROJ');
+ *
+ * // Get components
+ * const components = await jiraClient.project('PROJ').components();
+ *
+ * // Get versions
+ * const versions = await jiraClient.project('PROJ').versions();
+ *
+ * // Get statuses per issue type
+ * const statuses = await jiraClient.project('PROJ').statuses();
+ *
+ * // Get project roles
+ * const roles = await jiraClient.project('PROJ').roles();
+ * ```
+ */
+declare class ProjectResource implements PromiseLike<JiraProject> {
+    private readonly request;
+    private readonly basePath;
+    /** @internal */
+    constructor(request: RequestFn, projectIdOrKey: string);
+    /**
+     * Allows the resource to be awaited directly, resolving with the project.
+     * Delegates to {@link ProjectResource.get}.
+     */
+    then<TResult1 = JiraProject, TResult2 = never>(onfulfilled?: ((value: JiraProject) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
+    /**
+     * Fetches the project details.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}`
+     *
+     * @param params - Optional: `expand`
+     * @returns The project object
+     */
+    get(params?: ProjectsParams): Promise<JiraProject>;
+    /**
+     * Fetches the components defined in this project.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}/components`
+     *
+     * @returns An array of project components
+     */
+    components(): Promise<JiraComponent[]>;
+    /**
+     * Fetches the versions defined in this project.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}/versions`
+     *
+     * @param expand - Optional: `'operations'`
+     * @returns An array of project versions
+     */
+    versions(expand?: string): Promise<JiraVersion[]>;
+    /**
+     * Fetches the statuses available in this project, grouped by issue type.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}/statuses`
+     *
+     * @returns An array of issue type → statuses mappings
+     */
+    statuses(): Promise<JiraProjectStatus[]>;
+    /**
+     * Fetches the roles defined in this project.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}/role`
+     *
+     * @returns A record mapping role names to their resource URLs
+     */
+    roles(): Promise<Record<string, string>>;
+    /**
+     * Fetches a single role by ID, including the list of actors.
+     *
+     * `GET /rest/api/latest/project/{projectIdOrKey}/role/{id}`
+     *
+     * @param roleId - The numeric role ID
+     * @returns The project role object with actors
+     */
+    role(roleId: number): Promise<JiraProjectRole>;
+}
+
+/**
+ * Query parameters for listing boards.
+ */
+interface BoardsParams {
+    /** Index of the first result (0-based) */
+    startAt?: number;
+    /** Maximum number of results */
+    maxResults?: number;
+    /** Filter boards by type: `'scrum'` or `'kanban'` */
+    type?: 'scrum' | 'kanban';
+    /** Filter boards by name (contains match) */
+    name?: string;
+    /** Filter boards by project key or ID */
+    projectKeyOrId?: string;
+}
+/**
+ * The project associated with a board's filter.
+ */
+interface JiraBoardProject {
+    /** Numeric string project ID */
+    id: string;
+    /** Project key */
+    key: string;
+    /** Project name */
+    name: string;
+    /** URL of the project resource */
+    self: string;
+}
+/**
+ * The filter associated with a Jira board.
+ */
+interface JiraBoardFilter {
+    /** Numeric string filter ID */
+    id: string;
+    /** URL of the filter resource */
+    self: string;
+}
+/**
+ * A Jira Software board (Scrum or Kanban).
+ */
+interface JiraBoard {
+    /** Numeric board ID */
+    id: number;
+    /** URL of the board resource */
+    self: string;
+    /** Board name */
+    name: string;
+    /** Board type: `'scrum'` or `'kanban'` */
+    type: 'scrum' | 'kanban';
+    /** Filter configuration for the board */
+    filter?: JiraBoardFilter;
+    /** The location (project) this board belongs to */
+    location?: {
+        projectId?: number;
+        displayName?: string;
+        projectName?: string;
+        projectKey?: string;
+        projectTypeKey?: string;
+        avatarURI?: string;
+        name?: string;
+    };
+}
+/**
+ * Query parameters for listing issues on a board.
+ */
+interface BoardIssuesParams {
+    /** Index of the first result (0-based) */
+    startAt?: number;
+    /** Maximum number of results */
+    maxResults?: number;
+    /** JQL query to filter issues */
+    jql?: string;
+    /** Whether to validate the JQL query */
+    validateQuery?: boolean;
+    /** Comma-separated list of fields to include */
+    fields?: string;
+    /** Fields to expand */
+    expand?: string;
+}
+
+/**
+ * Query parameters for listing sprints on a board.
+ */
+interface SprintsParams {
+    /** Index of the first result (0-based) */
+    startAt?: number;
+    /** Maximum number of results */
+    maxResults?: number;
+    /** Filter by sprint state: `'future'`, `'active'`, or `'closed'` */
+    state?: 'future' | 'active' | 'closed';
+}
+/**
+ * A Jira Software sprint.
+ */
+interface JiraSprint {
+    /** Numeric sprint ID */
+    id: number;
+    /** URL of the sprint resource */
+    self: string;
+    /** Sprint state: `'future'`, `'active'`, or `'closed'` */
+    state: 'future' | 'active' | 'closed';
+    /** Sprint name */
+    name: string;
+    /** ISO 8601 start date */
+    startDate?: string;
+    /** ISO 8601 end date */
+    endDate?: string;
+    /** ISO 8601 date the sprint was completed */
+    completeDate?: string;
+    /** ID of the board this sprint belongs to */
+    originBoardId?: number;
+    /** Sprint goal */
+    goal?: string;
+}
+
+/**
+ * Query parameters for `GET /rest/api/latest/search`.
+ */
+interface SearchParams {
+    /** JQL query string (e.g. `'project = PROJ AND status = Open ORDER BY created DESC'`) */
+    jql?: string;
+    /** Index of the first result (0-based) */
+    startAt?: number;
+    /** Maximum number of results to return (max 50 by default, up to 100) */
+    maxResults?: number;
+    /** Whether to validate the JQL query (`'strict'`, `'warn'`, `'none'`) */
+    validateQuery?: 'strict' | 'warn' | 'none';
+    /** Comma-separated list of fields to include.
+     * Use `'*all'` for all fields, `'*navigable'` for navigable fields (default). */
+    fields?: string;
+    /** Fields to expand (e.g. `'changelog,renderedFields,names'`) */
+    expand?: string;
+    /** List of issue properties to return */
+    properties?: string;
+    /** Whether to return field IDs instead of field names */
+    fieldsByKeys?: boolean;
+}
+/**
+ * Response body from `GET /rest/api/latest/search` or `POST /rest/api/latest/search`.
+ */
+interface JiraSearchResponse {
+    /** URL used to perform the search */
+    expand?: string;
+    /** Index of the first result */
+    startAt: number;
+    /** Maximum number of results requested */
+    maxResults: number;
+    /** Total number of issues matching the query */
+    total: number;
+    /** Issues in this page */
+    issues: JiraIssue[];
+    /** Warning messages from the JQL validator */
+    warningMessages?: string[];
+    /** Field name → display name mapping (when `expand=names`) */
+    names?: Record<string, string>;
+}
+
+/**
+ * Represents a Jira Software sprint resource.
+ *
+ * Implements `PromiseLike<JiraSprint>` so it can be awaited directly
+ * to fetch the sprint, while also exposing sub-resource methods.
+ *
+ * @example
+ * ```typescript
+ * // Await directly to get sprint info
+ * const sprint = await jiraClient.board(42).sprint(10);
+ *
+ * // Get sprint issues
+ * const issues = await jiraClient.board(42).sprint(10).issues({ maxResults: 50 });
+ * ```
+ */
+declare class SprintResource implements PromiseLike<JiraSprint> {
+    private readonly request;
+    private readonly agileApiPath;
+    private readonly basePath;
+    /** @internal */
+    constructor(request: RequestFn, agileApiPath: string, sprintId: number);
+    /**
+     * Allows the resource to be awaited directly, resolving with the sprint.
+     * Delegates to {@link SprintResource.get}.
+     */
+    then<TResult1 = JiraSprint, TResult2 = never>(onfulfilled?: ((value: JiraSprint) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
+    /**
+     * Fetches the sprint details.
+     *
+     * `GET /rest/agile/latest/sprint/{sprintId}`
+     *
+     * @returns The sprint object
+     */
+    get(): Promise<JiraSprint>;
+    /**
+     * Fetches issues in this sprint.
+     *
+     * `GET /rest/agile/latest/sprint/{sprintId}/issue`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `jql`, `fields`, `expand`
+     * @returns A search response containing the sprint's issues
+     */
+    issues(params?: BoardIssuesParams): Promise<JiraSearchResponse>;
+}
+
+/**
+ * Represents a Jira Software board resource with chainable async methods.
+ *
+ * Implements `PromiseLike<JiraBoard>` so it can be awaited directly
+ * to fetch the board, while also exposing sub-resource methods.
+ *
+ * @example
+ * ```typescript
+ * // Await directly to get board info
+ * const board = await jiraClient.board(42);
+ *
+ * // Get sprints
+ * const sprints = await jiraClient.board(42).sprints({ state: 'active' });
+ *
+ * // Get board issues
+ * const issues = await jiraClient.board(42).issues({ jql: 'status = Open' });
+ *
+ * // Get backlog
+ * const backlog = await jiraClient.board(42).backlog({ maxResults: 50 });
+ *
+ * // Navigate to a sprint
+ * const sprint = await jiraClient.board(42).sprint(10);
+ * const sprintIssues = await jiraClient.board(42).sprint(10).issues();
+ * ```
+ */
+declare class BoardResource implements PromiseLike<JiraBoard> {
+    private readonly request;
+    private readonly agileApiPath;
+    private readonly basePath;
+    /** @internal */
+    constructor(request: RequestFn, agileApiPath: string, boardId: number);
+    /**
+     * Allows the resource to be awaited directly, resolving with the board.
+     * Delegates to {@link BoardResource.get}.
+     */
+    then<TResult1 = JiraBoard, TResult2 = never>(onfulfilled?: ((value: JiraBoard) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
+    /**
+     * Fetches the board details.
+     *
+     * `GET /rest/agile/latest/board/{boardId}`
+     *
+     * @returns The board object
+     */
+    get(): Promise<JiraBoard>;
+    /**
+     * Fetches sprints for this board.
+     *
+     * `GET /rest/agile/latest/board/{boardId}/sprint`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `state`
+     * @returns A paged response of sprints
+     */
+    sprints(params?: SprintsParams): Promise<PagedResponse<JiraSprint>>;
+    /**
+     * Fetches all issues on this board (across all sprints and the backlog).
+     *
+     * `GET /rest/agile/latest/board/{boardId}/issue`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `jql`, `fields`, `expand`
+     * @returns A search response containing the board's issues
+     */
+    issues(params?: BoardIssuesParams): Promise<JiraSearchResponse>;
+    /**
+     * Fetches the backlog issues for this board.
+     *
+     * `GET /rest/agile/latest/board/{boardId}/backlog`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `jql`, `fields`, `expand`
+     * @returns A search response containing the backlog issues
+     */
+    backlog(params?: BoardIssuesParams): Promise<JiraSearchResponse>;
+    /**
+     * Returns a {@link SprintResource} for a given sprint ID.
+     *
+     * The returned resource can be awaited directly to fetch sprint info,
+     * or chained to access sprint issues.
+     *
+     * @param sprintId - The numeric sprint ID
+     * @returns A chainable sprint resource
+     *
+     * @example
+     * ```typescript
+     * const sprint       = await jiraClient.board(42).sprint(10);
+     * const sprintIssues = await jiraClient.board(42).sprint(10).issues();
+     * ```
+     */
+    sprint(sprintId: number): SprintResource;
+}
+
+/**
+ * A Jira issue field (system or custom).
+ */
+interface JiraField {
+    /** Unique field ID (e.g. `'summary'`, `'customfield_10000'`) */
+    id: string;
+    /** Human-readable name */
+    name: string;
+    /** Whether this is a custom field */
+    custom: boolean;
+    /** Whether the field is orderable */
+    orderable: boolean;
+    /** Whether the field is navigable */
+    navigable: boolean;
+    /** Whether the field is searchable */
+    searchable: boolean;
+    /** Clause names used in JQL */
+    clauseNames: string[];
+    /** Field schema */
+    schema?: {
+        type: string;
+        system?: string;
+        custom?: string;
+        customId?: number;
+        items?: string;
+    };
+}
+
+/**
+ * A saved Jira filter.
+ */
+interface JiraFilter {
+    /** URL of the filter resource */
+    self: string;
+    /** Numeric string ID */
+    id: string;
+    /** Filter name */
+    name: string;
+    /** Filter description */
+    description?: string;
+    /** User who created the filter */
+    owner?: JiraUser;
+    /** The JQL query string */
+    jql: string;
+    /** URL to view the filter results */
+    viewUrl?: string;
+    /** URL to the filter REST resource */
+    searchUrl?: string;
+    /** Whether the filter is a favourite of the authenticated user */
+    favourite?: boolean;
+    /** Number of users who have marked this filter as a favourite */
+    favouritedCount?: number;
+    /** Shared permissions */
+    sharePermissions?: JiraFilterPermission[];
+    /** Subscriptions to this filter */
+    subscriptions?: {
+        size: number;
+        items: unknown[];
+    };
+}
+/**
+ * A permission entry for a shared filter.
+ */
+interface JiraFilterPermission {
+    /** Numeric ID */
+    id: number;
+    /** Permission type (e.g. `'global'`, `'project'`, `'group'`, `'role'`) */
+    type: string;
+    /** Project permission details */
+    project?: {
+        id: string;
+        key: string;
+        name: string;
+    };
+    /** Role permission details */
+    role?: {
+        id: number;
+        name: string;
+    };
+    /** Group permission details */
+    group?: {
+        name: string;
+    };
+}
+
+/**
+ * Payload emitted on every HTTP request made by {@link JiraClient}.
+ */
+interface RequestEvent {
+    /** Full URL that was requested */
+    url: string;
+    /** HTTP method used */
+    method: 'GET' | 'POST';
+    /** Timestamp when the request started */
+    startedAt: Date;
+    /** Timestamp when the request finished (success or error) */
+    finishedAt: Date;
+    /** Total duration in milliseconds */
+    durationMs: number;
+    /** HTTP status code returned by the server, if a response was received */
+    statusCode?: number;
+    /** Error thrown, if the request failed */
+    error?: Error;
+}
+/** Map of supported client events to their callback signatures */
+interface JiraClientEvents {
+    request: (event: RequestEvent) => void;
+}
+/**
+ * Constructor options for {@link JiraClient}.
+ */
+interface JiraClientOptions {
+    /** The host URL of the Jira Data Center instance (e.g., `https://jira.example.com`) */
+    apiUrl: string;
+    /**
+     * The REST API path to prepend to every core request.
+     * @default `'rest/api/latest'`
+     */
+    apiPath?: string;
+    /**
+     * The Agile (Software) REST API path used for boards and sprints.
+     * @default `'rest/agile/latest'`
+     */
+    agileApiPath?: string;
+    /** The username to authenticate with */
+    user: string;
+    /** The personal access token or password to authenticate with */
+    token: string;
+}
+/**
+ * Main entry point for the Jira Data Center REST API client.
+ *
+ * @example
+ * ```typescript
+ * const jira = new JiraClient({
+ *   apiUrl: 'https://jira.example.com',
+ *   user: 'pilmee',
+ *   token: 'my-token',
+ * });
+ *
+ * // Search issues with JQL
+ * const results = await jira.search({ jql: 'project = PROJ AND status = Open', maxResults: 50 });
+ *
+ * // Get a single issue
+ * const issue = await jira.issue('PROJ-42');
+ *
+ * // Get issue comments
+ * const comments = await jira.issue('PROJ-42').comments();
+ *
+ * // Get issue changelog
+ * const changelog = await jira.issue('PROJ-42').changelog();
+ *
+ * // Get a project
+ * const project = await jira.project('PROJ');
+ *
+ * // Get project components
+ * const components = await jira.project('PROJ').components();
+ *
+ * // Get all projects
+ * const projects = await jira.projects();
+ *
+ * // Get a board and its sprints
+ * const sprints = await jira.board(42).sprints({ state: 'active' });
+ *
+ * // Get sprint issues
+ * const sprintIssues = await jira.board(42).sprint(10).issues();
+ *
+ * // Get current user
+ * const me = await jira.currentUser();
+ * ```
+ */
+declare class JiraClient {
+    private readonly security;
+    private readonly apiPath;
+    private readonly agileApiPath;
+    private readonly listeners;
+    /**
+     * @param options - Connection and authentication options
+     * @throws {TypeError} If `apiUrl` is not a valid URL
+     */
+    constructor({ apiUrl, apiPath, agileApiPath, user, token }: JiraClientOptions);
+    /**
+     * Subscribes to a client event.
+     *
+     * @example
+     * ```typescript
+     * jira.on('request', (event) => {
+     *   console.log(`${event.method} ${event.url} — ${event.durationMs}ms`);
+     *   if (event.error) console.error('Request failed:', event.error);
+     * });
+     * ```
+     */
+    on<K extends keyof JiraClientEvents>(event: K, callback: JiraClientEvents[K]): this;
+    private emit;
+    /**
+     * Performs an authenticated GET request to the Jira REST API.
+     * @internal
+     */
+    private request;
+    private requestPost;
+    /**
+     * Returns an {@link IssueResource} for a given issue key or ID, providing access
+     * to issue data and sub-resources (comments, changelog, transitions, etc.).
+     *
+     * The returned resource can be awaited directly to fetch the issue,
+     * or chained to access nested resources.
+     *
+     * @param issueIdOrKey - The issue key (e.g., `'PROJ-42'`) or numeric ID
+     * @returns A chainable issue resource
+     *
+     * @example
+     * ```typescript
+     * const issue      = await jira.issue('PROJ-42');
+     * const comments   = await jira.issue('PROJ-42').comments();
+     * const changelog  = await jira.issue('PROJ-42').changelog();
+     * const transitions = await jira.issue('PROJ-42').transitions();
+     * ```
+     */
+    issue(issueIdOrKey: string): IssueResource;
+    /**
+     * Searches for issues using JQL.
+     *
+     * `GET /rest/api/latest/search`
+     *
+     * @param params - Optional: `jql`, `startAt`, `maxResults`, `fields`, `expand`, `validateQuery`
+     * @returns A search response containing matching issues
+     *
+     * @example
+     * ```typescript
+     * const results = await jira.search({
+     *   jql: 'project = PROJ AND status = Open ORDER BY created DESC',
+     *   maxResults: 50,
+     *   fields: 'summary,status,assignee,priority',
+     * });
+     * ```
+     */
+    search(params?: SearchParams): Promise<JiraSearchResponse>;
+    /**
+     * Fetches all projects accessible to the authenticated user.
+     *
+     * `GET /rest/api/latest/project`
+     *
+     * @param params - Optional: `expand`, `recent`
+     * @returns An array of projects
+     */
+    projects(params?: ProjectsParams): Promise<JiraProject[]>;
+    /**
+     * Returns a {@link ProjectResource} for a given project key or ID.
+     *
+     * The returned resource can be awaited directly to fetch project info,
+     * or chained to access nested resources.
+     *
+     * @param projectIdOrKey - The project key (e.g., `'PROJ'`) or numeric ID
+     * @returns A chainable project resource
+     *
+     * @example
+     * ```typescript
+     * const project    = await jira.project('PROJ');
+     * const components = await jira.project('PROJ').components();
+     * const versions   = await jira.project('PROJ').versions();
+     * const statuses   = await jira.project('PROJ').statuses();
+     * ```
+     */
+    project(projectIdOrKey: string): ProjectResource;
+    /**
+     * Searches for users.
+     *
+     * `GET /rest/api/latest/user/search`
+     *
+     * @param params - Optional: `username`, `startAt`, `maxResults`
+     * @returns An array of users
+     */
+    users(params?: UserSearchParams): Promise<JiraUser[]>;
+    /**
+     * Fetches a single user by username or key.
+     *
+     * `GET /rest/api/latest/user`
+     *
+     * @param username - The username (login name) to look up
+     * @returns The user object
+     *
+     * @example
+     * ```typescript
+     * const user = await jira.user('pilmee');
+     * ```
+     */
+    user(username: string): Promise<JiraUser>;
+    /**
+     * Fetches the currently authenticated user.
+     *
+     * `GET /rest/api/latest/myself`
+     *
+     * @returns The authenticated user object
+     *
+     * @example
+     * ```typescript
+     * const me = await jira.currentUser();
+     * ```
+     */
+    currentUser(): Promise<JiraUser>;
+    /**
+     * Fetches all boards accessible to the authenticated user.
+     *
+     * `GET /rest/agile/latest/board`
+     *
+     * @param params - Optional: `startAt`, `maxResults`, `type`, `name`, `projectKeyOrId`
+     * @returns A paged response of boards
+     */
+    boards(params?: BoardsParams): Promise<PagedResponse<JiraBoard>>;
+    /**
+     * Returns a {@link BoardResource} for a given board ID.
+     *
+     * The returned resource can be awaited directly to fetch board info,
+     * or chained to access nested resources (sprints, issues, backlog).
+     *
+     * @param boardId - The numeric board ID
+     * @returns A chainable board resource
+     *
+     * @example
+     * ```typescript
+     * const board       = await jira.board(42);
+     * const sprints     = await jira.board(42).sprints({ state: 'active' });
+     * const backlog     = await jira.board(42).backlog({ maxResults: 50 });
+     * const sprintIssues = await jira.board(42).sprint(10).issues();
+     * ```
+     */
+    board(boardId: number): BoardResource;
+    /**
+     * Fetches all issue types available to the authenticated user.
+     *
+     * `GET /rest/api/latest/issuetype`
+     *
+     * @returns An array of issue types
+     */
+    issuetypes(): Promise<JiraIssueType[]>;
+    /**
+     * Fetches a single issue type by ID.
+     *
+     * `GET /rest/api/latest/issuetype/{id}`
+     *
+     * @param id - The issue type ID
+     * @returns The issue type object
+     */
+    issuetype(id: string): Promise<JiraIssueType>;
+    /**
+     * Fetches all priorities.
+     *
+     * `GET /rest/api/latest/priority`
+     *
+     * @returns An array of priorities
+     */
+    priorities(): Promise<JiraPriority[]>;
+    /**
+     * Fetches a single priority by ID.
+     *
+     * `GET /rest/api/latest/priority/{id}`
+     *
+     * @param id - The priority ID
+     * @returns The priority object
+     */
+    priority(id: string): Promise<JiraPriority>;
+    /**
+     * Fetches all statuses.
+     *
+     * `GET /rest/api/latest/status`
+     *
+     * @returns An array of statuses
+     */
+    statuses(): Promise<JiraStatus[]>;
+    /**
+     * Fetches a single status by ID or name.
+     *
+     * `GET /rest/api/latest/status/{idOrName}`
+     *
+     * @param idOrName - The status ID or name
+     * @returns The status object
+     */
+    status(idOrName: string): Promise<JiraStatus>;
+    /**
+     * Fetches all issue fields (system and custom).
+     *
+     * `GET /rest/api/latest/field`
+     *
+     * @returns An array of fields
+     */
+    fields(): Promise<JiraField[]>;
+    /**
+     * Fetches all issue link types.
+     *
+     * `GET /rest/api/latest/issueLinkType`
+     *
+     * @returns An object with the list of issue link types
+     */
+    issueLinkTypes(): Promise<{
+        issueLinkTypes: JiraIssueLinkType[];
+    }>;
+    /**
+     * Fetches the authenticated user's favourite filters.
+     *
+     * `GET /rest/api/latest/filter/favourite`
+     *
+     * @returns An array of filters
+     */
+    favouriteFilters(): Promise<JiraFilter[]>;
+    /**
+     * Fetches a single filter by ID.
+     *
+     * `GET /rest/api/latest/filter/{id}`
+     *
+     * @param filterId - The numeric filter ID
+     * @returns The filter object
+     */
+    filter(filterId: string | number): Promise<JiraFilter>;
+    /**
+     * Fetches issues using a `POST` search, which supports larger JQL queries
+     * and additional options such as specifying the fields list as an array.
+     *
+     * `POST /rest/api/latest/search`
+     *
+     * @param body - Search request body
+     * @returns A search response containing matching issues
+     *
+     * @example
+     * ```typescript
+     * const results = await jira.searchPost({
+     *   jql: 'project = PROJ AND status = Open',
+     *   maxResults: 100,
+     *   fields: ['summary', 'status', 'assignee'],
+     * });
+     * ```
+     */
+    searchPost(body: {
+        jql?: string;
+        startAt?: number;
+        maxResults?: number;
+        fields?: string[];
+        expand?: string[];
+        validateQuery?: 'strict' | 'warn' | 'none';
+        fieldsByKeys?: boolean;
+        properties?: string[];
+    }): Promise<JiraSearchResponse>;
+    /**
+     * Fetches a single component by ID.
+     *
+     * `GET /rest/api/latest/component/{id}`
+     *
+     * @param componentId - The component ID
+     * @returns The component object
+     */
+    component(componentId: string): Promise<JiraComponent>;
+    /**
+     * Fetches a single version by ID.
+     *
+     * `GET /rest/api/latest/version/{id}`
+     *
+     * @param versionId - The version ID
+     * @returns The version object
+     */
+    version(versionId: string): Promise<JiraVersion>;
+    /**
+     * Fetches the related issue counts for a version.
+     *
+     * `GET /rest/api/latest/version/{id}/relatedIssueCounts`
+     *
+     * @param versionId - The version ID
+     * @returns Issue counts by type
+     */
+    versionIssueCounts(versionId: string): Promise<JiraVersionIssueCounts>;
+    /**
+     * Fetches the number of unresolved issues for a version.
+     *
+     * `GET /rest/api/latest/version/{id}/unresolvedIssueCount`
+     *
+     * @param versionId - The version ID
+     * @returns The unresolved issue count
+     */
+    versionUnresolvedIssueCount(versionId: string): Promise<JiraVersionUnresolvedIssueCount>;
+}
+
+/**
+ * Thrown when the Jira Data Center API returns a non-2xx response.
+ *
+ * @example
+ * ```typescript
+ * import { JiraApiError } from 'jira-datacenter-api-client';
+ *
+ * try {
+ *   await jira.issue('NONEXISTENT-1');
+ * } catch (err) {
+ *   if (err instanceof JiraApiError) {
+ *     console.log(err.status);     // 404
+ *     console.log(err.statusText); // 'Not Found'
+ *     console.log(err.message);    // 'Jira API error: 404 Not Found'
+ *   }
+ * }
+ * ```
+ */
+declare class JiraApiError extends Error {
+    /** HTTP status code (e.g. `404`, `401`, `403`) */
+    readonly status: number;
+    /** HTTP status text (e.g. `'Not Found'`, `'Unauthorized'`) */
+    readonly statusText: string;
+    constructor(status: number, statusText: string);
+}
+
+/**
+ * Handles Basic Authentication for Jira Data Center REST API requests.
+ *
+ * @example
+ * ```typescript
+ * const security = new Security(
+ *   'https://jira.example.com',
+ *   'my-user',
+ *   'my-token'
+ * );
+ *
+ * const headers = security.getHeaders();
+ * // { Authorization: 'Basic <base64>', 'Content-Type': 'application/json', Accept: 'application/json' }
+ * ```
+ */
+declare class Security {
+    private readonly apiUrl;
+    private readonly authorizationHeader;
+    /**
+     * Creates a new Security instance with Basic Authentication credentials.
+     *
+     * @param apiUrl - The base URL of the Jira Data Center instance (e.g., `https://jira.example.com`).
+     *   Must be a valid URL; throws if it cannot be parsed.
+     * @param user - The username to authenticate with
+     * @param token - The personal access token or password to authenticate with
+     *
+     * @throws {TypeError} If `apiUrl` is not a valid URL
+     */
+    constructor(apiUrl: string, user: string, token: string);
+    /**
+     * Returns the base URL of the Jira Data Center instance, without a trailing slash.
+     *
+     * @returns The API base URL
+     */
+    getApiUrl(): string;
+    /**
+     * Returns the value of the `Authorization` header for Basic Authentication.
+     *
+     * @returns The Authorization header value in the format `Basic <base64-encoded-credentials>`
+     */
+    getAuthorizationHeader(): string;
+    /**
+     * Returns the full set of HTTP headers required for authenticated API requests.
+     *
+     * @returns An object containing `Authorization`, `Content-Type`, and `Accept` headers
+     */
+    getHeaders(): Record<string, string>;
+}
+
+export { type BoardIssuesParams, BoardResource, type BoardsParams, type ChangelogParams, type CommentsParams, type IssueParams, IssueResource, JiraApiError, type JiraAttachment, type JiraBoard, type JiraBoardFilter, type JiraBoardProject, type JiraChangelogEntry, type JiraChangelogItem, type JiraChangelogResponse, JiraClient, type JiraClientEvents, type JiraClientOptions, type JiraComment, type JiraCommentResponse, type JiraCommentVisibility, type JiraComponent, type JiraField, type JiraFilter, type JiraFilterPermission, type JiraIssue, type JiraIssueFields, type JiraIssueLink, type JiraIssueLinkType, type JiraIssueRef, type JiraIssueType, type JiraPriority, type JiraProject, type JiraProjectRef, type JiraProjectRole, type JiraProjectRoleActor, type JiraProjectStatus, type JiraRemoteLink, type JiraRemoteLinkObject, type JiraResolution, type JiraSearchResponse, type JiraSprint, type JiraStatus, type JiraStatusCategory, type JiraSubtask, type JiraTimeTracking, type JiraTransition, type JiraTransitionField, type JiraUser, type JiraVersion, type JiraVersionIssueCounts, type JiraVersionUnresolvedIssueCount, type JiraVotes, type JiraWatchers, type JiraWorklog, type JiraWorklogResponse, type PagedResponse, type PaginationParams, ProjectResource, type ProjectsParams, type RequestEvent, type SearchParams, Security, SprintResource, type SprintsParams, type TransitionsParams, type UserSearchParams, type WorklogsParams };