Skip to content

Commit bd14f33

Browse files
FabioPinheirozetashiftarmanbilge
committed
Add support for Web NFC API
Apply suggestions from code review Co-authored-by: zetashift <rskaraya@gmail.com> Co-authored-by: Arman Bilge <armanbilge@gmail.com>
1 parent aa82b8f commit bd14f33

File tree

9 files changed

+316
-0
lines changed

9 files changed

+316
-0
lines changed

‎api-reports/2_12.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16464,6 +16464,56 @@ MutationRecord[JT] def previousSibling: Node
1646416464
MutationRecord[JT] def removedNodes: NodeList[Node]
1646516465
MutationRecord[JT] def target: Node
1646616466
MutationRecord[JT] def `type`: String
16467+
NDEFMessage[JC] var records: FrozenArray[NDEFRecord]
16468+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16469+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16470+
NDEFReader[JC] def dispatchEvent(evt: Event): Boolean
16471+
NDEFReader[JC] var onreading: js.Function1[NDEFReadingEvent, Any]
16472+
NDEFReader[JC] var onreadingerror: js.Function1[Event, Any]
16473+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16474+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16475+
NDEFReader[JC] def scan(options: NDEFScanOptions?): js.Promise[Unit]
16476+
NDEFReader[JC] def write(message: String): js.Promise[Unit]
16477+
NDEFReader[JC] def write(message: String, options: NDEFWriteOptions): js.Promise[Unit]
16478+
NDEFReader[JC] def write(message: js.Array[NDEFRecord]): js.Promise[Unit]
16479+
NDEFReader[JC] def write(message: js.Array[NDEFRecord], options: NDEFWriteOptions): js.Promise[Unit]
16480+
NDEFReader[JC] def write(message: js.typedarray.ArrayBuffer): js.Promise[Unit]
16481+
NDEFReader[JC] def write(message: js.typedarray.ArrayBuffer, options: NDEFWriteOptions): js.Promise[Unit]
16482+
NDEFReader[JC] def write(message: js.typedarray.DataView): js.Promise[Unit]
16483+
NDEFReader[JC] def write(message: js.typedarray.DataView, options: NDEFWriteOptions): js.Promise[Unit]
16484+
NDEFReader[JC] def write(message: js.typedarray.TypedArray[_, _], options: NDEFWriteOptions?): js.Promise[Unit]
16485+
NDEFReadingEvent[JT] def bubbles: Boolean
16486+
NDEFReadingEvent[JT] def cancelBubble: Boolean
16487+
NDEFReadingEvent[JT] def cancelable: Boolean
16488+
NDEFReadingEvent[JT] def composed: Boolean
16489+
NDEFReadingEvent[JT] def currentTarget: EventTarget
16490+
NDEFReadingEvent[JT] def defaultPrevented: Boolean
16491+
NDEFReadingEvent[JT] def eventPhase: Int
16492+
NDEFReadingEvent[JT] def isTrusted: Boolean
16493+
NDEFReadingEvent[JT] var message: NDEFMessage
16494+
NDEFReadingEvent[JT] def preventDefault(): Unit
16495+
NDEFReadingEvent[JT] var serialNumber: String
16496+
NDEFReadingEvent[JT] def stopImmediatePropagation(): Unit
16497+
NDEFReadingEvent[JT] def stopPropagation(): Unit
16498+
NDEFReadingEvent[JT] def target: EventTarget
16499+
NDEFReadingEvent[JT] def timeStamp: Double
16500+
NDEFReadingEvent[JT] def `type`: String
16501+
NDEFRecord[JC] var data: js.typedarray.DataView
16502+
NDEFRecord[JC] var encoding: js.UndefOr[String]
16503+
NDEFRecord[JC] var id: js.UndefOr[String]
16504+
NDEFRecord[JC] var lang: js.UndefOr[String]
16505+
NDEFRecord[JC] var mediaType: js.UndefOr[String]
16506+
NDEFRecord[JC] var recordType: String
16507+
NDEFRecord[JC] def toRecords(): js.Array[NDEFRecord]
16508+
NDEFRecordInit[JT] var data: js.UndefOr[String | js.typedarray.DataView | js.typedarray.ArrayBuffer | js.typedarray.TypedArray[_, _] | js.typedarray.DataView | js.Array[NDEFRecord]]
16509+
NDEFRecordInit[JT] var encoding: js.UndefOr[String]
16510+
NDEFRecordInit[JT] var id: js.UndefOr[String]
16511+
NDEFRecordInit[JT] var lang: js.UndefOr[String]
16512+
NDEFRecordInit[JT] var mediaType: js.UndefOr[String]
16513+
NDEFRecordInit[JT] var recordType: js.UndefOr[String]
16514+
NDEFScanOptions[JT] var signal: js.UndefOr[AbortSignal]
16515+
NDEFWriteOptions[JT] var overwrite: js.UndefOr[Boolean]
16516+
NDEFWriteOptions[JT] var signal: js.UndefOr[AbortSignal]
1646716517
NamedNodeMap[JC] @scala.scalajs.js.annotation.JSBracketAccess def apply(index: Int): Attr
1646816518
NamedNodeMap[JC] def getNamedItem(name: String): Attr
1646916519
NamedNodeMap[JC] def getNamedItemNS(namespaceURI: String, localName: String): Attr

