@theholocron/jira-client 1.58.0-alpha.3 → 1.58.0-alpha.4

package/dist/index.d.mts

@@ -1,73 +1,125 @@
 import { RestClient } from "@theholocron/http-client";
 import { ErrorSink, Logger } from "@theholocron/observability/core";
+/** Options for `createJiraClient()`. */
 interface JiraClientOptions {
+  /** The base URL of the Jira REST API. */
   host: string;
+  /** The pre-encoded Basic credential (Base64 of `email:apiToken`). */
   token: string;
   /** Override fetch for testing. Defaults to globalThis.fetch. */
   fetch?: typeof fetch;
 }
+/** An issue's fields, keyed by field id or name. */
 interface JiraIssueFields {
   [key: string]: unknown;
 }
+/** A Jira issue. */
 interface JiraIssue {
+  /** The issue id. */
   id: string;
+  /** The issue key, e.g. `PROJ-123`. */
   key: string;
+  /** The issue's fields. */
   fields: JiraIssueFields;
 }
+/** A project version (release). */
 interface JiraVersion {
+  /** The version id. */
   id: string;
+  /** The version name. */
   name: string;
+  /** The key of the project the version belongs to. */
   project: string;
+  /** The start date. */
   startDate?: string;
+  /** The release date. */
   releaseDate?: string;
+  /** Whether the version has been released. */
   released?: boolean;
   [key: string]: unknown;
 }
+/** A Jira project. */
 interface JiraProject {
+  /** The project id. */
   id: string;
+  /** The project key. */
   key: string;
+  /** The project name. */
   name: string;
+  /** The issue types the project allows; present when requested with `expand=issueTypes`. */
   issueTypes?: JiraIssueType[];
 }
+/** An issue type. */
 interface JiraIssueType {
+  /** The issue type id. */
   id: string;
+  /** The issue type name. */
   name: string;
 }
+/** A workflow transition an issue can take. */
 interface JiraTransition {
+  /** The transition id. */
   id: string;
+  /** The transition name. */
   name: string;
+  /** The status the issue ends up in. */
   to: {
+    /** The target status id. */
     id: string;
+    /** The target status name. */
     name: string;
   };
 }
+/** An issue resolution. */
 interface JiraResolution {
+  /** The resolution id. */
   id: string;
+  /** The resolution name. */
   name: string;
+  /** The resolution's description. */
   description?: string;
 }
+/** A kind of link between issues. */
 interface JiraIssueLinkType {
+  /** The link type id. */
   id: string;
+  /** The link type name. */
   name: string;
+  /** The phrase describing the link from the inward issue. */
   inward: string;
+  /** The phrase describing the link from the outward issue. */
   outward: string;
 }
+/** The response of `issues.search()`. */
 interface JiraSearchResponse {
+  /** The issues on this page. */
   issues: JiraIssue[];
+  /** The total number of matches. */
   total: number;
+  /** The page size used. */
   maxResults: number;
+  /** The index of the first issue on this page. */
   startAt: number;
 }
+/** Input for `issues.search()`. */
 interface JiraSearchQuery {
+  /** The JQL query. */
   jql?: string;
+  /** The index of the first result to return. */
   startAt?: number;
+  /** The page size. */
   maxResults?: number;
+  /** The fields to return for each issue. */
   fields?: string[];
 }
+/** The outcome of linking one ticket in `links.createMany()`. */
 interface IssueLinkResult {
+  /** The ticket key that was linked. */
   ticket: string;
+  /** The HTTP status of the link request; `201` on success. */
   status: number;
 }
+/** Issue link operations. */
 declare function links(client: RestClient): {
   create(ticket: string, link: string, type: string): Promise<number>;
   createMany(tickets: string[], link: string, type: string): Promise<IssueLinkResult[]>;
@@ -75,6 +127,7 @@ declare function links(client: RestClient): {
     issueLinkTypes: JiraIssueLinkType[];
   }>;
 };
