@dereekb/zoho 11.0.12 → 11.0.14

package/index.cjs.js

@@ -2911,6 +2911,43 @@ const ZOHO_DUPLICATE_DATA_ERROR_CODE = 'DUPLICATE_DATA';
  * Error when some passed data is invalid.
  */
 const ZOHO_INVALID_DATA_ERROR_CODE = 'INVALID_DATA';
+/**
+ * Error when too many requests are made in a short period of time.
+ */
+const ZOHO_TOO_MANY_REQUESTS_ERROR_CODE = 'TOO_MANY_REQUESTS';
+/**
+ * The status code that Zoho uses to indicates that too many requests have been made in a short period of time.
+ */
+const ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+const ZOHO_RATE_LIMIT_LIMIT_HEADER = 'X-RATELIMIT-LIMIT';
+const ZOHO_RATE_LIMIT_REMAINING_HEADER = 'X-RATELIMIT-REMAINING';
+const ZOHO_RATE_LIMIT_RESET_HEADER = 'X-RATELIMIT-RESET';
+const DEFAULT_ZOHO_API_RATE_LIMIT = 100;
+const DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_MINUTE;
+function zohoRateLimitHeaderDetails(headers) {
+  const limitHeader = headers.has(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+  const remainingHeader = headers.get(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+  const resetHeader = headers.get(ZOHO_RATE_LIMIT_RESET_HEADER);
+  let result = null;
+  if (limitHeader != null && remainingHeader != null && resetHeader != null) {
+    const limit = Number(limitHeader);
+    const remaining = Number(remainingHeader);
+    const reset = Number(resetHeader);
+    const resetAt = new Date(reset);
+    result = {
+      limit,
+      remaining,
+      reset,
+      resetAt
+    };
+  }
+  return result;
+}
+class ZohoTooManyRequestsError extends ZohoServerFetchResponseError {
+  get headerDetails() {
+    return zohoRateLimitHeaderDetails(this.responseError.response.headers);
+  }
+}
 /**
  * Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
  *
@@ -2933,6 +2970,9 @@ function parseZohoServerErrorResponseData(errorResponseData, responseError) {
       case ZOHO_INVALID_QUERY_ERROR_CODE:
         result = new ZohoInvalidQueryError(errorData, responseError);
         break;
+      case ZOHO_TOO_MANY_REQUESTS_ERROR_CODE:
+        result = new ZohoTooManyRequestsError(errorData, responseError);
+        break;
       default:
         result = new ZohoServerFetchResponseError(errorData, responseError);
         break;
@@ -3370,6 +3410,63 @@ 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$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,
+      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,
+      resetAt
+    };
+  }
+  const defaultConfig = configForLimit(defaultLimit);
+  const rateLimiter = util.resetPeriodPromiseRateLimiter(defaultConfig);
+  return fetch.rateLimitedFetchHandler({
+    rateLimiter,
+    updateWithResponse: function (response, fetchResponseError) {
+      const hasLimitHeader = response.headers.has(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+      let shouldRetry = false;
+      let enabled = false;
+      if (hasLimitHeader) {
+        const headerDetails = zohoRateLimitHeaderDetails(response.headers);
+        if (headerDetails) {
+          const {
+            limit,
+            resetAt,
+            remaining
+          } = headerDetails;
+          if (limit !== defaultLimit) {
+            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
+          if (response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
+            shouldRetry = true;
+            try {
+              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+            } catch (e) {}
+          }
+        }
+      }
+      rateLimiter.setEnabled(enabled);
+      return shouldRetry;
+    }
+  });
+}
+
 function _call$1(body, then, direct) {
   if (direct) {
     return then ? then(body()) : body();
@@ -3386,9 +3483,10 @@ function zohoRecruitFactory(factoryConfig) {
     accountsContext
   } = factoryConfig;
   const accessTokenStringFactory = zohoAccessTokenStringFactory(accountsContext.loadAccessToken);
+  const fetchHandler = zohoRateLimitedFetchHandler(factoryConfig.rateLimiterConfig);
   const {
     logZohoServerErrorFunction,
-    fetchFactory = input => fetch.nodeFetchService.makeFetch({
+    fetchFactory = input => fetch.fetchApiFetchService.makeFetch({
       baseUrl: input.apiUrl,
       baseRequest: function () {
         return _call$1(accessTokenStringFactory, function (_accessTokenStringFac) {
@@ -3400,6 +3498,7 @@ function zohoRecruitFactory(factoryConfig) {
           };
         });
       },
+      fetchHandler,
       timeout: 20 * 1000,
       requireOkResponse: true,
       useTimeout: true // use timeout
@@ -3423,7 +3522,8 @@ function zohoRecruitFactory(factoryConfig) {
       fetchJson,
       config: Object.assign({}, config, {
         apiUrl
-      })
+      }),
+      zohoRateLimiter: fetchHandler._rateLimiter
     };
     const zohoRecruit = {
       recruitContext
@@ -3540,15 +3640,17 @@ function _invoke(body, then) {
   return then(result);
 }
 function zohoAccountsFactory(factoryConfig) {
+  const fetchHandler = zohoRateLimitedFetchHandler();
   const {
     logZohoServerErrorFunction,
-    fetchFactory = input => fetch.nodeFetchService.makeFetch({
+    fetchFactory = input => fetch.fetchApiFetchService.makeFetch({
       baseUrl: input.apiUrl,
       baseRequest: {
         headers: {
           'Content-Type': 'application/json'
         }
       },
+      fetchHandler,
       timeout: 20 * 1000,
       requireOkResponse: true,
       useTimeout: true // use timeout
@@ -3664,6 +3766,9 @@ 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;
@@ -3673,9 +3778,14 @@ exports.ZOHO_INVALID_AUTHORIZATION_ERROR_CODE = ZOHO_INVALID_AUTHORIZATION_ERROR
 exports.ZOHO_INVALID_DATA_ERROR_CODE = ZOHO_INVALID_DATA_ERROR_CODE;
 exports.ZOHO_INVALID_QUERY_ERROR_CODE = ZOHO_INVALID_QUERY_ERROR_CODE;
 exports.ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE = ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE;
+exports.ZOHO_RATE_LIMIT_LIMIT_HEADER = ZOHO_RATE_LIMIT_LIMIT_HEADER;
+exports.ZOHO_RATE_LIMIT_REMAINING_HEADER = ZOHO_RATE_LIMIT_REMAINING_HEADER;
+exports.ZOHO_RATE_LIMIT_RESET_HEADER = ZOHO_RATE_LIMIT_RESET_HEADER;
 exports.ZOHO_RECRUIT_CANDIDATES_MODULE = ZOHO_RECRUIT_CANDIDATES_MODULE;
 exports.ZOHO_RECRUIT_SERVICE_NAME = ZOHO_RECRUIT_SERVICE_NAME;
 exports.ZOHO_SUCCESS_CODE = ZOHO_SUCCESS_CODE;
+exports.ZOHO_TOO_MANY_REQUESTS_ERROR_CODE = ZOHO_TOO_MANY_REQUESTS_ERROR_CODE;
+exports.ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE;
 exports.ZohoAccountsAccessTokenError = ZohoAccountsAccessTokenError;
 exports.ZohoAccountsAuthFailureError = ZohoAccountsAuthFailureError;
 exports.ZohoInternalError = ZohoInternalError;
@@ -3689,6 +3799,7 @@ exports.ZohoRecruitRecordCrudNoMatchingRecordError = ZohoRecruitRecordCrudNoMatc
 exports.ZohoRecruitRecordNoContentError = ZohoRecruitRecordNoContentError;
 exports.ZohoServerError = ZohoServerError;
 exports.ZohoServerFetchResponseError = ZohoServerFetchResponseError;
+exports.ZohoTooManyRequestsError = ZohoTooManyRequestsError;
 exports.accessToken = accessToken;
 exports.assertRecordDataArrayResultHasContent = assertRecordDataArrayResultHasContent;
 exports.createNotes = createNotes;
@@ -3726,6 +3837,8 @@ exports.zohoAccountsConfigApiUrl = zohoAccountsConfigApiUrl;
 exports.zohoAccountsFactory = zohoAccountsFactory;
 exports.zohoAccountsZohoAccessTokenFactory = zohoAccountsZohoAccessTokenFactory;
 exports.zohoFetchPageFactory = zohoFetchPageFactory;
+exports.zohoRateLimitHeaderDetails = zohoRateLimitHeaderDetails;
+exports.zohoRateLimitedFetchHandler = zohoRateLimitedFetchHandler;
 exports.zohoRecruitApiFetchJsonInput = zohoRecruitApiFetchJsonInput;
 exports.zohoRecruitConfigApiUrl = zohoRecruitConfigApiUrl;
 exports.zohoRecruitFactory = zohoRecruitFactory;

package/index.esm.js

@@ -1,5 +1,5 @@
-import { getNextPageNumber, escapeStringCharactersFunction, isStandardInternetAccessibleWebsiteUrl, filterMaybeValues, asArray, MS_IN_MINUTE, MS_IN_SECOND } from '@dereekb/util';
-import { fetchPageFactory, FetchResponseError, makeUrlSearchParams, FetchRequestFactoryError, fetchJsonFunction, returnNullHandleFetchJsonParseErrorFunction, nodeFetchService } from '@dereekb/util/fetch';
+import { getNextPageNumber, escapeStringCharactersFunction, isStandardInternetAccessibleWebsiteUrl, filterMaybeValues, asArray, MS_IN_MINUTE, resetPeriodPromiseRateLimiter, MS_IN_SECOND } from '@dereekb/util';
+import { fetchPageFactory, FetchResponseError, makeUrlSearchParams, FetchRequestFactoryError, rateLimitedFetchHandler, fetchJsonFunction, returnNullHandleFetchJsonParseErrorFunction, fetchApiFetchService } from '@dereekb/util/fetch';
 import { BaseError } from 'make-error';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
@@ -3005,6 +3005,45 @@ const ZOHO_DUPLICATE_DATA_ERROR_CODE = 'DUPLICATE_DATA';
  */
 const ZOHO_INVALID_DATA_ERROR_CODE = 'INVALID_DATA';
 
+/**
+ * Error when too many requests are made in a short period of time.
+ */
+const ZOHO_TOO_MANY_REQUESTS_ERROR_CODE = 'TOO_MANY_REQUESTS';
+
+/**
+ * The status code that Zoho uses to indicates that too many requests have been made in a short period of time.
+ */
+const ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+const ZOHO_RATE_LIMIT_LIMIT_HEADER = 'X-RATELIMIT-LIMIT';
+const ZOHO_RATE_LIMIT_REMAINING_HEADER = 'X-RATELIMIT-REMAINING';
+const ZOHO_RATE_LIMIT_RESET_HEADER = 'X-RATELIMIT-RESET';
+const DEFAULT_ZOHO_API_RATE_LIMIT = 100;
+const DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = MS_IN_MINUTE;
+function zohoRateLimitHeaderDetails(headers) {
+  const limitHeader = headers.has(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+  const remainingHeader = headers.get(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+  const resetHeader = headers.get(ZOHO_RATE_LIMIT_RESET_HEADER);
+  let result = null;
+  if (limitHeader != null && remainingHeader != null && resetHeader != null) {
+    const limit = Number(limitHeader);
+    const remaining = Number(remainingHeader);
+    const reset = Number(resetHeader);
+    const resetAt = new Date(reset);
+    result = {
+      limit,
+      remaining,
+      reset,
+      resetAt
+    };
+  }
+  return result;
+}
+class ZohoTooManyRequestsError extends ZohoServerFetchResponseError {
+  get headerDetails() {
+    return zohoRateLimitHeaderDetails(this.responseError.response.headers);
+  }
+}
+
 /**
  * Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
  *
@@ -3027,6 +3066,9 @@ function parseZohoServerErrorResponseData(errorResponseData, responseError) {
       case ZOHO_INVALID_QUERY_ERROR_CODE:
         result = new ZohoInvalidQueryError(errorData, responseError);
         break;
+      case ZOHO_TOO_MANY_REQUESTS_ERROR_CODE:
+        result = new ZohoTooManyRequestsError(errorData, responseError);
+        break;
       default:
         result = new ZohoServerFetchResponseError(errorData, responseError);
         break;
@@ -3500,14 +3542,80 @@ 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$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,
+      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,
+      resetAt
+    };
+  }
+  const defaultConfig = configForLimit(defaultLimit);
+  const rateLimiter = resetPeriodPromiseRateLimiter(defaultConfig);
+  return rateLimitedFetchHandler({
+    rateLimiter,
+    updateWithResponse: function (response, fetchResponseError) {
+      const hasLimitHeader = response.headers.has(ZOHO_RATE_LIMIT_REMAINING_HEADER);
+      let shouldRetry = false;
+      let enabled = false;
+      if (hasLimitHeader) {
+        const headerDetails = zohoRateLimitHeaderDetails(response.headers);
+        if (headerDetails) {
+          const {
+            limit,
+            resetAt,
+            remaining
+          } = headerDetails;
+          if (limit !== defaultLimit) {
+            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
+          if (response.status === ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE) {
+            shouldRetry = true;
+            try {
+              onTooManyRequests == null || onTooManyRequests(headerDetails, response, fetchResponseError);
+            } catch (e) {}
+          }
+        }
+      }
+      rateLimiter.setEnabled(enabled);
+      return shouldRetry;
+    }
+  });
+}
+
 function zohoRecruitFactory(factoryConfig) {
   const {
     accountsContext
   } = factoryConfig;
   const accessTokenStringFactory = zohoAccessTokenStringFactory(accountsContext.loadAccessToken);
+  const fetchHandler = zohoRateLimitedFetchHandler(factoryConfig.rateLimiterConfig);
   const {
     logZohoServerErrorFunction,
-    fetchFactory = input => nodeFetchService.makeFetch({
+    fetchFactory = input => fetchApiFetchService.makeFetch({
       baseUrl: input.apiUrl,
       baseRequest: async () => ({
         headers: {
@@ -3515,6 +3623,7 @@ function zohoRecruitFactory(factoryConfig) {
           Authorization: `Bearer ${await accessTokenStringFactory()}`
         }
       }),
+      fetchHandler,
       timeout: 20 * 1000,
       // 20 second timeout
       requireOkResponse: true,
@@ -3541,7 +3650,8 @@ function zohoRecruitFactory(factoryConfig) {
       fetchJson,
       config: Object.assign({}, config, {
         apiUrl
-      })
+      }),
+      zohoRateLimiter: fetchHandler._rateLimiter
     };
     const zohoRecruit = {
       recruitContext
@@ -3596,15 +3706,17 @@ function zohoAccountsConfigApiUrl(input) {
  */
 
 function zohoAccountsFactory(factoryConfig) {
+  const fetchHandler = zohoRateLimitedFetchHandler();
   const {
     logZohoServerErrorFunction,
-    fetchFactory = input => nodeFetchService.makeFetch({
+    fetchFactory = input => fetchApiFetchService.makeFetch({
       baseUrl: input.apiUrl,
       baseRequest: {
         headers: {
           'Content-Type': 'application/json'
         }
       },
+      fetchHandler,
       timeout: 20 * 1000,
       // 20 second timeout
       requireOkResponse: true,
@@ -3721,4 +3833,4 @@ function zohoAccountsZohoAccessTokenFactory(config) {
   };
 }
 
-export { 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_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, 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, 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,14 @@
 
 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)
+
+
+
 ## [11.0.12](https://github.com/dereekb/dbx-components/compare/v11.0.11-dev...v11.0.12) (2024-11-24)
 
 

package/nestjs/package.json

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

package/nestjs/src/lib/recruit/recruit.api.d.ts

@@ -6,6 +6,7 @@ export declare class ZohoRecruitApi {
     readonly zohoAccountsApi: ZohoAccountsApi;
     readonly zohoRecruit: ZohoRecruit;
     get recruitContext(): ZohoRecruitContext;
+    get zohoRateLimiter(): import("../../../../../../dist/packages/util/src").ResetPeriodPromiseRateLimiter;
     constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;

package/nestjs/src/lib/recruit/recruit.api.js

@@ -13,6 +13,9 @@ let ZohoRecruitApi = exports.ZohoRecruitApi = class ZohoRecruitApi {
     get recruitContext() {
         return this.zohoRecruit.recruitContext;
     }
+    get zohoRateLimiter() {
+        return this.zohoRecruit.recruitContext.zohoRateLimiter;
+    }
     constructor(config, zohoAccountsApi) {
         this.config = config;
         this.zohoAccountsApi = zohoAccountsApi;

package/nestjs/src/lib/recruit/recruit.api.js.map

@@ -1 +1 @@
-{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAAqQ;AACrQ,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAO8B;IAAoE;IANlH,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,CAAC;IAED,YAAuD,MAAgC,EAAoC,eAAgC;QAApG,WAAM,GAAN,MAAM,CAA0B;QAAoC,oBAAe,GAAf,eAAe,CAAiB;QACzJ,IAAI,CAAC,WAAW,GAAG,IAAA,yBAAkB,EAAC;YACpC,GAAG,MAAM,CAAC,aAAa;YACvB,eAAe,EAAE,eAAe,CAAC,eAAe;SACjD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAA,+BAAwB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;CACF,CAAA;yBA1DY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAQE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAPhJ,cAAc,CA0D1B"}
+{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAAqQ;AACrQ,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAW8B;IAAoE;IAVlH,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC;IACzD,CAAC;IAED,YAAuD,MAAgC,EAAoC,eAAgC;QAApG,WAAM,GAAN,MAAM,CAA0B;QAAoC,oBAAe,GAAf,eAAe,CAAiB;QACzJ,IAAI,CAAC,WAAW,GAAG,IAAA,yBAAkB,EAAC;YACpC,GAAG,MAAM,CAAC,aAAa;YACvB,eAAe,EAAE,eAAe,CAAC,eAAe;SACjD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAA,+BAAwB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;CACF,CAAA;yBA9DY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAYE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAXhJ,cAAc,CA8D1B"}

package/package.json

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

package/src/lib/index.d.ts

@@ -3,4 +3,5 @@ export * from './accounts';
 export * from './zoho.error.api';
 export * from './zoho.api.page';
 export * from './zoho.config';
+export * from './zoho.limit';
 export * from './zoho.type';

package/src/lib/recruit/recruit.config.d.ts

@@ -2,6 +2,7 @@ import { FactoryWithRequiredInput } from '@dereekb/util';
 import { ConfiguredFetch, FetchJsonFunction } from '@dereekb/util/fetch';
 import { ZohoApiUrl, ZohoRefreshToken, ZohoApiUrlKey, ZohoConfig, ZohoApiServiceName } from '../zoho.config';
 import { ZohoServiceAccessTokenKey } from '../accounts';
+import { ZohoRateLimiterRef } from '../zoho.limit';
 export declare const ZOHO_RECRUIT_SERVICE_NAME: ZohoApiServiceName | ZohoServiceAccessTokenKey;
 export type ZohoRecruitApiUrl = ZohoApiUrl;
 export type ZohoRecruitApiKey = ZohoRefreshToken;
@@ -13,7 +14,7 @@ export interface ZohoRecruitFetchFactoryInput {
     readonly apiUrl: ZohoRecruitApiUrl;
 }
 export type ZohoRecruitFetchFactory = FactoryWithRequiredInput<ConfiguredFetch, ZohoRecruitFetchFactoryInput>;
-export interface ZohoRecruitContext {
+export interface ZohoRecruitContext extends ZohoRateLimiterRef {
     readonly fetch: ConfiguredFetch;
     readonly fetchJson: FetchJsonFunction;
     readonly config: ZohoRecruitConfig;

package/src/lib/recruit/recruit.d.ts

@@ -136,7 +136,7 @@ export interface ZohoRecruitSearchRecordsCriteriaTree<T = any> {
      */
     readonly or?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
 }
-export type ZohoRecruitSearchRecordsCriteriaTreeElement<T = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
+export type ZohoRecruitSearchRecordsCriteriaTreeElement<T = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree<T> | ZohoRecruitSearchRecordsCriteriaString;
 export type ZohoRecruitSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
 export type ZohoRecruitSearchRecordsCriteriaEntryArray<T = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
 export interface ZohoRecruitSearchRecordsCriteriaEntry<T = any> {

package/src/lib/recruit/recruit.factory.d.ts

@@ -1,8 +1,14 @@
 import { ZohoRecruitConfig, ZohoRecruitContextRef, ZohoRecruitFetchFactory } from './recruit.config';
 import { LogZohoServerErrorFunction } from '../zoho.error.api';
 import { ZohoAccountsContextRef } from '../accounts/accounts.config';
+import { ZohoRateLimitedFetchHandlerConfig } from '../zoho.limit';
+import { Maybe } from '@dereekb/util';
 export type ZohoRecruit = ZohoRecruitContextRef;
 export interface ZohoRecruitFactoryConfig extends ZohoAccountsContextRef {
+    /**
+     * Custom ZohoRateLimitedFetchHandlerConfig
+     */
+    rateLimiterConfig?: Maybe<ZohoRateLimitedFetchHandlerConfig>;
     /**
      * Creates a new fetch instance to use when making calls.
      */

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

@@ -1,4 +1,4 @@
-import { Maybe } from '@dereekb/util';
+import { Maybe, UnixDateTimeNumber } from '@dereekb/util';
 import { ConfiguredFetch, FetchJsonInterceptJsonResponseFunction, FetchRequestFactoryError, FetchResponseError } from '@dereekb/util/fetch';
 import { BaseError } from 'make-error';
 export type ZohoServerErrorResponseDataError = ZohoServerErrorData | ZohoServerErrorCode;
@@ -125,6 +125,41 @@ export declare const ZOHO_DUPLICATE_DATA_ERROR_CODE = "DUPLICATE_DATA";
  * Error when some passed data is invalid.
  */
 export declare const ZOHO_INVALID_DATA_ERROR_CODE = "INVALID_DATA";
+/**
+ * Error when too many requests are made in a short period of time.
+ */
+export declare const ZOHO_TOO_MANY_REQUESTS_ERROR_CODE = "TOO_MANY_REQUESTS";
+/**
+ * The status code that Zoho uses to indicates that too many requests have been made in a short period of time.
+ */
+export declare const ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = 429;
+export declare const ZOHO_RATE_LIMIT_LIMIT_HEADER = "X-RATELIMIT-LIMIT";
+export declare const ZOHO_RATE_LIMIT_REMAINING_HEADER = "X-RATELIMIT-REMAINING";
+export declare const ZOHO_RATE_LIMIT_RESET_HEADER = "X-RATELIMIT-RESET";
+export declare const DEFAULT_ZOHO_API_RATE_LIMIT = 100;
+export declare const DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD: number;
+export interface ZohoRateLimitHeaderDetails {
+    /**
+     * 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 reset: UnixDateTimeNumber;
+    /**
+     * The time at which the rate limit will reset.
+     */
+    readonly resetAt: Date;
+}
+export declare function zohoRateLimitHeaderDetails(headers: Headers): Maybe<ZohoRateLimitHeaderDetails>;
+export declare class ZohoTooManyRequestsError extends ZohoServerFetchResponseError {
+    get headerDetails(): Maybe<ZohoRateLimitHeaderDetails>;
+}
 /**
  * Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
  *

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

@@ -0,0 +1,37 @@
+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.
+     *
+     * Rate limits are different between account types and are described here:
+     *
+     * https://help.zoho.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.
+     */
+    readonly maxRateLimit?: number;
+    /**
+     * Custom reset period for the rate limiter.
+     *
+     * 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;