@adaptic/utils 0.1.44 → 0.1.45

package/dist/types/rate-limiter.d.ts

@@ -1,171 +0,0 @@
-/**
- * Token bucket rate limiter for external API integrations
- *
- * Implements client-side rate limiting to prevent exceeding API quotas
- * and ensure fair usage of external services like Alpaca, Polygon, and AlphaVantage.
- *
- * @example
- * ```typescript
- * import { rateLimiters } from '@adaptic/utils';
- *
- * // Before making an API call
- * await rateLimiters.alpaca.acquire();
- * const result = await makeAlpacaApiCall();
- * ```
- */
-import { RateLimitError } from "./errors";
-export { RateLimitError };
-/**
- * Configuration for a rate limiter instance
- */
-export interface RateLimiterConfig {
-    /** Maximum number of tokens (requests) that can be accumulated */
-    maxTokens: number;
-    /** Rate at which tokens are refilled (tokens per second) */
-    refillRate: number;
-    /** Human-readable label for logging and error messages */
-    label: string;
-    /** Maximum time to wait for a token before timing out (milliseconds) */
-    timeoutMs?: number;
-}
-/**
- * Token bucket rate limiter implementation
- *
- * Uses the token bucket algorithm to control the rate of API requests.
- * Tokens are consumed on each request and refilled at a constant rate.
- * Requests that exceed the available tokens are queued and processed
- * when tokens become available.
- */
-export declare class TokenBucketRateLimiter {
-    private readonly config;
-    private tokens;
-    private lastRefill;
-    private queue;
-    private readonly timeoutMs;
-    private processingQueue;
-    /**
-     * Creates a new rate limiter instance
-     *
-     * @param config - Rate limiter configuration
-     *
-     * @example
-     * ```typescript
-     * // Alpaca: 200 requests per minute
-     * const alpacaLimiter = new TokenBucketRateLimiter({
-     *   maxTokens: 200,
-     *   refillRate: 200 / 60, // ~3.33 per second
-     *   label: 'alpaca',
-     *   timeoutMs: 60000
-     * });
-     * ```
-     */
-    constructor(config: RateLimiterConfig);
-    /**
-     * Acquires a token for making an API request
-     *
-     * If a token is available, it is consumed immediately.
-     * If no tokens are available, the request is queued and will resolve
-     * when a token becomes available or reject if it times out.
-     *
-     * @throws {RateLimitError} If the request times out waiting for a token
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   await limiter.acquire();
-     *   // Make API call
-     * } catch (error) {
-     *   if (error instanceof RateLimitError) {
-     *     // Handle rate limit timeout
-     *   }
-     * }
-     * ```
-     */
-    acquire(): Promise<void>;
-    /**
-     * Refills tokens based on elapsed time and processes queued requests
-     *
-     * Tokens are refilled at the configured rate up to the maximum capacity.
-     * If tokens are available after refilling, queued requests are processed.
-     */
-    private refill;
-    /**
-     * Processes queued requests when tokens are available
-     *
-     * Prevents concurrent queue processing to ensure FIFO order.
-     */
-    private processQueue;
-    /**
-     * Gets the current number of available tokens
-     *
-     * @returns Number of tokens currently available
-     */
-    getAvailableTokens(): number;
-    /**
-     * Gets the current queue length
-     *
-     * @returns Number of requests waiting for tokens
-     */
-    getQueueLength(): number;
-    /**
-     * Clears all queued requests and resets the token bucket
-     *
-     * All queued requests will be rejected with a RateLimitError.
-     * Useful for cleanup or when changing rate limit configurations.
-     */
-    reset(): void;
-}
-/**
- * Pre-configured rate limiters for common external APIs
- *
- * These limiters are configured based on the documented rate limits
- * for each service. Adjust the configurations if you have different
- * tier access or if limits change.
- *
- * @example
- * ```typescript
- * import { rateLimiters } from '@adaptic/utils';
- *
- * // Use before making API calls
- * await rateLimiters.alpaca.acquire();
- * await rateLimiters.polygon.acquire();
- * await rateLimiters.alphaVantage.acquire();
- * ```
- */
-export declare const rateLimiters: {
-    /**
-     * Alpaca API rate limiter
-     *
-     * Configured for 200 requests per minute.
-     * See: https://alpaca.markets/docs/api-references/trading-api/#rate-limit
-     */
-    alpaca: TokenBucketRateLimiter;
-    /**
-     * Polygon.io API rate limiter
-     *
-     * Configured for 5 requests per second (basic plan).
-     * Adjust if you have a different subscription tier.
-     * See: https://polygon.io/pricing
-     */
-    polygon: TokenBucketRateLimiter;
-    /**
-     * AlphaVantage API rate limiter
-     *
-     * Configured for 5 requests per minute (free tier).
-     * For premium tier (75/min), create a custom limiter:
-     *
-     * @example
-     * ```typescript
-     * const premiumAV = new TokenBucketRateLimiter({
-     *   maxTokens: 75,
-     *   refillRate: 75 / 60,
-     *   label: 'alphaVantage-premium',
-     *   timeoutMs: 60000,
-     * });
-     * ```
-     *
-     * See: https://www.alphavantage.co/premium/
-     */
-    alphaVantage: TokenBucketRateLimiter;
-};
-//# sourceMappingURL=rate-limiter.d.ts.map

package/dist/types/rate-limiter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rate-limiter.d.ts","sourceRoot":"","sources":["../../src/rate-limiter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAcD;;;;;;;GAOG;AACH,qBAAa,sBAAsB;IAuBrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAtBnC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAuB;IACpC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,eAAe,CAAkB;IAEzC;;;;;;;;;;;;;;;OAeG;gBAC0B,MAAM,EAAE,iBAAiB;IAMtD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkD9B;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IAYd;;;;OAIG;IACH,OAAO,CAAC,YAAY;IA6BpB;;;;OAIG;IACH,kBAAkB,IAAI,MAAM;IAK5B;;;;OAIG;IACH,cAAc,IAAI,MAAM;IAIxB;;;;;OAKG;IACH,KAAK,IAAI,IAAI;CAwBd;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;OAKG;;IAQH;;;;;;OAMG;;IAQH;;;;;;;;;;;;;;;;;OAiBG;;CAOJ,CAAC"}