maraj 2.8.0 → 2.8.2

package/dist/index.d.mts

@@ -21,7 +21,7 @@ type Options = {
     onNewIndexes?: OptionValues;
     onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
-type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
+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.
@@ -32,7 +32,7 @@ type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = DotPa
  * @returns New Updated Object.
  */
 declare const update: ImmutableUpdate;
-type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
+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.
@@ -171,15 +171,26 @@ type Set = <T>(newValue: T) => (v: unknown) => T;
  */
 declare const set: Set;
 
+type HasInstance = typeof Symbol.hasInstance;
+type ToPrimitive = typeof Symbol.toPrimitive;
+type Unscopables = typeof Symbol.unscopables;
+type NonObjectLiteralKeys = Unscopables | HasInstance | ToPrimitive;
+type ObjectLiteral = Record<PropertyKey, any> & {
+    [K in NonObjectLiteralKeys]?: never;
+};
 /** Checks if any provided value is an object literal or not */
-declare const isObjectLiteral: (valueToTest: any) => boolean;
+declare const isObjectLiteral: (valueToTest: unknown) => valueToTest is ObjectLiteral;
 
 declare const parseStringIndex: (v: string) => number | null;
-declare const isStringIndex: (v: string) => boolean;
+declare const isStringIndex: (v: string) => v is `${number}`;
 
-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"];
+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;
 
-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 };
+export { type DotPaths, type KeyOf, type LiteralIndex, type ReturnedValueInPath, type StrictCallback, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, unsealStrictCallback, update };

package/dist/index.d.ts

@@ -21,7 +21,7 @@ type Options = {
     onNewIndexes?: OptionValues;
     onPathsIntersectedByPrimitiveValues?: OptionValues;
 };
-type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = DotPaths<TObject>>(state: TObject, dotPathUpdateObject: UpdateObject<TObject, TAllowedDotPathKeys>, options?: Options) => TObject;
+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.
@@ -32,7 +32,7 @@ type ImmutableUpdate = <TObject, TAllowedDotPathKeys extends PropertyKey = DotPa
  * @returns New Updated Object.
  */
 declare const update: ImmutableUpdate;
-type ExtendableImmutableUpdate = <TObject, TUpdateObject extends UpdateObject<TObject>>(state: TObject, dotPathUpdateObject: TUpdateObject) => ExtendedUpdate<TObject, TUpdateObject>;
+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.
@@ -171,15 +171,26 @@ type Set = <T>(newValue: T) => (v: unknown) => T;
  */
 declare const set: Set;
 
+type HasInstance = typeof Symbol.hasInstance;
+type ToPrimitive = typeof Symbol.toPrimitive;
+type Unscopables = typeof Symbol.unscopables;
+type NonObjectLiteralKeys = Unscopables | HasInstance | ToPrimitive;
+type ObjectLiteral = Record<PropertyKey, any> & {
+    [K in NonObjectLiteralKeys]?: never;
+};
 /** Checks if any provided value is an object literal or not */
-declare const isObjectLiteral: (valueToTest: any) => boolean;
+declare const isObjectLiteral: (valueToTest: unknown) => valueToTest is ObjectLiteral;
 
 declare const parseStringIndex: (v: string) => number | null;
-declare const isStringIndex: (v: string) => boolean;
+declare const isStringIndex: (v: string) => v is `${number}`;
 
-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"];
+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;
 
-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 };
+export { type DotPaths, type KeyOf, type LiteralIndex, type ReturnedValueInPath, type StrictCallback, type UpdateObject, type UpdateValue, type ValueInPath, experimental_extendableUpdate, isObjectLiteral, isStringIndex, parseStringIndex, remove, select, set, splitPathAtLastKey, unsealStrictCallback, update };

package/dist/index.js

@@ -1 +1 @@
-"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});
+"use strict";var O=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var V=Object.prototype.hasOwnProperty;var D=(e,t)=>{for(var r in t)O(e,r,{get:t[r],enumerable:!0})},N=(e,t,r,a)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of R(t))!V.call(e,n)&&n!==r&&O(e,n,{get:()=>t[n],enumerable:!(a=v(t,n))||a.enumerable});return e};var $=e=>N(O({},"__esModule",{value:!0}),e);var F={};D(F,{experimental_extendableUpdate:()=>U,isObjectLiteral:()=>c,isStringIndex:()=>y,parseStringIndex:()=>K,remove:()=>I,select:()=>P,set:()=>S,splitPathAtLastKey:()=>L,unsealStrictCallback:()=>g,update:()=>k});module.exports=$(F);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 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 c=e=>!!e&&Object.getPrototypeOf(e)===Object.prototype,B=Symbol();var z={[B]:[""]};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(!c(e)&&!x(e))throw new Error(`"${w(e)}" is not an literalObject/array`);if(!c(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],b=l[s],h=c(b),T=x(b);if(!h&&!T&&!(b===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(!h&&!T){let C=x(l)&&y(s),A=y(o[1]),j=C?r.onNewIndexes:r.onNewProps;if(j==="error")throw new Error(`${s} doesn't exist in "${i}"`);if(j==="skip")continue;l[s]=A?[]:{}}else l[s]=T?[...b]:{...b};d[s]={}}l=l[s],d=d[s],o.shift()}let p=o[0],u=l;if(!Object.hasOwn(u,p)){let s=x(u)&&y(p)?r.onNewIndexes:r.onNewProps;if(s==="error")throw new Error(`Property/Index "${p}" doesnt exist in the path "${i}". Its value is: "${w(u)}"`);if(s==="skip")continue}u[p]=typeof f=="function"?f(u[p]):f,delete d[p]}return a},k=(e,t,r)=>E(e,t,r),U=(e,t)=>E(e,t);var g=e=>(...t)=>e(r=>r,...t);0&&(module.exports={experimental_extendableUpdate,isObjectLiteral,isStringIndex,parseStringIndex,remove,select,set,splitPathAtLastKey,unsealStrictCallback,update});

package/dist/index.mjs

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

package/package.json

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