@rescript/webapi 0.1.0-experimental-29b94b3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ReScript
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# experimental-rescript-webapi
+Experimental successor to [rescript-webapi](https://github.com/TheSpyder/rescript-webapi)
+
+## New approach to webapi bindings (TODO)
+
+1. Find out if it is possible to adapt https://github.com/microsoft/TypeScript-DOM-lib-generator to output `.res` files
+  - One example output is here: https://github.com/microsoft/TypeScript/blob/main/src/lib/dom.generated.d.ts
+2. Try to type most things with records with which we can model inheritance, but for readability and performance's sake it will be better to keep type spread and the necessity for coercion at a minimum and rather duplicate field names (which should not be a problem when everything is generated) as well as identity functions (coercion can be expensive with big record fields).
+3. 80/20 approach, we want to model the more common APIs in a way so that they are delightful to use while the more obscure ones can be harder to use, but those should still be documented well.
+4. In essence, we apply the rescript-core way of doing things here once again, so doc tests can be implemented as well.
+
+## TypeScript-DOM-lib-generator
+
+The repository [TypeScript-DOM-lib-generator](https://github.com/microsoft/TypeScript-DOM-lib-generator) was originally forked into [nojaf/TypeScript-DOM-lib-generator](https://github.com/nojaf/TypeScript-DOM-lib-generator/tree/rescript) but has since been copied into `tools/TypeScript-DOM-lib-generator` for easier collaboration.

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@rescript/webapi",
+  "version": "0.1.0-experimental-29b94b3",
+  "description": "Experimental successor to [rescript-webapi](https://github.com/TheSpyder/rescript-webapi)",
+  "homepage": "https://github.com/rescript-lang/experimental-rescript-webapi",
+  "bugs": "https://github.com/rescript-lang/experimental-rescript-webapi/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rescript-lang/experimental-rescript-webapi.git"
+  },
+  "author": {
+    "name": "Florian Verdonck"
+  },
+  "maintainers": [
+    "Florian Verdonck (https://github.com/nojaf)"
+  ],
+  "keywords": [
+    "rescript",
+    "webapi",
+    "mdn",
+    "dom",
+    "fetch"
+  ],
+  "files": [
+    "rescript.json",
+    "src/**/*.res"
+  ],
+  "type": "module",
+  "scripts": {
+    "test": "node tests/index.js",
+    "build": "rewatch",
+    "format": "rescript format -all"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "rescript": "^12.0.0-alpha.4"
+  }
+}

package/rescript.json

@@ -0,0 +1,19 @@
+{
+  "version": "0.0.0",
+  "name": "@rescript/webapi",
+  "sources": [
+    {
+      "dir": "src",
+      "subdirs": true
+    },
+    {
+      "dir": "tests",
+      "subdirs": true
+    }
+  ],
+  "package-specs": {
+    "module": "esmodule",
+    "in-source": true
+  },
+  "suffix": ".js"
+}

package/src/CSSFontLoadingAPI/FontFace.res

@@ -0,0 +1,34 @@
+open CSSFontLoadingAPI
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace)
+*/
+@new
+external make: (~family: string, ~source: string, ~descriptors: fontFaceDescriptors=?) => fontFace =
+  "FontFace"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace)
+*/
+@new
+external make2: (
+  ~family: string,
+  ~source: DataView.t,
+  ~descriptors: fontFaceDescriptors=?,
+) => fontFace = "FontFace"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace)
+*/
+@new
+external make3: (
+  ~family: string,
+  ~source: ArrayBuffer.t,
+  ~descriptors: fontFaceDescriptors=?,
+) => fontFace = "FontFace"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/load)
+*/
+@send
+external load: fontFace => Promise.t<fontFace> = "load"

package/src/CSSFontLoadingAPI/FontFaceSet.res

@@ -0,0 +1,112 @@
+open EventAPI
+open CSSFontLoadingAPI
+
+external asEventTarget: fontFaceSet => 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: (
+  fontFaceSet,
+  ~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: (
+  fontFaceSet,
+  ~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: (
+  fontFaceSet,
+  ~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: (
+  fontFaceSet,
+  ~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: (fontFaceSet, event) => bool = "dispatchEvent"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/add)
+*/
+@send
+external add: (fontFaceSet, fontFace) => fontFaceSet = "add"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/delete)
+*/
+@send
+external delete: (fontFaceSet, fontFace) => bool = "delete"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/clear)
+*/
+@send
+external clear: fontFaceSet => unit = "clear"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/load)
+*/
+@send
+external load: (fontFaceSet, ~font: string, ~text: string=?) => Promise.t<array<fontFace>> = "load"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/check)
+*/
+@send
+external check: (fontFaceSet, ~font: string, ~text: string=?) => bool = "check"

