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

package/dist/IndexedDb.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Browser IndexedDB primitives and key schemas for Effect applications.
+ *
+ * This module is the low-level bridge used by the platform-browser IndexedDB
+ * integration. It provides an `IndexedDb` service around the browser
+ * `indexedDB` factory and `IDBKeyRange` constructor, a `layerWindow` layer for
+ * wiring those primitives from `window`, and schemas for the key shapes accepted
+ * by IndexedDB object stores and indexes.
+ *
+ * Use it when building typed local persistence for browser caches,
+ * offline-first state, background queues, drafts, or other client-side data
+ * that should be validated before it reaches IndexedDB. Higher-level database,
+ * version, table, and query modules build on these primitives for migrations
+ * and typed transactions.
+ *
+ * IndexedDB still follows the browser rules: schema changes happen only during
+ * version upgrades, upgrades may be blocked by other open tabs or connections,
+ * and reads or writes must run in transactions scoped to the object stores they
+ * touch. The `layerWindow` constructor should be used only where browser
+ * globals are available, and code that also runs during SSR or in restricted
+ * browser contexts should account for `indexedDB` or `IDBKeyRange` being
+ * missing.
+ *
+ * @since 4.0.0
+ */
+import * as Context from "effect/Context";
+import * as Layer from "effect/Layer";
+import * as Schema from "effect/Schema";
+declare const TypeId = "~@effect/platform-browser/IndexedDb";
+/**
+ * Service interface that provides the browser `indexedDB` factory and `IDBKeyRange` constructor.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface IndexedDb {
+    readonly [TypeId]: typeof TypeId;
+    readonly indexedDB: globalThis.IDBFactory;
+    readonly IDBKeyRange: typeof globalThis.IDBKeyRange;
+}
+/**
+ * Service tag for browser IndexedDB primitives.
+ *
+ * @category tag
+ * @since 4.0.0
+ */
+export declare const IndexedDb: Context.Service<IndexedDb, IndexedDb>;
+/**
+ * Schema for IndexedDB keys: strings, non-NaN numbers, valid dates, buffer sources, or arrays of those flat key values.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const IDBValidKey: Schema.Union<readonly [Schema.Union<readonly [Schema.String, Schema.Number, Schema.DateValid, Schema.declare<BufferSource, unknown>]>, Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Number, Schema.DateValid, Schema.declare<BufferSource, unknown>]>>]>;
+/**
+ * Schema for auto-incremented IndexedDB keys, accepting integers from 1 through `2 ** 53`.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const AutoIncrement: Schema.Int;
+/**
+ * Creates an `IndexedDb` service from an `IDBFactory` and `IDBKeyRange` constructor.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: (impl: Omit<IndexedDb, typeof TypeId>) => IndexedDb;
+/**
+ * Layer that provides `IndexedDb` from `window.indexedDB` and `window.IDBKeyRange`, failing with a config error when they are unavailable.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const layerWindow: Layer.Layer<IndexedDb>;
+export {};
+//# sourceMappingURL=IndexedDb.d.ts.map

package/dist/IndexedDb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDb.d.ts","sourceRoot":"","sources":["../src/IndexedDb.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,QAAA,MAAM,MAAM,wCAAwC,CAAA;AAEpD;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,UAAU,CAAA;IACzC,QAAQ,CAAC,WAAW,EAAE,OAAO,UAAU,CAAC,WAAW,CAAA;CACpD;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAiD,CAAA;AAc7G;;;;;GAKG;AACH,eAAO,MAAM,WAAW,wQAAuD,CAAA;AAE/E;;;;;GAKG;AACH,eAAO,MAAM,aAAa,YAMxB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,MAAM,IAAI,CAAC,SAAS,EAAE,OAAO,MAAM,CAAC,KAAG,SAAwD,CAAA;AAEpH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAc9C,CAAA"}

package/dist/IndexedDb.js

@@ -0,0 +1,87 @@
+/**
+ * Browser IndexedDB primitives and key schemas for Effect applications.
+ *
+ * This module is the low-level bridge used by the platform-browser IndexedDB
+ * integration. It provides an `IndexedDb` service around the browser
+ * `indexedDB` factory and `IDBKeyRange` constructor, a `layerWindow` layer for
+ * wiring those primitives from `window`, and schemas for the key shapes accepted
+ * by IndexedDB object stores and indexes.
+ *
+ * Use it when building typed local persistence for browser caches,
+ * offline-first state, background queues, drafts, or other client-side data
+ * that should be validated before it reaches IndexedDB. Higher-level database,
+ * version, table, and query modules build on these primitives for migrations
+ * and typed transactions.
+ *
+ * IndexedDB still follows the browser rules: schema changes happen only during
+ * version upgrades, upgrades may be blocked by other open tabs or connections,
+ * and reads or writes must run in transactions scoped to the object stores they
+ * touch. The `layerWindow` constructor should be used only where browser
+ * globals are available, and code that also runs during SSR or in restricted
+ * browser contexts should account for `indexedDB` or `IDBKeyRange` being
+ * missing.
+ *
+ * @since 4.0.0
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Schema from "effect/Schema";
+const TypeId = "~@effect/platform-browser/IndexedDb";
+/**
+ * Service tag for browser IndexedDB primitives.
+ *
+ * @category tag
+ * @since 4.0.0
+ */
+export const IndexedDb = /*#__PURE__*/Context.Service(TypeId);
+/** @internal */
+const IDBFlatKey = /*#__PURE__*/Schema.Union([Schema.String, /*#__PURE__*/Schema.Number.check(/*#__PURE__*/Schema.makeFilter(input => !Number.isNaN(input))), Schema.DateValid, /*#__PURE__*/Schema.declare(input => input instanceof ArrayBuffer || ArrayBuffer.isView(input) && input.buffer instanceof ArrayBuffer)]);
+/**
+ * Schema for IndexedDB keys: strings, non-NaN numbers, valid dates, buffer sources, or arrays of those flat key values.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const IDBValidKey = /*#__PURE__*/Schema.Union([IDBFlatKey, /*#__PURE__*/Schema.Array(IDBFlatKey)]);
+/**
+ * Schema for auto-incremented IndexedDB keys, accepting integers from 1 through `2 ** 53`.
+ *
+ * @category schemas
+ * @since 4.0.0
+ */
+export const AutoIncrement = /*#__PURE__*/Schema.Int.check(Schema.isBetween({
+  minimum: 1,
+  maximum: 2 ** 53
+})).annotate({
+  identifier: "AutoIncrement",
+  title: "autoIncrement",
+  description: "Defines a valid autoIncrement key path for the IndexedDb table"
+});
+/**
+ * Creates an `IndexedDb` service from an `IDBFactory` and `IDBKeyRange` constructor.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make = impl => IndexedDb.of({
+  [TypeId]: TypeId,
+  ...impl
+});
+/**
+ * Layer that provides `IndexedDb` from `window.indexedDB` and `window.IDBKeyRange`, failing with a config error when they are unavailable.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const layerWindow = /*#__PURE__*/Layer.effect(IndexedDb, /*#__PURE__*/Effect.suspend(() => {
+  if (window.indexedDB && window.IDBKeyRange) {
+    return Effect.succeed(make({
+      indexedDB: window.indexedDB,
+      IDBKeyRange: window.IDBKeyRange
+    }));
+  } else {
+    return Effect.die(new Error("window.indexedDB is not available"));
+  }
+}));
+//# sourceMappingURL=IndexedDb.js.map

