Merge pull request #458 from sjrd/cleanups

Cleanups, part 1

Author: japgolly

api-reports/2_12.txt

@@ -1,5 +1,6 @@
 package example
 
+import scala.scalajs.js
 import scala.scalajs.js.annotation._
 
 import org.scalajs.dom
@@ -125,21 +126,25 @@ object EventHandler{
   }
 }
 
-@JSExportTopLevel("ExampleXMLHttpRequest")
-object XMLHttpRequest{
+@JSExportTopLevel("ExampleFetch")
+object Fetch {
   @JSExport
   def main(pre: html.Pre) = {
-    val xhr = new dom.XMLHttpRequest()
-    xhr.open("GET",
+    import scala.concurrent
+                .ExecutionContext
+                .Implicits
+                .global
+    import js.Thenable.Implicits._
+    val url =
       "https://www.boredapi.com/api/activity"
-    )
-    xhr.onload = { (e: dom.Event) =>
-      if (xhr.status == 200) {
-        pre.textContent =
-          xhr.responseText
-      }
+    val responseText = for {
+      response <- dom.fetch(url)
+      text <- response.text()
+    } yield {
+      text
     }
-    xhr.send()
+    for (text <- responseText)
+      pre.textContent = text
   }
 }
 
@@ -162,20 +167,3 @@ object Websocket {
     }
   }
 }
-
-@JSExportTopLevel("ExampleAjaxExtension")
-object AjaxExtension {
-  @JSExport
-  def main(pre: html.Pre) = {
-    import dom.ext.Ajax
-    import scala.concurrent
-                .ExecutionContext
-                .Implicits
-                .global
-    val url =
-      "https://www.boredapi.com/api/activity"
-    Ajax.get(url).foreach { case xhr =>
-      pre.textContent = xhr.responseText
-    }
-  }
-}

api-reports/2_13.txt

@@ -115,9 +115,9 @@
         autorun=true
       )
 
