@xemahq/backlog-api-client 0.1.0

package/LICENSE

@@ -0,0 +1 @@
+Copyright (c) 2026 Xema. All rights reserved.

package/dist/custom-fetch.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Configurable fetch wrapper for Orval-generated clients.
+ *
+ * Consumers must call `configureClient()` before using any endpoint function.
+ * The baseUrl is prepended to the relative paths generated by Orval.
+ *
+ * Features:
+ *   - Automatic bearer-token injection via `getAuthToken` callback
+ *   - Per-request header injection via `getHeaders` callback
+ *   - Automatic 401 handling via `onUnauthorized` callback (single retry)
+ *   - Exponential-backoff retry for transient failures (429, 502, 503, 504)
+ *   - Typed `ClientError` for non-2xx responses
+ *   - Per-call header overrides (take precedence over global headers)
+ *
+ * @example
+ *   configureClient({
+ *     baseUrl: 'http://governance-api:3400',
+ *     getAuthToken: () => identityBootstrapService.getAccessToken(),
+ *     getHeaders: () => ({ 'X-Org-Id': orgId, 'X-Correlation-Id': crypto.randomUUID() }),
+ *   });
+ */
+export interface ClientConfig {
+    /**
+     * Static base URL (e.g. 'http://localhost:3140') — no trailing slash.
+     * Mutually exclusive with `baseUrlResolver`; exactly one MUST be set.
+     */
+    baseUrl?: string;
+    /**
+     * Per-request base-URL resolver. When set, the peer URL is resolved from
+     * the service registry on EVERY request (boot-order-safe). Wired by
+     * `configureOrvalClientResolved` from `@xemahq/platform-common`.
+     */
+    baseUrlResolver?: () => string | Promise<string>;
+    /** Optional async callback to get an auth token. Auto-sets Authorization header on every request. */
+    getAuthToken?: () => Promise<string>;
+    /** Optional callback returning headers to inject on every request. Per-call headers take precedence. */
+    getHeaders?: () => Record<string, string> | Promise<Record<string, string>>;
+    /** Optional callback invoked on 401 before a single retry (e.g. force-refresh auth token). */
+    onUnauthorized?: () => Promise<void>;
+    /** Maximum retry attempts for transient failures (default: 3). Set to 0 to disable retries. */
+    maxRetries?: number;
+}
+export declare class ClientError extends Error {
+    readonly status: number;
+    readonly url: string;
+    readonly body: unknown;
+    constructor(status: number, url: string, body: unknown);
+}
+export declare function configureClient(config: ClientConfig): void;
+export declare function getClientConfig(): ClientConfig;
+export declare const customFetch: <T>(url: string, options: RequestInit) => Promise<T>;
+export default customFetch;

package/dist/custom-fetch.js

