@rescript/webapi 0.1.0-alpha-b1d58f9

package/src/web-audio/Worklet.res

@@ -0,0 +1,14 @@
+/**
+Loads and executes the module script given by moduleURL into all of worklet's global scopes. It can also create additional global scopes as part of this process, depending on the worklet type. The returned promise will fulfill once the script has been successfully loaded and run in all global scopes.
+
+The credentials option can be set to a credentials mode to modify the script-fetching process. It defaults to "same-origin".
+
+Any failures in fetching the script or its dependencies will cause the returned promise to be rejected with an "AbortError" DOMException. Any errors in parsing the script or its dependencies will cause the returned promise to be rejected with the exception generated during parsing.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Worklet/addModule)
+*/
+@send
+external addModule: (
+  WebAudioTypes.worklet,
+  ~moduleURL: string,
+  ~options: WebAudioTypes.workletOptions=?,
+) => promise<unit> = "addModule"

package/src/window/CustomElementRegistry.res

@@ -0,0 +1,30 @@
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/define)
+*/
+@throws(JsExn) @send
+external define: (
+  DOM.customElementRegistry,
+  ~name: string,
+  ~constructor: DOMTree.htmlElement,
+  ~options: DOM.elementDefinitionOptions=?,
+) => unit = "define"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/getName)
+*/
+@send
+external getName: (DOM.customElementRegistry, DOM.customElementConstructor) => Null.t<string> =
+  "getName"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/whenDefined)
+*/
+@send
+external whenDefined: (DOM.customElementRegistry, string) => promise<DOM.customElementConstructor> =
+  "whenDefined"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/CustomElementRegistry/upgrade)
+*/
+@send
+external upgrade: (DOM.customElementRegistry, DOMTree.node) => unit = "upgrade"

package/src/window/Document.res

