From 07fd6ce5ed5449068ca093969006906a5a96a39c Mon Sep 17 00:00:00 2001 From: FabioPinheiro Date: Fri, 29 Sep 2023 21:35:59 +0100 Subject: [PATCH] Reflect changes in scala-js/scala-js-dom#806 after review --- .../scala/org/scalajs/dom/NDEFMessage.scala | 11 +++++++---- .../scala/org/scalajs/dom/NDEFReader.scala | 7 ++++++- .../org/scalajs/dom/NDEFReadingEvent.scala | 11 +++++++---- .../scala/org/scalajs/dom/NDEFRecord.scala | 19 +++++++++++-------- .../org/scalajs/dom/NDEFScanOptions.scala | 4 ++-- .../org/scalajs/dom/NDEFWriteOptions.scala | 14 ++++++++++---- 6 files changed, 43 insertions(+), 23 deletions(-) diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFMessage.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFMessage.scala index 1f3e2a8d..b2add223 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFMessage.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFMessage.scala @@ -7,13 +7,16 @@ import scala.scalajs.js.annotation.JSGlobal * or could be written to an NFC tag. An instance is acquired by calling the NDEFMessage() constructor or from the * NDEFReadingEvent.message property, which is passed to the reading event. * - * @param records - * The records property of NDEFMessage interface represents a list of NDEFRecords present in the NDEF message. + * @see + * https://w3c.github.io/web-nfc/#the-ndefmessage-interface + * + * @param messageInit + * property of NDEFMessage interface represents a list of NDEFRecords present in the NDEF message. */ @js.native @JSGlobal -class NDEFMessage extends js.Object { +class NDEFMessage(messageInit: js.Array[NDEFRecordInit]) extends js.Object { /** Returns the list of NDEF records contained in the message. */ - var records: FrozenArray[NDEFRecord] = js.native + def records: FrozenArray[NDEFRecord] = js.native } diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFReader.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFReader.scala index 99bccdf5..d13ae5f2 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFReader.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFReader.scala @@ -6,6 +6,9 @@ import scala.scalajs.js.annotation.JSGlobal /** The [[NDEFReader]] interface of the Web NFC API (https://developer.mozilla.org/en-US/docs/Web/API/Web_NFC_API) is * used to read from and write data to compatible NFC devices, e.g. NFC tags supporting NDEF, when these devices are * within the reader's magnetic induction field. + * + * @see + * https://w3c.github.io/web-nfc/#the-ndefreader-object */ @JSGlobal("NDEFReader") @js.native @@ -36,7 +39,9 @@ class NDEFReader() extends EventTarget { */ def write(message: String, options: NDEFWriteOptions): js.Promise[Unit] = js.native def write(message: js.typedarray.ArrayBuffer, options: NDEFWriteOptions): js.Promise[Unit] = js.native - // def write(message:js.typedarray.TypedArray[NDEFRecord, ???] , options: NDEFWriteOptions = js.native): js.Promise[Unit] = js.native + + def write(message: js.typedarray.TypedArray[_, _], + options: NDEFWriteOptions = js.native): js.Promise[Unit] = js.native def write(message: js.typedarray.DataView, options: NDEFWriteOptions): js.Promise[Unit] = js.native def write(message: js.Array[NDEFRecord], options: NDEFWriteOptions): js.Promise[Unit] = js.native diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala index 3bc402a9..bb2aaa28 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFReadingEvent.scala @@ -1,22 +1,25 @@ package org.scalajs.dom import scala.scalajs.js +import scala.scalajs.js.annotation.JSGlobal /** The NDEFReadingEvent interface of the Web NFC API represents events dispatched on new NFC readings obtained by * NDEFReader. * * @see * https://developer.mozilla.org/en-US/docs/Web/API/NDEFReadingEvent + * @see + * https://w3c.github.io/web-nfc/#the-ndefreader-object */ @js.native -trait NDEFReadingEvent extends Event { +@JSGlobal +class NDEFReadingEvent(typeArg: String, init: NDEFReadingEventInit) extends Event(typeArg, init) { /** Returns an NDEFMessage object containing the received message. */ - var message: NDEFMessage = js.native + def message: NDEFMessage = js.native /** Returns the serial number of the device, which is used for anti-collision and identification, or an empty string * if no serial number is available. */ - var serialNumber: String = js.native - + def serialNumber: String = js.native } diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFRecord.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFRecord.scala index 63702642..0e0aead4 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFRecord.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFRecord.scala @@ -5,37 +5,40 @@ import scala.scalajs.js.annotation.JSGlobal /** The [[NDEFRecord]] interface of the Web NFC API provides data that can be read from, or written to, compatible NFC * devices, e.g. NFC tags supporting NDEF. + * + * @see + * https://w3c.github.io/web-nfc/#the-ndefrecord-interface */ @js.native @JSGlobal -class NDEFRecord extends js.Object { +class NDEFRecord(init: NDEFRecordInit) extends js.Object { /** Returns the record type of the record. Records must have either a standardized well-known type name such as * "empty", "text", "url", "smart-poster", "absolute-url", "mime", or "unknown" or else an external type name, which * consists of a domain name and custom type name separated by a colon (":"). */ - var recordType: String = js.native + def recordType: String = js.native /** Returns the MIME type of the record. This value will be null if recordType is not equal to "mime". */ - var mediaType: js.UndefOr[String] = js.native + def mediaType: js.UndefOr[String] = js.native /** Returns the record identifier, which is an absolute or relative URL used to identify the record. * * Note: The uniqueness of the identifier is enforced only by the generator of the record. */ - var id: js.UndefOr[String] = js.native + def id: js.UndefOr[String] = js.native /** Returns a DataView containing the raw bytes of the record's payload. */ - var data: js.typedarray.DataView = js.native + def data: js.typedarray.DataView = js.native /** Returns the encoding of a textual payload, or null otherwise. */ - var encoding: js.UndefOr[String] = js.native + def encoding: js.UndefOr[String] = js.native /** Returns the language of a textual payload, or null if one was not supplied. */ - var lang: js.UndefOr[String] = js.native + def lang: js.UndefOr[String] = js.native /** Converts [[NDEFRecord.data]] to a sequence of records. This allows parsing the payloads of record types which may * contain nested records, such as smart poster and external type records. */ - def toRecords(): js.Array[NDEFRecord] = js.native + def toRecords(): js.UndefOr[js.Array[NDEFRecord]] = js.native } diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala index cb19fdbc..2b2946b7 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFScanOptions.scala @@ -2,9 +2,9 @@ package org.scalajs.dom import scala.scalajs.js -@js.native +/** @see https://w3c.github.io/web-nfc/#the-ndefscanoptions-dictionary */ trait NDEFScanOptions extends js.Object { /** An AbortSignal that allows the current write operation to be canceled. */ - def `signal`: js.UndefOr[AbortSignal] = js.native + var `signal`: js.UndefOr[AbortSignal] = js.undefined } diff --git a/webapp/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala b/webapp/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala index a39612e5..c7836b55 100644 --- a/webapp/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala +++ b/webapp/src/main/scala/org/scalajs/dom/NDEFWriteOptions.scala @@ -2,12 +2,18 @@ package org.scalajs.dom import scala.scalajs.js -@js.native +/** @see + * https://w3c.github.io/web-nfc/#the-ndefwriteoptions-dictionary + * @see + * https://developer.mozilla.org/en-US/docs/Web/API/NDEFReader/write + */ trait NDEFWriteOptions extends js.Object { - /** A boolean value specifying whether or not existing records should be overwritten, if such exists. */ - def `overwrite`: Boolean = js.native + /** A boolean value specifying whether or not existing records should be overwritten, if such exists. Default is true + */ + var `overwrite`: js.UndefOr[Boolean] = js.undefined /** An AbortSignal that allows the current write operation to be canceled. */ - def `signal`: js.UndefOr[AbortSignal] = js.native + var `signal`: js.UndefOr[AbortSignal] = js.undefined + }