@rescript/webapi 0.1.0-alpha-b1d58f9

package/src/storage/CacheTypes.res

@@ -0,0 +1,24 @@
+/**
+Provides a storage mechanism for Request / Response object pairs that are cached, for example as part of the Service Worker life cycle. The Cache interface is also available in window contexts.
+[See Cache on MDN](https://developer.mozilla.org/docs/Web/API/Cache)
+*/
+@editor.completeFrom(Cache)
+type cache = private {}
+
+/**
+The storage for Cache objects.
+[See CacheStorage on MDN](https://developer.mozilla.org/docs/Web/API/CacheStorage)
+*/
+@editor.completeFrom(CacheStorage)
+type cacheStorage = private {}
+
+type cacheQueryOptions = {
+  mutable ignoreSearch?: bool,
+  mutable ignoreMethod?: bool,
+  mutable ignoreVary?: bool,
+}
+
+type multiCacheQueryOptions = {
+  ...cacheQueryOptions,
+  mutable cacheName?: string,
+}

package/src/storage/IDBDatabase.res

@@ -0,0 +1,54 @@
+include EventTarget.Impl({type t = IndexedDbTypes.idbDatabase})
+
+/**
+Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
+*/
+@throws(JsExn) @send
+external transaction: (
+  IndexedDbTypes.idbDatabase,
+  ~storeNames: string,
+  ~mode: IndexedDbTypes.idbTransactionMode=?,
+  ~options: IndexedDbTypes.idbTransactionOptions=?,
+) => IndexedDbTypes.idbTransaction = "transaction"
+
+/**
+Returns a new transaction with the given mode ("readonly" or "readwrite") and scope which can be a single object store name or an array of names.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/transaction)
+*/
+@throws(JsExn) @send
+external transaction2: (
+  IndexedDbTypes.idbDatabase,
+  ~storeNames: array<string>,
+  ~mode: IndexedDbTypes.idbTransactionMode=?,
+  ~options: IndexedDbTypes.idbTransactionOptions=?,
+) => IndexedDbTypes.idbTransaction = "transaction"
+
+/**
+Closes the connection once all running transactions have finished.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/close)
+*/
+@send
+external close: IndexedDbTypes.idbDatabase => unit = "close"
+
+/**
+Creates a new object store with the given name and options and returns a new IDBObjectStore.
+
+Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/createObjectStore)
+*/
+@throws(JsExn) @send
+external createObjectStore: (
+  IndexedDbTypes.idbDatabase,
+  ~name: string,
+  ~options: IndexedDbTypes.idbObjectStoreParameters=?,
+) => IndexedDbTypes.idbObjectStore = "createObjectStore"
+
+/**
+Deletes the object store with the given name.
+
+Throws a "InvalidStateError" DOMException if not called within an upgrade transaction.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/deleteObjectStore)
+*/
+@throws(JsExn) @send
+external deleteObjectStore: (IndexedDbTypes.idbDatabase, string) => unit = "deleteObjectStore"

package/src/storage/IDBFactory.res

@@ -0,0 +1,34 @@
+/**
+Attempts to open a connection to the named database with the current version, or 1 if it does not already exist. If the request is successful request's result will be the connection.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBFactory/open)
+*/
+@throws(JsExn) @send
+external open_: (
+  IndexedDbTypes.idbFactory,
+  ~name: string,
+  ~version: int=?,
+) => IndexedDbTypes.idbOpenDBRequest = "open"
+
+/**
+Attempts to delete the named database. If the database already exists and there are open connections that don't close in response to a versionchange event, the request will be blocked until all they close. If the request is successful request's result will be null.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBFactory/deleteDatabase)
+*/
+@send
+external deleteDatabase: (IndexedDbTypes.idbFactory, string) => IndexedDbTypes.idbOpenDBRequest =
+  "deleteDatabase"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBFactory/databases)
+*/
+@send
+external databases: IndexedDbTypes.idbFactory => promise<array<IndexedDbTypes.idbDatabaseInfo>> =
+  "databases"
+
+/**
+Compares two values as keys. Returns -1 if key1 precedes key2, 1 if key2 precedes key1, and 0 if the keys are equal.
+
+Throws a "DataError" DOMException if either input is not a valid key.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBFactory/cmp)
+*/
+@throws(JsExn) @send
+external cmp: (IndexedDbTypes.idbFactory, ~first: JSON.t, ~second: JSON.t) => int = "cmp"

