Skip to content

Commit 0072cb8

Browse files
FabioPinheiroFabioPinheiro
committed
Add support for Web NFC API
1 parent 9d7e1b7 commit 0072cb8

File tree

8 files changed

+226
-0
lines changed

8 files changed

+226
-0
lines changed

‎api-reports/2_12.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16426,6 +16426,42 @@ MutationRecord[JT] def previousSibling: Node
1642616426
MutationRecord[JT] def removedNodes: NodeList[Node]
1642716427
MutationRecord[JT] def target: Node
1642816428
MutationRecord[JT] def `type`: String
16429+
NDEFMessage[JC]
16430+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16431+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16432+
NDEFReader[JC] def dispatchEvent(evt: Event): Boolean
16433+
NDEFReader[JC] var onreading: js.Function1[NDEFReadingEvent, Any]
16434+
NDEFReader[JC] var onreadingerror: js.Function1[Event, Any]
16435+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16436+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16437+
NDEFReader[JC] def scan(options: NDEFScanOptions?): js.Promise[js.Any]
16438+
NDEFReader[JC] def write(message: String | js.typedarray.ArrayBuffer | js.typedarray.DataView | js.Array[NDEFRecord], options: NDEFWriteOptions?): js.Promise[js.Any]
16439+
NDEFReadingEvent[JT] def bubbles: Boolean
16440+
NDEFReadingEvent[JT] def cancelBubble: Boolean
16441+
NDEFReadingEvent[JT] def cancelable: Boolean
16442+
NDEFReadingEvent[JT] def composed: Boolean
16443+
NDEFReadingEvent[JT] def currentTarget: EventTarget
16444+
NDEFReadingEvent[JT] def defaultPrevented: Boolean
16445+
NDEFReadingEvent[JT] def eventPhase: Int
16446+
NDEFReadingEvent[JT] def isTrusted: Boolean
16447+
NDEFReadingEvent[JT] var message: NDEFMessage
16448+
NDEFReadingEvent[JT] def preventDefault(): Unit
16449+
NDEFReadingEvent[JT] var serialNumber: String
16450+
NDEFReadingEvent[JT] def stopImmediatePropagation(): Unit
16451+
NDEFReadingEvent[JT] def stopPropagation(): Unit
16452+
NDEFReadingEvent[JT] def target: EventTarget
16453+
NDEFReadingEvent[JT] def timeStamp: Double
16454+
NDEFReadingEvent[JT] def `type`: String
16455+
NDEFRecord[JC] var data: js.typedarray.DataView
16456+
NDEFRecord[JC] var encoding: js.UndefOr[String]
16457+
NDEFRecord[JC] var id: js.UndefOr[String]
16458+
NDEFRecord[JC] var lang: js.UndefOr[String]
16459+
NDEFRecord[JC] var mediaType: js.UndefOr[String]
16460+
NDEFRecord[JC] var recordType: String
16461+
NDEFRecord[JC] def toRecords(): js.Array[NDEFRecord]
16462+
NDEFScanOptions[JT] def signal: js.UndefOr[AbortSignal]
16463+
NDEFWriteOptions[JT] def overwrite: Boolean
16464+
NDEFWriteOptions[JT] def signal: js.UndefOr[AbortSignal]
1642916465
NamedNodeMap[JC] @scala.scalajs.js.annotation.JSBracketAccess def apply(index: Int): Attr
1643016466
NamedNodeMap[JC] def getNamedItem(name: String): Attr
1643116467
NamedNodeMap[JC] def getNamedItemNS(namespaceURI: String, localName: String): Attr

