@dereekb/util 12.1.14 → 12.2.1

package/fetch/package.json

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

package/index.cjs.js

@@ -12475,7 +12475,9 @@ class ModelRelationUtility {
  * Key used to signify
  */
 const CATCH_ALL_HANDLE_RESULT_KEY = '__CATCH_ALL_HANDLE_RESULT_KEY__';
-function handlerFactory(readKey) {
+function handlerFactory(readKey, options) {
+  const defaultResultValue = options?.defaultResult ?? true;
+  const negativeResultValue = options?.negativeResult ?? false;
   return () => {
     let catchAll;
     const map = new Map();
@@ -12499,9 +12501,9 @@ function handlerFactory(readKey) {
         const handler = (key != null ? map.get(key) : undefined) ?? catchAll;
         let handled;
         if (handler) {
-          handled = Promise.resolve(handler(value)).then(x => x ?? true);
+          handled = Promise.resolve(handler(value)).then(x => x ?? defaultResultValue);
         } else {
-          handled = Promise.resolve(false);
+          handled = Promise.resolve(negativeResultValue);
         }
         return handled;
       },

package/index.esm.js

@@ -12473,7 +12473,9 @@ class ModelRelationUtility {
  * Key used to signify
  */
 const CATCH_ALL_HANDLE_RESULT_KEY = '__CATCH_ALL_HANDLE_RESULT_KEY__';
-function handlerFactory(readKey) {
+function handlerFactory(readKey, options) {
+  const defaultResultValue = options?.defaultResult ?? true;
+  const negativeResultValue = options?.negativeResult ?? false;
   return () => {
     let catchAll;
     const map = new Map();
@@ -12497,9 +12499,9 @@ function handlerFactory(readKey) {
         const handler = (key != null ? map.get(key) : undefined) ?? catchAll;
         let handled;
         if (handler) {
-          handled = Promise.resolve(handler(value)).then(x => x ?? true);
+          handled = Promise.resolve(handler(value)).then(x => x ?? defaultResultValue);
         } else {
-          handled = Promise.resolve(false);
+          handled = Promise.resolve(negativeResultValue);
         }
         return handled;
       },

package/package.json

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

package/src/lib/key.d.ts

@@ -13,6 +13,10 @@ export type FieldOfType<T> = keyof T;
  * Reads a key from the input object.
  */
 export type ReadKeyFunction<T, K extends PrimativeKey = PrimativeKey> = MapFunction<T, Maybe<K>>;
+/**
+ * Reads a key value from the input object that is required to exist.
+ */
+export type ReadRequiredKeyFunction<T, K extends PrimativeKey = PrimativeKey> = MapFunction<T, K>;
 /**
  * Reads one or more keys from the input object.
  */

package/src/lib/service/handler.config.d.ts

@@ -1,12 +1,12 @@
 import { type MapFunction } from '../value/map';
 import { type ArrayOrValue } from '../array/array';
 import { type PrimativeKey } from '../key';
-import { InternalHandlerFunction, type Handler, type HandlerAccessor, type HandlerSetAccessor } from './handler';
+import { HandleResult, InternalHandlerFunction, type Handler, type HandlerAccessor, type HandlerSetAccessor } from './handler';
 /**
  * Wraps a HandlerAccessor and the item it is bound to in order to be a HandlerSetAccessor.
  */
-export interface HandlerBindAccessor<T, K extends PrimativeKey = string> extends HandlerSetAccessor<T, K> {
-    readonly accessor: HandlerAccessor<T, K>;
+export interface HandlerBindAccessor<T, K extends PrimativeKey = string, R = HandleResult> extends HandlerSetAccessor<T, K, R> {
+    readonly accessor: HandlerAccessor<T, K, R>;
     readonly boundTo: unknown;
 }
 /**
@@ -16,11 +16,11 @@ export interface HandlerBindAccessor<T, K extends PrimativeKey = string> extends
  * @param accessor
  * @returns
  */
-export declare function handlerBindAccessor<T, K extends PrimativeKey = string>(boundTo: unknown, accessor: HandlerAccessor<T, K>): HandlerBindAccessor<T, K>;
+export declare function handlerBindAccessor<T, K extends PrimativeKey = string, R = HandleResult>(boundTo: unknown, accessor: HandlerAccessor<T, K, R>): HandlerBindAccessor<T, K, R>;
 /**
  * Contextual function that configures the context's Handler with the input function for the context's key.
  */
-export type HandlerSetFunction<T> = (handlerFunction: InternalHandlerFunction<T>) => void;
+export type HandlerSetFunction<T, R = HandleResult> = (handlerFunction: InternalHandlerFunction<T, R>) => void;
 /**
  * Creates a HandlerSetFunction.
  *
@@ -28,21 +28,21 @@ export type HandlerSetFunction<T> = (handlerFunction: InternalHandlerFunction<T>
  * @param key
  * @returns
  */
-export declare function handlerSetFunction<T, K extends PrimativeKey = string>(accessor: HandlerSetAccessor<T, K>, key: ArrayOrValue<K>): HandlerSetFunction<T>;
-export type HandlerMappedSetFunction<I> = (handlerFunction: InternalHandlerFunction<I>) => void;
-export declare function handlerMappedSetFunction<I, T, K extends PrimativeKey = string>(accessor: HandlerSetAccessor<T, K>, key: ArrayOrValue<K>, mapFn: MapFunction<T, I>): HandlerMappedSetFunction<I>;
+export declare function handlerSetFunction<T, K extends PrimativeKey = string, R = HandleResult>(accessor: HandlerSetAccessor<T, K, R>, key: ArrayOrValue<K>): HandlerSetFunction<T, R>;
+export type HandlerMappedSetFunction<I, R = HandleResult> = (handlerFunction: InternalHandlerFunction<I, R>) => void;
+export declare function handlerMappedSetFunction<I, T, K extends PrimativeKey = string, R = HandleResult>(accessor: HandlerSetAccessor<T, K, R>, key: ArrayOrValue<K>, mapFn: MapFunction<T, I>): HandlerMappedSetFunction<I, R>;
 /**
  * Factory for a HandlerMappedSetFunction<I>.
  */
-export type HandlerMappedSetFunctionFactory<I, K extends PrimativeKey = string> = (key: ArrayOrValue<K>) => HandlerMappedSetFunction<I>;
-export declare function handlerMappedSetFunctionFactory<I, T, K extends PrimativeKey = string>(accessor: HandlerSetAccessor<T, K>, mapFn: MapFunction<T, I>): HandlerMappedSetFunctionFactory<I, K>;
-export type HandlerConfigurerFunction<C extends HandlerBindAccessor<T, K>, T, K extends PrimativeKey = string> = (configurer: C) => void;
-export type HandlerConfigurer<C extends HandlerBindAccessor<T, K>, T, K extends PrimativeKey = string> = (bindTo: unknown, configure: HandlerConfigurerFunction<C, T, K>) => void;
-export type HandlerConfigurerFactory<C extends HandlerBindAccessor<T, K>, T, K extends PrimativeKey = string> = (handler: Handler<T, K>) => HandlerConfigurer<C, T, K>;
+export type HandlerMappedSetFunctionFactory<I, K extends PrimativeKey = string, R = HandleResult> = (key: ArrayOrValue<K>) => HandlerMappedSetFunction<I, R>;
+export declare function handlerMappedSetFunctionFactory<I, T, K extends PrimativeKey = string, R = HandleResult>(accessor: HandlerSetAccessor<T, K, R>, mapFn: MapFunction<T, I>): HandlerMappedSetFunctionFactory<I, K, R>;
+export type HandlerConfigurerFunction<C extends HandlerBindAccessor<T, K, R>, T, K extends PrimativeKey = string, R = HandleResult> = (configurer: C) => void;
+export type HandlerConfigurer<C extends HandlerBindAccessor<T, K, R>, T, K extends PrimativeKey = string, R = HandleResult> = (bindTo: unknown, configure: HandlerConfigurerFunction<C, T, K, R>) => void;
+export type HandlerConfigurerFactory<C extends HandlerBindAccessor<T, K, R>, T, K extends PrimativeKey = string, R = HandleResult> = (handler: Handler<T, K, R>) => HandlerConfigurer<C, T, K, R>;
 /**
  * Config for handlerConfigurerFactory().
  */
-export interface HandlerConfigurerFactoryConfig<C extends HandlerBindAccessor<T, K>, T, K extends PrimativeKey = string> {
-    configurerForAccessor: (accessor: HandlerBindAccessor<T, K>) => C;
+export interface HandlerConfigurerFactoryConfig<C extends HandlerBindAccessor<T, K, R>, T, K extends PrimativeKey = string, R = HandleResult> {
+    configurerForAccessor: (accessor: HandlerBindAccessor<T, K, R>) => C;
 }
-export declare function handlerConfigurerFactory<C extends HandlerBindAccessor<T, K>, T, K extends PrimativeKey = string>(config: HandlerConfigurerFactoryConfig<C, T, K>): HandlerConfigurerFactory<C, T, K>;
+export declare function handlerConfigurerFactory<C extends HandlerBindAccessor<T, K, R>, T, K extends PrimativeKey = string, R = HandleResult>(config: HandlerConfigurerFactoryConfig<C, T, K, R>): HandlerConfigurerFactory<C, T, K, R>;

package/src/lib/service/handler.d.ts

@@ -22,27 +22,27 @@ export type HandlerKey<K extends PrimativeKey = string> = K | HandlerCatchAllKey
  *
  * If the value is not used/"handled", returns false.
  */
-export type HandlerFunction<T> = (value: T) => Promise<HandleResult>;
+export type HandlerFunction<T, R = HandleResult> = (value: T) => Promise<R>;
 /**
  * HandleFunction, but used only by Handler that can return undefined.
  */
-export type InternalHandlerFunction<T> = (value: T) => PromiseOrValue<InternalHandlerFunctionHandleResult>;
-export interface HandlerSetAccessor<T, K extends PrimativeKey = string> {
+export type InternalHandlerFunction<T, R = HandleResult> = (value: T) => PromiseOrValue<R | void>;
+export interface HandlerSetAccessor<T, K extends PrimativeKey = string, R = HandleResult> {
     /**
      * Adds a new handler function to the current handler.
      *
      * @param key
      * @param handle
      */
-    set(key: ArrayOrValue<HandlerKey<K>>, handle: InternalHandlerFunction<T>): void;
+    set(key: ArrayOrValue<HandlerKey<K>>, handle: InternalHandlerFunction<T, R>): void;
     /**
      * Sets the catch-all handler function to the current handler.
      *
      * @param handle
      */
-    setCatchAll(handle: InternalHandlerFunction<T>): void;
+    setCatchAll(handle: InternalHandlerFunction<T, R>): void;
 }
-export interface HandlerAccessor<T, K extends PrimativeKey = string> extends HandlerSetAccessor<T, K> {
+export interface HandlerAccessor<T, K extends PrimativeKey = string, R = HandleResult> extends HandlerSetAccessor<T, K, R> {
     /**
      * Used to read a handler key from the input value.
      */
@@ -54,10 +54,15 @@ export interface HandlerAccessor<T, K extends PrimativeKey = string> extends Han
      * @param key
      * @param handle
      */
-    bindSet(bindTo: unknown, key: ArrayOrValue<HandlerKey<K>>, handle: InternalHandlerFunction<T>): void;
+    bindSet(bindTo: unknown, key: ArrayOrValue<HandlerKey<K>>, handle: InternalHandlerFunction<T, R>): void;
 }
-export type Handler<T, K extends PrimativeKey = string> = HandlerFunction<T> & HandlerAccessor<T, K>;
-export type HandlerFactory<T, K extends PrimativeKey = string> = () => Handler<T, K>;
-export declare function handlerFactory<T, K extends PrimativeKey = string>(readKey: ReadKeyFunction<T, K>): HandlerFactory<T, K>;
+export type Handler<T, K extends PrimativeKey = string, R = HandleResult> = HandlerFunction<T, R> & HandlerAccessor<T, K, R>;
+export type HandlerFactory<T, K extends PrimativeKey = string, R = HandleResult> = () => Handler<T, K, R>;
+export interface HandlerFactoryOptions<R = HandleResult> {
+    readonly defaultResult: R;
+    readonly negativeResult: R;
+}
+export declare function handlerFactory<T, K extends PrimativeKey = string>(readKey: ReadKeyFunction<T, K>): HandlerFactory<T, K, HandleResult>;
+export declare function handlerFactory<T, K extends PrimativeKey = string, R = HandleResult>(readKey: ReadKeyFunction<T, K>, options: HandlerFactoryOptions<R>): HandlerFactory<T, K, R>;
 export declare function makeHandler<T, K extends PrimativeKey = string>(readKey: ReadKeyFunction<T, K>): Handler<T, K>;
 export declare function catchAllHandlerKey(): typeof CATCH_ALL_HANDLE_RESULT_KEY;

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

@@ -2,6 +2,7 @@ export * from './char';
 export * from './dencoder';
 export * from './factory';
 export * from './html';
+export * from './json';
 export * from './password';
 export * from './prefix';
 export * from './string';

package/src/lib/string/json.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A json encoded string.
+ */
+export type JSONEncodedString = string;

package/test/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [12.2.1](https://github.com/dereekb/dbx-components/compare/v12.2.0-dev...v12.2.1) (2025-07-02)
+
+
+
+# [12.2.0](https://github.com/dereekb/dbx-components/compare/v12.1.14-dev...v12.2.0) (2025-06-29)
+
+
+
 ## [12.1.14](https://github.com/dereekb/dbx-components/compare/v12.1.13-dev...v12.1.14) (2025-06-27)
 
 

package/test/package.json

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