@dereekb/util 11.0.7 → 11.0.8

package/fetch/index.cjs.js

@@ -5428,6 +5428,25 @@ const iterateFetchPagesByItems = _async(function (config) {
   return iterateFetchPages(fetchPagesConfig);
 });
 
+/**
+ * Creates URLSearchParams from the input objects. The input objects are merged together.
+ *
+ * @param input
+ * @param omitKeys
+ * @returns
+ */
+function makeUrlSearchParams(input, options) {
+  const {
+    omitKeys
+  } = options != null ? options : {};
+  const mergedInput = Array.isArray(input) ? util.mergeObjects(input) : input;
+  const searchParams = new URLSearchParams(mergedInput);
+  if (omitKeys != null) {
+    util.useIterableOrValue(omitKeys, key => searchParams.delete(key), false);
+  }
+  return searchParams;
+}
+
 var anObject$1 = anObject$e;
 
 // `RegExp.prototype.flags` getter implementation
@@ -5684,6 +5703,7 @@ exports.isURL = isURL;
 exports.isURLSearchParams = isURLSearchParams;
 exports.iterateFetchPages = iterateFetchPages;
 exports.iterateFetchPagesByItems = iterateFetchPagesByItems;
+exports.makeUrlSearchParams = makeUrlSearchParams;
 exports.mergeRequestHeaders = mergeRequestHeaders;
 exports.mergeRequestInits = mergeRequestInits;
 exports.nodeFetchService = nodeFetchService;

package/fetch/index.esm.js

@@ -1,4 +1,4 @@
-import { removeTrailingSlashes, asGetter, multiValueMapBuilder, filterMaybeValues, objectToTuples, fixMultiSlashesInSlashPath, isPromiseLike, cachedGetter, FIRST_PAGE, mapIdentityFunction, performTasksFromFactoryInParallelFunction, isEmptyIterable, fixExtraQueryParameters, forEachInIterable, useIterableOrValue, isIterable, forEachKeyValue } from '@dereekb/util';
+import { removeTrailingSlashes, asGetter, multiValueMapBuilder, filterMaybeValues, objectToTuples, fixMultiSlashesInSlashPath, isPromiseLike, cachedGetter, FIRST_PAGE, mapIdentityFunction, performTasksFromFactoryInParallelFunction, mergeObjects, useIterableOrValue, isEmptyIterable, fixExtraQueryParameters, forEachInIterable, isIterable, forEachKeyValue } from '@dereekb/util';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -5335,6 +5335,29 @@ async function iterateFetchPages(config) {
   return result;
 }
 
+/**
+ * Options for makeUrlSearchParams()
+ */
+
+/**
+ * Creates URLSearchParams from the input objects. The input objects are merged together.
+ *
+ * @param input
+ * @param omitKeys
+ * @returns
+ */
+function makeUrlSearchParams(input, options) {
+  const {
+    omitKeys
+  } = options != null ? options : {};
+  const mergedInput = Array.isArray(input) ? mergeObjects(input) : input;
+  const searchParams = new URLSearchParams(mergedInput);
+  if (omitKeys != null) {
+    useIterableOrValue(omitKeys, key => searchParams.delete(key), false);
+  }
+  return searchParams;
+}
+
 var anObject$1 = anObject$e;
 
 // `RegExp.prototype.flags` getter implementation
@@ -5572,4 +5595,4 @@ const nodeFetchService = fetchService({
   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, iterateFetchPagesByItems, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };
+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, iterateFetchPagesByItems, makeUrlSearchParams, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };

package/fetch/package.json

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

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

@@ -79,7 +79,20 @@ export interface FetchPageFactoryInputOptions {
      */
     readonly maxItemsPerPage?: Maybe<number>;
 }
