@dereekb/util 13.11.13 → 13.11.15

package/fetch/index.cjs.js

@@ -117,8 +117,8 @@ var FetchResponseError = /*#__PURE__*/ function(BaseError) {
 /**
  * Asserts that the fetch response has an ok status code, throwing a FetchResponseError if it does not.
  *
- * @param responsePromise - promise resolving to the fetch Response to validate
- * @returns a promise resolving to the Response if the status is ok
+ * @param responsePromise - Pending fetch result whose status must be validated.
+ * @returns Same response when the status is ok; otherwise the rejected error.
  */ function requireOkResponse(responsePromise) {
     return responsePromise.then(function(response) {
         if (!response.ok) {
@@ -253,8 +253,8 @@ var FetchTimeoutError = /*#__PURE__*/ function(BaseError) {
  * is present on the RequestInit or Request and no abort signal is already provided,
  * an AbortController is created to abort the request after the specified duration.
  *
- * @param inputFetch - the fetch function to wrap with timeout behavior
- * @returns a wrapped fetch function that enforces timeouts via AbortController
+ * @param inputFetch - The fetch function to wrap with timeout behavior.
+ * @returns A wrapped fetch function that enforces timeouts via AbortController.
  */ function fetchTimeout(inputFetch) {
     return function(input, init) {
         var _ref;
@@ -268,7 +268,7 @@ var FetchTimeoutError = /*#__PURE__*/ function(BaseError) {
                 signal: abortController.signal // pass the abort signal
             });
         }
-        var responsePromise = inputFetch(input, init);
+        var responsePromise = inputFetch(input, init !== null && init !== void 0 ? init : undefined);
         if (timeout) {
             var timeoutId = setTimeout(function() {
                 controller === null || controller === void 0 ? void 0 : controller.abort();
@@ -540,7 +540,7 @@ function _ts_generator$4(thisArg, body) {
     };
 }
 /**
- * Default FetchHabdler
+ * Default FetchHabdler.
  *
  * @param request
  * @param makeFetch
@@ -597,14 +597,14 @@ function _ts_generator$4(thisArg, body) {
  * @param init
  * @returns
  */ var DEFAULT_FETCH_REQUEST_FACTORY = function DEFAULT_FETCH_REQUEST_FACTORY(input, init) {
-    return new Request(input, init);
+    return new Request(input, init !== null && init !== void 0 ? init : undefined);
 };
 /**
  * Creates a FetchRequestFactory that builds Request objects by applying base URL resolution,
  * base request init merging, timeout configuration, and custom request init transformations.
  *
- * @param config - configuration for URL resolution, base request defaults, timeout, and request init transformations
- * @returns a FetchRequestFactory that produces fully configured Request objects
+ * @param config - Configuration for URL resolution, base request defaults, timeout, and request init transformations.
+ * @returns A FetchRequestFactory that produces fully configured Request objects.
  */ function fetchRequestFactory(config) {
     var _config_makeRequest = config.makeRequest, makeRequest = _config_makeRequest === void 0 ? DEFAULT_FETCH_REQUEST_FACTORY : _config_makeRequest, inputBaseUrl = config.baseUrl, inputBaseRequest = config.baseRequest, timeout = config.timeout, requestInitFactory = config.requestInitFactory, _config_useBaseUrlForConfiguredFetchRequests = config.useBaseUrlForConfiguredFetchRequests, useBaseUrlForConfiguredFetchRequests = _config_useBaseUrlForConfiguredFetchRequests === void 0 ? false : _config_useBaseUrlForConfiguredFetchRequests, _config_forceBaseUrlForWebsiteUrlWithPrefix = config.forceBaseUrlForWebsiteUrlWithPrefix, forceBaseUrlForWebsiteUrlWithPrefix = _config_forceBaseUrlForWebsiteUrlWithPrefix === void 0 ? useBaseUrlForConfiguredFetchRequests : _config_forceBaseUrlForWebsiteUrlWithPrefix;
     var baseUrl = inputBaseUrl ? new URL(util.removeTrailingSlashes(inputBaseUrl)) : undefined;
@@ -808,7 +808,7 @@ function _ts_generator$4(thisArg, body) {
                         fixedRequest = _state.sent();
                         return [
                             4,
-                            buildRequestInit(fixedRequest, init)
+                            buildRequestInit(fixedRequest, init !== null && init !== void 0 ? init : undefined)
                         ];
                     case 2:
                         init = _state.sent();
@@ -843,9 +843,9 @@ function _ts_generator$4(thisArg, body) {
  * Merges two RequestInit objects, combining their headers and spreading remaining properties
  * so that values from the second init override the base.
  *
- * @param base - the base RequestInit to merge onto
- * @param requestInit - optional RequestInit whose values override the base
- * @returns the merged RequestInit
+ * @param base - The base RequestInit to merge onto.
+ * @param requestInit - Optional RequestInit whose values override the base.
+ * @returns The merged RequestInit.
  */ function mergeRequestInits(base, requestInit) {
     var result;
     if (requestInit) {
@@ -865,8 +865,8 @@ function _ts_generator$4(thisArg, body) {
  * Merges an array of HeadersInit values into a single array of key-value tuples.
  * Later headers override earlier ones on a per-key basis while preserving multi-value support.
  *
- * @param inputHeadersArray - array of HeadersInit values to merge, where later entries take precedence
- * @returns an array of [key, value] tuples representing the merged headers
+ * @param inputHeadersArray - Header sources to combine; later entries override earlier ones per header name.
+ * @returns Combined [key, value] tuples representing the merged headers in iteration order.
  */ function mergeRequestHeaders(inputHeadersArray) {
     var headersMap = util.multiValueMapBuilder();
     util.filterMaybeArrayValues(inputHeadersArray).forEach(function(headers) {
@@ -889,8 +889,8 @@ function _ts_generator$4(thisArg, body) {
  * Converts a HeadersInit value (tuple array, Headers object, or plain object) into
  * a normalized array of [key, value] tuples.
  *
- * @param headers - the HeadersInit value to convert
- * @returns an array of [key, value] string tuples
+ * @param headers - Header input in any supported shape to normalize.
+ * @returns Tuple list usable as input to multi-value header merging.
  */ function headersToHeadersTuple(headers) {
     var tuples = [];
     if (Array.isArray(headers)) {
@@ -914,8 +914,8 @@ function _ts_generator$4(thisArg, body) {
  * Type guard that checks whether the given input is a fetch Request object
  * by testing for the presence of a url property.
  *
- * @param input - the value to test
- * @returns true if the input is a Request
+ * @param input - The value to test.
+ * @returns True if the input is a Request.
  */ function isFetchRequest(input) {
     return Boolean(input.url);
 }
@@ -1051,8 +1051,8 @@ function _ts_generator$3(thisArg, body) {
 /**
  * Creates a File object from the given input.
  *
- * @param input - configuration containing the file content, name, optional MIME type, and last modified timestamp
- * @returns a File object constructed from the provided input
+ * @param input - Configuration containing the file content, name, optional MIME type, and last modified timestamp.
+ * @returns A File object constructed from the provided input.
  */ function makeFileForFetch(input) {
     var options = {};
     if (input.mimeType) {
@@ -1132,10 +1132,10 @@ function fetchFileFromUrl(input, safe) {
     };
 }
 /**
- * @deprecated Use makeFileForFetch() with FormData and context.fetch() instead.
+ * @param input - Upload request inputs (target URL, fetch implementation, HTTP method, and file body) used to issue the request.
+ * @returns Resolved upload response from the underlying fetch call.
  *
- * @param input - configuration containing the upload URL, fetch function, HTTP method, and file body
- * @returns a promise resolving to the fetch Response
+ * @deprecated Use makeFileForFetch() with FormData and context.fetch() instead.
  */ // eslint-disable-next-line @typescript-eslint/no-deprecated
 function fetchUploadFile(input) {
     var _input_method;
@@ -1282,8 +1282,8 @@ function _ts_generator$2(thisArg, body) {
  * Creates a FetchHandler that enforces rate limiting via the provided PromiseRateLimiter and supports
  * automatic retry when the server signals throttling.
  *
- * @param config - configuration containing the rate limiter, retry settings, and response handler
- * @returns a RateLimitedFetchHandler that rate-limits outgoing requests and retries on throttle responses
+ * @param config - Configuration containing the rate limiter, retry settings, and response handler.
+ * @returns A RateLimitedFetchHandler that rate-limits outgoing requests and retries on throttle responses.
  */ function rateLimitedFetchHandler(config) {
     var updateWithResponse = config.updateWithResponse, inputMaxRetries = config.maxRetries;
     var maxRetries = inputMaxRetries !== null && inputMaxRetries !== void 0 ? inputMaxRetries : 1;
@@ -1621,7 +1621,7 @@ var FetchPageLimitReachedError = /*#__PURE__*/ function(FetchRequestFactoryError
 }(FetchRequestFactoryError);
 /**
  * Default max page for a FetchPageFactory.
- */ var FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE = 100;
+ */ var DEFAULT_FETCH_PAGE_FACTORY_MAX_PAGE = 100;
 /**
  * Creates a new FetchPageFactory from the input.
  *
@@ -1632,7 +1632,7 @@ var FetchPageLimitReachedError = /*#__PURE__*/ function(FetchRequestFactoryError
     return function(initalInput, options) {
         var _ref = options !== null && options !== void 0 ? options : {}, tmp = _ref.maxPage, inputMaxPage = tmp === void 0 ? defaultMaxPage : tmp, inputMaxItemsPerPage = _ref.maxItemsPerPage;
         var maxItemsPerPage = inputMaxItemsPerPage !== null && inputMaxItemsPerPage !== void 0 ? inputMaxItemsPerPage : defaultMaxItemsPerPage;
-        var maxPage = inputMaxPage === null ? Number.MAX_SAFE_INTEGER : inputMaxPage !== null && inputMaxPage !== void 0 ? inputMaxPage : FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE;
+        var maxPage = inputMaxPage === null ? Number.MAX_SAFE_INTEGER : inputMaxPage !== null && inputMaxPage !== void 0 ? inputMaxPage : DEFAULT_FETCH_PAGE_FACTORY_MAX_PAGE;
         function fetchNextWithInput(input) {
             var previous = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : undefined;
             return function() {
@@ -1961,8 +1961,8 @@ function _ts_generator(thisArg, body) {
  * Each item's callback receives a global index that reflects its position across all pages,
  * not just within the current page.
  *
- * @param config - Configuration specifying the fetch page source, item extraction, and per-item callback
- * @returns Combined result from {@link iterateFetchPagesByItems} including page/item counts and per-item task results
+ * @param config - Configuration specifying the fetch page source, item extraction, and per-item callback.
+ * @returns Combined result from {@link iterateFetchPagesByItems} including page/item counts and per-item task results.
  *
  * @example
  * ```typescript
@@ -2021,7 +2021,7 @@ function _ts_generator(thisArg, body) {
  *
  * For per-item processing instead of batch processing, use {@link iterateFetchPagesByEachItem}.
  *
- * @param config - Configuration specifying fetch source, item extraction, filtering, limits, and batch callback
+ * @param config - Configuration specifying fetch source, item extraction, filtering, limits, and batch callback.
  * @returns Result with page count and item counters (loaded and visited)
  *
  * @example
@@ -2107,35 +2107,47 @@ function iterateFetchPages(config) {
         var _ref, _ref1, iteratePage, inputFetchPage, input, fetchPageFactory, usePageResult, maxParallelPages, waitBetweenPages, maxPage, maxItemsPerPage, endEarly, hasReachedEnd, fetchPage, currentNextPage, performTaskFn, result;
         function taskInputFactory() {
             return _async_to_generator(function() {
+                var result;
                 return _ts_generator(this, function(_state) {
                     switch(_state.label){
                         case 0:
-                            if (hasReachedEnd) {
-                                return [
-                                    2,
-                                    null
-                                ]; // issue no more tasks
-                            }
-                            if (currentNextPage != null && (currentNextPage.isAtMaxPage || !currentNextPage.hasNext)) {
-                                hasReachedEnd = true;
-                                return [
-                                    2,
-                                    null
-                                ];
-                            }
+                            if (!hasReachedEnd) return [
+                                3,
+                                1
+                            ];
+                            result = null; // issue no more tasks
+                            return [
+                                3,
+                                4
+                            ];
+                        case 1:
+                            if (!(currentNextPage != null && (currentNextPage.isAtMaxPage || !currentNextPage.hasNext))) return [
+                                3,
+                                2
+                            ];
+                            hasReachedEnd = true;
+                            result = null;
+                            return [
+                                3,
+                                4
+                            ];
+                        case 2:
                             return [
                                 4,
                                 fetchPage.fetchNext()
                             ];
-                        case 1:
+                        case 3:
                             currentNextPage = _state.sent();
                             fetchPage = currentNextPage;
+                            result = {
+                                i: currentNextPage.page,
+                                fetchPageResult: currentNextPage
+                            };
+                            _state.label = 4;
+                        case 4:
                             return [
                                 2,
-                                {
-                                    i: currentNextPage.page,
-                                    fetchPageResult: currentNextPage
-                                }
+                                result
                             ];
                     }
                 });
@@ -2257,9 +2269,9 @@ function _unsupported_iterable_to_array$1(o, minLen) {
 /**
  * Creates URLSearchParams from the input objects. The input objects are merged together.
  *
- * @param input - one or more objects (or nullish values) whose key-value pairs become search parameters
- * @param options - optional configuration for filtering, omitting keys, and space encoding
- * @returns a URLSearchParams instance built from the merged and filtered input
+ * @param input - One or more objects (or nullish values) whose key-value pairs become search parameters.
+ * @param options - Optional configuration for filtering, omitting keys, and space encoding.
+ * @returns A URLSearchParams instance built from the merged and filtered input.
  */ function makeUrlSearchParams(input, options) {
     var _ref = options !== null && options !== void 0 ? options : {}, omitKeys = _ref.omitKeys, filterValues = _ref.filterEmptyValues;
     var mergedInput = Array.isArray(input) ? util.mergeObjects(input) : input;
@@ -2280,9 +2292,9 @@ function _unsupported_iterable_to_array$1(o, minLen) {
  * RFC 3986 percent-encoded output (`%20` for spaces) instead of the
  * `application/x-www-form-urlencoded` default (`+` for spaces).
  *
- * @param input - objects to encode as query parameters
- * @param options - encoding options
- * @returns the encoded query string (without a leading `?`)
+ * @param input - Objects to encode as query parameters.
+ * @param options - Encoding options.
+ * @returns The encoded query string (without a leading `?`)
  */ function makeUrlSearchParamsString(input, options) {
     var params = makeUrlSearchParams(input, options);
     var str = params.toString();
@@ -2296,6 +2308,11 @@ function _unsupported_iterable_to_array$1(o, minLen) {
  * {@link MakeUrlSearchParamsOptions} such as `omitKeys`, `filterEmptyValues`, and
  * `useUrlSearchSpaceHandling`.
  *
+ * @param url - The URL string to update.
+ * @param params - New search parameters to merge into the URL.
+ * @param options - Optional configuration for filtering, omitting keys, and space encoding.
+ * @returns The URL string with updated query parameters.
+ *
  * @example
  * ```typescript
  * // Add params to a URL with no query string
@@ -2310,11 +2327,6 @@ function _unsupported_iterable_to_array$1(o, minLen) {
  * updateUrlSearchParams('https://example.com', { scope: 'openid profile' }, { useUrlSearchSpaceHandling: true });
  * // => 'https://example.com?scope=openid%20profile'
  * ```
- *
- * @param url - the URL string to update
- * @param params - new search parameters to merge into the URL
- * @param options - optional configuration for filtering, omitting keys, and space encoding
- * @returns the URL string with updated query parameters
  */ function updateUrlSearchParams(url, params, options) {
     var _url_split = _sliced_to_array$1(url.split('?', 2), 2), basePath = _url_split[0], existingQuery = _url_split[1];
     var existingParams = existingQuery ? new URLSearchParams(existingQuery) : new URLSearchParams();
@@ -2355,8 +2367,8 @@ function _unsupported_iterable_to_array$1(o, minLen) {
 /**
  * Merges an array of MakeUrlSearchParamsOptions into a single MakeUrlSearchParamsOptions value.
  *
- * @param options - one or more options objects whose omitKeys sets are combined
- * @returns a single MakeUrlSearchParamsOptions with the union of all omitKeys
+ * @param options - One or more options objects whose omitKeys sets are combined.
+ * @returns A single MakeUrlSearchParamsOptions with the union of all omitKeys.
  */ function mergeMakeUrlSearchParamsOptions(options) {
     var omitKeys = new Set();
     util.useIterableOrValue(options, function(x) {
@@ -2433,8 +2445,8 @@ function _unsupported_iterable_to_array(o, minLen) {
  * Resolves a FetchURLInput to a URL string. Handles plain strings, URL objects, and
  * FetchURLConfiguration objects by appending query parameters when provided.
  *
- * @param input - a string, URL, or FetchURLConfiguration to resolve
- * @returns the resolved URL as a string
+ * @param input - URL source to normalize; may already be a string or carry query parameters to append.
+ * @returns Fully resolved request URL ready to pass to `fetch`.
  */ function fetchURL(input) {
     var url;
     if (typeof input === 'string') {
@@ -2459,21 +2471,21 @@ function _unsupported_iterable_to_array(o, minLen) {
 /**
  * Type guard that checks whether the given value is a URL instance.
  *
- * @param input - the value to test
- * @returns true if the input is a URL instance
+ * @param input - The value to test.
+ * @returns True if the input is a URL instance.
  */ function isURL(input) {
     return (typeof input === "undefined" ? "undefined" : _type_of$1(input)) === 'object' && _instanceof(input, URL);
 }
 /**
  * Type guard that checks whether the given value is a URLSearchParams instance.
  *
- * @param input - the value to test
- * @returns true if the input is a URLSearchParams instance
+ * @param input - The value to test.
+ * @returns True if the input is a URLSearchParams instance.
  */ function isURLSearchParams(input) {
     return (typeof input === "undefined" ? "undefined" : _type_of$1(input)) === 'object' && _instanceof(input, URLSearchParams);
 }
 /**
- * Converts the input
+ * Converts the input.
  *
  * @param input
  * @returns
@@ -2501,8 +2513,8 @@ function _unsupported_iterable_to_array(o, minLen) {
  * Converts a FetchURLQueryParamsInput value (URLSearchParams, string, iterable of tuples, or
  * params object) into a URLSearchParams instance.
  *
- * @param input - the query parameters input to convert
- * @returns a URLSearchParams instance representing the input
+ * @param input - The query parameters input to convert.
+ * @returns A URLSearchParams instance representing the input.
  */ function queryParamsToSearchParams(input) {
     var result;
     if (isURLSearchParams(input)) {
@@ -2522,8 +2534,8 @@ function _unsupported_iterable_to_array(o, minLen) {
  * Converts a FetchURLSearchParamsObject (a plain key-value record) into a URLSearchParams instance,
  * expanding array values into multiple entries for the same key and filtering out null/undefined values.
  *
- * @param input - the params object to convert
- * @returns a URLSearchParams instance representing the input object
+ * @param input - The params object to convert.
+ * @returns A URLSearchParams instance representing the input object.
  */ function fetchURLSearchParamsObjectToURLSearchParams(input) {
     var paramTuples = [];
     util.forEachKeyValue(input, {
@@ -2725,9 +2737,9 @@ var returnNullHandleFetchJsonParseErrorFunction = function returnNullHandleFetch
 /**
  * Creates a FetchJsonFunction from the input ConfiguredFetch.
  *
- * @param fetch - the configured fetch function to use for making HTTP requests
- * @param inputConfig - optional configuration or error handler for JSON parsing; when a function is provided it is used as the parse error handler
- * @returns a FetchJsonFunction that performs requests and parses JSON responses
+ * @param fetch - The configured fetch function to use for making HTTP requests.
+ * @param inputConfig - Optional configuration or error handler for JSON parsing; when a function is provided it is used as the parse error handler.
+ * @returns A FetchJsonFunction that performs requests and parses JSON responses.
  */ function fetchJsonFunction(fetch, inputConfig) {
     var _config_handleFetchJsonParseErrorFunction;
     var config;
@@ -2763,8 +2775,8 @@ var returnNullHandleFetchJsonParseErrorFunction = function returnNullHandleFetch
  * Creates a {@link FetchJsonRequestInitFunction} that converts method/body inputs into a fully formed {@link RequestInit},
  * applying the configured default method and optional input mapping.
  *
- * @param config - optional configuration specifying the default HTTP method and an input mapping function
- * @returns a function that produces a {@link RequestInit} from a method string or {@link FetchJsonInput}
+ * @param config - Default-method and input-mapping overrides applied by the generated function.
+ * @returns Reusable builder that resolves a `RequestInit` for each request.
  */ function fetchJsonRequestInitFunction() {
     var config = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
     var _config_defaultMethod = config.defaultMethod, defaultMethod = _config_defaultMethod === void 0 ? 'GET' : _config_defaultMethod, _config_mapFetchJsonInput = config.mapFetchJsonInput, mapFetchJsonInput = _config_mapFetchJsonInput === void 0 ? util.mapIdentityFunction() : _config_mapFetchJsonInput;
@@ -2777,7 +2789,10 @@ var returnNullHandleFetchJsonParseErrorFunction = function returnNullHandleFetch
                 body: body
             };
         } else {
-            config = methodOrInput;
+            config = methodOrInput !== null && methodOrInput !== void 0 ? methodOrInput : {
+                method: defaultMethod,
+                body: body
+            };
         }
         config = mapFetchJsonInput(config);
         var requestInit = _object_spread_props(_object_spread({}, config), {
@@ -2799,8 +2814,8 @@ var fetchJsonRequestInit = fetchJsonRequestInitFunction();
 });
 
 exports.DEFAULT_FETCH_HANDLER = DEFAULT_FETCH_HANDLER;
+exports.DEFAULT_FETCH_PAGE_FACTORY_MAX_PAGE = DEFAULT_FETCH_PAGE_FACTORY_MAX_PAGE;
 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;
 exports.FetchRequestFactoryError = FetchRequestFactoryError;