‎api-reports/2_13.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16426,6 +16426,42 @@ MutationRecord[JT] def previousSibling: Node
1642616426
MutationRecord[JT] def removedNodes: NodeList[Node]
1642716427
MutationRecord[JT] def target: Node
1642816428
MutationRecord[JT] def `type`: String
16429+
NDEFMessage[JC]
16430+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16431+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16432+
NDEFReader[JC] def dispatchEvent(evt: Event): Boolean
16433+
NDEFReader[JC] var onreading: js.Function1[NDEFReadingEvent, Any]
16434+
NDEFReader[JC] var onreadingerror: js.Function1[Event, Any]
16435+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16436+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16437+
NDEFReader[JC] def scan(options: NDEFScanOptions?): js.Promise[js.Any]
16438+
NDEFReader[JC] def write(message: String | js.typedarray.ArrayBuffer | js.typedarray.DataView | js.Array[NDEFRecord], options: NDEFWriteOptions?): js.Promise[js.Any]
16439+
NDEFReadingEvent[JT] def bubbles: Boolean
16440+
NDEFReadingEvent[JT] def cancelBubble: Boolean
16441+
NDEFReadingEvent[JT] def cancelable: Boolean
16442+
NDEFReadingEvent[JT] def composed: Boolean
16443+
NDEFReadingEvent[JT] def currentTarget: EventTarget
16444+
NDEFReadingEvent[JT] def defaultPrevented: Boolean
16445+
NDEFReadingEvent[JT] def eventPhase: Int
16446+
NDEFReadingEvent[JT] def isTrusted: Boolean
16447+
NDEFReadingEvent[JT] var message: NDEFMessage
16448+
NDEFReadingEvent[JT] def preventDefault(): Unit
16449+
NDEFReadingEvent[JT] var serialNumber: String
16450+
NDEFReadingEvent[JT] def stopImmediatePropagation(): Unit
16451+
NDEFReadingEvent[JT] def stopPropagation(): Unit
16452+
NDEFReadingEvent[JT] def target: EventTarget
16453+
NDEFReadingEvent[JT] def timeStamp: Double
16454+
NDEFReadingEvent[JT] def `type`: String
16455+
NDEFRecord[JC] var data: js.typedarray.DataView
16456+
NDEFRecord[JC] var encoding: js.UndefOr[String]
16457+
NDEFRecord[JC] var id: js.UndefOr[String]
16458+
NDEFRecord[JC] var lang: js.UndefOr[String]
16459+
NDEFRecord[JC] var mediaType: js.UndefOr[String]
16460+
NDEFRecord[JC] var recordType: String
16461+
NDEFRecord[JC] def toRecords(): js.Array[NDEFRecord]
16462+
NDEFScanOptions[JT] def signal: js.UndefOr[AbortSignal]
16463+
NDEFWriteOptions[JT] def overwrite: Boolean
16464+
NDEFWriteOptions[JT] def signal: js.UndefOr[AbortSignal]
1642916465
NamedNodeMap[JC] @scala.scalajs.js.annotation.JSBracketAccess def apply(index: Int): Attr
1643016466
NamedNodeMap[JC] def getNamedItem(name: String): Attr
1643116467
NamedNodeMap[JC] def getNamedItemNS(namespaceURI: String, localName: String): Attr

‎dom/src/main/scala/org/scalajs/dom/NDEFMessage.scala

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
import scala.scalajs.js.annotation.JSGlobal
5+
6+
/** The [[NDEFMessage]] interface of the Web NFC API represents the content of an NDEF message that has been read from
7+
* or could be written to an NFC tag. An instance is acquired by calling the NDEFMessage() constructor or from the
8+
* NDEFReadingEvent.message property, which is passed to the reading event.
9+
*
10+
* @param records\
11+
* The records property of NDEFMessage interface represents a list of NDEFRecords present in the NDEF message.
12+
*/
13+
@js.native
14+
@JSGlobal
15+
class NDEFMessage(var records: js.Array[NDEFRecord] = js.native) extends js.Object

‎dom/src/main/scala/org/scalajs/dom/NDEFReader.scala

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
import scala.scalajs.js.annotation.JSGlobal
5+
import scala.scalajs.js.|
6+
7+
/** The [[NDEFReader]] interface of the Web NFC API (https://developer.mozilla.org/en-US/docs/Web/API/Web_NFC_API) is
8+
* used to read from and write data to compatible NFC devices, e.g. NFC tags supporting NDEF, when these devices are
9+
* within the reader's magnetic induction field.
10+
*/
11+
@JSGlobal("NDEFReader")
12+
@js.native
13+
class NDEFReader() extends EventTarget {
14+
15+
/** Activates a reading device and returns a Promise that either resolves when an NFC tag read operation is scheduled
16+
* or rejects if a hardware or permission error is encountered. This method triggers a permission prompt if the "nfc"
17+
* permission has not been previously granted.
18+
*
19+
* @return
20+
* a Promise that resolves immediately after scheduling read operations for the NFC adapter.
21+
*/
22+
def scan(options: NDEFScanOptions = js.native): js.Promise[js.Any] = js.native
23+
24+
/** Attempts to write an NDEF message to a tag and returns a Promise that either resolves when a message has been
25+
* written to the tag or rejects if a hardware or permission error is encountered. This method triggers a permission
26+
* prompt if the "nfc" permission has not been previously granted.
27+
*
28+
* @param message
29+
* The message to be written, either a string object or literal, an ArrayBuffer, a TypedArray, a DataView, or an
30+
* array of records. A record has the following members:
31+
* @param options
32+
* An object with the following properties:
33+
*
34+
* @return
35+
* a Promise that either resolves when a message has been written to the tag or rejects if a hardware or permission
36+
* error is encountered.
37+
*/
38+
def write(
39+
message: String | js.typedarray.ArrayBuffer | /* js.typedarray.TypedArray[NDEFRecord, ???] */ js.typedarray.DataView |
40+
js.Array[NDEFRecord], options: NDEFWriteOptions = js.native
41+
): js.Promise[js.Any] = js.native
42+
43+
/** The reading event of the NDEFReader interface is fired whenever a new reading is available from compatible NFC
44+
* devices (e.g. NFC tags supporting NDEF) when these devices are within the reader's magnetic induction field.
45+
*/
46+
var onreading: js.Function1[NDEFReadingEvent, Any] = js.native
47+
48+
/** The readingerror event of the NDEFReader interface is fired whenever an error occurs during reading of NFC tags,
49+
* e.g. when tags leave the reader's magnetic induction field.
50+
*/
51+
var onreadingerror: js.Function1[Event, Any] = js.native
52+
}

