@fedpulse/sdk 1.0.0

package/dist/types/errors.d.ts

@@ -0,0 +1,139 @@
+/**
+ * FedPulse SDK error classes.
+ *
+ * All errors thrown by the SDK extend FedPulseError so callers can use
+ * `instanceof FedPulseError` to distinguish SDK errors from other exceptions.
+ */
+/**
+ * Base class for all FedPulse SDK errors.
+ */
+export declare class FedPulseError extends Error {
+    /** HTTP status code returned by the API, or 0 for network errors. */
+    readonly status: number;
+    /** Machine-readable error code from the API (e.g. NOT_FOUND, RATE_LIMIT_EXCEEDED). */
+    readonly code: string;
+    /** Request ID for debugging — correlates with API logs. */
+    readonly requestId: string | undefined;
+    /** Additional structured details from the API response. */
+    readonly details: unknown | undefined;
+    constructor({ message, status, code, requestId, details, }: {
+        message: string;
+        status: number;
+        code: string;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns 401 Unauthorized.
+ * Usually caused by missing, invalid, or revoked API key / JWT.
+ */
+export declare class AuthenticationError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns 403 Forbidden.
+ * Usually caused by insufficient plan permissions or missing key scope.
+ */
+export declare class PermissionError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        code?: string;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns 404 Not Found.
+ */
+export declare class NotFoundError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns 422 Unprocessable Entity or 400 Bad Request
+ * due to invalid request parameters or body.
+ */
+export declare class ValidationError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        status?: number;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns 429 Too Many Requests.
+ * The `retryAfter` property indicates when the rate limit resets (Unix seconds).
+ */
+export declare class RateLimitError extends FedPulseError {
+    /** Unix epoch seconds when the rate limit window resets. */
+    readonly retryAfter: number | undefined;
+    constructor(params: {
+        message: string;
+        retryAfter?: number;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when the API returns a 5xx server error.
+ */
+export declare class ServerError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        status?: number;
+        code?: string;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+/**
+ * Thrown when a network-level failure occurs (DNS, TCP, timeout, ECONNREFUSED).
+ * The `cause` property contains the original error.
+ */
+export declare class NetworkError extends FedPulseError {
+    /** The underlying network error. */
+    readonly cause: Error;
+    constructor(params: {
+        message: string;
+        cause: Error;
+    });
+}
+/**
+ * Thrown when a request exceeds the configured timeout.
+ */
+export declare class TimeoutError extends FedPulseError {
+    constructor(params: {
+        message: string;
+        requestId?: string;
+    });
+}
+/**
+ * Thrown when the SDK's retry budget is exhausted.
+ * The `lastError` property contains the final underlying error.
+ */
+export declare class RetryExhaustedError extends FedPulseError {
+    readonly lastError: FedPulseError;
+    readonly attempts: number;
+    constructor(params: {
+        lastError: FedPulseError;
+        attempts: number;
+    });
+}
+/**
+ * Factory — parses a raw API error response object into the correct error subtype.
+ *
+ * @param status   HTTP response status code.
+ * @param body     Parsed JSON body (may be the error envelope or anything).
+ * @param headers  Response headers map (used for Retry-After).
+ */
+export declare function createApiError(status: number, body: unknown, headers: Record<string, string | null>): FedPulseError;
+//# sourceMappingURL=errors.d.ts.map

package/dist/types/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC,qEAAqE;IACrE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,sFAAsF;IACtF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,2DAA2D;IAC3D,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;gBAE1B,EACV,OAAO,EACP,MAAM,EACN,IAAI,EACJ,SAAS,EACT,OAAO,GACR,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CAUF;AAID;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE;CAK/E;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE;CAK9F;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;gBAClC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE;CAK/E;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,aAAa;gBACpC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CAKF;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,aAAa;IAC/C,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;gBAE5B,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CAMF;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,aAAa;gBAChC,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;CAKF;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,aAAa;IAC7C,oCAAoC;IACpC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;gBAEV,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE;CAMtD;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,aAAa;gBACjC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE;CAK5D;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,aAAa;IACpD,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAClC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE;QAAE,SAAS,EAAE,aAAa,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;CAYnE;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,OAAO,EACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,GACrC,aAAa,CAuCf"}

package/dist/types/http.d.cts

@@ -0,0 +1,137 @@
+/**
+ * Core HTTP client for the FedPulse SDK.
+ *
+ * Features:
+ *  - Native fetch (Node 18+) — zero runtime dependencies
+ *  - Configurable timeout via AbortController
+ *  - Automatic retry with exponential back-off + full jitter for transient errors
+ *  - In-memory LRU cache for GET requests with per-entry TTL
+ *  - Rate-limit header tracking (X-RateLimit-*)
+ *  - Standard API envelope parsing + typed error creation
+ *  - Array query-parameter serialisation (repeated keys)
+ */
+import type { RateLimitInfo, Pagination } from './types/common.cjs';
+/**
+ * Serialise a plain-object params map to a URLSearchParams instance.
+ *
+ * Arrays are serialised as repeated keys: `{ naics: ['11', '21'] }` →
+ * `?naics=11&naics=21`.
+ *
+ * Undefined and null values are omitted.
+ */
+export declare function buildQueryParams(params: Record<string, unknown>): URLSearchParams;
+export interface HttpClientOptions {
+    /** API key or JWT token. Sent as `Authorization: Bearer <apiKey>`. */
+    apiKey: string;
+    /** API base URL. Defaults to `https://api.fedpulse.dev`. */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds. Applies to each individual attempt (not
+     * total retry budget). Default: 30 000 ms.
+     */
+    timeoutMs?: number;
+    /**
+     * Maximum number of retry attempts for transient errors.
+     * Set to 0 to disable retries. Default: 3.
+     */
+    maxRetries?: number;
+    /**
+     * Maximum number of GET responses to cache in memory.
+     * Set to 0 to disable caching. Default: 256.
+     */
+    cacheSize?: number;
+    /**
+     * Default TTL for cached GET responses in milliseconds. Default: 60 000 ms.
+     */
+    cacheTtlMs?: number;
+    /**
+     * Custom `fetch` implementation. Defaults to the global `fetch`.
+     * Useful for testing or environments with a non-standard fetch.
+     */
+    fetchFn?: typeof fetch;
+}
+export interface RequestOptions {
+    /**
+     * Override cache TTL for this specific request (ms).
+     * Pass 0 to bypass cache entirely.
+     */
+    cacheTtlMs?: number;
+    /** Extra headers to merge into this request. */
+    headers?: Record<string, string>;
+}
+export interface ParsedResponse<T> {
+    data: T;
+    pagination: Pagination;
+    meta: {
+        requestId: string;
+        cached?: boolean;
+        [key: string]: unknown;
+    };
+    rateLimit: RateLimitInfo | null;
+    /** Whether the result was served from the in-memory cache. */
+    fromCache: boolean;
+}
+/**
+ * Low-level HTTP client used by all domain resources.
+ *
+ * You should not need to instantiate this directly — use `FedPulse` instead.
+ */
+export declare class HttpClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    private readonly cache;
+    private readonly defaultCacheTtlMs;
+    private readonly fetchFn;
+    /** Most recent rate-limit info observed across all requests. */
+    lastRateLimit: RateLimitInfo | null;
+    constructor(options: HttpClientOptions);
+    /**
+     * Perform a GET request. Results are cached unless `cacheTtlMs` is 0.
+     *
+     * @param path     API path (e.g. `/v1/opportunities`).
+     * @param params   Query parameters — arrays serialised as repeated keys.
+     * @param options  Per-request overrides.
+     */
+    get<T>(path: string, params?: Record<string, unknown>, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a POST request (never cached).
+     *
+     * @param path   API path.
+     * @param body   JSON-serialisable request body.
+     * @param options  Per-request overrides.
+     */
+    post<T>(path: string, body: unknown, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a PATCH request (never cached).
+     */
+    patch<T>(path: string, body: unknown, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a DELETE request (never cached).
+     */
+    del<T = null>(path: string, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Clear all cached responses.
+     */
+    clearCache(): void;
+    /**
+     * Execute a request, retrying on transient failures with exponential back-off
+     * and full jitter.
+     */
+    private executeWithRetry;
+    /**
+     * Execute a single HTTP request (no retry logic).
+     * Handles timeout, response parsing, header extraction, and error creation.
+     */
+    private executeOnce;
+    /**
+     * Perform a raw fetch that returns the full Response (for streaming downloads).
+     * No retry, no envelope parsing.
+     *
+     * @param path   API path.
+     * @param params Query parameters.
+     */
+    rawGet(path: string, params?: Record<string, unknown>): Promise<Response>;
+}
+//# sourceMappingURL=http.d.ts.map

package/dist/types/http.d.ts

@@ -0,0 +1,137 @@
+/**
+ * Core HTTP client for the FedPulse SDK.
+ *
+ * Features:
+ *  - Native fetch (Node 18+) — zero runtime dependencies
+ *  - Configurable timeout via AbortController
+ *  - Automatic retry with exponential back-off + full jitter for transient errors
+ *  - In-memory LRU cache for GET requests with per-entry TTL
+ *  - Rate-limit header tracking (X-RateLimit-*)
+ *  - Standard API envelope parsing + typed error creation
+ *  - Array query-parameter serialisation (repeated keys)
+ */
+import type { RateLimitInfo, Pagination } from './types/common.js';
+/**
+ * Serialise a plain-object params map to a URLSearchParams instance.
+ *
+ * Arrays are serialised as repeated keys: `{ naics: ['11', '21'] }` →
+ * `?naics=11&naics=21`.
+ *
+ * Undefined and null values are omitted.
+ */
+export declare function buildQueryParams(params: Record<string, unknown>): URLSearchParams;
+export interface HttpClientOptions {
+    /** API key or JWT token. Sent as `Authorization: Bearer <apiKey>`. */
+    apiKey: string;
+    /** API base URL. Defaults to `https://api.fedpulse.dev`. */
+    baseUrl?: string;
+    /**
+     * Request timeout in milliseconds. Applies to each individual attempt (not
+     * total retry budget). Default: 30 000 ms.
+     */
+    timeoutMs?: number;
+    /**
+     * Maximum number of retry attempts for transient errors.
+     * Set to 0 to disable retries. Default: 3.
+     */
+    maxRetries?: number;
+    /**
+     * Maximum number of GET responses to cache in memory.
+     * Set to 0 to disable caching. Default: 256.
+     */
+    cacheSize?: number;
+    /**
+     * Default TTL for cached GET responses in milliseconds. Default: 60 000 ms.
+     */
+    cacheTtlMs?: number;
+    /**
+     * Custom `fetch` implementation. Defaults to the global `fetch`.
+     * Useful for testing or environments with a non-standard fetch.
+     */
+    fetchFn?: typeof fetch;
+}
+export interface RequestOptions {
+    /**
+     * Override cache TTL for this specific request (ms).
+     * Pass 0 to bypass cache entirely.
+     */
+    cacheTtlMs?: number;
+    /** Extra headers to merge into this request. */
+    headers?: Record<string, string>;
+}
+export interface ParsedResponse<T> {
+    data: T;
+    pagination: Pagination;
+    meta: {
+        requestId: string;
+        cached?: boolean;
+        [key: string]: unknown;
+    };
+    rateLimit: RateLimitInfo | null;
+    /** Whether the result was served from the in-memory cache. */
+    fromCache: boolean;
+}
+/**
+ * Low-level HTTP client used by all domain resources.
+ *
+ * You should not need to instantiate this directly — use `FedPulse` instead.
+ */
+export declare class HttpClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    private readonly cache;
+    private readonly defaultCacheTtlMs;
+    private readonly fetchFn;
+    /** Most recent rate-limit info observed across all requests. */
+    lastRateLimit: RateLimitInfo | null;
+    constructor(options: HttpClientOptions);
+    /**
+     * Perform a GET request. Results are cached unless `cacheTtlMs` is 0.
+     *
+     * @param path     API path (e.g. `/v1/opportunities`).
+     * @param params   Query parameters — arrays serialised as repeated keys.
+     * @param options  Per-request overrides.
+     */
+    get<T>(path: string, params?: Record<string, unknown>, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a POST request (never cached).
+     *
+     * @param path   API path.
+     * @param body   JSON-serialisable request body.
+     * @param options  Per-request overrides.
+     */
+    post<T>(path: string, body: unknown, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a PATCH request (never cached).
+     */
+    patch<T>(path: string, body: unknown, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Perform a DELETE request (never cached).
+     */
+    del<T = null>(path: string, options?: RequestOptions): Promise<ParsedResponse<T>>;
+    /**
+     * Clear all cached responses.
+     */
+    clearCache(): void;
+    /**
+     * Execute a request, retrying on transient failures with exponential back-off
+     * and full jitter.
+     */
+    private executeWithRetry;
+    /**
+     * Execute a single HTTP request (no retry logic).
+     * Handles timeout, response parsing, header extraction, and error creation.
+     */
+    private executeOnce;
+    /**
+     * Perform a raw fetch that returns the full Response (for streaming downloads).
+     * No retry, no envelope parsing.
+     *
+     * @param path   API path.
+     * @param params Query parameters.
+     */
+    rawGet(path: string, params?: Record<string, unknown>): Promise<Response>;
+}
+//# sourceMappingURL=http.d.ts.map

package/dist/types/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/http.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAWH,OAAO,KAAK,EAAe,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAkIhF;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,eAAe,CAejF;AAID,MAAM,WAAW,iBAAiB;IAChC,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,KAAK,CAAC;CACxB;AAID,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAID,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,CAAC;IACR,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACtE,SAAS,EAAE,aAAa,GAAG,IAAI,CAAC;IAChC,8DAA8D;IAC9D,SAAS,EAAE,OAAO,CAAC;CACpB;AAID;;;;GAIG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA2C;IACjE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IAEvC,gEAAgE;IAChE,aAAa,EAAE,aAAa,GAAG,IAAI,CAAQ;gBAE/B,OAAO,EAAE,iBAAiB;IAqBtC;;;;;;OAMG;IACG,GAAG,CAAC,CAAC,EACT,IAAI,EAAE,MAAM,EACZ,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAwB7B;;;;;;OAMG;IACG,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAK7B;;OAEG;IACG,KAAK,CAAC,CAAC,EACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,EACb,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAK7B;;OAEG;IACG,GAAG,CAAC,CAAC,GAAG,IAAI,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAK7B;;OAEG;IACH,UAAU,IAAI,IAAI;IAMlB;;;OAGG;YACW,gBAAgB;IA6D9B;;;OAGG;YACW,WAAW;IA6FzB;;;;;;OAMG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;CAyCpF"}

package/dist/types/index.d.cts

@@ -0,0 +1,39 @@
+/**
+ * @fedpulse/sdk — Official JavaScript/TypeScript SDK for the FedPulse API.
+ *
+ * Quick start:
+ * ```ts
+ * import { FedPulse } from '@fedpulse/sdk';
+ *
+ * const client = new FedPulse({ apiKey: process.env.FEDPULSE_API_KEY! });
+ *
+ * const { data } = await client.opportunities.list({ q: 'cloud', naics: '541512' });
+ * console.log(data[0].title);
+ * ```
+ *
+ * Webhook verification:
+ * ```ts
+ * const payload = FedPulse.verifyWebhook({
+ *   rawBody: req.body,
+ *   signatureHeader: req.headers['x-fedpulse-signature'],
+ *   timestampHeader: req.headers['x-fedpulse-timestamp'],
+ *   secret: process.env.FEDPULSE_WEBHOOK_SECRET!,
+ * });
+ * ```
+ */
+export { FedPulse, WebhookVerificationError } from './client.cjs';
+export type { FedPulseOptions } from './client.cjs';
+export { FedPulseError, AuthenticationError, PermissionError, NotFoundError, ValidationError, RateLimitError, ServerError, NetworkError, TimeoutError, RetryExhaustedError, } from './errors.cjs';
+export { HttpClient, buildQueryParams } from './http.cjs';
+export type { HttpClientOptions, ParsedResponse, RequestOptions } from './http.cjs';
+export { OpportunitiesResource } from './resources/opportunities.cjs';
+export { ExclusionsResource } from './resources/exclusions.cjs';
+export { EntitiesResource } from './resources/entities.cjs';
+export { IntelligenceResource } from './resources/intelligence.cjs';
+export { AssistanceResource } from './resources/assistance.cjs';
+export { AnalyticsResource } from './resources/analytics.cjs';
+export { WebhooksResource } from './resources/webhooks.cjs';
+export { verifyWebhook, extractWebhookHeaders } from './webhooks-verify.cjs';
+export type { VerifyWebhookInput } from './webhooks-verify.cjs';
+export type { RateLimitInfo, OffsetPagination, CursorPagination, Pagination, ResponseMeta, ApiResponse, PaginationParams, SortParams, FieldsParam, Opportunity, AiCategory, AiDifficulty, OpportunitiesStats, OpportunityStatsItem, OpportunitiesStatsGroupBy, ListOpportunitiesParams, GetOpportunitiesStatsParams, CreateExportParams, ExportJob, ExportFormat, ExportStatus, Exclusion, ExclusionsStats, ListExclusionsParams, BulkComplianceCheckParams, ComplianceCheckEntity, ComplianceCheckResult, Entity, EntityStats, EntityAddress, EntityCertification, EntityNaicsEntry, EntityExclusionCheckResult, ListEntitiesParams, EntityIntelProfile, MarketAnalysis, CompliancePackage, ComplianceCheckRequestParams, AgencyRelationship, ContractHistoryItem, RiskIndicator, MarketAwardee, MarketAgency, SetAsideBreakdown, AssistanceListing, AssistanceStats, ListAssistanceParams, GetAssistanceStatsParams, AnalyticsSummary, AnalyticsChart, AnalyticsChartDay, AnalyticsEndpoints, AnalyticsEndpoint, AnalyticsLogs, AnalyticsLogEntry, AnalyticsSummaryParams, AnalyticsChartParams, AnalyticsEndpointsParams, AnalyticsLogsParams, AnalyticsRange, LogStatusFilter, Webhook, WebhookDelivery, WebhookPayload, WebhookFilters, WebhookEvent, DeliveryStatus, CreateWebhookParams, UpdateWebhookParams, CreateWebhookResult, RotateSecretResult, ListDeliveriesParams, WebhookVerifyOptions, } from './types/index.cjs';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @fedpulse/sdk — Official JavaScript/TypeScript SDK for the FedPulse API.
+ *
+ * Quick start:
+ * ```ts
+ * import { FedPulse } from '@fedpulse/sdk';
+ *
+ * const client = new FedPulse({ apiKey: process.env.FEDPULSE_API_KEY! });
+ *
+ * const { data } = await client.opportunities.list({ q: 'cloud', naics: '541512' });
+ * console.log(data[0].title);
+ * ```
+ *
+ * Webhook verification:
+ * ```ts
+ * const payload = FedPulse.verifyWebhook({
+ *   rawBody: req.body,
+ *   signatureHeader: req.headers['x-fedpulse-signature'],
+ *   timestampHeader: req.headers['x-fedpulse-timestamp'],
+ *   secret: process.env.FEDPULSE_WEBHOOK_SECRET!,
+ * });
+ * ```
+ */
+export { FedPulse, WebhookVerificationError } from './client.js';
+export type { FedPulseOptions } from './client.js';
+export { FedPulseError, AuthenticationError, PermissionError, NotFoundError, ValidationError, RateLimitError, ServerError, NetworkError, TimeoutError, RetryExhaustedError, } from './errors.js';
+export { HttpClient, buildQueryParams } from './http.js';
+export type { HttpClientOptions, ParsedResponse, RequestOptions } from './http.js';
+export { OpportunitiesResource } from './resources/opportunities.js';
+export { ExclusionsResource } from './resources/exclusions.js';
+export { EntitiesResource } from './resources/entities.js';
+export { IntelligenceResource } from './resources/intelligence.js';
+export { AssistanceResource } from './resources/assistance.js';
+export { AnalyticsResource } from './resources/analytics.js';
+export { WebhooksResource } from './resources/webhooks.js';
+export { verifyWebhook, extractWebhookHeaders } from './webhooks-verify.js';
+export type { VerifyWebhookInput } from './webhooks-verify.js';
+export type { RateLimitInfo, OffsetPagination, CursorPagination, Pagination, ResponseMeta, ApiResponse, PaginationParams, SortParams, FieldsParam, Opportunity, AiCategory, AiDifficulty, OpportunitiesStats, OpportunityStatsItem, OpportunitiesStatsGroupBy, ListOpportunitiesParams, GetOpportunitiesStatsParams, CreateExportParams, ExportJob, ExportFormat, ExportStatus, Exclusion, ExclusionsStats, ListExclusionsParams, BulkComplianceCheckParams, ComplianceCheckEntity, ComplianceCheckResult, Entity, EntityStats, EntityAddress, EntityCertification, EntityNaicsEntry, EntityExclusionCheckResult, ListEntitiesParams, EntityIntelProfile, MarketAnalysis, CompliancePackage, ComplianceCheckRequestParams, AgencyRelationship, ContractHistoryItem, RiskIndicator, MarketAwardee, MarketAgency, SetAsideBreakdown, AssistanceListing, AssistanceStats, ListAssistanceParams, GetAssistanceStatsParams, AnalyticsSummary, AnalyticsChart, AnalyticsChartDay, AnalyticsEndpoints, AnalyticsEndpoint, AnalyticsLogs, AnalyticsLogEntry, AnalyticsSummaryParams, AnalyticsChartParams, AnalyticsEndpointsParams, AnalyticsLogsParams, AnalyticsRange, LogStatusFilter, Webhook, WebhookDelivery, WebhookPayload, WebhookFilters, WebhookEvent, DeliveryStatus, CreateWebhookParams, UpdateWebhookParams, CreateWebhookResult, RotateSecretResult, ListDeliveriesParams, WebhookVerifyOptions, } from './types/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAIH,OAAO,EAAE,QAAQ,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAInD,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,eAAe,EACf,cAAc,EACd,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAIrB,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AACzD,YAAY,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAInF,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAI3D,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC5E,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI/D,YAAY,EAEV,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,WAAW,EAEX,WAAW,EACX,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,EACpB,yBAAyB,EACzB,uBAAuB,EACvB,2BAA2B,EAC3B,kBAAkB,EAClB,SAAS,EACT,YAAY,EACZ,YAAY,EAEZ,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,yBAAyB,EACzB,qBAAqB,EACrB,qBAAqB,EAErB,MAAM,EACN,WAAW,EACX,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAElB,kBAAkB,EAClB,cAAc,EACd,iBAAiB,EACjB,4BAA4B,EAC5B,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,aAAa,EACb,YAAY,EACZ,iBAAiB,EAEjB,iBAAiB,EACjB,eAAe,EACf,oBAAoB,EACpB,wBAAwB,EAExB,gBAAgB,EAChB,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,cAAc,EACd,eAAe,EAEf,OAAO,EACP,eAAe,EACf,cAAc,EACd,cAAc,EACd,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,kBAAkB,CAAC"}

package/dist/types/resources/analytics.d.cts

@@ -0,0 +1,94 @@
+/**
+ * Analytics resource client.
+ *
+ * Wraps all /v1/analytics endpoints (per-user API usage analytics):
+ *   - summary    GET /v1/analytics/summary
+ *   - chart      GET /v1/analytics/chart
+ *   - endpoints  GET /v1/analytics/endpoints
+ *   - logs       GET /v1/analytics/logs
+ *   - logPages   async generator over the logs endpoint
+ *
+ * All results are scoped to the authenticated user — no cross-user visibility.
+ */
+import type { HttpClient, ParsedResponse } from '../http.cjs';
+import type { AnalyticsSummary, AnalyticsChart, AnalyticsEndpoints, AnalyticsLogs, AnalyticsSummaryParams, AnalyticsChartParams, AnalyticsEndpointsParams, AnalyticsLogsParams } from '../types/analytics.cjs';
+export declare class AnalyticsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /**
+     * Get KPI summary totals for the authenticated user.
+     *
+     * Returns: requests today, this month, in range, 4xx/5xx counts and rates.
+     * Analytics data is never cached — always returns live counts.
+     *
+     * @param params  Optional key-scoping and time range.
+     *
+     * @example
+     * ```ts
+     * const summary = await client.analytics.summary({ range: '7d' });
+     * console.log('Requests last 7d:', summary.data.requestsInRange);
+     * ```
+     */
+    summary(params?: AnalyticsSummaryParams): Promise<ParsedResponse<AnalyticsSummary>>;
+    /**
+     * Get per-day request counts broken down by success / 4xx / 5xx.
+     *
+     * @param params  Optional key-scoping and time range.
+     *
+     * @example
+     * ```ts
+     * const chart = await client.analytics.chart({ range: '30d' });
+     * for (const day of chart.data.days) {
+     *   console.log(day.date, day.total);
+     * }
+     * ```
+     */
+    chart(params?: AnalyticsChartParams): Promise<ParsedResponse<AnalyticsChart>>;
+    /**
+     * Get top-10 endpoints by request volume and by P95 latency.
+     *
+     * @param params  Optional key-scoping and time range.
+     *
+     * @example
+     * ```ts
+     * const endpoints = await client.analytics.endpoints({ range: '7d' });
+     * console.log('Slowest endpoint:', endpoints.data.byLatency[0]?.endpoint);
+     * ```
+     */
+    endpoints(params?: AnalyticsEndpointsParams): Promise<ParsedResponse<AnalyticsEndpoints>>;
+    /**
+     * Get paginated API request logs for the authenticated user.
+     *
+     * Supports cursor-based pagination via the `cursor` parameter.
+     * Maximum `limit` is 1000.
+     *
+     * @param params  Filter and pagination parameters.
+     *
+     * @example
+     * ```ts
+     * const logs = await client.analytics.logs({ limit: 50, status: '4xx' });
+     * for (const entry of logs.data.items) {
+     *   console.log(entry.method, entry.endpoint, entry.statusCode);
+     * }
+     * ```
+     */
+    logs(params?: AnalyticsLogsParams): Promise<ParsedResponse<AnalyticsLogs>>;
+    /**
+     * Async generator that automatically paginates through all log entries.
+     *
+     * Uses cursor-based pagination. Yields one page at a time.
+     *
+     * @param params  Same parameters as `logs()`. Do not pass `cursor`.
+     *
+     * @example
+     * ```ts
+     * for await (const page of client.analytics.logPages({ range: '7d' })) {
+     *   for (const entry of page.data.items) {
+     *     console.log(entry.requestId, entry.statusCode);
+     *   }
+     * }
+     * ```
+     */
+    logPages(params: Omit<AnalyticsLogsParams, 'cursor'>): AsyncGenerator<ParsedResponse<AnalyticsLogs>>;
+}
+//# sourceMappingURL=analytics.d.ts.map