@rimbu/deep 0.14.4 → 0.14.5

package/README.md

@@ -2,6 +2,10 @@
     <img src="https://github.com/rimbu-org/rimbu/raw/main/assets/rimbu_logo.svg" />
 </p>
 
+[![npm version](https://badge.fury.io/js/@rimbu%2Fdeep.svg)](https://www.npmjs.com/package/@rimbu/deep) [![Deno](https://shield.deno.dev/x/rimbu)](http://deno.land/x/rimbu)
+
+![Licence](https://img.shields.io/github/license/rimbu-org/rimbu)
+
 # @rimbu/deep
 
 Offers tools to use handle plain JS objects as immutable objects. The [`Patch` object](https://rimbu.org/docs/deep/patch) allows convenient immutable modification of simple objects. The [`Match` object](https://rimbu.org/docs/deep/match) allows easy matching on plain objects. The [`Path` object](https://rimbu.org/docs/deep/path) allows easy querying of nested values. The [`Immutable` type](https://rimbu.org/docs/deep/immutable) makes it easy to create plain objects that that have compile-time protection against mutation. The [`Tuple` type](https://rimbu.org/docs/deep/tuple) is a utility to have similar functionality as `as const` but less strict.
@@ -12,18 +16,31 @@ Or [Try Out Rimbu](https://codesandbox.io/s/github/vitoke/rimbu-sandbox/tree/mai
 
 ## Installation
 
-All types are exported through `@rimbu/core`. It is recommended to use that package.
+### Compabitity
+
+- [`Node >= 16` ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?logo=node.js&logoColor=white)](https://nodejs.org)
+- [`Deno` ![Deno JS](https://img.shields.io/badge/deno%20js-000000?logo=deno&logoColor=white)](https://deno.com/runtime)
+- [`Bun >= 0.6.0` ![Bun](https://img.shields.io/badge/Bun-%23000000.svg?logoColor=white)](https://bun.sh/)
+- `Web` ![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?logoColor=white)
+
+### Yarn / NPM / Bun
+
+For convenience, all main types are also exported through [`@rimbu/core`](../core).
 
 To install this package only:
 
-### Yarn/NPM
+For `yarn`:
 
 > `yarn add @rimbu/deep`
 
-or
+For `npm`:
 
 > `npm i @rimbu/deep`
 
+For `bun`:
+
+> `bun add @rimbu/deep`
+
 ### Deno
 
 For Deno, the following approach is recommended:

package/dist/types/protected.d.ts

@@ -12,6 +12,6 @@ import type { IsAny, IsPlainObj } from '@rimbu/base';
  */
 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> ? Omit<Map<Protected<K>, Protected<V>>, 'clear' | 'delete' | 'set'> : T extends Set<infer E> ? Omit<Set<Protected<E>>, 'add' | 'clear' | 'delete'> : T extends Promise<infer E> ? Promise<Protected<E>> : IsPlainObj<T> extends true ? {
+} : T extends Map<infer K, infer V> ? ReadonlyMap<Protected<K>, Protected<V>> : T extends Set<infer E> ? ReadonlySet<Protected<E>> : T extends Promise<infer E> ? Promise<Protected<E>> : IsPlainObj<T> extends true ? {
     readonly [K in keyof T]: Protected<T[K]>;
 } : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/deep",
-  "version": "0.14.4",
+  "version": "0.14.5",
   "description": "Tools to use handle plain JS objects as immutable objects",
   "keywords": [
     "immutable",
@@ -66,12 +66,12 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@rimbu/base": "^0.11.3",
-    "@rimbu/common": "^0.12.3",
+    "@rimbu/base": "^0.11.4",
+    "@rimbu/common": "*",
     "tslib": "^2.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f83f7bc9812a739279a64e2e52d83f631dfb4f6"
+  "gitHead": "5400f8471bdfc7a227f7defc4a3942bdf3ff1423"
 }

package/src/protected.ts

@@ -18,14 +18,11 @@ export type Protected<T> = IsAny<T> extends true
   ? // convert all keys to readonly and all values to `Protected`
     { readonly [K in keyof A]: Protected<A[K]> }
   : T extends Map<infer K, infer V>
-  ? // return keys and values as `Protected` and omit mutable methods
-    Omit<Map<Protected<K>, Protected<V>>, 'clear' | 'delete' | 'set'>
+  ? ReadonlyMap<Protected<K>, Protected<V>>
   : T extends Set<infer E>
-  ? // return values as `Protected` and omit mutable methods
-    Omit<Set<Protected<E>>, 'add' | 'clear' | 'delete'>
+  ? ReadonlySet<Protected<E>>
   : T extends Promise<infer E>
-  ? // return promise value as `Protected`
-    Promise<Protected<E>>
+  ? Promise<Protected<E>>
   : IsPlainObj<T> extends true
   ? // convert all keys to readonly and all values to `Protected`
     { readonly [K in keyof T]: Protected<T[K]> }