maraj 2.8.4 → 2.9.0

package/dist/index.d.mts

@@ -1,78 +1,18 @@
-/** Returns only the optional keys of an object. */
-type OptionalKeys<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
-}[keyof T];
-/** Removes properties or indexes, order doesn't matter. */
-type Remove = <T extends Record<PropertyKey, any>>(value: T, keys: T extends any[] ? (number | `${number}` | (number | `${number}`)[]) : OptionalKeys<T> | (OptionalKeys<T>)[]) => T;
-/**
- * Removes properties or indexes, order doesn't matter.
- * @param value Object/array from where to remove keys/indexes shallowly.
- * @param keys Keys to remove.
- * @returns New object/array without the provided keys/indexes.
- */
-declare const remove: Remove;
-
-/** Index literal type to improve DX at managing updates. */
-declare const LITERAL_INDEX = "${number}";
-type LiteralIndex = typeof LITERAL_INDEX;
-type OptionValues = 'error' | 'skip' | 'add';
-type Options = {
-    onNewProps?: OptionValues;
-    onNewIndexes?: OptionValues;
-    onPathsIntersectedByPrimitiveValues?: OptionValues;
-};
-type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends DotPaths<TObject> = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
-/**
- * Creates a new object applying immutable updates using dot-path syntax.
- * Can add or skip new props or indexes depending on options.
- * TYPESCRIPT: Dot-Path Update Object type must STRICTLY match the type of state.
- * @param state Original State Object.
- * @param dotPathUpdateObject Dot Path Update Object.
- * @param options Options to change JS behaviour on non-existent fields.
- * @returns New Updated Object.
- */
-declare const update: ImmutableUpdate;
-type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject> = UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
-/**
- * Creates a new object applying immutable updates using dot-path syntax.
- * It will always add non-existent props or indexes if provided.
- * TYPESCRIPT: Dot-Path Update Object type extends from the type of state and you can add new non-existent properties.
- * @param state Original State Object.
- * @param dotPathUpdateObject Dot Path Update Object.
- * @returns New Updated Object.
- */
-declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
-
 /**
  * --------------------------------------------
- *  UTILITIES
- * --------------------------------------------
- */
-/** Primitives and browser native objects. */
-type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
-/** Array indexes type. */
-type ArrayIndexes = number | `${number}` | LiteralIndex;
-/** To check if a ReadonlyArray is a tuple or not. */
-type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false : true;
-/**
- * --------------------------------------------
- *  DOT PATH IMPLEMENTATION
+ *  DOT PATHS IMPLEMENTATION
  * --------------------------------------------
  */
 /** Dot-paths of an array. */
-type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ArrayIndexes : ArrayIndexes | `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}`;
+type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ExtendedArrayIndexes : ExtendedArrayIndexes | `${ExtendedArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ExtendedArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}`;
 /** Dot-paths of an object. */
 type ObjectPaths<T, TAllowedTypes> = {
     [Key in keyof T & (string | number)]: T[Key] extends TAllowedTypes ? T[Key] extends PrimitivesAndNativeObjects ? `${Key}` : `${Key}` | `${Key}.${DotPathsImplementation<T[Key], TAllowedTypes>}` : `${Key}.${DotPathsImplementation<T[Key], TAllowedTypes>}`;
-}[keyof T & (string | number)] & unknown;
+}[keyof T & (string | number)] & {};
 /** Dot-paths of a tuple. */
-type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & unknown;
+type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & {};
 /** Dot-paths implementation */
-type DotPathsImplementation<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? IsTuple<T> extends true ? TuplePaths<T, TAllowedTypes> : ArrayPaths<U, TAllowedTypes> : T extends PrimitivesAndNativeObjects ? never : ObjectPaths<T, TAllowedTypes>;
-/** Extract Keys from any kind of type, including objects, arrays, tuples. */
-type KeyOf<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? U extends TAllowedTypes ? IsTuple<T> extends true ? keyof Omit<T, keyof any[]> : ArrayIndexes : never : T extends PrimitivesAndNativeObjects ? never : {
-    [Key in keyof T]: T[Key] extends TAllowedTypes ? Key : never;
-}[keyof T];
+type DotPathsImplementation<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? T extends Tuple ? TuplePaths<T, TAllowedTypes> : ArrayPaths<U, TAllowedTypes> : T extends PrimitivesAndNativeObjects ? never : ObjectPaths<T, TAllowedTypes>;
 /** Literal union of all posible dot-paths which satisfy provided types as second argument (default: any). */
 type DotPaths<T, TAllowedTypes = any> = KeyOf<T, TAllowedTypes> | DotPathsImplementation<T, TAllowedTypes>;
 /**
@@ -97,7 +37,7 @@ type ReturnedValueInPath<TObject, TPath> = TPath extends '' ? TObject : TPath ex
 /** Value of a dot-path update object, can be the value or a function. */
 type UpdateValue<TObject, TPath> = ValueInPath<TObject, TPath> extends never ? never : ValueInPath<TObject, TPath> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
 /** Dot-path update object, used to give updates to the updateImmutably function. */
