@ng-org/alien-deepsignals 0.1.2-alpha.4 → 0.1.2-alpha.6

package/README.md

@@ -13,7 +13,6 @@ Core idea: wrap a data tree in a `Proxy` that lazily creates per-property signal
 - Per-property signals: fine‑grained invalidation without traversal on each change.
 - Patch stream: microtask‑batched granular mutations (paths + op) for syncing external stores / framework adapters.
 - Getter => computed: property getters become derived (readonly) signals automatically.
-- `$` accessors: TypeScript exposes `$prop` for each non‑function key plus `$` / `$length` for arrays.
 - Sets: structural `add/delete/clear` emit patches; object entries get synthetic stable ids.
 - Configurable synthetic IDs: custom property generator - the synthetic id is used in the paths of patches to identify objects in sets.
 - Read-only properties: protect specific properties from modification.
@@ -47,39 +46,38 @@ state.settings.add("beta");
 
 ## Frontend Hooks
 
-We provide hooks for Svelte, Vue, and React so that you can use deepSignal objects in your frontend framework. Modifying the object within those components works as usual, just that the component will rerender automatically if the object changed (by an event in the component or a modification from elsewhere).
+We provide hooks for Svelte 3/4, Svelte 5, Vue, and React so that you can use deepSignal objects in your frontend framework. Modifying the object within those components works as usual, just that the component will rerender automatically if the object changed (by an event in the component or a modification from elsewhere).
 
 Note that you can pass existing deepSignal objects (that you are using elsewhere too, for example as shared state) as well as plain JavaScript objects (which are then wrapped).
 
 ```tsx
 import { useDeepSignal } from "@ng-org/alien-deepsignals/react";
 
-const users = useDeepSignal([{username: "Bob"}]);
+const users = useDeepSignal([{ username: "Bob" }]);
 // Note: Instead of calling `setState`, you just need to modify a property. That will trigger the required re-render.
 ```
 
 ### Vue
 
 In component `UserManager.vue`
+
 ```vue
-<script setup lang="ts"> 
+<script setup lang="ts">
 import { DeepSignal } from "@ng-org/alien-deepsignals";
 import { useDeepSignal } from "@ng-org/alien-deepsignals/vue";
 import UserComponent from "./User.vue";
 import { User } from "./types.ts";
 
-const users: DeepSignal<User> = useDeepSignal([{username: "Bob", id: 1}]);
+const users: DeepSignal<User> = useDeepSignal([{ username: "Bob", id: 1 }]);
 </script>
 
 <template>
-    <UserComponent
-        v-for="user in users"
-        :key="user.id"
-        :user="user"
-    />
+    <UserComponent v-for="user in users" :key="user.id" :user="user" />
 </template>
 ```
+
 In a child component, `User.vue`
+
 ```vue
 <script setup lang="ts">
 import { useDeepSignal } from "@ng-org/alien-deepsignals/vue";
@@ -88,22 +86,31 @@ const props = defineProps<{
     user: DeepSignal<User>;
 }>();
 
-// Important!
-// In vue child components, you need to wrap deepSignal objects into useDeepSignal hooks, to ensure the component re-renders.
-const user = useDeepSignal(props.user);
+// The component only rerenders when user.name changes.
+// It behaves the same as an object called with `reactive()`
+const user = props.user;
 </script>
 <template>
-    {{user.name}}
+    <input type="text" v-model:value="user.name" />
 </template>
 ```
 
-### Svelte
+### Svelte 3 / 4
+
+```ts
+import { useDeepSignal } from "@ng-org/alien-deepsignals/svelte4";
+
+// `users` is a store of type `{username: string}[]`
+const users = useDeepSignal([{ username: "Bob" }]);
+```
+
+### Svelte 5
 
 ```ts
 import { useDeepSignal } from "@ng-org/alien-deepsignals/svelte";
 
 // `users` is a rune of type `{username: string}[]`
-const users = useDeepSignal([{username: "Bob"}]);
+const users = useDeepSignal([{ username: "Bob" }]);
 ```
 
 ## Configuration options