‎api-reports/2_13.txt

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16464,6 +16464,56 @@ MutationRecord[JT] def previousSibling: Node
1646416464
MutationRecord[JT] def removedNodes: NodeList[Node]
1646516465
MutationRecord[JT] def target: Node
1646616466
MutationRecord[JT] def `type`: String
16467+
NDEFMessage[JC] var records: FrozenArray[NDEFRecord]
16468+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16469+
NDEFReader[JC] def addEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16470+
NDEFReader[JC] def dispatchEvent(evt: Event): Boolean
16471+
NDEFReader[JC] var onreading: js.Function1[NDEFReadingEvent, Any]
16472+
NDEFReader[JC] var onreadingerror: js.Function1[Event, Any]
16473+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], options: EventListenerOptions): Unit
16474+
NDEFReader[JC] def removeEventListener[T <: Event](`type`: String, listener: js.Function1[T, _], useCapture: Boolean?): Unit
16475+
NDEFReader[JC] def scan(options: NDEFScanOptions?): js.Promise[Unit]
16476+
NDEFReader[JC] def write(message: String): js.Promise[Unit]
16477+
NDEFReader[JC] def write(message: String, options: NDEFWriteOptions): js.Promise[Unit]
16478+
NDEFReader[JC] def write(message: js.Array[NDEFRecord]): js.Promise[Unit]
16479+
NDEFReader[JC] def write(message: js.Array[NDEFRecord], options: NDEFWriteOptions): js.Promise[Unit]
16480+
NDEFReader[JC] def write(message: js.typedarray.ArrayBuffer): js.Promise[Unit]
16481+
NDEFReader[JC] def write(message: js.typedarray.ArrayBuffer, options: NDEFWriteOptions): js.Promise[Unit]
16482+
NDEFReader[JC] def write(message: js.typedarray.DataView): js.Promise[Unit]
16483+
NDEFReader[JC] def write(message: js.typedarray.DataView, options: NDEFWriteOptions): js.Promise[Unit]
16484+
NDEFReader[JC] def write(message: js.typedarray.TypedArray[_, _], options: NDEFWriteOptions?): js.Promise[Unit]
16485+
NDEFReadingEvent[JT] def bubbles: Boolean
16486+
NDEFReadingEvent[JT] def cancelBubble: Boolean
16487+
NDEFReadingEvent[JT] def cancelable: Boolean
16488+
NDEFReadingEvent[JT] def composed: Boolean
16489+
NDEFReadingEvent[JT] def currentTarget: EventTarget
16490+
NDEFReadingEvent[JT] def defaultPrevented: Boolean
16491+
NDEFReadingEvent[JT] def eventPhase: Int
16492+
NDEFReadingEvent[JT] def isTrusted: Boolean
16493+
NDEFReadingEvent[JT] var message: NDEFMessage
16494+
NDEFReadingEvent[JT] def preventDefault(): Unit
16495+
NDEFReadingEvent[JT] var serialNumber: String
16496+
NDEFReadingEvent[JT] def stopImmediatePropagation(): Unit
16497+
NDEFReadingEvent[JT] def stopPropagation(): Unit
16498+
NDEFReadingEvent[JT] def target: EventTarget
16499+
NDEFReadingEvent[JT] def timeStamp: Double
16500+
NDEFReadingEvent[JT] def `type`: String
16501+
NDEFRecord[JC] var data: js.typedarray.DataView
16502+
NDEFRecord[JC] var encoding: js.UndefOr[String]
16503+
NDEFRecord[JC] var id: js.UndefOr[String]
16504+
NDEFRecord[JC] var lang: js.UndefOr[String]
16505+
NDEFRecord[JC] var mediaType: js.UndefOr[String]
16506+
NDEFRecord[JC] var recordType: String
16507+
NDEFRecord[JC] def toRecords(): js.Array[NDEFRecord]
16508+
NDEFRecordInit[JT] var data: js.UndefOr[String | js.typedarray.DataView | js.typedarray.ArrayBuffer | js.typedarray.TypedArray[_, _] | js.typedarray.DataView | js.Array[NDEFRecord]]
16509+
NDEFRecordInit[JT] var encoding: js.UndefOr[String]
16510+
NDEFRecordInit[JT] var id: js.UndefOr[String]
16511+
NDEFRecordInit[JT] var lang: js.UndefOr[String]
16512+
NDEFRecordInit[JT] var mediaType: js.UndefOr[String]
16513+
NDEFRecordInit[JT] var recordType: js.UndefOr[String]
16514+
NDEFScanOptions[JT] var signal: js.UndefOr[AbortSignal]
16515+
NDEFWriteOptions[JT] var overwrite: js.UndefOr[Boolean]
16516+
NDEFWriteOptions[JT] var signal: js.UndefOr[AbortSignal]
1646716517
NamedNodeMap[JC] @scala.scalajs.js.annotation.JSBracketAccess def apply(index: Int): Attr
1646816518
NamedNodeMap[JC] def getNamedItem(name: String): Attr
1646916519
NamedNodeMap[JC] def getNamedItemNS(namespaceURI: String, localName: String): Attr

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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(recordsAgr: js.Array[NDEFRecordInit]) extends js.Object {
16+
17+
/** Returns the list of NDEF records contained in the message. */
18+
var records: FrozenArray[NDEFRecord] = js.native
19+
}

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

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

