@buoy-gg/storage 7.0.16 → 7.0.18

package/lib/typescript/storage/sync/storageSyncAdapter.d.ts

@@ -1,6 +1,29 @@
+import { type StorageEvent } from "../stores/storageEventStore";
+/**
+ * Sentinel used in WIRE-FORM snapshots in place of oversized values.
+ * Storage events, MMKV browse dumps, and SecureStore dumps all reuse this
+ * marker. Dashboards fetch the real payload via `getEventDetail` / `mmkv.get`
+ * / `secure.get`.
+ */
+export declare const VALUE_ON_DEVICE: Readonly<{
+    __buoyValueOnDevice: true;
+    note: "Value stays on the device — fetched on demand via getEventDetail / mmkv.get / secure.get.";
+}>;
+/** Max serialized bytes of one storage value on the list snapshot. */
+export declare const SNAPSHOT_VALUE_INLINE_LIMIT: number;
+/**
+ * Total inline budget for one snapshot's event list, held under the emit
+ * layer's 2MB so a snapshot is never DROPPED (a drop leaves the whole panel
+ * stale). Per-value caps alone don't get there: the store keeps 500 events, so
+ * 500 writes of an individually-legal 9KB value still total ~4.7MB. Newest
+ * events keep their values inline; once the budget is spent, older ones
+ * degrade to metadata + fetch-on-demand.
+ */
+export declare const SNAPSHOT_EVENTS_BUDGET: number;
 /** One MMKV entry in a `mmkv.snapshot` result. */
 export interface MMKVSnapshotEntry {
     key: string;
+    /** Oversized values are replaced with VALUE_ON_DEVICE on the wire. */
     value: unknown;
     valueType: string;
 }