@@ -0,0 +1,152 @@
+"use strict";
+/**
+ * Configurable fetch wrapper for Orval-generated clients.
+ *
+ * Consumers must call `configureClient()` before using any endpoint function.
+ * The baseUrl is prepended to the relative paths generated by Orval.
+ *
+ * Features:
+ *   - Automatic bearer-token injection via `getAuthToken` callback
+ *   - Per-request header injection via `getHeaders` callback
+ *   - Automatic 401 handling via `onUnauthorized` callback (single retry)
+ *   - Exponential-backoff retry for transient failures (429, 502, 503, 504)
+ *   - Typed `ClientError` for non-2xx responses
+ *   - Per-call header overrides (take precedence over global headers)
+ *
+ * @example
+ *   configureClient({
+ *     baseUrl: 'http://governance-api:3400',
+ *     getAuthToken: () => identityBootstrapService.getAccessToken(),
+ *     getHeaders: () => ({ 'X-Org-Id': orgId, 'X-Correlation-Id': crypto.randomUUID() }),
+ *   });
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customFetch = exports.ClientError = void 0;
+exports.configureClient = configureClient;
+exports.getClientConfig = getClientConfig;
+class ClientError extends Error {
+    status;
+    url;
+    body;
+    constructor(status, url, body) {
+        super(`HTTP ${status} from ${url}`);
+        this.status = status;
+        this.url = url;
+        this.body = body;
+        this.name = 'ClientError';
+    }
+}
+exports.ClientError = ClientError;
+let clientConfig = null;
+function configureClient(config) {
+    clientConfig = config;
+}
+function getClientConfig() {
+    if (!clientConfig) {
+        throw new Error('Client not configured. Call configureClient({ baseUrl }) before using endpoint functions.');
+    }
+    return clientConfig;
+}
+const RETRYABLE_STATUSES = [429, 502, 503, 504];
+async function buildHeaders(config, callerHeaders) {
+    const headers = new Headers(callerHeaders);
+    // Global headers from config (caller-provided headers take precedence)
+    if (config.getHeaders) {
+        const globalHeaders = await Promise.resolve(config.getHeaders());
+        for (const [key, value] of Object.entries(globalHeaders)) {
+            if (!headers.has(key)) {
+                headers.set(key, value);
+            }
+        }
+    }
+    // Auth token (caller or global headers take precedence)
+    if (config.getAuthToken && !headers.has('Authorization')) {
+        const token = await config.getAuthToken();
+        headers.set('Authorization', `Bearer ${token}`);
+    }
+    return headers;
+}
+const customFetch = async (url, options) => {
+    const config = getClientConfig();
+    const base = config.baseUrlResolver
+        ? await config.baseUrlResolver()
+        : config.baseUrl;
+    if (base === undefined) {
+        throw new Error('Client not configured: set baseUrl or baseUrlResolver via configureClient().');
+    }
+    const fullUrl = `${base}${url}`;
+    const maxRetries = config.maxRetries ?? 3;
+    const headers = await buildHeaders(config, options.headers);
+    const requestInit = { ...options, headers };
+    let delay = 1000;
+    let lastError;
+    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+        try {
+            const response = await fetch(fullUrl, requestInit);
+            // 401 — invoke onUnauthorized and retry once (outside the transient retry loop)
+            if (response.status === 401 && config.onUnauthorized && attempt === 0) {
+                await config.onUnauthorized();
+                const refreshedHeaders = await buildHeaders(config, options.headers);
+                const retryResponse = await fetch(fullUrl, { ...options, headers: refreshedHeaders });
+                const retryBody = await parseBody(retryResponse);
+                if (retryResponse.status >= 400) {
+                    throw new ClientError(retryResponse.status, fullUrl, retryBody);
+                }
+                return retryBody;
+            }
+            // Non-retryable status — return or throw
+            if (!RETRYABLE_STATUSES.includes(response.status) || attempt >= maxRetries) {
+                const body = await parseBody(response);
+                if (response.status >= 400) {
+                    throw new ClientError(response.status, fullUrl, body);
+                }
+                return body;
+            }
+            // Retryable — wait and retry
+            const retryAfter = parseRetryAfter(response.headers.get('Retry-After'));
+            const waitMs = retryAfter ?? addJitter(delay);
+            await sleep(waitMs);
+            delay = Math.min(delay * 2, 30_000);
+        }
+        catch (error) {
+            if (error instanceof ClientError)
+                throw error; // Don't retry client errors
+            lastError = error instanceof Error ? error : new Error(String(error));
+            if (attempt >= maxRetries)
+                throw lastError;
+            const waitMs = addJitter(delay);
+            await sleep(waitMs);
+            delay = Math.min(delay * 2, 30_000);
+        }
+    }
+    throw lastError ?? new Error(`All retries exhausted for ${fullUrl}`);
+};
+exports.customFetch = customFetch;
+async function parseBody(response) {
+    const contentType = response.headers.get('content-type');
+    if (contentType?.includes('application/json')) {
+        return response.json();
+    }
+    if (response.status === 204) {
+        return undefined;
+    }
+    return response.text();
+}
+function parseRetryAfter(value) {
+    if (!value)
+        return undefined;
+    const seconds = Number(value);
+    if (!isNaN(seconds) && seconds >= 0)
+        return seconds * 1000;
+    const date = new Date(value);
+    if (!isNaN(date.getTime()))
+        return Math.max(0, date.getTime() - Date.now());
+    return undefined;
+}
+function addJitter(delay) {
+    return delay + (Math.random() * 2 - 1) * delay * 0.25;
+}
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+exports.default = exports.customFetch;

package/dist/endpoints/backlog/backlog.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Generated by orval v8.6.2 🍺
+ * Do not edit manually.
+ * Backlog API
+ * Canonical backlog items, readiness, dependencies and sync operations
+ * OpenAPI spec version: 0.1.0
+ */
+import type { AddCommentDto, BacklogCommentResponseDtoDataArrayEnvelope, BacklogCommentResponseDtoDataEnvelope, BacklogControllerCleanupByPipelineRunParams, BacklogControllerGetBoardParams, BacklogControllerGetItemTreeParams, BacklogControllerListItemsParams, BacklogControllerSearchItemsParams, BacklogControllerTagUsageParams, BacklogDependencyResponseDtoDataArrayEnvelope, BacklogDependencyResponseDtoDataEnvelope, BacklogItemResponseDtoDataArrayEnvelope, BacklogItemResponseDtoDataEnvelope, BacklogItemTreeNodeResponseDtoDataArrayEnvelope, BacklogReadyResponseDtoDataEnvelope, BoardColumnResponseDtoDataArrayEnvelope, BulkUpsertBacklogDto, BulkUpsertBacklogResponseDtoDataEnvelope, CreateBacklogItemDto, IntegrationFreshnessResponseDtoDataEnvelope, SetBacklogReadyDto, SetStatusDto, SyncResponseDtoDataEnvelope, TagUsageResponseDtoDataEnvelope, UpdateBacklogItemDto } from '../../models';
+/**
+ * @summary Get tracker integration freshness metadata
+ */
+export declare const getBacklogControllerGetIntegrationFreshnessUrl: () => string;
+export declare const backlogControllerGetIntegrationFreshness: (options?: RequestInit) => Promise<IntegrationFreshnessResponseDtoDataEnvelope>;
+/**
+ * @summary Get tag usage counts for this project
+ */
+export declare const getBacklogControllerTagUsageUrl: (params?: BacklogControllerTagUsageParams) => string;
+export declare const backlogControllerTagUsage: (params?: BacklogControllerTagUsageParams, options?: RequestInit) => Promise<TagUsageResponseDtoDataEnvelope>;
+/**
+ * @summary List backlog items for project
+ */
+export declare const getBacklogControllerListItemsUrl: (params?: BacklogControllerListItemsParams) => string;
+export declare const backlogControllerListItems: (params?: BacklogControllerListItemsParams, options?: RequestInit) => Promise<BacklogItemResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Create backlog item
+ */
+export declare const getBacklogControllerCreateItemUrl: () => string;
+export declare const backlogControllerCreateItem: (createBacklogItemDto: CreateBacklogItemDto, options?: RequestInit) => Promise<BacklogItemResponseDtoDataEnvelope>;
+/**
+ * @summary Get hierarchical item tree (epic → stories → tasks)
+ */
+export declare const getBacklogControllerGetItemTreeUrl: (params?: BacklogControllerGetItemTreeParams) => string;
+export declare const backlogControllerGetItemTree: (params?: BacklogControllerGetItemTreeParams, options?: RequestInit) => Promise<BacklogItemTreeNodeResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Search backlog items by text
+ */
+export declare const getBacklogControllerSearchItemsUrl: (params?: BacklogControllerSearchItemsParams) => string;
+export declare const backlogControllerSearchItems: (params?: BacklogControllerSearchItemsParams, options?: RequestInit) => Promise<BacklogItemResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Get a single backlog item by ID
+ */
+export declare const getBacklogControllerGetItemUrl: (id: string) => string;
+export declare const backlogControllerGetItem: (id: string, options?: RequestInit) => Promise<BacklogItemResponseDtoDataEnvelope>;
+/**
+ * @summary Update backlog item
+ */
+export declare const getBacklogControllerUpdateItemUrl: (id: string) => string;
+export declare const backlogControllerUpdateItem: (id: string, updateBacklogItemDto: UpdateBacklogItemDto, options?: RequestInit) => Promise<BacklogItemResponseDtoDataEnvelope>;
+/**
+ * @summary Delete a single backlog item
+ */
+export declare const getBacklogControllerDeleteItemUrl: (id: string) => string;
+export declare const backlogControllerDeleteItem: (id: string, options?: RequestInit) => Promise<unknown>;
+/**
+ * @summary Bulk upsert backlog items — create or update by externalId
+ */
+export declare const getBacklogControllerBulkUpsertUrl: () => string;
+export declare const backlogControllerBulkUpsert: (bulkUpsertBacklogDto: BulkUpsertBacklogDto, options?: RequestInit) => Promise<BulkUpsertBacklogResponseDtoDataEnvelope>;
+/**
+ * @summary Set item status (kanban column move)
+ */
+export declare const getBacklogControllerSetItemStatusUrl: (id: string) => string;
+export declare const backlogControllerSetItemStatus: (id: string, setStatusDto: SetStatusDto, options?: RequestInit) => Promise<BacklogItemResponseDtoDataEnvelope>;
+/**
+ * @summary Set backlog ready state
+ */
+export declare const getBacklogControllerSetReadyUrl: (id: string) => string;
+export declare const backlogControllerSetReady: (id: string, setBacklogReadyDto: SetBacklogReadyDto, options?: RequestInit) => Promise<BacklogReadyResponseDtoDataEnvelope>;
+/**
+ * @summary List comments for a backlog item
+ */
+export declare const getBacklogControllerListCommentsUrl: (id: string) => string;
+export declare const backlogControllerListComments: (id: string, options?: RequestInit) => Promise<BacklogCommentResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Add a comment to a backlog item
+ */
+export declare const getBacklogControllerAddCommentUrl: (id: string) => string;
+export declare const backlogControllerAddComment: (id: string, addCommentDto: AddCommentDto, options?: RequestInit) => Promise<BacklogCommentResponseDtoDataEnvelope>;
+/**
+ * @summary List dependencies for a backlog item
+ */
+export declare const getBacklogControllerListDependenciesUrl: (id: string) => string;
+export declare const backlogControllerListDependencies: (id: string, options?: RequestInit) => Promise<BacklogDependencyResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Add a dependency to a backlog item
+ */
+export declare const getBacklogControllerAddDependencyUrl: (id: string) => string;
+export declare const backlogControllerAddDependency: (id: string, options?: RequestInit) => Promise<BacklogDependencyResponseDtoDataEnvelope>;
+/**
+ * @summary Remove a dependency from a backlog item
+ */
+export declare const getBacklogControllerRemoveDependencyUrl: (id: string, depId: string) => string;
+export declare const backlogControllerRemoveDependency: (id: string, depId: string, options?: RequestInit) => Promise<unknown>;
+/**
+ * @summary Get kanban board — items grouped by status columns
+ */
+export declare const getBacklogControllerGetBoardUrl: (params?: BacklogControllerGetBoardParams) => string;
+export declare const backlogControllerGetBoard: (params?: BacklogControllerGetBoardParams, options?: RequestInit) => Promise<BoardColumnResponseDtoDataArrayEnvelope>;
+/**
+ * @summary Pull backlog sync from Jira
+ */
+export declare const getBacklogControllerSyncPullUrl: () => string;
+export declare const backlogControllerSyncPull: (options?: RequestInit) => Promise<SyncResponseDtoDataEnvelope>;
+/**
+ * @summary Push backlog sync to Jira
+ */
+export declare const getBacklogControllerSyncPushUrl: () => string;
+export declare const backlogControllerSyncPush: (options?: RequestInit) => Promise<SyncResponseDtoDataEnvelope>;
+/**
+ * @summary Delete backlog items created during a specific pipeline run (pipeline stop cleanup)
+ */
+export declare const getBacklogControllerCleanupByPipelineRunUrl: (params: BacklogControllerCleanupByPipelineRunParams) => string;
+export declare const backlogControllerCleanupByPipelineRun: (params: BacklogControllerCleanupByPipelineRunParams, options?: RequestInit) => Promise<unknown>;