@lensmcp/valtio-instrumentation 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+# @lensmcp/valtio-instrumentation
+
+Drop-in instrumented Valtio for LensMCP — per-path subscription and mutation tracking.
+
+`@lensmcp/valtio-instrumentation` is a transparent, drop-in replacement for [`valtio`](https://github.com/pmndrs/valtio). It exposes the exact same surface (`proxy`, `useSnapshot`, `snapshot`, `subscribe`, `ref`, …), but the `proxy` and `useSnapshot` you get are instrumented: every store creation, every state mutation, and every per-path component subscription is observed and published as a LensMCP event. This is what lets the [LensMCP](https://github.com/kiwiapps-ltd/lensmcp) lens show frontend state changes inside a flow/trace — which store changed, on which path, and which mounted components were subscribed to it at the time.
+
+The instrumentation is path-aware. `proxy()` registers each store and subscribes at the root with Valtio's path-tracking ops enabled, emitting one `state-update` per touched leaf. `useSnapshot()` inlines Valtio v2's `proxy-compare` "affected" map so it knows exactly which `(storeId, path)` pairs a component actually read, and registers one subscription per path instead of a single store-wide one. You normally don't import this package by hand — [`@lensmcp/vite-plugin`](https://github.com/kiwiapps-ltd/lensmcp) aliases `valtio → @lensmcp/valtio-instrumentation` at dev time, so your existing Valtio code is observed with no source changes.
+
+## Install
+
+```bash
+yarn add @lensmcp/valtio-instrumentation
+```
+
+In a LensMCP-enabled Vite app you usually don't need this: `@lensmcp/vite-plugin` aliases `valtio` to this package automatically, so `import { proxy, useSnapshot } from 'valtio'` resolves here in dev. Install it directly only if you want to import `@lensmcp/valtio-instrumentation` explicitly or use the LensMCP-specific store-registry exports.
+
+`react` (`^18 || ^19`) and `valtio` (`^1 || ^2`) are peer dependencies, and it depends on `@lensmcp/react-instrumentation` for event publishing and flow context.
+
+## Usage
+
+Because the surface matches Valtio exactly, existing code works unchanged — it's just now observed:
+
+```tsx
+// With @lensmcp/vite-plugin, this import resolves to @lensmcp/valtio-instrumentation in dev.
+import { proxy, useSnapshot } from 'valtio';
+
+// `proxy()` registers the store and emits a `store-created` event.
+const state = proxy({ count: 0, user: { name: 'Ada' } });
+
+function Counter() {
+  // `useSnapshot()` infers the paths this component reads (here: `count`)
+  // and registers one subscription per path.
+  const snap = useSnapshot(state);
+  return <button onClick={() => state.count++}>{snap.count}</button>;
+}
+```
+
+Mutating `state.count` emits a `state-update` event for path `count`, tagged with the components currently subscribed to that path (and its parents). No callbacks, providers, or annotations are required beyond mounting your tree under `LensmcpRoot` from `@lensmcp/react-instrumentation`.
+
+If you import this package directly, you can pass LensMCP options to `proxy()`:
+
+```ts
+import { proxy } from '@lensmcp/valtio-instrumentation';
+
+const cart = proxy(
+  { items: [] },
+  { storeId: 'cart', source: 'src/cart.ts:12', emitInitialPreview: true },
+);
+```
+
+For cases where you want to declare a read path explicitly rather than infer it, use `useTrackedSnapshot`:
+
+```ts
+import { useTrackedSnapshot } from '@lensmcp/valtio-instrumentation';
+
+const snap = useTrackedSnapshot(cart, { storeId: 'cart', path: 'items' });
+```
+
+## API
+
+### Valtio-compatible surface
+
+| Export | Description |
+| --- | --- |
+| `proxy(initial, opts?)` | Instrumented `proxy`. Registers the store, emits `store-created`, and emits a `state-update` per mutated path. Accepts `LensmcpProxyOptions`. |
+| `useSnapshot(target)` | Instrumented `useSnapshot` with the same signature as Valtio's. Infers read paths via `proxy-compare` and registers one subscription per path. |
+| `useTrackedSnapshot(target, opts)` | Like `useSnapshot`, but the caller declares `{ storeId, path }` explicitly instead of inferring it. Accepts `UseSnapshotOptions`. |
+| `snapshot` | Re-exported from `valtio/vanilla` (uninstrumented). |
+| `subscribe` | Re-exported from `valtio/vanilla`. |
+| `ref` | Re-exported from `valtio/vanilla`. |
+| `getVersion` | Re-exported from `valtio/vanilla`. |
+| `unstable_enableOp` | Re-exported from `valtio/vanilla`. |
+| `unstable_getInternalStates` | Re-exported from `valtio/vanilla`. |
+| `unstable_replaceInternalFunction` | Re-exported from `valtio/vanilla`. |
+| `LensmcpProxyOptions` | Options for `proxy()`: `storeId?`, `source?`, `emitInitialPreview?`. |
+| `UseSnapshotOptions` | Options for `useTrackedSnapshot()`: `storeId` (required), `path?`. |
+
+> `proxy` and `useSnapshot` are the instrumented versions; everything else passes through from the real Valtio (imported via the `valtio/vanilla` subpath so this module never aliases itself).
+
+### Store registry (LensMCP-specific)
+
+Module-level bookkeeping shared by `proxy`, `useSnapshot`, and the LensMCP reducer. Most apps never call these directly.
+
+| Export | Description |
+| --- | --- |
+| `registerStore(storeId, source?)` | Record a store and its source location. |
+| `tagProxy(proxyObject, storeId)` | Associate a proxy object with its `storeId` so `useSnapshot(store)` can recover the id with no extra args. |
+| `storeIdOf(proxyObject)` | Look up the `storeId` previously tagged onto a proxy. |
+| `addSubscription(entry)` | Register a `{ storeId, path, componentInstanceId }` subscription. |
+| `removeSubscription(entry)` | Remove a subscription entry. |
+| `subscribersFor(storeId, path)` | List `componentInstanceId`s subscribed to an exact path. |
+| `subscribersForPathAndParents(storeId, path)` | List subscribers of a path unioned with every parent prefix and the root. |
+| `resetRegistry()` | Clear all stores and subscriptions (useful in tests). |
+| `SubscriptionEntry` | `{ storeId, path, componentInstanceId }`. |
+
+### Event payload types
+
+The wire-shape payloads emitted by this package (consumed by the LensMCP Valtio reducer via `event.raw.kind`):
+
+| Export | Description |
+| --- | --- |
+| `ValtioPublishPayload` | Union of `store-created`, `state-update`, `subscription-added`, and `subscription-removed`. |
+| `ValtioStoreRecord` | `{ storeId, source?, initialPreview? }`. |
+| `ValtioUpdateRecord` | `{ storeId, path, changedKeys, beforeHash, afterHash, preview?, subscribers }`. |
+| `ValtioSubscriptionRecord` | `{ storeId, path, componentInstanceId? }`. |
+
+## How it fits
+
+- **Aliased by [`@lensmcp/vite-plugin`](https://github.com/kiwiapps-ltd/lensmcp).** The plugin rewrites `valtio` to this package at dev time, so instrumentation is zero-touch for app code.
+- **Pairs with [`@lensmcp/react-instrumentation`](https://github.com/kiwiapps-ltd/lensmcp).** This package publishes events through its `publish()` API and reads the active flow/component context from `useLensmcpContext()` / `LensmcpRoot`, so state updates are correlated with the render and effect timeline in the same trace.
+- **Speaks [`@lensmcp/protocol-types`](https://github.com/kiwiapps-ltd/lensmcp).** Events ride the LensMCP publish envelope (`source: 'valtio'`, `category: 'state'`) defined by the shared protocol, so the lens and reducers can render store creation, mutations, and per-path subscriptions in a unified flow view.
+
+---
+
+Part of [LensMCP](https://github.com/kiwiapps-ltd/lensmcp). Apache-2.0.

package/index.d.ts

@@ -0,0 +1,6 @@
+export { ref, snapshot, subscribe, getVersion, unstable_enableOp, unstable_getInternalStates, unstable_replaceInternalFunction, } from 'valtio/vanilla';
+export { proxy, type LensmcpProxyOptions } from './lib/proxy.js';
+export { useSnapshot, useTrackedSnapshot, type UseSnapshotOptions } from './lib/snapshot.js';
+export { registerStore, tagProxy, storeIdOf, addSubscription, removeSubscription, subscribersFor, subscribersForPathAndParents, resetRegistry, type SubscriptionEntry, } from './lib/store-registry.js';
+export type { ValtioUpdateRecord, ValtioStoreRecord, ValtioSubscriptionRecord, ValtioPublishPayload, } from './lib/types.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,GAAG,EACH,QAAQ,EACR,SAAS,EACT,UAAU,EACV,iBAAiB,EACjB,0BAA0B,EAC1B,gCAAgC,GACjC,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,KAAK,EAAE,KAAK,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,KAAK,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAG7F,OAAO,EACL,aAAa,EACb,QAAQ,EACR,SAAS,EACT,eAAe,EACf,kBAAkB,EAClB,cAAc,EACd,4BAA4B,EAC5B,aAAa,EACb,KAAK,iBAAiB,GACvB,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,gBAAgB,CAAC"}

package/index.js

@@ -0,0 +1,10 @@
+// Drop-in for `valtio`: re-exports the full main-entry surface so the
+// Vite plugin can alias `valtio → @lensmcp/valtio-instrumentation` in dev
+// with no caller changes. `proxy` + `useSnapshot` are the instrumented
+// versions; the rest pass through from the real valtio (imported via the
+// `valtio/vanilla` subpath so this module never aliases itself).
+export { ref, snapshot, subscribe, getVersion, unstable_enableOp, unstable_getInternalStates, unstable_replaceInternalFunction, } from 'valtio/vanilla';
+export { proxy } from './lib/proxy.js';
+export { useSnapshot, useTrackedSnapshot } from './lib/snapshot.js';
+// LensMCP-specific extras (not part of the valtio surface).
+export { registerStore, tagProxy, storeIdOf, addSubscription, removeSubscription, subscribersFor, subscribersForPathAndParents, resetRegistry, } from './lib/store-registry.js';

package/lib/proxy.d.ts

@@ -0,0 +1,13 @@
+export interface LensmcpProxyOptions {
+    /** Stable storeId; defaults to `valtio:store:<n>`. */
+    storeId?: string;
+    /** Source path (file:line) the proxy was created at. */
+    source?: string;
+    /** Include first-level state in `store-created` events. */
+    emitInitialPreview?: boolean;
+}
+/**
+ * Create a tracked Valtio proxy.
+ */
+export declare function proxy<T extends object>(initial: T, opts?: LensmcpProxyOptions): T;
+//# sourceMappingURL=proxy.d.ts.map

package/lib/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/lib/proxy.ts"],"names":[],"mappings":"AAmCA,MAAM,WAAW,mBAAmB;IAClC,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAID;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EACpC,OAAO,EAAE,CAAC,EACV,IAAI,GAAE,mBAAwB,GAC7B,CAAC,CAkEH"}

package/lib/proxy.js

@@ -0,0 +1,94 @@
+/**
+ * `proxy(initial, opts)` — wraps the actual Valtio proxy and emits
+ * `store-created` + per-mutation `state-update` events.
+ *
+ * Valtio is a peer dependency; we import it statically so bundlers
+ * resolve it the same way as user code.
+ */
+// Import the REAL valtio via the `valtio/vanilla` subpath — never bare
+// `valtio` — so the dev-time `valtio → @lensmcp/valtio-instrumentation`
+// alias (Phase 8) doesn't make this module import itself.
+// `unstable_enableOp` turns on path-aware ops; without it `subscribe()`
+// callbacks receive empty op arrays.
+import { proxy as valtioProxy, subscribe as valtioSubscribe, unstable_enableOp, } from 'valtio/vanilla';
+import { publish, depsHash } from '@lensmcp/react-instrumentation';
+import { registerStore, subscribersForPathAndParents, tagProxy, } from './store-registry.js';
+let opsEnabled = false;
+function ensureOpsEnabled() {
+    if (opsEnabled)
+        return;
+    try {
+        unstable_enableOp(true);
+        opsEnabled = true;
+    }
+    catch {
+        /* older valtio without the flag — fall through, paths just won't populate */
+    }
+}
+let storeCounter = 0;
+/**
+ * Create a tracked Valtio proxy.
+ */
+export function proxy(initial, opts = {}) {
+    ensureOpsEnabled();
+    const storeId = opts.storeId ?? `valtio:store:${++storeCounter}`;
+    registerStore(storeId, opts.source);
+    const proxied = valtioProxy(initial);
+    // Remember which store this proxy is, so the drop-in `useSnapshot(store)`
+    // can recover the id with no extra args.
+    tagProxy(proxied, storeId);
+    publish({
+        source: 'valtio',
+        category: 'state',
+        severity: 'info',
+        title: `store-created ${storeId}`,
+        fingerprint: `valtio-store:${storeId}`,
+        raw: {
+            kind: 'store-created',
+            store: {
+                storeId,
+                source: opts.source,
+                initialPreview: opts.emitInitialPreview === false ? undefined : safePreview(initial),
+            },
+        },
+    });
+    // Subscribe at the root to all changes; Valtio's ops carry the path
+    // tuple so we can emit one `state-update` per touched leaf.
+    valtioSubscribe(proxied, (ops) => {
+        for (const op of ops) {
+            const [, pathParts, value, prevValue] = op;
+            const path = (pathParts ?? []).map(String).join('.');
+            if (!path)
+                continue;
+            const changedKeys = (pathParts ?? []).map(String);
+            publish({
+                source: 'valtio',
+                category: 'state',
+                severity: 'info',
+                title: `state-update ${storeId}.${path}`,
+                fingerprint: `valtio-update:${storeId}:${path}`,
+                raw: {
+                    kind: 'state-update',
+                    update: {
+                        storeId,
+                        path,
+                        changedKeys,
+                        beforeHash: depsHash([prevValue]),
+                        afterHash: depsHash([value]),
+                        preview: safePreview(value),
+                        subscribers: subscribersForPathAndParents(storeId, path),
+                    },
+                },
+            });
+        }
+    }, true);
+    return proxied;
+}
+function safePreview(v) {
+    try {
+        return JSON.parse(JSON.stringify(v));
+    }
+    catch {
+        return undefined;
+    }
+}

package/lib/snapshot.d.ts

@@ -0,0 +1,17 @@
+export interface UseSnapshotOptions {
+    /** Path string declared by the caller (e.g. "dashboard.cards"). Optional —
+     *  without it we fall back to the empty root path. */
+    path?: string;
+    /** Store id (set by `proxy()`); the snapshot wrapper can't recover this
+     *  from the proxy alone, so callers must supply it. */
+    storeId: string;
+}
+export declare function useTrackedSnapshot<T extends object>(target: T, opts: UseSnapshotOptions): T;
+/**
+ * Drop-in `useSnapshot(store)` matching valtio's signature exactly. Infers
+ * the read paths from `proxy-compare`'s affected map and registers one
+ * subscription per path. Recovers the storeId tagged by the instrumented
+ * `proxy()`; falls back to a single root subscription when nothing is read.
+ */
+export declare function useSnapshot<T extends object>(target: T): T;
+//# sourceMappingURL=snapshot.d.ts.map

package/lib/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../../src/lib/snapshot.ts"],"names":[],"mappings":"AAoCA,MAAM,WAAW,kBAAkB;IACjC;0DACsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;2DACuD;IACvD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,MAAM,EACjD,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,kBAAkB,GACvB,CAAC,CAcH;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,CAgF1D"}

package/lib/snapshot.js

@@ -0,0 +1,136 @@
+/**
+ * `useSnapshot` — the drop-in replacement for valtio's `useSnapshot`, with
+ * **per-path subscription inference**.
+ *
+ * valtio's own re-render optimisation is a `proxy-compare` "affected"
+ * WeakMap recording which snapshot paths a component reads. We inline
+ * valtio v2's `useSnapshot` here so we *own* that `affected` map, then read
+ * it back with `affectedToPathList` after commit to learn exactly which
+ * (`storeId`, `path`) pairs the component depends on — and register one
+ * subscription per path instead of a single store-root subscription.
+ *
+ * `useTrackedSnapshot(target, { storeId, path })` stays available for
+ * callers that want to declare a path explicitly.
+ */
+import { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useSyncExternalStore, } from 'react';
+// Real valtio via the `valtio/vanilla` subpath (never bare `valtio`), so the
+// dev-time alias doesn't make this module import itself.
+import { snapshot as valtioSnapshot, subscribe as valtioSubscribe, } from 'valtio/vanilla';
+import { useSnapshot as valtioUseSnapshot } from 'valtio/react';
+import { affectedToPathList, createProxy, isChanged } from 'proxy-compare';
+import { useLensmcpContext, publish } from '@lensmcp/react-instrumentation';
+import { addSubscription, removeSubscription, storeIdOf } from './store-registry.js';
+// Shared across components for proxy reuse, exactly as valtio does.
+const targetCache = new WeakMap();
+export function useTrackedSnapshot(target, opts) {
+    const ctx = useLensmcpContext();
+    const path = opts.path ?? '';
+    const componentInstanceId = ctx.componentInstanceId ?? `react:component:anonymous`;
+    useEffect(() => {
+        emitSubscription('added', opts.storeId, path, componentInstanceId);
+        return () => {
+            emitSubscription('removed', opts.storeId, path, componentInstanceId);
+        };
+    }, [opts.storeId, path, componentInstanceId]);
+    return valtioUseSnapshot(target);
+}
+/**
+ * Drop-in `useSnapshot(store)` matching valtio's signature exactly. Infers
+ * the read paths from `proxy-compare`'s affected map and registers one
+ * subscription per path. Recovers the storeId tagged by the instrumented
+ * `proxy()`; falls back to a single root subscription when nothing is read.
+ */
+export function useSnapshot(target) {
+    const storeId = storeIdOf(target) ?? 'valtio:store:anonymous';
+    const ctx = useLensmcpContext();
+    const componentInstanceId = ctx.componentInstanceId ?? 'react:component:anonymous';
+    // ---- valtio v2's useSnapshot, inlined so we own `affected` ----
+    const affected = useMemo(() => target && new WeakMap(), [target]);
+    const lastSnapshot = useRef(undefined);
+    let inRender = true;
+    const currSnapshot = useSyncExternalStore(useCallback((callback) => {
+        const unsub = valtioSubscribe(target, callback, false);
+        callback();
+        return unsub;
+    }, [target]), () => {
+        const next = valtioSnapshot(target);
+        try {
+            if (!inRender &&
+                lastSnapshot.current &&
+                affected &&
+                !isChanged(lastSnapshot.current, next, affected, new WeakMap())) {
+                return lastSnapshot.current;
+            }
+        }
+        catch {
+            /* fall through to the fresh snapshot */
+        }
+        return next;
+    }, () => valtioSnapshot(target));
+    inRender = false;
+    useLayoutEffect(() => {
+        lastSnapshot.current = currSnapshot;
+    });
+    const proxyCache = useMemo(() => new WeakMap(), []);
+    // ---- LensMCP: reconcile per-path subscriptions to the read set ----
+    const subscribedRef = useRef(undefined);
+    if (!subscribedRef.current)
+        subscribedRef.current = new Set();
+    // Runs after every commit — `affected` now reflects this render's reads.
+    useEffect(() => {
+        const paths = affected
+            ? affectedToPathList(currSnapshot, affected, true).map((parts) => parts.map(String).join('.'))
+            : [];
+        const next = new Set(paths.length ? paths : ['']);
+        reconcileSubscriptions(subscribedRef.current, next, storeId, componentInstanceId);
+    });
+    // Drop all subscriptions on unmount.
+    useEffect(() => {
+        const subscribed = subscribedRef.current;
+        return () => {
+            for (const path of [...subscribed]) {
+                emitSubscription('removed', storeId, path, componentInstanceId);
+            }
+            subscribed.clear();
+        };
+    }, [storeId, componentInstanceId]);
+    return affected
+        ? createProxy(currSnapshot, affected, proxyCache, targetCache)
+        : currSnapshot;
+}
+/** Add/remove subscriptions so the registry matches `next` exactly. */
+function reconcileSubscriptions(prev, next, storeId, componentInstanceId) {
+    for (const path of next) {
+        if (!prev.has(path)) {
+            emitSubscription('added', storeId, path, componentInstanceId);
+        }
+    }
+    for (const path of [...prev]) {
+        if (!next.has(path)) {
+            emitSubscription('removed', storeId, path, componentInstanceId);
+        }
+    }
+    prev.clear();
+    for (const path of next)
+        prev.add(path);
+}
+function emitSubscription(kind, storeId, path, componentInstanceId) {
+    if (kind === 'added') {
+        addSubscription({ storeId, path, componentInstanceId });
+    }
+    else {
+        removeSubscription({ storeId, path, componentInstanceId });
+    }
+    const verb = kind === 'added' ? 'sub' : 'unsub';
+    publish({
+        source: 'valtio',
+        category: 'state',
+        severity: 'debug',
+        title: `subscription-${kind} ${storeId}.${path}`,
+        fingerprint: `valtio-${verb}:${storeId}:${path}:${componentInstanceId}`,
+        raw: {
+            kind: `subscription-${kind}`,
+            subscription: { storeId, path, componentInstanceId },
+        },
+    });
+}

package/lib/store-registry.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Module-level bookkeeping shared by `proxy`/`subscribe`/`useSnapshot`.
+ * The map from path → subscriber set is what `valtio://path/{path}/subscribers`
+ * shows; the reducer reads it indirectly via `subscription-added`
+ * events but we also keep a local copy so `useSnapshot` can attach the
+ * subscriber list inline to a `state-update`.
+ */
+export interface SubscriptionEntry {
+    storeId: string;
+    path: string;
+    componentInstanceId: string;
+}
+export declare function registerStore(storeId: string, source?: string): void;
+export declare function tagProxy(proxyObject: object, storeId: string): void;
+export declare function storeIdOf(proxyObject: object): string | undefined;
+export declare function isStoreRegistered(storeId: string): boolean;
+export declare function addSubscription(entry: SubscriptionEntry): void;
+export declare function removeSubscription(entry: SubscriptionEntry): void;
+export declare function subscribersFor(storeId: string, path: string): string[];
+/** Walk every prefix of `path` and union the subscribers. Used when a
+ *  state-update lands on a nested path but parent-path snapshot users
+ *  also need to be notified. */
+export declare function subscribersForPathAndParents(storeId: string, path: string): string[];
+export declare function resetRegistry(): void;
+//# sourceMappingURL=store-registry.d.ts.map

package/lib/store-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store-registry.d.ts","sourceRoot":"","sources":["../../src/lib/store-registry.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,EAAE,MAAM,CAAC;CAC7B;AAQD,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAEpE;AAED,wBAAgB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAEnE;AAED,wBAAgB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAQ9D;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAOjE;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAEtE;AAED;;gCAEgC;AAChC,wBAAgB,4BAA4B,CAC1C,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,GACX,MAAM,EAAE,CAUV;AAED,wBAAgB,aAAa,IAAI,IAAI,CAGpC"}

package/lib/store-registry.js

@@ -0,0 +1,58 @@
+const subs = new Map(); // key: `${storeId}::${path}` → set of componentInstanceIds
+const stores = new Map();
+// proxy object → its storeId, so the drop-in `useSnapshot(store)` can
+// recover the store id without the caller passing it.
+const proxyStoreIds = new WeakMap();
+export function registerStore(storeId, source) {
+    stores.set(storeId, { storeId, source });
+}
+export function tagProxy(proxyObject, storeId) {
+    proxyStoreIds.set(proxyObject, storeId);
+}
+export function storeIdOf(proxyObject) {
+    return proxyStoreIds.get(proxyObject);
+}
+export function isStoreRegistered(storeId) {
+    return stores.has(storeId);
+}
+export function addSubscription(entry) {
+    const key = `${entry.storeId}::${entry.path}`;
+    let set = subs.get(key);
+    if (!set) {
+        set = new Set();
+        subs.set(key, set);
+    }
+    set.add(entry.componentInstanceId);
+}
+export function removeSubscription(entry) {
+    const key = `${entry.storeId}::${entry.path}`;
+    const set = subs.get(key);
+    if (set) {
+        set.delete(entry.componentInstanceId);
+        if (set.size === 0)
+            subs.delete(key);
+    }
+}
+export function subscribersFor(storeId, path) {
+    return [...(subs.get(`${storeId}::${path}`) ?? [])];
+}
+/** Walk every prefix of `path` and union the subscribers. Used when a
+ *  state-update lands on a nested path but parent-path snapshot users
+ *  also need to be notified. */
+export function subscribersForPathAndParents(storeId, path) {
+    const out = new Set();
+    const parts = path.split('.');
+    for (let i = parts.length; i > 0; i--) {
+        const candidate = parts.slice(0, i).join('.');
+        for (const id of subscribersFor(storeId, candidate))
+            out.add(id);
+    }
+    // root subscribers
+    for (const id of subscribersFor(storeId, ''))
+        out.add(id);
+    return [...out];
+}
+export function resetRegistry() {
+    subs.clear();
+    stores.clear();
+}

package/lib/types.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Wire-shape payloads emitted by `@lensmcp/valtio-instrumentation`. The
+ * apps/valtio reducer consumes these via `event.raw.kind`.
+ */
+export interface ValtioUpdateRecord {
+    storeId: string;
+    path: string;
+    changedKeys: string[];
+    beforeHash: string;
+    afterHash: string;
+    preview?: unknown;
+    /** Components subscribing to this path at update time. */
+    subscribers: string[];
+}
+export interface ValtioStoreRecord {
+    storeId: string;
+    source?: string;
+    initialPreview?: unknown;
+}
+export interface ValtioSubscriptionRecord {
+    storeId: string;
+    path: string;
+    componentInstanceId?: string;
+}
+export type ValtioPublishPayload = {
+    kind: 'state-update';
+    update: ValtioUpdateRecord;
+} | {
+    kind: 'store-created';
+    store: ValtioStoreRecord;
+} | {
+    kind: 'subscription-added';
+    subscription: ValtioSubscriptionRecord;
+} | {
+    kind: 'subscription-removed';
+    subscription: ValtioSubscriptionRecord;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0DAA0D;IAC1D,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,MAAM,oBAAoB,GAC5B;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,GACpD;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,KAAK,EAAE,iBAAiB,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,YAAY,EAAE,wBAAwB,CAAA;CAAE,GACtE;IAAE,IAAI,EAAE,sBAAsB,CAAC;IAAC,YAAY,EAAE,wBAAwB,CAAA;CAAE,CAAC"}

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@lensmcp/valtio-instrumentation",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "dependencies": {
+    "@lensmcp/react-instrumentation": "1.0.0",
+    "proxy-compare": "^3.0.0",
+    "tslib": "^2.3.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "valtio": "^1.0.0 || ^2.0.0"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/kiwiapps-ltd/lensmcp#readme",
+  "bugs": {
+    "url": "https://github.com/kiwiapps-ltd/lensmcp/issues"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Drop-in instrumented Valtio for LensMCP — per-path subscription tracking.",
+  "keywords": [
+    "lensmcp",
+    "mcp",
+    "observability",
+    "ai-agents",
+    "claude",
+    "valtio",
+    "state"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kiwiapps-ltd/lensmcp.git",
+    "directory": "libs/valtio-instrumentation"
+  }
+}