@@ -17,8 +40,11 @@ export interface SecureSnapshotEntry {
     description?: string;
     keychainService?: string;
     requireAuthentication: boolean;
-    /** `null` when unset, or when the key is biometric-protected (never read). */
-    value: string | null;
+    /**
+     * `null` when unset, or when the key is biometric-protected (never read).
+     * Oversized values are replaced with VALUE_ON_DEVICE on the wire.
+     */
+    value: unknown;
 }
 /**
  * Sync adapter for the storage tool, consumed by @buoy-gg/external-sync's
@@ -31,19 +57,39 @@ export interface SecureSnapshotEntry {
  *
  * The `async.*` actions mirror the AsyncStorage API so the desktop dashboard
  * can proxy its browse/edit mode against the device's real storage.
+ *
+ * v2: oversized / unserializable event values are replaced with
+ * VALUE_ON_DEVICE. Dashboards fetch them via `getEventDetail`.
  */
 export declare const storageSyncAdapter: {
     version: number;
-    getSnapshot: () => import("../..").StorageEvent[];
+    getSnapshot: () => StorageEvent[];
     subscribe: (onChange: () => void) => () => void;
     actions: {
         clearEvents: () => void;
+        /**
+         * On-demand detail: one event's real value/prevValue/pairs.
+         * The per-snapshot stream stays payload-light; this is the explicit,
+         * size-guarded channel for the detail pane (and for time-travel undo,
+         * which needs `prevValue`).
+         */
+        getEventDetail: (params: unknown) => {
+            found: false;
+            reason: string;
+            id?: undefined;
+            event?: undefined;
+        } | {
+            found: true;
+            id: string;
+            event: StorageEvent;
+            reason?: undefined;
+        };
         /** Clears all app storage keys, preserving dev tools settings. */
         clearAppStorage: () => Promise<void>;
         /** Undo one event, addressed by the `id` the store assigned it. */
         "timeTravel.undo": (params: unknown) => Promise<{
             undone: boolean;
-            action: "clear" | "mergeItem" | "multiSet" | "multiRemove" | "setItem" | "removeItem" | "multiMerge";
+            action: "mergeItem" | "multiSet" | "multiRemove" | "clear" | "setItem" | "removeItem" | "multiMerge";
             key: string | undefined;
         }>;
         /**
@@ -53,7 +99,7 @@ export declare const storageSyncAdapter: {
          */
         "timeTravel.jump": (params: unknown) => Promise<{
             jumped: boolean;
-            scope: "all" | "key";
+            scope: "key" | "all";
             replayed: number;
             of: number;
             key: string | undefined;
@@ -67,6 +113,26 @@ export declare const storageSyncAdapter: {
         "async.multiSet": (params: unknown) => Promise<void>;
         "async.clear": () => Promise<void>;
         "mmkv.snapshot": () => MMKVSnapshotInstance[];
+        /**
+         * On-demand MMKV value. `mmkv.snapshot` omits oversized strings so a
+         * browse poll cannot blow the action-result budget; this is the
+         * size-guarded channel for one key.
+         */
+        "mmkv.get": (params: unknown) => {
+            found: false;
+            reason: string;
+            instanceId?: undefined;
+            key?: undefined;
+            value?: undefined;
+            valueType?: undefined;
+        } | {
+            found: true;
+            instanceId: string;
+            key: string;
+            value: unknown;
+            valueType: import("../..").MMKVValueType;
+            reason?: undefined;
+        };
         "mmkv.set": (params: unknown) => void;
         "mmkv.remove": (params: unknown) => void;
         "secure.keys": () => {

package/lib/typescript/storage/sync/storageSyncAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storageSyncAdapter.d.ts","sourceRoot":"","sources":["../../../../src/storage/sync/storageSyncAdapter.ts"],"names":[],"mappings":"AAsCA,kDAAkD;AAClD,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,iBAAiB,EAAE,CAAC;CAC9B;AAED,wDAAwD;AACxD,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,8EAA8E;IAC9E,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAsBD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB;;;0BAaP,MAAM,IAAI;;;QAM9B,kEAAkE;;QAOlE,mEAAmE;oCACjC,OAAO;;;;;QAkBzC;;;;WAIG;oCAC+B,OAAO;;;;;;;;mCAyCR,OAAO;kCAId,OAAO;kCAMP,OAAO;qCAIJ,OAAO;sCAEN,OAAO;mCAEV,OAAO;;+BAOb,oBAAoB,EAAE;6BAgBtB,OAAO;gCAIJ,OAAO;;;;;;;QAkB/B;;;;;WAKG;iCAC0B,OAAO,CAAC,mBAAmB,EAAE,CAAC;+BAwBpC,OAAO;QAW9B;;;;;WAKG;+BACoB,OAAO;kCAIJ,OAAO;;CAGpC,CAAC"}
+{"version":3,"file":"storageSyncAdapter.d.ts","sourceRoot":"","sources":["../../../../src/storage/sync/storageSyncAdapter.ts"],"names":[],"mappings":"AAQA,OAAO,EAGL,KAAK,YAAY,EAClB,MAAM,6BAA6B,CAAC;AAYrC;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;EAG1B,CAAC;AAEH,sEAAsE;AACtE,eAAO,MAAM,2BAA2B,QAAY,CAAC;AAErD;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,QAAqB,CAAC;AA4JzD,kDAAkD;AAClD,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,sEAAsE;IACtE,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,iBAAiB,EAAE,CAAC;CAC9B;AAED,wDAAwD;AACxD,MAAM,WAAW,mBAAmB;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAsBD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB;;;0BAeP,MAAM,IAAI;;;QAM9B;;;;;WAKG;iCACsB,OAAO;;;;;;;;;;;QAUhC,kEAAkE;;QAOlE,mEAAmE;oCACjC,OAAO;;;;;QAkBzC;;;;WAIG;oCAC+B,OAAO;;;;;;;;mCAyCR,OAAO;kCAId,OAAO;kCAMP,OAAO;qCAIJ,OAAO;sCAEN,OAAO;mCAEV,OAAO;;+BAOb,oBAAoB,EAAE;QAgB3C;;;;WAIG;6BACkB,OAAO;;;;;;;;;;;;;;;6BAkBP,OAAO;gCAIJ,OAAO;;;;;;;QAkB/B;;;;;WAKG;iCAC0B,OAAO,CAAC,mBAAmB,EAAE,CAAC;+BAwBpC,OAAO;QAW9B;;;;;WAKG;+BACoB,OAAO;kCAIJ,OAAO;;CAGpC,CAAC"}

package/lib/typescript/storage/types.d.ts

@@ -12,17 +12,17 @@ export interface StorageKeyInfo {
     category: "required" | "optional";
     lastUpdated?: Date;
 }
+/**
+ * A required key the browser validates. `storageType` scopes the check to one
+ * backend — without it, every backend's hook historically synthesized its own
+ * Missing row for the same key (Async + MMKV both counting it). Prefer always
+ * setting `storageType` when more than one backend is registered.
+ */
 export type RequiredStorageKey = string | {
     key: string;
-    expectedValue: string;
-    description?: string;
-} | {
-    key: string;
-    expectedType: string;
-    description?: string;
-} | {
-    key: string;
-    storageType: StorageType;
+    expectedValue?: string;
+    expectedType?: string;
+    storageType?: StorageType;
     description?: string;
 };
 export interface StorageKeyStats {

package/lib/typescript/storage/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/storage/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EACF,kBAAkB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,qBAAqB,GACrB,kBAAkB,CAAC;IACvB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5D;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,WAAW,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpE,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IAEtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/storage/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAExD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;IACvD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EACF,kBAAkB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,qBAAqB,GACrB,kBAAkB,CAAC;IACvB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,WAAW,CAAC,EAAE,IAAI,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN;IACE,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IAEtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IAEpB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC"}

package/lib/typescript/storage/utils/requiredStorageKeyScope.d.ts

@@ -0,0 +1,10 @@
+import type { RequiredStorageKey } from "../types";
+import type { StorageType } from "./storageQueryUtils";
+/**
+ * Whether a required-key declaration should be enforced by a given backend
+ * hook. Explicit `storageType` wins; bare string keys default to AsyncStorage
+ * (the historical zero-config backend). Objects without `storageType` still
+ * apply to every backend — matching prior behavior for apps that never set it.
+ */
+export declare function requiredKeyAppliesTo(req: RequiredStorageKey, backend: StorageType): boolean;
+//# sourceMappingURL=requiredStorageKeyScope.d.ts.map

package/lib/typescript/storage/utils/requiredStorageKeyScope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requiredStorageKeyScope.d.ts","sourceRoot":"","sources":["../../../../src/storage/utils/requiredStorageKeyScope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEvD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,kBAAkB,EACvB,OAAO,EAAE,WAAW,GACnB,OAAO,CAIT"}

package/lib/typescript/storage/utils/snapshotProvider.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=snapshotProvider.d.ts.map

package/lib/typescript/storage/utils/snapshotProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotProvider.d.ts","sourceRoot":"","sources":["../../../../src/storage/utils/snapshotProvider.ts"],"names":[],"mappings":""}

package/lib/typescript/storage/utils/storageTimeTravelUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storageTimeTravelUtils.d.ts","sourceRoot":"","sources":["../../../../src/storage/utils/storageTimeTravelUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;;;;;;;;;;;GAaG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAkE3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,iBAAiB,EAAE,EAC3B,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC,CAuCf;AAoGD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAoBzD"}
+{"version":3,"file":"storageTimeTravelUtils.d.ts","sourceRoot":"","sources":["../../../../src/storage/utils/storageTimeTravelUtils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAUhE;;;;;;;;;;;;;GAaG;AACH,wBAAsB,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CA0E3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,iBAAiB,EAAE,EAC3B,gBAAgB,EAAE,MAAM,GACvB,OAAO,CAAC,IAAI,CAAC,CAqDf;AAoGD;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAyBzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@buoy-gg/storage",
-  "version": "7.0.16",
+  "version": "7.0.18",
   "description": "Browse & edit AsyncStorage, MMKV & SecureStore inside your React Native app, with change history. Part of Buoy devtools.",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",
@@ -24,13 +24,16 @@
   "files": [
     "lib"
   ],
-  "sideEffects": false,
+  "sideEffects": [
+    "**/snapshotProvider.js",
+    "**/snapshotProvider.ts"
+  ],
   "dependencies": {
-    "@buoy-gg/floating-tools-core": "^7.0.16",
-    "@buoy-gg/shared-ui": "^7.0.16"
+    "@buoy-gg/floating-tools-core": "^7.0.18",
+    "@buoy-gg/shared-ui": "^7.0.18"
   },
   "peerDependencies": {
-    "@buoy-gg/license": "7.0.16",
+    "@buoy-gg/license": "7.0.18",
     "@react-native-async-storage/async-storage": "^2.0.0 || ^3.1.0",
     "react": "*",
     "react-native": "*"
@@ -40,7 +43,7 @@
     "@types/react": "^19.1.0",
     "@types/react-native": "^0.73.0",
     "typescript": "~5.8.3",
-    "@buoy-gg/license": "^7.0.16"
+    "@buoy-gg/license": "^7.0.18"
   },
   "react-native-builder-bob": {
     "source": "src",