@http-client-toolkit/store-dynamodb 0.0.1 → 0.4.0

package/lib/index.d.cts

@@ -1,165 +1,221 @@
-import { DynamoDBClient, KeySchemaElement, AttributeDefinition, GlobalSecondaryIndex } from '@aws-sdk/client-dynamodb';
+import {
+  DynamoDBClient,
+  KeySchemaElement,
+  AttributeDefinition,
+  GlobalSecondaryIndex,
+} from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import { CacheStore, DedupeStore, RateLimitStore, RateLimitConfig, AdaptiveRateLimitStore, AdaptiveConfigSchema, RequestPriority } from '@http-client-toolkit/core';
-export { AdaptiveConfig, AdaptiveRateLimitStore, CacheStore, DedupeStore, RateLimitConfig, RateLimitStore, RequestPriority } from '@http-client-toolkit/core';
+import {
+  CacheStore,
+  DedupeStore,
+  RateLimitStore,
+  RateLimitConfig,
+  AdaptiveRateLimitStore,
+  AdaptiveConfigSchema,
+  RequestPriority,
+} from '@http-client-toolkit/core';
+export {
+  AdaptiveConfig,
+  AdaptiveRateLimitStore,
+  CacheStore,
+  DedupeStore,
+  RateLimitConfig,
+  RateLimitStore,
+  RequestPriority,
+} from '@http-client-toolkit/core';
 import { z } from 'zod';
 
 interface DynamoDBCacheStoreOptions {
-    client?: DynamoDBDocumentClient | DynamoDBClient;
-    region?: string;
-    tableName?: string;
-    maxEntrySizeBytes?: number;
+  client?: DynamoDBDocumentClient | DynamoDBClient;
+  region?: string;
+  tableName?: string;
+  maxEntrySizeBytes?: number;
 }
 declare class DynamoDBCacheStore<T = unknown> implements CacheStore<T> {
-    private readonly docClient;
-    private readonly rawClient;
-    private readonly isClientManaged;
-    private readonly tableName;
-    private readonly maxEntrySizeBytes;
-    private isDestroyed;
-    constructor({ client, region, tableName, maxEntrySizeBytes, }?: DynamoDBCacheStoreOptions);
-    get(hash: string): Promise<T | undefined>;
-    set(hash: string, value: T, ttlSeconds: number): Promise<void>;
-    delete(hash: string): Promise<void>;
-    clear(): Promise<void>;
-    close(): Promise<void>;
-    destroy(): void;
-    private assertValidHash;
+  private readonly docClient;
+  private readonly rawClient;
+  private readonly isClientManaged;
+  private readonly tableName;
+  private readonly maxEntrySizeBytes;
+  private isDestroyed;
+  constructor({
+    client,
+    region,
+    tableName,
+    maxEntrySizeBytes,
+  }?: DynamoDBCacheStoreOptions);
+  get(hash: string): Promise<T | undefined>;
+  set(hash: string, value: T, ttlSeconds: number): Promise<void>;
+  delete(hash: string): Promise<void>;
+  clear(): Promise<void>;
+  close(): Promise<void>;
+  destroy(): void;
+  private assertValidHash;
 }
 
 interface DynamoDBDedupeStoreOptions {
-    client?: DynamoDBDocumentClient | DynamoDBClient;
-    region?: string;
-    tableName?: string;
-    jobTimeoutMs?: number;
-    pollIntervalMs?: number;
+  client?: DynamoDBDocumentClient | DynamoDBClient;
+  region?: string;
+  tableName?: string;
+  jobTimeoutMs?: number;
+  pollIntervalMs?: number;
 }
 declare class DynamoDBDedupeStore<T = unknown> implements DedupeStore<T> {
-    private readonly docClient;
-    private readonly rawClient;
-    private readonly isClientManaged;
-    private readonly tableName;
-    private readonly jobTimeoutMs;
-    private readonly pollIntervalMs;
-    private jobPromises;
-    private jobSettlers;
-    private isDestroyed;
-    constructor({ client, region, tableName, jobTimeoutMs, pollIntervalMs, }?: DynamoDBDedupeStoreOptions);
-    waitFor(hash: string): Promise<T | undefined>;
-    register(hash: string): Promise<string>;
-    registerOrJoin(hash: string): Promise<{
-        jobId: string;
-        isOwner: boolean;
-    }>;
-    complete(hash: string, value: T | undefined): Promise<void>;
-    fail(hash: string, _error: Error): Promise<void>;
-    isInProgress(hash: string): Promise<boolean>;
-    clear(): Promise<void>;
-    close(): Promise<void>;
-    destroy(): void;
-    private deserializeResult;
-    private assertValidHash;
+  private readonly docClient;
+  private readonly rawClient;
+  private readonly isClientManaged;
+  private readonly tableName;
+  private readonly jobTimeoutMs;
+  private readonly pollIntervalMs;
+  private jobPromises;
+  private jobSettlers;
+  private isDestroyed;
+  constructor({
+    client,
+    region,
+    tableName,
+    jobTimeoutMs,
+    pollIntervalMs,
+  }?: DynamoDBDedupeStoreOptions);
+  waitFor(hash: string): Promise<T | undefined>;
+  register(hash: string): Promise<string>;
+  registerOrJoin(hash: string): Promise<{
+    jobId: string;
+    isOwner: boolean;
+  }>;
+  complete(hash: string, value: T | undefined): Promise<void>;
+  fail(hash: string, _error: Error): Promise<void>;
+  isInProgress(hash: string): Promise<boolean>;
+  clear(): Promise<void>;
+  close(): Promise<void>;
+  destroy(): void;
+  private deserializeResult;
+  private assertValidHash;
 }
 
 interface DynamoDBRateLimitStoreOptions {
-    client?: DynamoDBDocumentClient | DynamoDBClient;
-    region?: string;
-    tableName?: string;
-    defaultConfig?: RateLimitConfig;
-    resourceConfigs?: Map<string, RateLimitConfig>;
+  client?: DynamoDBDocumentClient | DynamoDBClient;
+  region?: string;
+  tableName?: string;
+  defaultConfig?: RateLimitConfig;
+  resourceConfigs?: Map<string, RateLimitConfig>;
 }
 declare class DynamoDBRateLimitStore implements RateLimitStore {
-    private readonly docClient;
-    private readonly rawClient;
-    private readonly isClientManaged;
-    private readonly tableName;
-    private defaultConfig;
-    private resourceConfigs;
-    private isDestroyed;
-    constructor({ client, region, tableName, defaultConfig, resourceConfigs, }?: DynamoDBRateLimitStoreOptions);
-    canProceed(resource: string): Promise<boolean>;
-    acquire(resource: string): Promise<boolean>;
-    record(resource: string): Promise<void>;
-    getStatus(resource: string): Promise<{
-        remaining: number;
-        resetTime: Date;
-        limit: number;
-    }>;
-    reset(resource: string): Promise<void>;
-    getWaitTime(resource: string): Promise<number>;
-    setResourceConfig(resource: string, config: RateLimitConfig): void;
-    getResourceConfig(resource: string): RateLimitConfig;
-    clear(): Promise<void>;
-    close(): Promise<void>;
-    destroy(): void;
-    private countRequestsInWindow;
-    private hasCapacityInWindow;
-    private deleteResourceItems;
-    private assertValidResource;
+  private readonly docClient;
+  private readonly rawClient;
+  private readonly isClientManaged;
+  private readonly tableName;
+  private defaultConfig;
+  private resourceConfigs;
+  private isDestroyed;
+  constructor({
+    client,
+    region,
+    tableName,
+    defaultConfig,
+    resourceConfigs,
+  }?: DynamoDBRateLimitStoreOptions);
+  canProceed(resource: string): Promise<boolean>;
+  acquire(resource: string): Promise<boolean>;
+  record(resource: string): Promise<void>;
+  getStatus(resource: string): Promise<{
+    remaining: number;
+    resetTime: Date;
+    limit: number;
+  }>;
+  reset(resource: string): Promise<void>;
+  getWaitTime(resource: string): Promise<number>;
+  setResourceConfig(resource: string, config: RateLimitConfig): void;
+  getResourceConfig(resource: string): RateLimitConfig;
+  clear(): Promise<void>;
+  close(): Promise<void>;
+  destroy(): void;
+  private countRequestsInWindow;
+  private hasCapacityInWindow;
+  private deleteResourceItems;
+  private assertValidResource;
 }
 
 interface DynamoDBAdaptiveRateLimitStoreOptions {
-    client?: DynamoDBDocumentClient | DynamoDBClient;
-    region?: string;
-    tableName?: string;
-    defaultConfig?: RateLimitConfig;
-    resourceConfigs?: Map<string, RateLimitConfig>;
-    adaptiveConfig?: Partial<z.input<typeof AdaptiveConfigSchema>>;
+  client?: DynamoDBDocumentClient | DynamoDBClient;
+  region?: string;
+  tableName?: string;
+  defaultConfig?: RateLimitConfig;
+  resourceConfigs?: Map<string, RateLimitConfig>;
+  adaptiveConfig?: Partial<z.input<typeof AdaptiveConfigSchema>>;
 }
 declare class DynamoDBAdaptiveRateLimitStore implements AdaptiveRateLimitStore {
-    private readonly docClient;
-    private readonly rawClient;
-    private readonly isClientManaged;
-    private readonly tableName;
-    private defaultConfig;
-    private resourceConfigs;
-    private isDestroyed;
-    private capacityCalculator;
-    private activityMetrics;
-    private lastCapacityUpdate;
-    private cachedCapacity;
-    private readonly maxMetricSamples;
-    constructor({ client, region, tableName, defaultConfig, resourceConfigs, adaptiveConfig, }?: DynamoDBAdaptiveRateLimitStoreOptions);
-    canProceed(resource: string, priority?: RequestPriority): Promise<boolean>;
-    acquire(resource: string, priority?: RequestPriority): Promise<boolean>;
-    record(resource: string, priority?: RequestPriority): Promise<void>;
-    getStatus(resource: string): Promise<{
-        remaining: number;
-        resetTime: Date;
-        limit: number;
-        adaptive?: {
-            userReserved: number;
-            backgroundMax: number;
-            backgroundPaused: boolean;
-            recentUserActivity: number;
-            reason: string;
-        };
-    }>;
-    reset(resource: string): Promise<void>;
-    getWaitTime(resource: string, priority?: RequestPriority): Promise<number>;
-    setResourceConfig(resource: string, config: RateLimitConfig): void;
-    getResourceConfig(resource: string): RateLimitConfig;
-    clear(): Promise<void>;
-    close(): Promise<void>;
-    destroy(): void;
-    private calculateCurrentCapacity;
-    private getOrCreateActivityMetrics;
-    private ensureActivityMetrics;
-    private getCurrentUsage;
-    private hasPriorityCapacityInWindow;
-    private cleanupOldRequests;
-    private pushRecentRequest;
-    private getResourceLimit;
-    private getDefaultCapacity;
-    private deleteResourceItems;
-    private assertValidResource;
+  private readonly docClient;
+  private readonly rawClient;
+  private readonly isClientManaged;
+  private readonly tableName;
+  private defaultConfig;
+  private resourceConfigs;
+  private isDestroyed;
+  private capacityCalculator;
+  private activityMetrics;
+  private lastCapacityUpdate;
+  private cachedCapacity;
+  private readonly maxMetricSamples;
+  constructor({
+    client,
+    region,
+    tableName,
+    defaultConfig,
+    resourceConfigs,
+    adaptiveConfig,
+  }?: DynamoDBAdaptiveRateLimitStoreOptions);
+  canProceed(resource: string, priority?: RequestPriority): Promise<boolean>;
+  acquire(resource: string, priority?: RequestPriority): Promise<boolean>;
+  record(resource: string, priority?: RequestPriority): Promise<void>;
+  getStatus(resource: string): Promise<{
+    remaining: number;
+    resetTime: Date;
+    limit: number;
+    adaptive?: {
+      userReserved: number;
+      backgroundMax: number;
+      backgroundPaused: boolean;
+      recentUserActivity: number;
+      reason: string;
+    };
+  }>;
+  reset(resource: string): Promise<void>;
+  getWaitTime(resource: string, priority?: RequestPriority): Promise<number>;
+  setResourceConfig(resource: string, config: RateLimitConfig): void;
+  getResourceConfig(resource: string): RateLimitConfig;
+  clear(): Promise<void>;
+  close(): Promise<void>;
+  destroy(): void;
+  private calculateCurrentCapacity;
+  private getOrCreateActivityMetrics;
+  private ensureActivityMetrics;
+  private getCurrentUsage;
+  private hasPriorityCapacityInWindow;
+  private cleanupOldRequests;
+  private pushRecentRequest;
+  private getResourceLimit;
+  private getDefaultCapacity;
+  private deleteResourceItems;
+  private assertValidResource;
 }
 
