@dereekb/zoom 12.1.0 → 12.1.1

package/index.cjs.js

@@ -3412,13 +3412,17 @@ function handleZoomErrorFetchFactory(parseZoomError, defaultLogError) {
  * The status code that Zoom uses to indicates that too many requests have been made in a short period of time.
  */
 const ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+/**
+ * Also shares the same 429 code as ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE.
+ */
+const ZOOM_TOO_MANY_REQUESTS_ERROR_CODE = 429;
 const ZOOM_RATE_LIMIT_CATEGORY_HEADER = 'X-RateLimit-Category';
 const ZOOM_RATE_LIMIT_TYPE_HEADER = 'X-RateLimit-Type';
 const ZOOM_RATE_LIMIT_LIMIT_HEADER = 'X-RateLimit-Limit';
 const ZOOM_RATE_LIMIT_REMAINING_HEADER = 'X-RateLimit-Remaining';
 const ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER = 'Retry-After';
-const DEFAULT_ZOOM_API_RATE_LIMIT = 100;
-const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_MINUTE;
+const DEFAULT_ZOOM_API_RATE_LIMIT = 2;
+const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_SECOND;
 function zoomRateLimitHeaderDetails(headers) {
   const limitHeader = headers.get(ZOOM_RATE_LIMIT_LIMIT_HEADER);
   const remainingHeader = headers.get(ZOOM_RATE_LIMIT_REMAINING_HEADER);
@@ -3426,13 +3430,13 @@ function zoomRateLimitHeaderDetails(headers) {
   const categoryHeader = headers.get(ZOOM_RATE_LIMIT_CATEGORY_HEADER);
   const typeHeader = headers.get(ZOOM_RATE_LIMIT_TYPE_HEADER);
   let result = null;
-  if (limitHeader != null && remainingHeader != null && retryAfterHeader != null) {
-    const limit = Number(limitHeader);
-    const remaining = Number(remainingHeader);
-    const retryAfter = Number(retryAfterHeader);
-    const retryAfterAt = new Date(retryAfter);
+  if (categoryHeader != null && typeHeader != null) {
     const category = categoryHeader;
     const type = typeHeader;
+    const limit = limitHeader ? Number(limitHeader) : undefined;
+    const remaining = remainingHeader ? Number(remainingHeader) : undefined;
+    const retryAfter = retryAfterHeader ? Number(retryAfterHeader) : undefined;
+    const retryAfterAt = retryAfterHeader ? new Date(retryAfterHeader) : undefined;
     result = {
       limit,
       remaining,
@@ -3460,6 +3464,11 @@ function parseZoomServerErrorData(zoomServerError, responseError) {
   let result;
   if (responseError.response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
     result = new ZoomTooManyRequestsError(zoomServerError, responseError);
+    console.warn('ZoomTooManyRequestsError', {
+      result,
+      responseError,
+      headerDetails: result.headerDetails
+    });
   } else if (zoomServerError) {
     switch (zoomServerError.code) {
       default:
@@ -3720,48 +3729,54 @@ function zoomRateLimitedFetchHandler(config) {
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      startLimitAt: Math.ceil(limit / 10),
-      // can do 10% of the requests of the limit before rate limiting begins
-      cooldownRate: 1.2 * (limit / (defaultResetPeriod / util.MS_IN_SECOND)),
-      exponentRate: 1.08,
-      maxWaitTime: util.MS_IN_SECOND * 10,
+      startLimitAt: 2,
+      cooldownRate: 1,
+      exponentRate: 1.2,
+      maxWaitTime: util.MS_IN_SECOND * 5,
       resetPeriod: defaultResetPeriod,
       resetAt
     };
   }
-  const defaultConfig = configForLimit(defaultLimit);
+  const defaultConfig = configForLimit();
   const rateLimiter = util.resetPeriodPromiseRateLimiter(defaultConfig);
   return fetch.rateLimitedFetchHandler({
     rateLimiter,
     updateWithResponse: function (response, fetchResponseError) {
       const hasLimitHeader = response.headers.has(ZOOM_RATE_LIMIT_REMAINING_HEADER);
       let shouldRetry = false;
-      let enabled = false;
+      // let enabled = false;   // rate limiter should not be turned off
       if (hasLimitHeader) {
         const headerDetails = zoomRateLimitHeaderDetails(response.headers);
         if (headerDetails) {
           const {
+            type,
             limit,
             retryAfterAt,
             remaining
           } = headerDetails;
-          if (limit !== defaultLimit) {
-            const newConfig = configForLimit(limit, retryAfterAt);
-            rateLimiter.setConfig(newConfig, false);
-          }
-          rateLimiter.setRemainingLimit(remaining);
-          rateLimiter.setNextResetAt(retryAfterAt);
-          enabled = true;
-          // only retry if it's a TOO MANY REQUESTS error
           if (response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
-            shouldRetry = true;
-            try {
-              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
-            } catch (e) {}
+            // For simple query-per-second rate limits, just schedule a retry
+            if (type === 'QPS') {
+              shouldRetry = true;
+              try {
+                onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+              } catch (e) {}
+            }
+          }
+          // NOTE: typically it seems like these headers are not available usually.
+          // There is a daily limit for message requests
+          if (limit != null && retryAfterAt != null && remaining != null) {
+            if (limit !== defaultLimit) {
+              const newConfig = configForLimit(limit, retryAfterAt);
+              rateLimiter.setConfig(newConfig, false);
+            }
+            rateLimiter.setRemainingLimit(remaining);
+            rateLimiter.setNextResetAt(retryAfterAt);
+            // enabled = true;
           }
         }
       }
-      rateLimiter.setEnabled(enabled);
+      // rateLimiter.setEnabled(enabled);
       return shouldRetry;
     }
   });
@@ -4305,6 +4320,7 @@ exports.ZOOM_RATE_LIMIT_REMAINING_HEADER = ZOOM_RATE_LIMIT_REMAINING_HEADER;
 exports.ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER = ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER;
 exports.ZOOM_RATE_LIMIT_TYPE_HEADER = ZOOM_RATE_LIMIT_TYPE_HEADER;
 exports.ZOOM_SUCCESS_CODE = ZOOM_SUCCESS_CODE;
+exports.ZOOM_TOO_MANY_REQUESTS_ERROR_CODE = ZOOM_TOO_MANY_REQUESTS_ERROR_CODE;
 exports.ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE;
 exports.ZoomOAuthAccessTokenError = ZoomOAuthAccessTokenError;
 exports.ZoomOAuthAuthFailureError = ZoomOAuthAuthFailureError;

package/index.esm.js

@@ -1,5 +1,5 @@
 import { fetchPageFactory, FetchResponseError, mergeMakeUrlSearchParamsOptions, makeUrlSearchParams, FetchRequestFactoryError, rateLimitedFetchHandler, fetchJsonFunction, returnNullHandleFetchJsonParseErrorFunction, fetchApiFetchService } from '@dereekb/util/fetch';
-import { MS_IN_MINUTE, asArray, resetPeriodPromiseRateLimiter, MS_IN_SECOND } from '@dereekb/util';
+import { MS_IN_SECOND, asArray, resetPeriodPromiseRateLimiter, MS_IN_MINUTE } from '@dereekb/util';
 import { BaseError } from 'make-error';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
@@ -3410,13 +3410,17 @@ function handleZoomErrorFetchFactory(parseZoomError, defaultLogError) {
  * The status code that Zoom uses to indicates that too many requests have been made in a short period of time.
  */
 const ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+/**
+ * Also shares the same 429 code as ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE.
+ */
+const ZOOM_TOO_MANY_REQUESTS_ERROR_CODE = 429;
 const ZOOM_RATE_LIMIT_CATEGORY_HEADER = 'X-RateLimit-Category';
 const ZOOM_RATE_LIMIT_TYPE_HEADER = 'X-RateLimit-Type';
 const ZOOM_RATE_LIMIT_LIMIT_HEADER = 'X-RateLimit-Limit';
 const ZOOM_RATE_LIMIT_REMAINING_HEADER = 'X-RateLimit-Remaining';
 const ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER = 'Retry-After';
-const DEFAULT_ZOOM_API_RATE_LIMIT = 100;
-const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = MS_IN_MINUTE;
+const DEFAULT_ZOOM_API_RATE_LIMIT = 2;
+const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = MS_IN_SECOND;
 function zoomRateLimitHeaderDetails(headers) {
   const limitHeader = headers.get(ZOOM_RATE_LIMIT_LIMIT_HEADER);
   const remainingHeader = headers.get(ZOOM_RATE_LIMIT_REMAINING_HEADER);
@@ -3424,13 +3428,13 @@ function zoomRateLimitHeaderDetails(headers) {
   const categoryHeader = headers.get(ZOOM_RATE_LIMIT_CATEGORY_HEADER);
   const typeHeader = headers.get(ZOOM_RATE_LIMIT_TYPE_HEADER);
   let result = null;
-  if (limitHeader != null && remainingHeader != null && retryAfterHeader != null) {
-    const limit = Number(limitHeader);
-    const remaining = Number(remainingHeader);
-    const retryAfter = Number(retryAfterHeader);
-    const retryAfterAt = new Date(retryAfter);
+  if (categoryHeader != null && typeHeader != null) {
     const category = categoryHeader;
     const type = typeHeader;
+    const limit = limitHeader ? Number(limitHeader) : undefined;
+    const remaining = remainingHeader ? Number(remainingHeader) : undefined;
+    const retryAfter = retryAfterHeader ? Number(retryAfterHeader) : undefined;
+    const retryAfterAt = retryAfterHeader ? new Date(retryAfterHeader) : undefined;
     result = {
       limit,
       remaining,
@@ -3458,6 +3462,11 @@ function parseZoomServerErrorData(zoomServerError, responseError) {
   let result;
   if (responseError.response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
     result = new ZoomTooManyRequestsError(zoomServerError, responseError);
+    console.warn('ZoomTooManyRequestsError', {
+      result,
+      responseError,
+      headerDetails: result.headerDetails
+    });
   } else if (zoomServerError) {
     switch (zoomServerError.code) {
       default:
@@ -3718,48 +3727,54 @@ function zoomRateLimitedFetchHandler(config) {
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      startLimitAt: Math.ceil(limit / 10),
-      // can do 10% of the requests of the limit before rate limiting begins
-      cooldownRate: 1.2 * (limit / (defaultResetPeriod / MS_IN_SECOND)),
-      exponentRate: 1.08,
-      maxWaitTime: MS_IN_SECOND * 10,
+      startLimitAt: 2,
+      cooldownRate: 1,
+      exponentRate: 1.2,
+      maxWaitTime: MS_IN_SECOND * 5,
       resetPeriod: defaultResetPeriod,
       resetAt
     };
   }
-  const defaultConfig = configForLimit(defaultLimit);
+  const defaultConfig = configForLimit();
   const rateLimiter = resetPeriodPromiseRateLimiter(defaultConfig);
   return rateLimitedFetchHandler({
     rateLimiter,
     updateWithResponse: function (response, fetchResponseError) {
       const hasLimitHeader = response.headers.has(ZOOM_RATE_LIMIT_REMAINING_HEADER);
       let shouldRetry = false;
-      let enabled = false;
+      // let enabled = false;   // rate limiter should not be turned off
       if (hasLimitHeader) {
         const headerDetails = zoomRateLimitHeaderDetails(response.headers);
         if (headerDetails) {
           const {
+            type,
             limit,
             retryAfterAt,
             remaining
           } = headerDetails;
-          if (limit !== defaultLimit) {
-            const newConfig = configForLimit(limit, retryAfterAt);
-            rateLimiter.setConfig(newConfig, false);
-          }
-          rateLimiter.setRemainingLimit(remaining);
-          rateLimiter.setNextResetAt(retryAfterAt);
-          enabled = true;
-          // only retry if it's a TOO MANY REQUESTS error
           if (response.status === ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
-            shouldRetry = true;
-            try {
-              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
-            } catch (e) {}
+            // For simple query-per-second rate limits, just schedule a retry
+            if (type === 'QPS') {
+              shouldRetry = true;
+              try {
+                onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+              } catch (e) {}
+            }
+          }
+          // NOTE: typically it seems like these headers are not available usually.
+          // There is a daily limit for message requests
+          if (limit != null && retryAfterAt != null && remaining != null) {
+            if (limit !== defaultLimit) {
+              const newConfig = configForLimit(limit, retryAfterAt);
+              rateLimiter.setConfig(newConfig, false);
+            }
+            rateLimiter.setRemainingLimit(remaining);
+            rateLimiter.setNextResetAt(retryAfterAt);
+            // enabled = true;
           }
         }
       }
-      rateLimiter.setEnabled(enabled);
+      // rateLimiter.setEnabled(enabled);
       return shouldRetry;
     }
   });
@@ -4290,4 +4305,4 @@ function zoomOAuthZoomAccessTokenFactory(config) {
   };
 }
 
-export { DEFAULT_ZOOM_API_RATE_LIMIT, DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE, ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE, ZOOM_API_URL, ZOOM_OAUTH_API_URL, ZOOM_RATE_LIMIT_CATEGORY_HEADER, ZOOM_RATE_LIMIT_LIMIT_HEADER, ZOOM_RATE_LIMIT_REMAINING_HEADER, ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER, ZOOM_RATE_LIMIT_TYPE_HEADER, ZOOM_SUCCESS_CODE, ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZoomApprovalType, ZoomMeetingType, ZoomMonthlyWeek, ZoomMonthlyWeekDay, ZoomOAuthAccessTokenError, ZoomOAuthAuthFailureError, ZoomRecurrenceType, ZoomRegistrationType, ZoomServerError, ZoomServerFetchResponseError, ZoomTooManyRequestsError, ZoomUserType, createMeetingForUser, deleteMeeting, getMeeting, getUser, handleZoomErrorFetch, handleZoomErrorFetchFactory, handleZoomOAuthErrorFetch, listMeetingsForUser, listMeetingsForUserPageFactory, listUsers, listUsersPageFactory, logZoomErrorToConsole, logZoomOAuthErrorToConsole, logZoomServerErrorFunction, mapToZoomPageResult, omitSilenceZoomErrorKeys, parseZoomApiError, parseZoomApiServerErrorResponseData, parseZoomOAuthError, parseZoomOAuthServerErrorResponseData, parseZoomServerErrorData, serverAccessToken, silenceZoomErrorWithCodesFunction, userAccessToken, zoomAccessTokenStringFactory, zoomFactory, zoomFetchPageFactory, zoomOAuthApiFetchJsonInput, zoomOAuthFactory, zoomOAuthServerBasicAuthorizationHeaderValue, zoomOAuthZoomAccessTokenFactory, zoomRateLimitHeaderDetails, zoomRateLimitedFetchHandler };
+export { DEFAULT_ZOOM_API_RATE_LIMIT, DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOOM_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, DELETE_MEETING_DOES_NOT_EXIST_ERROR_CODE, ZOOM_ACCOUNTS_INVALID_GRANT_ERROR_CODE, ZOOM_API_URL, ZOOM_OAUTH_API_URL, ZOOM_RATE_LIMIT_CATEGORY_HEADER, ZOOM_RATE_LIMIT_LIMIT_HEADER, ZOOM_RATE_LIMIT_REMAINING_HEADER, ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER, ZOOM_RATE_LIMIT_TYPE_HEADER, ZOOM_SUCCESS_CODE, ZOOM_TOO_MANY_REQUESTS_ERROR_CODE, ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZoomApprovalType, ZoomMeetingType, ZoomMonthlyWeek, ZoomMonthlyWeekDay, ZoomOAuthAccessTokenError, ZoomOAuthAuthFailureError, ZoomRecurrenceType, ZoomRegistrationType, ZoomServerError, ZoomServerFetchResponseError, ZoomTooManyRequestsError, ZoomUserType, createMeetingForUser, deleteMeeting, getMeeting, getUser, handleZoomErrorFetch, handleZoomErrorFetchFactory, handleZoomOAuthErrorFetch, listMeetingsForUser, listMeetingsForUserPageFactory, listUsers, listUsersPageFactory, logZoomErrorToConsole, logZoomOAuthErrorToConsole, logZoomServerErrorFunction, mapToZoomPageResult, omitSilenceZoomErrorKeys, parseZoomApiError, parseZoomApiServerErrorResponseData, parseZoomOAuthError, parseZoomOAuthServerErrorResponseData, parseZoomServerErrorData, serverAccessToken, silenceZoomErrorWithCodesFunction, userAccessToken, zoomAccessTokenStringFactory, zoomFactory, zoomFetchPageFactory, zoomOAuthApiFetchJsonInput, zoomOAuthFactory, zoomOAuthServerBasicAuthorizationHeaderValue, zoomOAuthZoomAccessTokenFactory, zoomRateLimitHeaderDetails, zoomRateLimitedFetchHandler };

package/nestjs/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [12.1.1](https://github.com/dereekb/dbx-components/compare/v12.1.0-dev...v12.1.1) (2025-05-12)
+
+
+
 # [12.1.0](https://github.com/dereekb/dbx-components/compare/v12.0.6-dev...v12.1.0) (2025-05-10)
 
 

package/nestjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoom/nestjs",
-  "version": "12.1.0",
+  "version": "12.1.1",
   "type": "commonjs",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoom",
-  "version": "12.1.0",
+  "version": "12.1.1",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/zoom.error.api.d.ts

@@ -76,24 +76,23 @@ export declare function handleZoomErrorFetchFactory(parseZoomError: ParseZoomFet
  * The status code that Zoom uses to indicates that too many requests have been made in a short period of time.
  */
 export declare const ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+/**
+ * Also shares the same 429 code as ZOOM_TOO_MANY_REQUESTS_HTTP_STATUS_CODE.
+ */
+export declare const ZOOM_TOO_MANY_REQUESTS_ERROR_CODE = 429;
 export type ZoomRateLimitCategory = 'Light' | 'Medium' | 'Heavy';
-export type ZoomRateLimitType = 'Per-second-limit' | 'Daily-limit';
+/**
+ * QPS - Queries per second
+ */
+export type ZoomRateLimitType = 'QPS' | 'Per-second-limit' | 'Daily-limit';
 export declare const ZOOM_RATE_LIMIT_CATEGORY_HEADER = "X-RateLimit-Category";
 export declare const ZOOM_RATE_LIMIT_TYPE_HEADER = "X-RateLimit-Type";
 export declare const ZOOM_RATE_LIMIT_LIMIT_HEADER = "X-RateLimit-Limit";
 export declare const ZOOM_RATE_LIMIT_REMAINING_HEADER = "X-RateLimit-Remaining";
 export declare const ZOOM_RATE_LIMIT_RETRY_AFTER_HEADER = "Retry-After";
-export declare const DEFAULT_ZOOM_API_RATE_LIMIT = 100;
-export declare const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD: number;
+export declare const DEFAULT_ZOOM_API_RATE_LIMIT = 2;
+export declare const DEFAULT_ZOOM_API_RATE_LIMIT_RESET_PERIOD = 1000;
 export interface ZoomRateLimitHeaderDetails {
-    /**
-     * Total limit in a given period.
-     */
-    readonly limit: number;
-    /**
-     * Total number of remaining allowed requests.
-     */
-    readonly remaining: number;
     /**
      * The category of the rate limit.
      */
@@ -102,14 +101,22 @@ export interface ZoomRateLimitHeaderDetails {
      * The type of the rate limit.
      */
     readonly type: ZoomRateLimitType;
+    /**
+     * Total limit in a given period.
+     */
+    readonly limit?: number;
+    /**
+     * Total number of remaining allowed requests.
+     */
+    readonly remaining?: number;
     /**
      * The time at which the rate limit will reset.
      */
-    readonly retryAfter: UnixDateTimeNumber;
+    readonly retryAfter?: UnixDateTimeNumber;
     /**
      * The time at which the rate limit will reset.
      */
-    readonly retryAfterAt: Date;
+    readonly retryAfterAt?: Date;
 }
 export declare function zoomRateLimitHeaderDetails(headers: Headers): Maybe<ZoomRateLimitHeaderDetails>;
 export declare class ZoomTooManyRequestsError extends ZoomServerFetchResponseError {

package/src/lib/zoom.limit.d.ts

@@ -15,19 +15,17 @@ export interface ZoomRateLimitedFetchHandlerConfig {
     /**
      * Custom max rate limit.
      *
-     * Rate limits are different between account types and are described here:
-     *
-     * https://help.zoom.com/portal/en/community/topic/key-changes-in-api-limits-26-9-2018#:~:text=X%2DRATELIMIT%2DREMAINING%20%2D%20Represents,time%20of%20the%20current%20window.&text=Please%20note%20that%20these%20Rate,API%20limit%20changes%20are%20implemented.
+     * The QPS is the main rate limit to watch for. We start slowing down requets after 2 requests per second.
      */
     readonly maxRateLimit?: number;
     /**
      * Custom reset period for the rate limiter.
      *
-     * Defaults to 1 minute in milliseconds.
+     * Defaults to 1 second in milliseconds.
      */
     readonly resetPeriod?: Milliseconds;
     /**
-     * Optional function to execute when too many requests is reached.t
+     * Optional function to execute when too many requests is reached.
      *
      * Defaults to the default logging function, unless false is passed.
      */