package/src/storage/IDBIndex.res

@@ -0,0 +1,83 @@
+/**
+Retrieves the value of the first record matching the given key or key range in query.
+
+If successful, request's result will be the value, or undefined if there was no matching record.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/get)
+*/
+@throws(JsExn) @send
+external get: (IndexedDbTypes.idbIndex, unknown) => IndexedDbTypes.idbRequest<option<JSON.t>> =
+  "get"
+
+/**
+Retrieves the key of the first record matching the given key or key range in query.
+
+If successful, request's result will be the key, or undefined if there was no matching record.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/getKey)
+*/
+@throws(JsExn) @send
+external getKey: (
+  IndexedDbTypes.idbIndex,
+  unknown,
+) => IndexedDbTypes.idbRequest<option<IndexedDbTypes.idbValidKey>> = "getKey"
+
+/**
+Retrieves the values of the records matching the given key or key range in query (up to count if given).
+
+If successful, request's result will be an Array of the values.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/getAll)
+*/
+@throws(JsExn) @send
+external getAll: (
+  IndexedDbTypes.idbIndex,
+  ~query: unknown=?,
+  ~count: int=?,
+) => IndexedDbTypes.idbRequest<array<JSON.t>> = "getAll"
+
+/**
+Retrieves the keys of records matching the given key or key range in query (up to count if given).
+
+If successful, request's result will be an Array of the keys.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/getAllKeys)
+*/
+@throws(JsExn) @send
+external getAllKeys: (
+  IndexedDbTypes.idbIndex,
+  ~query: unknown=?,
+  ~count: int=?,
+) => IndexedDbTypes.idbRequest<array<IndexedDbTypes.idbValidKey>> = "getAllKeys"
+
+/**
+Retrieves the number of records matching the given key or key range in query.
+
+If successful, request's result will be the count.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/count)
+*/
+@throws(JsExn) @send
+external count: (IndexedDbTypes.idbIndex, ~query: unknown=?) => IndexedDbTypes.idbRequest<int> =
+  "count"
+
+/**
+Opens a cursor over the records matching query, ordered by direction. If query is null, all records in index are matched.
+
+If successful, request's result will be an IDBCursorWithValue, or null if there were no matching records.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/openCursor)
+*/
+@throws(JsExn) @send
+external openCursor: (
+  IndexedDbTypes.idbIndex,
+  ~query: unknown=?,
+  ~direction: IndexedDbTypes.idbCursorDirection=?,
+) => IndexedDbTypes.idbRequest<Null.t<unknown>> = "openCursor"
+
+/**
+Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in index are matched.
+
+If successful, request's result will be an IDBCursor, or null if there were no matching records.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/openKeyCursor)
+*/
+@throws(JsExn) @send
+external openKeyCursor: (
+  IndexedDbTypes.idbIndex,
+  ~query: unknown=?,
+  ~direction: IndexedDbTypes.idbCursorDirection=?,
+) => IndexedDbTypes.idbRequest<Null.t<unknown>> = "openKeyCursor"

package/src/storage/IDBObjectStore.res