package/dist/IndexedDb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDb.js","names":["Context","Effect","Layer","Schema","TypeId","IndexedDb","Service","IDBFlatKey","Union","String","Number","check","makeFilter","input","isNaN","DateValid","declare","ArrayBuffer","isView","buffer","IDBValidKey","Array","AutoIncrement","Int","isBetween","minimum","maximum","annotate","identifier","title","description","make","impl","of","layerWindow","effect","suspend","window","indexedDB","IDBKeyRange","succeed","die","Error"],"sources":["../src/IndexedDb.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,MAAM,MAAM,eAAe;AAEvC,MAAMC,MAAM,GAAG,qCAAqC;AAcpD;;;;;;AAMA,OAAO,MAAMC,SAAS,gBAA0CL,OAAO,CAACM,OAAO,CAAuBF,MAAM,CAAC;AAE7G;AACA,MAAMG,UAAU,gBAAGJ,MAAM,CAACK,KAAK,CAAC,CAC9BL,MAAM,CAACM,MAAM,eACbN,MAAM,CAACO,MAAM,CAACC,KAAK,cAACR,MAAM,CAACS,UAAU,CAAEC,KAAK,IAAK,CAACH,MAAM,CAACI,KAAK,CAACD,KAAK,CAAC,CAAC,CAAC,EACvEV,MAAM,CAACY,SAAS,eAChBZ,MAAM,CAACa,OAAO,CACXH,KAAK,IACJA,KAAK,YAAYI,WAAW,IAC3BA,WAAW,CAACC,MAAM,CAACL,KAAK,CAAC,IAAIA,KAAK,CAACM,MAAM,YAAYF,WAAY,CACrE,CACF,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMG,WAAW,gBAAGjB,MAAM,CAACK,KAAK,CAAC,CAACD,UAAU,eAAEJ,MAAM,CAACkB,KAAK,CAACd,UAAU,CAAC,CAAC,CAAC;AAE/E;;;;;;AAMA,OAAO,MAAMe,aAAa,gBAAGnB,MAAM,CAACoB,GAAG,CAACZ,KAAK,CAC3CR,MAAM,CAACqB,SAAS,CAAC;EAAEC,OAAO,EAAE,CAAC;EAAEC,OAAO,EAAE,CAAC,IAAI;AAAE,CAAE,CAAC,CACnD,CAACC,QAAQ,CAAC;EACTC,UAAU,EAAE,eAAe;EAC3BC,KAAK,EAAE,eAAe;EACtBC,WAAW,EAAE;CACd,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMC,IAAI,GAAIC,IAAoC,IAAgB3B,SAAS,CAAC4B,EAAE,CAAC;EAAE,CAAC7B,MAAM,GAAGA,MAAM;EAAE,GAAG4B;AAAI,CAAE,CAAC;AAEpH;;;;;;AAMA,OAAO,MAAME,WAAW,gBAA2BhC,KAAK,CAACiC,MAAM,CAC7D9B,SAAS,eACTJ,MAAM,CAACmC,OAAO,CAAC,MAAK;EAClB,IAAIC,MAAM,CAACC,SAAS,IAAID,MAAM,CAACE,WAAW,EAAE;IAC1C,OAAOtC,MAAM,CAACuC,OAAO,CACnBT,IAAI,CAAC;MACHO,SAAS,EAAED,MAAM,CAACC,SAAS;MAC3BC,WAAW,EAAEF,MAAM,CAACE;KACrB,CAAC,CACH;EACH,CAAC,MAAM;IACL,OAAOtC,MAAM,CAACwC,GAAG,CAAC,IAAIC,KAAK,CAAC,mCAAmC,CAAC,CAAC;EACnE;AACF,CAAC,CAAC,CACH","ignoreList":[]}

