@rescript/webapi 0.1.0-experimental-29b94b3

package/src/IndexedDBAPI/IDBObjectStore.res

@@ -0,0 +1,167 @@
+open IndexedDBAPI
+open Prelude
+
+/**
+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)
+*/
+@send
+external put: (idbObjectStore, ~value: JSON.t, ~key: idbValidKey=?) => idbRequest<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)
+*/
+@send
+external add: (idbObjectStore, ~value: JSON.t, ~key: idbValidKey=?) => idbRequest<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)
+*/
+@send
+external delete: (idbObjectStore, any) => 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)
+*/
+@send
+external clear: idbObjectStore => 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)
+*/
+@send
+external get: (idbObjectStore, any) => idbRequest<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)
+*/
+@send
+external getKey: (idbObjectStore, any) => idbRequest<any> = "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)
+*/
+@send
+external getAll: (idbObjectStore, ~query: any=?, ~count: int=?) => 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)
+*/
+@send
+external getAllKeys: (
+  idbObjectStore,
+  ~query: any=?,
+  ~count: int=?,
+) => idbRequest<array<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)
+*/
+@send
+external count: (idbObjectStore, ~query: any=?) => 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)
+*/
+@send
+external openCursor: (
+  idbObjectStore,
+  ~query: any=?,
+  ~direction: idbCursorDirection=?,
+) => idbRequest<any> = "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)
+*/
+@send
+external openKeyCursor: (
+  idbObjectStore,
+  ~query: any=?,
+  ~direction: idbCursorDirection=?,
+) => idbRequest<any> = "openKeyCursor"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/index)
+*/
+@send
+external index: (idbObjectStore, string) => 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)
+*/
+@send
+external createIndex: (
+  idbObjectStore,
+  ~name: string,
+  ~keyPath: string,
+  ~options: idbIndexParameters=?,
+) => 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)
+*/
+@send
+external createIndex2: (
+  idbObjectStore,
+  ~name: string,
+  ~keyPath: array<string>,
+  ~options: idbIndexParameters=?,
+) => 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)
+*/
+@send
+external deleteIndex: (idbObjectStore, string) => unit = "deleteIndex"

package/src/IndexedDBAPI/IDBTransaction.res

@@ -0,0 +1,102 @@
+open EventAPI
+open IndexedDBAPI
+
+external asEventTarget: idbTransaction => eventTarget = "%identity"
+/**
+Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
+
+The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
+
+When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
+
+When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
+
+When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
+
+If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
+
+The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
+*/
+@send
+external addEventListener: (
+  idbTransaction,
+  ~type_: eventType,
+  ~callback: eventListener<'event>,
+  ~options: addEventListenerOptions=?,
+) => unit = "addEventListener"
+
+/**
+Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
+
+The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
+
+When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
+
+When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
+
+When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
+
+If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
+
+The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener)
+*/
+@send
+external addEventListener2: (
+  idbTransaction,
+  ~type_: eventType,
+  ~callback: eventListener<'event>,
+  ~options: bool=?,
+) => unit = "addEventListener"
+
+/**
+Removes the event listener in target's event listener list with the same type, callback, and options.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
+*/
+@send
+external removeEventListener: (
+  idbTransaction,
+  ~type_: eventType,
+  ~callback: eventListener<'event>,
+  ~options: eventListenerOptions=?,
+) => unit = "removeEventListener"
+
+/**
+Removes the event listener in target's event listener list with the same type, callback, and options.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener)
+*/
+@send
+external removeEventListener2: (
+  idbTransaction,
+  ~type_: eventType,
+  ~callback: eventListener<'event>,
+  ~options: bool=?,
+) => unit = "removeEventListener"
+
+/**
+Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent)
+*/
+@send
+external dispatchEvent: (idbTransaction, event) => bool = "dispatchEvent"
+
+/**
+Returns an IDBObjectStore in the transaction's scope.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/objectStore)
+*/
+@send
+external objectStore: (idbTransaction, string) => idbObjectStore = "objectStore"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction/commit)
+*/
+@send
+external commit: 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)
+*/
+@send
+external abort: idbTransaction => unit = "abort"

package/src/IndexedDBAPI.res