-export interface FetchPageFactoryConfig<I, O> {
+export type ReadFetchPageResultInfo = Omit<FetchPageResultInfo, 'page'>;
+export interface FetchPageFactoryConfigDefaults {
+    /**
+     * The default max page to load up to.
+     *
+     * Defaults to 100. Pass null to disable the max page amount.
+     */
+    readonly defaultMaxPage?: Maybe<number>;
+    /**
+     * The default maximum number of items to load per page.
+     */
+    readonly defaultMaxItemsPerPage?: Maybe<number>;
+}
+export interface FetchPageFactoryConfig<I, O> extends FetchPageFactoryConfigDefaults {
     /**
      * The configured Fetch function that takes in the input and returns a results.
      */
@@ -92,7 +105,7 @@ export interface FetchPageFactoryConfig<I, O> {
      * @param result
      * @returns
      */
-    readonly readFetchPageResultInfo: (result: O) => PromiseOrValue<Omit<FetchPageResultInfo, 'page'>>;
+    readonly readFetchPageResultInfo: (result: O) => PromiseOrValue<ReadFetchPageResultInfo>;
     /**
      * Creates new input for the next page that is merged with the previous input.
      *
@@ -102,16 +115,6 @@ export interface FetchPageFactoryConfig<I, O> {
      * @returns
      */
     readonly buildInputForNextPage: (pageResult: Partial<FetchPageResult<O>>, input: I, options: FetchPageFactoryInputOptions) => PromiseOrValue<Maybe<Partial<I>>>;
-    /**
-     * The default max page to load up to.
-     *
-     * Defaults to 100. Pass null to disable the max page amount.
-     */
-    readonly defaultMaxPage?: Maybe<number>;
-    /**
-     * The default maximum number of items to load per page.
-     */
-    readonly defaultMaxItemsPerPage?: Maybe<number>;
 }
 export type FetchPageFactoryOptions<I, O> = FetchPageFactoryInputOptions;
 /**

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

@@ -0,0 +1,22 @@
+import { type Maybe, type ArrayOrValue, type IterableOrValue, type ObjectKey, type FilterKeyValueTuplesInput } from '@dereekb/util';
+/**
+ * Options for makeUrlSearchParams()
+ */
+export interface MakeUrlSearchParamsOptions {
+    /**
+     * Optional iterable of keys to remove from the search params.
+     */
+    readonly omitKeys?: Maybe<IterableOrValue<ObjectKey>>;
+    /**
+     * Optional filter for merging the objects together.
+     */
+    readonly mergeFilter?: FilterKeyValueTuplesInput;
+}
+/**
+ * Creates URLSearchParams from the input objects. The input objects are merged together.
+ *
+ * @param input
+ * @param omitKeys
+ * @returns
+ */
+export declare function makeUrlSearchParams(input: Maybe<ArrayOrValue<Maybe<object | Record<string, string | number>>>>, options?: Maybe<MakeUrlSearchParamsOptions>): URLSearchParams;

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

@@ -3,6 +3,7 @@ export * from './fetch';
 export * from './fetch.type';
 export * from './fetch.page';
 export * from './fetch.page.iterate';
+export * from './fetch.url';
 export * from './json';
 export * from './provider';
 export * from './timeout';

package/index.esm.js

@@ -2788,6 +2788,10 @@ function arrayDecision(values, decision, mode) {
   return arrayDecisionFunction(decision, mode)(values);
 }
 
+/**
+ * Key of an object.
+ */
+
 function objectHasNoKeys(obj) {
   return Object.keys(obj).length === 0;
 }

package/package.json

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

package/src/lib/object/object.d.ts

@@ -1,6 +1,10 @@
 import { type FieldOfType } from '../key';
 import { type SetIncludesMode } from '../set/set.mode';
 import { type KeyAsString } from '../type';
+/**
+ * Key of an object.
+ */
+export type ObjectKey = string;
 export type EmptyObject = Record<string, never>;
 export declare function objectHasNoKeys(obj: object): obj is EmptyObject;
 export declare function objectHasKey<T>(obj: T, key: KeyAsString<keyof T>): boolean;
@@ -13,7 +17,7 @@ export declare function objectHasKey<T, K extends keyof T>(obj: T, key: K): bool
  * @param keys
  */
 export declare function objectHasKeys<T>(obj: T, keys: KeyAsString<keyof T>[], mode?: SetIncludesMode): boolean;
-export declare function objectHasKeys(obj: unknown, keys: string[], mode?: SetIncludesMode): boolean;
+export declare function objectHasKeys(obj: unknown, keys: ObjectKey[], mode?: SetIncludesMode): boolean;
 export declare function objectHasKeys<T, K extends keyof T>(obj: T, keys: K[], mode?: SetIncludesMode): boolean;
 export declare function applyToMultipleFields<T extends object, X = unknown>(value: X, fields: FieldOfType<T>[]): Partial<{
     [K in keyof T]: X;

package/src/lib/page/page.d.ts

@@ -21,6 +21,6 @@ export interface Page {
      */
     page: PageNumber;
 }
-export declare function getPageNumber(page: Maybe<Page>): number;
-export declare function getNextPageNumber(page: Maybe<Page>): number;
-export declare function isFinalPage(page: Maybe<Page>): boolean;
+export declare function getPageNumber(page: Maybe<Partial<Page>>): number;
+export declare function getNextPageNumber(page: Maybe<Partial<Page>>): number;
+export declare function isFinalPage(page: Maybe<Partial<Page>>): boolean;

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.0.8](https://github.com/dereekb/dbx-components/compare/v11.0.7-dev...v11.0.8) (2024-11-23)
+
+
+
 ## [11.0.7](https://github.com/dereekb/dbx-components/compare/v11.0.6-dev...v11.0.7) (2024-11-22)
 
 

package/test/package.json

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