-declare const DEFAULT_TABLE_NAME = "http-client-toolkit";
+declare const DEFAULT_TABLE_NAME = 'http-client-toolkit';
 declare const TABLE_SCHEMA: {
-    KeySchema: Array<KeySchemaElement>;
-    AttributeDefinitions: Array<AttributeDefinition>;
-    GlobalSecondaryIndexes: Array<GlobalSecondaryIndex>;
+  KeySchema: Array<KeySchemaElement>;
+  AttributeDefinitions: Array<AttributeDefinition>;
+  GlobalSecondaryIndexes: Array<GlobalSecondaryIndex>;
 };
 
-export { DEFAULT_TABLE_NAME, DynamoDBAdaptiveRateLimitStore, type DynamoDBAdaptiveRateLimitStoreOptions, DynamoDBCacheStore, type DynamoDBCacheStoreOptions, DynamoDBDedupeStore, type DynamoDBDedupeStoreOptions, DynamoDBRateLimitStore, type DynamoDBRateLimitStoreOptions, TABLE_SCHEMA };
+export {
+  DEFAULT_TABLE_NAME,
+  DynamoDBAdaptiveRateLimitStore,
+  type DynamoDBAdaptiveRateLimitStoreOptions,
+  DynamoDBCacheStore,
+  type DynamoDBCacheStoreOptions,
+  DynamoDBDedupeStore,
+  type DynamoDBDedupeStoreOptions,
+  DynamoDBRateLimitStore,
+  type DynamoDBRateLimitStoreOptions,
+  TABLE_SCHEMA,
+};