@effect/platform-browser 4.0.0-beta.7 → 4.0.0-beta.71

package/dist/BrowserKeyValueStore.js

@@ -1,20 +1,195 @@
-import * as KeyValueStore from "effect/unstable/persistence/KeyValueStore";
 /**
- * Creates a `KeyValueStore` layer that uses the browser's `localStorage` api.
+ * Browser-backed `KeyValueStore` layers for client-side Effect programs.
+ *
+ * This module provides browser implementations of the unstable persistence
+ * `KeyValueStore` service. Use {@link layerLocalStorage} for small
+ * origin-scoped values that should survive reloads and browser restarts, use
+ * {@link layerSessionStorage} for tab / page-session state, and use
+ * {@link layerIndexedDb} when the store should be asynchronous and backed by
+ * IndexedDB.
+ *
+ * ## Mental model
+ *
+ * All exports provide the same `KeyValueStore.KeyValueStore` service; the layer
+ * chooses the browser storage backend. The Web Storage layers delegate to
+ * `globalThis.localStorage` or `globalThis.sessionStorage` and adapt the
+ * string-only API, encoding `Uint8Array` values as base64. The IndexedDB layer
+ * stores strings and `Uint8Array` values in an object store and requires the
+ * browser `IndexedDb` service to open the database.
+ *
+ * ## Common tasks
+ *
+ * - Persist user preferences, lightweight caches, or drafts with
+ *   {@link layerLocalStorage}.
+ * - Keep tab-scoped workflow state with {@link layerSessionStorage}.
+ * - Avoid blocking the main thread for larger client-side stores by using
+ *   {@link layerIndexedDb}.
+ *
+ * ## Gotchas
  *
- * Values are stored between sessions.
+ * These layers only work where browser storage APIs are available. Browsers may
+ * deny storage in private modes, sandboxed frames, disabled-storage settings, or
+ * quota-limited contexts. Web Storage is synchronous and origin-scoped, so keep
+ * payloads small and do not use it as a secure store for secrets. IndexedDB is
+ * asynchronous but can still be blocked by permissions, quota limits, version
+ * upgrades, or other open tabs.
  *
- * @since 1.0.0
- * @category Layers
+ * **Example** (Provide localStorage to a program)
+ *
+ * ```ts
+ * import { BrowserKeyValueStore } from "@effect/platform-browser"
+ * import { Effect } from "effect"
+ * import { KeyValueStore } from "effect/unstable/persistence"
+ *
+ * const program = Effect.gen(function*() {
+ *   const store = yield* KeyValueStore.KeyValueStore
+ *   yield* store.set("theme", "dark")
+ *   return yield* store.get("theme")
+ * }).pipe(
+ *   Effect.provide(BrowserKeyValueStore.layerLocalStorage)
+ * )
+ * ```
+ *
+ * @since 4.0.0
  */
-export const layerLocalStorage = /*#__PURE__*/KeyValueStore.layerStorage(() => globalThis.localStorage);
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as KeyValueStore from "effect/unstable/persistence/KeyValueStore";
+import { IndexedDb } from "./IndexedDb.js";
 /**
- * Creates a `KeyValueStore` layer that uses the browser's `sessionStorage` api.
+ * Creates a `KeyValueStore` layer that uses the browser's `localStorage` API and stores values between browser sessions.
  *
- * Values are stored only for the current session.
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerLocalStorage = /*#__PURE__*/KeyValueStore.layerStorage(() => globalThis.localStorage);
+/**
+ * Creates a `KeyValueStore` layer that uses the browser's `sessionStorage` API and stores values only for the current session.
  *
- * @since 1.0.0
- * @category Layers
+ * @category layers
+ * @since 4.0.0
  */
 export const layerSessionStorage = /*#__PURE__*/KeyValueStore.layerStorage(() => globalThis.sessionStorage);
+/**
+ * Creates a `KeyValueStore` layer backed by IndexedDB.
+ *
+ * **When to use**
+ *
+ * Use when a browser `KeyValueStore` needs persistent asynchronous IndexedDB
+ * storage instead of the synchronous Web Storage APIs.
+ *
+ * **Details**
+ *
+ * The database name defaults to `"effect_key_value_store"`. The layer requires
+ * the `IndexedDb` service and stores string and `Uint8Array` values in the same
+ * backing object store.
+ *
+ * **Gotchas**
+ *
+ * IndexedDB may be unavailable or blocked by browser settings, private browsing,
+ * quota limits, or restricted contexts. The string and `Uint8Array` accessors do
+ * not coerce values stored with the other representation.
+ *
+ * @see {@link layerLocalStorage} for synchronous persistent Web Storage
+ * @see {@link layerSessionStorage} for synchronous tab-session Web Storage
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerIndexedDb = options => Layer.effect(KeyValueStore.KeyValueStore)(Effect.gen(function* () {
+  const db = yield* Effect.acquireRelease(openDatabase(options?.database ?? "effect_key_value_store"), db => Effect.sync(() => db.close())).pipe(Effect.orDie);
+  return KeyValueStore.make({
+    clear: Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readwrite");
+      return idbRequest({
+        method: "clear",
+        message: "Failed to clear backing store"
+      }, () => store.clear());
+    }),
+    get: key => Effect.map(Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readonly");
+      return idbRequest({
+        method: "get",
+        message: "Failed to get value from backing store",
+        key
+      }, () => store.get(key));
+    }), found => typeof found?.value === "string" ? found.value : undefined),
+    getUint8Array: key => Effect.map(Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readonly");
+      return idbRequest({
+        method: "getUint8Array",
+        message: "Failed to get value from backing store",
+        key
+      }, () => store.get(key));
+    }), found => found?.value && found.value instanceof Uint8Array ? found.value : undefined),
+    set: (key, value) => Effect.asVoid(Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readwrite");
+      return idbRequest({
+        method: "set",
+        message: "Failed to set value in backing store",
+        key
+      }, () => store.put({
+        key,
+        value
+      }));
+    })),
+    size: Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readonly");
+      return idbRequest({
+        method: "size",
+        message: "Failed to get backing store size"
+      }, () => store.count());
+    }),
+    remove: key => Effect.asVoid(Effect.suspend(() => {
+      const store = getKvsEntriesStore(db, "readwrite");
+      return idbRequest({
+        method: "remove",
+        message: "Failed to remove value from backing store",
+        key
+      }, () => store.delete(key));
+    }))
+  });
+}));
+const databaseVersion = 1;
+const entriesStoreName = "entries";
+const openDatabase = /*#__PURE__*/Effect.fnUntraced(function* (database) {
+  const idb = (yield* IndexedDb).indexedDB;
+  const openRequest = yield* Effect.try({
+    try: () => idb.open(database, databaseVersion),
+    catch: cause => new KeyValueStore.KeyValueStoreError({
+      method: "open",
+      message: "Failed to open backing store database",
+      cause
+    })
+  });
+  openRequest.onupgradeneeded = () => {
+    const db = openRequest.result;
+    if (!db.objectStoreNames.contains(entriesStoreName)) {
+      db.createObjectStore(entriesStoreName, {
+        keyPath: "key"
+      });
+    }
+  };
+  return yield* idbRequest({
+    method: "open",
+    message: "Failed to open backing store database"
+  }, () => openRequest);
+});
+const idbRequest = (failArgs, evaluate) => Effect.callback(resume => {
+  const request = evaluate();
+  if (request.readyState === "done") {
+    return resume(Effect.succeed(request.result));
+  }
+  request.onsuccess = () => {
+    resume(Effect.succeed(request.result));
+  };
+  request.onerror = () => resume(Effect.fail(new KeyValueStore.KeyValueStoreError({
+    ...failArgs,
+    cause: request.error
+  })));
+});
+const getKvsEntriesStore = (db, mode) => {
+  const transaction = db.transaction(entriesStoreName, mode);
+  return transaction.objectStore(entriesStoreName);
+};
 //# sourceMappingURL=BrowserKeyValueStore.js.map