@@ -433,32 +440,6 @@ import { shallow } from "alien-deepsignals";
 state.config = shallow({ huge: { blob: true } });
 ```
 
-## TypeScript ergonomics
-
-`DeepSignal<T>` exposes both plain properties and optional `$prop` signal accessors (excluded for function members). Arrays add `$` (index signal map) and `$length`.
-
-```ts
-const state = deepSignal({ count: 0, user: { name: "A" } });
-state.count++; // ok
-state.$count!.set(9); // write via signal
-const n: number = state.$count!(); // typed number
-```
-
-## API surface
-
-| Function                           | Description                                                        |
-| ---------------------------------- | ------------------------------------------------------------------ |
-| `deepSignal(obj, options?)`        | Create (or reuse) reactive deep proxy with optional configuration. |
-| `watch(root, cb, opts?)`           | Observe batched deep mutations.                                    |
-| `observe(root, cb, opts?)`         | Alias of `watch`.                                                  |
-| `peek(obj,key)`                    | Untracked property read.                                           |
-| `shallow(obj)`                     | Mark object to skip deep proxying.                                 |
-| `isDeepSignal(val)`                | Runtime predicate.                                                 |
-| `isShallow(val)`                   | Was value marked shallow.                                          |
-| `setSetEntrySyntheticId(obj,id)`   | Assign custom Set entry id (highest priority).                     |
-| `addWithId(set, entry, id)`        | Insert with desired synthetic id (convenience).                    |
-| `subscribeDeepMutations(root, cb)` | Low-level patch stream (used by watch).                            |
-
 ## License
 
 This project is a fork of https://github.com/CCherry07/alien-deepsignals, forked at commit `b691dc9202c58f63c1bf78675577c811316396db`. All code previous to this commit is licensed under MIT, and author is CCherry. No copyright attribution is present. This codebase is therefor relicensed under dual MIT and Apache 2.0 licensing.

package/dist/core.d.ts

@@ -1,63 +1,4 @@
-/** Lightweight facade adding ergonomic helpers (.value/.peek/.get/.set) to native alien-signals function signals. */
-export { signal as _rawSignal, computed as _rawComputed, startBatch as _rawStartBatch, endBatch as _rawEndBatch, getCurrentSub as _rawGetCurrentSub, setCurrentSub as _rawSetCurrentSub, effect as _rawEffect, } from "alien-signals";
-import { signal as alienSignal, computed as alienComputed } from "alien-signals";
-/** Internal shape of a tagged writable signal after adding ergonomic helpers. */
-type TaggedSignal<T> = ReturnType<typeof alienSignal<T>> & {
-    /** Tracking read / write via property syntax */
-    value: T;
-    /** Non-tracking read */
-    peek(): T;
-    /** Alias for tracking read */
-    get(): T;
-    /** Write helper */
-    set(v: T): void;
-};
-/**
- * Create a new writable function-form signal enhanced with `.value`, `.peek()`, `.get()`, `.set()`.
- *
- * @example
- * const count = signal(0);
- * count();      // 0 (track)
- * count(1);     // write
- * count.value;  // 1 (track)
- * count.peek(); // 1 (non-tracking)
- */
-export declare const signal: <T>(v?: T) => TaggedSignal<any>;
-/** Internal shape of a tagged computed signal after adding ergonomic helpers. */
-type TaggedComputed<T> = ReturnType<typeof alienComputed<T>> & {
-    /** Tracking read via property syntax (readonly) */
-    readonly value: T;
-    /** Non-tracking read */
-    peek(): T;
-    /** Alias for tracking read */
-    get(): T;
-};
-/**
- * Create a lazy computed (readonly) signal derived from other signals.
- *
- * Computed signals are automatically cached and only recompute when their tracked
- * dependencies change. The getter function is evaluated lazily—if you never read
- * the computed value, the computation never runs.
- *
- * The returned function can be called directly `computed()` or accessed via `.value`.
- * Use `.peek()` for non-tracking reads (won't establish reactive dependency).
- *
- * @example
- * const count = signal(5);
- * const doubled = computed(() => count() * 2);
- * doubled();       // 10 (establishes dependency, caches result)
- * doubled.value;   // 10 (cached, same as calling it)
- * doubled.peek();  // 10 (no dependency tracking)
- * count(10);
- * doubled();       // 20 (recomputed because count changed)
- */
-export declare const computed: <T>(getter: () => T) => TaggedComputed<T>;
-/** Union allowing a plain value or a writable signal wrapping that value. */
-export type MaybeSignal<T = any> = T | ReturnType<typeof signal>;
-/** Union allowing value, writable signal, computed signal or plain getter function. */
-export type MaybeSignalOrGetter<T = any> = MaybeSignal<T> | ReturnType<typeof computed> | (() => T);
-/** Runtime guard that an unknown value is one of our tagged signals/computeds. */
-export declare const isSignal: (s: any) => boolean;
+export { signal as alienSignal, computed as alienComputed, effect as alienEffect, } from "alien-signals";
 /**
  * Execute multiple signal writes in a single batched update frame.
  * All downstream computed/effect re-evaluations are deferred until the function exits.

package/dist/core.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAUA,qHAAqH;AAGrH,OAAO,EACH,MAAM,IAAI,UAAU,EACpB,QAAQ,IAAI,YAAY,EACxB,UAAU,IAAI,cAAc,EAC5B,QAAQ,IAAI,YAAY,EACxB,aAAa,IAAI,iBAAiB,EAClC,aAAa,IAAI,iBAAiB,EAClC,MAAM,IAAI,UAAU,GACvB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACH,MAAM,IAAI,WAAW,EACrB,QAAQ,IAAI,aAAa,EAI5B,MAAM,eAAe,CAAC;AAKvB,iFAAiF;AACjF,KAAK,YAAY,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG;IACvD,gDAAgD;IAChD,KAAK,EAAE,CAAC,CAAC;IACT,wBAAwB;IACxB,IAAI,IAAI,CAAC,CAAC;IACV,8BAA8B;IAC9B,GAAG,IAAI,CAAC,CAAC;IACT,mBAAmB;IACnB,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;CACnB,CAAC;AA6BF;;;;;;;;;GASG;AACH,eAAO,MAAM,MAAM,GAAI,CAAC,EAAE,IAAI,CAAC,sBAA8B,CAAC;AAC9D,iFAAiF;AACjF,KAAK,cAAc,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG;IAC3D,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;IAClB,wBAAwB;IACxB,IAAI,IAAI,CAAC,CAAC;IACV,8BAA8B;IAC9B,GAAG,IAAI,CAAC,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,EAAE,QAAQ,MAAM,CAAC,KAAG,cAAc,CAAC,CAAC,CACxB,CAAC;AAEvC,6EAA6E;AAC7E,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC;AACjE,uFAAuF;AACvF,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,GAAG,IACjC,WAAW,CAAC,CAAC,CAAC,GACd,UAAU,CAAC,OAAO,QAAQ,CAAC,GAC3B,CAAC,MAAM,CAAC,CAAC,CAAC;AAChB,kFAAkF;AAClF,eAAO,MAAM,QAAQ,GAAI,GAAG,GAAG,KAAG,OACiC,CAAC;AAEpE;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAOvC"}
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAWA,OAAO,EACH,MAAM,IAAI,WAAW,EACrB,QAAQ,IAAI,aAAa,EACzB,MAAM,IAAI,WAAW,GACxB,MAAM,eAAe,CAAC;AAOvB;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAOvC"}

package/dist/core.js

@@ -9,86 +9,14 @@
 // according to those terms.
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSignal = exports.computed = exports.signal = exports._rawEffect = exports._rawSetCurrentSub = exports._rawGetCurrentSub = exports._rawEndBatch = exports._rawStartBatch = exports._rawComputed = exports._rawSignal = void 0;
+exports.alienEffect = exports.alienComputed = exports.alienSignal = void 0;
 exports.batch = batch;
-/** Lightweight facade adding ergonomic helpers (.value/.peek/.get/.set) to native alien-signals function signals. */
 // Native re-exports for advanced usage.
 var alien_signals_1 = require("alien-signals");
-Object.defineProperty(exports, "_rawSignal", { enumerable: true, get: function () { return alien_signals_1.signal; } });
-Object.defineProperty(exports, "_rawComputed", { enumerable: true, get: function () { return alien_signals_1.computed; } });
-Object.defineProperty(exports, "_rawStartBatch", { enumerable: true, get: function () { return alien_signals_1.startBatch; } });
-Object.defineProperty(exports, "_rawEndBatch", { enumerable: true, get: function () { return alien_signals_1.endBatch; } });
-Object.defineProperty(exports, "_rawGetCurrentSub", { enumerable: true, get: function () { return alien_signals_1.getCurrentSub; } });
-Object.defineProperty(exports, "_rawSetCurrentSub", { enumerable: true, get: function () { return alien_signals_1.setCurrentSub; } });
-Object.defineProperty(exports, "_rawEffect", { enumerable: true, get: function () { return alien_signals_1.effect; } });
+Object.defineProperty(exports, "alienSignal", { enumerable: true, get: function () { return alien_signals_1.signal; } });
+Object.defineProperty(exports, "alienComputed", { enumerable: true, get: function () { return alien_signals_1.computed; } });
+Object.defineProperty(exports, "alienEffect", { enumerable: true, get: function () { return alien_signals_1.effect; } });
 const alien_signals_2 = require("alien-signals");
-const contents_1 = require("./contents");
-/**
- * Decorate a native signal function with helpers & identity.
- */
-function tagSignal(fn) {
-    Object.defineProperty(fn, contents_1.ReactiveFlags.IS_SIGNAL, { value: true });
-    Object.defineProperty(fn, "value", {
-        get: () => fn(),
-        set: (v) => fn(v),
-    });
-    // Add peek to mirror old API (non-tracking read)
-    if (!fn.peek)
-        Object.defineProperty(fn, "peek", { value: () => fn() });
-    if (!fn.get)
-        Object.defineProperty(fn, "get", { value: () => fn() });
-    if (!fn.set)
-        Object.defineProperty(fn, "set", { value: (v) => fn(v) });
-    return fn;
-}
-/**
- * Decorate a native computed function with ergonomic helpers & readonly value accessor.
- */
-function tagComputed(fn) {
-    Object.defineProperty(fn, contents_1.ReactiveFlags.IS_SIGNAL, { value: true });
-    Object.defineProperty(fn, "value", { get: () => fn() });
-    if (!fn.peek)
-        Object.defineProperty(fn, "peek", { value: () => fn() });
-    if (!fn.get)
-        Object.defineProperty(fn, "get", { value: () => fn() });
-    return fn;
-}
-/**
- * Create a new writable function-form signal enhanced with `.value`, `.peek()`, `.get()`, `.set()`.
- *
- * @example
- * const count = signal(0);
- * count();      // 0 (track)
- * count(1);     // write
- * count.value;  // 1 (track)
- * count.peek(); // 1 (non-tracking)
- */
-const signal = (v) => tagSignal((0, alien_signals_2.signal)(v));
-exports.signal = signal;
-/**
- * Create a lazy computed (readonly) signal derived from other signals.
- *
- * Computed signals are automatically cached and only recompute when their tracked
- * dependencies change. The getter function is evaluated lazily—if you never read
- * the computed value, the computation never runs.
- *
- * The returned function can be called directly `computed()` or accessed via `.value`.
- * Use `.peek()` for non-tracking reads (won't establish reactive dependency).
- *
- * @example
- * const count = signal(5);
- * const doubled = computed(() => count() * 2);
- * doubled();       // 10 (establishes dependency, caches result)
- * doubled.value;   // 10 (cached, same as calling it)
- * doubled.peek();  // 10 (no dependency tracking)
- * count(10);
- * doubled();       // 20 (recomputed because count changed)
- */
-const computed = (getter) => tagComputed((0, alien_signals_2.computed)(getter));
-exports.computed = computed;
-/** Runtime guard that an unknown value is one of our tagged signals/computeds. */
-const isSignal = (s) => typeof s === "function" && !!s && !!s[contents_1.ReactiveFlags.IS_SIGNAL];
-exports.isSignal = isSignal;
 /**
  * Execute multiple signal writes in a single batched update frame.
  * All downstream computed/effect re-evaluations are deferred until the function exits.

package/dist/deepSignal.d.ts

@@ -1,6 +1,6 @@
 import { DeepPatchJITSubscriber, DeepPatchSubscriber, DeepSignal, DeepSignalOptions } from "./types";
 /** Runtime guard that checks whether a value is a deepSignal proxy. */
-export declare function isDeepSignal(value: any): boolean;
+export declare function isDeepSignal(value: unknown): value is DeepSignal<any>;
 /**
  * Create a deep reactive proxy for objects, arrays or Sets.
  * Returns the input itself, if it's a deepSignal already.
@@ -23,4 +23,6 @@ export declare function shallow<T extends object>(obj: T): T;
 export declare function setSetEntrySyntheticId(obj: object, id: string | number): void;
 /** Convenience helper to add an entry to a proxied Set with a pre-defined synthetic ID. */
 export declare function addWithId<T>(set: Set<T>, entry: T, id: string | number): T;
+/** Get the original, raw value of a deep signal. */
+export declare function getRaw<T extends object>(value: T | DeepSignal<T>): any;
 //# sourceMappingURL=deepSignal.d.ts.map

package/dist/deepSignal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deepSignal.d.ts","sourceRoot":"","sources":["../src/deepSignal.ts"],"names":[],"mappings":"AAWA,OAAO,EAGH,sBAAsB,EACtB,mBAAmB,EACnB,UAAU,EACV,iBAAiB,EAMpB,MAAM,SAAS,CAAC;AA+qCjB,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACvC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,iBAAiB,GAC5B,UAAU,CAAC,CAAC,CAAC,CAwBf;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,EAAE,mBAAmB,GAAG,sBAAsB,EAChD,gBAAgB,GAAE,OAAe,GAClC,MAAM,IAAI,CAoBZ;AAED,yEAAyE;AACzE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAElE;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAChC,IAAI,EAAE,MAAM,GAAG,MAAM,GACtB,MAAM,GAAG,SAAS,CAIpB;AAED,yEAAyE;AACzE,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAGnD;AAED,mFAAmF;AACnF,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,QAItE;AAED,2FAA2F;AAC3F,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,CAa1E"}
+{"version":3,"file":"deepSignal.d.ts","sourceRoot":"","sources":["../src/deepSignal.ts"],"names":[],"mappings":"AAWA,OAAO,EAGH,sBAAsB,EACtB,mBAAmB,EACnB,UAAU,EACV,iBAAiB,EAOpB,MAAM,SAAS,CAAC;AA2wCjB,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAAC,GAAG,CAAC,CAErE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACvC,KAAK,EAAE,CAAC,EACR,OAAO,CAAC,EAAE,iBAAiB,GAC5B,UAAU,CAAC,CAAC,CAAC,CAyCf;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,EAAE,mBAAmB,GAAG,sBAAsB,EAChD,gBAAgB,GAAE,OAAe,GAClC,MAAM,IAAI,CAoBZ;AAED,yEAAyE;AACzE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,GAAG,GAAG,MAAM,GAAG,SAAS,CAElE;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAChC,IAAI,EAAE,MAAM,GAAG,MAAM,GACtB,MAAM,GAAG,SAAS,CAIpB;AAED,yEAAyE;AACzE,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAGnD;AAED,mFAAmF;AACnF,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,QAItE;AAED,2FAA2F;AAC3F,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,CAa1E;AAED,oDAAoD;AACpD,wBAAgB,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,OAEhE"}