-type UpdateObject<TObject, TPaths extends PropertyKey = DotPaths<TObject>> = {
+type UpdateObject<TObject, TPaths extends DotPaths<TObject> = DotPaths<TObject>> = {
     [Path in TPaths]?: UpdateValue<TObject, Path>;
 };
 /**
@@ -141,6 +81,54 @@ type ExtractTypeFromDotPathUpdateObject<T extends Record<string, any>> = T exten
 /** New expanded value after aplying updates including new properties */
 type ExtendedUpdate<TObject, TDotPathUpdateObject extends Record<PropertyKey, any>> = TObject extends Array<infer U> ? ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject> extends Array<infer W> ? Array<U | W> : TObject & ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject> : TObject & ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject>;
 
+/** Index literal type to improve DX at managing updates. */
+declare const LITERAL_INDEX = "${number}";
+
+/** Primitives and browser native objects. */
+type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
+/** Tuple type, it has to have at least property "0" */
+type Tuple = ReadonlyArray<any> & {
+    "0": any;
+};
+/** Array indexes type. */
+type LiteralIndex = typeof LITERAL_INDEX;
+type ExtendedArrayIndexes = number | `${number}` | LiteralIndex;
+/** Object Literal */
+type ObjectLiteral = {
+    [x: string]: any;
+    [x: number]: any;
+    [x: symbol]: any;
+    [Symbol.iterator]?: never;
+    [Symbol.toPrimitive]?: never;
+    [Symbol.hasInstance]?: never;
+    [Symbol.unscopables]?: never;
+    [Symbol.matchAll]?: never;
+};
+/** Strict key */
+declare const strictSymbol: unique symbol;
+type Strict<T> = T extends ObjectLiteral ? T & {
+    [strictSymbol]: DotPaths<T>;
+} : T;
+/** Smart KeyOf (doesnt include the "strict" key) */
+type KeyOf<T, TAllowedValuesInKeys = any> = T extends ObjectLiteral ? T extends Strict<infer U> ? KeysOfObject<U, TAllowedValuesInKeys> : KeysOfObject<T, TAllowedValuesInKeys> : T extends Tuple ? KeysOfObject<Omit<T, keyof any[]>, TAllowedValuesInKeys> : T extends ReadonlyArray<infer U> ? U extends TAllowedValuesInKeys ? ExtendedArrayIndexes : never : never;
+type KeysOfObject<T, TAllowedValuesInKeys> = {
+    [Key in keyof T]: T[Key] extends TAllowedValuesInKeys ? Key : never;
+}[keyof T];
+
+/** Returns only the optional keys of an object. */
+type OptionalKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
+}[keyof T];
+/** Removes properties or indexes, order doesn't matter. */
+type Remove = <T extends ObjectLiteral | any[]>(value: T, keys: T extends any[] ? (number | `${number}` | (number | `${number}`)[]) : OptionalKeys<T> | (OptionalKeys<T>)[]) => T;
+/**
+ * Removes properties or indexes, order doesn't matter.
+ * @param value Object/array from where to remove keys/indexes shallowly.
+ * @param keys Keys to remove.
+ * @returns New object/array without the provided keys/indexes.
+ */
+declare const remove: Remove;
+
 type Select = {
     <T, TPath extends DotPaths<T>>(state: T, path: TPath): ReturnedValueInPath<T, TPath>;
     <T, TPath extends ''>(state: T, path: TPath): T;
@@ -171,28 +159,51 @@ type Set = <T>(newValue: T) => (v: unknown) => T;
  */
 declare const set: Set;
 
-type Iterator = typeof Symbol.iterator;
-type HasInstance = typeof Symbol.hasInstance;
-type ToPrimitive = typeof Symbol.toPrimitive;
-type Unscopables = typeof Symbol.unscopables;
-type MatchAll = typeof Symbol.matchAll;
-type NonObjectLiteralKeys = Unscopables | HasInstance | ToPrimitive | MatchAll | Iterator;
-type ObjectLiteral = Record<PropertyKey, any> & {
-    [K in NonObjectLiteralKeys]?: never;
+type OptionValues = 'error' | 'skip' | 'add';
+type Options = {
+    onNewProps?: OptionValues;
+    onNewIndexes?: OptionValues;
+    onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
+type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends DotPaths<TObject> = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
+/**
+ * Creates a new object applying immutable updates using dot-path syntax.
+ * Can add or skip new props or indexes depending on options.
+ * TYPESCRIPT: Dot-Path Update Object type must STRICTLY match the type of state.
+ * @param state Original State Object.
+ * @param dotPathUpdateObject Dot Path Update Object.
+ * @param options Options to change JS behaviour on non-existent fields.
+ * @returns New Updated Object.
+ */
+declare const update: ImmutableUpdate;
+type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject> = UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
+/**
+ * Creates a new object applying immutable updates using dot-path syntax.
+ * It will always add non-existent props or indexes if provided.
+ * TYPESCRIPT: Dot-Path Update Object type extends from the type of state and you can add new non-existent properties.
+ * @param state Original State Object.
+ * @param dotPathUpdateObject Dot Path Update Object.
+ * @returns New Updated Object.
+ */
+declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
+
+type ForEachEntry = <T extends ObjectLiteral>(object: T, callbackfn: (key: keyof T, value: T[keyof T]) => void) => void;
+declare const forEachEntry: ForEachEntry;
+
 /** Checks if any provided value is an object literal or not */
-declare const isObjectLiteral: (valueToTest: unknown) => valueToTest is ObjectLiteral;
+type IsObjectLiteral = (valueToTest: unknown) => valueToTest is ObjectLiteral;
+declare const isObjectLiteral: IsObjectLiteral;
 
-declare const parseStringIndex: (v: string) => number | null;
-declare const isStringIndex: (v: string) => v is `${number}`;
+/** Adds strict property to an object literal */
+type StrictFn = <T>(value: T) => Strict<T>;
+declare const s: StrictFn;
+/** Checks the strictness of a type passed to a function or callback without 3rd party implementation */
+type EnsureStrictness = <T extends U, U>(v: T extends U ? DotPaths<T> extends DotPaths<U> ? T : Exclude<DotPaths<T>, DotPaths<U>> : never) => U;
+declare const ensureStrictness: EnsureStrictness;
 
-type StrictCallbackError = "CALLBACK STRICTNESS RETURN ERROR: return the value using the first parameter";
-type StrictCallbackValue<T> = [StrictCallbackError, T];
-type StrictCallbackFunction<T> = (v: T) => StrictCallbackValue<T>;
-/** Apply strictness to a callback function */
-type StrictCallback<T extends (...args: any[]) => any> = (r: StrictCallbackFunction<ReturnType<T>>, ...args: Parameters<T>) => [StrictCallbackError, ReturnType<T>];
-type UnsealStrictCallback = <TCallback extends (r: StrictCallbackFunction<any>, ...args: any[]) => any>(callback: TCallback) => (...args: Parameters<TCallback> extends [infer _, ...infer RestParams] ? RestParams : never) => ReturnType<TCallback>['1'];
-/** Extract the callback from */
-declare const unsealStrictCallback: UnsealStrictCallback;
+type ParseStringIndex = (stringKey: string) => number | null;
+declare const parseStringIndex: ParseStringIndex;
+type IsStringIndex = (stringKey: string) => stringKey is `${number}`;
+declare const isStringIndex: IsStringIndex;
 
-export { type DotPaths, type KeyOf, type LiteralIndex, type ObjectLiteral, type ReturnedValueInPath, type StrictCallback, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, unsealStrictCallback, update };
+export { type DotPaths, type ExtendedArrayIndexes, type KeyOf, type LiteralIndex, type ObjectLiteral, type PrimitivesAndNativeObjects, type ReturnedValueInPath, type Strict, type Tuple, type UpdateObject, type UpdateValue, type ValueInPath, ensureStrictness, experimental_extendableUpdate, forEachEntry, isObjectLiteral, isStringIndex, parseStringIndex, remove, s, select, set, splitPathAtLastKey, update };

package/dist/index.d.ts

@@ -1,78 +1,18 @@
-/** Returns only the optional keys of an object. */
-type OptionalKeys<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
-}[keyof T];
-/** Removes properties or indexes, order doesn't matter. */
-type Remove = <T extends Record<PropertyKey, any>>(value: T, keys: T extends any[] ? (number | `${number}` | (number | `${number}`)[]) : OptionalKeys<T> | (OptionalKeys<T>)[]) => T;
-/**
- * Removes properties or indexes, order doesn't matter.
- * @param value Object/array from where to remove keys/indexes shallowly.
- * @param keys Keys to remove.
- * @returns New object/array without the provided keys/indexes.
- */
-declare const remove: Remove;
-
-/** Index literal type to improve DX at managing updates. */
-declare const LITERAL_INDEX = "${number}";
-type LiteralIndex = typeof LITERAL_INDEX;
-type OptionValues = 'error' | 'skip' | 'add';
-type Options = {
-    onNewProps?: OptionValues;
-    onNewIndexes?: OptionValues;
-    onPathsIntersectedByPrimitiveValues?: OptionValues;
-};
-type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends DotPaths<TObject> = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
-/**
- * Creates a new object applying immutable updates using dot-path syntax.
- * Can add or skip new props or indexes depending on options.
- * TYPESCRIPT: Dot-Path Update Object type must STRICTLY match the type of state.
- * @param state Original State Object.
- * @param dotPathUpdateObject Dot Path Update Object.
- * @param options Options to change JS behaviour on non-existent fields.
- * @returns New Updated Object.
- */
-declare const update: ImmutableUpdate;
-type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject> = UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
-/**
- * Creates a new object applying immutable updates using dot-path syntax.
- * It will always add non-existent props or indexes if provided.
- * TYPESCRIPT: Dot-Path Update Object type extends from the type of state and you can add new non-existent properties.
- * @param state Original State Object.
- * @param dotPathUpdateObject Dot Path Update Object.
- * @returns New Updated Object.
- */
-declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
-
 /**
  * --------------------------------------------
- *  UTILITIES
- * --------------------------------------------
- */
-/** Primitives and browser native objects. */
-type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
-/** Array indexes type. */
-type ArrayIndexes = number | `${number}` | LiteralIndex;
-/** To check if a ReadonlyArray is a tuple or not. */
-type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false : true;
-/**
- * --------------------------------------------
- *  DOT PATH IMPLEMENTATION
+ *  DOT PATHS IMPLEMENTATION
  * --------------------------------------------
  */
 /** Dot-paths of an array. */
-type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ArrayIndexes : ArrayIndexes | `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}`;
+type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ExtendedArrayIndexes : ExtendedArrayIndexes | `${ExtendedArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ExtendedArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}`;
 /** Dot-paths of an object. */
 type ObjectPaths<T, TAllowedTypes> = {
     [Key in keyof T & (string | number)]: T[Key] extends TAllowedTypes ? T[Key] extends PrimitivesAndNativeObjects ? `${Key}` : `${Key}` | `${Key}.${DotPathsImplementation<T[Key], TAllowedTypes>}` : `${Key}.${DotPathsImplementation<T[Key], TAllowedTypes>}`;
-}[keyof T & (string | number)] & unknown;
+}[keyof T & (string | number)] & {};
 /** Dot-paths of a tuple. */
-type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & unknown;
+type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & {};
 /** Dot-paths implementation */
-type DotPathsImplementation<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? IsTuple<T> extends true ? TuplePaths<T, TAllowedTypes> : ArrayPaths<U, TAllowedTypes> : T extends PrimitivesAndNativeObjects ? never : ObjectPaths<T, TAllowedTypes>;
-/** Extract Keys from any kind of type, including objects, arrays, tuples. */
-type KeyOf<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? U extends TAllowedTypes ? IsTuple<T> extends true ? keyof Omit<T, keyof any[]> : ArrayIndexes : never : T extends PrimitivesAndNativeObjects ? never : {
-    [Key in keyof T]: T[Key] extends TAllowedTypes ? Key : never;
-}[keyof T];
+type DotPathsImplementation<T, TAllowedTypes = any> = T extends ReadonlyArray<infer U> ? T extends Tuple ? TuplePaths<T, TAllowedTypes> : ArrayPaths<U, TAllowedTypes> : T extends PrimitivesAndNativeObjects ? never : ObjectPaths<T, TAllowedTypes>;
 /** Literal union of all posible dot-paths which satisfy provided types as second argument (default: any). */
 type DotPaths<T, TAllowedTypes = any> = KeyOf<T, TAllowedTypes> | DotPathsImplementation<T, TAllowedTypes>;
 /**
@@ -97,7 +37,7 @@ type ReturnedValueInPath<TObject, TPath> = TPath extends '' ? TObject : TPath ex
 /** Value of a dot-path update object, can be the value or a function. */
 type UpdateValue<TObject, TPath> = ValueInPath<TObject, TPath> extends never ? never : ValueInPath<TObject, TPath> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
 /** Dot-path update object, used to give updates to the updateImmutably function. */
-type UpdateObject<TObject, TPaths extends PropertyKey = DotPaths<TObject>> = {
+type UpdateObject<TObject, TPaths extends DotPaths<TObject> = DotPaths<TObject>> = {
     [Path in TPaths]?: UpdateValue<TObject, Path>;
 };
 /**
@@ -141,6 +81,54 @@ type ExtractTypeFromDotPathUpdateObject<T extends Record<string, any>> = T exten
 /** New expanded value after aplying updates including new properties */
 type ExtendedUpdate<TObject, TDotPathUpdateObject extends Record<PropertyKey, any>> = TObject extends Array<infer U> ? ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject> extends Array<infer W> ? Array<U | W> : TObject & ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject> : TObject & ExtractTypeFromDotPathUpdateObject<TDotPathUpdateObject>;
 
+/** Index literal type to improve DX at managing updates. */
+declare const LITERAL_INDEX = "${number}";
+
+/** Primitives and browser native objects. */
+type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
+/** Tuple type, it has to have at least property "0" */
+type Tuple = ReadonlyArray<any> & {
+    "0": any;
+};
+/** Array indexes type. */
+type LiteralIndex = typeof LITERAL_INDEX;
+type ExtendedArrayIndexes = number | `${number}` | LiteralIndex;
+/** Object Literal */
+type ObjectLiteral = {
+    [x: string]: any;
+    [x: number]: any;
+    [x: symbol]: any;
+    [Symbol.iterator]?: never;
+    [Symbol.toPrimitive]?: never;
+    [Symbol.hasInstance]?: never;
+    [Symbol.unscopables]?: never;
+    [Symbol.matchAll]?: never;
+};
+/** Strict key */
+declare const strictSymbol: unique symbol;
+type Strict<T> = T extends ObjectLiteral ? T & {
+    [strictSymbol]: DotPaths<T>;
+} : T;
+/** Smart KeyOf (doesnt include the "strict" key) */
+type KeyOf<T, TAllowedValuesInKeys = any> = T extends ObjectLiteral ? T extends Strict<infer U> ? KeysOfObject<U, TAllowedValuesInKeys> : KeysOfObject<T, TAllowedValuesInKeys> : T extends Tuple ? KeysOfObject<Omit<T, keyof any[]>, TAllowedValuesInKeys> : T extends ReadonlyArray<infer U> ? U extends TAllowedValuesInKeys ? ExtendedArrayIndexes : never : never;
+type KeysOfObject<T, TAllowedValuesInKeys> = {
+    [Key in keyof T]: T[Key] extends TAllowedValuesInKeys ? Key : never;
+}[keyof T];
+
+/** Returns only the optional keys of an object. */
+type OptionalKeys<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? K : never;
+}[keyof T];
+/** Removes properties or indexes, order doesn't matter. */
+type Remove = <T extends ObjectLiteral | any[]>(value: T, keys: T extends any[] ? (number | `${number}` | (number | `${number}`)[]) : OptionalKeys<T> | (OptionalKeys<T>)[]) => T;
+/**
+ * Removes properties or indexes, order doesn't matter.
+ * @param value Object/array from where to remove keys/indexes shallowly.
+ * @param keys Keys to remove.
+ * @returns New object/array without the provided keys/indexes.
+ */
+declare const remove: Remove;
+
 type Select = {
     <T, TPath extends DotPaths<T>>(state: T, path: TPath): ReturnedValueInPath<T, TPath>;
     <T, TPath extends ''>(state: T, path: TPath): T;
@@ -171,28 +159,51 @@ type Set = <T>(newValue: T) => (v: unknown) => T;
  */
 declare const set: Set;
 
-type Iterator = typeof Symbol.iterator;
-type HasInstance = typeof Symbol.hasInstance;
-type ToPrimitive = typeof Symbol.toPrimitive;
-type Unscopables = typeof Symbol.unscopables;
-type MatchAll = typeof Symbol.matchAll;
-type NonObjectLiteralKeys = Unscopables | HasInstance | ToPrimitive | MatchAll | Iterator;
-type ObjectLiteral = Record<PropertyKey, any> & {
-    [K in NonObjectLiteralKeys]?: never;
+type OptionValues = 'error' | 'skip' | 'add';
+type Options = {
+    onNewProps?: OptionValues;
+    onNewIndexes?: OptionValues;
+    onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
+type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends DotPaths<TObject> = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
+/**
+ * Creates a new object applying immutable updates using dot-path syntax.
+ * Can add or skip new props or indexes depending on options.
+ * TYPESCRIPT: Dot-Path Update Object type must STRICTLY match the type of state.
+ * @param state Original State Object.
+ * @param dotPathUpdateObject Dot Path Update Object.
+ * @param options Options to change JS behaviour on non-existent fields.
+ * @returns New Updated Object.
+ */
+declare const update: ImmutableUpdate;
+type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject> = UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
+/**
+ * Creates a new object applying immutable updates using dot-path syntax.
+ * It will always add non-existent props or indexes if provided.
+ * TYPESCRIPT: Dot-Path Update Object type extends from the type of state and you can add new non-existent properties.
+ * @param state Original State Object.
+ * @param dotPathUpdateObject Dot Path Update Object.
+ * @returns New Updated Object.
+ */
+declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
+
+type ForEachEntry = <T extends ObjectLiteral>(object: T, callbackfn: (key: keyof T, value: T[keyof T]) => void) => void;
+declare const forEachEntry: ForEachEntry;
+
 /** Checks if any provided value is an object literal or not */
-declare const isObjectLiteral: (valueToTest: unknown) => valueToTest is ObjectLiteral;
+type IsObjectLiteral = (valueToTest: unknown) => valueToTest is ObjectLiteral;
+declare const isObjectLiteral: IsObjectLiteral;
 
-declare const parseStringIndex: (v: string) => number | null;
-declare const isStringIndex: (v: string) => v is `${number}`;
+/** Adds strict property to an object literal */
+type StrictFn = <T>(value: T) => Strict<T>;
+declare const s: StrictFn;
+/** Checks the strictness of a type passed to a function or callback without 3rd party implementation */
+type EnsureStrictness = <T extends U, U>(v: T extends U ? DotPaths<T> extends DotPaths<U> ? T : Exclude<DotPaths<T>, DotPaths<U>> : never) => U;
+declare const ensureStrictness: EnsureStrictness;
 
-type StrictCallbackError = "CALLBACK STRICTNESS RETURN ERROR: return the value using the first parameter";
-type StrictCallbackValue<T> = [StrictCallbackError, T];
-type StrictCallbackFunction<T> = (v: T) => StrictCallbackValue<T>;
-/** Apply strictness to a callback function */
-type StrictCallback<T extends (...args: any[]) => any> = (r: StrictCallbackFunction<ReturnType<T>>, ...args: Parameters<T>) => [StrictCallbackError, ReturnType<T>];
-type UnsealStrictCallback = <TCallback extends (r: StrictCallbackFunction<any>, ...args: any[]) => any>(callback: TCallback) => (...args: Parameters<TCallback> extends [infer _, ...infer RestParams] ? RestParams : never) => ReturnType<TCallback>['1'];
-/** Extract the callback from */
-declare const unsealStrictCallback: UnsealStrictCallback;
+type ParseStringIndex = (stringKey: string) => number | null;
+declare const parseStringIndex: ParseStringIndex;
+type IsStringIndex = (stringKey: string) => stringKey is `${number}`;
+declare const isStringIndex: IsStringIndex;
 
-export { type DotPaths, type KeyOf, type LiteralIndex, type ObjectLiteral, type ReturnedValueInPath, type StrictCallback, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, unsealStrictCallback, update };
+export { type DotPaths, type ExtendedArrayIndexes, type KeyOf, type LiteralIndex, type ObjectLiteral, type PrimitivesAndNativeObjects, type ReturnedValueInPath, type Strict, type Tuple, type UpdateObject, type UpdateValue, type ValueInPath, ensureStrictness, experimental_extendableUpdate, forEachEntry, isObjectLiteral, isStringIndex, parseStringIndex, remove, s, select, set, splitPathAtLastKey, update };

package/dist/index.js

@@ -1 +1 @@
-"use strict";var j=Object.defineProperty;var R=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var V=Object.prototype.hasOwnProperty;var D=(e,t)=>{for(var r in t)j(e,r,{get:t[r],enumerable:!0})},N=(e,t,r,a)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of v(t))!V.call(e,n)&&n!==r&&j(e,n,{get:()=>t[n],enumerable:!(a=R(t,n))||a.enumerable});return e};var $=e=>N(j({},"__esModule",{value:!0}),e);var F={};D(F,{experimental_extendableUpdate:()=>k,isObjectLiteral:()=>p,isStringIndex:()=>y,parseStringIndex:()=>K,remove:()=>h,select:()=>P,set:()=>S,splitPathAtLastKey:()=>L,unsealStrictCallback:()=>A,update:()=>g});module.exports=$(F);var p=e=>!!e&&Object.getPrototypeOf(e)===Object.prototype,B=Symbol();var M={[B]:[""]};var h=(e,t)=>{if(!Array.isArray(e)&&!p(e))throw'Wrong type provided in "remove" function';let r=Array.isArray(t)?t:[t];if(Array.isArray(e)){let n=Symbol(),i=[...e];return r.forEach(o=>{i[o]=n}),i.filter(o=>o!==n)}let a={...e};return r.forEach(n=>delete a[n]),a};var P=(e,t)=>{if(typeof t!="string")throw new Error("path is not a string");if(!t)return e;let r=t.split("."),a=e;for(;r.length;){let n=r.join(".");if(a?.hasOwnProperty(n))return a[n];if(!a?.hasOwnProperty(r[0]))return;a=a[r[0]],r.shift()}return a};var L=e=>{if(typeof e!="string")throw new Error(`Wrong dotPath type: ${e}`);let t=e.lastIndexOf(".")+1,r=t?e.slice(0,t-1):"",a=e.slice(t);return[r,a]};var S=e=>()=>e;var K=e=>{let t=parseInt(e);return t.toString()===e?t:null},y=e=>parseInt(e).toString()===e;var w=e=>JSON.stringify(e),x=e=>Array.isArray(e),E=(e,t,r={})=>{if(!p(e)&&!x(e))throw new Error(`"${w(e)}" is not an literalObject/array`);if(!p(t))throw new Error('wrong "updateObject" type provided');let a=Array.isArray(e)?[...e]:{...e},n={};for(let[i,f]of Object.entries(t)){if(i==="")continue;let o=i.split("."),d=n,l=a;for(;o.length>1;){let m=o.join(".");if(Object.hasOwn(l,m)){o=[m];break}let s=o[0],u=l[s],T=p(u),O=x(u);if(!T&&!O&&!(u===void 0)){if(r.onPathsIntersectedByPrimitiveValues==="error")throw new Error(`Property "${s}" in "${i}" is a primitive`);if(r.onPathsIntersectedByPrimitiveValues==="skip")continue}if(!d[s]){if(!T&&!O){let U=x(l)&&y(s),C=y(o[1]),I=U?r.onNewIndexes:r.onNewProps;if(I==="error")throw new Error(`${s} doesn't exist in "${i}"`);if(I==="skip")continue;l[s]=C?[]:{}}else l[s]=O?[...u]:{...u};d[s]={}}l=l[s],d=d[s],o.shift()}let c=o[0],b=l;if(!Object.hasOwn(b,c)){let s=x(b)&&y(c)?r.onNewIndexes:r.onNewProps;if(s==="error")throw new Error(`Property/Index "${c}" doesnt exist in the path "${i}". Its value is: "${w(b)}"`);if(s==="skip")continue}b[c]=typeof f=="function"?f(b[c]):f,delete d[c]}return a},g=(e,t,r)=>E(e,t,r),k=(e,t)=>E(e,t);var A=e=>(...t)=>e(r=>r,...t);0&&(module.exports={experimental_extendableUpdate,isObjectLiteral,isStringIndex,parseStringIndex,remove,select,set,splitPathAtLastKey,unsealStrictCallback,update});
+"use strict";var m=Object.defineProperty;var $=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var C=Object.prototype.hasOwnProperty;var N=(e,t)=>{for(var r in t)m(e,r,{get:t[r],enumerable:!0})},F=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of R(t))!C.call(e,s)&&s!==r&&m(e,s,{get:()=>t[s],enumerable:!(n=$(t,s))||n.enumerable});return e};var B=e=>F(m({},"__esModule",{value:!0}),e);var q={};N(q,{ensureStrictness:()=>D,experimental_extendableUpdate:()=>U,forEachEntry:()=>A,isObjectLiteral:()=>l,isStringIndex:()=>y,parseStringIndex:()=>g,remove:()=>I,s:()=>v,select:()=>L,set:()=>E,splitPathAtLastKey:()=>P,update:()=>S});module.exports=B(q);var l=e=>!!e&&Object.getPrototypeOf(e)===Object.prototype,W=Symbol();var _={[W]:[""]};var I=(e,t)=>{if(!Array.isArray(e)&&!l(e))throw'Wrong type provided in "remove" function';let r=Array.isArray(t)?t:[t];if(Array.isArray(e)){let s=Symbol(),o=[...e];return r.forEach(i=>{o[i]=s}),o.filter(i=>i!==s)}let n={...e};return r.forEach(s=>delete n[s]),n};var L=(e,t)=>{if(typeof t!="string")throw new Error("path is not a string");if(!t)return e;let r=t.split("."),n=e;for(;r.length;){let s=r[0],o=r.join(".");if(Object.hasOwn(n,o))return n[o];if(!Object.hasOwn(n,s))return;n=n[s],r.shift()}return n};var P=e=>{if(typeof e!="string")throw new Error(`Wrong dotPath type: ${e}`);let t=e.lastIndexOf(".")+1,r=t?e.slice(0,t-1):"",n=e.slice(t);return[r,n]};var E=e=>()=>e;var g=e=>{let t=parseInt(e);return t.toString()===e?t:null},y=e=>parseInt(e).toString()===e;var w=e=>JSON.stringify(e),f=e=>Array.isArray(e),K=(e,t,r={})=>{if(!l(e)&&!f(e))throw new Error(`"${w(e)}" is not an literalObject/array`);if(!l(t))throw new Error('wrong "updateObject" type provided');let n=Array.isArray(e)?[...e]:{...e},s={};for(let[o,x]of Object.entries(t)){if(o==="")continue;let i=o.split("."),d=s,p=n;for(;i.length>1;){let O=i.join(".");if(Object.hasOwn(p,O)){i=[O];break}let a=i[0],b=p[a],T=l(b),j=f(b);if(!T&&!j&&!(b===void 0)){if(r.onPathsIntersectedByPrimitiveValues==="error")throw new Error(`Property "${a}" in "${o}" is a primitive`);if(r.onPathsIntersectedByPrimitiveValues==="skip")continue}if(!d[a]){if(!T&&!j){let k=f(p)&&y(a),V=y(i[1]),h=k?r.onNewIndexes:r.onNewProps;if(h==="error")throw new Error(`${a} doesn't exist in "${o}"`);if(h==="skip")continue;p[a]=V?[]:{}}else p[a]=j?[...b]:{...b};d[a]={}}p=p[a],d=d[a],i.shift()}let c=i[0],u=p;if(!Object.hasOwn(u,c)){let a=f(u)&&y(c)?r.onNewIndexes:r.onNewProps;if(a==="error")throw new Error(`Property/Index "${c}" doesnt exist in the path "${o}". Its value is: "${w(u)}"`);if(a==="skip")continue}u[c]=typeof x=="function"?x(u[c]):x,delete d[c]}return n},S=(e,t,r)=>K(e,t,r),U=(e,t)=>K(e,t);var A=(e,t)=>Object.keys(e).forEach(r=>t(r,e[r]));var v=e=>e,D=e=>e;0&&(module.exports={ensureStrictness,experimental_extendableUpdate,forEachEntry,isObjectLiteral,isStringIndex,parseStringIndex,remove,s,select,set,splitPathAtLastKey,update});

