@rimbu/deep 0.10.0 → 0.10.1

package/README.md

@@ -84,7 +84,7 @@ console.log(
 
 ## Contributing
 
-Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](../../CONTRIBUTING.md).
+Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
 
 ## Contributors
 

package/dist/main/path.js

@@ -59,8 +59,9 @@ var Path;
         try {
             for (var items_2 = tslib_1.__values(items), items_2_1 = items_2.next(); !items_2_1.done; items_2_1 = items_2.next()) {
                 var item = items_2_1.value;
-                current[item] = {};
-                current = current[item];
+                var next = {};
+                current[item] = (0, internal_1.patchNested)(next);
+                current = next;
             }
         }
         catch (e_2_1) { e_2 = { error: e_2_1 }; }

package/dist/main/path.js.map

@@ -1 +1 @@
-{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":";;;;AAGA,uCAAmC;AAcnC,IAAiB,IAAI,CAqFpB;AArFD,WAAiB,IAAI;IAwBnB;;;;;;;;;;;;;OAaG;IACH,SAAgB,GAAG,CACjB,MAAuB,EACvB,IAAO;;QAEP,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;;YAEzB,KAAmB,IAAA,UAAA,iBAAA,KAAK,CAAA,4BAAA,+CAAE;gBAArB,IAAM,IAAI,kBAAA;gBACb,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;aACvB;;;;;;;;;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,QAAG,MAalB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CACpB,MAAuB,EACvB,IAAO,EACP,KAAgC;;QAEhC,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,IAAM,IAAI,GAAwB,EAAE,CAAC;QAErC,IAAI,OAAO,GAAG,IAAI,CAAC;;YAEnB,KAAmB,IAAA,UAAA,iBAAA,KAAK,CAAA,4BAAA,+CAAE;gBAArB,IAAM,IAAI,kBAAA;gBACb,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACnB,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;aACzB;;;;;;;;;QAED,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,IAAA,gBAAK,EAAI,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IApBe,WAAM,SAoBrB,CAAA;AACH,CAAC,EArFgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAqFpB"}
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":";;;;AAGA,uCAAgD;AAchD,IAAiB,IAAI,CAsFpB;AAtFD,WAAiB,IAAI;IAwBnB;;;;;;;;;;;;;OAaG;IACH,SAAgB,GAAG,CACjB,MAAuB,EACvB,IAAO;;QAEP,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;;YAEzB,KAAmB,IAAA,UAAA,iBAAA,KAAK,CAAA,4BAAA,+CAAE;gBAArB,IAAM,IAAI,kBAAA;gBACb,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;aACvB;;;;;;;;;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,QAAG,MAalB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CACpB,MAAuB,EACvB,IAAO,EACP,KAAgC;;QAEhC,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,IAAM,IAAI,GAAwB,EAAE,CAAC;QAErC,IAAI,OAAO,GAAG,IAAI,CAAC;;YAEnB,KAAmB,IAAA,UAAA,iBAAA,KAAK,CAAA,4BAAA,+CAAE;gBAArB,IAAM,IAAI,kBAAA;gBACb,IAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,OAAO,CAAC,IAAI,CAAC,GAAG,IAAA,sBAAW,EAAC,IAAI,CAAC,CAAC;gBAClC,OAAO,GAAG,IAAI,CAAC;aAChB;;;;;;;;;QAED,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,IAAA,gBAAK,EAAI,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IArBe,WAAM,SAqBrB,CAAA;AACH,CAAC,EAtFgB,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAsFpB"}

package/dist/main/protected.js

@@ -2,8 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Protected = void 0;
 /**
- * Returns the same value wrapped in the Protected type
+ * Returns the same value wrapped in the `Protected` type.
  * @param value - the value to wrap
+ * @note does not perform any runtime protection, it is only a utility to easily add the `Protected`
+ * type to a value
+ * @example
+ * ```ts
+ * const obj = Protected({ a: 1, b: { c: true, d: [1] } })
+ * obj.a = 2        // compiler error: a is readonly
+ * obj.b.c = false  // compiler error: c is readonly
+ * obj.b.d.push(2)  // compiler error: d is a readonly array
+ * (obj as any).b.d.push(2)  // will actually mutate the object
+ * ```
+
+ * '
  */
 function Protected(value) {
     return value;

package/dist/main/protected.js.map

@@ -1 +1 @@
-{"version":3,"file":"protected.js","sourceRoot":"","sources":["../../src/protected.ts"],"names":[],"mappings":";;;AAkBA;;;GAGG;AACH,SAAgB,SAAS,CAAI,KAAQ;IACnC,OAAO,KAAY,CAAC;AACtB,CAAC;AAFD,8BAEC"}
+{"version":3,"file":"protected.js","sourceRoot":"","sources":["../../src/protected.ts"],"names":[],"mappings":";;;AA2BA;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,SAAS,CAAI,KAAQ;IACnC,OAAO,KAAY,CAAC;AACtB,CAAC;AAFD,8BAEC"}

package/dist/module/path.js

@@ -1,4 +1,4 @@
-import { patch } from './internal';
+import { patch, patchNested } from './internal';
 export var Path;
 (function (Path) {
     /**
@@ -41,8 +41,9 @@ export var Path;
         const root = {};
         let current = root;
         for (const item of items) {
-            current[item] = {};
-            current = current[item];
+            const next = {};
+            current[item] = patchNested(next);
+            current = next;
         }
         current[last] = value;
         return patch(source, root);

package/dist/module/path.js.map

@@ -1 +1 @@
-{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAcnC,MAAM,KAAW,IAAI,CAqFpB;AArFD,WAAiB,IAAI;IAwBnB;;;;;;;;;;;;;OAaG;IACH,SAAgB,GAAG,CACjB,MAAuB,EACvB,IAAO;QAEP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;QAEzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,QAAG,MAalB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CACpB,MAAuB,EACvB,IAAO,EACP,KAAgC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,MAAM,IAAI,GAAwB,EAAE,CAAC;QAErC,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACnB,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;SACzB;QAED,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,KAAK,CAAI,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IApBe,WAAM,SAoBrB,CAAA;AACH,CAAC,EArFgB,IAAI,KAAJ,IAAI,QAqFpB"}
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAchD,MAAM,KAAW,IAAI,CAsFpB;AAtFD,WAAiB,IAAI;IAwBnB;;;;;;;;;;;;;OAaG;IACH,SAAgB,GAAG,CACjB,MAAuB,EACvB,IAAO;QAEP,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,MAAM,GAAQ,MAAM,CAAC;QAEzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;SACvB;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAbe,QAAG,MAalB,CAAA;IAED;;;;;;;;;;OAUG;IACH,SAAgB,MAAM,CACpB,MAAuB,EACvB,IAAO,EACP,KAAgC;QAEhC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAE1B,MAAM,IAAI,GAAwB,EAAE,CAAC;QAErC,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,OAAO,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;YAClC,OAAO,GAAG,IAAI,CAAC;SAChB;QAED,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAEtB,OAAO,KAAK,CAAI,MAAM,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IArBe,WAAM,SAqBrB,CAAA;AACH,CAAC,EAtFgB,IAAI,KAAJ,IAAI,QAsFpB"}

package/dist/module/protected.js

@@ -1,6 +1,18 @@
 /**
- * Returns the same value wrapped in the Protected type
+ * Returns the same value wrapped in the `Protected` type.
  * @param value - the value to wrap
+ * @note does not perform any runtime protection, it is only a utility to easily add the `Protected`
+ * type to a value
+ * @example
+ * ```ts
+ * const obj = Protected({ a: 1, b: { c: true, d: [1] } })
+ * obj.a = 2        // compiler error: a is readonly
+ * obj.b.c = false  // compiler error: c is readonly
+ * obj.b.d.push(2)  // compiler error: d is a readonly array
+ * (obj as any).b.d.push(2)  // will actually mutate the object
+ * ```
+
+ * '
  */
 export function Protected(value) {
     return value;

package/dist/module/protected.js.map

@@ -1 +1 @@
-{"version":3,"file":"protected.js","sourceRoot":"","sources":["../../src/protected.ts"],"names":[],"mappings":"AAkBA;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAI,KAAQ;IACnC,OAAO,KAAY,CAAC;AACtB,CAAC"}
+{"version":3,"file":"protected.js","sourceRoot":"","sources":["../../src/protected.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,SAAS,CAAI,KAAQ;IACnC,OAAO,KAAY,CAAC;AACtB,CAAC"}

package/dist/types/protected.d.ts

@@ -1,13 +1,34 @@
-import type { IsPlainObj } from '@rimbu/base';
+import type { IsAny, IsPlainObj } from '@rimbu/base';
 /**
  * A deep readonly typed version of given type T. Makes all properties or elements read only.
+ * It maps types using the following rules:
+ * - arrays and tuples become readonly counterparts, and all element types are wrapped in `Protected` if applicable
+ * - Maps of key type K and value type V become Maps of key type `Protected<K>` and value type `Protected<V>`
+ * - Sets of element type E become Sets of element type `Protected<E>`
+ * - Promises of value type E become Promises of value type `Protected<E>`
+ * - Objects that have only simple properties (no functions or iterators) will have all the properties as Protected if applicable
+ * - Any other type will not be mapped
  * @typeparam T - the input type
  */
-export declare type Protected<T> = T extends readonly (infer E)[] ? readonly Protected<E>[] : T extends Map<infer K, infer V> ? Map<Protected<K>, Protected<V>> : T extends Set<infer E> ? Set<Protected<E>> : T extends Promise<infer E> ? Promise<Protected<E>> : IsPlainObj<T> extends true ? {
+export declare type Protected<T> = IsAny<T> extends true ? T : T extends readonly any[] & infer A ? {
+    readonly [K in keyof A]: Protected<A[K]>;
+} : T extends Map<infer K, infer V> ? Map<Protected<K>, Protected<V>> : T extends Set<infer E> ? Set<Protected<E>> : T extends Promise<infer E> ? Promise<Protected<E>> : IsPlainObj<T> extends true ? {
     readonly [K in keyof T]: Protected<T[K]>;
 } : T;
 /**
- * Returns the same value wrapped in the Protected type
+ * Returns the same value wrapped in the `Protected` type.
  * @param value - the value to wrap
+ * @note does not perform any runtime protection, it is only a utility to easily add the `Protected`
+ * type to a value
+ * @example
+ * ```ts
+ * const obj = Protected({ a: 1, b: { c: true, d: [1] } })
+ * obj.a = 2        // compiler error: a is readonly
+ * obj.b.c = false  // compiler error: c is readonly
+ * obj.b.d.push(2)  // compiler error: d is a readonly array
+ * (obj as any).b.d.push(2)  // will actually mutate the object
+ * ```
+
+ * '
  */
 export declare function Protected<T>(value: T): Protected<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/deep",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "Tools to use handle plain JS objects as immutable objects",
   "keywords": [
     "immutable",
@@ -57,8 +57,8 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@rimbu/base": "^0.9.0",
-    "@rimbu/common": "^0.9.3",
+    "@rimbu/base": "^0.9.1",
+    "@rimbu/common": "^0.9.4",
     "tslib": "^2.4.0"
   },
   "publishConfig": {
@@ -68,5 +68,5 @@
     "index": "src/index.ts",
     "replacer": "../../config/denoify-rimbu-replacer.js"
   },
-  "gitHead": "4efaf8c469d606381517984436383fd6b1b61ec0"
+  "gitHead": "60d3b52050fc30f10921cbf92d637362d663d7e0"
 }

package/src/path.ts

@@ -1,7 +1,7 @@
 import type { Update } from '@rimbu/common';
 import type { IsPlainObj, PlainObj } from '@rimbu/base';
 
-import { patch } from './internal';
+import { patch, patchNested } from './internal';
 
 /**
  * A string representing a path into an (nested) object of type T.
@@ -92,8 +92,9 @@ export namespace Path {
     let current = root;
 
     for (const item of items) {
-      current[item] = {};
-      current = current[item];
+      const next = {};
+      current[item] = patchNested(next);
+      current = next;
     }
 
     current[last] = value;

package/src/protected.ts

@@ -1,11 +1,20 @@
-import type { IsPlainObj } from '@rimbu/base';
+import type { IsAny, IsPlainObj } from '@rimbu/base';
 
 /**
  * A deep readonly typed version of given type T. Makes all properties or elements read only.
+ * It maps types using the following rules:
+ * - arrays and tuples become readonly counterparts, and all element types are wrapped in `Protected` if applicable
+ * - Maps of key type K and value type V become Maps of key type `Protected<K>` and value type `Protected<V>`
+ * - Sets of element type E become Sets of element type `Protected<E>`
+ * - Promises of value type E become Promises of value type `Protected<E>`
+ * - Objects that have only simple properties (no functions or iterators) will have all the properties as Protected if applicable
+ * - Any other type will not be mapped
  * @typeparam T - the input type
  */
-export type Protected<T> = T extends readonly (infer E)[]
-  ? readonly Protected<E>[]
+export type Protected<T> = IsAny<T> extends true
+  ? T
+  : T extends readonly any[] & infer A
+  ? { readonly [K in keyof A]: Protected<A[K]> }
   : T extends Map<infer K, infer V>
   ? Map<Protected<K>, Protected<V>>
   : T extends Set<infer E>
@@ -17,8 +26,20 @@ export type Protected<T> = T extends readonly (infer E)[]
   : T;
 
 /**
- * Returns the same value wrapped in the Protected type
+ * Returns the same value wrapped in the `Protected` type.
  * @param value - the value to wrap
+ * @note does not perform any runtime protection, it is only a utility to easily add the `Protected`
+ * type to a value
+ * @example
+ * ```ts
+ * const obj = Protected({ a: 1, b: { c: true, d: [1] } })
+ * obj.a = 2        // compiler error: a is readonly
+ * obj.b.c = false  // compiler error: c is readonly
+ * obj.b.d.push(2)  // compiler error: d is a readonly array
+ * (obj as any).b.d.push(2)  // will actually mutate the object
+ * ```
+
+ * '
  */
 export function Protected<T>(value: T): Protected<T> {
   return value as any;