Merge pull request #617 from scala-js/topic/readyState

armanbilge · web-flow · commit 4d41914b8124 · 2021-10-20T23:20:43.000-07:00
Revise and add `ReadyState` classes
diff --git a/api-reports/2_12.txt b/api-reports/2_12.txt
@@ -1548,6 +1548,10 @@ DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listene
 DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 DocumentFragment[JC] def replaceChild(newChild: Node, oldChild: Node): Node
 DocumentFragment[JC] var textContent: String
+DocumentReadyState[JT]
+DocumentReadyState[SO] val complete: DocumentReadyState
+DocumentReadyState[SO] val interactive: DocumentReadyState
+DocumentReadyState[SO] val loading: DocumentReadyState
 DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 DocumentType[JC] def appendChild(newChild: Node): Node
@@ -4480,7 +4484,7 @@ HTMLDocument[JC] def queryCommandText(commandId: String): String
 HTMLDocument[JC] def queryCommandValue(commandId: String): String
 HTMLDocument[JC] def querySelector(selectors: String): Element
 HTMLDocument[JC] def querySelectorAll(selectors: String): NodeList[Element]
-HTMLDocument[JC] def readyState: String
+HTMLDocument[JC] def readyState: DocumentReadyState
 HTMLDocument[JC] def referrer: String
 HTMLDocument[JC] def removeChild(oldChild: Node): Node
 HTMLDocument[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
@@ -14093,7 +14097,7 @@ IDBOpenDBRequest[JC] var onblocked: js.Function1[IDBVersionChangeEvent, _]
 IDBOpenDBRequest[JC] var onerror: js.Function1[Event, _]
 IDBOpenDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
 IDBOpenDBRequest[JC] var onupgradeneeded: js.Function1[IDBVersionChangeEvent, _]
-IDBOpenDBRequest[JC] def readyState: String
+IDBOpenDBRequest[JC] def readyState: IDBRequestReadyState
 IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 IDBOpenDBRequest[JC] def result: A
@@ -14105,12 +14109,15 @@ IDBRequest[JC] def dispatchEvent(evt: Event): Boolean
 IDBRequest[JC] def error: DOMException
 IDBRequest[JC] var onerror: js.Function1[Event, _]
 IDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
-IDBRequest[JC] def readyState: String
+IDBRequest[JC] def readyState: IDBRequestReadyState
 IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 IDBRequest[JC] def result: A
 IDBRequest[JC] def source: S
 IDBRequest[JC] def transaction: IDBTransaction
+IDBRequestReadyState[JT]
+IDBRequestReadyState[SO] val done: IDBRequestReadyState
+IDBRequestReadyState[SO] val pending: IDBRequestReadyState
 IDBStoreLike[JT] def count(query: IDBKey | IDBKeyRange?): IDBRequest[S, Double]
 IDBStoreLike[JT] def get(key: IDBKey | IDBKeyRange): IDBRequest[S, IDBValue]
 IDBStoreLike[JT] def getAll(query: js.UndefOr[IDBKeyRange | IDBKey]?, count: js.UndefOr[Double]?): IDBRequest[S, js.Array[IDBValue]]
@@ -14761,13 +14768,17 @@ MediaSource[JC] def endOfStream(error: EndOfStreamError?): Unit
 MediaSource[JC] var onsourceclose: js.Function1[Event, Any]
 MediaSource[JC] var onsourceended: js.Function1[Event, Any]
 MediaSource[JC] var onsourceopen: js.Function1[Event, Any]
-MediaSource[JC] def readyState: ReadyState
+MediaSource[JC] def readyState: MediaSourceReadyState
 MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 MediaSource[JC] def removeSourceBuffer(sourceBuffer: SourceBuffer): Unit
 MediaSource[JC] def setLiveSeekableRange(start: Double, end: Double): Unit
 MediaSource[JC] def sourceBuffers: SourceBufferList
 MediaSource[JO] def isTypeSupported(mediaType: String): Boolean
+MediaSourceReadyState[JT]
+MediaSourceReadyState[SO] val closed: MediaSourceReadyState
+MediaSourceReadyState[SO] val ended: MediaSourceReadyState
+MediaSourceReadyState[SO] val open: MediaSourceReadyState
 MediaStream[JC] val active: Boolean
 MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
@@ -15845,10 +15856,6 @@ ReadableStreamReader[JC] def cancel(reason: Any): js.Promise[Any]
 ReadableStreamReader[JC] def closed: js.Promise[ReadableStreamReader[T]]
 ReadableStreamReader[JC] def read(): js.Promise[Chunk[T]]
 ReadableStreamReader[JC] def releaseLock(): Unit
-ReadyState[JT]
-ReadyState[SO] val closed: ReadyState
-ReadyState[SO] val ended: ReadyState
-ReadyState[SO] val open: ReadyState
 ReferrerPolicy[JT]
 ReferrerPolicy[SO] val empty: ReferrerPolicy
 ReferrerPolicy[SO] val `no-referrer` = "no-referrer".asInstanceOf[ReferrerPolicy]
@@ -25559,7 +25566,7 @@ experimental/mediastream/package[SO] type MediaTrackConstraintSet = dom.MediaTra
 experimental/mediastream/package[SO] type MediaTrackConstraints = dom.MediaTrackConstraints  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type MediaTrackSettings = dom.MediaTrackSettings  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type MediaTrackSupportedConstraints = dom.MediaTrackSupportedConstraints  (@deprecated in 2.0.0)
-experimental/mediastream/package[SO] type ReadyState = dom.ReadyState  (@deprecated in 2.0.0)
+experimental/mediastream/package[SO] type ReadyState = dom.MediaSourceReadyState  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type SourceBuffer = dom.SourceBuffer  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type SourceBufferList = dom.SourceBufferList  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type TextTrack = dom.TextTrack  (@deprecated in 2.0.0)
diff --git a/api-reports/2_13.txt b/api-reports/2_13.txt
@@ -1548,6 +1548,10 @@ DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listene
 DocumentFragment[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 DocumentFragment[JC] def replaceChild(newChild: Node, oldChild: Node): Node
 DocumentFragment[JC] var textContent: String
+DocumentReadyState[JT]
+DocumentReadyState[SO] val complete: DocumentReadyState
+DocumentReadyState[SO] val interactive: DocumentReadyState
+DocumentReadyState[SO] val loading: DocumentReadyState
 DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 DocumentType[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 DocumentType[JC] def appendChild(newChild: Node): Node
@@ -4480,7 +4484,7 @@ HTMLDocument[JC] def queryCommandText(commandId: String): String
 HTMLDocument[JC] def queryCommandValue(commandId: String): String
 HTMLDocument[JC] def querySelector(selectors: String): Element
 HTMLDocument[JC] def querySelectorAll(selectors: String): NodeList[Element]
-HTMLDocument[JC] def readyState: String
+HTMLDocument[JC] def readyState: DocumentReadyState
 HTMLDocument[JC] def referrer: String
 HTMLDocument[JC] def removeChild(oldChild: Node): Node
 HTMLDocument[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
@@ -14093,7 +14097,7 @@ IDBOpenDBRequest[JC] var onblocked: js.Function1[IDBVersionChangeEvent, _]
 IDBOpenDBRequest[JC] var onerror: js.Function1[Event, _]
 IDBOpenDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
 IDBOpenDBRequest[JC] var onupgradeneeded: js.Function1[IDBVersionChangeEvent, _]
-IDBOpenDBRequest[JC] def readyState: String
+IDBOpenDBRequest[JC] def readyState: IDBRequestReadyState
 IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 IDBOpenDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 IDBOpenDBRequest[JC] def result: A
@@ -14105,12 +14109,15 @@ IDBRequest[JC] def dispatchEvent(evt: Event): Boolean
 IDBRequest[JC] def error: DOMException
 IDBRequest[JC] var onerror: js.Function1[Event, _]
 IDBRequest[JC] var onsuccess: js.Function1[IDBEvent[A], _]
-IDBRequest[JC] def readyState: String
+IDBRequest[JC] def readyState: IDBRequestReadyState
 IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 IDBRequest[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 IDBRequest[JC] def result: A
 IDBRequest[JC] def source: S
 IDBRequest[JC] def transaction: IDBTransaction
+IDBRequestReadyState[JT]
+IDBRequestReadyState[SO] val done: IDBRequestReadyState
+IDBRequestReadyState[SO] val pending: IDBRequestReadyState
 IDBStoreLike[JT] def count(query: IDBKey | IDBKeyRange?): IDBRequest[S, Double]
 IDBStoreLike[JT] def get(key: IDBKey | IDBKeyRange): IDBRequest[S, IDBValue]
 IDBStoreLike[JT] def getAll(query: js.UndefOr[IDBKeyRange | IDBKey]?, count: js.UndefOr[Double]?): IDBRequest[S, js.Array[IDBValue]]
@@ -14761,13 +14768,17 @@ MediaSource[JC] def endOfStream(error: EndOfStreamError?): Unit
 MediaSource[JC] var onsourceclose: js.Function1[Event, Any]
 MediaSource[JC] var onsourceended: js.Function1[Event, Any]
 MediaSource[JC] var onsourceopen: js.Function1[Event, Any]
-MediaSource[JC] def readyState: ReadyState
+MediaSource[JC] def readyState: MediaSourceReadyState
 MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 MediaSource[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
 MediaSource[JC] def removeSourceBuffer(sourceBuffer: SourceBuffer): Unit
 MediaSource[JC] def setLiveSeekableRange(start: Double, end: Double): Unit
 MediaSource[JC] def sourceBuffers: SourceBufferList
 MediaSource[JO] def isTypeSupported(mediaType: String): Boolean
+MediaSourceReadyState[JT]
+MediaSourceReadyState[SO] val closed: MediaSourceReadyState
+MediaSourceReadyState[SO] val ended: MediaSourceReadyState
+MediaSourceReadyState[SO] val open: MediaSourceReadyState
 MediaStream[JC] val active: Boolean
 MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
 MediaStream[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
@@ -15845,10 +15856,6 @@ ReadableStreamReader[JC] def cancel(reason: Any): js.Promise[Any]
 ReadableStreamReader[JC] def closed: js.Promise[ReadableStreamReader[T]]
 ReadableStreamReader[JC] def read(): js.Promise[Chunk[T]]
 ReadableStreamReader[JC] def releaseLock(): Unit
-ReadyState[JT]
-ReadyState[SO] val closed: ReadyState
-ReadyState[SO] val ended: ReadyState
-ReadyState[SO] val open: ReadyState
 ReferrerPolicy[JT]
 ReferrerPolicy[SO] val empty: ReferrerPolicy
 ReferrerPolicy[SO] val `no-referrer` = "no-referrer".asInstanceOf[ReferrerPolicy]
@@ -25559,7 +25566,7 @@ experimental/mediastream/package[SO] type MediaTrackConstraintSet = dom.MediaTra
 experimental/mediastream/package[SO] type MediaTrackConstraints = dom.MediaTrackConstraints  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type MediaTrackSettings = dom.MediaTrackSettings  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type MediaTrackSupportedConstraints = dom.MediaTrackSupportedConstraints  (@deprecated in 2.0.0)
-experimental/mediastream/package[SO] type ReadyState = dom.ReadyState  (@deprecated in 2.0.0)
+experimental/mediastream/package[SO] type ReadyState = dom.MediaSourceReadyState  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type SourceBuffer = dom.SourceBuffer  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type SourceBufferList = dom.SourceBufferList  (@deprecated in 2.0.0)
 experimental/mediastream/package[SO] type TextTrack = dom.TextTrack  (@deprecated in 2.0.0)
diff --git a/dom/src/main/scala-2/org/scalajs/dom/DocumentReadyState.scala b/dom/src/main/scala-2/org/scalajs/dom/DocumentReadyState.scala
@@ -0,0 +1,12 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+@js.native
+sealed trait DocumentReadyState extends js.Any
+
+object DocumentReadyState {
+  val complete: DocumentReadyState = "complete".asInstanceOf[DocumentReadyState]
+  val interactive: DocumentReadyState = "interactive".asInstanceOf[DocumentReadyState]
+  val loading: DocumentReadyState = "loading".asInstanceOf[DocumentReadyState]
+}
diff --git a/dom/src/main/scala-2/org/scalajs/dom/IDBRequestReadyState.scala b/dom/src/main/scala-2/org/scalajs/dom/IDBRequestReadyState.scala
@@ -0,0 +1,11 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+@js.native
+sealed trait IDBRequestReadyState extends js.Any
+
+object IDBRequestReadyState {
+  val done: IDBRequestReadyState = "done".asInstanceOf[IDBRequestReadyState]
+  val pending: IDBRequestReadyState = "pending".asInstanceOf[IDBRequestReadyState]
+}
diff --git a/dom/src/main/scala-2/org/scalajs/dom/MediaSourceReadyState.scala b/dom/src/main/scala-2/org/scalajs/dom/MediaSourceReadyState.scala
@@ -0,0 +1,12 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+@js.native
+sealed trait MediaSourceReadyState extends js.Any
+
+object MediaSourceReadyState {
+  val closed: MediaSourceReadyState = "closed".asInstanceOf[MediaSourceReadyState]
+  val ended: MediaSourceReadyState = "ended".asInstanceOf[MediaSourceReadyState]
+  val open: MediaSourceReadyState = "open".asInstanceOf[MediaSourceReadyState]
+}
diff --git a/dom/src/main/scala-2/org/scalajs/dom/ReadyState.scala b/dom/src/main/scala-2/org/scalajs/dom/ReadyState.scala
diff --git a/dom/src/main/scala-3/org/scalajs/dom/DocumentReadyState.scala b/dom/src/main/scala-3/org/scalajs/dom/DocumentReadyState.scala
@@ -0,0 +1,9 @@
+package org.scalajs.dom
+
+opaque type DocumentReadyState <: String = String
+
+object DocumentReadyState {
+  val complete: DocumentReadyState = "complete"
+  val interactive: DocumentReadyState = "interactive"
+  val loading: DocumentReadyState = "loading"
+}
diff --git a/dom/src/main/scala-3/org/scalajs/dom/IDBRequestReadyState.scala b/dom/src/main/scala-3/org/scalajs/dom/IDBRequestReadyState.scala
@@ -0,0 +1,8 @@
+package org.scalajs.dom
+
+opaque type IDBRequestReadyState <: String = String
+
+object IDBRequestReadyState {
+  val done: IDBRequestReadyState = "done"
+  val pending: IDBRequestReadyState = "pending"
+}
diff --git a/dom/src/main/scala-3/org/scalajs/dom/MediaSourceReadyState.scala b/dom/src/main/scala-3/org/scalajs/dom/MediaSourceReadyState.scala
@@ -0,0 +1,9 @@
+package org.scalajs.dom
+
+opaque type MediaSourceReadyState <: String = String
+
+object MediaSourceReadyState {
+  val closed: MediaSourceReadyState = "closed"
+  val ended: MediaSourceReadyState = "ended"
+  val open: MediaSourceReadyState = "open"
+}
diff --git a/dom/src/main/scala-3/org/scalajs/dom/ReadyState.scala b/dom/src/main/scala-3/org/scalajs/dom/ReadyState.scala
diff --git a/dom/src/main/scala/org/scalajs/dom/HTMLDocument.scala b/dom/src/main/scala/org/scalajs/dom/HTMLDocument.scala
@@ -47,7 +47,7 @@ abstract class HTMLDocument extends Document {
   /** Returns "loading" while the document is loading, "interactive" once it is finished parsing but still loading
     * sub-resources, and "complete" once it has loaded.
     */
-  def readyState: String = js.native
+  def readyState: DocumentReadyState = js.native
 
   var uniqueID: String = js.native
 
diff --git a/dom/src/main/scala/org/scalajs/dom/IDBRequest.scala b/dom/src/main/scala/org/scalajs/dom/IDBRequest.scala
@@ -46,7 +46,7 @@ class IDBRequest[+S, A] extends EventTarget {
   /** The state of the request. Every request starts in the pending state. The state changes to done when the request
     * completes successfully or when an error occurs.
     */
-  def readyState: String = js.native
+  def readyState: IDBRequestReadyState = js.native
 
   /** Returns the result of the request. If the the request failed and the result is not available,
     * the InvalidStateError exception is thrown.
diff --git a/dom/src/main/scala/org/scalajs/dom/MediaSource.scala b/dom/src/main/scala/org/scalajs/dom/MediaSource.scala
@@ -13,7 +13,7 @@ import scala.scalajs.js.annotation._
 class MediaSource extends EventTarget {
   def sourceBuffers: SourceBufferList = js.native
   def activeSourceBuffers: SourceBufferList = js.native
-  def readyState: ReadyState = js.native
+  def readyState: MediaSourceReadyState = js.native
 
   /** Allows the web application to set the presentation duration.
     *
diff --git a/dom/src/main/scala/org/scalajs/dom/experimental/mediastream/package.scala b/dom/src/main/scala/org/scalajs/dom/experimental/mediastream/package.scala
@@ -16,8 +16,8 @@ package object mediastream {
   @deprecated("use dom.EndOfStreamError instead", "2.0.0")
   type EndOfStreamError = dom.EndOfStreamError
 
-  @deprecated("use dom.ReadyState instead", "2.0.0")
-  type ReadyState = dom.ReadyState
+  @deprecated("use dom.MediaSourceReadyState instead", "2.0.0")
+  type ReadyState = dom.MediaSourceReadyState
 
   @deprecated("use dom.AudioTrack instead", "2.0.0")
   type AudioTrack = dom.AudioTrack
diff --git a/dom/src/main/scala/org/scalajs/dom/webgl/package.scala b/dom/src/main/scala/org/scalajs/dom/webgl/package.scala
