maraj 2.7.2 → 2.8.0

package/README.md

@@ -41,6 +41,8 @@ originalValue.files[1] === newValue.files[1] // true
   - { a: { b: {"c.d": ... } } }
   - { a: { b: {"c": { d: ... } } } }
 
+  It can still work with dot-paths keys containing an object or array, however the paths targeting nested properties in this key are forbiden. For example having the following object { a: { "b.c": { d: ... } } } you can use the path "a" and "a.b.c", but you cant use "a.b.c.d", this path will create a new property "b" inside "a", then "c" and lastly "d" resulting in the following object { a: { "b.c": { d: ... } }, b: { c: { d: ... } } }
+
 - In "extendableUpdate", **numbers** inside path will **always** create a mutable **array** if the array/object doesnt exist beforehand. If you want an object/tuple/readonlyArray instead of an array, add it beforehand as type.
 
 ```ts
@@ -57,22 +59,27 @@ const updatedValue2 = extendableUpdate({}, {
 // updatedValue2 = { files: { '1': { name: 'new name' } } }
 ```
 
-- The type "UpdateDotPathObject" (the type of the object provided containing the updates, the one used as second parameter in the update function) if used to create new update objects using computed properties { [key]: value } (middlewares for example) will always throw a ts error even if the typing is correct. [Playground simple explanation](https://www.typescriptlang.org/play?ts=5.3.2#code/LAKALgngDgpgBAGQJYGcxwLxwOQENtwA+cABgCQDeAdgK4C2ARjAE4C+JooksiqYASjADGAe2YATTHApwA2gGk4SKrzQBdAPwAuOItacQoqmjhDmMXGBiDREqQB4AKnBgAPK1XEpVYAHwAKAGsYCB1HAEpMX2lQODijE3MhHWQ0GzFJLApYuNyAejy4AD0wbxZmMR0UZSF4ADcAFgA6AGYmgFYldAB3JAAbPrgwAAsK7rhcFXKxCfQhYeFA5QBzUxE6KBorSWCIb0nJOtw+mhhvGmqqVasNvst4PqQrZmOyupgVJAAzIYWh6BWSm8tiSYByuTkuzUOl24P0IFy5jANGYKiSoFYQA)
+- The type "UpdateObject" (the type of the object provided containing the updates, used as second parameter in the update function) if used to create new update objects using computed properties in a inline syntax { [key]: value } will always throw a ts error even if the typing is correct, use the second syntax.
 
 ```ts
-const updateFieldStore = <TPath extends DotPaths<Store>>(
+const updateFieldStore = <T, TPath extends DotPaths<T>>(
+   state: T,
    path: TPath,
-   newValue: UpdateDotPathValue<Store, TPath>
+   newValue: UpdateValue<T, TPath>
 ) => {
-   const update: UpdateDotPathObject<Store> = {
-      // ^throws ts error even if the typing is correct
+   // ts error even if the typing is correct (typescript issue)
+   const updateObject1: UpdateObject<T> = {
       [path]: newValue
-   } // fix: coherce it with " as UpdateDotPathObject<Store>"
-   return update
+   }
+
+   // All good, no ts error
+   const updateObject2: UpdateObject<T> = {}
+   updateObject[path] = newValue
+   
 }
 ```
 
-- Use the "set" utility if typescript doesn't infer properly _"an optional field"_ vs a _"field which can have 'undefined' as type"_. Usually happens in optional nested props inside arrays.
+- Use the "set" utility if typescript doesn't infer properly *"an optional field"* vs a *"field which can have 'undefined' as type"*. Usually happens in nested props inside arrays.
 
 ```ts
 const updatedValue = update(data, {

package/dist/index.d.mts

@@ -21,7 +21,7 @@ type Options = {
     onNewIndexes?: OptionValues;
     onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
-type ImmutableUpdate = <TObject>(state: TObject, dotPathUpdateObject: UpdateObject<TObject>, options?: Options) => TObject;
+type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = 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.
@@ -41,7 +41,7 @@ type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TO
  * @param dotPathUpdateObject Dot Path Update Object.
  * @returns New Updated Object.
  */
-declare const extendableUpdate: ExtendableImmutableUpdate;
+declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
 
 /**
  * --------------------------------------------
@@ -51,7 +51,7 @@ declare const extendableUpdate: ExtendableImmutableUpdate;
 /** Primitives and browser native objects. */
 type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
 /** Array indexes type. */
-type ArrayIndexes = number | LiteralIndex;
+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;
 /**
@@ -60,15 +60,21 @@ type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false
  * --------------------------------------------
  */
 /** Dot-paths of an array. */
-type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? number | `${ArrayIndexes}` : number | `${ArrayIndexes}` | `${ArrayIndexes}.${DotPaths<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${DotPaths<TInnerType, TAllowedTypes>}`;
+type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ArrayIndexes : ArrayIndexes | `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${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}.${DotPaths<T[Key], TAllowedTypes>}` : `${Key}.${DotPaths<T[Key], TAllowedTypes>}`;
-}[keyof T & (string | number)];
+    [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;
 /** Dot-paths of a tuple. */
-type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes>;
+type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & unknown;
+/** 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];
 /** Literal union of all posible dot-paths which satisfy provided types as second argument (default: any). */
-type DotPaths<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>;
+type DotPaths<T, TAllowedTypes = any> = KeyOf<T, TAllowedTypes> | DotPathsImplementation<T, TAllowedTypes>;
 /**
  * --------------------------------------------
  *  VALUE OF A NESTED PROPERTY PROVIDING A DOT PATH
@@ -89,10 +95,10 @@ 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> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
+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>> = {
-    [TPath in TPaths]?: ValueInPath<TObject, TPath> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
+    [Path in TPaths]?: UpdateValue<TObject, Path>;
 };
 /**
  * --------------------------------------------
@@ -133,7 +139,7 @@ type ExtractTypeFromDotPathUpdateObject<T extends Record<string, any>> = T exten
     }>;
 } & unknown;
 /** 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> : ExtractTypeFromDotPathUpdateObject<TObject & TDotPathUpdateObject>;
+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>;
 
 type Select = {
     <T, TPath extends DotPaths<T>>(state: T, path: TPath): ReturnedValueInPath<T, TPath>;
@@ -171,4 +177,9 @@ declare const isObjectLiteral: (valueToTest: any) => boolean;
 declare const parseStringIndex: (v: string) => number | null;
 declare const isStringIndex: (v: string) => boolean;
 
-export { type DotPaths, type LiteralIndex, type ReturnedValueInPath, type UpdateObject, type UpdateValue, type ValueInPath, extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, update };
+type StrictCallback<T> = (v: T) => [T, 'STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function'];
+type StrictCallbackReturn<T> = [T, 'STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function'] & unknown;
+/** Parameter allowing to strictly check types for callback functions as arguments. It returns a tuple where the first index is the value you want as return type. */
+declare const strictCallback: <T>(v: T) => [T, "STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function"];
+
+export { type DotPaths, type KeyOf, type LiteralIndex, type ReturnedValueInPath, type StrictCallback, type StrictCallbackReturn, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, strictCallback, update };

package/dist/index.d.ts

@@ -21,7 +21,7 @@ type Options = {
     onNewIndexes?: OptionValues;
     onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
-type ImmutableUpdate = <TObject>(state: TObject, dotPathUpdateObject: UpdateObject<TObject>, options?: Options) => TObject;
+type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = 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.
@@ -41,7 +41,7 @@ type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TO
  * @param dotPathUpdateObject Dot Path Update Object.
  * @returns New Updated Object.
  */
-declare const extendableUpdate: ExtendableImmutableUpdate;
+declare const experimental_extendableUpdate: ExtendableImmutableUpdate;
 
 /**
  * --------------------------------------------
@@ -51,7 +51,7 @@ declare const extendableUpdate: ExtendableImmutableUpdate;
 /** Primitives and browser native objects. */
 type PrimitivesAndNativeObjects = null | undefined | string | number | boolean | symbol | bigint | Date | FileList | File;
 /** Array indexes type. */
-type ArrayIndexes = number | LiteralIndex;
+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;
 /**
@@ -60,15 +60,21 @@ type IsTuple<T extends ReadonlyArray<any>> = number extends T['length'] ? false
  * --------------------------------------------
  */
 /** Dot-paths of an array. */
-type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? number | `${ArrayIndexes}` : number | `${ArrayIndexes}` | `${ArrayIndexes}.${DotPaths<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${DotPaths<TInnerType, TAllowedTypes>}`;
+type ArrayPaths<TInnerType, TAllowedTypes> = TInnerType extends TAllowedTypes ? TInnerType extends PrimitivesAndNativeObjects ? ArrayIndexes : ArrayIndexes | `${ArrayIndexes}.${DotPathsImplementation<TInnerType, TAllowedTypes>}` : `${ArrayIndexes}.${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}.${DotPaths<T[Key], TAllowedTypes>}` : `${Key}.${DotPaths<T[Key], TAllowedTypes>}`;
-}[keyof T & (string | number)];
+    [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;
 /** Dot-paths of a tuple. */
-type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes>;
+type TuplePaths<T, TAllowedTypes> = ObjectPaths<Omit<T, keyof any[]>, TAllowedTypes> & unknown;
+/** 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];
 /** Literal union of all posible dot-paths which satisfy provided types as second argument (default: any). */
-type DotPaths<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>;
+type DotPaths<T, TAllowedTypes = any> = KeyOf<T, TAllowedTypes> | DotPathsImplementation<T, TAllowedTypes>;
 /**
  * --------------------------------------------
  *  VALUE OF A NESTED PROPERTY PROVIDING A DOT PATH
@@ -89,10 +95,10 @@ 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> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
+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>> = {
-    [TPath in TPaths]?: ValueInPath<TObject, TPath> | ((fieldValue: ValueInPath<TObject, TPath>) => ValueInPath<TObject, TPath>);
+    [Path in TPaths]?: UpdateValue<TObject, Path>;
 };
 /**
  * --------------------------------------------
@@ -133,7 +139,7 @@ type ExtractTypeFromDotPathUpdateObject<T extends Record<string, any>> = T exten
     }>;
 } & unknown;
 /** 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> : ExtractTypeFromDotPathUpdateObject<TObject & TDotPathUpdateObject>;
+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>;
 
 type Select = {
     <T, TPath extends DotPaths<T>>(state: T, path: TPath): ReturnedValueInPath<T, TPath>;
@@ -171,4 +177,9 @@ declare const isObjectLiteral: (valueToTest: any) => boolean;
 declare const parseStringIndex: (v: string) => number | null;
 declare const isStringIndex: (v: string) => boolean;
 
-export { type DotPaths, type LiteralIndex, type ReturnedValueInPath, type UpdateObject, type UpdateValue, type ValueInPath, extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, update };
+type StrictCallback<T> = (v: T) => [T, 'STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function'];
+type StrictCallbackReturn<T> = [T, 'STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function'] & unknown;
+/** Parameter allowing to strictly check types for callback functions as arguments. It returns a tuple where the first index is the value you want as return type. */
+declare const strictCallback: <T>(v: T) => [T, "STRICTNESS RETURN ERROR: wrap the return value with the first parameter of the callback function"];
+
+export { type DotPaths, type KeyOf, type LiteralIndex, type ReturnedValueInPath, type StrictCallback, type StrictCallbackReturn, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, strictCallback, update };

package/dist/index.js

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

package/dist/index.mjs

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

package/package.json

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