@@ -0,0 +1,205 @@
+@@warning("-30")
+
+open Prelude
+open EventAPI
+
+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)
+*/
+type idbFactory = {}
+
+/**
+This IndexedDB 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)
+*/
+type idbDatabase = {
+  ...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: domStringList,
+}
+
+/**
+[See IDBTransaction on MDN](https://developer.mozilla.org/docs/Web/API/IDBTransaction)
+*/
+type idbTransaction = {
+  ...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: 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<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> = {
+  ...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)
+    */
+  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)
+    */
+  error: Null.t<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: 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)
+*/
+type idbObjectStore = {
+  /**
+    Returns the name of the store.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBObjectStore/name)
+    */
+  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: string,
+  /**
+    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: 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 IndexedDB 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)
+*/
+type idbIndex = {
+  /**
+    Returns the name of the index.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/IDBIndex/name)
+    */
+  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: string,
+  /**
+    [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 = any
+
+type idbDatabaseInfo = {
+  mutable name?: string,
+  mutable version?: int,
+}
+
+type idbTransactionOptions = {mutable durability?: idbTransactionDurability}
+
+type idbObjectStoreParameters = {
+  mutable keyPath?: Null.t<unknown>,
+  mutable autoIncrement?: bool,
+}
+
+type idbIndexParameters = {
+  mutable unique?: bool,
+  mutable multiEntry?: bool,
+}

package/src/MediaCapabilitiesAPI/MediaCapabilities.res

@@ -0,0 +1,19 @@
+open MediaCapabilitiesAPI
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MediaCapabilities/decodingInfo)
+*/
+@send
+external decodingInfo: (
+  mediaCapabilities,
+  mediaDecodingConfiguration,
+) => Promise.t<mediaCapabilitiesDecodingInfo> = "decodingInfo"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MediaCapabilities/encodingInfo)
+*/
+@send
+external encodingInfo: (
+  mediaCapabilities,
+  mediaEncodingConfiguration,
+) => Promise.t<mediaCapabilitiesEncodingInfo> = "encodingInfo"

package/src/MediaCapabilitiesAPI.res

@@ -0,0 +1,81 @@
+@@warning("-30")
+type hdrMetadataType =
+  | @as("smpteSt2086") SmpteSt2086
+  | @as("smpteSt2094-10") SmpteSt209410
+  | @as("smpteSt2094-40") SmpteSt209440
+
+type colorGamut =
+  | @as("p3") P3
+  | @as("rec2020") Rec2020
+  | @as("srgb") Srgb
+
+type transferFunction =
+  | @as("hlg") Hlg
+  | @as("pq") Pq
+  | @as("srgb") Srgb
+
+type mediaDecodingType =
+  | @as("file") File
+  | @as("media-source") MediaSource
+  | @as("webrtc") Webrtc
+
+type mediaEncodingType =
+  | @as("record") Record
+  | @as("webrtc") Webrtc
+
+/**
+[See MediaCapabilities on MDN](https://developer.mozilla.org/docs/Web/API/MediaCapabilities)
+*/
+type mediaCapabilities = {}
+
+type audioConfiguration = {
+  mutable contentType: string,
+  mutable channels?: string,
+  mutable bitrate?: int,
+  mutable samplerate?: int,
+  mutable spatialRendering?: bool,
+}
+
+type videoConfiguration = {
+  mutable contentType: string,
+  mutable width: int,
+  mutable height: int,
+  mutable bitrate: int,
+  mutable framerate: float,
+  mutable hasAlphaChannel?: bool,
+  mutable hdrMetadataType?: hdrMetadataType,
+  mutable colorGamut?: colorGamut,
+  mutable transferFunction?: transferFunction,
+  mutable scalabilityMode?: string,
+}
+
+type mediaConfiguration = {
+  mutable video?: videoConfiguration,
+  mutable audio?: audioConfiguration,
+}
+
+type mediaDecodingConfiguration = {
+  ...mediaConfiguration,
+  @as("type") mutable type_: mediaDecodingType,
+}
+
+type mediaCapabilitiesInfo = {
+  mutable supported: bool,
+  mutable smooth: bool,
+  mutable powerEfficient: bool,
+}
+
+type mediaCapabilitiesDecodingInfo = {
+  ...mediaCapabilitiesInfo,
+  mutable configuration?: mediaDecodingConfiguration,
+}
+
+type mediaEncodingConfiguration = {
+  ...mediaConfiguration,
+  @as("type") mutable type_: mediaEncodingType,
+}
+
+type mediaCapabilitiesEncodingInfo = {
+  ...mediaCapabilitiesInfo,
+  mutable configuration?: mediaEncodingConfiguration,
+}

package/src/MediaCaptureAndStreamsAPI/MediaDeviceInfo.res

@@ -0,0 +1,7 @@
+open MediaCaptureAndStreamsAPI
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MediaDeviceInfo/toJSON)
+*/
+@send
+external toJSON: mediaDeviceInfo => Dict.t<string> = "toJSON"