Added modules for IndexedDb

[SandroMaglione]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Add modules for IndexedDb. This PR includes the following new modules (in order of dependency between each other):

• IndexedDbTable: define a table (with Schema)
• IndexedDbVersion: collects tables in a database version
• IndexedDbMigration: collects a sequence of versions and their schema + data migrations
• IndexedDbDatabase: service that initialises the database and executes the migration
• IndexedDbQuery: api to interact with the database

This also adds BrowserIndexedDb to @effect/platform-browser with a layer to create an instance of IndexedDb from the browser window.

Initial full API example included in the PR

Notes

• I added the modules inside @effect/platform since they are technically "generic" (not dependent on the browser window)
• Currently the migration doesn’t automatically create object stores and indexes (even if it would be possible). That's because the user may want to read the previous data for data migrations. Note that IndexedDb requires to delete the previous object store and create a new one whenever an index changes
• Migrations and transactions cannot have async effects inside them. That's a "limitation" of IndexedDb. From the docs:

Transactions are tied very closely to the event loop. If you make a transaction and return to the event loop without using it then the transaction will become inactive.

• There are more features that can be added (e.g. reactivity), but I would leave them as additions for later

Note

I plan to add more examples and README after the PR review, to avoid having to rewrite it all because of API changes

---

Notes for review

The modules can be reviewed in the following order (each directly depends/references the previous module):

1. IndexedDbTable
2. IndexedDbVersion
3. IndexedDbMigration
4. IndexedDbDatabase
5. IndexedDbQuery

IndexedDbTable and IndexedDbVersion don't contain any logic, they are just data containers (schemas).

IndexedDbMigration contains code to execute migrations (e.g. createObjectStore/deleteObjectStore).

IndexedDbDatabase is mainly used to initialise the database inside its layer.

IndexedDbQuery is the main service used to extract a type safe API and execute queries. The code that interacts with IndexedDb is mainly inside internal/indexedDbQuery.ts.

IndexedDb is a service to provide a valid instance of IndexedDb (with BrowserIndexedDb exporting a window layer).

[changeset-bot]

🦋 Changeset detected

Latest commit: 057dbf5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@effect/platform-browser	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[tim-smart]

I think this should just live in platform-browser, I can't see us adding implementations for any other platform.

[tim-smart]

This needs an explicit type.

[SandroMaglione]

Updated the error definition for internal/exported value and type

[tim-smart]

You can't use internal types here

[SandroMaglione]

Updated error definition

[tim-smart]

What is the Symbol.iterator for?

[SandroMaglione]

I simplified clearAll and clear to just return an Effect instead of an intermediate interface