@dereekb/util 11.0.11 → 11.0.13

package/fetch/index.cjs.js

@@ -4922,7 +4922,7 @@ function fetchTimeout(inputFetch) {
  * @returns
  */
 
-function _await$2(value, then, direct) {
+function _await$3(value, then, direct) {
   if (direct) {
     return then ? then(value) : value;
   }
@@ -4931,13 +4931,13 @@ function _await$2(value, then, direct) {
   }
   return then ? value.then(then) : value;
 } /**
-   * Creates a function that wraps fetch and uses a FetchRequestFactory to generate a Request before invoking Fetch.
-   *
-   * @param config
+   * Default FetchHabdler
+   * @param request
+   * @param makeFetch
    * @returns
    */
 
-function _async$2(f) {
+function _async$3(f) {
   return function () {
     for (var args = [], i = 0; i < arguments.length; i++) {
       args[i] = arguments[i];
@@ -4956,7 +4956,7 @@ function _invokeIgnored(body) {
     return result.then(_empty);
   }
 }
-function _invoke(body, then) {
+function _invoke$1(body, then) {
   var result = body();
   if (result && result.then) {
     return result.then(then);
@@ -4974,7 +4974,7 @@ function _call(body, then, direct) {
     return Promise.reject(e);
   }
 }
-function _catch(body, recover) {
+function _catch$1(body, recover) {
   try {
     var result = body();
   } catch (e) {
@@ -5005,9 +5005,17 @@ function fetchService(config) {
   };
   return factory;
 }
+const DEFAULT_FETCH_HANDLER = (request, makeFetch) => makeFetch(request);
+/**
+ * Creates a function that wraps fetch and uses a FetchRequestFactory to generate a Request before invoking Fetch.
+ *
+ * @param config
+ * @returns
+ */
 function configureFetch(config) {
   const {
     makeFetch: inputMakeFetch = fetch,
+    fetchHandler = DEFAULT_FETCH_HANDLER,
     useTimeout,
     requireOkResponse: inputRequireOkResponse,
     mapResponse
@@ -5022,9 +5030,9 @@ function configureFetch(config) {
     makeFetch = fetchOk(makeFetch);
   }
   const makeFetchRequest = fetchRequestFactory(config);
-  return _async$2(function (input, init) {
-    return _await$2(makeFetchRequest(input, init), function (request) {
-      let response = makeFetch(request);
+  return _async$3(function (input, init) {
+    return _await$3(makeFetchRequest(input, init), function (request) {
+      let response = fetchHandler(request, makeFetch);
       if (mapResponse) {
         response = mapResponse(response);
       }
@@ -5032,10 +5040,18 @@ function configureFetch(config) {
     });
   });
 }
+/**
+ * The deafult FetchRequestFactory implementation that uses window/global Request.
+ *
+ * @param input
+ * @param init
+ * @returns
+ */
+const DEFAULT_FETCH_REQUEST_FACTORY = (input, init) => new Request(input, init);
 function fetchRequestFactory(config) {
-  const asFetchRequest = _async$2(function (input) {
+  const asFetchRequest = _async$3(function (input) {
     const _isPromiseLike = util.isPromiseLike(input);
-    return _await$2(input, function (awaitedInput) {
+    return _await$3(input, function (awaitedInput) {
       if (isFetchRequest(awaitedInput)) {
         return awaitedInput;
       } else {
@@ -5044,7 +5060,7 @@ function fetchRequestFactory(config) {
     }, !_isPromiseLike);
   });
   const {
-    makeRequest = (input, init) => new Request(input, init),
+    makeRequest = DEFAULT_FETCH_REQUEST_FACTORY,
     baseUrl: inputBaseUrl,
     baseRequest: inputBaseRequest,
     timeout,
@@ -5058,11 +5074,11 @@ function fetchRequestFactory(config) {
     const result = new URL(urlPath, baseUrl);
     return result;
   } : undefined;
-  const buildRequestWithFixedUrl = buildUrl ? _async$2(function (input) {
+  const buildRequestWithFixedUrl = buildUrl ? _async$3(function (input) {
     let relativeUrl;
     let baseRequest;
     let request;
-    return _invoke(function () {
+    return _invoke$1(function () {
       if (typeof input === 'string') {
         relativeUrl = input;
       } else return _invokeIgnored(function () {
@@ -5074,16 +5090,16 @@ function fetchRequestFactory(config) {
             request = input;
           }
         } else {
-          return _await$2(makeRequest(input), function (_makeRequest) {
+          return _await$3(makeRequest(input), function (_makeRequest) {
             request = _makeRequest;
           });
         }
       });
     }, function () {
-      return _invoke(function () {
+      return _invoke$1(function () {
         if (!request) {
           const url = buildUrl(relativeUrl);
-          return _await$2(makeRequest(url.href, baseRequest), function (_makeRequest2) {
+          return _await$3(makeRequest(url.href, baseRequest), function (_makeRequest2) {
             request = _makeRequest2;
           });
         }
@@ -5096,7 +5112,7 @@ function fetchRequestFactory(config) {
   if (inputBaseRequest != null || timeout != null) {
     const combineRequestInits = function combineRequestInits(request, requestInit) {
       return _call(computeBaseRequest, function (baseRequest) {
-        return _await$2(requestInit, function (_requestInit) {
+        return _await$3(requestInit, function (_requestInit) {
           const merged = mergeRequestInits(baseRequest, _requestInit);
           const timeout = merged.timeout === undefined ? request.timeout : merged.timeout;
           return Object.assign({}, merged, {
@@ -5124,12 +5140,12 @@ function fetchRequestFactory(config) {
   } else {
     buildRequestInit = (_, x) => x;
   }
-  return _async$2(function (input, init) {
-    return _catch(function () {
-      return _await$2(buildRequestWithFixedUrl(input), function (fixedRequest) {
-        return _await$2(buildRequestInit(fixedRequest, init), function (_buildRequestInit) {
+  return _async$3(function (input, init) {
+    return _catch$1(function () {
+      return _await$3(buildRequestWithFixedUrl(input), function (fixedRequest) {
+        return _await$3(buildRequestInit(fixedRequest, init), function (_buildRequestInit) {
           init = _buildRequestInit;
-          return _await$2(makeRequest(fixedRequest, init), function (request) {
+          return _await$3(makeRequest(fixedRequest, init), function (request) {
             request.timeout = timeout; // copy/set timeout on the request directly
             return request;
           });
@@ -5191,6 +5207,93 @@ function isFetchRequest(input) {
   return Boolean(input.url);
 }
 
+function _await$2(value, then, direct) {
+  if (direct) {
+    return then ? then(value) : value;
+  }
+  if (!value || !value.then) {
+    value = Promise.resolve(value);
+  }
+  return then ? value.then(then) : value;
+}
+function _catch(body, recover) {
+  try {
+    var result = body();
+  } catch (e) {
+    return recover(e);
+  }
+  if (result && result.then) {
+    return result.then(void 0, recover);
+  }
+  return result;
+}
+function _invoke(body, then) {
+  var result = body();
+  if (result && result.then) {
+    return result.then(then);
+  }
+  return then(result);
+}
+function _continue(value, then) {
+  return value && value.then ? value.then(then) : then(value);
+}
+function _async$2(f) {
+  return function () {
+    for (var args = [], i = 0; i < arguments.length; i++) {
+      args[i] = arguments[i];
+    }
+    try {
+      return Promise.resolve(f.apply(this, args));
+    } catch (e) {
+      return Promise.reject(e);
+    }
+  };
+}
+function rateLimitedFetchHandler(config) {
+  const {
+    updateWithResponse,
+    maxRetries: inputMaxRetries
+  } = config;
+  const maxRetries = inputMaxRetries != null ? inputMaxRetries : 1;
+  const _rateLimiter = config.rateLimiter;
+  const fetchHandler = function fetchHandler(request, makeFetch) {
+    const tryFetch = _async$2(function (retriesAttempted) {
+      // wait for the rate limiter
+      return _await$2(_rateLimiter.waitForRateLimit(), function () {
+        let response;
+        let fetchResponseError;
+        return _continue(_catch(function () {
+          return _await$2(makeFetch(request), function (_makeFetch) {
+            response = _makeFetch;
+          });
+        }, function (e) {
+          fetchResponseError = e;
+          response = fetchResponseError.response;
+        }), function () {
+          return _await$2(updateWithResponse(response, fetchResponseError), function (shouldRetry) {
+            return _invoke(function () {
+              if (shouldRetry && retriesAttempted < maxRetries) {
+                return _await$2(tryFetch(retriesAttempted + 1), function (_tryFetch) {
+                  response = _tryFetch;
+                });
+              } else {
+                if (fetchResponseError != null) {
+                  throw fetchResponseError;
+                }
+              }
+            }, function (_result) {
+              return response;
+            });
+          });
+        });
+      });
+    });
+    return tryFetch(0);
+  };
+  fetchHandler._rateLimiter = _rateLimiter;
+  return fetchHandler;
+}
+
 function _await$1(value, then, direct) {
   if (direct) {
     return then ? then(value) : value;
@@ -5694,11 +5797,21 @@ function fetchJsonRequestInitFunction(config = {}) {
 }
 const fetchJsonRequestInit = fetchJsonRequestInitFunction();
 
-const nodeFetchService = fetchService({
+/**
+ * Default FetchService implementation that uses the native Fetch api.
+ */
+const fetchApiFetchService = fetchService({
   makeFetch: fetch,
   makeRequest: (x, y) => new Request(x, y)
 });
+// MARK: Compat
+/**
+ * @deprecated use fetchApiFetchService instead. This is an alias.
+ */
+const nodeFetchService = fetchApiFetchService;
 
+exports.DEFAULT_FETCH_HANDLER = DEFAULT_FETCH_HANDLER;
+exports.DEFAULT_FETCH_REQUEST_FACTORY = DEFAULT_FETCH_REQUEST_FACTORY;
 exports.FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE = FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE;
 exports.FetchPageLimitReachedError = FetchPageLimitReachedError;
 exports.FetchPageNoNextPageError = FetchPageNoNextPageError;
@@ -5707,6 +5820,7 @@ exports.FetchResponseError = FetchResponseError;
 exports.FetchTimeoutError = FetchTimeoutError;
 exports.JsonResponseParseError = JsonResponseParseError;
 exports.configureFetch = configureFetch;
+exports.fetchApiFetchService = fetchApiFetchService;
 exports.fetchJsonBodyString = fetchJsonBodyString;
 exports.fetchJsonFunction = fetchJsonFunction;
 exports.fetchJsonRequestInit = fetchJsonRequestInit;
@@ -5731,6 +5845,7 @@ exports.mergeRequestHeaders = mergeRequestHeaders;
 exports.mergeRequestInits = mergeRequestInits;
 exports.nodeFetchService = nodeFetchService;
 exports.queryParamsToSearchParams = queryParamsToSearchParams;
+exports.rateLimitedFetchHandler = rateLimitedFetchHandler;
 exports.requireOkResponse = requireOkResponse;
 exports.returnNullHandleFetchJsonParseErrorFunction = returnNullHandleFetchJsonParseErrorFunction;
 exports.throwJsonResponseParseErrorFunction = throwJsonResponseParseErrorFunction;

package/fetch/index.esm.js

@@ -4946,6 +4946,18 @@ function fetchService(config) {
 
 // MARK: Make Fetch
 
+/**
+ * Custom fetch handler that takes in a Request and fetch function and returns a Response.
+ */
+
+/**
+ * Default FetchHabdler
+ * @param request
+ * @param makeFetch
+ * @returns
+ */
+const DEFAULT_FETCH_HANDLER = (request, makeFetch) => makeFetch(request);
+
 /**
  * Creates a function that wraps fetch and uses a FetchRequestFactory to generate a Request before invoking Fetch.
  *
@@ -4955,6 +4967,7 @@ function fetchService(config) {
 function configureFetch(config) {
   const {
     makeFetch: inputMakeFetch = fetch,
+    fetchHandler = DEFAULT_FETCH_HANDLER,
     useTimeout,
     requireOkResponse: inputRequireOkResponse,
     mapResponse
@@ -4971,7 +4984,7 @@ function configureFetch(config) {
   const makeFetchRequest = fetchRequestFactory(config);
   return async (input, init) => {
     const request = await makeFetchRequest(input, init);
-    let response = makeFetch(request);
+    let response = fetchHandler(request, makeFetch);
     if (mapResponse) {
       response = mapResponse(response);
     }
@@ -4981,9 +4994,17 @@ function configureFetch(config) {
 
 // MARK: Request
 
+/**
+ * The deafult FetchRequestFactory implementation that uses window/global Request.
+ *
+ * @param input
+ * @param init
+ * @returns
+ */
+const DEFAULT_FETCH_REQUEST_FACTORY = (input, init) => new Request(input, init);
 function fetchRequestFactory(config) {
   const {
-    makeRequest = (input, init) => new Request(input, init),
+    makeRequest = DEFAULT_FETCH_REQUEST_FACTORY,
     baseUrl: inputBaseUrl,
     baseRequest: inputBaseRequest,
     timeout,
@@ -5118,6 +5139,46 @@ function isFetchRequest(input) {
   return Boolean(input.url);
 }
 
+/**
+ * A FetchRequestFactory with PromiseRateLimiter
+ */
+
+function rateLimitedFetchHandler(config) {
+  const {
+    updateWithResponse,
+    maxRetries: inputMaxRetries
+  } = config;
+  const maxRetries = inputMaxRetries != null ? inputMaxRetries : 1;
+  const _rateLimiter = config.rateLimiter;
+  const fetchHandler = async (request, makeFetch) => {
+    async function tryFetch(retriesAttempted) {
+      // wait for the rate limiter
+      await _rateLimiter.waitForRateLimit();
+      let response;
+      let fetchResponseError;
+      try {
+        response = await makeFetch(request);
+      } catch (e) {
+        fetchResponseError = e;
+        response = fetchResponseError.response;
+      }
+      const shouldRetry = await updateWithResponse(response, fetchResponseError);
+      if (shouldRetry && retriesAttempted < maxRetries) {
+        response = await tryFetch(retriesAttempted + 1);
+      } else {
+        // re-throw the fetch response error if it exists and we cannot retry
+        if (fetchResponseError != null) {
+          throw fetchResponseError;
+        }
+      }
+      return response;
+    }
+    return tryFetch(0);
+  };
+  fetchHandler._rateLimiter = _rateLimiter;
+  return fetchHandler;
+}
+
 class FetchPageNoNextPageError extends FetchRequestFactoryError {
   constructor(page) {
     super(`There was no next page for this.`);
@@ -5621,9 +5682,18 @@ function fetchJsonRequestInitFunction(config = {}) {
 }
 const fetchJsonRequestInit = fetchJsonRequestInitFunction();
 
-const nodeFetchService = fetchService({
+/**
+ * Default FetchService implementation that uses the native Fetch api.
+ */
+const fetchApiFetchService = fetchService({
   makeFetch: fetch,
   makeRequest: (x, y) => new Request(x, y)
 });
 
-export { FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE, FetchPageLimitReachedError, FetchPageNoNextPageError, FetchRequestFactoryError, FetchResponseError, FetchTimeoutError, JsonResponseParseError, configureFetch, fetchJsonBodyString, fetchJsonFunction, fetchJsonRequestInit, fetchJsonRequestInitFunction, fetchOk, fetchPageFactory, fetchRequestFactory, fetchService, fetchTimeout, fetchURL, fetchURLQueryKeyValueStringTuples, fetchURLSearchParamsObjectToURLSearchParams, headersToHeadersTuple, isFetchRequest, isURL, isURLSearchParams, iterateFetchPages, iterateFetchPagesByEachItem, iterateFetchPagesByItems, makeUrlSearchParams, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };
+// MARK: Compat
+/**
+ * @deprecated use fetchApiFetchService instead. This is an alias.
+ */
+const nodeFetchService = fetchApiFetchService;
+
+export { DEFAULT_FETCH_HANDLER, DEFAULT_FETCH_REQUEST_FACTORY, FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE, FetchPageLimitReachedError, FetchPageNoNextPageError, FetchRequestFactoryError, FetchResponseError, FetchTimeoutError, JsonResponseParseError, configureFetch, fetchApiFetchService, fetchJsonBodyString, fetchJsonFunction, fetchJsonRequestInit, fetchJsonRequestInitFunction, fetchOk, fetchPageFactory, fetchRequestFactory, fetchService, fetchTimeout, fetchURL, fetchURLQueryKeyValueStringTuples, fetchURLSearchParamsObjectToURLSearchParams, headersToHeadersTuple, isFetchRequest, isURL, isURLSearchParams, iterateFetchPages, iterateFetchPagesByEachItem, iterateFetchPagesByItems, makeUrlSearchParams, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, rateLimitedFetchHandler, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };

package/fetch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util/fetch",
-  "version": "11.0.11",
+  "version": "11.0.13",
   ".": {
     "types": "./src/index.d.ts",
     "node": {

package/fetch/src/lib/fetch.d.ts

@@ -20,6 +20,10 @@ export type FetchServiceConfig = Required<Pick<ConfigureFetchInput, 'makeFetch'
  */
 export declare function fetchService(config: FetchServiceConfig): FetchService;
 export type MapFetchResponseFunction = MapFunction<Promise<Response>, Promise<Response>>;
+/**
+ * Custom fetch handler that takes in a Request and fetch function and returns a Response.
+ */
+export type FetchHandler = (request: Request, makeFetch: typeof fetch) => Promise<Response>;
 export interface ConfigureFetchInput extends FetchRequestFactoryInput {
     makeFetch?: typeof fetch;
     /**
@@ -34,6 +38,10 @@ export interface ConfigureFetchInput extends FetchRequestFactoryInput {
      * Default: false
      */
     requireOkResponse?: boolean;
+    /**
+     * (Optional) Custom fetch handler.
+     */
+    fetchHandler?: FetchHandler;
     /**
      * (Optional) MapFetchResponseFunction
      *
@@ -41,6 +49,13 @@ export interface ConfigureFetchInput extends FetchRequestFactoryInput {
      */
     mapResponse?: MapFetchResponseFunction;
 }
+/**
+ * Default FetchHabdler
+ * @param request
+ * @param makeFetch
+ * @returns
+ */
+export declare const DEFAULT_FETCH_HANDLER: FetchHandler;
 /**
  * Creates a function that wraps fetch and uses a FetchRequestFactory to generate a Request before invoking Fetch.
  *
@@ -81,6 +96,14 @@ export interface FetchRequestFactoryInput {
 export type FetchRequestInitFactory = (currRequest: PromiseOrValue<Request>, init?: PromiseOrValue<RequestInit>) => PromiseOrValue<RequestInitWithTimeout | undefined>;
 export type FetchRequestFactory = (input: RequestInfo | URL, init?: RequestInit | undefined) => PromiseOrValue<Request>;
 export type AbortControllerFactory = Factory<AbortController>;
+/**
+ * The deafult FetchRequestFactory implementation that uses window/global Request.
+ *
+ * @param input
+ * @param init
+ * @returns
+ */
+export declare const DEFAULT_FETCH_REQUEST_FACTORY: FetchRequestFactory;
 export declare function fetchRequestFactory(config: FetchRequestFactoryInput): FetchRequestFactory;
 export declare function mergeRequestInits<T extends RequestInit>(base: T, requestInit?: T | undefined): T;
 export declare function mergeRequestHeaders(inputHeadersArray: Maybe<HeadersInit>[]): [string, string][];

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

@@ -0,0 +1,33 @@
+import { type Maybe, type PromiseOrValue, type PromiseRateLimiter } from '@dereekb/util';
+import { type FetchHandler } from './fetch';
+import { type FetchResponseError } from './error';
+/**
+ * A FetchRequestFactory with PromiseRateLimiter
+ */
+export type RateLimitedFetchHandler<T extends PromiseRateLimiter = PromiseRateLimiter> = FetchHandler & {
+    /**
+     * Internal limiter used by the RateLimitedFetchRequestFactory.
+     */
+    readonly _rateLimiter: T;
+};
+export interface RateLimitedFetchHandlerConfig<T extends PromiseRateLimiter> {
+    /**
+     * Rate limiter configuration. Should be based on the target API.
+     */
+    readonly rateLimiter: T;
+    /**
+     * The maximum number of retries to try.
+     *
+     * Defaults to 1.
+     */
+    readonly maxRetries?: number;
+    /**
+     * Update the fetch handler with the response, ideally setting/updating the time at which the rate limiter can be reset.
+     *
+     * Return true if the response should be retried. Should typically also only return true if the response is a throttle error by the remote server.
+     *
+     * The response is only allowed to be retried once not guranteed to be retried if it returns true on a second retry.
+     */
+    updateWithResponse(response: Response, fetchResponseError?: Maybe<FetchResponseError>): PromiseOrValue<boolean>;
+}
+export declare function rateLimitedFetchHandler<T extends PromiseRateLimiter>(config: RateLimitedFetchHandlerConfig<T>): RateLimitedFetchHandler<T>;

package/fetch/src/lib/index.d.ts

@@ -1,5 +1,6 @@
 export * from './error';
 export * from './fetch';
+export * from './fetch.limit';
 export * from './fetch.type';
 export * from './fetch.page';
 export * from './fetch.page.iterate';

package/fetch/src/lib/provider.d.ts

@@ -1,2 +1,9 @@
 import { type FetchService } from './fetch';
+/**
+ * Default FetchService implementation that uses the native Fetch api.
+ */
+export declare const fetchApiFetchService: FetchService;
+/**
+ * @deprecated use fetchApiFetchService instead. This is an alias.
+ */
 export declare const nodeFetchService: FetchService;

package/index.cjs.js

@@ -4795,6 +4795,20 @@ const sortCompareNumberFunction = (a, b) => a - b;
 function minAndMaxNumber(values) {
   return minAndMaxFunction(sortCompareNumberFunction)(values);
 }
+/**
+ * Returns the lorgathirm of y with base x.
+ *
+ * Example:
+ * - (log2(16)): x = 2, y = 16 -> 4    (2^4 = 16)
+ * - (log10(100)): x = 10, y = 100 -> 2   (10^2 = 100)
+ *
+ * @param x
+ * @param y
+ * @returns
+ */
+function getBaseLog(x, y) {
+  return Math.log(y) / Math.log(x);
+}
 
 function roundingFunction(type) {
   let fn;
@@ -13747,6 +13761,195 @@ function performTasksFromFactoryInParallelFunction(config) {
   };
 }
 
+function exponentialPromiseRateLimiter(initialConfig) {
+  const DEFAULT_COOLDOWN_RATE = 1;
+  const DEFAULT_EXPONENT_RATE = 2;
+  const DEFAULT_MAX_WAIT_TIME = MS_IN_HOUR;
+  let config = {
+    cooldownRate: DEFAULT_COOLDOWN_RATE,
+    exponentRate: DEFAULT_EXPONENT_RATE,
+    maxWaitTime: DEFAULT_MAX_WAIT_TIME
+  };
+  let currentCount = 0;
+  let countForMaxWaitTime = Number.MAX_SAFE_INTEGER;
+  let timeOfLastExecution = new Date();
+  let enabled = true;
+  setConfig(initialConfig != null ? initialConfig : config);
+  function getConfig() {
+    return Object.assign({}, config);
+  }
+  function getEnabled() {
+    return enabled;
+  }
+  function setEnabled(nextEnabled) {
+    enabled = nextEnabled;
+  }
+  function setConfig(newConfig, andReset = false) {
+    var _newConfig$cooldownRa, _newConfig$maxWaitTim, _newConfig$exponentRa;
+    const cooldownRate = (_newConfig$cooldownRa = newConfig.cooldownRate) != null ? _newConfig$cooldownRa : DEFAULT_COOLDOWN_RATE;
+    const maxWaitTime = (_newConfig$maxWaitTim = newConfig.maxWaitTime) != null ? _newConfig$maxWaitTim : DEFAULT_MAX_WAIT_TIME;
+    const exponentRate = (_newConfig$exponentRa = newConfig.exponentRate) != null ? _newConfig$exponentRa : DEFAULT_EXPONENT_RATE;
+    config = {
+      cooldownRate,
+      maxWaitTime,
+      exponentRate
+    };
+    // calculate max count for max wait time to use for determining rounding of nextWaitTime
+    countForMaxWaitTime = getBaseLog(exponentRate, maxWaitTime / MS_IN_SECOND + 1);
+    if (andReset) {
+      reset();
+    }
+  }
+  function reset() {
+    currentCount = 0;
+    timeOfLastExecution = new Date();
+  }
+  function _nextWaitTime(increasedExecutions) {
+    if (!enabled) {
+      return 0;
+    }
+    const {
+      cooldownRate
+    } = config;
+    const msSinceLastExecution = Date.now() - timeOfLastExecution.getTime();
+    const cooldown = msSinceLastExecution * cooldownRate / MS_IN_SECOND; // the cooldown amount
+    const count = Math.max(currentCount - cooldown, 0);
+    if (increasedExecutions) {
+      currentCount = count + increasedExecutions;
+      timeOfLastExecution = new Date();
+    }
+    if (count >= countForMaxWaitTime) {
+      return config.maxWaitTime;
+    } else {
+      return count === 0 ? 0 : Math.pow(config.exponentRate, Math.max(count - 1, 0)) * MS_IN_SECOND;
+    }
+  }
+  function getNextWaitTime(increase) {
+    return _nextWaitTime(increase != null ? increase : 0);
+  }
+  function waitForRateLimit() {
+    const waitTime = _nextWaitTime(1);
+    return waitForMs(waitTime);
+  }
+  return {
+    waitForRateLimit,
+    getNextWaitTime,
+    getConfig,
+    setConfig,
+    getEnabled,
+    setEnabled,
+    reset
+  };
+}
+/**
+ * Creates a ResetPeriodPromiseRateLimiter.
+ *
+ * @param limit
+ */
+function resetPeriodPromiseRateLimiter(initialConfig) {
+  const DEFAULT_EXPONENT_RATE = 1.5;
+  const exponentialLimiter = exponentialPromiseRateLimiter(Object.assign({
+    exponentRate: DEFAULT_EXPONENT_RATE,
+    maxWaitTime: MS_IN_SECOND * 8
+  }, initialConfig));
+  let resetPeriod = MS_IN_MINUTE;
+  let nextResetAt = new Date();
+  let limit = 0;
+  let remaining = 0;
+  let enabled = true;
+  setConfig(initialConfig, true);
+  function _checkRemainingReset() {
+    if (nextResetAt && isPast(nextResetAt)) {
+      reset();
+    }
+  }
+  function getEnabled() {
+    return enabled;
+  }
+  function setEnabled(nextEnabled) {
+    enabled = nextEnabled;
+  }
+  function reset() {
+    remaining = limit;
+    nextResetAt = new Date(Date.now() + resetPeriod);
+    // do not reset the exponential limiter
+  }
+
+  function getResetAt() {
+    return nextResetAt;
+  }
+  function getTimeUntilNextReset() {
+    return Math.max(0, nextResetAt.getTime() - Date.now());
+  }
+  function setNextResetAt(date) {
+    nextResetAt = date;
+  }
+  function getRemainingLimit() {
+    _checkRemainingReset();
+    return remaining;
+  }
+  function setRemainingLimit(nextRemaining) {
+    remaining = nextRemaining;
+  }
+  function setConfig(config, andReset = false) {
+    var _config$limit, _config$resetPeriod, _config$cooldownRate, _config$exponentRate, _config$maxWaitTime, _config$resetAt;
+    limit = (_config$limit = config.limit) != null ? _config$limit : limit;
+    resetPeriod = (_config$resetPeriod = config.resetPeriod) != null ? _config$resetPeriod : resetPeriod;
+    const exponentialLimiterConfig = {
+      cooldownRate: (_config$cooldownRate = config.cooldownRate) != null ? _config$cooldownRate : Math.max(0.1, resetPeriod / MS_IN_SECOND),
+      exponentRate: (_config$exponentRate = config.exponentRate) != null ? _config$exponentRate : DEFAULT_EXPONENT_RATE,
+      maxWaitTime: (_config$maxWaitTime = config.maxWaitTime) != null ? _config$maxWaitTime : MS_IN_SECOND * 8
+    };
+    exponentialLimiter.setConfig(exponentialLimiterConfig, andReset);
+    if (andReset) {
+      reset();
+    }
+    nextResetAt = (_config$resetAt = config.resetAt) != null ? _config$resetAt : nextResetAt;
+  }
+  function _nextWaitTime(increasedExecutions) {
+    if (!enabled) {
+      return 0;
+    }
+    function computeNextWaitTime() {
+      remaining -= increasedExecutions;
+      return exponentialLimiter.getNextWaitTime(increasedExecutions);
+    }
+    let waitTime = 0;
+    if (remaining > 0) {
+      waitTime = computeNextWaitTime();
+    } else {
+      // if none remaining, try and reset
+      _checkRemainingReset();
+      if (remaining > 0) {
+        waitTime = computeNextWaitTime();
+      } else {
+        waitTime = getTimeUntilNextReset();
+      }
+    }
+    return waitTime;
+  }
+  function getNextWaitTime(increase) {
+    return _nextWaitTime(increase != null ? increase : 0);
+  }
+  function waitForRateLimit() {
+    const waitTime = _nextWaitTime(1);
+    return waitForMs(waitTime);
+  }
+  return {
+    getRemainingLimit,
+    setRemainingLimit,
+    getTimeUntilNextReset,
+    getResetAt,
+    setNextResetAt,
+    setConfig,
+    reset,
+    getNextWaitTime,
+    waitForRateLimit,
+    getEnabled,
+    setEnabled
+  };
+}
+
 function _await$1(value, then, direct) {
   if (direct) {
     return then ? then(value) : value;
@@ -16168,6 +16371,7 @@ exports.expandFlattenTreeFunction = expandFlattenTreeFunction;
 exports.expandIndexSet = expandIndexSet;
 exports.expandTreeFunction = expandTreeFunction;
 exports.expandTrees = expandTrees;
+exports.exponentialPromiseRateLimiter = exponentialPromiseRateLimiter;
 exports.extendLatLngBound = extendLatLngBound;
 exports.filterAndMapFunction = filterAndMapFunction;
 exports.filterEmptyValues = filterEmptyValues;
@@ -16237,6 +16441,7 @@ exports.forwardFunction = forwardFunction;
 exports.fractionalHoursToMinutes = fractionalHoursToMinutes;
 exports.generateIfDoesNotExist = generateIfDoesNotExist;
 exports.getArrayNextIndex = getArrayNextIndex;
+exports.getBaseLog = getBaseLog;
 exports.getDayOffset = getDayOffset;
 exports.getDayTomorrow = getDayTomorrow;
 exports.getDayYesterday = getDayYesterday;
@@ -16605,6 +16810,7 @@ exports.replaceLastCharacterIfIsFunction = replaceLastCharacterIfIsFunction;
 exports.replaceMultipleFilePathsInSlashPath = replaceMultipleFilePathsInSlashPath;
 exports.replaceStringsFunction = replaceStringsFunction;
 exports.requireModelKey = requireModelKey;
+exports.resetPeriodPromiseRateLimiter = resetPeriodPromiseRateLimiter;
 exports.restoreOrder = restoreOrder;
 exports.restoreOrderWithValues = restoreOrderWithValues;
 exports.reverseCompareFn = reverseCompareFn;

package/index.esm.js

@@ -5457,6 +5457,21 @@ function minAndMaxNumber(values) {
   return minAndMaxFunction(sortCompareNumberFunction)(values);
 }
 
+/**
+ * Returns the lorgathirm of y with base x.
+ *
+ * Example:
+ * - (log2(16)): x = 2, y = 16 -> 4    (2^4 = 16)
+ * - (log10(100)): x = 10, y = 100 -> 2   (10^2 = 100)
+ *
+ * @param x
+ * @param y
+ * @returns
+ */
+function getBaseLog(x, y) {
+  return Math.log(y) / Math.log(x);
+}
+
 // MARK: Rounding
 
 function roundingFunction(type) {
@@ -15272,6 +15287,213 @@ function performTasksFromFactoryInParallelFunction(config) {
   };
 }
 
+/**
+ * Interface for a rate limiter.
+ */
+
+/**
+ * Interface for a PromiseRateLimiter that can be enabled or disabled.
+ */
+
+// MARK: Exponential Limiter
+
+function exponentialPromiseRateLimiter(initialConfig) {
+  const DEFAULT_COOLDOWN_RATE = 1;
+  const DEFAULT_EXPONENT_RATE = 2;
+  const DEFAULT_MAX_WAIT_TIME = MS_IN_HOUR;
+  let config = {
+    cooldownRate: DEFAULT_COOLDOWN_RATE,
+    exponentRate: DEFAULT_EXPONENT_RATE,
+    maxWaitTime: DEFAULT_MAX_WAIT_TIME
+  };
+  let currentCount = 0;
+  let countForMaxWaitTime = Number.MAX_SAFE_INTEGER;
+  let timeOfLastExecution = new Date();
+  let enabled = true;
+  setConfig(initialConfig != null ? initialConfig : config);
+  function getConfig() {
+    return Object.assign({}, config);
+  }
+  function getEnabled() {
+    return enabled;
+  }
+  function setEnabled(nextEnabled) {
+    enabled = nextEnabled;
+  }
+  function setConfig(newConfig, andReset = false) {
+    var _newConfig$cooldownRa, _newConfig$maxWaitTim, _newConfig$exponentRa;
+    const cooldownRate = (_newConfig$cooldownRa = newConfig.cooldownRate) != null ? _newConfig$cooldownRa : DEFAULT_COOLDOWN_RATE;
+    const maxWaitTime = (_newConfig$maxWaitTim = newConfig.maxWaitTime) != null ? _newConfig$maxWaitTim : DEFAULT_MAX_WAIT_TIME;
+    const exponentRate = (_newConfig$exponentRa = newConfig.exponentRate) != null ? _newConfig$exponentRa : DEFAULT_EXPONENT_RATE;
+    config = {
+      cooldownRate,
+      maxWaitTime,
+      exponentRate
+    };
+
+    // calculate max count for max wait time to use for determining rounding of nextWaitTime
+    countForMaxWaitTime = getBaseLog(exponentRate, maxWaitTime / MS_IN_SECOND + 1);
+    if (andReset) {
+      reset();
+    }
+  }
+  function reset() {
+    currentCount = 0;
+    timeOfLastExecution = new Date();
+  }
+  function _nextWaitTime(increasedExecutions) {
+    if (!enabled) {
+      return 0;
+    }
+    const {
+      cooldownRate
+    } = config;
+    const msSinceLastExecution = Date.now() - timeOfLastExecution.getTime();
+    const cooldown = msSinceLastExecution * cooldownRate / MS_IN_SECOND; // the cooldown amount
+    const count = Math.max(currentCount - cooldown, 0);
+    if (increasedExecutions) {
+      currentCount = count + increasedExecutions;
+      timeOfLastExecution = new Date();
+    }
+    if (count >= countForMaxWaitTime) {
+      return config.maxWaitTime;
+    } else {
+      return count === 0 ? 0 : Math.pow(config.exponentRate, Math.max(count - 1, 0)) * MS_IN_SECOND;
+    }
+  }
+  function getNextWaitTime(increase) {
+    return _nextWaitTime(increase != null ? increase : 0);
+  }
+  function waitForRateLimit() {
+    const waitTime = _nextWaitTime(1);
+    return waitForMs(waitTime);
+  }
+  return {
+    waitForRateLimit,
+    getNextWaitTime,
+    getConfig,
+    setConfig,
+    getEnabled,
+    setEnabled,
+    reset
+  };
+}
+
+// MARK: Count Down limiter
+
+/**
+ * A rate limiter that resets every specific period of time and has a limited amount of items that can go out.
+ */
+
+/**
+ * Creates a ResetPeriodPromiseRateLimiter.
+ *
+ * @param limit
+ */
+function resetPeriodPromiseRateLimiter(initialConfig) {
+  const DEFAULT_EXPONENT_RATE = 1.5;
+  const exponentialLimiter = exponentialPromiseRateLimiter(Object.assign({
+    exponentRate: DEFAULT_EXPONENT_RATE,
+    maxWaitTime: MS_IN_SECOND * 8
+  }, initialConfig));
+  let resetPeriod = MS_IN_MINUTE;
+  let nextResetAt = new Date();
+  let limit = 0;
+  let remaining = 0;
+  let enabled = true;
+  setConfig(initialConfig, true);
+  function _checkRemainingReset() {
+    if (nextResetAt && isPast(nextResetAt)) {
+      reset();
+    }
+  }
+  function getEnabled() {
+    return enabled;
+  }
+  function setEnabled(nextEnabled) {
+    enabled = nextEnabled;
+  }
+  function reset() {
+    remaining = limit;
+    nextResetAt = new Date(Date.now() + resetPeriod);
+    // do not reset the exponential limiter
+  }
+
+  function getResetAt() {
+    return nextResetAt;
+  }
+  function getTimeUntilNextReset() {
+    return Math.max(0, nextResetAt.getTime() - Date.now());
+  }
+  function setNextResetAt(date) {
+    nextResetAt = date;
+  }
+  function getRemainingLimit() {
+    _checkRemainingReset();
+    return remaining;
+  }
+  function setRemainingLimit(nextRemaining) {
+    remaining = nextRemaining;
+  }
+  function setConfig(config, andReset = false) {
+    var _config$limit, _config$resetPeriod, _config$cooldownRate, _config$exponentRate, _config$maxWaitTime, _config$resetAt;
+    limit = (_config$limit = config.limit) != null ? _config$limit : limit;
+    resetPeriod = (_config$resetPeriod = config.resetPeriod) != null ? _config$resetPeriod : resetPeriod;
+    const exponentialLimiterConfig = {
+      cooldownRate: (_config$cooldownRate = config.cooldownRate) != null ? _config$cooldownRate : Math.max(0.1, resetPeriod / MS_IN_SECOND),
+      exponentRate: (_config$exponentRate = config.exponentRate) != null ? _config$exponentRate : DEFAULT_EXPONENT_RATE,
+      maxWaitTime: (_config$maxWaitTime = config.maxWaitTime) != null ? _config$maxWaitTime : MS_IN_SECOND * 8
+    };
+    exponentialLimiter.setConfig(exponentialLimiterConfig, andReset);
+    if (andReset) {
+      reset();
+    }
+    nextResetAt = (_config$resetAt = config.resetAt) != null ? _config$resetAt : nextResetAt;
+  }
+  function _nextWaitTime(increasedExecutions) {
+    if (!enabled) {
+      return 0;
+    }
+    function computeNextWaitTime() {
+      remaining -= increasedExecutions;
+      return exponentialLimiter.getNextWaitTime(increasedExecutions);
+    }
+    let waitTime = 0;
+    if (remaining > 0) {
+      waitTime = computeNextWaitTime();
+    } else {
+      // if none remaining, try and reset
+      _checkRemainingReset();
+      if (remaining > 0) {
+        waitTime = computeNextWaitTime();
+      } else {
+        waitTime = getTimeUntilNextReset();
+      }
+    }
+    return waitTime;
+  }
+  function getNextWaitTime(increase) {
+    return _nextWaitTime(increase != null ? increase : 0);
+  }
+  function waitForRateLimit() {
+    const waitTime = _nextWaitTime(1);
+    return waitForMs(waitTime);
+  }
+  return {
+    getRemainingLimit,
+    setRemainingLimit,
+    getTimeUntilNextReset,
+    getResetAt,
+    setNextResetAt,
+    setConfig,
+    reset,
+    getNextWaitTime,
+    waitForRateLimit,
+    getEnabled,
+    setEnabled
+  };
+}
+
 /**
  * Function that uses an array of Factories to produce Promises, one after the other, to attempt to return the value.
  *
@@ -17157,4 +17379,4 @@ async function iterateFilteredPages(inputPage, loadFn, iterFn) {
   return count;
 }
 
-export { ALL_DOUBLE_SLASHES_REGEX, ALL_SLASHES_REGEX, ALL_SLASH_PATH_FILE_TYPE_SEPARATORS_REGEX, ASSERTION_ERROR_CODE, ASSERTION_HANDLER, AUTH_ADMIN_ROLE, AUTH_ONBOARDED_ROLE, AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE, AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE, AUTH_TOS_SIGNED_ROLE, AUTH_USER_ROLE, AbstractUniqueModel, Assert, AssertMax, AssertMin, AssertionError, AssertionIssueHandler, BooleanStringKeyArrayUtility, BooleanStringKeyArrayUtilityInstance, CATCH_ALL_HANDLE_RESULT_KEY, CUT_VALUE_TO_ZERO_PRECISION, DATE_NOW_VALUE, DEFAULT_LAT_LNG_STRING_VALUE, DEFAULT_RANDOM_EMAIL_FACTORY_CONFIG, DEFAULT_RANDOM_PHONE_NUMBER_FACTORY_CONFIG, DEFAULT_READABLE_ERROR_CODE, DEFAULT_SLASH_PATH_ILLEGAL_CHARACTERS, DEFAULT_SLASH_PATH_ILLEGAL_CHARACTER_REPLACEMENT, DEFAULT_UNKNOWN_MODEL_TYPE_STRING, DOLLAR_AMOUNT_PRECISION, DOLLAR_AMOUNT_STRING_REGEX, DataDoesNotExistError, DataIsExpiredError, Day, DestroyFunctionObject, E164PHONE_NUMBER_REGEX, E164PHONE_NUMBER_WITH_EXTENSION_REGEX, E164PHONE_NUMBER_WITH_OPTIONAL_EXTENSION_REGEX, FINAL_PAGE, FIRST_PAGE, FRACTIONAL_HOURS_PRECISION_FUNCTION, FullStorageObject, HAS_PORT_NUMBER_REGEX, HAS_WEBSITE_DOMAIN_NAME_REGEX, HOURS_IN_DAY, HTTP_OR_HTTPS_REGEX, HashSet, ISO8601_DAY_STRING_REGEX, ISO8601_DAY_STRING_START_REGEX, ISO_8601_DATE_STRING_REGEX, KeyValueTypleValueFilter, LAT_LNG_PATTERN, LAT_LNG_PATTERN_MAX_PRECISION, LAT_LONG_100KM_PRECISION, LAT_LONG_100M_PRECISION, LAT_LONG_10CM_PRECISION, LAT_LONG_10KM_PRECISION, LAT_LONG_10M_PRECISION, LAT_LONG_1CM_PRECISION, LAT_LONG_1KM_PRECISION, LAT_LONG_1MM_PRECISION, LAT_LONG_1M_PRECISION, LAT_LONG_GRAINS_OF_SAND_PRECISION, LEADING_SLASHES_REGEX, MAP_IDENTITY, MAX_BITWISE_SET_SIZE, MAX_LATITUDE_VALUE, MAX_LONGITUDE_VALUE, MINUTES_IN_DAY, MINUTES_IN_HOUR, MINUTE_OF_DAY_MAXMIMUM, MINUTE_OF_DAY_MINIUMUM, MIN_LATITUDE_VALUE, MIN_LONGITUDE_VALUE, MONTH_DAY_SLASH_DATE_STRING_REGEX, MS_IN_DAY, MS_IN_HOUR, MS_IN_MINUTE, MS_IN_SECOND, MemoryStorageInstance, ModelRelationUtility, NOOP_MODIFIER, NUMBER_STRING_DENCODER_64, NUMBER_STRING_DENCODER_64_DEFAULT_NEGATIVE_PREFIX, NUMBER_STRING_DENCODER_64_DIGITS, PHONE_EXTENSION_NUMBER_REGEX, PRIMATIVE_KEY_DENCODER_VALUE, PageCalculator, PropertyDescriptorUtility, REGEX_SPECIAL_CHARACTERS, REGEX_SPECIAL_CHARACTERS_SET, RelationChange, SECONDS_IN_MINUTE, SHARED_MEMORY_STORAGE, SLASH_PATH_FILE_TYPE_SEPARATOR, SLASH_PATH_SEPARATOR, SORT_VALUE_EQUAL, SORT_VALUE_GREATER_THAN, SORT_VALUE_LESS_THAN, SPLIT_STRING_TREE_NODE_ROOT_VALUE, ServerErrorResponse, SetDeltaChange, SimpleStorageObject, StorageObject, StorageObjectUtility, StoredDataError, SyncState, TOTAL_LATITUDE_RANGE, TOTAL_LONGITUDE_RANGE, TOTAL_SPAN_OF_LONGITUDE, TRAILING_FILE_TYPE_SEPARATORS_REGEX, TRAILING_SLASHES_REGEX, TimeAM, TimerCancelledError, TimerInstance, TypedServiceRegistryInstance, UNLOADED_PAGE, US_STATE_CODE_STRING_REGEX, UTC_DATE_STRING_REGEX, UTC_TIMEZONE_STRING, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, UnauthorizedServerErrorResponse, WEBSITE_TLD_DETECTION_REGEX, WEB_PROTOCOL_PREFIX_REGEX, ZIP_CODE_STRING_REGEX, addHttpToUrl, addLatLngPoints, addModifiers, addPlusPrefixToNumber, addPrefix, addPrefixFunction, addSuffix, addSuffixFunction, addToSet, addToSetCopy, addToSplitStringTree, allFalsyOrEmptyKeys, allIndexesInIndexRange, allKeyValueTuples, allMaybeSoKeys, allNonUndefinedKeys, allObjectsAreEqual, allValuesAreMaybeNot, allValuesAreNotMaybe, allowValueOnceFilter, applyBestFit, applySplitStringTreeWithMultipleValues, applyToMultipleFields, approximateTimerEndDate, areEqualContext, areEqualPOJOValues, arrayContainsDuplicateValue, arrayContentsDiffer, arrayDecision, arrayDecisionFunction, arrayFactory, arrayInputFactory, arrayToLowercase, arrayToMap, arrayToObject, arrayToUppercase, asArray, asDecisionFunction, asGetter, asIndexRangeCheckFunctionConfig, asIterable, asMinuteOfDay, asNumber, asObjectCopyFactory, asPromise, asSet, assignValuesToPOJO, assignValuesToPOJOFunction, authClaims, authRoleClaimsService, authRolesSetHasRoles, baseWebsiteUrl, batch, batchCalc, bitwiseObjectDencoder, bitwiseObjectEncoder, bitwiseObjectdecoder, bitwiseSetDecoder, bitwiseSetDencoder, booleanFactory, booleanKeyArrayUtility, boundNumber, boundNumberFunction, boundToRectangle, build, cachedGetter, capLatValue, capitalizeFirstLetter, caseInsensitiveFilterByIndexOfDecisionFactory, caseInsensitiveString, catchAllHandlerKey, chainMapFunction, chainMapSameFunctions, coerceToEmailParticipants, combineMaps, compareEqualityWithValueFromItemsFunction, compareEqualityWithValueFromItemsFunctionFactory, compareFnOrder, compareWithMappedValuesFunction, computeNextFractionalHour, computeNextFreeIndexFunction, concatArrays, concatArraysUnique, containsAllStringsAnyCase, containsAllValues, containsAnyStringAnyCase, containsAnyValue, containsAnyValueFromSet, containsNoValueFromSet, containsNoneOfValue, containsStringAnyCase, convertEmailParticipantStringToParticipant, convertMaybeToArray, convertParticipantToEmailParticipantString, convertToArray, copyArray, copyField, copyLatLngBound, copyLatLngPoint, copyObject, copySetAndDo, countAllInNestedArray, countPOJOKeys, countPOJOKeysFunction, cronExpressionRepeatingEveryNMinutes, cssClassesSet, cutToPrecision, cutValueToInteger, cutValueToPrecision, cutValueToPrecisionFunction, dateFromLogicalDate, dateFromMinuteOfDay, dateToHoursAndMinutes, dateToMinuteOfDay, dayOfWeek, daysOfWeekArray, daysOfWeekFromEnabledDays, daysOfWeekNameFunction, daysOfWeekNameMap, decisionFunction, decodeHashedValues, decodeHashedValuesWithDecodeMap, decodeModelKeyTypePair, defaultFilterFromPOJOFunctionNoCopy, defaultForwardFunctionFactory, defaultLatLngPoint, defaultLatLngString, dencodeBitwiseSet, diffLatLngBoundPoints, diffLatLngPoints, dollarAmountString, e164PhoneNumberExtensionPair, e164PhoneNumberFromE164PhoneNumberExtensionPair, enabledDaysFromDaysOfWeek, encodeBitwiseSet, encodeModelKeyTypePair, errorMessageContainsString, errorMessageContainsStringFunction, escapeStringCharactersFunction, escapeStringForRegex, excludeValues, excludeValuesFromArray, excludeValuesFromSet, existsInIterable, expandArrayMapTuples, expandArrayValueTuples, expandFlattenTreeFunction, expandIndexSet, expandTreeFunction, expandTrees, extendLatLngBound, filterAndMapFunction, filterEmptyValues, filterFalsyAndEmptyValues, filterFromIterable, filterFromPOJO, filterFromPOJOFunction, filterKeyValueTupleFunction, filterKeyValueTuples, filterKeyValueTuplesFunction, filterKeyValueTuplesInputToFilter, filterMaybeValues, filterNullAndUndefinedValues, filterOnlyUndefinedValues, filterUndefinedValues, filterUniqueByIndex, filterUniqueCaseInsensitiveStrings, filterUniqueFunction, filterUniqueTransform, filterUniqueValues, filterValuesByDistance, filterValuesByDistanceNoOrder, filterValuesToSet, filterValuesUsingSet, filteredPage, findAllCharacterOccurences, findAllCharacterOccurencesFunction, findBest, findBestIndexMatch, findBestIndexMatchFunction, findBestIndexSetPair, findBestSplitStringTreeChildMatch, findBestSplitStringTreeChildMatchPath, findBestSplitStringTreeMatch, findBestSplitStringTreeMatchPath, findFirstCharacterOccurence, findInIterable, findIndexOfFirstDuplicateValue, findItemsByIndex, findNext, findPOJOKeys, findPOJOKeysFunction, findStringsRegexString, findToIndexSet, findValuesFrom, firstAndLastCharacterOccurrence, firstAndLastValue, firstValue, firstValueFromIterable, fitToIndexRangeFunction, fixExtraQueryParameters, fixMultiSlashesInSlashPath, flattenArray, flattenArrayOrValueArray, flattenArrayToSet, flattenArrayUnique, flattenArrayUniqueCaseInsensitiveStrings, flattenTree, flattenTreeToArray, flattenTreeToArrayFunction, flattenTrees, forEachInIterable, forEachKeyValue, forEachKeyValueOnPOJOFunction, forEachWithArray, forwardFunction, fractionalHoursToMinutes, generateIfDoesNotExist, getArrayNextIndex, getDayOffset, getDayTomorrow, getDayYesterday, getDaysOfWeekNames, getFunctionType, getNextDay, getNextPageNumber, getOverlappingRectangle, getPageNumber, getPreviousDay, getValueFromGetter, groupValues, handlerBindAccessor, handlerConfigurerFactory, handlerFactory, handlerMappedSetFunction, handlerMappedSetFunctionFactory, handlerSetFunction, hasDifferentStringsNoCase, hasDifferentValues, hasHttpPrefix, hasNonNullValue, hasPortNumber, hasSameTimezone, hasSameValues, hasValueFunction, hasValueOrNotEmpty, hasValueOrNotEmptyObject, hasWebsiteDomain, hasWebsiteTopLevelDomain, hashSetForIndexed, hourToFractionalHour, idBatchFactory, incrementingNumberFactory, indexDeltaGroup, indexDeltaGroupFunction, indexRange, indexRangeCheckFunction, indexRangeCheckReaderFunction, indexRangeForArray, indexRangeOverlapsIndexRange, indexRangeOverlapsIndexRangeFunction, indexRangeReaderPairFactory, indexRefMap, indexedValuesArrayAccessorFactory, insertIntoBooleanKeyArray, invertBooleanReturnFunction, invertDecision, invertFilter, isAllowed, isClassLikeType, isCompleteUnitedStatesAddress, isConsideredUtcTimezoneString, isDate, isDefaultLatLngPoint, isDefaultLatLngPointValue, isDefaultReadableError, isDefinedAndNotFalse, isDollarAmountString, isE164PhoneNumber, isE164PhoneNumberWithExtension, isEmptyIterable, isEqualContext, isEqualDate, isEqualToValueDecisionFunction, isEvenNumber, isFalseBooleanKeyArray, isFinalPage, isGetter, isISO8601DateString, isISO8601DayString, isISO8601DayStringStart, isInAllowedDaysOfWeekSet, isInNumberBoundFunction, isInSetDecisionFunction, isIndexNumberInIndexRange, isIndexNumberInIndexRangeFunction, isIndexRangeInIndexRange, isIndexRangeInIndexRangeFunction, isIterable, isKnownHttpWebsiteProtocol, isLatLngBound, isLatLngBoundWithinLatLngBound, isLatLngPoint, isLatLngPointWithinLatLngBound, isLatLngString, isLogicalDateStringCode, isMapIdentityFunction, isMaybeNot, isMaybeNotOrTrue, isMaybeSo, isMinuteOfDay, isModelKey, isMonthDaySlashDate, isNonClassFunction, isNotNullOrEmptyString, isNumberDivisibleBy, isObjectWithConstructor, isOddNumber, isPast, isPromise, isPromiseLike, isSameLatLngBound, isSameLatLngPoint, isSameNonNullValue, isSameVector, isSelectedDecisionFunctionFactory, isSelectedIndexDecisionFunction, isServerError, isSlashPathFile, isSlashPathFolder, isSlashPathTypedFile, isStandardInternetAccessibleWebsiteUrl, isStringOrTrue, isTrueBooleanKeyArray, isUTCDateString, isUniqueKeyedFunction, isUsStateCodeString, isValidLatLngPoint, isValidLatitude, isValidLongitude, isValidNumberBound, isValidPhoneExtensionNumber, isValidSlashPath, isWebsiteUrl, isWebsiteUrlWithPrefix, isWithinLatLngBoundFunction, isolateSlashPath, isolateSlashPathFunction, isolateWebsitePathFunction, itemCountForBatchIndex, iterableToArray, iterableToMap, iterableToSet, iterablesAreSetEquivalent, iterate, iterateFilteredPages, joinHostAndPort, joinStringsWithSpaces, keepCharactersAfterFirstCharacterOccurence, keepCharactersAfterFirstCharacterOccurenceFunction, keepFromSetCopy, keepValuesFromArray, keepValuesFromSet, keyValueMapFactory, labeledValueMap, lastValue, latLngBound, latLngBoundCenterPoint, latLngBoundEastBound, latLngBoundFromInput, latLngBoundFullyWrapsMap, latLngBoundFunction, latLngBoundNorthBound, latLngBoundNorthEastPoint, latLngBoundNorthWestPoint, latLngBoundOverlapsLatLngBound, latLngBoundSouthBound, latLngBoundSouthEastPoint, latLngBoundSouthWestPoint, latLngBoundStrictlyWrapsMap, latLngBoundTuple, latLngBoundTupleFunction, latLngBoundWestBound, latLngBoundWrapsMap, latLngDataPointFunction, latLngPoint, latLngPointFromString, latLngPointFunction, latLngPointPrecisionFunction, latLngString, latLngStringFunction, latLngTuple, latLngTupleFunction, limitArray, lonLatTuple, lowercaseFirstLetter, mailToUrlString, makeBestFit, makeCopyModelFieldFunction, makeDateMonthForMonthOfYear, makeGetter, makeHandler, makeHashDecodeMap, makeKeyPairs, makeModelConversionFieldValuesFunction, makeModelMap, makeModelMapFunctions, makeMultiModelKeyMap, makeValuesGroupMap, makeWithFactory, makeWithFactoryInput, mapArrayFunction, mapFunctionOutput, mapFunctionOutputPair, mapGetter, mapGetterFactory, mapIdentityFunction, mapIterable, mapKeysIntersectionObjectToArray, mapMaybeFunction, mapObjectMap, mapObjectMapFunction, mapObjectToTargetObject, mapPromiseOrValue, mapToObject, mapToTuples, mapValuesToSet, mappedUseAsyncFunction, mappedUseFunction, mapsHaveSameKeys, maybeMergeModelModifiers, maybeMergeModifiers, maybeModifierMapToFunction, maybeSet, mergeArrays, mergeArraysIntoArray, mergeFilterFunctions, mergeModifiers, mergeObjects, mergeObjectsFunction, mergeSlashPaths, messageFromError, minAndMaxFunction, minAndMaxIndex, minAndMaxIndexFunction, minAndMaxIndexItemsFunction, minAndMaxNumber, minutesToFractionalHours, minutesToHoursAndMinutes, modelFieldConversions, modelFieldMapFunction, modelFieldMapFunctions, modelTypeDataPairFactory, modifier, modifierMapToFunction, modifyModelMapFunction, modifyModelMapFunctions, monthDaySlashDateToDateString, monthOfYearFromDate, monthOfYearFromDateMonth, multiKeyValueMapFactory, multiValueMapBuilder, neMostLatLngPoint, nearestDivisibleValues, numberStringDencoder, numberStringDencoderDecodedNumberValueFunction, numberStringDencoderEncodedStringValueFunction, numberStringDencoderFunction, objectCopyFactory, objectDeltaArrayCompressor, objectFieldEqualityChecker, objectFlatMergeMatrix, objectHasKey, objectHasKeys, objectHasNoKeys, objectIsEmpty, objectKeyEqualityComparatorFunction, objectKeysEqualityComparatorFunction, objectMergeMatrix, objectToMap, objectToTuples, overlapsLatLngBoundFunction, overrideInObject, overrideInObjectFunctionFactory, padStartFunction, pairGroupValues, parseISO8601DayStringToUTCDate, partialServerError, passThrough, percentNumberFromDecimal, percentNumberToDecimal, performAsyncTask, performAsyncTasks, performBatchLoop, performMakeLoop, performTaskCountLoop, performTaskLoop, performTasksFromFactoryInParallelFunction, performTasksInParallel, performTasksInParallelFunction, pickOneRandomly, poll, primativeKeyDencoder, primativeKeyDencoderMap, primativeKeyStringDencoder, primativeValuesDelta, promiseReference, protectedFactory, pushArrayItemsIntoArray, pushElementOntoArray, pushItemOrArrayItemsIntoArray, randomArrayFactory, randomArrayIndex, randomBoolean, randomEmailFactory, randomFromArrayFactory, randomLatLngFactory, randomLatLngFromCenterFactory, randomNumber, randomNumberFactory, randomPhoneNumberFactory, randomPickFactory, range, rangedIndexedValuesArrayAccessorFactory, rangedIndexedValuesArrayAccessorInfoFactory, readBooleanKeySafetyWrap, readDomainFromEmailAddress, readDomainsFromEmailAddresses, readEmailDomainFromUrlOrEmailAddress, readIndexNumber, readKeysFrom, readKeysFromFilterUniqueFunctionAdditionalKeys, readKeysFromFilterUniqueFunctionAdditionalKeysInput, readKeysFunction, readKeysSetFrom, readKeysSetFunction, readKeysToMap, readModelKey, readModelKeyFromObject, readModelKeys, readModelKeysFromObjects, readMultipleKeysToMap, readPortNumber, readUniqueModelKey, readWebsiteProtocol, readableError, readableStreamToBase64, readableStreamToBuffer, readableStreamToStringFunction, rectangleOverlapsRectangle, reduceBooleansFn, reduceBooleansWithAnd, reduceBooleansWithAndFn, reduceBooleansWithOr, reduceBooleansWithOrFn, reduceNumbers, reduceNumbersFn, reduceNumbersWithAdd, reduceNumbersWithAddFn, reduceNumbersWithMax, reduceNumbersWithMaxFn, reduceNumbersWithMin, reduceNumbersWithMinFn, removeByKeyFromBooleanKeyArray, removeCharactersAfterFirstCharacterOccurence, removeCharactersAfterFirstCharacterOccurenceFunction, removeExtensionFromPhoneNumber, removeFromBooleanKeyArray, removeFromSet, removeFromSetCopy, removeHttpFromUrl, removeModelsWithKey, removeModelsWithSameKey, removeModifiers, removeTrailingFileTypeSeparators, removeTrailingSlashes, removeWebProtocolPrefix, repeatString, replaceCharacterAtIndexIf, replaceCharacterAtIndexWith, replaceInvalidFilePathTypeSeparatorsInSlashPath, replaceInvalidFilePathTypeSeparatorsInSlashPathFunction, replaceLastCharacterIf, replaceLastCharacterIfIsFunction, replaceMultipleFilePathsInSlashPath, replaceStringsFunction, requireModelKey, restoreOrder, restoreOrderWithValues, reverseCompareFn, roundNumberToStepFunction, roundNumberUpToStep, roundToPrecision, roundToPrecisionFunction, roundingFunction, runAsyncTaskForValue, runAsyncTasksForValues, safeCompareEquality, safeEqualityComparatorFunction, safeFindBestIndexMatch, searchStringFilterFunction, separateValues, separateValuesToSets, sequentialIncrementingNumberStringModelIdFactory, serverError, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, setDeltaChangeKeys, setDeltaFunction, setHasValueFunction, setIncludes, setIncludesFunction, setKeysOnMap, setWebProtocolPrefix, setsAreEquivalent, simpleSortValuesFunctionWithSortRef, slashPathFactory, slashPathInvalidError, slashPathName, slashPathParts, slashPathStartTypeFactory, slashPathType, slashPathValidationFactory, sliceIndexRangeFunction, sortAscendingIndexNumberRefFunction, sortByIndexAscendingCompareFunction, sortByIndexRangeAscendingCompareFunction, sortByLabelFunction, sortByNumberFunction, sortByStringFunction, sortCompareNumberFunction, sortNumbersAscendingFunction, sortValues, sortValuesFunctionOrMapIdentityWithSortRef, sortValuesFunctionWithSortRef, spaceSeparatedCssClasses, splitCommaSeparatedString, splitCommaSeparatedStringToSet, splitJoinNameString, splitJoinRemainder, splitStringAtFirstCharacterOccurence, splitStringAtFirstCharacterOccurenceFunction, splitStringAtIndex, splitStringTreeFactory, startOfDayForSystemDateInUTC, startOfDayForUTCDateInUTC, stepsFromIndex, stepsFromIndexFunction, stringCharactersToIndexRecord, stringContains, stringFactoryFromFactory, stringToLowercaseFunction, stringToUppercaseFunction, stringTrimFunction, sumOfIntegersBetween, swMostLatLngPoint, symmetricDifferenceArray, symmetricDifferenceArrayBetweenSets, symmetricDifferenceWithModels, takeFront, takeLast, takeValuesFromIterable, telUrlString, telUrlStringForE164PhoneNumberPair, terminatingFactoryFromArray, throwKeyIsRequired, timePeriodCounter, timer, toAbsoluteSlashPathStartType, toCaseInsensitiveStringArray, toMinuteOfDay, toModelFieldConversions, toModelMapFunctions, toReadableError, toRelativeSlashPathStartType, toggleInSet, toggleInSetCopy, toggleTimerRunning, transformNumberFunction, transformNumberFunctionConfig, transformStringFunction, transformStringFunctionConfig, transformStrings, trimArray, tryWithPromiseFactoriesFunction, typedServiceRegistry, unique, uniqueCaseInsensitiveStrings, uniqueCaseInsensitiveStringsSet, uniqueKeys, uniqueModels, unitedStatesAddressString, urlWithoutParameters, useAsync, useCallback, useContextFunction, useIterableOrValue, useModelOrKey, usePromise, useValue, validLatLngPoint, validLatLngPointFunction, valueAtIndex, valuesAreBothNullishOrEquivalent, valuesFromPOJO, valuesFromPOJOFunction, vectorMinimumSizeResizeFunction, vectorsAreEqual, waitForMs, websiteDomainAndPathPair, websiteDomainAndPathPairFromWebsiteUrl, websitePathAndQueryPair, websitePathFromWebsiteDomainAndPath, websitePathFromWebsiteUrl, websiteUrlFromPaths, wrapIndexRangeFunction, wrapLatLngPoint, wrapLngValue, wrapMapFunctionOutput, wrapNumberFunction, wrapTuples, wrapUseAsyncFunction, wrapUseFunction };
+export { ALL_DOUBLE_SLASHES_REGEX, ALL_SLASHES_REGEX, ALL_SLASH_PATH_FILE_TYPE_SEPARATORS_REGEX, ASSERTION_ERROR_CODE, ASSERTION_HANDLER, AUTH_ADMIN_ROLE, AUTH_ONBOARDED_ROLE, AUTH_ROLE_CLAIMS_DEFAULT_CLAIM_VALUE, AUTH_ROLE_CLAIMS_DEFAULT_EMPTY_VALUE, AUTH_TOS_SIGNED_ROLE, AUTH_USER_ROLE, AbstractUniqueModel, Assert, AssertMax, AssertMin, AssertionError, AssertionIssueHandler, BooleanStringKeyArrayUtility, BooleanStringKeyArrayUtilityInstance, CATCH_ALL_HANDLE_RESULT_KEY, CUT_VALUE_TO_ZERO_PRECISION, DATE_NOW_VALUE, DEFAULT_LAT_LNG_STRING_VALUE, DEFAULT_RANDOM_EMAIL_FACTORY_CONFIG, DEFAULT_RANDOM_PHONE_NUMBER_FACTORY_CONFIG, DEFAULT_READABLE_ERROR_CODE, DEFAULT_SLASH_PATH_ILLEGAL_CHARACTERS, DEFAULT_SLASH_PATH_ILLEGAL_CHARACTER_REPLACEMENT, DEFAULT_UNKNOWN_MODEL_TYPE_STRING, DOLLAR_AMOUNT_PRECISION, DOLLAR_AMOUNT_STRING_REGEX, DataDoesNotExistError, DataIsExpiredError, Day, DestroyFunctionObject, E164PHONE_NUMBER_REGEX, E164PHONE_NUMBER_WITH_EXTENSION_REGEX, E164PHONE_NUMBER_WITH_OPTIONAL_EXTENSION_REGEX, FINAL_PAGE, FIRST_PAGE, FRACTIONAL_HOURS_PRECISION_FUNCTION, FullStorageObject, HAS_PORT_NUMBER_REGEX, HAS_WEBSITE_DOMAIN_NAME_REGEX, HOURS_IN_DAY, HTTP_OR_HTTPS_REGEX, HashSet, ISO8601_DAY_STRING_REGEX, ISO8601_DAY_STRING_START_REGEX, ISO_8601_DATE_STRING_REGEX, KeyValueTypleValueFilter, LAT_LNG_PATTERN, LAT_LNG_PATTERN_MAX_PRECISION, LAT_LONG_100KM_PRECISION, LAT_LONG_100M_PRECISION, LAT_LONG_10CM_PRECISION, LAT_LONG_10KM_PRECISION, LAT_LONG_10M_PRECISION, LAT_LONG_1CM_PRECISION, LAT_LONG_1KM_PRECISION, LAT_LONG_1MM_PRECISION, LAT_LONG_1M_PRECISION, LAT_LONG_GRAINS_OF_SAND_PRECISION, LEADING_SLASHES_REGEX, MAP_IDENTITY, MAX_BITWISE_SET_SIZE, MAX_LATITUDE_VALUE, MAX_LONGITUDE_VALUE, MINUTES_IN_DAY, MINUTES_IN_HOUR, MINUTE_OF_DAY_MAXMIMUM, MINUTE_OF_DAY_MINIUMUM, MIN_LATITUDE_VALUE, MIN_LONGITUDE_VALUE, MONTH_DAY_SLASH_DATE_STRING_REGEX, MS_IN_DAY, MS_IN_HOUR, MS_IN_MINUTE, MS_IN_SECOND, MemoryStorageInstance, ModelRelationUtility, NOOP_MODIFIER, NUMBER_STRING_DENCODER_64, NUMBER_STRING_DENCODER_64_DEFAULT_NEGATIVE_PREFIX, NUMBER_STRING_DENCODER_64_DIGITS, PHONE_EXTENSION_NUMBER_REGEX, PRIMATIVE_KEY_DENCODER_VALUE, PageCalculator, PropertyDescriptorUtility, REGEX_SPECIAL_CHARACTERS, REGEX_SPECIAL_CHARACTERS_SET, RelationChange, SECONDS_IN_MINUTE, SHARED_MEMORY_STORAGE, SLASH_PATH_FILE_TYPE_SEPARATOR, SLASH_PATH_SEPARATOR, SORT_VALUE_EQUAL, SORT_VALUE_GREATER_THAN, SORT_VALUE_LESS_THAN, SPLIT_STRING_TREE_NODE_ROOT_VALUE, ServerErrorResponse, SetDeltaChange, SimpleStorageObject, StorageObject, StorageObjectUtility, StoredDataError, SyncState, TOTAL_LATITUDE_RANGE, TOTAL_LONGITUDE_RANGE, TOTAL_SPAN_OF_LONGITUDE, TRAILING_FILE_TYPE_SEPARATORS_REGEX, TRAILING_SLASHES_REGEX, TimeAM, TimerCancelledError, TimerInstance, TypedServiceRegistryInstance, UNLOADED_PAGE, US_STATE_CODE_STRING_REGEX, UTC_DATE_STRING_REGEX, UTC_TIMEZONE_STRING, UTF_8_START_CHARACTER, UTF_PRIVATE_USAGE_AREA_START, UnauthorizedServerErrorResponse, WEBSITE_TLD_DETECTION_REGEX, WEB_PROTOCOL_PREFIX_REGEX, ZIP_CODE_STRING_REGEX, addHttpToUrl, addLatLngPoints, addModifiers, addPlusPrefixToNumber, addPrefix, addPrefixFunction, addSuffix, addSuffixFunction, addToSet, addToSetCopy, addToSplitStringTree, allFalsyOrEmptyKeys, allIndexesInIndexRange, allKeyValueTuples, allMaybeSoKeys, allNonUndefinedKeys, allObjectsAreEqual, allValuesAreMaybeNot, allValuesAreNotMaybe, allowValueOnceFilter, applyBestFit, applySplitStringTreeWithMultipleValues, applyToMultipleFields, approximateTimerEndDate, areEqualContext, areEqualPOJOValues, arrayContainsDuplicateValue, arrayContentsDiffer, arrayDecision, arrayDecisionFunction, arrayFactory, arrayInputFactory, arrayToLowercase, arrayToMap, arrayToObject, arrayToUppercase, asArray, asDecisionFunction, asGetter, asIndexRangeCheckFunctionConfig, asIterable, asMinuteOfDay, asNumber, asObjectCopyFactory, asPromise, asSet, assignValuesToPOJO, assignValuesToPOJOFunction, authClaims, authRoleClaimsService, authRolesSetHasRoles, baseWebsiteUrl, batch, batchCalc, bitwiseObjectDencoder, bitwiseObjectEncoder, bitwiseObjectdecoder, bitwiseSetDecoder, bitwiseSetDencoder, booleanFactory, booleanKeyArrayUtility, boundNumber, boundNumberFunction, boundToRectangle, build, cachedGetter, capLatValue, capitalizeFirstLetter, caseInsensitiveFilterByIndexOfDecisionFactory, caseInsensitiveString, catchAllHandlerKey, chainMapFunction, chainMapSameFunctions, coerceToEmailParticipants, combineMaps, compareEqualityWithValueFromItemsFunction, compareEqualityWithValueFromItemsFunctionFactory, compareFnOrder, compareWithMappedValuesFunction, computeNextFractionalHour, computeNextFreeIndexFunction, concatArrays, concatArraysUnique, containsAllStringsAnyCase, containsAllValues, containsAnyStringAnyCase, containsAnyValue, containsAnyValueFromSet, containsNoValueFromSet, containsNoneOfValue, containsStringAnyCase, convertEmailParticipantStringToParticipant, convertMaybeToArray, convertParticipantToEmailParticipantString, convertToArray, copyArray, copyField, copyLatLngBound, copyLatLngPoint, copyObject, copySetAndDo, countAllInNestedArray, countPOJOKeys, countPOJOKeysFunction, cronExpressionRepeatingEveryNMinutes, cssClassesSet, cutToPrecision, cutValueToInteger, cutValueToPrecision, cutValueToPrecisionFunction, dateFromLogicalDate, dateFromMinuteOfDay, dateToHoursAndMinutes, dateToMinuteOfDay, dayOfWeek, daysOfWeekArray, daysOfWeekFromEnabledDays, daysOfWeekNameFunction, daysOfWeekNameMap, decisionFunction, decodeHashedValues, decodeHashedValuesWithDecodeMap, decodeModelKeyTypePair, defaultFilterFromPOJOFunctionNoCopy, defaultForwardFunctionFactory, defaultLatLngPoint, defaultLatLngString, dencodeBitwiseSet, diffLatLngBoundPoints, diffLatLngPoints, dollarAmountString, e164PhoneNumberExtensionPair, e164PhoneNumberFromE164PhoneNumberExtensionPair, enabledDaysFromDaysOfWeek, encodeBitwiseSet, encodeModelKeyTypePair, errorMessageContainsString, errorMessageContainsStringFunction, escapeStringCharactersFunction, escapeStringForRegex, excludeValues, excludeValuesFromArray, excludeValuesFromSet, existsInIterable, expandArrayMapTuples, expandArrayValueTuples, expandFlattenTreeFunction, expandIndexSet, expandTreeFunction, expandTrees, exponentialPromiseRateLimiter, extendLatLngBound, filterAndMapFunction, filterEmptyValues, filterFalsyAndEmptyValues, filterFromIterable, filterFromPOJO, filterFromPOJOFunction, filterKeyValueTupleFunction, filterKeyValueTuples, filterKeyValueTuplesFunction, filterKeyValueTuplesInputToFilter, filterMaybeValues, filterNullAndUndefinedValues, filterOnlyUndefinedValues, filterUndefinedValues, filterUniqueByIndex, filterUniqueCaseInsensitiveStrings, filterUniqueFunction, filterUniqueTransform, filterUniqueValues, filterValuesByDistance, filterValuesByDistanceNoOrder, filterValuesToSet, filterValuesUsingSet, filteredPage, findAllCharacterOccurences, findAllCharacterOccurencesFunction, findBest, findBestIndexMatch, findBestIndexMatchFunction, findBestIndexSetPair, findBestSplitStringTreeChildMatch, findBestSplitStringTreeChildMatchPath, findBestSplitStringTreeMatch, findBestSplitStringTreeMatchPath, findFirstCharacterOccurence, findInIterable, findIndexOfFirstDuplicateValue, findItemsByIndex, findNext, findPOJOKeys, findPOJOKeysFunction, findStringsRegexString, findToIndexSet, findValuesFrom, firstAndLastCharacterOccurrence, firstAndLastValue, firstValue, firstValueFromIterable, fitToIndexRangeFunction, fixExtraQueryParameters, fixMultiSlashesInSlashPath, flattenArray, flattenArrayOrValueArray, flattenArrayToSet, flattenArrayUnique, flattenArrayUniqueCaseInsensitiveStrings, flattenTree, flattenTreeToArray, flattenTreeToArrayFunction, flattenTrees, forEachInIterable, forEachKeyValue, forEachKeyValueOnPOJOFunction, forEachWithArray, forwardFunction, fractionalHoursToMinutes, generateIfDoesNotExist, getArrayNextIndex, getBaseLog, getDayOffset, getDayTomorrow, getDayYesterday, getDaysOfWeekNames, getFunctionType, getNextDay, getNextPageNumber, getOverlappingRectangle, getPageNumber, getPreviousDay, getValueFromGetter, groupValues, handlerBindAccessor, handlerConfigurerFactory, handlerFactory, handlerMappedSetFunction, handlerMappedSetFunctionFactory, handlerSetFunction, hasDifferentStringsNoCase, hasDifferentValues, hasHttpPrefix, hasNonNullValue, hasPortNumber, hasSameTimezone, hasSameValues, hasValueFunction, hasValueOrNotEmpty, hasValueOrNotEmptyObject, hasWebsiteDomain, hasWebsiteTopLevelDomain, hashSetForIndexed, hourToFractionalHour, idBatchFactory, incrementingNumberFactory, indexDeltaGroup, indexDeltaGroupFunction, indexRange, indexRangeCheckFunction, indexRangeCheckReaderFunction, indexRangeForArray, indexRangeOverlapsIndexRange, indexRangeOverlapsIndexRangeFunction, indexRangeReaderPairFactory, indexRefMap, indexedValuesArrayAccessorFactory, insertIntoBooleanKeyArray, invertBooleanReturnFunction, invertDecision, invertFilter, isAllowed, isClassLikeType, isCompleteUnitedStatesAddress, isConsideredUtcTimezoneString, isDate, isDefaultLatLngPoint, isDefaultLatLngPointValue, isDefaultReadableError, isDefinedAndNotFalse, isDollarAmountString, isE164PhoneNumber, isE164PhoneNumberWithExtension, isEmptyIterable, isEqualContext, isEqualDate, isEqualToValueDecisionFunction, isEvenNumber, isFalseBooleanKeyArray, isFinalPage, isGetter, isISO8601DateString, isISO8601DayString, isISO8601DayStringStart, isInAllowedDaysOfWeekSet, isInNumberBoundFunction, isInSetDecisionFunction, isIndexNumberInIndexRange, isIndexNumberInIndexRangeFunction, isIndexRangeInIndexRange, isIndexRangeInIndexRangeFunction, isIterable, isKnownHttpWebsiteProtocol, isLatLngBound, isLatLngBoundWithinLatLngBound, isLatLngPoint, isLatLngPointWithinLatLngBound, isLatLngString, isLogicalDateStringCode, isMapIdentityFunction, isMaybeNot, isMaybeNotOrTrue, isMaybeSo, isMinuteOfDay, isModelKey, isMonthDaySlashDate, isNonClassFunction, isNotNullOrEmptyString, isNumberDivisibleBy, isObjectWithConstructor, isOddNumber, isPast, isPromise, isPromiseLike, isSameLatLngBound, isSameLatLngPoint, isSameNonNullValue, isSameVector, isSelectedDecisionFunctionFactory, isSelectedIndexDecisionFunction, isServerError, isSlashPathFile, isSlashPathFolder, isSlashPathTypedFile, isStandardInternetAccessibleWebsiteUrl, isStringOrTrue, isTrueBooleanKeyArray, isUTCDateString, isUniqueKeyedFunction, isUsStateCodeString, isValidLatLngPoint, isValidLatitude, isValidLongitude, isValidNumberBound, isValidPhoneExtensionNumber, isValidSlashPath, isWebsiteUrl, isWebsiteUrlWithPrefix, isWithinLatLngBoundFunction, isolateSlashPath, isolateSlashPathFunction, isolateWebsitePathFunction, itemCountForBatchIndex, iterableToArray, iterableToMap, iterableToSet, iterablesAreSetEquivalent, iterate, iterateFilteredPages, joinHostAndPort, joinStringsWithSpaces, keepCharactersAfterFirstCharacterOccurence, keepCharactersAfterFirstCharacterOccurenceFunction, keepFromSetCopy, keepValuesFromArray, keepValuesFromSet, keyValueMapFactory, labeledValueMap, lastValue, latLngBound, latLngBoundCenterPoint, latLngBoundEastBound, latLngBoundFromInput, latLngBoundFullyWrapsMap, latLngBoundFunction, latLngBoundNorthBound, latLngBoundNorthEastPoint, latLngBoundNorthWestPoint, latLngBoundOverlapsLatLngBound, latLngBoundSouthBound, latLngBoundSouthEastPoint, latLngBoundSouthWestPoint, latLngBoundStrictlyWrapsMap, latLngBoundTuple, latLngBoundTupleFunction, latLngBoundWestBound, latLngBoundWrapsMap, latLngDataPointFunction, latLngPoint, latLngPointFromString, latLngPointFunction, latLngPointPrecisionFunction, latLngString, latLngStringFunction, latLngTuple, latLngTupleFunction, limitArray, lonLatTuple, lowercaseFirstLetter, mailToUrlString, makeBestFit, makeCopyModelFieldFunction, makeDateMonthForMonthOfYear, makeGetter, makeHandler, makeHashDecodeMap, makeKeyPairs, makeModelConversionFieldValuesFunction, makeModelMap, makeModelMapFunctions, makeMultiModelKeyMap, makeValuesGroupMap, makeWithFactory, makeWithFactoryInput, mapArrayFunction, mapFunctionOutput, mapFunctionOutputPair, mapGetter, mapGetterFactory, mapIdentityFunction, mapIterable, mapKeysIntersectionObjectToArray, mapMaybeFunction, mapObjectMap, mapObjectMapFunction, mapObjectToTargetObject, mapPromiseOrValue, mapToObject, mapToTuples, mapValuesToSet, mappedUseAsyncFunction, mappedUseFunction, mapsHaveSameKeys, maybeMergeModelModifiers, maybeMergeModifiers, maybeModifierMapToFunction, maybeSet, mergeArrays, mergeArraysIntoArray, mergeFilterFunctions, mergeModifiers, mergeObjects, mergeObjectsFunction, mergeSlashPaths, messageFromError, minAndMaxFunction, minAndMaxIndex, minAndMaxIndexFunction, minAndMaxIndexItemsFunction, minAndMaxNumber, minutesToFractionalHours, minutesToHoursAndMinutes, modelFieldConversions, modelFieldMapFunction, modelFieldMapFunctions, modelTypeDataPairFactory, modifier, modifierMapToFunction, modifyModelMapFunction, modifyModelMapFunctions, monthDaySlashDateToDateString, monthOfYearFromDate, monthOfYearFromDateMonth, multiKeyValueMapFactory, multiValueMapBuilder, neMostLatLngPoint, nearestDivisibleValues, numberStringDencoder, numberStringDencoderDecodedNumberValueFunction, numberStringDencoderEncodedStringValueFunction, numberStringDencoderFunction, objectCopyFactory, objectDeltaArrayCompressor, objectFieldEqualityChecker, objectFlatMergeMatrix, objectHasKey, objectHasKeys, objectHasNoKeys, objectIsEmpty, objectKeyEqualityComparatorFunction, objectKeysEqualityComparatorFunction, objectMergeMatrix, objectToMap, objectToTuples, overlapsLatLngBoundFunction, overrideInObject, overrideInObjectFunctionFactory, padStartFunction, pairGroupValues, parseISO8601DayStringToUTCDate, partialServerError, passThrough, percentNumberFromDecimal, percentNumberToDecimal, performAsyncTask, performAsyncTasks, performBatchLoop, performMakeLoop, performTaskCountLoop, performTaskLoop, performTasksFromFactoryInParallelFunction, performTasksInParallel, performTasksInParallelFunction, pickOneRandomly, poll, primativeKeyDencoder, primativeKeyDencoderMap, primativeKeyStringDencoder, primativeValuesDelta, promiseReference, protectedFactory, pushArrayItemsIntoArray, pushElementOntoArray, pushItemOrArrayItemsIntoArray, randomArrayFactory, randomArrayIndex, randomBoolean, randomEmailFactory, randomFromArrayFactory, randomLatLngFactory, randomLatLngFromCenterFactory, randomNumber, randomNumberFactory, randomPhoneNumberFactory, randomPickFactory, range, rangedIndexedValuesArrayAccessorFactory, rangedIndexedValuesArrayAccessorInfoFactory, readBooleanKeySafetyWrap, readDomainFromEmailAddress, readDomainsFromEmailAddresses, readEmailDomainFromUrlOrEmailAddress, readIndexNumber, readKeysFrom, readKeysFromFilterUniqueFunctionAdditionalKeys, readKeysFromFilterUniqueFunctionAdditionalKeysInput, readKeysFunction, readKeysSetFrom, readKeysSetFunction, readKeysToMap, readModelKey, readModelKeyFromObject, readModelKeys, readModelKeysFromObjects, readMultipleKeysToMap, readPortNumber, readUniqueModelKey, readWebsiteProtocol, readableError, readableStreamToBase64, readableStreamToBuffer, readableStreamToStringFunction, rectangleOverlapsRectangle, reduceBooleansFn, reduceBooleansWithAnd, reduceBooleansWithAndFn, reduceBooleansWithOr, reduceBooleansWithOrFn, reduceNumbers, reduceNumbersFn, reduceNumbersWithAdd, reduceNumbersWithAddFn, reduceNumbersWithMax, reduceNumbersWithMaxFn, reduceNumbersWithMin, reduceNumbersWithMinFn, removeByKeyFromBooleanKeyArray, removeCharactersAfterFirstCharacterOccurence, removeCharactersAfterFirstCharacterOccurenceFunction, removeExtensionFromPhoneNumber, removeFromBooleanKeyArray, removeFromSet, removeFromSetCopy, removeHttpFromUrl, removeModelsWithKey, removeModelsWithSameKey, removeModifiers, removeTrailingFileTypeSeparators, removeTrailingSlashes, removeWebProtocolPrefix, repeatString, replaceCharacterAtIndexIf, replaceCharacterAtIndexWith, replaceInvalidFilePathTypeSeparatorsInSlashPath, replaceInvalidFilePathTypeSeparatorsInSlashPathFunction, replaceLastCharacterIf, replaceLastCharacterIfIsFunction, replaceMultipleFilePathsInSlashPath, replaceStringsFunction, requireModelKey, resetPeriodPromiseRateLimiter, restoreOrder, restoreOrderWithValues, reverseCompareFn, roundNumberToStepFunction, roundNumberUpToStep, roundToPrecision, roundToPrecisionFunction, roundingFunction, runAsyncTaskForValue, runAsyncTasksForValues, safeCompareEquality, safeEqualityComparatorFunction, safeFindBestIndexMatch, searchStringFilterFunction, separateValues, separateValuesToSets, sequentialIncrementingNumberStringModelIdFactory, serverError, setContainsAllValues, setContainsAnyValue, setContainsNoneOfValue, setDeltaChangeKeys, setDeltaFunction, setHasValueFunction, setIncludes, setIncludesFunction, setKeysOnMap, setWebProtocolPrefix, setsAreEquivalent, simpleSortValuesFunctionWithSortRef, slashPathFactory, slashPathInvalidError, slashPathName, slashPathParts, slashPathStartTypeFactory, slashPathType, slashPathValidationFactory, sliceIndexRangeFunction, sortAscendingIndexNumberRefFunction, sortByIndexAscendingCompareFunction, sortByIndexRangeAscendingCompareFunction, sortByLabelFunction, sortByNumberFunction, sortByStringFunction, sortCompareNumberFunction, sortNumbersAscendingFunction, sortValues, sortValuesFunctionOrMapIdentityWithSortRef, sortValuesFunctionWithSortRef, spaceSeparatedCssClasses, splitCommaSeparatedString, splitCommaSeparatedStringToSet, splitJoinNameString, splitJoinRemainder, splitStringAtFirstCharacterOccurence, splitStringAtFirstCharacterOccurenceFunction, splitStringAtIndex, splitStringTreeFactory, startOfDayForSystemDateInUTC, startOfDayForUTCDateInUTC, stepsFromIndex, stepsFromIndexFunction, stringCharactersToIndexRecord, stringContains, stringFactoryFromFactory, stringToLowercaseFunction, stringToUppercaseFunction, stringTrimFunction, sumOfIntegersBetween, swMostLatLngPoint, symmetricDifferenceArray, symmetricDifferenceArrayBetweenSets, symmetricDifferenceWithModels, takeFront, takeLast, takeValuesFromIterable, telUrlString, telUrlStringForE164PhoneNumberPair, terminatingFactoryFromArray, throwKeyIsRequired, timePeriodCounter, timer, toAbsoluteSlashPathStartType, toCaseInsensitiveStringArray, toMinuteOfDay, toModelFieldConversions, toModelMapFunctions, toReadableError, toRelativeSlashPathStartType, toggleInSet, toggleInSetCopy, toggleTimerRunning, transformNumberFunction, transformNumberFunctionConfig, transformStringFunction, transformStringFunctionConfig, transformStrings, trimArray, tryWithPromiseFactoriesFunction, typedServiceRegistry, unique, uniqueCaseInsensitiveStrings, uniqueCaseInsensitiveStringsSet, uniqueKeys, uniqueModels, unitedStatesAddressString, urlWithoutParameters, useAsync, useCallback, useContextFunction, useIterableOrValue, useModelOrKey, usePromise, useValue, validLatLngPoint, validLatLngPointFunction, valueAtIndex, valuesAreBothNullishOrEquivalent, valuesFromPOJO, valuesFromPOJOFunction, vectorMinimumSizeResizeFunction, vectorsAreEqual, waitForMs, websiteDomainAndPathPair, websiteDomainAndPathPairFromWebsiteUrl, websitePathAndQueryPair, websitePathFromWebsiteDomainAndPath, websitePathFromWebsiteUrl, websiteUrlFromPaths, wrapIndexRangeFunction, wrapLatLngPoint, wrapLngValue, wrapMapFunctionOutput, wrapNumberFunction, wrapTuples, wrapUseAsyncFunction, wrapUseFunction };

package/package.json

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

package/src/lib/number/number.d.ts

@@ -85,3 +85,15 @@ export declare const sortCompareNumberFunction: SortCompareFunction<number>;
  * @returns
  */
 export declare function minAndMaxNumber(values: Iterable<number>): MinAndMaxFunctionResult<number>;
+/**
+ * Returns the lorgathirm of y with base x.
+ *
+ * Example:
+ * - (log2(16)): x = 2, y = 16 -> 4    (2^4 = 16)
+ * - (log10(100)): x = 10, y = 100 -> 2   (10^2 = 100)
+ *
+ * @param x
+ * @param y
+ * @returns
+ */
+export declare function getBaseLog(x: number, y: number): number;

package/src/lib/promise/index.d.ts

@@ -3,6 +3,7 @@ export * from './is';
 export * from './poll';
 export * from './map';
 export * from './promise';
+export * from './promise.limit';
 export * from './promise.loop';
 export * from './promise.ref';
 export * from './promise.factory';

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

@@ -0,0 +1,125 @@
+import { type Milliseconds } from '../date/date';
+import { type Maybe } from '../value/maybe.type';
+/**
+ * Interface for a rate limiter.
+ */
+export interface PromiseRateLimiter {
+    /**
+     * Returns the expected wait time for the next wait.
+     *
+     * Can optionally provide an increase that updates the limiter to behave like the number of items is now being waited on.
+     */
+    getNextWaitTime(increase?: number): Milliseconds;
+    /**
+     * Waits for the rate limited to allow the promise to continue.
+     */
+    waitForRateLimit(): Promise<void>;
+}
+/**
+ * Interface for a PromiseRateLimiter that can be enabled or disabled.
+ */
+export interface EnableTogglePromiseRateLimiter extends PromiseRateLimiter {
+    /**
+     * Returns true if the rate limiter is enabled or not.
+     */
+    getEnabled(): boolean;
+    /**
+     * Enables or disables the rate limiter based on the inputs.
+     *
+     * @param enable
+     */
+    setEnabled(enable: boolean): void;
+}
+export interface ExponentialPromiseRateLimiterConfig {
+    /**
+     * How fast the cooldown occurs.
+     *
+     * Defaults to 1.
+     */
+    readonly cooldownRate?: number;
+    /**
+     * The maximum amount of wait time to limit exponential requests to, if applicable.
+     *
+     * Defaults to 1 hour.
+     */
+    readonly maxWaitTime?: Milliseconds;
+    /**
+     * The base exponent of the growth.
+     *
+     * Defaults to 2.
+     */
+    readonly exponentRate?: number;
+}
+export type FullExponentialPromiseRateLimiterConfig = Required<ExponentialPromiseRateLimiterConfig>;
+export interface ExponentialPromiseRateLimiter extends EnableTogglePromiseRateLimiter {
+    /**
+     * Returns the current config.
+     */
+    getConfig(): FullExponentialPromiseRateLimiterConfig;
+    /**
+     * Updates the configuration.
+     */
+    setConfig(config: Partial<ExponentialPromiseRateLimiterConfig>, andReset?: boolean): void;
+    /**
+     * Manually resets the limit
+     */
+    reset(): void;
+}
+export declare function exponentialPromiseRateLimiter(initialConfig?: Maybe<ExponentialPromiseRateLimiterConfig>): ExponentialPromiseRateLimiter;
+export interface ResetPeriodPromiseRateLimiterConfig extends Partial<ExponentialPromiseRateLimiterConfig> {
+    /**
+     * The number of times the rate limiter can be used before it needs to be reset.
+     */
+    readonly limit: number;
+    /**
+     * Optional specific Date/Time at which to reset the remaining count back to the limit.
+     */
+    readonly resetAt?: Maybe<Date>;
+    /**
+     * Amount of time in milliseconds to set the next resetAt time when reset is called.
+     */
+    readonly resetPeriod: Milliseconds;
+}
+/**
+ * A rate limiter that resets every specific period of time and has a limited amount of items that can go out.
+ */
+export interface ResetPeriodPromiseRateLimiter extends EnableTogglePromiseRateLimiter {
+    /**
+     * Returns the current limit details with the amount remaining.
+     */
+    getRemainingLimit(): number;
+    /**
+     * Sets the remaining limit number.
+     *
+     * @param limit
+     */
+    setRemainingLimit(limit: number): void;
+    /**
+     * Returns the number of milliseconds until the next reset.
+     */
+    getTimeUntilNextReset(): Milliseconds;
+    /**
+     * Returns the next reset at date/time.
+     */
+    getResetAt(): Date;
+    /**
+     * Sets the next reset at Date.
+     */
+    setNextResetAt(date: Date): void;
+    /**
+     * Sets the new config.
+     *
+     * @param limit
+     */
+    setConfig(config: Partial<ResetPeriodPromiseRateLimiterConfig>, andReset?: boolean): void;
+    /**
+     * Manually resets the "remaining" amount on the limit back to the limit amount.
+     */
+    reset(): void;
+}
+/**
+ * Creates a ResetPeriodPromiseRateLimiter.
+ *
+ * @param limit
+ */
+export declare function resetPeriodPromiseRateLimiter(initialConfig: ResetPeriodPromiseRateLimiterConfig): ResetPeriodPromiseRateLimiter;

package/test/CHANGELOG.md

@@ -2,7 +2,11 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
-## [11.0.11](https://github.com/dereekb/dbx-components/compare/v11.0.10-dev...v11.0.11) (2024-11-24)
+## [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/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util/test",
-  "version": "11.0.11",
+  "version": "11.0.13",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*"