package/src/CSSFontLoadingAPI.res

@@ -0,0 +1,101 @@
+@@warning("-30")
+
+open EventAPI
+
+type fontDisplay =
+  | @as("auto") Auto
+  | @as("block") Block
+  | @as("fallback") Fallback
+  | @as("optional") Optional
+  | @as("swap") Swap
+
+type fontFaceLoadStatus =
+  | @as("error") Error
+  | @as("loaded") Loaded
+  | @as("loading") Loading
+  | @as("unloaded") Unloaded
+
+type fontFaceSetLoadStatus =
+  | @as("loaded") Loaded
+  | @as("loading") Loading
+
+/**
+[See FontFace on MDN](https://developer.mozilla.org/docs/Web/API/FontFace)
+*/
+type rec fontFace = {
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/family)
+    */
+  mutable family: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/style)
+    */
+  mutable style: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/weight)
+    */
+  mutable weight: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/stretch)
+    */
+  mutable stretch: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/unicodeRange)
+    */
+  mutable unicodeRange: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/featureSettings)
+    */
+  mutable featureSettings: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/display)
+    */
+  mutable display: fontDisplay,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/ascentOverride)
+    */
+  mutable ascentOverride: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/descentOverride)
+    */
+  mutable descentOverride: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/lineGapOverride)
+    */
+  mutable lineGapOverride: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/status)
+    */
+  status: fontFaceLoadStatus,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFace/loaded)
+    */
+  loaded: Promise.t<fontFace>,
+}
+
+/**
+[See FontFaceSet on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet)
+*/
+type rec fontFaceSet = {
+  ...eventTarget,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/ready)
+    */
+  ready: Promise.t<fontFaceSet>,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/FontFaceSet/status)
+    */
+  status: fontFaceSetLoadStatus,
+}
+
+type fontFaceDescriptors = {
+  mutable style?: string,
+  mutable weight?: string,
+  mutable stretch?: string,
+  mutable unicodeRange?: string,
+  mutable featureSettings?: string,
+  mutable display?: fontDisplay,
+  mutable ascentOverride?: string,
+  mutable descentOverride?: string,
+  mutable lineGapOverride?: string,
+}

package/src/CanvasAPI/ImageBitmap.res

@@ -0,0 +1,8 @@
+open CanvasAPI
+
+/**
+Releases imageBitmap's underlying bitmap data.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/ImageBitmap/close)
+*/
+@send
+external close: imageBitmap => unit = "close"

package/src/CanvasAPI/OffscreenCanvas.res