-    @sect{dom.XMLHttpRequest}
+    @sect{dom.Fetch}
       @pair(
-        "XMLHttpRequest",
+        "Fetch",
         Seq(
           pre("output")
         )
@@ -145,38 +145,19 @@
     @li
       Deprecated properties/methods/types will not be present.
     @li
-      IE-only, Chrome-only, FF-only, and in general browser-specific attributes will only be found under the @hl.scala{experimental} package.
+      IE-only, Chrome-only, FF-only, and in general browser-specific attributes will typically not be present.
     @li
       The name of a Scala type should map directly to the name of the corresponding Javascript type.
     @li
       Any type which is a Javascript type (e.g. you can @hl.scala{instanceof} in javascript) should be a Scala @hl.scala{class}; any other interface which isn't a Javascript type should be a @hl.scala{trait}.
     @li
       Read-only members should be @hl.scala{def}, and not-directly-instantiable classes should have @hl.scala{private} constructors.
 
-  @sect{Extensions}
-
-    @p
-      Apart from @hl.scala{Color}, Scala-js-dom contains some useful helpers and implicit classes in @hl.scala{org.scalajs.dom.ext} that serve no purpose other than to make your use of the DOM more pleasant.
-
-    @p
-      Examples include the @hl.scala{Ajax.get} and @hl.scala{Ajax.post} methods which let you avoid messing with @hl.scala{dom.XMLHttpRequest} directly, or @hl.scala{KeyCodes} which provides a nice list of the keycodes that result from pressing various keys on the keyboard.
-    @pair(
-      "AjaxExtension",
-      Seq(
-        pre("output")
-      )
-    )
-
-    @p
-      See also @a("roll", href:="https://github.com/lihaoyi/roll") (@a("live demo", href:="http://lihaoyi.github.io/roll/")) and @a("scala-js-games", href:="https://github.com/lihaoyi/scala-js-games") for an example of its use. @a("Scala-js-fiddle", href:="http://www.scala-js-fiddle.com/") also contains a pile of @a("fun examples", href:="(http://www.scala-js-fiddle.com/gist/9405209/Oscilloscope.scala") that demonstrate its usage. Pull requests/forks are welcome!
-
   @sect{Contributing}
     @p
-      Scala-js-dom is a work in progress. The current code base is a hodgepodge of auto-generated/scraped/hand-tweaked code, and is full of rough edges. If you see something that you think can be improved, feel free to send a pull request. These could include:
+      The DOM API is always evolving, and scala-js-dom is a hodgepodge of auto-generated/scraped/hand-tweaked code full of rough edges. If you see something that you think can be improved, feel free to send a pull request. These could include:
     @ul
       @li
         Improved doc-comments; who doesn't love better docs?
       @li
         Missing methods/properties/classes; send the PR adding it in including it together with a link to an authoritative source (e.g. MDN) and it should get merged.
-      @li
-        Additional extensions (in @hl.scala{org.scalajs.dom.ext}). These currently represent an arbitrary collection of helpers that have been needed so far. If there's some implicit that you find you need and you think other people will to, send a pull request and we can talk about it.

example/src/main/scala/example/Example.scala

@@ -1,9 +1,8 @@
-package org.scalajs.dom.ext
+package org.scalajs.dom
 
-import org.scalajs.dom._
 import scala.collection.mutable
 
-class NamedNodeMapMap private[ext] (namedNodeMap: NamedNodeMap)
+private[dom] class NamedNodeMapMap(namedNodeMap: NamedNodeMap)
     extends mutable.Map[String, Attr] {
   self =>
 

readme/Index.scalatex

@@ -1,9 +1,8 @@
-package org.scalajs.dom.ext
+package org.scalajs.dom
 
-import org.scalajs.dom._
 import scala.collection.mutable
 
-class NamedNodeMapMap private[ext] (namedNodeMap: NamedNodeMap)
+private[dom] class NamedNodeMapMap(namedNodeMap: NamedNodeMap)
     extends mutable.Map[String, Attr] {
   self =>
 

src/main/scala-new-collections/org/scalajs/dom/ext/NamedNodeMapMap.scala renamed to src/main/scala-new-collections/org/scalajs/dom/NamedNodeMapMap.scala

@@ -1,6 +1,5 @@
-package org.scalajs.dom.experimental
+package org.scalajs.dom
 
-import org.scalajs.dom.raw.EventTarget
 import scala.scalajs.js
 import scala.scalajs.js.annotation.JSGlobal
 

src/main/scala-old-collections/org/scalajs/dom/ext/NamedNodeMapMap.scala renamed to src/main/scala-old-collections/org/scalajs/dom/NamedNodeMapMap.scala

@@ -7,7 +7,7 @@
  * Everything else is under the MIT License
  * http://opensource.org/licenses/MIT
  */
-package org.scalajs.dom.raw
+package org.scalajs.dom
 
 import org.scalajs.dom.experimental.mediastream.MediaStream
 import scala.scalajs.js

src/main/scala/org/scalajs/dom/experimental/AbortController.scala renamed to src/main/scala/org/scalajs/dom/AbortController.scala

@@ -7,7 +7,7 @@
  * Everything else is under the MIT License
  * http://opensource.org/licenses/MIT
  */
-package org.scalajs.dom.raw
+package org.scalajs.dom
 
 import scala.scalajs.js
 import scala.scalajs.js.annotation._
@@ -501,7 +501,9 @@ class CSSPageRule extends CSSRule {
  */
 @js.native
 @JSGlobal
-class CSSRuleList extends DOMList[CSSRule]
+class CSSRuleList private[this] () extends DOMList[CSSRule] {
+  def item(index: Int): CSSRule = js.native
+}
 
 /**
  * The CSSKeyframesRule interface describes an object representing a complete set

src/main/scala/org/scalajs/dom/raw/Audio.scala renamed to src/main/scala/org/scalajs/dom/Audio.scala

@@ -0,0 +1,36 @@
+package org.scalajs.dom
+
+import org.scalajs.dom
+
+/**
+ * Short aliases of all the dom.CSSThing classes
+ */
+@deprecated("directly use the dom.CSS* types and values instead", "2.0.0")
+object DeprecatedCSSAliases {
+  @deprecated("use dom.CSS instead", "2.0.0")
+  @inline def CSS = dom.CSS
+  @deprecated("use dom.FontFaceRule instead", "2.0.0")
+  type FontFaceRule = CSSFontFaceRule
+  @deprecated("use dom.ImportRule instead", "2.0.0")
+  type ImportRule = CSSImportRule
+  @deprecated("use dom.KeyframeRule instead", "2.0.0")
+  type KeyframeRule = CSSKeyframeRule
+  @deprecated("use dom.MediaRule instead", "2.0.0")
+  type MediaRule = CSSMediaRule
+  @deprecated("use dom.NamespaceRule instead", "2.0.0")
+  type NamespaceRule = CSSNamespaceRule
+  @deprecated("use dom.PageRule instead", "2.0.0")
+  type PageRule = CSSPageRule
+  @deprecated("use dom.Rule instead", "2.0.0")
+  type Rule = CSSRule
+  @deprecated("use dom.Rule instead", "2.0.0")
+  @inline def Rule = CSSRule
+  @deprecated("use dom.RuleList instead", "2.0.0")
+  type RuleList = CSSRuleList
+  @deprecated("use dom.StyleDeclaration instead", "2.0.0")
+  type StyleDeclaration = CSSStyleDeclaration
+  @deprecated("use dom.StyleSheet instead", "2.0.0")
+  type StyleSheet = CSSStyleSheet
+  @deprecated("use dom.StyleRule instead", "2.0.0")
+  type StyleRule = CSSStyleRule
+}