+/** Issue operations: create, read, update and search. */
 declare function issues(client: RestClient): {
   create(title: string, type: string, project: string, fields?: JiraIssueFields): Promise<JiraIssue>;
   get(ticket: string, params?: Record<string, string>): Promise<JiraIssue>;
@@ -83,9 +136,11 @@ declare function issues(client: RestClient): {
   getProperty(ticket: string, property: string): Promise<unknown>;
   search(query?: JiraSearchQuery): Promise<JiraSearchResponse>;
 };
+/** Project operations. */
 declare function projects(client: RestClient): {
   get(id: string): Promise<JiraProject>;
 };
+/** Issue transition operations. */
 declare function transitions(client: RestClient): {
   create(ticket: string, statusId: string, fields?: JiraIssueFields): Promise<void>;
   get(ticket: string): Promise<{
@@ -93,6 +148,7 @@ declare function transitions(client: RestClient): {
   }>;
   getResolutions(): Promise<JiraResolution[]>;
 };
+/** Project version (release) operations. */
 declare function versions(client: RestClient): {
   create(name: string, project: string, fields?: Partial<JiraVersion>): Promise<JiraVersion>;
   get(version: string, params?: Record<string, string>): Promise<JiraVersion>;
@@ -100,6 +156,7 @@ declare function versions(client: RestClient): {
   update(version: string, fields: Partial<JiraVersion>): Promise<JiraVersion>;
   delete(version: string): Promise<void>;
 };
+/** Create a Jira client with `issues`, `links`, `projects`, `transitions` and `versions` groups, all sharing one REST client. `options.token` is the pre-encoded Basic credential (Base64 of `email:apiToken`). */
 export declare function createJiraClient(options: {
   host: string;
   token: string;

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import { ProviderApiError, createRestClient } from "@theholocron/http-client";
 // src/issues.ts
+/** Issue operations: create, read, update and search. */
 function issues(client) {
 	return {
 		create(title, type, project, fields = {}) {
@@ -39,6 +40,7 @@ function issues(client) {
 	};
 }
 // src/links.ts
+/** Issue link operations. */
 function links(client) {
 	return {
 		async create(ticket, link, type) {
@@ -69,12 +71,14 @@ function links(client) {
 	};
 }
 // src/projects.ts
+/** Project operations. */
 function projects(client) {
 	return { get(id) {
 		return client.request(`/project/${id}`, { query: { expand: "issueTypes" } });
 	} };
 }
 // src/transitions.ts
+/** Issue transition operations. */
 function transitions(client) {
 	return {
 		create(ticket, statusId, fields = {}) {
@@ -95,6 +99,7 @@ function transitions(client) {
 	};
 }
 // src/versions.ts
+/** Project version (release) operations. */
 function versions(client) {
 	return {
 		create(name, project, fields = {}) {
@@ -126,6 +131,7 @@ function versions(client) {
 	};
 }
 // src/index.ts
+/** Create a Jira client with `issues`, `links`, `projects`, `transitions` and `versions` groups, all sharing one REST client. `options.token` is the pre-encoded Basic credential (Base64 of `email:apiToken`). */
 function createJiraClient(options) {
 	const client = createRestClient({
 		baseUrl: options.host,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/jira-client",
-  "version": "1.58.0-alpha.3",
+  "version": "1.58.0-alpha.4",
   "description": "A TypeScript client for the Jira REST API",
   "keywords": [
     "jira",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/http-client": "^1.58.0-alpha.3",
+    "@theholocron/http-client": "^1.58.0-alpha.4",
     "@theholocron/observability": "^0.6.1-alpha.1"
   },
   "devDependencies": {
@@ -45,10 +45,10 @@
     "tsdown": "^0.23.3",
     "typescript": "^5.9.3",
     "vitest": "^5.0.5",
-    "@theholocron/eslint-config": "^8.9.0-alpha.3",
-    "@theholocron/vitest-config": "^8.9.0-alpha.3",
-    "@theholocron/tsconfig": "^8.9.0-alpha.3",
-    "@theholocron/tsdown-config": "^8.9.0-alpha.3"
+    "@theholocron/tsconfig": "^8.9.0-alpha.5",
+    "@theholocron/tsdown-config": "^8.9.0-alpha.5",
+    "@theholocron/eslint-config": "^8.9.0-alpha.5",
+    "@theholocron/vitest-config": "^8.9.0-alpha.5"
   },
   "engines": {
     "node": ">=22.0.0"