@felixgeelhaar/jira-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,250 @@
+import { RetryMiddlewareConfig, RateLimitMiddlewareConfig, CircuitBreakerConfig, Middleware, CircuitBreaker, AuthProvider, Logger, HttpClient } from '@felixgeelhaar/sdk-core';
+export { AbortError, ApiError, ApiTokenAuth, ApiTokenAuthConfig, AuthConfigError, AuthError, AuthProvider, BasicAuth, BasicAuthConfig, CircuitBreaker, CircuitBreakerConfig, CircuitBreakerOpenError, CircuitState, ConfigValidationError, ConsoleLogger, ForbiddenError, JiraSdkError, LogLevel, Logger, Middleware, MiddlewareContext, NetworkError, NoopLogger, NotFoundError, OAuth2Auth, OAuth2AuthConfig, PatAuth, PatAuthConfig, RateLimitError, ResponseValidationError, ServerError, TimeoutError, TokenExpiredError, TokenRefreshError, UnauthorizedError, ValidationError, composeMiddleware, createApiTokenAuth, createBasicAuth, createCircuitBreakerMiddleware, createDefaultCircuitBreaker, createLoggingMiddleware, createOAuth2Auth, createPatAuth, createRateLimitMiddleware, createRequestIdMiddleware, createRetryMiddleware, createUserAgentMiddleware } from '@felixgeelhaar/sdk-core';
+import { IssueService, ProjectService, SearchService, UserService } from './services/index.cjs';
+export { BaseService, SearchOptions, SearchResult } from './services/index.cjs';
+export { AddAttachmentResponse, AddAttachmentResponseSchema, Attachment, AttachmentMetadata, AttachmentMetadataSchema, AttachmentSchema, Component, ComponentInput, ComponentInputSchema, ComponentSchema, CreateIssueLinkInput, CreateIssueLinkInputSchema, Insight, InsightSchema, IssueLink, IssueLinkSchema, IssueLinkType, IssueLinkTypeSchema, IssueLinkTypesResponse, IssueLinkTypesResponseSchema, IssuePriority, IssuePrioritySchema, IssueProject, IssueProjectSchema, IssueResolution, IssueResolutionSchema, IssueStatus, IssueStatusSchema, IssueType, IssueTypeInput, IssueTypeInputSchema, IssueTypeSchema, PriorityInput, PriorityInputSchema, ProjectCategory, ProjectCategorySchema, ProjectInput, ProjectInputSchema, ProjectLead, ProjectLeadSchema, ProjectStyle, ProjectStyleSchema, ProjectType, ProjectTypeSchema, ResolutionInput, ResolutionInputSchema, StatusCategory, StatusCategorySchema, Version, VersionInput, VersionInputSchema, VersionSchema } from './schemas/index.cjs';
+export { q as AddCommentInput, A as AddCommentInputSchema, H as AddWorklogInput, F as AddWorklogInputSchema, p as Comment, o as CommentSchema, n as CommentVisibility, m as CommentVisibilitySchema, u as CommentsPage, t as CommentsPageSchema, f as CreateIssueFields, C as CreateIssueFieldsSchema, h as CreateIssueInput, g as CreateIssueInputSchema, k as CreateIssueResponse, j as CreateIssueResponseSchema, X as CreateProjectInput, V as CreateProjectInputSchema, y as DoTransitionInput, D as DoTransitionInputSchema, l as GetIssueOptions, G as GetIssueOptionsSchema, a1 as GetProjectsOptions, a0 as GetProjectsOptionsSchema, e as Issue, c as IssueFields, b as IssueFieldsSchema, a as IssueRef, I as IssueRefSchema, d as IssueSchema, S as Project, Q as ProjectRef, P as ProjectRefSchema, R as ProjectSchema, $ as ProjectSearchResult, _ as ProjectSearchResultSchema, v as Transition, T as TransitionSchema, x as TransitionsResponse, w as TransitionsResponseSchema, s as UpdateCommentInput, r as UpdateCommentInputSchema, i as UpdateIssueInput, U as UpdateIssueInputSchema, Z as UpdateProjectInput, Y as UpdateProjectInputSchema, K as UpdateWorklogInput, J as UpdateWorklogInputSchema, O as Watchers, N as WatchersSchema, E as Worklog, B as WorklogSchema, z as WorklogVisibility, W as WorklogVisibilitySchema, M as WorklogsPage, L as WorklogsPageSchema } from './project-DNkPXkPv.cjs';
+import 'zod';
+import '@felixgeelhaar/sdk-core/schemas';
+
+/**
+ * Resilience configuration for the Jira client
+ */
+interface ResilienceConfig {
+    /**
+     * Retry configuration
+     * Set to false to disable retries
+     */
+    retry?: RetryMiddlewareConfig | false;
+    /**
+     * Client-side rate limiting configuration
+     * Set to false to disable
+     */
+    rateLimit?: RateLimitMiddlewareConfig | false;
+    /**
+     * Circuit breaker configuration
+     * Set to false to disable
+     */
+    circuitBreaker?: CircuitBreakerConfig | false;
+}
+/**
+ * Default resilience configuration optimized for Jira API
+ */
+declare const DEFAULT_RESILIENCE_CONFIG: ResilienceConfig;
+/**
+ * Result of creating resilience middleware
+ */
+interface ResilienceMiddlewareResult {
+    /**
+     * Combined middleware to add to the HTTP client
+     */
+    middleware: Middleware;
+    /**
+     * Circuit breaker instance (if enabled) for monitoring
+     */
+    circuitBreaker: CircuitBreaker | undefined;
+}
+/**
+ * Create resilience middleware for the Jira client
+ *
+ * This function creates a composed middleware that includes:
+ * - Retry with exponential backoff for transient failures
+ * - Client-side rate limiting to avoid hitting Jira's limits
+ * - Circuit breaker for fail-fast behavior
+ *
+ * @example
+ * ```typescript
+ * import { createJiraClient } from '@felixgeelhaar/jira-sdk';
+ * import { createResilienceMiddleware } from '@felixgeelhaar/jira-sdk/client/resilience';
+ *
+ * const { middleware, circuitBreaker } = createResilienceMiddleware();
+ *
+ * const client = createJiraClient({
+ *   host: 'https://your-domain.atlassian.net',
+ *   auth: apiTokenAuth,
+ *   middleware: [middleware],
+ * });
+ *
+ * // Monitor circuit breaker state
+ * console.log(circuitBreaker?.getStats());
+ * ```
+ *
+ * @example Custom configuration
+ * ```typescript
+ * const { middleware } = createResilienceMiddleware({
+ *   retry: {
+ *     maxRetries: 5,
+ *     initialDelayMs: 500,
+ *   },
+ *   rateLimit: false, // Disable rate limiting
+ *   circuitBreaker: {
+ *     failureThreshold: 10,
+ *     resetTimeoutMs: 60000,
+ *   },
+ * });
+ * ```
+ */
+declare function createResilienceMiddleware(config?: ResilienceConfig): ResilienceMiddlewareResult;
+/**
+ * Create a Jira client option that adds resilience middleware
+ *
+ * @example
+ * ```typescript
+ * import { JiraClient, withResilience } from '@felixgeelhaar/jira-sdk';
+ *
+ * const client = new JiraClient(
+ *   { host: '...', auth: '...' },
+ *   withResilience()
+ * );
+ * ```
+ */
+declare function withResilience(config?: ResilienceConfig): (internalConfig: {
+    middleware?: Middleware[];
+}) => void;
+
+/**
+ * Jira client configuration
+ */
+interface JiraClientConfig {
+    /**
+     * Jira Cloud instance URL (e.g., https://your-domain.atlassian.net)
+     */
+    host: string;
+    /**
+     * Authentication provider
+     */
+    auth: AuthProvider;
+    /**
+     * Logger instance (optional)
+     */
+    logger?: Logger;
+    /**
+     * Request timeout in milliseconds (default: 30000)
+     */
+    timeout?: number;
+    /**
+     * Additional middleware to apply
+     */
+    middleware?: Middleware[];
+    /**
+     * User agent suffix (optional)
+     */
+    userAgent?: string;
+    /**
+     * API version (default: '3')
+     */
+    apiVersion?: '2' | '3';
+    /**
+     * Enable automatic retry on failures (default: true)
+     */
+    retryEnabled?: boolean;
+    /**
+     * Maximum number of retries (default: 3)
+     */
+    maxRetries?: number;
+    /**
+     * Enable request logging (default: false)
+     */
+    debug?: boolean;
+}
+/**
+ * Functional option for client configuration
+ */
+type JiraClientOption = (config: JiraClientConfig) => JiraClientConfig;
+
+/**
+ * Jira API Client
+ *
+ * The main entry point for interacting with the Jira REST API.
+ * Provides access to all Jira services through a unified interface.
+ *
+ * @example
+ * ```typescript
+ * import { JiraClient, ApiTokenAuth } from '@felixgeelhaar/jira-sdk';
+ *
+ * const client = new JiraClient({
+ *   host: 'https://your-domain.atlassian.net',
+ *   auth: new ApiTokenAuth({
+ *     email: 'user@example.com',
+ *     apiToken: 'your-api-token',
+ *   }),
+ * });
+ *
+ * // Get an issue
+ * const issue = await client.issues.get('PROJECT-123');
+ *
+ * // Search issues
+ * const results = await client.search.jql('project = PROJECT AND status = Open');
+ * ```
+ */
+declare class JiraClient {
+    private readonly httpClient;
+    private readonly config;
+    private _issues?;
+    private _projects?;
+    private _search?;
+    private _users?;
+    constructor(config: JiraClientConfig, ...options: JiraClientOption[]);
+    /**
+     * Get the API base path for the configured version
+     */
+    get apiBasePath(): string;
+    /**
+     * Get the Agile API base path
+     */
+    get agileApiBasePath(): string;
+    /**
+     * Issues service - CRUD operations for issues
+     */
+    get issues(): IssueService;
+    /**
+     * Projects service - CRUD operations for projects
+     */
+    get projects(): ProjectService;
+    /**
+     * Search service - JQL search and filters
+     */
+    get search(): SearchService;
+    /**
+     * Users service - User management
+     */
+    get users(): UserService;
+    /**
+     * Get the underlying HTTP client for advanced usage
+     */
+    getHttpClient(): HttpClient;
+    /**
+     * Get the configured host URL
+     */
+    getHost(): string;
+}
+/**
+ * Factory function to create a Jira client
+ */
+declare function createJiraClient(config: JiraClientConfig, ...options: JiraClientOption[]): JiraClient;
+/**
+ * Set the API version
+ */
+declare function withApiVersion(version: '2' | '3'): JiraClientOption;
+/**
+ * Set the request timeout
+ */
+declare function withTimeout(timeout: number): JiraClientOption;
+/**
+ * Enable debug logging
+ */
+declare function withDebug(enabled?: boolean): JiraClientOption;
+/**
+ * Configure retry behavior
+ */
+declare function withRetry(enabled: boolean, maxRetries?: number): JiraClientOption;
+/**
+ * Add custom middleware
+ */
+declare function withMiddleware(...middleware: Middleware[]): JiraClientOption;
+/**
+ * Set custom logger
+ */
+declare function withLogger(logger: Logger): JiraClientOption;
+
+export { DEFAULT_RESILIENCE_CONFIG, IssueService, JiraClient, type JiraClientConfig, type JiraClientOption, ProjectService, type ResilienceConfig, type ResilienceMiddlewareResult, SearchService, UserService, createJiraClient, createResilienceMiddleware, withApiVersion, withDebug, withLogger, withMiddleware, withResilience, withRetry, withTimeout };

