@dereekb/zoho 11.0.13 → 11.0.14

package/index.cjs.js

@@ -3410,17 +3410,23 @@ function zohoAccessTokenStringFactory(zohoAccessTokenFactory) {
   };
 }
 
+const DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = headers => {
+  console.warn(`zohoRateLimitedFetchHandler(): Too many requests made. The limit is ${headers.limit} requests per reset period. Will be reset at ${headers.resetAt}.`);
+};
 function zohoRateLimitedFetchHandler(config) {
-  var _config$maxRateLimit, _config$resetPeriod;
+  var _config$onTooManyRequ, _config$maxRateLimit, _config$resetPeriod;
+  const onTooManyRequests = (config == null ? void 0 : config.onTooManyRequests) !== false ? (_config$onTooManyRequ = config == null ? void 0 : config.onTooManyRequests) != null ? _config$onTooManyRequ : DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION : undefined;
   const defaultLimit = (_config$maxRateLimit = config == null ? void 0 : config.maxRateLimit) != null ? _config$maxRateLimit : DEFAULT_ZOHO_API_RATE_LIMIT;
   const defaultResetPeriod = (_config$resetPeriod = config == null ? void 0 : config.resetPeriod) != null ? _config$resetPeriod : DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD;
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      cooldownRate: limit / (defaultResetPeriod / util.MS_IN_SECOND),
-      exponentRate: 1.12,
+      startLimitAt: Math.ceil(limit / 20),
+      cooldownRate: 1.1 * (limit / (defaultResetPeriod / util.MS_IN_SECOND)),
+      exponentRate: 1.1,
       maxWaitTime: util.MS_IN_SECOND * 10,
-      resetPeriod: defaultResetPeriod
+      resetPeriod: defaultResetPeriod,
+      resetAt
     };
   }
   const defaultConfig = configForLimit(defaultLimit);
@@ -3440,14 +3446,19 @@ function zohoRateLimitedFetchHandler(config) {
             remaining
           } = headerDetails;
           if (limit !== defaultLimit) {
-            const newConfig = configForLimit(limit);
+            const newConfig = configForLimit(limit, resetAt);
             rateLimiter.setConfig(newConfig, false);
           }
           rateLimiter.setRemainingLimit(remaining);
           rateLimiter.setNextResetAt(resetAt);
           enabled = true;
           // only retry if it's a TOO MANY REQUESTS error
-          shouldRetry = response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE;
+          if (response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
+            shouldRetry = true;
+            try {
+              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+            } catch (e) {}
+          }
         }
       }
       rateLimiter.setEnabled(enabled);
@@ -3757,6 +3768,7 @@ function zohoAccountsZohoAccessTokenFactory(config) {
 
 exports.DEFAULT_ZOHO_API_RATE_LIMIT = DEFAULT_ZOHO_API_RATE_LIMIT;
 exports.DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD;
+exports.DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION;
 exports.ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE = ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE;
 exports.ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE = ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE;
 exports.ZOHO_ACCOUNTS_US_API_URL = ZOHO_ACCOUNTS_US_API_URL;

package/index.esm.js

@@ -3542,17 +3542,30 @@ function zohoAccessTokenStringFactory(zohoAccessTokenFactory) {
   };
 }
 
+/**
+ * Function to execute when too many requests is reached.
+ *
+ * Typically used for logging of some sort. Thrown errors are ignored.
+ */
+
+const DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = headers => {
+  console.warn(`zohoRateLimitedFetchHandler(): Too many requests made. The limit is ${headers.limit} requests per reset period. Will be reset at ${headers.resetAt}.`);
+};
 function zohoRateLimitedFetchHandler(config) {
-  var _config$maxRateLimit, _config$resetPeriod;
+  var _config$onTooManyRequ, _config$maxRateLimit, _config$resetPeriod;
+  const onTooManyRequests = (config == null ? void 0 : config.onTooManyRequests) !== false ? (_config$onTooManyRequ = config == null ? void 0 : config.onTooManyRequests) != null ? _config$onTooManyRequ : DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION : undefined;
   const defaultLimit = (_config$maxRateLimit = config == null ? void 0 : config.maxRateLimit) != null ? _config$maxRateLimit : DEFAULT_ZOHO_API_RATE_LIMIT;
   const defaultResetPeriod = (_config$resetPeriod = config == null ? void 0 : config.resetPeriod) != null ? _config$resetPeriod : DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD;
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      cooldownRate: limit / (defaultResetPeriod / MS_IN_SECOND),
-      exponentRate: 1.12,
+      startLimitAt: Math.ceil(limit / 20),
+      // can do 5% of the requests of the limit before rate limiting begins
+      cooldownRate: 1.1 * (limit / (defaultResetPeriod / MS_IN_SECOND)),
+      exponentRate: 1.1,
       maxWaitTime: MS_IN_SECOND * 10,
-      resetPeriod: defaultResetPeriod
+      resetPeriod: defaultResetPeriod,
+      resetAt
     };
   }
   const defaultConfig = configForLimit(defaultLimit);