@@ -0,0 +1,183 @@
+/**
+Adds or updates a record in store with the given value and key.
+
+If the store uses in-line keys and key is specified a "DataError" DOMException will be thrown.
+
+If put() is used, any existing record with the key will be replaced. If add() is used, and if a record with the key already exists the request will fail, with request's error set to a "ConstraintError" DOMException.
+
+If successful, request's result will be the record's key.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/put)
+*/
+@throws(JsExn) @send
+external put: (
+  IndexedDbTypes.idbObjectStore,
+  ~value: JSON.t,
+  ~key: IndexedDbTypes.idbValidKey=?,
+) => IndexedDbTypes.idbRequest<IndexedDbTypes.idbValidKey> = "put"
+
+/**
+Adds or updates a record in store with the given value and key.
+
+If the store uses in-line keys and key is specified a "DataError" DOMException will be thrown.
+
+If put() is used, any existing record with the key will be replaced. If add() is used, and if a record with the key already exists the request will fail, with request's error set to a "ConstraintError" DOMException.
+
+If successful, request's result will be the record's key.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/add)
+*/
+@throws(JsExn) @send
+external add: (
+  IndexedDbTypes.idbObjectStore,
+  ~value: JSON.t,
+  ~key: IndexedDbTypes.idbValidKey=?,
+) => IndexedDbTypes.idbRequest<IndexedDbTypes.idbValidKey> = "add"
+
+/**
+Deletes records in store with the given key or in the given key range in query.
+
+If successful, request's result will be undefined.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/delete)
+*/
+@throws(JsExn) @send
+external delete: (IndexedDbTypes.idbObjectStore, unknown) => IndexedDbTypes.idbRequest<unit> =
+  "delete"
+
+/**
+Deletes all records in store.
+
+If successful, request's result will be undefined.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/clear)
+*/
+@throws(JsExn) @send
+external clear: IndexedDbTypes.idbObjectStore => IndexedDbTypes.idbRequest<unit> = "clear"
+
+/**
+Retrieves the value of the first record matching the given key or key range in query.
+
+If successful, request's result will be the value, or undefined if there was no matching record.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/get)
+*/
+@throws(JsExn) @send
+external get: (
+  IndexedDbTypes.idbObjectStore,
+  unknown,
+) => IndexedDbTypes.idbRequest<option<JSON.t>> = "get"
+
+/**
+Retrieves the key of the first record matching the given key or key range in query.
+
+If successful, request's result will be the key, or undefined if there was no matching record.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/getKey)
+*/
+@throws(JsExn) @send
+external getKey: (
+  IndexedDbTypes.idbObjectStore,
+  unknown,
+) => IndexedDbTypes.idbRequest<option<IndexedDbTypes.idbValidKey>> = "getKey"
+
+/**
+Retrieves the values of the records matching the given key or key range in query (up to count if given).
+
+If successful, request's result will be an Array of the values.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/getAll)
+*/
+@throws(JsExn) @send
+external getAll: (
+  IndexedDbTypes.idbObjectStore,
+  ~query: unknown=?,
+  ~count: int=?,
+) => IndexedDbTypes.idbRequest<array<JSON.t>> = "getAll"
+
+/**
+Retrieves the keys of records matching the given key or key range in query (up to count if given).
+
+If successful, request's result will be an Array of the keys.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/getAllKeys)
+*/
+@throws(JsExn) @send
+external getAllKeys: (
+  IndexedDbTypes.idbObjectStore,
+  ~query: unknown=?,
+  ~count: int=?,
+) => IndexedDbTypes.idbRequest<array<IndexedDbTypes.idbValidKey>> = "getAllKeys"
+
+/**
+Retrieves the number of records matching the given key or key range in query.
+
+If successful, request's result will be the count.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/count)
+*/
+@throws(JsExn) @send
+external count: (
+  IndexedDbTypes.idbObjectStore,
+  ~query: unknown=?,
+) => IndexedDbTypes.idbRequest<int> = "count"
+
+/**
+Opens a cursor over the records matching query, ordered by direction. If query is null, all records in store are matched.
+
+If successful, request's result will be an IDBCursorWithValue pointing at the first matching record, or null if there were no matching records.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/openCursor)
+*/
+@throws(JsExn) @send
+external openCursor: (
+  IndexedDbTypes.idbObjectStore,
+  ~query: unknown=?,
+  ~direction: IndexedDbTypes.idbCursorDirection=?,
+) => IndexedDbTypes.idbRequest<Null.t<unknown>> = "openCursor"
+
+/**
+Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in store are matched.
+
+If successful, request's result will be an IDBCursor pointing at the first matching record, or null if there were no matching records.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/openKeyCursor)
+*/
+@throws(JsExn) @send
+external openKeyCursor: (
+  IndexedDbTypes.idbObjectStore,
+  ~query: unknown=?,
+  ~direction: IndexedDbTypes.idbCursorDirection=?,
+) => IndexedDbTypes.idbRequest<Null.t<unknown>> = "openKeyCursor"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/index)
+*/
+@throws(JsExn) @send
+external index: (IndexedDbTypes.idbObjectStore, string) => IndexedDbTypes.idbIndex = "index"
+
+/**
+Creates a new index in store with the given name, keyPath and options and returns a new IDBIndex. If the keyPath and options define constraints that cannot be satisfied with the data already in store the upgrade transaction will abort with a "ConstraintError" DOMException.
+
+Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
+*/
+@throws(JsExn) @send
+external createIndex: (
+  IndexedDbTypes.idbObjectStore,
+  ~name: string,
+  ~keyPath: string,
+  ~options: IndexedDbTypes.idbIndexParameters=?,
+) => IndexedDbTypes.idbIndex = "createIndex"
+
+/**
+Creates a new index in store with the given name, keyPath and options and returns a new IDBIndex. If the keyPath and options define constraints that cannot be satisfied with the data already in store the upgrade transaction will abort with a "ConstraintError" DOMException.
+
+Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/createIndex)
+*/
+@throws(JsExn) @send
+external createIndex2: (
+  IndexedDbTypes.idbObjectStore,
+  ~name: string,
+  ~keyPath: array<string>,
+  ~options: IndexedDbTypes.idbIndexParameters=?,
+) => IndexedDbTypes.idbIndex = "createIndex"
+
+/**
+Deletes the index in store with the given name.
+
+Throws an "InvalidStateError" DOMException if not called within an upgrade transaction.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/deleteIndex)
+*/
+@throws(JsExn) @send
+external deleteIndex: (IndexedDbTypes.idbObjectStore, string) => unit = "deleteIndex"