package/dist/index.mjs

@@ -1 +1 @@
-var p=e=>!!e&&Object.getPrototypeOf(e)===Object.prototype,S=Symbol();var v={[S]:[""]};var K=(e,t)=>{if(!Array.isArray(e)&&!p(e))throw'Wrong type provided in "remove" function';let r=Array.isArray(t)?t:[t];if(Array.isArray(e)){let o=Symbol(),i=[...e];return r.forEach(s=>{i[s]=o}),i.filter(s=>s!==o)}let a={...e};return r.forEach(o=>delete a[o]),a};var w=(e,t)=>{if(typeof t!="string")throw new Error("path is not a string");if(!t)return e;let r=t.split("."),a=e;for(;r.length;){let o=r.join(".");if(a?.hasOwnProperty(o))return a[o];if(!a?.hasOwnProperty(r[0]))return;a=a[r[0]],r.shift()}return a};var E=e=>{if(typeof e!="string")throw new Error(`Wrong dotPath type: ${e}`);let t=e.lastIndexOf(".")+1,r=t?e.slice(0,t-1):"",a=e.slice(t);return[r,a]};var g=e=>()=>e;var k=e=>{let t=parseInt(e);return t.toString()===e?t:null},u=e=>parseInt(e).toString()===e;var I=e=>JSON.stringify(e),x=e=>Array.isArray(e),h=(e,t,r={})=>{if(!p(e)&&!x(e))throw new Error(`"${I(e)}" is not an literalObject/array`);if(!p(t))throw new Error('wrong "updateObject" type provided');let a=Array.isArray(e)?[...e]:{...e},o={};for(let[i,f]of Object.entries(t)){if(i==="")continue;let s=i.split("."),y=o,l=a;for(;s.length>1;){let m=s.join(".");if(Object.hasOwn(l,m)){s=[m];break}let n=s[0],b=l[n],j=p(b),O=x(b);if(!j&&!O&&!(b===void 0)){if(r.onPathsIntersectedByPrimitiveValues==="error")throw new Error(`Property "${n}" in "${i}" is a primitive`);if(r.onPathsIntersectedByPrimitiveValues==="skip")continue}if(!y[n]){if(!j&&!O){let P=x(l)&&u(n),L=u(s[1]),T=P?r.onNewIndexes:r.onNewProps;if(T==="error")throw new Error(`${n} doesn't exist in "${i}"`);if(T==="skip")continue;l[n]=L?[]:{}}else l[n]=O?[...b]:{...b};y[n]={}}l=l[n],y=y[n],s.shift()}let c=s[0],d=l;if(!Object.hasOwn(d,c)){let n=x(d)&&u(c)?r.onNewIndexes:r.onNewProps;if(n==="error")throw new Error(`Property/Index "${c}" doesnt exist in the path "${i}". Its value is: "${I(d)}"`);if(n==="skip")continue}d[c]=typeof f=="function"?f(d[c]):f,delete y[c]}return a},A=(e,t,r)=>h(e,t,r),U=(e,t)=>h(e,t);var C=e=>(...t)=>e(r=>r,...t);export{U as experimental_extendableUpdate,p as isObjectLiteral,u as isStringIndex,k as parseStringIndex,K as remove,w as select,g as set,E as splitPathAtLastKey,C as unsealStrictCallback,A as update};
+var l=e=>!!e&&Object.getPrototypeOf(e)===Object.prototype,E=Symbol();var R={[E]:[""]};var g=(e,t)=>{if(!Array.isArray(e)&&!l(e))throw'Wrong type provided in "remove" function';let r=Array.isArray(t)?t:[t];if(Array.isArray(e)){let i=Symbol(),a=[...e];return r.forEach(o=>{a[o]=i}),a.filter(o=>o!==i)}let n={...e};return r.forEach(i=>delete n[i]),n};var w=(e,t)=>{if(typeof t!="string")throw new Error("path is not a string");if(!t)return e;let r=t.split("."),n=e;for(;r.length;){let i=r[0],a=r.join(".");if(Object.hasOwn(n,a))return n[a];if(!Object.hasOwn(n,i))return;n=n[i],r.shift()}return n};var K=e=>{if(typeof e!="string")throw new Error(`Wrong dotPath type: ${e}`);let t=e.lastIndexOf(".")+1,r=t?e.slice(0,t-1):"",n=e.slice(t);return[r,n]};var S=e=>()=>e;var U=e=>{let t=parseInt(e);return t.toString()===e?t:null},b=e=>parseInt(e).toString()===e;var h=e=>JSON.stringify(e),f=e=>Array.isArray(e),I=(e,t,r={})=>{if(!l(e)&&!f(e))throw new Error(`"${h(e)}" is not an literalObject/array`);if(!l(t))throw new Error('wrong "updateObject" type provided');let n=Array.isArray(e)?[...e]:{...e},i={};for(let[a,x]of Object.entries(t)){if(a==="")continue;let o=a.split("."),y=i,p=n;for(;o.length>1;){let O=o.join(".");if(Object.hasOwn(p,O)){o=[O];break}let s=o[0],u=p[s],m=l(u),j=f(u);if(!m&&!j&&!(u===void 0)){if(r.onPathsIntersectedByPrimitiveValues==="error")throw new Error(`Property "${s}" in "${a}" is a primitive`);if(r.onPathsIntersectedByPrimitiveValues==="skip")continue}if(!y[s]){if(!m&&!j){let L=f(p)&&b(s),P=b(o[1]),T=L?r.onNewIndexes:r.onNewProps;if(T==="error")throw new Error(`${s} doesn't exist in "${a}"`);if(T==="skip")continue;p[s]=P?[]:{}}else p[s]=j?[...u]:{...u};y[s]={}}p=p[s],y=y[s],o.shift()}let c=o[0],d=p;if(!Object.hasOwn(d,c)){let s=f(d)&&b(c)?r.onNewIndexes:r.onNewProps;if(s==="error")throw new Error(`Property/Index "${c}" doesnt exist in the path "${a}". Its value is: "${h(d)}"`);if(s==="skip")continue}d[c]=typeof x=="function"?x(d[c]):x,delete y[c]}return n},A=(e,t,r)=>I(e,t,r),v=(e,t)=>I(e,t);var D=(e,t)=>Object.keys(e).forEach(r=>t(r,e[r]));var k=e=>e,V=e=>e;export{V as ensureStrictness,v as experimental_extendableUpdate,D as forEachEntry,l as isObjectLiteral,b as isStringIndex,U as parseStringIndex,g as remove,k as s,w as select,S as set,K as splitPathAtLastKey,A as update};

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "maraj",
-   "version": "2.8.4",
+   "version": "2.9.0",
    "description": "A lightweight 600 bytes gzipped alternative for immutable updates while dealing with objects and arrays",
    "keywords": [
       "shallow",