sibujs 1.5.0 → 2.1.0

package/dist/patterns.d.cts

@@ -71,19 +71,24 @@ interface PersistOptions<T = unknown> {
      *  - use XOR with a static key — trivially reversible
      *  - roll your own cipher — nearly always broken
      *
+     * **Sync only:** because `persisted()` exposes synchronous getters and
+     * setters, both `encrypt` and `decrypt` must be SYNCHRONOUS. Async
+     * crypto (e.g. `crypto.subtle.encrypt`) is NOT supported here — derive
+     * keys ahead of time and use a sync wrapper, or pre/post-process the
+     * value yourself before/after `setValue`.
+     *
      * @example
      * ```ts
+     * // Pre-derived key + sync wrapper
      * persisted("token", "", {
-     *   encrypt: async (v) => aesGcmEncrypt(v, await getKey()),
-     *   decrypt: async (v) => aesGcmDecrypt(v, await getKey()),
+     *   encrypt: (v) => syncAesGcmEncrypt(v, derivedKey),
+     *   decrypt: (v) => syncAesGcmDecrypt(v, derivedKey),
      * });
      * ```
-     *
-     * Note that because localStorage is synchronous, any real AES-GCM
-     * flow needs pre-derived keys and is inherently best-effort.
      */
     encrypt?: (value: string) => string;
-    /** Decrypt the stored value before deserialization. Required if `encrypt` is set. */
+    /** Decrypt the stored value before deserialization. Required if `encrypt` is set.
+     *  Must be synchronous — see `encrypt` docs. */
     decrypt?: (value: string) => string;
 }
 declare function persisted<T>(key: string, initial: T, options?: PersistOptions<T>): [() => T, (next: T | ((prev: T) => T)) => void];
@@ -141,12 +146,6 @@ declare function optimisticList<T>(initialValue: T[]): {
     add: (item: T, asyncAction: () => Promise<T>) => Promise<void>;
     remove: (predicate: (item: T) => boolean, asyncAction: () => Promise<void>) => Promise<void>;
     update: (predicate: (item: T) => boolean, patch: Partial<T>, asyncAction: () => Promise<T>) => Promise<void>;
-    /** @deprecated Use `add` instead */
-    addOptimistic: (item: T, asyncAction: () => Promise<T>) => Promise<void>;
-    /** @deprecated Use `remove` instead */
-    removeOptimistic: (predicate: (item: T) => boolean, asyncAction: () => Promise<void>) => Promise<void>;
-    /** @deprecated Use `update` instead */
-    updateOptimistic: (predicate: (item: T) => boolean, patch: Partial<T>, asyncAction: () => Promise<T>) => Promise<void>;
 };
 
 interface TimeTravelReturn<T> {

package/dist/patterns.d.ts

@@ -71,19 +71,24 @@ interface PersistOptions<T = unknown> {
      *  - use XOR with a static key — trivially reversible
      *  - roll your own cipher — nearly always broken
      *
+     * **Sync only:** because `persisted()` exposes synchronous getters and
+     * setters, both `encrypt` and `decrypt` must be SYNCHRONOUS. Async
+     * crypto (e.g. `crypto.subtle.encrypt`) is NOT supported here — derive
+     * keys ahead of time and use a sync wrapper, or pre/post-process the
+     * value yourself before/after `setValue`.
+     *
      * @example
      * ```ts
+     * // Pre-derived key + sync wrapper
      * persisted("token", "", {
-     *   encrypt: async (v) => aesGcmEncrypt(v, await getKey()),
-     *   decrypt: async (v) => aesGcmDecrypt(v, await getKey()),
+     *   encrypt: (v) => syncAesGcmEncrypt(v, derivedKey),
+     *   decrypt: (v) => syncAesGcmDecrypt(v, derivedKey),
      * });
      * ```
-     *
-     * Note that because localStorage is synchronous, any real AES-GCM
-     * flow needs pre-derived keys and is inherently best-effort.
      */
     encrypt?: (value: string) => string;
-    /** Decrypt the stored value before deserialization. Required if `encrypt` is set. */
+    /** Decrypt the stored value before deserialization. Required if `encrypt` is set.
+     *  Must be synchronous — see `encrypt` docs. */
     decrypt?: (value: string) => string;
 }
 declare function persisted<T>(key: string, initial: T, options?: PersistOptions<T>): [() => T, (next: T | ((prev: T) => T)) => void];
@@ -141,12 +146,6 @@ declare function optimisticList<T>(initialValue: T[]): {
     add: (item: T, asyncAction: () => Promise<T>) => Promise<void>;
     remove: (predicate: (item: T) => boolean, asyncAction: () => Promise<void>) => Promise<void>;
     update: (predicate: (item: T) => boolean, patch: Partial<T>, asyncAction: () => Promise<T>) => Promise<void>;
-    /** @deprecated Use `add` instead */
-    addOptimistic: (item: T, asyncAction: () => Promise<T>) => Promise<void>;
-    /** @deprecated Use `remove` instead */
-    removeOptimistic: (predicate: (item: T) => boolean, asyncAction: () => Promise<void>) => Promise<void>;
-    /** @deprecated Use `update` instead */
-    updateOptimistic: (predicate: (item: T) => boolean, patch: Partial<T>, asyncAction: () => Promise<T>) => Promise<void>;
 };
 
 interface TimeTravelReturn<T> {

package/dist/patterns.js

@@ -5,7 +5,7 @@ import {
   optimisticList,
   persisted,
   timeline
-} from "./chunk-VAPYJN4X.js";
+} from "./chunk-V6C4FADE.js";
 import {
   RenderProp,
   assertType,
@@ -22,12 +22,12 @@ import {
   withProps,
   withWrapper
 } from "./chunk-CNZ35WI2.js";
-import "./chunk-XHK6BDAJ.js";
-import "./chunk-VQNQZCWJ.js";
-import "./chunk-EUZND3CB.js";
-import "./chunk-NZIIMDWI.js";
-import "./chunk-K4G4ZQNR.js";
-import "./chunk-5X6PP2UK.js";
+import "./chunk-DRUZZAK4.js";
+import "./chunk-WZA53FXU.js";
+import "./chunk-2RA7SHDA.js";
+import "./chunk-RDTDJCAB.js";
+import "./chunk-QO3WC6FS.js";
+import "./chunk-LMLD24FC.js";
 export {
   RenderProp,
   assertType,