@@ -3572,7 +3585,7 @@ function zohoRateLimitedFetchHandler(config) {
             remaining
           } = headerDetails;
           if (limit !== defaultLimit) {
-            const newConfig = configForLimit(limit);
+            const newConfig = configForLimit(limit, resetAt);
             rateLimiter.setConfig(newConfig, false);
           }
           rateLimiter.setRemainingLimit(remaining);
@@ -3580,7 +3593,12 @@ function zohoRateLimitedFetchHandler(config) {
           enabled = true;
 
           // only retry if it's a TOO MANY REQUESTS error
-          shouldRetry = response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE;
+          if (response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
+            shouldRetry = true;
+            try {
+              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+            } catch (e) {}
+          }
         }
       }
       rateLimiter.setEnabled(enabled);
@@ -3815,4 +3833,4 @@ function zohoAccountsZohoAccessTokenFactory(config) {
   };
 }
 
-export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_ERROR_CODE, ZOHO_INTERNAL_ERROR_CODE, ZOHO_INVALID_AUTHORIZATION_ERROR_CODE, ZOHO_INVALID_DATA_ERROR_CODE, ZOHO_INVALID_QUERY_ERROR_CODE, ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE, ZOHO_RATE_LIMIT_LIMIT_HEADER, ZOHO_RATE_LIMIT_REMAINING_HEADER, ZOHO_RATE_LIMIT_RESET_HEADER, ZOHO_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZOHO_TOO_MANY_REQUESTS_ERROR_CODE, ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, accessToken, assertRecordDataArrayResultHasContent, createNotes, createNotesForRecord, deleteNotes, escapeZohoFieldValueForCriteriaString, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParams, zohoRecruitUrlSearchParamsMinusIdAndModule, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };
+export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_ERROR_CODE, ZOHO_INTERNAL_ERROR_CODE, ZOHO_INVALID_AUTHORIZATION_ERROR_CODE, ZOHO_INVALID_DATA_ERROR_CODE, ZOHO_INVALID_QUERY_ERROR_CODE, ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE, ZOHO_RATE_LIMIT_LIMIT_HEADER, ZOHO_RATE_LIMIT_REMAINING_HEADER, ZOHO_RATE_LIMIT_RESET_HEADER, ZOHO_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZOHO_TOO_MANY_REQUESTS_ERROR_CODE, ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, accessToken, assertRecordDataArrayResultHasContent, createNotes, createNotesForRecord, deleteNotes, escapeZohoFieldValueForCriteriaString, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParams, zohoRecruitUrlSearchParamsMinusIdAndModule, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };

package/nestjs/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.0.14](https://github.com/dereekb/dbx-components/compare/v11.0.13-dev...v11.0.14) (2024-11-27)
+
+
+
 ## [11.0.13](https://github.com/dereekb/dbx-components/compare/v11.0.12-dev...v11.0.13) (2024-11-27)
 
 

package/nestjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "11.0.13",
+  "version": "11.0.14",
   "type": "commonjs",
   "main": "./src/index.js"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho",
-  "version": "11.0.13",
+  "version": "11.0.14",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

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

@@ -1,8 +1,16 @@
-import { Maybe, Milliseconds, ResetPeriodPromiseRateLimiter } from '@dereekb/util';
-import { RateLimitedFetchHandler } from '@dereekb/util/fetch';
+import { Maybe, Milliseconds, PromiseOrValue, ResetPeriodPromiseRateLimiter } from '@dereekb/util';
+import { FetchResponseError, RateLimitedFetchHandler } from '@dereekb/util/fetch';
+import { ZohoRateLimitHeaderDetails } from './zoho.error.api';
 export interface ZohoRateLimiterRef {
     readonly zohoRateLimiter: ResetPeriodPromiseRateLimiter;
 }
+/**
+ * Function to execute when too many requests is reached.
+ *
+ * Typically used for logging of some sort. Thrown errors are ignored.
+ */
+export type ZohoRateLimitedTooManyRequestsLogFunction = (headers: ZohoRateLimitHeaderDetails, response: Response, fetchResponseError?: FetchResponseError) => PromiseOrValue<void>;
+export declare const DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION: (headers: ZohoRateLimitHeaderDetails) => void;
 export interface ZohoRateLimitedFetchHandlerConfig {
     /**
      * Custom max rate limit.
@@ -18,6 +26,12 @@ export interface ZohoRateLimitedFetchHandlerConfig {
      * Defaults to 1 minute in milliseconds.
      */
     readonly resetPeriod?: Milliseconds;
+    /**
+     * Optional function to execute when too many requests is reached.t
+     *
+     * Defaults to the default logging function, unless false is passed.
+     */
+    readonly onTooManyRequests?: ZohoRateLimitedTooManyRequestsLogFunction | false;
 }
 export type ZohoRateLimitedFetchHandler = RateLimitedFetchHandler<ResetPeriodPromiseRateLimiter>;
 export declare function zohoRateLimitedFetchHandler(config?: Maybe<ZohoRateLimitedFetchHandlerConfig>): ZohoRateLimitedFetchHandler;