package/dist/IndexedDbDatabase.d.ts

@@ -0,0 +1,150 @@
+/**
+ * Builds and opens typed IndexedDB databases from versioned schema migrations.
+ *
+ * This module turns an `IndexedDbVersion` migration chain into an
+ * `IndexedDbDatabase` layer. The layer opens the browser database, runs any
+ * pending upgrade migrations, provides a query builder for the current schema,
+ * and exposes a `rebuild` effect that deletes and reopens the database. It is
+ * the database-level companion to the table, version, and query builder
+ * modules.
+ *
+ * Use it for browser-local persistence such as offline-first application
+ * state, cached server data, background queues, drafts, and other client-side
+ * stores that need typed reads and writes backed by IndexedDB transactions.
+ *
+ * IndexedDB schema changes can only happen inside upgrade transactions, so
+ * every call to `make` or `.add` represents the next browser database version
+ * and only migrations after the existing browser version are run. Table and
+ * index definitions type the migration and query APIs, but object stores and
+ * indexes still need to be created or removed explicitly with the migration
+ * transaction helpers. Include the complete target table set in each version,
+ * create indexes before querying them, and treat key path or auto-increment
+ * changes as store migrations that copy data into a replacement object store.
+ * Upgrades can be blocked by other open connections, and all migration reads,
+ * writes, store changes, and index changes share the single upgrade
+ * transaction supplied by the browser.
+ *
+ * @since 4.0.0
+ */
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as MutableRef from "effect/MutableRef";
+import * as Reactivity from "effect/unstable/reactivity/Reactivity";
+import * as IndexedDb from "./IndexedDb.ts";
+import * as IndexedDbQueryBuilder from "./IndexedDbQueryBuilder.ts";
+import type * as IndexedDbTable from "./IndexedDbTable.ts";
+import type * as IndexedDbVersion from "./IndexedDbVersion.ts";
+declare const ErrorTypeId = "~@effect/platform-browser/IndexedDbDatabase/IndexedDbDatabaseError";
+/**
+ * String union describing the failure categories for IndexedDB database opening, migration, and schema operations.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export type ErrorReason = "TransactionError" | "MissingTable" | "OpenError" | "UpgradeError" | "Aborted" | "Blocked" | "MissingIndex";
+declare const IndexedDbDatabaseError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "IndexedDbDatabaseError";
+} & Readonly<A>;
+/**
+ * Tagged error for IndexedDB database operations, carrying a database error reason and the original cause.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export declare class IndexedDbDatabaseError extends IndexedDbDatabaseError_base<{
+    reason: ErrorReason;
+    cause: unknown;
+}> {
+    /**
+     * Marks this value as an IndexedDB database error for runtime guards.
+     *
+     * @since 4.0.0
+     */
+    readonly [ErrorTypeId]: typeof ErrorTypeId;
+    readonly message: ErrorReason;
+}
+declare const IndexedDbDatabase_base: Context.ServiceClass<IndexedDbDatabase, "~@effect/platform-browser/IndexedDbDatabase", {
+    readonly database: MutableRef.MutableRef<globalThis.IDBDatabase>;
+    readonly IDBKeyRange: typeof globalThis.IDBKeyRange;
+    readonly reactivity: Reactivity.Reactivity["Service"];
+    readonly rebuild: Effect.Effect<void, IndexedDbDatabaseError>;
+}>;
+/**
+ * Service tag for an open IndexedDB database, its `IDBKeyRange` constructor, reactivity service, and rebuild effect.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export declare class IndexedDbDatabase extends IndexedDbDatabase_base {
+}
+/**
+ * Describes an IndexedDB schema version and its migrations, and acts as an effect that yields a query builder for the target version.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface IndexedDbSchema<in out FromVersion extends IndexedDbVersion.AnyWithProps, in out ToVersion extends IndexedDbVersion.AnyWithProps, out Error = never> extends Effect.Effect<IndexedDbQueryBuilder.IndexedDbQueryBuilder<ToVersion>, never, IndexedDbDatabase> {
+    new (_: never): {};
+    readonly previous: [FromVersion] extends [never] ? undefined : IndexedDbSchema<never, FromVersion, Error>;
+    readonly fromVersion: FromVersion;
+    readonly version: ToVersion;
+    readonly migrate: [FromVersion] extends [never] ? (query: Transaction<ToVersion>) => Effect.Effect<void, Error> : (fromQuery: Transaction<FromVersion>, toQuery: Transaction<ToVersion>) => Effect.Effect<void, Error>;
+    readonly add: <Version extends IndexedDbVersion.AnyWithProps, MigrationError>(version: Version, migrate: (fromQuery: Transaction<ToVersion>, toQuery: Transaction<Version>) => Effect.Effect<void, MigrationError>) => IndexedDbSchema<ToVersion, Version, MigrationError | Error>;
+    readonly getQueryBuilder: Effect.Effect<IndexedDbQueryBuilder.IndexedDbQueryBuilder<ToVersion>, never, IndexedDbDatabase>;
+    readonly layer: (databaseName: string) => Layer.Layer<IndexedDbDatabase, IndexedDbDatabaseError, IndexedDb.IndexedDb>;
+}
+/**
+ * Query builder available during a database migration, extended with object-store and index management helpers for the active `IDBTransaction`.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Transaction<Source extends IndexedDbVersion.AnyWithProps = never> extends Omit<IndexedDbQueryBuilder.IndexedDbQueryBuilder<Source>, "transaction"> {
+    readonly transaction: globalThis.IDBTransaction;
+    readonly createObjectStore: <A extends IndexedDbTable.TableName<IndexedDbVersion.Tables<Source>>>(table: A) => Effect.Effect<globalThis.IDBObjectStore, IndexedDbDatabaseError>;
+    readonly deleteObjectStore: <A extends IndexedDbTable.TableName<IndexedDbVersion.Tables<Source>>>(table: A) => Effect.Effect<void, IndexedDbDatabaseError>;
+    readonly createIndex: <Name extends IndexedDbTable.TableName<IndexedDbVersion.Tables<Source>>>(table: Name, indexName: IndexFromTableName<Source, Name>, options?: IDBIndexParameters) => Effect.Effect<globalThis.IDBIndex, IndexedDbDatabaseError>;
+    readonly deleteIndex: <Name extends IndexedDbTable.TableName<IndexedDbVersion.Tables<Source>>>(table: Name, indexName: IndexFromTableName<Source, Name>) => Effect.Effect<void, IndexedDbDatabaseError>;
+}
+/**
+ * Extracts the string-literal index names defined by an `IndexedDbTable`.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type IndexFromTable<Table extends IndexedDbTable.AnyWithProps> = IsStringLiteral<Extract<keyof IndexedDbTable.Indexes<Table>, string>> extends true ? Extract<keyof IndexedDbTable.Indexes<Table>, string> : never;
+/**
+ * Extracts the valid index names for a table name within an IndexedDB version.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type IndexFromTableName<Version extends IndexedDbVersion.AnyWithProps, Table extends string> = IndexFromTable<IndexedDbTable.WithName<IndexedDbVersion.Tables<Version>, Table>>;
+/**
+ * Type-erased IndexedDB schema shape used when traversing schema migration chains.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Any {
+    readonly previous?: Any | undefined;
+    readonly layer: (databaseName: string) => Layer.Layer<IndexedDbDatabase, IndexedDbDatabaseError, IndexedDb.IndexedDb>;
+}
+/**
+ * Type-erased `IndexedDbSchema` covering any source version, target version, and migration error type.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type AnySchema = IndexedDbSchema<IndexedDbVersion.AnyWithProps, IndexedDbVersion.AnyWithProps, any>;
+/**
+ * Creates the initial `IndexedDbSchema` from a version and an initialization migration run during database upgrade.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: <InitialVersion extends IndexedDbVersion.AnyWithProps, Error>(initialVersion: InitialVersion, init: (toQuery: Transaction<InitialVersion>) => Effect.Effect<void, Error>) => IndexedDbSchema<never, InitialVersion, Error>;
+type IsStringLiteral<T> = T extends string ? string extends T ? false : true : false;
+export {};
+//# sourceMappingURL=IndexedDbDatabase.d.ts.map

package/dist/IndexedDbDatabase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IndexedDbDatabase.d.ts","sourceRoot":"","sources":["../src/IndexedDbDatabase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,UAAU,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,UAAU,MAAM,uCAAuC,CAAA;AACnE,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AACnE,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAC1D,OAAO,KAAK,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAG9D,QAAA,MAAM,WAAW,uEAAuE,CAAA;AA2CxF;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,cAAc,GACd,WAAW,GACX,cAAc,GACd,SAAS,GACT,SAAS,GACT,cAAc,CAAA;;;;AAElB;;;;;GAKG;AACH,qBAAa,sBAAuB,SAAQ,4BAE1C;IACA,MAAM,EAAE,WAAW,CAAA;IACnB,KAAK,EAAE,OAAO,CAAA;CACf,CAAC;IACA;;;;OAIG;IACH,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,WAAW,CAAc;IACxD,SAAkB,OAAO,cAAc;CACxC;;uBAWsB,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC;0BAC1C,OAAO,UAAU,CAAC,WAAW;yBAC9B,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC;sBACnC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,CAAC;;AAZjE;;;;;GAKG;AACH,qBAAa,iBAAkB,SAAQ,sBAQ5B;CAAG;AAEd;;;;;GAKG;AACH,MAAM,WAAW,eAAe,CAC9B,EAAE,CAAC,GAAG,CAAC,WAAW,SAAS,gBAAgB,CAAC,YAAY,EACxD,EAAE,CAAC,GAAG,CAAC,SAAS,SAAS,gBAAgB,CAAC,YAAY,EACtD,GAAG,CAAC,KAAK,GAAG,KAAK,CACjB,SACA,MAAM,CAAC,MAAM,CACX,qBAAqB,CAAC,qBAAqB,CAAC,SAAS,CAAC,EACtD,KAAK,EACL,iBAAiB,CAClB;IAED,KAAI,CAAC,EAAE,KAAK,GAAG,EAAE,CAAA;IAEjB,QAAQ,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,GACxD,eAAe,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;IAC9C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;IACjC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAA;IAE3B,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAC3G,CACA,SAAS,EAAE,WAAW,CAAC,WAAW,CAAC,EACnC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,KAC5B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAEjC,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,SAAS,gBAAgB,CAAC,YAAY,EAAE,cAAc,EAC1E,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,CACP,SAAS,EAAE,WAAW,CAAC,SAAS,CAAC,EACjC,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,KAC1B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,KACrC,eAAe,CAAC,SAAS,EAAE,OAAO,EAAE,cAAc,GAAG,KAAK,CAAC,CAAA;IAEhE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CACrC,qBAAqB,CAAC,qBAAqB,CAAC,SAAS,CAAC,EACtD,KAAK,EACL,iBAAiB,CAClB,CAAA;IAED,QAAQ,CAAC,KAAK,EAAE,CACd,YAAY,EAAE,MAAM,KACjB,KAAK,CAAC,KAAK,CACd,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,CAAC,SAAS,CACpB,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAC1B,MAAM,SAAS,gBAAgB,CAAC,YAAY,GAAG,KAAK,CACpD,SAAQ,IAAI,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAChF,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,cAAc,CAAA;IAE/C,QAAQ,CAAC,iBAAiB,EAAE,CAC1B,CAAC,SAAS,cAAc,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAEnE,KAAK,EAAE,CAAC,KACL,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAA;IAErE,QAAQ,CAAC,iBAAiB,EAAE,CAC1B,CAAC,SAAS,cAAc,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAEnE,KAAK,EAAE,CAAC,KACL,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAA;IAEhD,QAAQ,CAAC,WAAW,EAAE,CACpB,IAAI,SAAS,cAAc,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAEtE,KAAK,EAAE,IAAI,EACX,SAAS,EAAE,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC3C,OAAO,CAAC,EAAE,kBAAkB,KACzB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAA;IAE/D,QAAQ,CAAC,WAAW,EAAE,CACpB,IAAI,SAAS,cAAc,CAAC,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAEtE,KAAK,EAAE,IAAI,EACX,SAAS,EAAE,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,KACxC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAA;CACjD;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,cAAc,CAAC,YAAY,IAAI,eAAe,CACrF,OAAO,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CACrD,SAAS,IAAI,GAAG,OAAO,CAAC,MAAM,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GACjE,KAAK,CAAA;AAET;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,gBAAgB,CAAC,YAAY,EAC7C,KAAK,SAAS,MAAM,IAClB,cAAc,CAChB,cAAc,CAAC,QAAQ,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CACjE,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,QAAQ,CAAC,EAAE,GAAG,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,KAAK,EAAE,CACd,YAAY,EAAE,MAAM,KACjB,KAAK,CAAC,KAAK,CACd,iBAAiB,EACjB,sBAAsB,EACtB,SAAS,CAAC,SAAS,CACpB,CAAA;CACF;AAED;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,CACrC,gBAAgB,CAAC,YAAY,EAC7B,gBAAgB,CAAC,YAAY,EAC7B,GAAG,CACJ,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GACf,cAAc,SAAS,gBAAgB,CAAC,YAAY,EACpD,KAAK,EAEL,gBAAgB,cAAc,EAC9B,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,KACzE,eAAe,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,CAO9C,CAAA;AAqOD,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,SAAS,CAAC,GAAG,KAAK,GACjE,IAAI,GACJ,KAAK,CAAA"}

package/dist/IndexedDbDatabase.js

@@ -0,0 +1,324 @@
+/**
+ * Builds and opens typed IndexedDB databases from versioned schema migrations.
+ *
+ * This module turns an `IndexedDbVersion` migration chain into an
+ * `IndexedDbDatabase` layer. The layer opens the browser database, runs any
+ * pending upgrade migrations, provides a query builder for the current schema,
+ * and exposes a `rebuild` effect that deletes and reopens the database. It is
+ * the database-level companion to the table, version, and query builder
+ * modules.
+ *
+ * Use it for browser-local persistence such as offline-first application
+ * state, cached server data, background queues, drafts, and other client-side
+ * stores that need typed reads and writes backed by IndexedDB transactions.
+ *
+ * IndexedDB schema changes can only happen inside upgrade transactions, so
+ * every call to `make` or `.add` represents the next browser database version
+ * and only migrations after the existing browser version are run. Table and
+ * index definitions type the migration and query APIs, but object stores and
+ * indexes still need to be created or removed explicitly with the migration
+ * transaction helpers. Include the complete target table set in each version,
+ * create indexes before querying them, and treat key path or auto-increment
+ * changes as store migrations that copy data into a replacement object store.
+ * Upgrades can be blocked by other open connections, and all migration reads,
+ * writes, store changes, and index changes share the single upgrade
+ * transaction supplied by the browser.
+ *
+ * @since 4.0.0
+ */
+import * as Context from "effect/Context";
+import * as Data from "effect/Data";
+import * as Effect from "effect/Effect";
+import * as Effectable from "effect/Effectable";
+import * as Fiber from "effect/Fiber";
+import * as Layer from "effect/Layer";
+import * as MutableRef from "effect/MutableRef";
+import * as Semaphore from "effect/Semaphore";
+import * as Reactivity from "effect/unstable/reactivity/Reactivity";
+import * as IndexedDb from "./IndexedDb.js";
+import * as IndexedDbQueryBuilder from "./IndexedDbQueryBuilder.js";
+const TypeId = "~@effect/platform-browser/IndexedDbDatabase";
+const ErrorTypeId = "~@effect/platform-browser/IndexedDbDatabase/IndexedDbDatabaseError";
+const SchemaProto = {
+  [TypeId]: {
+    _A: _ => _
+  },
+  ... /*#__PURE__*/Effectable.Prototype({
+    label: "IndexedDbSchema",
+    evaluate() {
+      return this.getQueryBuilder;
+    }
+  }),
+  get getQueryBuilder() {
+    const self = this;
+    return IndexedDbDatabase.useSync(({
+      database,
+      IDBKeyRange,
+      reactivity
+    }) => IndexedDbQueryBuilder.make({
+      database,
+      IDBKeyRange,
+      tables: self.version.tables,
+      reactivity
+    }));
+  },
+  add(version, migrate) {
+    return makeMigration({
+      fromVersion: this.version,
+      version,
+      migrate,
+      previous: this
+    });
+  },
+  layer(databaseName) {
+    return layer(databaseName, this);
+  }
+};
+/**
+ * Tagged error for IndexedDB database operations, carrying a database error reason and the original cause.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export class IndexedDbDatabaseError extends /*#__PURE__*/Data.TaggedError("IndexedDbDatabaseError") {
+  /**
+   * Marks this value as an IndexedDB database error for runtime guards.
+   *
+   * @since 4.0.0
+   */
+  [ErrorTypeId] = ErrorTypeId;
+  message = this.reason;
+}
+/**
+ * Service tag for an open IndexedDB database, its `IDBKeyRange` constructor, reactivity service, and rebuild effect.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export class IndexedDbDatabase extends /*#__PURE__*/Context.Service()(TypeId) {}
+/**
+ * Creates the initial `IndexedDbSchema` from a version and an initialization migration run during database upgrade.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make = (initialVersion, init) => {
+  // oxlint-disable-next-line typescript/no-extraneous-class
+  function Initial() {}
+  Object.setPrototypeOf(Initial, SchemaProto);
+  Initial.version = initialVersion;
+  Initial.migrate = init;
+  return Initial;
+};
+const makeMigration = options => {
+  // oxlint-disable-next-line typescript/no-extraneous-class
+  function Migration() {}
+  Object.setPrototypeOf(Migration, SchemaProto);
+  Migration.previous = options.previous;
+  Migration.fromVersion = options.fromVersion;
+  Migration.version = options.version;
+  Migration.migrate = options.migrate;
+  return Migration;
+};
+const layer = (databaseName, migration) => Layer.effect(IndexedDbDatabase, Effect.gen(function* () {
+  const {
+    IDBKeyRange,
+    indexedDB
+  } = yield* IndexedDb.IndexedDb;
+  const reactivity = yield* Reactivity.Reactivity;
+  const context = yield* Effect.context();
+  const runForkWith = Effect.runForkWith(context);
+  let oldVersion = 0;
+  const migrations = [];
+  let current = migration;
+  while (current) {
+    migrations.unshift(current);
+    current = current.previous;
+  }
+  const version = migrations.length;
+  const database = MutableRef.make(null);
+  const open = Effect.callback(resume => {
+    const request = indexedDB.open(databaseName, version);
+    request.onblocked = event => {
+      resume(Effect.fail(new IndexedDbDatabaseError({
+        reason: "Blocked",
+        cause: event
+      })));
+    };
+    request.onerror = event => {
+      const idbRequest = event.target;
+      resume(Effect.fail(new IndexedDbDatabaseError({
+        reason: "OpenError",
+        cause: idbRequest.error
+      })));
+    };
+    let fiber;
+    request.onupgradeneeded = event => {
+      const idbRequest = event.target;
+      const db = idbRequest.result;
+      const transaction = idbRequest.transaction;
+      oldVersion = event.oldVersion;
+      MutableRef.set(database, db);
+      if (transaction === null) {
+        return resume(Effect.fail(new IndexedDbDatabaseError({
+          reason: "TransactionError",
+          cause: null
+        })));
+      }
+      transaction.onabort = event => {
+        resume(Effect.fail(new IndexedDbDatabaseError({
+          reason: "Aborted",
+          cause: event
+        })));
+      };
+      transaction.onerror = event => {
+        resume(Effect.fail(new IndexedDbDatabaseError({
+          reason: "TransactionError",
+          cause: event
+        })));
+      };
+      const effect = Effect.forEach(migrations.slice(oldVersion), untypedMigration => {
+        if (untypedMigration.previous === undefined) {
+          const migration = untypedMigration;
+          const api = makeTransactionProto({
+            database,
+            IDBKeyRange,
+            tables: migration.version.tables,
+            transaction,
+            reactivity
+          });
+          return migration.migrate(api);
+        } else if (untypedMigration.previous) {
+          const migration = untypedMigration;
+          const fromApi = makeTransactionProto({
+            database,
+            IDBKeyRange,
+            tables: migration.fromVersion.tables,
+            transaction,
+            reactivity
+          });
+          const toApi = makeTransactionProto({
+            database,
+            IDBKeyRange,
+            tables: migration.version.tables,
+            transaction,
+            reactivity
+          });
+          return migration.migrate(fromApi, toApi);
+        }
+        return Effect.die(new Error("Invalid migration"));
+      }, {
+        discard: true
+      }).pipe(Effect.mapError(cause => new IndexedDbDatabaseError({
+        reason: "UpgradeError",
+        cause
+      })), Effect.provideService(IndexedDbQueryBuilder.IndexedDbTransaction, transaction));
+      fiber = runForkWith(effect);
+      fiber.currentDispatcher.flush();
+    };
+    request.onsuccess = event => {
+      const idbRequest = event.target;
+      const db = idbRequest.result;
+      MutableRef.set(database, db);
+      if (fiber) {
+        // ensure migration errors are propagated
+        resume(Effect.asVoid(Fiber.join(fiber)));
+      } else {
+        resume(Effect.void);
+      }
+    };
+  });
+  yield* Effect.addFinalizer(() => {
+    database.current?.close();
+    return Effect.void;
+  });
+  yield* open;
+  const rebuildLock = Semaphore.makeUnsafe(1).withPermit;
+  const rebuild = Effect.callback(resume => {
+    database.current?.close();
+    const request = indexedDB.deleteDatabase(databaseName);
+    request.onerror = _ => {
+      resume(Effect.fail(new IndexedDbDatabaseError({
+        reason: "OpenError",
+        cause: request.error
+      })));
+    };
+    request.onsuccess = () => {
+      resume(Effect.void);
+    };
+  }).pipe(Effect.flatMap(() => open), rebuildLock);
+  return IndexedDbDatabase.of({
+    database,
+    IDBKeyRange,
+    rebuild,
+    reactivity
+  });
+})).pipe(Layer.provide(Reactivity.layer));
+const makeTransactionProto = ({
+  IDBKeyRange,
+  database,
+  tables,
+  transaction,
+  reactivity
+}) => {
+  const migration = IndexedDbQueryBuilder.make({
+    database,
+    IDBKeyRange,
+    tables,
+    reactivity
+  });
+  migration.transaction = transaction;
+  migration.createObjectStore = Effect.fnUntraced(function* (table) {
+    const createTable = yield* Effect.fromNullishOr(tables.get(table)).pipe(Effect.mapError(cause => new IndexedDbDatabaseError({
+      reason: "MissingTable",
+      cause
+    })));
+    return yield* Effect.try({
+      try: () => database.current.createObjectStore(createTable.tableName, {
+        keyPath: createTable.keyPath,
+        autoIncrement: createTable.autoIncrement
+      }),
+      catch: cause => new IndexedDbDatabaseError({
+        reason: "TransactionError",
+        cause
+      })
+    });
+  });
+  migration.deleteObjectStore = Effect.fnUntraced(function* (table) {
+    const createTable = yield* Effect.fromNullishOr(tables.get(table)).pipe(Effect.mapError(cause => new IndexedDbDatabaseError({
+      reason: "MissingTable",
+      cause
+    })));
+    return yield* Effect.try({
+      try: () => database.current.deleteObjectStore(createTable.tableName),
+      catch: cause => new IndexedDbDatabaseError({
+        reason: "TransactionError",
+        cause
+      })
+    });
+  });
+  migration.createIndex = Effect.fnUntraced(function* (table, indexName, options) {
+    const store = transaction.objectStore(table);
+    const sourceTable = tables.get(table);
+    const keyPath = yield* Effect.fromNullishOr(sourceTable.indexes[indexName]).pipe(Effect.mapError(cause => new IndexedDbDatabaseError({
+      reason: "MissingIndex",
+      cause
+    })));
+    return yield* Effect.try({
+      try: () => store.createIndex(indexName, keyPath, options),
+      catch: cause => new IndexedDbDatabaseError({
+        reason: "TransactionError",
+        cause
+      })
+    });
+  });
+  migration.deleteIndex = (table, indexName) => Effect.try({
+    try: () => transaction.objectStore(table).deleteIndex(indexName),
+    catch: cause => new IndexedDbDatabaseError({
+      reason: "TransactionError",
+      cause
+    })
+  });
+  return migration;
+};
+//# sourceMappingURL=IndexedDbDatabase.js.map