package/dist/BrowserKeyValueStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserKeyValueStore.js","names":["KeyValueStore","layerLocalStorage","layerStorage","globalThis","localStorage","layerSessionStorage","sessionStorage"],"sources":["../src/BrowserKeyValueStore.ts"],"sourcesContent":[null],"mappings":"AAIA,OAAO,KAAKA,aAAa,MAAM,2CAA2C;AAE1E;;;;;;;;AAQA,OAAO,MAAMC,iBAAiB,gBAA6CD,aAAa,CAACE,YAAY,CAAC,MACpGC,UAAU,CAACC,YAAY,CACxB;AAED;;;;;;;;AAQA,OAAO,MAAMC,mBAAmB,gBAA6CL,aAAa,CAACE,YAAY,CAAC,MACtGC,UAAU,CAACG,cAAc,CAC1B","ignoreList":[]}
+{"version":3,"file":"BrowserKeyValueStore.js","names":["Effect","Layer","KeyValueStore","IndexedDb","layerLocalStorage","layerStorage","globalThis","localStorage","layerSessionStorage","sessionStorage","layerIndexedDb","options","effect","gen","db","acquireRelease","openDatabase","database","sync","close","pipe","orDie","make","clear","suspend","store","getKvsEntriesStore","idbRequest","method","message","get","key","map","found","value","undefined","getUint8Array","Uint8Array","set","asVoid","put","size","count","remove","delete","databaseVersion","entriesStoreName","fnUntraced","idb","indexedDB","openRequest","try","open","catch","cause","KeyValueStoreError","onupgradeneeded","result","objectStoreNames","contains","createObjectStore","keyPath","failArgs","evaluate","callback","resume","request","readyState","succeed","onsuccess","onerror","fail","error","mode","transaction","objectStore"],"sources":["../src/BrowserKeyValueStore.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDA,OAAO,KAAKA,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,aAAa,MAAM,2CAA2C;AAC1E,SAASC,SAAS,QAAQ,gBAAgB;AAE1C;;;;;;AAMA,OAAO,MAAMC,iBAAiB,gBAA6CF,aAAa,CAACG,YAAY,CAAC,MACpGC,UAAU,CAACC,YAAY,CACxB;AAED;;;;;;AAMA,OAAO,MAAMC,mBAAmB,gBAA6CN,aAAa,CAACG,YAAY,CAAC,MACtGC,UAAU,CAACG,cAAc,CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAMC,cAAc,GAAIC,OAE9B,IACCV,KAAK,CAACW,MAAM,CAACV,aAAa,CAACA,aAAa,CAAC,CACvCF,MAAM,CAACa,GAAG,CAAC,aAAS;EAClB,MAAMC,EAAE,GAAG,OAAOd,MAAM,CAACe,cAAc,CACrCC,YAAY,CAACL,OAAO,EAAEM,QAAQ,IAAI,wBAAwB,CAAC,EAC1DH,EAAE,IAAKd,MAAM,CAACkB,IAAI,CAAC,MAAMJ,EAAE,CAACK,KAAK,EAAE,CAAC,CACtC,CAACC,IAAI,CAACpB,MAAM,CAACqB,KAAK,CAAC;EAEpB,OAAOnB,aAAa,CAACoB,IAAI,CAAC;IACxBC,KAAK,EAAEvB,MAAM,CAACwB,OAAO,CAAC,MAAK;MACzB,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,WAAW,CAAC;MACjD,OAAOa,UAAU,CAAC;QAAEC,MAAM,EAAE,OAAO;QAAEC,OAAO,EAAE;MAA+B,CAAE,EAAE,MAAMJ,KAAK,CAACF,KAAK,EAAE,CAAC;IACvG,CAAC,CAAC;IACFO,GAAG,EAAGC,GAAW,IACf/B,MAAM,CAACgC,GAAG,CACRhC,MAAM,CAACwB,OAAO,CAAC,MAAK;MAClB,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,UAAU,CAAC;MAChD,OAAOa,UAAU,CAA6C;QAC5DC,MAAM,EAAE,KAAK;QACbC,OAAO,EAAE,wCAAwC;QACjDE;OACD,EAAE,MAAMN,KAAK,CAACK,GAAG,CAACC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC,EACDE,KAAK,IAAK,OAAOA,KAAK,EAAEC,KAAK,KAAK,QAAQ,GAAGD,KAAK,CAACC,KAAK,GAAGC,SAAS,CACtE;IACHC,aAAa,EAAGL,GAAW,IACzB/B,MAAM,CAACgC,GAAG,CACRhC,MAAM,CAACwB,OAAO,CAAC,MAAK;MAClB,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,UAAU,CAAC;MAChD,OAAOa,UAAU,CAAiD;QAChEC,MAAM,EAAE,eAAe;QACvBC,OAAO,EAAE,wCAAwC;QACjDE;OACD,EAAE,MAAMN,KAAK,CAACK,GAAG,CAACC,GAAG,CAAC,CAAC;IAC1B,CAAC,CAAC,EACDE,KAAK,IAAKA,KAAK,EAAEC,KAAK,IAAID,KAAK,CAACC,KAAK,YAAYG,UAAU,GAAGJ,KAAK,CAACC,KAAK,GAAGC,SAAS,CACvF;IACHG,GAAG,EAAEA,CAACP,GAAW,EAAEG,KAA0B,KAC3ClC,MAAM,CAACuC,MAAM,CAACvC,MAAM,CAACwB,OAAO,CAAC,MAAK;MAChC,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,WAAW,CAAC;MACjD,OAAOa,UAAU,CACf;QAAEC,MAAM,EAAE,KAAK;QAAEC,OAAO,EAAE,sCAAsC;QAAEE;MAAG,CAAE,EACvE,MAAMN,KAAK,CAACe,GAAG,CAAC;QAAET,GAAG;QAAEG;MAAK,CAAE,CAAC,CAChC;IACH,CAAC,CAAC,CAAC;IACLO,IAAI,EAAEzC,MAAM,CAACwB,OAAO,CAAC,MAAK;MACxB,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,UAAU,CAAC;MAChD,OAAOa,UAAU,CACf;QAAEC,MAAM,EAAE,MAAM;QAAEC,OAAO,EAAE;MAAkC,CAAE,EAC/D,MAAMJ,KAAK,CAACiB,KAAK,EAAE,CACpB;IACH,CAAC,CAAC;IACFC,MAAM,EAAGZ,GAAW,IAClB/B,MAAM,CAACuC,MAAM,CAACvC,MAAM,CAACwB,OAAO,CAAC,MAAK;MAChC,MAAMC,KAAK,GAAGC,kBAAkB,CAACZ,EAAE,EAAE,WAAW,CAAC;MACjD,OAAOa,UAAU,CACf;QAAEC,MAAM,EAAE,QAAQ;QAAEC,OAAO,EAAE,2CAA2C;QAAEE;MAAG,CAAE,EAC/E,MAAMN,KAAK,CAACmB,MAAM,CAACb,GAAG,CAAC,CACxB;IACH,CAAC,CAAC;GACL,CAAC;AACJ,CAAC,CAAC,CACH;AAEH,MAAMc,eAAe,GAAG,CAAC;AACzB,MAAMC,gBAAgB,GAAG,SAAS;AAClC,MAAM9B,YAAY,gBAAGhB,MAAM,CAAC+C,UAAU,CAAC,WAAU9B,QAAgB;EAC/D,MAAM+B,GAAG,GAAG,CAAC,OAAO7C,SAAS,EAAE8C,SAAS;EACxC,MAAMC,WAAW,GAAG,OAAOlD,MAAM,CAACmD,GAAG,CAAC;IACpCA,GAAG,EAAEA,CAAA,KAAMH,GAAG,CAACI,IAAI,CAACnC,QAAQ,EAAE4B,eAAe,CAAC;IAC9CQ,KAAK,EAAGC,KAAK,IACX,IAAIpD,aAAa,CAACqD,kBAAkB,CAAC;MACnC3B,MAAM,EAAE,MAAM;MACdC,OAAO,EAAE,uCAAuC;MAChDyB;KACD;GACJ,CAAC;EACFJ,WAAW,CAACM,eAAe,GAAG,MAAK;IACjC,MAAM1C,EAAE,GAAGoC,WAAW,CAACO,MAAM;IAC7B,IAAI,CAAC3C,EAAE,CAAC4C,gBAAgB,CAACC,QAAQ,CAACb,gBAAgB,CAAC,EAAE;MACnDhC,EAAE,CAAC8C,iBAAiB,CAACd,gBAAgB,EAAE;QAAEe,OAAO,EAAE;MAAK,CAAE,CAAC;IAC5D;EACF,CAAC;EACD,OAAO,OAAOlC,UAAU,CAAC;IAAEC,MAAM,EAAE,MAAM;IAAEC,OAAO,EAAE;EAAuC,CAAE,EAAE,MAAMqB,WAAW,CAAC;AACnH,CAAC,CAAC;AAEF,MAAMvB,UAAU,GAAGA,CACjBmC,QAA2D,EAC3DC,QAA6B,KAE7B/D,MAAM,CAACgE,QAAQ,CAAuCC,MAAM,IAAI;EAC9D,MAAMC,OAAO,GAAGH,QAAQ,EAAE;EAC1B,IAAIG,OAAO,CAACC,UAAU,KAAK,MAAM,EAAE;IACjC,OAAOF,MAAM,CAACjE,MAAM,CAACoE,OAAO,CAACF,OAAO,CAACT,MAAM,CAAC,CAAC;EAC/C;EACAS,OAAO,CAACG,SAAS,GAAG,MAAK;IACvBJ,MAAM,CAACjE,MAAM,CAACoE,OAAO,CAACF,OAAO,CAACT,MAAM,CAAC,CAAC;EACxC,CAAC;EACDS,OAAO,CAACI,OAAO,GAAG,MAChBL,MAAM,CAACjE,MAAM,CAACuE,IAAI,CAChB,IAAIrE,aAAa,CAACqD,kBAAkB,CAAC;IACnC,GAAGO,QAAQ;IACXR,KAAK,EAAEY,OAAO,CAACM;GAChB,CAAC,CACH,CAAC;AACN,CAAC,CAAC;AAEJ,MAAM9C,kBAAkB,GAAGA,CAACZ,EAAe,EAAE2D,IAAwB,KAAI;EACvE,MAAMC,WAAW,GAAG5D,EAAE,CAAC4D,WAAW,CAAC5B,gBAAgB,EAAE2B,IAAI,CAAC;EAC1D,OAAOC,WAAW,CAACC,WAAW,CAAC7B,gBAAgB,CAAC;AAClD,CAAC","ignoreList":[]}

package/dist/BrowserPersistence.d.ts

@@ -0,0 +1,40 @@
+import * as Layer from "effect/Layer";
+import * as Persistence from "effect/unstable/persistence/Persistence";
+/**
+ * Creates a `BackingPersistence` layer backed by IndexedDB, optionally using the provided database name.
+ *
+ * **When to use**
+ *
+ * Use when composing persistence manually and the lower-level
+ * `BackingPersistence` service should be backed by browser IndexedDB.
+ *
+ * **Details**
+ *
+ * The database name defaults to `"effect_persistence"`. Entries are stored by
+ * persistence store id and key in a shared object store, and TTL expiration is
+ * checked when values are read.
+ *
+ * **Gotchas**
+ *
+ * Opening the database is defected during layer acquisition if IndexedDB is
+ * unavailable or cannot be opened. Store operations report `PersistenceError`
+ * for IndexedDB request, transaction, quota, and structured-clone failures.
+ *
+ * @see {@link layerIndexedDb} for providing the higher-level `Persistence` service
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export declare const layerBackingIndexedDb: (options?: {
+    readonly database?: string | undefined;
+}) => Layer.Layer<Persistence.BackingPersistence>;
+/**
+ * Creates a `Persistence` layer backed by IndexedDB, optionally using the provided database name.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export declare const layerIndexedDb: (options?: {
+    readonly database?: string | undefined;
+}) => Layer.Layer<Persistence.Persistence>;
+//# sourceMappingURL=BrowserPersistence.d.ts.map

package/dist/BrowserPersistence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserPersistence.d.ts","sourceRoot":"","sources":["../src/BrowserPersistence.ts"],"names":[],"mappings":"AAyDA,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,WAAW,MAAM,yCAAyC,CAAA;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,qBAAqB,GAAI,UAAU;IAC9C,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACvC,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,kBAAkB,CAoBzC,CAAA;AAOL;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACvC,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,WAAW,CAGpC,CAAA"}

package/dist/BrowserPersistence.js

@@ -0,0 +1,207 @@
+import * as Clock from "effect/Clock";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Persistence from "effect/unstable/persistence/Persistence";
+/**
+ * Creates a `BackingPersistence` layer backed by IndexedDB, optionally using the provided database name.
+ *
+ * **When to use**
+ *
+ * Use when composing persistence manually and the lower-level
+ * `BackingPersistence` service should be backed by browser IndexedDB.
+ *
+ * **Details**
+ *
+ * The database name defaults to `"effect_persistence"`. Entries are stored by
+ * persistence store id and key in a shared object store, and TTL expiration is
+ * checked when values are read.
+ *
+ * **Gotchas**
+ *
+ * Opening the database is defected during layer acquisition if IndexedDB is
+ * unavailable or cannot be opened. Store operations report `PersistenceError`
+ * for IndexedDB request, transaction, quota, and structured-clone failures.
+ *
+ * @see {@link layerIndexedDb} for providing the higher-level `Persistence` service
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerBackingIndexedDb = options => Layer.effect(Persistence.BackingPersistence)(Effect.gen(function* () {
+  const db = yield* Effect.acquireRelease(openDatabase(options?.database ?? defaultDatabase), db => Effect.sync(() => db.close())).pipe(Effect.orDie);
+  return Persistence.BackingPersistence.of({
+    make: Effect.fnUntraced(function* (storeId) {
+      const clock = yield* Clock.Clock;
+      return {
+        get: key => get(db, clock, storeId, key),
+        getMany: keys => getMany(db, clock, storeId, keys),
+        set: (key, value, ttl) => set(db, clock, storeId, key, value, ttl),
+        setMany: entries => setMany(db, clock, storeId, entries),
+        remove: key => remove(db, storeId, key),
+        clear: clear(db, storeId)
+      };
+    })
+  });
+}));
+const defaultDatabase = "effect_persistence";
+const databaseVersion = 1;
+const entriesStoreName = "entries";
+const storeIdIndexName = "storeId";
+/**
+ * Creates a `Persistence` layer backed by IndexedDB, optionally using the provided database name.
+ *
+ * @category layers
+ * @since 4.0.0
+ */
+export const layerIndexedDb = options => Persistence.layer.pipe(Layer.provide(layerBackingIndexedDb(options)));
+const openDatabase = database => Effect.gen(function* () {
+  const openRequest = yield* Effect.try({
+    try: () => globalThis.indexedDB.open(database, databaseVersion),
+    catch: cause => new Persistence.PersistenceError({
+      message: "Failed to open backing store database",
+      cause
+    })
+  });
+  openRequest.onupgradeneeded = () => {
+    const db = openRequest.result;
+    const entries = db.objectStoreNames.contains(entriesStoreName) ? openRequest.transaction?.objectStore(entriesStoreName) : db.createObjectStore(entriesStoreName, {
+      keyPath: ["storeId", "id"]
+    });
+    if (entries && !entries.indexNames.contains(storeIdIndexName)) {
+      entries.createIndex(storeIdIndexName, storeIdIndexName, {
+        unique: false
+      });
+    }
+  };
+  return yield* idbRequest("Failed to open backing store database", () => openRequest);
+});
+const isExpired = (row, now) => row.expires !== null && row.expires <= now;
+const get = (db, clock, storeId, key) => withEntriesTransaction(db, "readwrite", `Failed to get key ${key} from backing store`, (entries, setResult, fail) => {
+  const now = clock.currentTimeMillisUnsafe();
+  const id = [storeId, key];
+  const request = entries.get(id);
+  request.onerror = () => fail(request.error);
+  request.onsuccess = () => {
+    const row = request.result;
+    if (!row || !isExpired(row, now)) {
+      setResult(row?.value);
+      return;
+    }
+    const deleteRequest = entries.delete(id);
+    deleteRequest.onerror = () => fail(deleteRequest.error);
+    deleteRequest.onsuccess = () => setResult(undefined);
+  };
+});
+const getMany = (db, clock, storeId, keys) => withEntriesTransaction(db, "readwrite", "Failed to getMany from backing store", (entries, setResult, fail) => {
+  const now = clock.currentTimeMillisUnsafe();
+  const results = new Array(keys.length);
+  setResult(results);
+  for (let i = 0; i < keys.length; i++) {
+    const key = keys[i];
+    const keyPath = [storeId, key];
+    const request = entries.get(keyPath);
+    request.onerror = () => fail(request.error);
+    request.onsuccess = () => {
+      const row = request.result;
+      if (!row) return;else if (!isExpired(row, now)) {
+        results[i] = row.value;
+        return;
+      }
+      const deleteRequest = entries.delete(keyPath);
+      deleteRequest.onerror = () => fail(deleteRequest.error);
+    };
+  }
+});
+const set = (db, clock, storeId, key, value, ttl) => withEntriesTransaction(db, "readwrite", `Failed to set key ${key} in backing store`, (entries, setResult, fail) => {
+  const request = entries.put({
+    storeId,
+    id: key,
+    value,
+    expires: Persistence.unsafeTtlToExpires(clock, ttl)
+  });
+  request.onerror = () => fail(request.error);
+  request.onsuccess = () => setResult(undefined);
+});
+const setMany = (db, clock, storeId, entries) => withEntriesTransaction(db, "readwrite", "Failed to setMany in backing store", (store, setResult, fail) => {
+  for (const [key, value, ttl] of entries) {
+    const request = store.put({
+      storeId,
+      id: key,
+      value,
+      expires: Persistence.unsafeTtlToExpires(clock, ttl)
+    });
+    request.onerror = () => fail(request.error);
+    request.onsuccess = () => setResult(undefined);
+  }
+});
+const remove = (db, storeId, key) => withEntriesTransaction(db, "readwrite", `Failed to remove key ${key} from backing store`, (entries, setResult, fail) => {
+  const request = entries.delete([storeId, key]);
+  request.onerror = () => fail(request.error);
+  request.onsuccess = () => setResult(undefined);
+});
+const clear = (db, storeId) => withEntriesTransaction(db, "readwrite", "Failed to clear backing store", (entries, setResult, fail) => {
+  const index = entries.index(storeIdIndexName);
+  const cursorRequest = index.openCursor(storeId);
+  cursorRequest.onerror = () => fail(cursorRequest.error);
+  cursorRequest.onsuccess = () => {
+    const cursor = cursorRequest.result;
+    if (!cursor) {
+      setResult(undefined);
+      return;
+    }
+    const deleteRequest = cursor.delete();
+    deleteRequest.onerror = () => fail(deleteRequest.error);
+    deleteRequest.onsuccess = () => cursor.continue();
+  };
+});
+const withEntriesTransaction = (db, mode, message, run) => Effect.callback(resume => {
+  const tx = db.transaction(entriesStoreName, mode);
+  const entries = tx.objectStore(entriesStoreName);
+  let result;
+  let setResult = false;
+  let done = false;
+  const fail = cause => {
+    done = true;
+    resume(Effect.fail(new Persistence.PersistenceError({
+      message,
+      cause
+    })));
+  };
+  tx.oncomplete = () => {
+    done = true;
+    if (setResult) resume(Effect.succeed(result));
+  };
+  tx.onerror = () => {
+    done = true;
+    fail(tx.error);
+  };
+  tx.onabort = () => {
+    done = true;
+    fail(tx.error);
+  };
+  run(entries, next => {
+    if (done) return resume(Effect.succeed(next));
+    setResult = true;
+    result = next;
+  }, fail);
+  return Effect.sync(() => {
+    tx.abort();
+  });
+});
+const idbRequest = (message, evaluate) => Effect.callback(resume => {
+  const request = evaluate();
+  const fail = cause => {
+    resume(Effect.fail(new Persistence.PersistenceError({
+      message,
+      cause
+    })));
+  };
+  if (request.readyState === "done") {
+    resume(Effect.succeed(request.result));
+  }
+  request.onsuccess = () => {
+    resume(Effect.succeed(request.result));
+  };
+  request.onerror = () => fail(request.error);
+});
+//# sourceMappingURL=BrowserPersistence.js.map

package/dist/BrowserPersistence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrowserPersistence.js","names":["Clock","Effect","Layer","Persistence","layerBackingIndexedDb","options","effect","BackingPersistence","gen","db","acquireRelease","openDatabase","database","defaultDatabase","sync","close","pipe","orDie","of","make","fnUntraced","storeId","clock","get","key","getMany","keys","set","value","ttl","setMany","entries","remove","clear","databaseVersion","entriesStoreName","storeIdIndexName","layerIndexedDb","layer","provide","openRequest","try","globalThis","indexedDB","open","catch","cause","PersistenceError","message","onupgradeneeded","result","objectStoreNames","contains","transaction","objectStore","createObjectStore","keyPath","indexNames","createIndex","unique","idbRequest","isExpired","row","now","expires","withEntriesTransaction","setResult","fail","currentTimeMillisUnsafe","id","request","onerror","error","onsuccess","deleteRequest","delete","undefined","results","Array","length","i","put","unsafeTtlToExpires","store","index","cursorRequest","openCursor","cursor","continue","mode","run","callback","resume","tx","done","oncomplete","succeed","onabort","next","abort","evaluate","readyState"],"sources":["../src/BrowserPersistence.ts"],"sourcesContent":[null],"mappings":"AAsDA,OAAO,KAAKA,KAAK,MAAM,cAAc;AAErC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,WAAW,MAAM,yCAAyC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMC,qBAAqB,GAAIC,OAErC,IACCH,KAAK,CAACI,MAAM,CAACH,WAAW,CAACI,kBAAkB,CAAC,CAACN,MAAM,CAACO,GAAG,CAAC,aAAS;EAC/D,MAAMC,EAAE,GAAG,OAAOR,MAAM,CAACS,cAAc,CACrCC,YAAY,CAACN,OAAO,EAAEO,QAAQ,IAAIC,eAAe,CAAC,EACjDJ,EAAE,IAAKR,MAAM,CAACa,IAAI,CAAC,MAAML,EAAE,CAACM,KAAK,EAAE,CAAC,CACtC,CAACC,IAAI,CAACf,MAAM,CAACgB,KAAK,CAAC;EAEpB,OAAOd,WAAW,CAACI,kBAAkB,CAACW,EAAE,CAAC;IACvCC,IAAI,EAAElB,MAAM,CAACmB,UAAU,CAAC,WAAUC,OAAO;MACvC,MAAMC,KAAK,GAAG,OAAOtB,KAAK,CAACA,KAAK;MAChC,OAAO;QACLuB,GAAG,EAAGC,GAAG,IAAKD,GAAG,CAACd,EAAE,EAAEa,KAAK,EAAED,OAAO,EAAEG,GAAG,CAAC;QAC1CC,OAAO,EAAGC,IAAI,IAAKD,OAAO,CAAChB,EAAE,EAAEa,KAAK,EAAED,OAAO,EAAEK,IAAI,CAAC;QACpDC,GAAG,EAAEA,CAACH,GAAG,EAAEI,KAAK,EAAEC,GAAG,KAAKF,GAAG,CAAClB,EAAE,EAAEa,KAAK,EAAED,OAAO,EAAEG,GAAG,EAAEI,KAAK,EAAEC,GAAG,CAAC;QAClEC,OAAO,EAAGC,OAAO,IAAKD,OAAO,CAACrB,EAAE,EAAEa,KAAK,EAAED,OAAO,EAAEU,OAAO,CAAC;QAC1DC,MAAM,EAAGR,GAAG,IAAKQ,MAAM,CAACvB,EAAE,EAAEY,OAAO,EAAEG,GAAG,CAAC;QACzCS,KAAK,EAAEA,KAAK,CAACxB,EAAE,EAAEY,OAAO;OACzB;IACH,CAAC;GACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,MAAMR,eAAe,GAAG,oBAAoB;AAC5C,MAAMqB,eAAe,GAAG,CAAC;AACzB,MAAMC,gBAAgB,GAAG,SAAS;AAClC,MAAMC,gBAAgB,GAAG,SAAS;AAElC;;;;;;AAMA,OAAO,MAAMC,cAAc,GAAIhC,OAE9B,IACCF,WAAW,CAACmC,KAAK,CAACtB,IAAI,CACpBd,KAAK,CAACqC,OAAO,CAACnC,qBAAqB,CAACC,OAAO,CAAC,CAAC,CAC9C;AAEH,MAAMM,YAAY,GAAIC,QAAgB,IACpCX,MAAM,CAACO,GAAG,CAAC,aAAS;EAClB,MAAMgC,WAAW,GAAG,OAAOvC,MAAM,CAACwC,GAAG,CAAC;IACpCA,GAAG,EAAEA,CAAA,KAAMC,UAAU,CAACC,SAAS,CAACC,IAAI,CAAChC,QAAQ,EAAEsB,eAAe,CAAC;IAC/DW,KAAK,EAAGC,KAAK,IACX,IAAI3C,WAAW,CAAC4C,gBAAgB,CAAC;MAC/BC,OAAO,EAAE,uCAAuC;MAChDF;KACD;GACJ,CAAC;EAEFN,WAAW,CAACS,eAAe,GAAG,MAAK;IACjC,MAAMxC,EAAE,GAAG+B,WAAW,CAACU,MAAM;IAC7B,MAAMnB,OAAO,GAAGtB,EAAE,CAAC0C,gBAAgB,CAACC,QAAQ,CAACjB,gBAAgB,CAAC,GAC1DK,WAAW,CAACa,WAAW,EAAEC,WAAW,CAACnB,gBAAgB,CAAC,GACtD1B,EAAE,CAAC8C,iBAAiB,CAACpB,gBAAgB,EAAE;MAAEqB,OAAO,EAAE,CAAC,SAAS,EAAE,IAAI;IAAC,CAAE,CAAC;IAC1E,IAAIzB,OAAO,IAAI,CAACA,OAAO,CAAC0B,UAAU,CAACL,QAAQ,CAAChB,gBAAgB,CAAC,EAAE;MAC7DL,OAAO,CAAC2B,WAAW,CAACtB,gBAAgB,EAAEA,gBAAgB,EAAE;QAAEuB,MAAM,EAAE;MAAK,CAAE,CAAC;IAC5E;EACF,CAAC;EAED,OAAO,OAAOC,UAAU,CAAC,uCAAuC,EAAE,MAAMpB,WAAW,CAAC;AACtF,CAAC,CAAC;AASJ,MAAMqB,SAAS,GAAGA,CAACC,GAAa,EAAEC,GAAW,KAAcD,GAAG,CAACE,OAAO,KAAK,IAAI,IAAIF,GAAG,CAACE,OAAO,IAAID,GAAG;AAErG,MAAMxC,GAAG,GAAGA,CACVd,EAAe,EACfa,KAAkB,EAClBD,OAAe,EACfG,GAAW,KAEXyC,sBAAsB,CACpBxD,EAAE,EACF,WAAW,EACX,qBAAqBe,GAAG,qBAAqB,EAC7C,CACEO,OAAO,EACPmC,SAAS,EACTC,IAAI,KACF;EACF,MAAMJ,GAAG,GAAGzC,KAAK,CAAC8C,uBAAuB,EAAE;EAC3C,MAAMC,EAAE,GAAqB,CAAChD,OAAO,EAAEG,GAAG,CAAC;EAC3C,MAAM8C,OAAO,GAAGvC,OAAO,CAACR,GAAG,CAAC8C,EAAE,CAAC;EAC/BC,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;EAC3CF,OAAO,CAACG,SAAS,GAAG,MAAK;IACvB,MAAMX,GAAG,GAAGQ,OAAO,CAACpB,MAA8B;IAClD,IAAI,CAACY,GAAG,IAAI,CAACD,SAAS,CAACC,GAAG,EAAEC,GAAG,CAAC,EAAE;MAChCG,SAAS,CAACJ,GAAG,EAAElC,KAAK,CAAC;MACrB;IACF;IAEA,MAAM8C,aAAa,GAAG3C,OAAO,CAAC4C,MAAM,CAACN,EAAE,CAAC;IACxCK,aAAa,CAACH,OAAO,GAAG,MAAMJ,IAAI,CAACO,aAAa,CAACF,KAAK,CAAC;IACvDE,aAAa,CAACD,SAAS,GAAG,MAAMP,SAAS,CAACU,SAAS,CAAC;EACtD,CAAC;AACH,CAAC,CACF;AAEH,MAAMnD,OAAO,GAAGA,CACdhB,EAAe,EACfa,KAAkB,EAClBD,OAAe,EACfK,IAA+B,KAE/BuC,sBAAsB,CACpBxD,EAAE,EACF,WAAW,EACX,sCAAsC,EACtC,CAACsB,OAAO,EAAEmC,SAAS,EAAEC,IAAI,KAAI;EAC3B,MAAMJ,GAAG,GAAGzC,KAAK,CAAC8C,uBAAuB,EAAE;EAC3C,MAAMS,OAAO,GAAG,IAAIC,KAAK,CAAqBpD,IAAI,CAACqD,MAAM,CAAC;EAC1Db,SAAS,CAACW,OAAc,CAAC;EAEzB,KAAK,IAAIG,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGtD,IAAI,CAACqD,MAAM,EAAEC,CAAC,EAAE,EAAE;IACpC,MAAMxD,GAAG,GAAGE,IAAI,CAACsD,CAAC,CAAC;IACnB,MAAMxB,OAAO,GAAG,CAACnC,OAAO,EAAEG,GAAG,CAAC;IAC9B,MAAM8C,OAAO,GAAGvC,OAAO,CAACR,GAAG,CAACiC,OAAO,CAAC;IACpCc,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;IAC3CF,OAAO,CAACG,SAAS,GAAG,MAAK;MACvB,MAAMX,GAAG,GAAGQ,OAAO,CAACpB,MAA8B;MAClD,IAAI,CAACY,GAAG,EAAE,OAAM,KACX,IAAI,CAACD,SAAS,CAACC,GAAG,EAAEC,GAAG,CAAC,EAAE;QAC7Bc,OAAO,CAACG,CAAC,CAAC,GAAGlB,GAAG,CAAClC,KAAK;QACtB;MACF;MACA,MAAM8C,aAAa,GAAG3C,OAAO,CAAC4C,MAAM,CAACnB,OAAO,CAAC;MAC7CkB,aAAa,CAACH,OAAO,GAAG,MAAMJ,IAAI,CAACO,aAAa,CAACF,KAAK,CAAC;IACzD,CAAC;EACH;AACF,CAAC,CACF;AAEH,MAAM7C,GAAG,GAAGA,CACVlB,EAAe,EACfa,KAAkB,EAClBD,OAAe,EACfG,GAAW,EACXI,KAAa,EACbC,GAAkC,KAElCoC,sBAAsB,CACpBxD,EAAE,EACF,WAAW,EACX,qBAAqBe,GAAG,mBAAmB,EAC3C,CAACO,OAAO,EAAEmC,SAAS,EAAEC,IAAI,KAAI;EAC3B,MAAMG,OAAO,GAAGvC,OAAO,CAACkD,GAAG,CACzB;IACE5D,OAAO;IACPgD,EAAE,EAAE7C,GAAG;IACPI,KAAK;IACLoC,OAAO,EAAE7D,WAAW,CAAC+E,kBAAkB,CAAC5D,KAAK,EAAEO,GAAG;GAChC,CACrB;EACDyC,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;EAC3CF,OAAO,CAACG,SAAS,GAAG,MAAMP,SAAS,CAACU,SAAS,CAAC;AAChD,CAAC,CACF;AAEH,MAAM9C,OAAO,GAAGA,CACdrB,EAAe,EACfa,KAAkB,EAClBD,OAAe,EACfU,OAAqG,KAErGkC,sBAAsB,CACpBxD,EAAE,EACF,WAAW,EACX,oCAAoC,EACpC,CAAC0E,KAAK,EAAEjB,SAAS,EAAEC,IAAI,KAAI;EACzB,KAAK,MAAM,CAAC3C,GAAG,EAAEI,KAAK,EAAEC,GAAG,CAAC,IAAIE,OAAO,EAAE;IACvC,MAAMuC,OAAO,GAAGa,KAAK,CAACF,GAAG,CACvB;MACE5D,OAAO;MACPgD,EAAE,EAAE7C,GAAG;MACPI,KAAK;MACLoC,OAAO,EAAE7D,WAAW,CAAC+E,kBAAkB,CAAC5D,KAAK,EAAEO,GAAG;KAChC,CACrB;IACDyC,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;IAC3CF,OAAO,CAACG,SAAS,GAAG,MAAMP,SAAS,CAACU,SAAS,CAAC;EAChD;AACF,CAAC,CACF;AAEH,MAAM5C,MAAM,GAAGA,CACbvB,EAAe,EACfY,OAAe,EACfG,GAAW,KAEXyC,sBAAsB,CACpBxD,EAAE,EACF,WAAW,EACX,wBAAwBe,GAAG,qBAAqB,EAChD,CAACO,OAAO,EAAEmC,SAAS,EAAEC,IAAI,KAAI;EAC3B,MAAMG,OAAO,GAAGvC,OAAO,CAAC4C,MAAM,CAAC,CAACtD,OAAO,EAAEG,GAAG,CAAC,CAAC;EAC9C8C,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;EAC3CF,OAAO,CAACG,SAAS,GAAG,MAAMP,SAAS,CAACU,SAAS,CAAC;AAChD,CAAC,CACF;AAEH,MAAM3C,KAAK,GAAGA,CAACxB,EAAe,EAAEY,OAAe,KAC7C4C,sBAAsB,CAACxD,EAAE,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAACsB,OAAO,EAAEmC,SAAS,EAAEC,IAAI,KAAI;EACpG,MAAMiB,KAAK,GAAGrD,OAAO,CAACqD,KAAK,CAAChD,gBAAgB,CAAC;EAC7C,MAAMiD,aAAa,GAAGD,KAAK,CAACE,UAAU,CAACjE,OAAO,CAAC;EAC/CgE,aAAa,CAACd,OAAO,GAAG,MAAMJ,IAAI,CAACkB,aAAa,CAACb,KAAK,CAAC;EACvDa,aAAa,CAACZ,SAAS,GAAG,MAAK;IAC7B,MAAMc,MAAM,GAAGF,aAAa,CAACnC,MAAM;IACnC,IAAI,CAACqC,MAAM,EAAE;MACXrB,SAAS,CAACU,SAAS,CAAC;MACpB;IACF;IACA,MAAMF,aAAa,GAAGa,MAAM,CAACZ,MAAM,EAAE;IACrCD,aAAa,CAACH,OAAO,GAAG,MAAMJ,IAAI,CAACO,aAAa,CAACF,KAAK,CAAC;IACvDE,aAAa,CAACD,SAAS,GAAG,MAAMc,MAAM,CAACC,QAAQ,EAAE;EACnD,CAAC;AACH,CAAC,CAAC;AAEJ,MAAMvB,sBAAsB,GAAGA,CAC7BxD,EAAe,EACfgF,IAAwB,EACxBzC,OAAe,EACf0C,GAIS,KAETzF,MAAM,CAAC0F,QAAQ,CAAmCC,MAAM,IAAI;EAC1D,MAAMC,EAAE,GAAGpF,EAAE,CAAC4C,WAAW,CAAClB,gBAAgB,EAAEsD,IAAI,CAAC;EACjD,MAAM1D,OAAO,GAAG8D,EAAE,CAACvC,WAAW,CAACnB,gBAAgB,CAAC;EAEhD,IAAIe,MAAqB;EACzB,IAAIgB,SAAS,GAAG,KAAK;EACrB,IAAI4B,IAAI,GAAG,KAAK;EAEhB,MAAM3B,IAAI,GAAIrB,KAAc,IAAI;IAC9BgD,IAAI,GAAG,IAAI;IACXF,MAAM,CAAC3F,MAAM,CAACkE,IAAI,CAAC,IAAIhE,WAAW,CAAC4C,gBAAgB,CAAC;MAAEC,OAAO;MAAEF;IAAK,CAAE,CAAC,CAAC,CAAC;EAC3E,CAAC;EAED+C,EAAE,CAACE,UAAU,GAAG,MAAK;IACnBD,IAAI,GAAG,IAAI;IACX,IAAI5B,SAAS,EAAE0B,MAAM,CAAC3F,MAAM,CAAC+F,OAAO,CAAC9C,MAAO,CAAC,CAAC;EAChD,CAAC;EACD2C,EAAE,CAACtB,OAAO,GAAG,MAAK;IAChBuB,IAAI,GAAG,IAAI;IACX3B,IAAI,CAAC0B,EAAE,CAACrB,KAAK,CAAC;EAChB,CAAC;EACDqB,EAAE,CAACI,OAAO,GAAG,MAAK;IAChBH,IAAI,GAAG,IAAI;IACX3B,IAAI,CAAC0B,EAAE,CAACrB,KAAK,CAAC;EAChB,CAAC;EAEDkB,GAAG,CAAC3D,OAAO,EAAGmE,IAAI,IAAI;IACpB,IAAIJ,IAAI,EAAE,OAAOF,MAAM,CAAC3F,MAAM,CAAC+F,OAAO,CAACE,IAAI,CAAC,CAAC;IAC7ChC,SAAS,GAAG,IAAI;IAChBhB,MAAM,GAAGgD,IAAI;EACf,CAAC,EAAE/B,IAAI,CAAC;EAER,OAAOlE,MAAM,CAACa,IAAI,CAAC,MAAK;IACtB+E,EAAE,CAACM,KAAK,EAAE;EACZ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEJ,MAAMvC,UAAU,GAAGA,CACjBZ,OAAe,EACfoD,QAA6B,KAE7BnG,MAAM,CAAC0F,QAAQ,CAAmCC,MAAM,IAAI;EAC1D,MAAMtB,OAAO,GAAG8B,QAAQ,EAAE;EAC1B,MAAMjC,IAAI,GAAIrB,KAAc,IAAI;IAC9B8C,MAAM,CAAC3F,MAAM,CAACkE,IAAI,CAAC,IAAIhE,WAAW,CAAC4C,gBAAgB,CAAC;MAAEC,OAAO;MAAEF;IAAK,CAAE,CAAC,CAAC,CAAC;EAC3E,CAAC;EACD,IAAIwB,OAAO,CAAC+B,UAAU,KAAK,MAAM,EAAE;IACjCT,MAAM,CAAC3F,MAAM,CAAC+F,OAAO,CAAC1B,OAAO,CAACpB,MAAM,CAAC,CAAC;EACxC;EACAoB,OAAO,CAACG,SAAS,GAAG,MAAK;IACvBmB,MAAM,CAAC3F,MAAM,CAAC+F,OAAO,CAAC1B,OAAO,CAACpB,MAAM,CAAC,CAAC;EACxC,CAAC;EACDoB,OAAO,CAACC,OAAO,GAAG,MAAMJ,IAAI,CAACG,OAAO,CAACE,KAAK,CAAC;AAC7C,CAAC,CAAC","ignoreList":[]}

package/dist/BrowserRuntime.d.ts

@@ -1,24 +1,99 @@
 /**
- * @since 1.0.0
+ * Browser entry-point helpers for running Effect programs.
+ *
+ * This module exposes `runMain`, a browser-oriented main runner for launching
+ * an Effect as the root program of a page, single-page application, demo, or
+ * browser test harness. It delegates execution to the core Effect runtime while
+ * adding the browser lifecycle hook needed to interrupt the main fiber when the
+ * page receives `beforeunload`.
+ *
+ * `BrowserRuntime` does not provide application services by itself. Provide
+ * any required layers, such as browser HTTP, storage, worker, geolocation, or
+ * permission services, before passing the effect to `runMain`. Keep long-lived
+ * browser resources scoped so interruption can run their finalizers while the
+ * page is still active.
+ *
+ * Browser unload is more constrained than a process signal. Finalizers that
+ * need the network, timers, prompts, or long asynchronous work may not complete
+ * once navigation or tab close has started, and browsers do not expose a
+ * process exit status. Use `runMain` to connect the page lifecycle to Effect
+ * interruption, and use browser-specific persistence or delivery APIs for work
+ * that must survive page teardown.
+ *
+ * @since 4.0.0
  */
 import type * as Effect from "effect/Effect";
 import { type Teardown } from "effect/Runtime";
 /**
- * @since 1.0.0
+ * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+ *
+ * **When to use**
+ *
+ * Use to launch a browser page, single-page application, demo, or browser test
+ * harness as a root Effect program.
+ *
+ * **Details**
+ *
+ * Supports both direct and curried call forms. Options are forwarded to
+ * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
+ * behavior.
+ *
+ * **Gotchas**
+ *
+ * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+ * asynchronous finalizers, network work, timers, or prompts from completing.
+ *
  * @category Runtime
+ * @since 4.0.0
  */
 export declare const runMain: {
     /**
-     * @since 1.0.0
+     * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+     *
+     * **When to use**
+     *
+     * Use to launch a browser page, single-page application, demo, or browser test
+     * harness as a root Effect program.
+     *
+     * **Details**
+     *
+     * Supports both direct and curried call forms. Options are forwarded to
+     * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
+     * behavior.
+     *
+     * **Gotchas**
+     *
+     * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+     * asynchronous finalizers, network work, timers, or prompts from completing.
+     *
      * @category Runtime
+     * @since 4.0.0
      */
     (options?: {
         readonly disableErrorReporting?: boolean | undefined;
         readonly teardown?: Teardown | undefined;
     }): <E, A>(effect: Effect.Effect<A, E>) => void;
     /**
-     * @since 1.0.0
+     * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+     *
+     * **When to use**
+     *
+     * Use to launch a browser page, single-page application, demo, or browser test
+     * harness as a root Effect program.
+     *
+     * **Details**
+     *
+     * Supports both direct and curried call forms. Options are forwarded to
+     * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
+     * behavior.
+     *
+     * **Gotchas**
+     *
+     * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+     * asynchronous finalizers, network work, timers, or prompts from completing.
+     *
      * @category Runtime
+     * @since 4.0.0
      */
     <E, A>(effect: Effect.Effect<A, E>, options?: {
         readonly disableErrorReporting?: boolean | undefined;

package/dist/BrowserRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserRuntime.d.ts","sourceRoot":"","sources":["../src/BrowserRuntime.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE3D;;;GAGG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;OAGG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;OAGG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CAKP,CAAA"}
+{"version":3,"file":"BrowserRuntime.d.ts","sourceRoot":"","sources":["../src/BrowserRuntime.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAe,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAE3D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CACE,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,CAAA;IAC9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAC3B,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;QACpD,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KACzC,GACA,IAAI,CAAA;CAKP,CAAA"}

package/dist/BrowserRuntime.js

@@ -1,7 +1,25 @@
 import { makeRunMain } from "effect/Runtime";
 /**
- * @since 1.0.0
+ * Runs an effect as the browser main program and interrupts its fiber when the page receives a `beforeunload` event.
+ *
+ * **When to use**
+ *
+ * Use to launch a browser page, single-page application, demo, or browser test
+ * harness as a root Effect program.
+ *
+ * **Details**
+ *
+ * Supports both direct and curried call forms. Options are forwarded to
+ * `makeRunMain`, including `disableErrorReporting` and custom `teardown`
+ * behavior.
+ *
+ * **Gotchas**
+ *
+ * The `beforeunload` interruption is best-effort. Browser teardown may prevent
+ * asynchronous finalizers, network work, timers, or prompts from completing.
+ *
  * @category Runtime
+ * @since 4.0.0
  */
 export const runMain = /*#__PURE__*/makeRunMain(({
   fiber

package/dist/BrowserRuntime.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrowserRuntime.js","names":["makeRunMain","runMain","fiber","globalThis","addEventListener","interruptUnsafe","id"],"sources":["../src/BrowserRuntime.ts"],"sourcesContent":[null],"mappings":"AAIA,SAASA,WAAW,QAAuB,gBAAgB;AAE3D;;;;AAIA,OAAO,MAAMC,OAAO,gBAsBhBD,WAAW,CAAC,CAAC;EAAEE;AAAK,CAAE,KAAI;EAC5BC,UAAU,CAACC,gBAAgB,CAAC,cAAc,EAAE,MAAK;IAC/CF,KAAK,CAACG,eAAe,CAACH,KAAK,CAACI,EAAE,CAAC;EACjC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"BrowserRuntime.js","names":["makeRunMain","runMain","fiber","globalThis","addEventListener","interruptUnsafe","id"],"sources":["../src/BrowserRuntime.ts"],"sourcesContent":[null],"mappings":"AAyBA,SAASA,WAAW,QAAuB,gBAAgB;AAE3D;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMC,OAAO,gBA0DhBD,WAAW,CAAC,CAAC;EAAEE;AAAK,CAAE,KAAI;EAC5BC,UAAU,CAACC,gBAAgB,CAAC,cAAc,EAAE,MAAK;IAC/CF,KAAK,CAACG,eAAe,CAACH,KAAK,CAACI,EAAE,CAAC;EACjC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}