package/src/storage/IDBTransaction.res

@@ -0,0 +1,22 @@
+include EventTarget.Impl({type t = IndexedDbTypes.idbTransaction})
+
+/**
+Returns an IDBObjectStore in the transaction's scope.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStore)
+*/
+@throws(JsExn) @send
+external objectStore: (IndexedDbTypes.idbTransaction, string) => IndexedDbTypes.idbObjectStore =
+  "objectStore"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/commit)
+*/
+@throws(JsExn) @send
+external commit: IndexedDbTypes.idbTransaction => unit = "commit"
+
+/**
+Aborts the transaction. All pending requests will fail with a "AbortError" DOMException and all changes made to the database will be reverted.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/abort)
+*/
+@throws(JsExn) @send
+external abort: IndexedDbTypes.idbTransaction => unit = "abort"

package/src/storage/IndexedDbTypes.res

@@ -0,0 +1,213 @@
+@@warning("-30")
+
+type idbTransactionMode =
+  | @as("readonly") Readonly
+  | @as("readwrite") Readwrite
+  | @as("versionchange") Versionchange
+
+type idbTransactionDurability =
+  | @as("default") Default
+  | @as("relaxed") Relaxed
+  | @as("strict") Strict
+
+type idbRequestReadyState =
+  | @as("done") Done
+  | @as("pending") Pending
+
+type idbCursorDirection =
+  | @as("next") Next
+  | @as("nextunique") Nextunique
+  | @as("prev") Prev
+  | @as("prevunique") Prevunique
+
+/**
+In the following code snippet, we make a request to open a database, and include handlers for the success and error cases. For a full working example, see our To-do Notifications app (view example live.)
+[See IDBFactory on MDN](https://developer.mozilla.org/docs/Web/API/IDBFactory)
+*/
+@editor.completeFrom(IDBFactory)
+type idbFactory = private {}
+
+/**
+This WebApiIndexedDB API interface provides a connection to a database; you can use an IDBDatabase object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The interface provides the only way to get and manage versions of the database.
+[See IDBDatabase on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase)
+*/
+@editor.completeFrom(IDBDatabase)
+type idbDatabase = private {
+  ...DOM.eventTarget,
+  /**
+    Returns the name of the database.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/name)
+    */
+  name: string,
+  /**
+    Returns the version of the database.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/version)
+    */
+  version: int,
+  /**
+    Returns a list of the names of object stores in the database.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBDatabase/objectStoreNames)
+    */
+  objectStoreNames: DOM.domStringList,
+}
+
+/**
+[See IDBTransaction on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction)
+*/
+@editor.completeFrom(IDBTransaction)
+type idbTransaction = private {
+  ...DOM.eventTarget,
+  /**
+    Returns a list of the names of object stores in the transaction's scope. For an upgrade transaction this is all object stores in the database.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStoreNames)
+    */
+  objectStoreNames: DOM.domStringList,
+  /**
+    Returns the mode the transaction was created with ("readonly" or "readwrite"), or "versionchange" for an upgrade transaction.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/mode)
+    */
+  mode: idbTransactionMode,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/durability)
+    */
+  durability: idbTransactionDurability,
+  /**
+    Returns the transaction's connection.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/db)
+    */
+  db: idbDatabase,
+  /**
+    If the transaction was aborted, returns the error (a DOMException) providing the reason.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/error)
+    */
+  error: Null.t<DOM.domException>,
+}
+
+/**
+The request object does not initially contain any information about the result of the operation, but once information becomes available, an event is fired on the request, and the information becomes available through the properties of the IDBRequest instance.
+[See IDBRequest on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest)
+*/
+type idbRequest<'t> = {
+  ...DOM.eventTarget,
+  /**
+    When a request is completed, returns the result, or undefined if the request failed. Throws a "InvalidStateError" DOMException if the request is still pending.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest/result)
+    */
+  @throws(JsExn)
+  result: 't,
+  /**
+    When a request is completed, returns the error (a DOMException), or null if the request succeeded. Throws a "InvalidStateError" DOMException if the request is still pending.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest/error)
+    */
+  @throws(JsExn)
+  error: Null.t<DOM.domException>,
+  /**
+    Returns the IDBObjectStore, IDBIndex, or IDBCursor the request was made against, or null if is was an open request.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest/source)
+    */
+  source: Null.t<unknown>,
+  /**
+    Returns the IDBTransaction the request was made within. If this as an open request, then it returns an upgrade transaction while it is running, or null otherwise.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest/transaction)
+    */
+  transaction: Null.t<idbTransaction>,
+  /**
+    Returns "pending" until a request is complete, then returns "done".
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBRequest/readyState)
+    */
+  readyState: idbRequestReadyState,
+}
+
+/**
+Also inherits methods from its parents IDBRequest and EventTarget.
+[See IDBOpenDBRequest on MDN](https://developer.mozilla.org/docs/Web/API/IDBOpenDBRequest)
+*/
+type idbOpenDBRequest = {
+  ...idbRequest<idbDatabase>,
+}
+
+/**
+This example shows a variety of different uses of object stores, from updating the data structure with IDBObjectStore.createIndex inside an onupgradeneeded function, to adding a new item to our object store with IDBObjectStore.add. For a full working example, see our To-do Notifications app (view example live.)
+[See IDBObjectStore on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore)
+TODO: mark as private once mutating fields of private records is allowed
+*/
+@editor.completeFrom(IDBObjectStore)
+type idbObjectStore = {
+  /**
+    Returns the name of the store.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/name)
+    */
+  @throws(JsExn)
+  mutable name: string,
+  /**
+    Returns the key path of the store, or null if none.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/keyPath)
+    */
+  keyPath: Null.t<unknown>,
+  /**
+    Returns a list of the names of indexes in the store.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/indexNames)
+    */
+  indexNames: DOM.domStringList,
+  /**
+    Returns the associated transaction.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/transaction)
+    */
+  transaction: idbTransaction,
+  /**
+    Returns true if the store has a key generator, and false otherwise.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/autoIncrement)
+    */
+  autoIncrement: bool,
+}
+
+/**
+IDBIndex interface of the WebApiIndexedDB API provides asynchronous access to an index in a database. An index is a kind of object store for looking up records in another object store, called the referenced object store. You use this interface to retrieve data.
+[See IDBIndex on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex)
+TODO: mark as private once mutating fields of private records is allowed
+*/
+@editor.completeFrom(IDBIndex)
+type idbIndex = {
+  /**
+    Returns the name of the index.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/name)
+    */
+  @throws(JsExn)
+  mutable name: string,
+  /**
+    Returns the IDBObjectStore the index belongs to.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/objectStore)
+    */
+  objectStore: idbObjectStore,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/keyPath)
+    */
+  keyPath: Null.t<unknown>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/multiEntry)
+    */
+  multiEntry: bool,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/unique)
+    */
+  unique: bool,
+}
+
+type idbValidKey = unknown
+
+type idbDatabaseInfo = {
+  mutable name?: string,
+  mutable version?: int,
+}
+
+type idbTransactionOptions = {mutable durability?: idbTransactionDurability}
+
+type idbObjectStoreParameters = {
+  mutable keyPath?: Nullable.t<unknown>,
+  mutable autoIncrement?: bool,
+}
+
+type idbIndexParameters = {
+  mutable unique?: bool,
+  mutable multiEntry?: bool,
+}