@@ -0,0 +1,470 @@
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document)
+*/
+@new
+external make: unit => DOM.document = "Document"
+
+include Node.Impl({type t = DOM.document})
+
+/**
+Returns the first element within node's descendants whose ID is elementId.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getElementById)
+*/
+@send
+external getElementById: (DOM.document, string) => Null.t<DOMTree.element> = "getElementById"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getAnimations)
+*/
+@send
+external getAnimations: DOM.document => array<Animation.t> = "getAnimations"
+
+/**
+Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/prepend)
+*/
+@throws(JsExn) @send
+external prepend: (DOM.document, DOMTree.node) => unit = "prepend"
+
+/**
+Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/prepend)
+*/
+@throws(JsExn) @send
+external prepend2: (DOM.document, string) => unit = "prepend"
+
+/**
+Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/append)
+*/
+@throws(JsExn) @send
+external append: (DOM.document, DOMTree.node) => unit = "append"
+
+/**
+Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/append)
+*/
+@throws(JsExn) @send
+external append2: (DOM.document, string) => unit = "append"
+
+/**
+Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
+*/
+@throws(JsExn) @send
+external replaceChildren: (DOM.document, DOMTree.node) => unit = "replaceChildren"
+
+/**
+Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.
+
+Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren)
+*/
+@throws(JsExn) @send
+external replaceChildren2: (DOM.document, string) => unit = "replaceChildren"
+
+/**
+Returns the first element that is a descendant of node that matches selectors.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/querySelector)
+*/
+@throws(JsExn) @send
+external querySelector: (DOM.document, string) => Null.t<DOMTree.element> = "querySelector"
+
+/**
+Returns all element descendants of node that match selectors.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll)
+*/
+@throws(JsExn) @send
+external querySelectorAll: (DOM.document, string) => DOM.nodeList<DOMTree.element> =
+  "querySelectorAll"
+
+/**
+This method compiles an XPathExpression which can then be used for (repeated) evaluations.
+
+You must call this method on the same document that you run the expression against.
+
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createExpression)
+*/
+@send
+external createExpression: (
+  DOM.document,
+  ~expression: string,
+  /** A function which maps a namespace prefix to a namespace URL (or null if none needed). **/
+  ~namespaceURLMapper: Null.t<string> => Null.t<string>=?,
+) => XPathExpression.t = "createExpression"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/evaluate)
+*/
+@send
+external evaluate: (
+  DOM.document,
+  ~expression: string,
+  ~contextNode: DOMTree.node,
+  ~resolver: Null.t<string> => Null.t<string>=?,
+  ~type_: int=?,
+  ~result: XPathResult.t=?,
+) => XPathResult.t = "evaluate"
+
+/**
+Retrieves a collection of objects based on the specified element name.
+@param name Specifies the name of an element.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getElementsByTagName)
+*/
+@send
+external getElementsByTagName: (DOM.document, string) => HTMLCollection.t<DOMTree.element> =
+  "getElementsByTagName"
+
+/**
+If namespace and localName are "*" returns a HTMLCollection of all descendant elements.
+
+If only namespace is "*" returns a HTMLCollection of all descendant elements whose local name is localName.
+
+If only localName is "*" returns a HTMLCollection of all descendant elements whose namespace is namespace.
+
+Otherwise, returns a HTMLCollection of all descendant elements whose namespace is namespace and local name is localName.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getElementsByTagNameNS)
+*/
+@send
+external getElementsByTagNameNS: (
+  DOM.document,
+  ~namespace: string,
+  ~localName: string,
+) => HTMLCollection.t<DOMTree.element> = "getElementsByTagNameNS"
+
+/**
+Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getElementsByClassName)
+*/
+@send
+external getElementsByClassName: (DOM.document, string) => HTMLCollection.t<DOMTree.element> =
+  "getElementsByClassName"
+
+type elementCreationOptions = {mutable is?: string}
+
+/**
+Creates an instance of the element for the specified tag.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createElement)
+*/
+@throws(JsExn) @send
+external createElement: (
+  DOM.document,
+  string,
+  ~options: elementCreationOptions=?,
+) => DOMTree.element = "createElement"
+
+/**
+Returns an element with namespace namespace. Its namespace prefix will be everything before ":" (U+003E) in qualifiedName or null. Its local name will be everything after ":" (U+003E) in qualifiedName or qualifiedName.
+
+If localName does not match the Name production an "InvalidCharacterError" DOMException will be thrown.
+
+If one of the following conditions is true a "NamespaceError" DOMException will be thrown:
+
+localName does not match the QName production.
+Namespace prefix is not null and namespace is the empty string.
+Namespace prefix is "xml" and namespace is not the XML namespace.
+qualifiedName or namespace prefix is "xmlns" and namespace is not the XMLNS namespace.
+namespace is the XMLNS namespace and neither qualifiedName nor namespace prefix is "xmlns".
+
+When supplied, options's is can be used to create a customized built-in element.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createElementNS)
+*/
+@throws(JsExn) @send
+external createElementNS: (
+  DOM.document,
+  ~namespace: string,
+  ~qualifiedName: string,
+  ~options: string=?,
+) => DOMTree.element = "createElementNS"
+
+/**
+Returns an element with namespace namespace. Its namespace prefix will be everything before ":" (U+003E) in qualifiedName or null. Its local name will be everything after ":" (U+003E) in qualifiedName or qualifiedName.
+
+If localName does not match the Name production an "InvalidCharacterError" DOMException will be thrown.
+
+If one of the following conditions is true a "NamespaceError" DOMException will be thrown:
+
+localName does not match the QName production.
+Namespace prefix is not null and namespace is the empty string.
+Namespace prefix is "xml" and namespace is not the XML namespace.
+qualifiedName or namespace prefix is "xmlns" and namespace is not the XMLNS namespace.
+namespace is the XMLNS namespace and neither qualifiedName nor namespace prefix is "xmlns".
+
+When supplied, options's is can be used to create a customized built-in element.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createElementNS)
+*/
+@throws(JsExn) @send
+external createElementNS2: (
+  DOM.document,
+  ~namespace: string,
+  ~qualifiedName: string,
+  ~options: elementCreationOptions=?,
+) => DOMTree.element = "createElementNS"
+
+/**
+Creates a new document.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createDocumentFragment)
+*/
+@send
+external createDocumentFragment: DOM.document => DOMTree.documentFragment = "createDocumentFragment"
+
+/**
+Creates a text string from the specified value.
+@param data String that specifies the nodeValue property of the text node.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createTextNode)
+*/
+@send
+external createTextNode: (DOM.document, string) => Text.t = "createTextNode"
+
+/**
+Returns a CDATASection node whose data is data.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createCDATASection)
+*/
+@send
+external createCDATASection: (DOM.document, string) => CDATASection.t = "createCDATASection"
+
+/**
+Creates a comment object with the specified data.
+@param data Sets the comment object's data.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createComment)
+*/
+@send
+external createComment: (DOM.document, string) => Comment.t = "createComment"
+
+/**
+Returns a ProcessingInstruction node whose target is target and data is data. If target does not match the Name production an "InvalidCharacterError" DOMException will be thrown. If data contains "?>" an "InvalidCharacterError" DOMException will be thrown.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createProcessingInstruction)
+*/
+@throws(JsExn) @send
+external createProcessingInstruction: (
+  DOM.document,
+  ~target: string,
+  ~data: string,
+) => ProcessingInstruction.t = "createProcessingInstruction"
+
+/**
+Returns a copy of node. If deep is true, the copy also includes the node's descendants.
+
+If node is a document or a shadow root, throws a "NotSupportedError" DOMException.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/importNode)
+*/
+@throws(JsExn) @send
+external importNode: (DOM.document, 't, ~deep: bool=?) => 't = "importNode"
+
+/**
+Moves node from another document and returns it.
+
+If node is a document, throws a "NotSupportedError" DOMException or, if node is a shadow root, throws a "HierarchyRequestError" DOMException.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/adoptNode)
+*/
+@throws(JsExn) @send
+external adoptNode: (DOM.document, 't) => 't = "adoptNode"
+
+/**
+Creates an attribute object with a specified name.
+@param name String that sets the attribute object's name.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createAttribute)
+*/
+@throws(JsExn) @send
+external createAttribute: (DOM.document, string) => Attr.t = "createAttribute"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createAttributeNS)
+*/
+@throws(JsExn) @send
+external createAttributeNS: (DOM.document, ~namespace: string, ~qualifiedName: string) => Attr.t =
+  "createAttributeNS"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createEvent)
+*/
+@send
+external createEvent: (DOM.document, string) => DOM.event = "createEvent"
+
+/**
+ Returns an empty range object that has both of its boundary points positioned at the beginning of the document.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createRange)
+*/
+@send
+external createRange: DOM.document => Range.t = "createRange"
+
+/**
+Creates a NodeIterator object that you can use to traverse filtered lists of nodes or elements in a document.
+@param root The root element or node to start traversing on.
+@param whatToShow The type of nodes or elements to appear in the node list
+@param filter A custom NodeFilter function to use. For more information, see filter. Use null for no filter.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createNodeIterator)
+*/
+@send
+external createNodeIterator: (
+  DOM.document,
+  ~root: DOMTree.node,
+  ~whatToShow: int=?,
+  ~filter: NodeFilter.t=?,
+) => NodeIterator.t = "createNodeIterator"
+
+/**
+Creates a TreeWalker object that you can use to traverse filtered lists of nodes or elements in a document.
+@param root The root element or node to start traversing on.
+@param whatToShow The type of nodes or elements to appear in the node list. For more information, see whatToShow.
+@param filter A custom NodeFilter function to use.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/createTreeWalker)
+*/
+@send
+external createTreeWalker: (
+  DOM.document,
+  ~root: DOMTree.node,
+  ~whatToShow: int=?,
+  ~filter: NodeFilter.t=?,
+) => TreeWalker.t = "createTreeWalker"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/startViewTransition)
+*/
+@send
+external startViewTransition: (
+  DOM.document,
+  ~callbackOptions: ViewTransitionsTypes.viewTransitionUpdateCallback=?,
+) => ViewTransitionsTypes.viewTransition = "startViewTransition"
+
+type caretPositionFromPointOptions = {mutable shadowRoots?: array<DOMTree.shadowRoot>}
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/caretPositionFromPoint)
+*/
+@send
+external caretPositionFromPoint: (
+  DOM.document,
+  ~x: float,
+  ~y: float,
+  ~options: caretPositionFromPointOptions=?,
+) => Null.t<DOM.caretPosition> = "caretPositionFromPoint"
+
+/**
+Stops document's fullscreen element from being displayed fullscreen and resolves promise when done.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/exitFullscreen)
+*/
+@send
+external exitFullscreen: DOM.document => promise<unit> = "exitFullscreen"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/parseHTMLUnsafe_static)
+*/
+@throws(JsExn) @scope("Document")
+external parseHTMLUnsafe: string => DOM.document = "parseHTMLUnsafe"
+
+/**
+Gets a collection of objects based on the value of the NAME or ID attribute.
+@param elementName Gets a collection of objects based on the value of the NAME or ID attribute.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getElementsByName)
+*/
+@send
+external getElementsByName: (DOM.document, string) => DOM.nodeList<DOMTree.htmlElement> =
+  "getElementsByName"
+
+/**
+Opens a new window and loads a document specified by a given URL. Also, opens a new window that uses the url parameter and the name parameter to collect the output of the write method and the writeln method.
+@param url Specifies a MIME type for the document.
+@param name Specifies the name of the window. This name is used as the value for the TARGET attribute on a form or an anchor element.
+@param features Contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, "fullscreen=yes, toolbar=yes"). The following values are supported.
+@param replace Specifies whether the existing entry for the document is replaced in the history list.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/open)
+*/
+@send
+external open_: (DOM.document, ~unused1: string=?, ~unused2: string=?) => DOM.document = "open"
+
+/**
+Opens a new window and loads a document specified by a given URL. Also, opens a new window that uses the url parameter and the name parameter to collect the output of the write method and the writeln method.
+@param url Specifies a MIME type for the document.
+@param name Specifies the name of the window. This name is used as the value for the TARGET attribute on a form or an anchor element.
+@param features Contains a list of items separated by commas. Each item consists of an option and a value, separated by an equals sign (for example, "fullscreen=yes, toolbar=yes"). The following values are supported.
+@param replace Specifies whether the existing entry for the document is replaced in the history list.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/open)
+*/
+@send
+external open2: (
+  DOM.document,
+  ~url: string,
+  ~name: string,
+  ~features: string,
+) => Null.t<DOM.window> = "open"
+
+/**
+Closes an output stream and forces the sent data to display.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/close)
+*/
+@send
+external close: DOM.document => unit = "close"
+
+/**
+Writes one or more HTML expressions to a document in the specified window.
+@param content Specifies the text and HTML tags to write.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/write)
+*/
+@throws(JsExn) @send
+external write: (DOM.document, string) => unit = "write"
+
+/**
+Writes one or more HTML expressions, followed by a carriage return, to a document in the specified window.
+@param content The text and HTML tags to write.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/writeln)
+*/
+@throws(JsExn) @send
+external writeln: (DOM.document, string) => unit = "writeln"
+
+/**
+Gets a value indicating whether the object currently has focus.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/hasFocus)
+*/
+@send
+external hasFocus: DOM.document => bool = "hasFocus"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/exitPictureInPicture)
+*/
+@send
+external exitPictureInPicture: DOM.document => promise<unit> = "exitPictureInPicture"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/exitPointerLock)
+*/
+@send
+external exitPointerLock: DOM.document => unit = "exitPointerLock"
+
+/**
+Returns an object representing the current selection of the document that is loaded into the object displaying a webpage.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/getSelection)
+*/
+@send
+external getSelection: DOM.document => Null.t<Selection.t> = "getSelection"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/hasStorageAccess)
+*/
+@send
+external hasStorageAccess: DOM.document => promise<bool> = "hasStorageAccess"
+
+/**
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/requestStorageAccess)
+*/
+@send
+external requestStorageAccess: DOM.document => promise<unit> = "requestStorageAccess"
+
+let isInstanceOf = (_: 't): bool => %raw(`param instanceof Document`)
+
+/**
+Returns the Location associated with this document, which provides information about the current URL and methods for navigating to another URL.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/Document/location)
+*/
+@get
+external location: DOM.document => Null.t<Location.t> = "location"