‎dom/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
/** The NDEFReadingEvent interface of the Web NFC API represents events dispatched on new NFC readings obtained by
6+
* NDEFReader.
7+
*
8+
* @see
9+
* https://developer.mozilla.org/en-US/docs/Web/API/NDEFReadingEvent
10+
*/
11+
@js.native
12+
trait NDEFReadingEvent extends Event {
13+
14+
/** Returns an NDEFMessage object containing the received message. */
15+
var message: NDEFMessage = js.native
16+
17+
/** Returns the serial number of the device, which is used for anti-collision and identification, or an empty string
18+
* if no serial number is available.
19+
*/
20+
var serialNumber: String = js.native
21+
22+
}

‎dom/src/main/scala/org/scalajs/dom/NDEFRecord.scala

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
import scala.scalajs.js.annotation.JSGlobal
5+
6+
/** The [[NDEFRecord]] interface of the Web NFC API provides data that can be read from, or written to, compatible NFC
7+
* devices, e.g. NFC tags supporting NDEF.
8+
*/
9+
@js.native
10+
@JSGlobal
11+
class NDEFRecord extends js.Object {
12+
13+
/** Returns the record type of the record. Records must have either a standardized well-known type name such as
14+
* "empty", "text", "url", "smart-poster", "absolute-url", "mime", or "unknown" or else an external type name, which
15+
* consists of a domain name and custom type name separated by a colon (":").
16+
*/
17+
var recordType: String = js.native
18+
19+
/** Returns the MIME type of the record. This value will be null if recordType is not equal to "mime". */
20+
var mediaType: js.UndefOr[String] = js.native
21+
22+
/** Returns the record identifier, which is an absolute or relative URL used to identify the record.
23+
*
24+
* Note: The uniqueness of the identifier is enforced only by the generator of the record.
25+
*/
26+
var id: js.UndefOr[String] = js.native
27+
28+
/** Returns a DataView containing the raw bytes of the record's payload. */
29+
var data: js.typedarray.DataView = js.native
30+
// var data: DataView = js.native
31+
32+
/** Returns the encoding of a textual payload, or null otherwise. */
33+
var encoding: js.UndefOr[String] = js.native
34+
35+
/** Returns the language of a textual payload, or null if one was not supplied. */
36+
var lang: js.UndefOr[String] = js.native
37+
38+
/** Converts [[NDEFRecord.data]] to a sequence of records. This allows parsing the payloads of record types which may
39+
* contain nested records, such as smart poster and external type records.
40+
*/
41+
def toRecords(): js.Array[NDEFRecord] = js.native
42+
}

‎dom/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
trait NDEFScanOptions extends js.Object {
7+
8+
/** An AbortSignal that allows the current write operation to be canceled. */
9+
def `signal`: js.UndefOr[AbortSignal] = js.native
10+
}

‎dom/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
5+
@js.native
6+
trait NDEFWriteOptions extends js.Object {
7+
8+
/** A boolean value specifying whether or not existing records should be overwritten, if such exists. */
9+
def `overwrite`: Boolean = js.native
10+
11+
/** An AbortSignal that allows the current write operation to be canceled. */
12+
def `signal`: js.UndefOr[AbortSignal] = js.native
13+
}

0 commit comments

Comments
 (0)