Use opaque types for Scala 3

Author: armanbilge

src/main/scala/org/scalajs/dom/ClientType.scala renamed to src/main/scala-2/org/scalajs/dom/ClientType.scala

@@ -0,0 +1,15 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type ClientType = String
+
+object ClientType {
+  val window: ClientType = "window"
+
+  val worker: ClientType = "worker"
+
+  val sharedworker: ClientType = "sharedworker"
+
+  val all: ClientType = "all"
+}

src/main/scala/org/scalajs/dom/FrameType.scala renamed to src/main/scala-2/org/scalajs/dom/FrameType.scala

@@ -0,0 +1,23 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type FrameType = String
+
+/** part of ServiceWorker
+  * [[https://slightlyoff.github.io/ServiceWorker/spec/service_worker_1/#client-frametype ¶4.2.2 frameType]] of
+  * serviceWorker spec
+  */
+object FrameType {
+
+  /** The window client's global object's browsing context is an auxiliary browsing context. */
+  val auxiliary: FrameType = "auxiliary"
+
+  /** The window client's global object's browsing context is a top-level browsing context. */
+  val `top-level` = "top-level"
+
+  /** The window client's global object's browsing context is a nested browsing context. */
+  val nested: FrameType = "nested"
+
+  val none: FrameType = "none"
+}

src/main/scala/org/scalajs/dom/IDBCursorDirection.scala renamed to src/main/scala-2/org/scalajs/dom/IDBCursorDirection.scala

@@ -0,0 +1,34 @@
+/** All documentation for facades is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API
+  * and available under the Creative Commons Attribution-ShareAlike v2.5 or later.
+  * http://creativecommons.org/licenses/by-sa/2.5/
+  *
+  * Everything else is under the MIT License http://opensource.org/licenses/MIT
+  */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type IDBCursorDirection = js.Any
+
+object IDBCursorDirection {
+
+  /** The cursor shows all records, including duplicates. It starts at the upper bound of the key range and moves
+    * downwards (monotonically decreasing in the order of keys).
+    */
+  @inline def prev: IDBCursorDirection = "prev"
+
+  /** The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first
+    * one iterated is retrieved. It starts at the upper bound of the key range and moves downwards.
+    */
+  @inline def prevunique: IDBCursorDirection = "prevunique"
+
+  /** The cursor shows all records, including duplicates. It starts at the lower bound of the key range and moves
+    * upwards (monotonically increasing in the order of keys).
+    */
+  @inline def next: IDBCursorDirection = "next"
+
+  /** The cursor shows all records, excluding duplicates. If multiple records exist with the same key, only the first
+    * one iterated is retrieved. It starts at the lower bound of the key range and moves upwards.
+    */
+  @inline def nextunique: IDBCursorDirection = "nextunique"
+}

src/main/scala/org/scalajs/dom/IDBTransactionDurability.scala renamed to src/main/scala-2/org/scalajs/dom/IDBTransactionDurability.scala

@@ -0,0 +1,17 @@
+/** All documentation for facades is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API
+  * and available under the Creative Commons Attribution-ShareAlike v2.5 or later.
+  * http://creativecommons.org/licenses/by-sa/2.5/
+  *
+  * Everything else is under the MIT License http://opensource.org/licenses/MIT
+  */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type IDBTransactionDurability = String
+
+object IDBTransactionDurability {
+  @inline def default: IDBTransactionDurability = "default"
+  @inline def strict: IDBTransactionDurability = "strict"
+  @inline def relaxed: IDBTransactionDurability = "relaxed"
+}

src/main/scala/org/scalajs/dom/IDBTransactionMode.scala renamed to src/main/scala-2/org/scalajs/dom/IDBTransactionMode.scala

@@ -0,0 +1,29 @@
+/** All documentation for facades is thanks to Mozilla Contributors at https://developer.mozilla.org/en-US/docs/Web/API
+  * and available under the Creative Commons Attribution-ShareAlike v2.5 or later.
+  * http://creativecommons.org/licenses/by-sa/2.5/
+  *
+  * Everything else is under the MIT License http://opensource.org/licenses/MIT
+  */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** IndexedDB transaction mode Provides constants for IDB Transaction modes These constants have been removed from
+  * browser support and replaced by String values
+  */
+opaque type IDBTransactionMode = String
+
+object IDBTransactionMode {
+
+  /** Allows data to be read but not changed. It is the default transaction mode. */
+  @inline def readonly: IDBTransactionMode = "readonly"
+
+  /** Allows any operation to be performed, including ones that delete and create object stores and indexes. This mode
+    * is for updating the version number of transactions that were started using the setVersion() method of IDBDatabase
+    * objects. Transactions of this mode cannot run concurrently with other transactions.
+    */
+  @inline def versionchange: IDBTransactionMode = "versionchange"
+
+  /** Allows reading and writing of data in existing data stores to be changed. */
+  @inline def readwrite: IDBTransactionMode = "readwrite"
+}