‎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: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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(options: NDEFRecordInit) 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+
31+
/** Returns the encoding of a textual payload, or null otherwise. */
32+
var encoding: js.UndefOr[String] = js.native
33+
34+
/** Returns the language of a textual payload, or null if one was not supplied. */
35+
var lang: js.UndefOr[String] = js.native
36+
37+
/** Converts [[NDEFRecord.data]] to a sequence of records. This allows parsing the payloads of record types which may
38+
* contain nested records, such as smart poster and external type records.
39+
*/
40+
def toRecords(): js.Array[NDEFRecord] = js.native
41+
}

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

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
package org.scalajs.dom
2+
3+
import scala.scalajs.js
4+
import scala.scalajs.js.|
5+
6+
/** @see
7+
* https://developer.mozilla.org/en-US/docs/Web/API/NDEFMessage/NDEFMessage
8+
* @see
9+
* https://developer.mozilla.org/en-US/docs/Web/API/NDEFRecord/NDEFRecord
10+
*/
11+
trait NDEFRecordInit extends js.Object {
12+
13+
/** Contains the data to be transmitted. It can be a string object or literal, an ArrayBuffer, a TypedArray, a
14+
* DataView, or an array of nested records.
15+
*/
16+
var data: js.UndefOr[
17+
String |
18+
js.typedarray.DataView |
19+
js.typedarray.ArrayBuffer |
20+
js.typedarray.TypedArray[_, _] |
21+
js.typedarray.DataView |
22+
js.Array[NDEFRecord]
23+
] = js.undefined
24+
25+
/** A string specifying the record's encoding. */
26+
var encoding: js.UndefOr[String] = js.undefined
27+
28+
/** A developer-defined identifier for the record. */
29+
var id: js.UndefOr[String] = js.undefined
30+
31+
/** A valid language tag according to [RFC 5646: Tags for Identifying Languages (also known as BCP
32+
* 47)](https://datatracker.ietf.org/doc/html/rfc5646).
33+
*/
34+
var lang: js.UndefOr[String] = js.undefined
35+
36+
/** A valid MIME type. */
37+
var mediaType: js.UndefOr[String] = js.undefined
38+
39+
/** A string indicating the type of data stored in data.
40+
*
41+
* It must be one of the following values:
42+
* - "absolute-url" - An absolute URL to the data.
43+
* - "empty" - An empty NDEFRecord.
44+
* - "mime" - A valid MIME type.
45+
* - "smart-poster" - A smart poster as defined by the NDEF-SMARTPOSTER specification.
46+
* - "text" - Text as defined by the NDEF-TEXT specification.
47+
* - "unknown" - The record type is not known.
48+
* - "URL" - A URL as defined by the NDEF-URI specification.
49+
*/
50+
var recordType: js.UndefOr[String] = js.undefined
51+
}

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

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

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

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

0 commit comments

Comments
 (0)