package/src/storage/Storage.res

@@ -0,0 +1,42 @@
+/**
+Returns the name of the nth key, or null if n is greater than or equal to the number of key/value pairs.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Storage/key)
+*/
+@send
+external key: (WebStorageTypes.storage, int) => Null.t<string> = "key"
+
+/**
+Returns the current value associated with the given key, or null if the given key does not exist.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Storage/getItem)
+*/
+@send
+external getItem: (WebStorageTypes.storage, string) => Null.t<string> = "getItem"
+
+/**
+Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+
+Throws a "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)
+
+Dispatches a storage event on Window objects holding an equivalent WebApiStorage object.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Storage/setItem)
+*/
+@throws(JsExn) @send
+external setItem: (WebStorageTypes.storage, ~key: string, ~value: string) => unit = "setItem"
+
+/**
+Removes the key/value pair with the given key, if a key/value pair with the given key exists.
+
+Dispatches a storage event on Window objects holding an equivalent WebApiStorage object.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Storage/removeItem)
+*/
+@send
+external removeItem: (WebStorageTypes.storage, string) => unit = "removeItem"
+
+/**
+Removes all key/value pairs, if there are any.
+
+Dispatches a storage event on Window objects holding an equivalent WebApiStorage object.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Storage/clear)
+*/
+@send
+external clear: WebStorageTypes.storage => unit = "clear"

package/src/storage/StorageEvent.res

@@ -0,0 +1,10 @@
+include Event.Impl({type t = WebStorageTypes.storageEvent})
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/StorageEvent)
+*/
+@new
+external make: (
+  ~type_: string,
+  ~eventInitDict: WebStorageTypes.storageEventInit=?,
+) => WebStorageTypes.storageEvent = "StorageEvent"