package/dist/index.d.ts

@@ -0,0 +1,250 @@
+import { RetryMiddlewareConfig, RateLimitMiddlewareConfig, CircuitBreakerConfig, Middleware, CircuitBreaker, AuthProvider, Logger, HttpClient } from '@felixgeelhaar/sdk-core';
+export { AbortError, ApiError, ApiTokenAuth, ApiTokenAuthConfig, AuthConfigError, AuthError, AuthProvider, BasicAuth, BasicAuthConfig, CircuitBreaker, CircuitBreakerConfig, CircuitBreakerOpenError, CircuitState, ConfigValidationError, ConsoleLogger, ForbiddenError, JiraSdkError, LogLevel, Logger, Middleware, MiddlewareContext, NetworkError, NoopLogger, NotFoundError, OAuth2Auth, OAuth2AuthConfig, PatAuth, PatAuthConfig, RateLimitError, ResponseValidationError, ServerError, TimeoutError, TokenExpiredError, TokenRefreshError, UnauthorizedError, ValidationError, composeMiddleware, createApiTokenAuth, createBasicAuth, createCircuitBreakerMiddleware, createDefaultCircuitBreaker, createLoggingMiddleware, createOAuth2Auth, createPatAuth, createRateLimitMiddleware, createRequestIdMiddleware, createRetryMiddleware, createUserAgentMiddleware } from '@felixgeelhaar/sdk-core';
+import { IssueService, ProjectService, SearchService, UserService } from './services/index.js';
+export { BaseService, SearchOptions, SearchResult } from './services/index.js';
+export { AddAttachmentResponse, AddAttachmentResponseSchema, Attachment, AttachmentMetadata, AttachmentMetadataSchema, AttachmentSchema, Component, ComponentInput, ComponentInputSchema, ComponentSchema, CreateIssueLinkInput, CreateIssueLinkInputSchema, Insight, InsightSchema, IssueLink, IssueLinkSchema, IssueLinkType, IssueLinkTypeSchema, IssueLinkTypesResponse, IssueLinkTypesResponseSchema, IssuePriority, IssuePrioritySchema, IssueProject, IssueProjectSchema, IssueResolution, IssueResolutionSchema, IssueStatus, IssueStatusSchema, IssueType, IssueTypeInput, IssueTypeInputSchema, IssueTypeSchema, PriorityInput, PriorityInputSchema, ProjectCategory, ProjectCategorySchema, ProjectInput, ProjectInputSchema, ProjectLead, ProjectLeadSchema, ProjectStyle, ProjectStyleSchema, ProjectType, ProjectTypeSchema, ResolutionInput, ResolutionInputSchema, StatusCategory, StatusCategorySchema, Version, VersionInput, VersionInputSchema, VersionSchema } from './schemas/index.js';
+export { q as AddCommentInput, A as AddCommentInputSchema, H as AddWorklogInput, F as AddWorklogInputSchema, p as Comment, o as CommentSchema, n as CommentVisibility, m as CommentVisibilitySchema, u as CommentsPage, t as CommentsPageSchema, f as CreateIssueFields, C as CreateIssueFieldsSchema, h as CreateIssueInput, g as CreateIssueInputSchema, k as CreateIssueResponse, j as CreateIssueResponseSchema, X as CreateProjectInput, V as CreateProjectInputSchema, y as DoTransitionInput, D as DoTransitionInputSchema, l as GetIssueOptions, G as GetIssueOptionsSchema, a1 as GetProjectsOptions, a0 as GetProjectsOptionsSchema, e as Issue, c as IssueFields, b as IssueFieldsSchema, a as IssueRef, I as IssueRefSchema, d as IssueSchema, S as Project, Q as ProjectRef, P as ProjectRefSchema, R as ProjectSchema, $ as ProjectSearchResult, _ as ProjectSearchResultSchema, v as Transition, T as TransitionSchema, x as TransitionsResponse, w as TransitionsResponseSchema, s as UpdateCommentInput, r as UpdateCommentInputSchema, i as UpdateIssueInput, U as UpdateIssueInputSchema, Z as UpdateProjectInput, Y as UpdateProjectInputSchema, K as UpdateWorklogInput, J as UpdateWorklogInputSchema, O as Watchers, N as WatchersSchema, E as Worklog, B as WorklogSchema, z as WorklogVisibility, W as WorklogVisibilitySchema, M as WorklogsPage, L as WorklogsPageSchema } from './project-DNkPXkPv.js';
+import 'zod';
+import '@felixgeelhaar/sdk-core/schemas';
+
+/**
+ * Resilience configuration for the Jira client
+ */
+interface ResilienceConfig {
+    /**
+     * Retry configuration
+     * Set to false to disable retries
+     */
+    retry?: RetryMiddlewareConfig | false;
+    /**
+     * Client-side rate limiting configuration
+     * Set to false to disable
+     */
+    rateLimit?: RateLimitMiddlewareConfig | false;
+    /**
+     * Circuit breaker configuration
+     * Set to false to disable
+     */
+    circuitBreaker?: CircuitBreakerConfig | false;
+}
+/**
+ * Default resilience configuration optimized for Jira API
+ */
+declare const DEFAULT_RESILIENCE_CONFIG: ResilienceConfig;
+/**
+ * Result of creating resilience middleware
+ */
+interface ResilienceMiddlewareResult {
+    /**
+     * Combined middleware to add to the HTTP client
+     */
+    middleware: Middleware;
+    /**
+     * Circuit breaker instance (if enabled) for monitoring
+     */
+    circuitBreaker: CircuitBreaker | undefined;
+}
+/**
+ * Create resilience middleware for the Jira client
+ *
+ * This function creates a composed middleware that includes:
+ * - Retry with exponential backoff for transient failures
+ * - Client-side rate limiting to avoid hitting Jira's limits
+ * - Circuit breaker for fail-fast behavior
+ *
+ * @example
+ * ```typescript
+ * import { createJiraClient } from '@felixgeelhaar/jira-sdk';
+ * import { createResilienceMiddleware } from '@felixgeelhaar/jira-sdk/client/resilience';
+ *
+ * const { middleware, circuitBreaker } = createResilienceMiddleware();
+ *
+ * const client = createJiraClient({
+ *   host: 'https://your-domain.atlassian.net',
+ *   auth: apiTokenAuth,
+ *   middleware: [middleware],
+ * });
+ *
+ * // Monitor circuit breaker state
+ * console.log(circuitBreaker?.getStats());
+ * ```
+ *
+ * @example Custom configuration
+ * ```typescript
+ * const { middleware } = createResilienceMiddleware({
+ *   retry: {
+ *     maxRetries: 5,
+ *     initialDelayMs: 500,
+ *   },
+ *   rateLimit: false, // Disable rate limiting
+ *   circuitBreaker: {
+ *     failureThreshold: 10,
+ *     resetTimeoutMs: 60000,
+ *   },
+ * });
+ * ```
+ */
+declare function createResilienceMiddleware(config?: ResilienceConfig): ResilienceMiddlewareResult;
+/**
+ * Create a Jira client option that adds resilience middleware
+ *
+ * @example
+ * ```typescript
+ * import { JiraClient, withResilience } from '@felixgeelhaar/jira-sdk';
+ *
+ * const client = new JiraClient(
+ *   { host: '...', auth: '...' },
+ *   withResilience()
+ * );
+ * ```
+ */
+declare function withResilience(config?: ResilienceConfig): (internalConfig: {
+    middleware?: Middleware[];
+}) => void;
+
+/**
+ * Jira client configuration
+ */
+interface JiraClientConfig {
+    /**
+     * Jira Cloud instance URL (e.g., https://your-domain.atlassian.net)
+     */
+    host: string;
+    /**
+     * Authentication provider
+     */
+    auth: AuthProvider;
+    /**
+     * Logger instance (optional)
+     */
+    logger?: Logger;
+    /**
+     * Request timeout in milliseconds (default: 30000)
+     */
+    timeout?: number;
+    /**
+     * Additional middleware to apply
+     */
+    middleware?: Middleware[];
+    /**
+     * User agent suffix (optional)
+     */
+    userAgent?: string;
+    /**
+     * API version (default: '3')
+     */
+    apiVersion?: '2' | '3';
+    /**
+     * Enable automatic retry on failures (default: true)
+     */
+    retryEnabled?: boolean;
+    /**
+     * Maximum number of retries (default: 3)
+     */
+    maxRetries?: number;
+    /**
+     * Enable request logging (default: false)
+     */
+    debug?: boolean;
+}
+/**
+ * Functional option for client configuration
+ */
+type JiraClientOption = (config: JiraClientConfig) => JiraClientConfig;
+
+/**
+ * Jira API Client
+ *
+ * The main entry point for interacting with the Jira REST API.
+ * Provides access to all Jira services through a unified interface.
+ *
+ * @example
+ * ```typescript
+ * import { JiraClient, ApiTokenAuth } from '@felixgeelhaar/jira-sdk';
+ *
+ * const client = new JiraClient({
+ *   host: 'https://your-domain.atlassian.net',
+ *   auth: new ApiTokenAuth({
+ *     email: 'user@example.com',
+ *     apiToken: 'your-api-token',
+ *   }),
+ * });
+ *
+ * // Get an issue
+ * const issue = await client.issues.get('PROJECT-123');
+ *
+ * // Search issues
+ * const results = await client.search.jql('project = PROJECT AND status = Open');
+ * ```
+ */
+declare class JiraClient {
+    private readonly httpClient;
+    private readonly config;
+    private _issues?;
+    private _projects?;
+    private _search?;
+    private _users?;
+    constructor(config: JiraClientConfig, ...options: JiraClientOption[]);
+    /**
+     * Get the API base path for the configured version
+     */
+    get apiBasePath(): string;
+    /**
+     * Get the Agile API base path
+     */
+    get agileApiBasePath(): string;
+    /**
+     * Issues service - CRUD operations for issues
+     */
+    get issues(): IssueService;
+    /**
+     * Projects service - CRUD operations for projects
+     */
+    get projects(): ProjectService;
+    /**
+     * Search service - JQL search and filters
+     */
+    get search(): SearchService;
+    /**
+     * Users service - User management
+     */
+    get users(): UserService;
+    /**
+     * Get the underlying HTTP client for advanced usage
+     */
+    getHttpClient(): HttpClient;
+    /**
+     * Get the configured host URL
+     */
+    getHost(): string;
+}
+/**
+ * Factory function to create a Jira client
+ */
+declare function createJiraClient(config: JiraClientConfig, ...options: JiraClientOption[]): JiraClient;
+/**
+ * Set the API version
+ */
+declare function withApiVersion(version: '2' | '3'): JiraClientOption;
+/**
+ * Set the request timeout
+ */
+declare function withTimeout(timeout: number): JiraClientOption;
+/**
+ * Enable debug logging
+ */
+declare function withDebug(enabled?: boolean): JiraClientOption;
+/**
+ * Configure retry behavior
+ */
+declare function withRetry(enabled: boolean, maxRetries?: number): JiraClientOption;
+/**
+ * Add custom middleware
+ */
+declare function withMiddleware(...middleware: Middleware[]): JiraClientOption;
+/**
+ * Set custom logger
+ */
+declare function withLogger(logger: Logger): JiraClientOption;
+
+export { DEFAULT_RESILIENCE_CONFIG, IssueService, JiraClient, type JiraClientConfig, type JiraClientOption, ProjectService, type ResilienceConfig, type ResilienceMiddlewareResult, SearchService, UserService, createJiraClient, createResilienceMiddleware, withApiVersion, withDebug, withLogger, withMiddleware, withResilience, withRetry, withTimeout };