@profplum700/etsy-v3-api-client 3.0.1 → 4.1.0

package/dist/index.d.ts

@@ -4,7 +4,9 @@ interface EtsyClientConfig {
     accessToken: string;
     refreshToken: string;
     expiresAt: Date;
-    refreshSave?: (_accessToken: string, _refreshToken: string, _expiresAt: Date) => void;
+    refreshSave?: TokenRefreshCallback;
+    refreshSaveAsync?: TokenRefreshCallbackAsync;
+    refreshClearAsync?: TokenRefreshClearCallbackAsync;
     baseUrl?: string;
     rateLimiting?: {
         enabled: boolean;
@@ -46,6 +48,8 @@ interface EtsyTokenResponse {
     scope: string;
 }
 type TokenRefreshCallback = (_accessToken: string, _refreshToken: string, _expiresAt: Date) => void;
+type TokenRefreshCallbackAsync = (_accessToken: string, _refreshToken: string, _expiresAt: Date) => void | Promise<void>;
+type TokenRefreshClearCallbackAsync = () => void | Promise<void>;
 type TokenRotationCallback = (oldTokens: EtsyTokens, newTokens: EtsyTokens) => void | Promise<void>;
 interface TokenStorage {
     save(_tokens: EtsyTokens): Promise<void>;
@@ -906,27 +910,25 @@ interface UpdateListingParams {
 }
 interface UpdateListingInventoryParams {
     products: Array<{
-        sku?: string;
-        property_values?: Array<{
+        sku?: string | null;
+        property_values: Array<{
             property_id: number;
             property_name?: string;
-            scale_id?: number;
-            scale_name?: string;
-            value_ids?: number[];
-            values?: string[];
+            scale_id?: number | null;
+            value_ids: number[];
+            values: string[];
         }>;
         offerings: Array<{
-            offering_id?: number;
             price: number;
             quantity: number;
             is_enabled: boolean;
-            readiness_state_id?: number;
+            readiness_state_id: number | null;
         }>;
     }>;
     price_on_property?: number[];
     quantity_on_property?: number[];
     sku_on_property?: number[];
-    readiness_state_on_property?: number[];
+    readiness_state_on_property?: number[] | null;
 }
 interface EtsyListingProperty {
     property_id: number;
@@ -1333,10 +1335,13 @@ declare class EtsyClient {
     private logger;
     private cache?;
     private cacheTtl;
+    private rateLimitingEnabled;
     private keystring;
     private sharedSecret;
     private bulkOperationManager;
     constructor(config: EtsyClientConfig);
+    private acquireRateLimitSlot;
+    private fetchOnceWithRateLimit;
     private makeRequest;
     private executeWithRetry;
     private sleep;
@@ -1369,6 +1374,7 @@ declare class EtsyClient {
     deleteListing(listingId: string): Promise<void>;
     updateListingInventory(listingId: string, params: UpdateListingInventoryParams, options?: {
         legacy?: boolean;
+        enableScaleValidation?: boolean;
     }): Promise<EtsyListingInventory>;
     uploadListingImage(shopId: string, listingId: string, imageData: Blob | Buffer, params?: {
         rank?: number;
@@ -1546,14 +1552,22 @@ declare class MemoryTokenStorage implements TokenStorage {
 declare class TokenManager {
     private keystring;
     private currentTokens;
+    private pendingTokens?;
     private refreshCallback?;
+    private refreshClearRequired;
     private storage?;
+    private clearCallback?;
+    private tokenMutationGeneration;
     private refreshPromise?;
     private rotationConfig?;
     private rotationTimer?;
     constructor(config: EtsyClientConfig, storage?: TokenStorage, rotationConfig?: TokenRotationConfig);
     getAccessToken(): Promise<string>;
     refreshToken(): Promise<EtsyTokens>;
+    private throwIfSuperseded;
+    private repairPersistenceToCurrentTokens;
+    private persistRefreshedTokens;
+    private retryPendingTokenPersistence;
     private performTokenRefresh;
     getCurrentTokens(): EtsyTokens | null;
     updateTokens(tokens: EtsyTokens): void;
@@ -1606,8 +1620,8 @@ declare const ETSY_RATE_LIMITS: {
     readonly MIN_REQUEST_INTERVAL: 200;
 };
 declare class EtsyRateLimiter {
-    private requestCount;
-    private dailyReset;
+    private requestTimestamps;
+    private uncertainRequestTimestamps;
     private lastRequestTime;
     private readonly config;
     private headerLimitPerSecond?;
@@ -1615,13 +1629,33 @@ declare class EtsyRateLimiter {
     private headerLimitPerDay?;
     private headerRemainingToday?;
     private isHeaderBasedLimiting;
+    private headerQuotaAvailableAt;
+    private retryNotBefore;
+    private quotaProbeBackoffMs;
+    private nextReservationId;
+    private latestHeaderReservationId;
+    private inFlightReservations;
+    private quotaProbeInFlight;
+    private readonly stateWaiters;
     private currentRetryCount;
+    private reservationQueue;
     constructor(config?: Partial<RateLimitConfig>);
-    private setNextDailyReset;
-    updateFromHeaders(headers: Headers | Record<string, string> | undefined | null): void;
+    private pruneRequestTimestamps;
+    private getLocalResetTime;
+    private getLocalRemainingRequests;
+    private getEffectiveRemainingRequests;
+    private isQuotaProbeReady;
+    private refreshExpiredHeaderQuota;
+    private notifyStateWaiters;
+    private scheduleQuotaProbe;
+    private waitForStateChange;
+    private finishReservation;
+    acquireRequestSlot(): Promise<number>;
+    releaseRequestSlot(reservationId: number): void;
+    updateFromHeaders(headers: Headers | Record<string, string> | undefined | null, reservationId?: number): void;
     private parseRateLimitHeaders;
     private checkApproachingLimit;
-    handleRateLimitResponse(headers: Headers | Record<string, string> | undefined | null): Promise<{
+    handleRateLimitResponse(headers: Headers | Record<string, string> | undefined | null, reservationId?: number, retryAttempt?: number): Promise<{
         shouldRetry: boolean;
         delayMs: number;
     }>;
@@ -1631,6 +1665,7 @@ declare class EtsyRateLimiter {
     setWarningThreshold(threshold: number): void;
     private getEffectiveMinInterval;
     waitForRateLimit(): Promise<void>;
+    waitForRateLimitWithReservation(): Promise<number>;
     getRateLimitStatus(): RateLimitStatus;
     getRemainingRequests(): number;
     reset(): void;
@@ -1651,8 +1686,7 @@ declare class GlobalRequestQueue {
     private queue;
     private processing;
     private rateLimits;
-    private requestCount;
-    private dailyReset;
+    private requestTimestamps;
     private lastRequestTime;
     private readonly maxRequestsPerDay;
     private readonly maxRequestsPerSecond;
@@ -1671,7 +1705,9 @@ declare class GlobalRequestQueue {
     private processQueue;
     private waitForRateLimit;
     private updateRateLimitInfo;
-    private setNextDailyReset;
+    private pruneRequestTimestamps;
+    private getNextRequestExpiry;
+    private startRequest;
     private generateId;
     private delay;
 }