src/main/scala/org/scalajs/dom/KeyFormat.scala renamed to src/main/scala-2/org/scalajs/dom/KeyFormat.scala

@@ -0,0 +1,21 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[http://www.w3.org/TR/WebCryptoAPI/#dfn-KeyFormat ¶14.2 Data Types]] in W3C spec */
+opaque type KeyFormat = String
+
+object KeyFormat {
+
+  /** An unformatted sequence of bytes. Intended for secret keys. */
+  val raw: KeyFormat = "raw"
+
+  /** The DER encoding of the PrivateKeyInfo structure from RFC 5208. */
+  val pkcs8: KeyFormat = "pkcs8"
+
+  /** The DER encoding of the SubjectPublicKeyInfo structure from RFC 5280. */
+  val spki: KeyFormat = "spki"
+
+  /** The key is a JsonWebKey dictionary encoded as a JavaScript object */
+  val jwk: KeyFormat = "jwk"
+}

src/main/scala/org/scalajs/dom/KeyType.scala renamed to src/main/scala-2/org/scalajs/dom/KeyType.scala

@@ -0,0 +1,12 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[http://www.w3.org/TR/WebCryptoAPI/#cryptokey-interface ¶13 CryptoKey interface]] in W3C doc */
+opaque type KeyType = String
+
+object KeyType {
+  val public: KeyType = "public"
+  val `private`: KeyType = "private"
+  val secret: KeyType = "secret"
+}

src/main/scala/org/scalajs/dom/KeyUsage.scala renamed to src/main/scala-2/org/scalajs/dom/KeyUsage.scala

@@ -0,0 +1,17 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** See [[http://www.w3.org/TR/WebCryptoAPI/#cryptokey-interface ¶ 13. CryptoKey Interface]] of w3c spec */
+opaque type KeyUsage = String
+
+object KeyUsage {
+  val encrypt: KeyUsage = "encrypt"
+  val decrypt: KeyUsage = "decrypt"
+  val sign: KeyUsage = "sign"
+  val verify: KeyUsage = "verify"
+  val deriveKey: KeyUsage = "deriveKey"
+  val deriveBits: KeyUsage = "deriveBits"
+  val wrapKey: KeyUsage = "wrapKey"
+  val unwrapKey: KeyUsage = "unwrapKey"
+}

src/main/scala/org/scalajs/dom/MIMEType.scala renamed to src/main/scala-2/org/scalajs/dom/MIMEType.scala

@@ -0,0 +1,15 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type MIMEType = String
+
+object MIMEType {
+  val `text/html` = "text/html"
+  val `text/xml` = "text/xml"
+  val `application/xml` = "application/xml"
+
+  val `application/xhtml+xml` =
+    "application/xhtml+xml"
+  val `image/svg+xml` = "image/svg+xml"
+}

src/main/scala/org/scalajs/dom/MediaDeviceKind.scala renamed to src/main/scala-2/org/scalajs/dom/MediaDeviceKind.scala

@@ -0,0 +1,19 @@
+/** https://www.w3.org/TR/2016/CR-mediacapture-streams-20160519/ */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[https://www.w3.org/TR/2016/CR-mediacapture-streams-20160519/#idl-def-MediaDeviceKind]] in W3C spec */
+opaque type MediaDeviceKind = String
+
+object MediaDeviceKind {
+
+  /** Represents an audio input device; for example a microphone. */
+  val audioinput: MediaDeviceKind = "audioinput"
+
+  /** Represents an audio output device; for example a pair of headphones. */
+  val audiooutput: MediaDeviceKind = "audiooutput"
+
+  /** Represents a video input device; for example a webcam. */
+  val videoinput: MediaDeviceKind = "videoinput"
+}

src/main/scala/org/scalajs/dom/MediaStreamTrackState.scala renamed to src/main/scala-2/org/scalajs/dom/MediaStreamTrackState.scala

@@ -0,0 +1,23 @@
+/** https://www.w3.org/TR/2016/CR-mediacapture-streams-20160519/ */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[https://www.w3.org/TR/2013/WD-mediacapture-streams-20130903/#widl-MediaStream-onended]] in W3C spec */
+opaque type MediaStreamTrackState = String
+
+object MediaStreamTrackState {
+
+  /** The track is active (the track's underlying media source is making a best-effort attempt to provide data in real
+    * time). The output of a track in the live state can be switched on and off with the enabled attribute.
+    */
+  val live: MediaStreamTrackState = "live"
+
+  /** The track has ended (the track's underlying media source is no longer providing data, and will never provide more
+    * data for this track). Once a track enters this state, it never exits it.
+    *
+    * For example, a video track in a MediaStream ends if the user unplugs the USB web camera that acts as the track's
+    * media source.
+    */
+  val ended: MediaStreamTrackState = "ended"
+}

src/main/scala/org/scalajs/dom/PermissionName.scala renamed to src/main/scala-2/org/scalajs/dom/PermissionName.scala

@@ -0,0 +1,15 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type PermissionName = String
+
+object PermissionName {
+  val geolocation: PermissionName = "geolocation"
+  val midi: PermissionName = "midi"
+  val notifications: PermissionName = "notifications"
+  val push: PermissionName = "push"
+
+  val `persistent-storage` =
+    "persistent-storage"
+}

src/main/scala/org/scalajs/dom/PermissionState.scala renamed to src/main/scala-2/org/scalajs/dom/PermissionState.scala

@@ -0,0 +1,11 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+opaque type PermissionState = String
+
+object PermissionState {
+  val granted: PermissionState = "granted"
+  val denied: PermissionState = "denied"
+  val prompt: PermissionState = "prompt"
+}

src/main/scala/org/scalajs/dom/PushEncryptionKeyName.scala renamed to src/main/scala-2/org/scalajs/dom/PushEncryptionKeyName.scala

@@ -0,0 +1,22 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** This represents a JavaScript enumeration representing the various keys you an request from a [[PushSubscription]] as
+  * described here: [[http://www.w3.org/TR/push-api/#idl-def-PushEncryptionKeyName]]
+  */
+opaque type PushEncryptionKeyName = String
+
+/** Static definitions for [[PushEncryptionKeyName]] */
+object PushEncryptionKeyName {
+
+  /** used to retrieve the P-256 ECDH Diffie-Hellman public key described here:
+    * [[https://tools.ietf.org/html/draft-ietf-webpush-encryption-01]]
+    */
+  val p256dh: PushEncryptionKeyName = "p256dh"
+
+  /** used to retrieve the authentication secret described here:
+    * [[https://tools.ietf.org/html/draft-ietf-webpush-encryption-01]]
+    */
+  val auth: PushEncryptionKeyName = "auth"
+}

src/main/scala/org/scalajs/dom/PushPermissionState.scala renamed to src/main/scala-2/org/scalajs/dom/PushPermissionState.scala

@@ -0,0 +1,21 @@
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** This represents a JavaScript enumeration describing the state of permissions for pushing described here:
+  * [[http://www.w3.org/TR/push-api/#idl-def-PushPermissionState]]
+  */
+opaque type PushPermissionState = String
+
+/** Static definitions for [[PushPermissionState]] */
+object PushPermissionState {
+
+  /** The webapp has permission to use the Push API. */
+  val granted: PushPermissionState = "granted"
+
+  /** The webapp has been denied permission to use the Push API. */
+  val denied: PushPermissionState = "denied"
+
+  /** The webapp needs to ask for permission in order to use the Push API. */
+  val prompt: PushPermissionState = "prompt"
+}

src/main/scala/org/scalajs/dom/RTCBundlePolicy.scala renamed to src/main/scala-2/org/scalajs/dom/RTCBundlePolicy.scala

@@ -0,0 +1,25 @@
+/** http://www.w3.org/TR/2015/WD-webrtc-20150210/ */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[https://www.w3.org/TR/2015/WD-webrtc-20150210/#idl-def-RTCBundlePolicy]] in W3C spec */
+opaque type RTCBundlePolicy = String
+
+object RTCBundlePolicy {
+
+  /** Gather ICE candidates for each media type in use (audio, video, and data). If the remote endpoint is not
+    * BUNDLE-aware, negotiate only one audio and video track on separate transports.
+    */
+  val balanced: RTCBundlePolicy = "balanced"
+
+  /** Gather ICE candidates for each track. If the remote endpoint is not BUNDLE-aware, negotiate all media tracks on
+    * separate transports.
+    */
+  val `max-compat` = "max-compat"
+
+  /** Gather ICE candidates for only one track. If the remote endpoint is not BUNDLE-aware, negotiate only one media
+    * track.
+    */
+  val `max-bundle` = "max-bundle"
+}

src/main/scala/org/scalajs/dom/RTCDataChannelState.scala renamed to src/main/scala-2/org/scalajs/dom/RTCDataChannelState.scala

@@ -0,0 +1,26 @@
+/** http://www.w3.org/TR/2015/WD-webrtc-20150210/ */
+package org.scalajs.dom
+
+import scala.scalajs.js
+
+/** see [[https://www.w3.org/TR/2015/WD-webrtc-20150210/#idl-def-RTCDataChannelState]] in W3C spec */
+opaque type RTCDataChannelState = String
+
+object RTCDataChannelState {
+
+  /** The user agent is attempting to establish the underlying data transport. This is the initial state of a
+    * RTCDataChannel object created with createDataChannel().
+    */
+  val connecting: RTCDataChannelState = "connecting"
+
+  /** The underlying data transport is established and communication is possible. This is the initial state of a
+    * RTCDataChannel object dispatched as a part of a RTCDataChannelEvent.
+    */
+  val open: RTCDataChannelState = "open"
+
+  /** The procedure to close down the underlying data transport has started. */
+  val closing: RTCDataChannelState = "closing"
+
+  /** The underlying data transport has been closed or could not be established. */
+  val closed: RTCDataChannelState = "closed"
+}