@@ -0,0 +1,123 @@
+open EventAPI
+open CanvasAPI
+open DOMAPI
+open Prelude
+open FileAPI
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas)
+*/
+@new
+external make: (~width: int, ~height: int) => offscreenCanvas = "OffscreenCanvas"
+
+external asEventTarget: offscreenCanvas => 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: (
+  offscreenCanvas,
+  ~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: (
+  offscreenCanvas,
+  ~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: (
+  offscreenCanvas,
+  ~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: (
+  offscreenCanvas,
+  ~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: (offscreenCanvas, event) => bool = "dispatchEvent"
+
+/**
+Returns an object that exposes an API for drawing on the OffscreenCanvas object. contextId specifies the desired API: "2d", "bitmaprenderer", "webgl", or "webgl2". options is handled by that API.
+
+This specification defines the "2d" context below, which is similar but distinct from the "2d" context that is created from a canvas element. The WebGL specifications define the "webgl" and "webgl2" contexts. [WEBGL]
+
+Returns null if the canvas has already been initialized with another context type (e.g., trying to get a "2d" context after getting a "webgl" context).
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/getContext)
+*/
+@send
+external getContext: (
+  offscreenCanvas,
+  ~contextId: offscreenRenderingContextId,
+  ~options: JSON.t=?,
+) => offscreenRenderingContext = "getContext"
+
+/**
+Returns a newly created ImageBitmap object with the image in the OffscreenCanvas object. The image in the OffscreenCanvas object is replaced with a new blank image.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/transferToImageBitmap)
+*/
+@send
+external transferToImageBitmap: offscreenCanvas => imageBitmap = "transferToImageBitmap"
+
+/**
+Returns a promise that will fulfill with a new Blob object representing a file containing the image in the OffscreenCanvas object.
+
+The argument, if provided, is a dictionary that controls the encoding options of the image file to be created. The type field specifies the file format and has a default value of "image/png"; that type is also used if the requested type isn't supported. If the image format supports variable quality (such as "image/jpeg"), then the quality field is a number in the range 0.0 to 1.0 inclusive indicating the desired quality level for the resulting image.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/convertToBlob)
+*/
+@send
+external convertToBlob: (offscreenCanvas, ~options: imageEncodeOptions=?) => Promise.t<blob> =
+  "convertToBlob"

package/src/CanvasAPI.res

@@ -0,0 +1,55 @@
+@@warning("-30")
+
+open Prelude
+open EventAPI
+
+type offscreenRenderingContextId =
+  | @as("2d") V2d
+  | @as("bitmaprenderer") Bitmaprenderer
+  | @as("webgl") Webgl
+  | @as("webgl2") Webgl2
+  | @as("webgpu") Webgpu
+
+/**
+[See OffscreenCanvas on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas)
+*/
+type offscreenCanvas = {
+  ...eventTarget,
+  /**
+    These attributes return the dimensions of the OffscreenCanvas object's bitmap.
+
+They can be set, to replace the bitmap with a new, transparent black bitmap of the specified dimensions (effectively resizing it).
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/width)
+    */
+  mutable width: int,
+  /**
+    These attributes return the dimensions of the OffscreenCanvas object's bitmap.
+
+They can be set, to replace the bitmap with a new, transparent black bitmap of the specified dimensions (effectively resizing it).
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/OffscreenCanvas/height)
+    */
+  mutable height: int,
+}
+
+/**
+[See ImageBitmap on MDN](https://developer.mozilla.org/docs/Web/API/ImageBitmap)
+*/
+type imageBitmap = {
+  /**
+    Returns the intrinsic width of the image, in CSS pixels.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/ImageBitmap/width)
+    */
+  width: int,
+  /**
+    Returns the intrinsic height of the image, in CSS pixels.
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/ImageBitmap/height)
+    */
+  height: int,
+}
+
+type offscreenRenderingContext = any
+
+type imageEncodeOptions = {
+  @as("type") mutable type_?: string,
+  mutable quality?: float,
+}

package/src/ChannelMessagingAPI/MessagePort.res

@@ -0,0 +1,120 @@
+open EventAPI
+open ChannelMessagingAPI
+open Prelude
+
+external asEventTarget: messagePort => 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: (
+  messagePort,
+  ~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: (
+  messagePort,
+  ~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: (
+  messagePort,
+  ~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: (
+  messagePort,
+  ~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: (messagePort, event) => bool = "dispatchEvent"
+
+/**
+Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side.
+
+Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage)
+*/
+@send
+external postMessage: (messagePort, ~message: JSON.t, ~transfer: array<Dict.t<string>>) => unit =
+  "postMessage"
+
+/**
+Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side.
+
+Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MessagePort/postMessage)
+*/
+@send
+external postMessage2: (
+  messagePort,
+  ~message: JSON.t,
+  ~options: structuredSerializeOptions=?,
+) => unit = "postMessage"
+
+/**
+Begins dispatching messages received on the port.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MessagePort/start)
+*/
+@send
+external start: messagePort => unit = "start"
+
+/**
+Disconnects the port, so that it is no longer active.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/MessagePort/close)
+*/
+@send
+external close: messagePort => unit = "close"

package/src/ChannelMessagingAPI.res

@@ -0,0 +1,13 @@
+@@warning("-30")
+
+open EventAPI
+
+/**
+This Channel Messaging API interface represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.
+[See MessagePort on MDN](https://developer.mozilla.org/docs/Web/API/MessagePort)
+*/
+type messagePort = {
+  ...eventTarget,
+}
+
+type structuredSerializeOptions = {mutable transfer?: array<Dict.t<string>>}