snapshot of https://github.com/tauri-apps/plugins-workspace.git (v2, 2026-09-23; blobs > 131072B omitted)
Some checks failed
integration tests / run-integration-tests (windows-latest) (push) Has been cancelled
Test Rust / test (push) Has been cancelled
test plugins e2e (mobile) / ios (push) Has been cancelled
test plugins e2e / test (map[name:Windows os:windows-latest]) (push) Has been cancelled
test plugins e2e / test (map[name:macOS os:macos-latest]) (push) Has been cancelled
integration tests / run-integration-tests (macos-latest) (push) Has been cancelled
version or publish / version-or-publish (push) Failing after 0s
integration tests / run-integration-tests (ubuntu-22.04) (push) Failing after 0s
Lint JavaScript / eslint (push) Failing after 0s
Sync / sync-to-mirrors (push) Failing after 0s
test plugins e2e (mobile) / android (push) Failing after 0s
test plugins e2e / test (map[name:Linux os:ubuntu-latest]) (push) Failing after 0s
Test Rust / changes (push) Failing after 0s
Lint Rust / changes (push) Failing after 0s
Lint Rust / clippy (push) Has been skipped
Audit Rust / audit-rust (push) Failing after 1s
Audit JavaScript / audit-js (push) Failing after 1s
Some checks failed
integration tests / run-integration-tests (windows-latest) (push) Has been cancelled
Test Rust / test (push) Has been cancelled
test plugins e2e (mobile) / ios (push) Has been cancelled
test plugins e2e / test (map[name:Windows os:windows-latest]) (push) Has been cancelled
test plugins e2e / test (map[name:macOS os:macos-latest]) (push) Has been cancelled
integration tests / run-integration-tests (macos-latest) (push) Has been cancelled
version or publish / version-or-publish (push) Failing after 0s
integration tests / run-integration-tests (ubuntu-22.04) (push) Failing after 0s
Lint JavaScript / eslint (push) Failing after 0s
Sync / sync-to-mirrors (push) Failing after 0s
test plugins e2e (mobile) / android (push) Failing after 0s
test plugins e2e / test (map[name:Linux os:ubuntu-latest]) (push) Failing after 0s
Test Rust / changes (push) Failing after 0s
Lint Rust / changes (push) Failing after 0s
Lint Rust / clippy (push) Has been skipped
Audit Rust / audit-rust (push) Failing after 1s
Audit JavaScript / audit-js (push) Failing after 1s
This commit is contained in:
upstream-mirror
116
plugins/nfc/CHANGELOG.md
Normal file
116
plugins/nfc/CHANGELOG.md
Normal file
@@ -0,0 +1,116 @@
|
||||
# Changelog
|
||||
|
||||
## [2.3.6]
|
||||
|
||||
- [`db9c5998`](https://github.com/tauri-apps/plugins-workspace/commit/db9c5998feff9384f9cbbefcbe0d45937c00a1fc) ([#3531](https://github.com/tauri-apps/plugins-workspace/pull/3531) by [@Legend-Master](https://github.com/tauri-apps/plugins-workspace/../../Legend-Master)) Fix missing `consumer-rules.pro` on Gradle v9.
|
||||
- [`52672616`](https://github.com/tauri-apps/plugins-workspace/commit/526726162f8ddddf9469797436123704a261df87) ([#3419](https://github.com/tauri-apps/plugins-workspace/pull/3419) by [@pascalauroboa](https://github.com/tauri-apps/plugins-workspace/../../pascalauroboa)) Expect a `NFCTag` as input and return a `ScanResponse` in the `scan` function.
|
||||
|
||||
## \[2.3.5]
|
||||
|
||||
- [`ab037b70`](https://github.com/tauri-apps/plugins-workspace/commit/ab037b70d6fb54f1ad07d5fe21c41bd1997b34dd) ([#3339](https://github.com/tauri-apps/plugins-workspace/pull/3339) by [@crazy-genius](https://github.com/tauri-apps/plugins-workspace/../../crazy-genius)) Fixed syntax error in kotlin files potentially causing issues when trying to write to tags when no prior session existed.
|
||||
|
||||
## \[2.3.4]
|
||||
|
||||
- [`b4348cee`](https://github.com/tauri-apps/plugins-workspace/commit/b4348cee926ee3d1db151bc831cdb9049bee717f) ([#3101](https://github.com/tauri-apps/plugins-workspace/pull/3101) by [@bclarke123](https://github.com/tauri-apps/plugins-workspace/../../bclarke123)) Update return value of `isAvailable` to match TypeScript function signature
|
||||
|
||||
## \[2.3.3]
|
||||
|
||||
- [`93426f85`](https://github.com/tauri-apps/plugins-workspace/commit/93426f85120f49beb9f40222bff45185a32d54a9) Fixed an issue that caused docs.rs builds to fail. No user facing changes.
|
||||
|
||||
## \[2.3.2]
|
||||
|
||||
- [`6c9b61fb`](https://github.com/tauri-apps/plugins-workspace/commit/6c9b61fb658145d13893626112fc489f7458aa17) ([#3039](https://github.com/tauri-apps/plugins-workspace/pull/3039) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) On Android, updated compileSdk to 36.
|
||||
|
||||
## \[2.3.1]
|
||||
|
||||
- [`fe23a5e0`](https://github.com/tauri-apps/plugins-workspace/commit/fe23a5e01399a6ad61426bf8a94a6bb97227cf88) ([#2885](https://github.com/tauri-apps/plugins-workspace/pull/2885) by [@zaphim12](https://github.com/tauri-apps/plugins-workspace/../../zaphim12)) On iOS, the reader session will now get closed properly on errors, preventing dangling invalid sessions that could prevent subsequent write attempts.
|
||||
|
||||
## \[2.3.0]
|
||||
|
||||
- [`f209b2f2`](https://github.com/tauri-apps/plugins-workspace/commit/f209b2f23cb29133c97ad5961fb46ef794dbe063) ([#2804](https://github.com/tauri-apps/plugins-workspace/pull/2804) by [@renovate](https://github.com/tauri-apps/plugins-workspace/../../renovate)) Updated tauri to 2.6
|
||||
|
||||
## \[2.2.1]
|
||||
|
||||
- [`f634e524`](https://github.com/tauri-apps/plugins-workspace/commit/f634e5248ebe428f8305a59f74c13fc15147fb8e) This is an "empty" release to update the plugins' source files on crates.io and docs.rs. This should fix docs.rs build failures for projects using tauri plugins as dependencies.
|
||||
|
||||
## \[2.2.0]
|
||||
|
||||
- [`3a79266b`](https://github.com/tauri-apps/plugins-workspace/commit/3a79266b8cf96a55b1ae6339d725567d45a44b1d) ([#2173](https://github.com/tauri-apps/plugins-workspace/pull/2173) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) Bumped all plugins to `v2.2.0`. From now, the versions for the Rust and JavaScript packages of each plugin will be in sync with each other.
|
||||
|
||||
## \[2.0.1]
|
||||
|
||||
- [`a1a82208`](https://github.com/tauri-apps/plugins-workspace/commit/a1a82208ed4ab87f83310be0dc95428aec9ab241) ([#1873](https://github.com/tauri-apps/plugins-workspace/pull/1873) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Downgrade MSRV to 1.77.2 to support Windows 7.
|
||||
|
||||
## \[2.0.0]
|
||||
|
||||
- [`e2c4dfb6`](https://github.com/tauri-apps/plugins-workspace/commit/e2c4dfb6af43e5dd8d9ceba232c315f5febd55c1) Update to tauri v2 stable release.
|
||||
|
||||
## \[2.0.0-rc.1]
|
||||
|
||||
- [`e2e97db5`](https://github.com/tauri-apps/plugins-workspace/commit/e2e97db51983267f5be84d4f6f0278d58834d1f5) ([#1701](https://github.com/tauri-apps/plugins-workspace/pull/1701) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Update to tauri 2.0.0-rc.8
|
||||
|
||||
## \[2.0.0-rc.2]
|
||||
|
||||
- [`b9147758`](https://github.com/tauri-apps/plugins-workspace/commit/b914775898c2bee7ceb20bd17ee595005cd17a64) ([#1679](https://github.com/tauri-apps/plugins-workspace/pull/1679) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Explicitly set a minimum macOS version for the Swift package.
|
||||
|
||||
## \[2.0.0-rc.1]
|
||||
|
||||
### changes
|
||||
|
||||
- [`6b079cfd`](https://github.com/tauri-apps/plugins-workspace/commit/6b079cfdd107c94abc2c7300f6af00bac3ff4040) ([#1649](https://github.com/tauri-apps/plugins-workspace/pull/1649) by [@ahqsoftwares](https://github.com/tauri-apps/plugins-workspace/../../ahqsoftwares)) Remove targetSdk from build.kts files as it is deprecated and will be removed from DSL v9.0
|
||||
|
||||
## \[2.0.0-rc.0]
|
||||
|
||||
- [`9887d1`](https://github.com/tauri-apps/plugins-workspace/commit/9887d14bd0e971c4c0f5c1188fc4005d3fc2e29e) Update to tauri RC.
|
||||
|
||||
## \[2.0.0-beta.8]
|
||||
|
||||
- [`99d6ac0f`](https://github.com/tauri-apps/plugins-workspace/commit/99d6ac0f9506a6a4a1aa59c728157190a7441af6) ([#1606](https://github.com/tauri-apps/plugins-workspace/pull/1606) by [@FabianLars](https://github.com/tauri-apps/plugins-workspace/../../FabianLars)) The JS packages now specify the *minimum* `@tauri-apps/api` version instead of a single exact version.
|
||||
- [`6de87966`](https://github.com/tauri-apps/plugins-workspace/commit/6de87966ecc00ad9d91c25be452f1f46bd2b7e1f) ([#1597](https://github.com/tauri-apps/plugins-workspace/pull/1597) by [@Legend-Master](https://github.com/tauri-apps/plugins-workspace/../../Legend-Master)) Update to tauri beta.25.
|
||||
|
||||
## \[2.0.0-beta.7]
|
||||
|
||||
- [`22a17980`](https://github.com/tauri-apps/plugins-workspace/commit/22a17980ff4f6f8c40adb1b8f4ffc6dae2fe7e30) ([#1537](https://github.com/tauri-apps/plugins-workspace/pull/1537) by [@lucasfernog](https://github.com/tauri-apps/plugins-workspace/../../lucasfernog)) Update to tauri beta.24.
|
||||
|
||||
## \[2.0.0-beta.6]
|
||||
|
||||
- [`76daee7a`](https://github.com/tauri-apps/plugins-workspace/commit/76daee7aafece34de3092c86e531cf9eb1138989) ([#1512](https://github.com/tauri-apps/plugins-workspace/pull/1512) by [@renovate](https://github.com/tauri-apps/plugins-workspace/../../renovate)) Update to tauri beta.23.
|
||||
|
||||
## \[2.0.0-beta.5]
|
||||
|
||||
- [`9013854f`](https://github.com/tauri-apps/plugins-workspace/commit/9013854f42a49a230b9dbb9d02774765528a923f)([#1382](https://github.com/tauri-apps/plugins-workspace/pull/1382)) Update to tauri beta.22.
|
||||
|
||||
## \[2.0.0-beta.4]
|
||||
|
||||
- [`430bd6f4`](https://github.com/tauri-apps/plugins-workspace/commit/430bd6f4f379bee5d232ae6b098ae131db7f178a)([#1363](https://github.com/tauri-apps/plugins-workspace/pull/1363)) Update to tauri beta.20.
|
||||
|
||||
## \[2.0.0-beta.3]
|
||||
|
||||
- [`bd1ed590`](https://github.com/tauri-apps/plugins-workspace/commit/bd1ed5903ffcce5500310dac1e59e8c67674ef1e)([#1237](https://github.com/tauri-apps/plugins-workspace/pull/1237)) Update to tauri beta.17.
|
||||
|
||||
## \[2.0.0-beta.3]
|
||||
|
||||
- [`a04ea2f`](https://github.com/tauri-apps/plugins-workspace/commit/a04ea2f38294d5a3987578283badc8eec87a7752)([#1071](https://github.com/tauri-apps/plugins-workspace/pull/1071)) The global API script is now only added to the binary when the `withGlobalTauri` config is true.
|
||||
|
||||
## \[2.0.0-beta.2]
|
||||
|
||||
- [`99bea25`](https://github.com/tauri-apps/plugins-workspace/commit/99bea2559c2c0648c2519c50a18cd124dacef57b)([#1005](https://github.com/tauri-apps/plugins-workspace/pull/1005)) Update to tauri beta.8.
|
||||
|
||||
## \[2.0.0-beta.1]
|
||||
|
||||
- [`569defb`](https://github.com/tauri-apps/plugins-workspace/commit/569defbe9492e38938554bb7bdc1be9151456d21) Update to tauri beta.4.
|
||||
|
||||
## \[2.0.0-beta.0]
|
||||
|
||||
- [`d198c01`](https://github.com/tauri-apps/plugins-workspace/commit/d198c014863ee260cb0de88a14b7fc4356ef7474)([#862](https://github.com/tauri-apps/plugins-workspace/pull/862)) Update to tauri beta.
|
||||
- [`d198c01`](https://github.com/tauri-apps/plugins-workspace/commit/d198c014863ee260cb0de88a14b7fc4356ef7474)([#862](https://github.com/tauri-apps/plugins-workspace/pull/862)) Add permissions.
|
||||
|
||||
## \[2.0.0-alpha.0]
|
||||
|
||||
- [`fe79adb`](https://github.com/tauri-apps/plugins-workspace/commit/fe79adb5c7febd0e912efb5581264d671709fbb0)([#830](https://github.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
commit/fe79adb5c7febd0e912efb5581264d671709fbb0)([#830](https://github.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
30]\(https://github.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
commit/fe79adb5c7febd0e912efb5581264d671709fbb0)([#830](https://github.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
.
|
||||
commit/fe79adb5c7febd0e912efb5581264d671709fbb0)([#830](https://github.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
ithub.com/tauri-apps/plugins-workspace/pull/830)) Initial release.
|
||||
31
plugins/nfc/Cargo.toml
Normal file
31
plugins/nfc/Cargo.toml
Normal file
@@ -0,0 +1,31 @@
|
||||
[package]
|
||||
name = "tauri-plugin-nfc"
|
||||
version = "2.3.6"
|
||||
description = "Read and write NFC tags on Android and iOS."
|
||||
edition = { workspace = true }
|
||||
authors = { workspace = true }
|
||||
license = { workspace = true }
|
||||
repository = { workspace = true }
|
||||
links = "tauri-plugin-nfc"
|
||||
exclude = ["/guest-js", "/package.json", "/rollup.config.js", "/tsconfig.json"]
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
targets = ["x86_64-linux-android"]
|
||||
|
||||
[package.metadata.platforms.support]
|
||||
windows = { level = "none", notes = "" }
|
||||
linux = { level = "none", notes = "" }
|
||||
macos = { level = "none", notes = "" }
|
||||
android = { level = "full", notes = "" }
|
||||
ios = { level = "full", notes = "" }
|
||||
|
||||
[build-dependencies]
|
||||
tauri-plugin = { workspace = true, features = ["build"] }
|
||||
|
||||
[dependencies]
|
||||
serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
tauri = { workspace = true }
|
||||
log = { workspace = true }
|
||||
thiserror = { workspace = true }
|
||||
serde_repr = "0.1"
|
||||
20
plugins/nfc/LICENSE.spdx
Normal file
20
plugins/nfc/LICENSE.spdx
Normal file
@@ -0,0 +1,20 @@
|
||||
SPDXVersion: SPDX-2.1
|
||||
DataLicense: CC0-1.0
|
||||
PackageName: tauri
|
||||
DataFormat: SPDXRef-1
|
||||
PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
|
||||
PackageHomePage: https://tauri.app
|
||||
PackageLicenseDeclared: Apache-2.0
|
||||
PackageLicenseDeclared: MIT
|
||||
PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
|
||||
PackageSummary: <text>Tauri is a rust project that enables developers to make secure
|
||||
and small desktop applications using a web frontend.
|
||||
</text>
|
||||
PackageComment: <text>The package includes the following libraries; see
|
||||
Relationship information.
|
||||
</text>
|
||||
Created: 2019-05-20T09:00:00Z
|
||||
PackageDownloadLocation: git://github.com/tauri-apps/tauri
|
||||
PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
|
||||
PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
|
||||
Creator: Person: Daniel Thompson-Yvetot
|
||||
177
plugins/nfc/LICENSE_APACHE-2.0
Normal file
177
plugins/nfc/LICENSE_APACHE-2.0
Normal file
@@ -0,0 +1,177 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
21
plugins/nfc/LICENSE_MIT
Normal file
21
plugins/nfc/LICENSE_MIT
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 - Present Tauri Apps Contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
112
plugins/nfc/README.md
Normal file
112
plugins/nfc/README.md
Normal file
@@ -0,0 +1,112 @@
|
||||
|
||||
|
||||
Read and write NFC tags on Android and iOS.
|
||||
|
||||
| Platform | Supported |
|
||||
| -------- | --------- |
|
||||
| Linux | x |
|
||||
| Windows | x |
|
||||
| macOS | x |
|
||||
| Android | ✓ |
|
||||
| iOS | ✓ |
|
||||
|
||||
## Install
|
||||
|
||||
_This plugin requires a Rust version of at least **1.65**_
|
||||
|
||||
There are three general methods of installation that we can recommend.
|
||||
|
||||
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
||||
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
||||
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
|
||||
|
||||
Install the Core plugin by adding the following to your `Cargo.toml` file:
|
||||
|
||||
`src-tauri/Cargo.toml`
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
tauri-plugin-nfc = "2.0.0"
|
||||
# alternatively with Git:
|
||||
tauri-plugin-nfc = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
|
||||
```
|
||||
|
||||
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
|
||||
|
||||
<!-- Add the branch for installations using git! -->
|
||||
|
||||
```sh
|
||||
pnpm add @tauri-apps/plugin-nfc
|
||||
# or
|
||||
npm add @tauri-apps/plugin-nfc
|
||||
# or
|
||||
yarn add @tauri-apps/plugin-nfc
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
First you need to register the core plugin with Tauri:
|
||||
|
||||
`src-tauri/src/lib.rs`
|
||||
|
||||
```rust
|
||||
fn main() {
|
||||
tauri::Builder::default()
|
||||
.plugin(tauri_plugin_nfc::init())
|
||||
.run(tauri::generate_context!())
|
||||
.expect("error while running tauri application");
|
||||
}
|
||||
```
|
||||
|
||||
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
||||
|
||||
```javascript
|
||||
import { scan, textRecord, write } from '@tauri-apps/plugin-nfc'
|
||||
await scan({ type: 'tag', keepSessionAlive: true })
|
||||
await write([textRecord('Tauri is awesome!')])
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
||||
|
||||
## Contributed By
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="middle">
|
||||
<a href="https://crabnebula.dev" target="_blank">
|
||||
<img src="contributors/crabnebula.svg" alt="CrabNebula" width="283">
|
||||
</a>
|
||||
</td>
|
||||
<td align="center" valign="middle">
|
||||
<a href="https://impierce.com" target="_blank">
|
||||
<img src="contributors/impierce.svg" alt="Impierce" width="283" height="90">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Partners
|
||||
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="center" valign="middle">
|
||||
<a href="https://crabnebula.dev" target="_blank">
|
||||
<img src="https://github.com/tauri-apps/plugins-workspace/raw/v2/.github/sponsors/crabnebula.svg" alt="CrabNebula" width="283">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).
|
||||
|
||||
## License
|
||||
|
||||
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
||||
|
||||
MIT or MIT/Apache 2.0 where applicable.
|
||||
23
plugins/nfc/SECURITY.md
Normal file
23
plugins/nfc/SECURITY.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# Security Policy
|
||||
|
||||
**Do not report security vulnerabilities through public GitHub issues.**
|
||||
|
||||
**Please use the [Private Vulnerability Disclosure](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability) feature of GitHub.**
|
||||
|
||||
Include as much of the following information:
|
||||
|
||||
- Type of issue (e.g. improper input parsing, privilege escalation, etc.)
|
||||
- The location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Any special configuration required to reproduce the issue
|
||||
- The distribution affected or used to help us with reproduction of the issue
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Ideally a reproduction repository
|
||||
- Impact of the issue, including how an attacker might exploit the issue
|
||||
|
||||
We prefer to receive reports in English.
|
||||
|
||||
## Contact
|
||||
|
||||
Please disclose a vulnerability or security relevant issue here: [https://github.com/tauri-apps/plugins-workspace/security/advisories/new](https://github.com/tauri-apps/plugins-workspace/security/advisories/new).
|
||||
|
||||
Alternatively, you can also contact us by email via [security@tauri.app](mailto:security@tauri.app).
|
||||
2
plugins/nfc/android/.gitignore
vendored
Normal file
2
plugins/nfc/android/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
/build
|
||||
/.tauri
|
||||
36
plugins/nfc/android/build.gradle.kts
Normal file
36
plugins/nfc/android/build.gradle.kts
Normal file
@@ -0,0 +1,36 @@
|
||||
plugins {
|
||||
id("com.android.library")
|
||||
id("org.jetbrains.kotlin.android")
|
||||
}
|
||||
|
||||
android {
|
||||
namespace = "app.tauri.nfc"
|
||||
compileSdk = 36
|
||||
|
||||
defaultConfig {
|
||||
minSdk = 24
|
||||
|
||||
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
|
||||
consumerProguardFiles("consumer-rules.pro")
|
||||
}
|
||||
|
||||
compileOptions {
|
||||
sourceCompatibility = JavaVersion.VERSION_1_8
|
||||
targetCompatibility = JavaVersion.VERSION_1_8
|
||||
}
|
||||
kotlinOptions {
|
||||
jvmTarget = "1.8"
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
|
||||
implementation("androidx.core:core-ktx:1.9.0")
|
||||
implementation("androidx.appcompat:appcompat:1.6.0")
|
||||
implementation("com.google.android.material:material:1.7.0")
|
||||
implementation("com.fasterxml.jackson.core:jackson-databind:2.15.3")
|
||||
testImplementation("junit:junit:4.13.2")
|
||||
androidTestImplementation("androidx.test.ext:junit:1.1.5")
|
||||
androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
|
||||
implementation(project(":tauri-android"))
|
||||
}
|
||||
21
plugins/nfc/android/consumer-rules.pro
Normal file
21
plugins/nfc/android/consumer-rules.pro
Normal file
@@ -0,0 +1,21 @@
|
||||
# Add project specific ProGuard rules here.
|
||||
# You can control the set of applied configuration files using the
|
||||
# proguardFiles setting in build.gradle.
|
||||
#
|
||||
# For more details, see
|
||||
# http://developer.android.com/guide/developing/tools/proguard.html
|
||||
|
||||
# If your project uses WebView with JS, uncomment the following
|
||||
# and specify the fully qualified class name to the JavaScript interface
|
||||
# class:
|
||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
|
||||
# public *;
|
||||
#}
|
||||
|
||||
# Uncomment this to preserve the line number information for
|
||||
# debugging stack traces.
|
||||
#-keepattributes SourceFile,LineNumberTable
|
||||
|
||||
# If you keep the line number information, uncomment this to
|
||||
# hide the original source file name.
|
||||
#-renamesourcefileattribute SourceFile
|
||||
2
plugins/nfc/android/settings.gradle
Normal file
2
plugins/nfc/android/settings.gradle
Normal file
@@ -0,0 +1,2 @@
|
||||
include ':tauri-android'
|
||||
project(':tauri-android').projectDir = new File('./.tauri/tauri-api')
|
||||
@@ -0,0 +1,28 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package app.tauri.nfc
|
||||
|
||||
import androidx.test.platform.app.InstrumentationRegistry
|
||||
import androidx.test.ext.junit.runners.AndroidJUnit4
|
||||
|
||||
import org.junit.Test
|
||||
import org.junit.runner.RunWith
|
||||
|
||||
import org.junit.Assert.*
|
||||
|
||||
/**
|
||||
* Instrumented test, which will execute on an Android device.
|
||||
*
|
||||
* See [testing documentation](http://d.android.com/tools/testing).
|
||||
*/
|
||||
@RunWith(AndroidJUnit4::class)
|
||||
class ExampleInstrumentedTest {
|
||||
@Test
|
||||
fun useAppContext() {
|
||||
// Context of the app under test.
|
||||
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
|
||||
assertEquals("app.tauri.nfc", appContext.packageName)
|
||||
}
|
||||
}
|
||||
4
plugins/nfc/android/src/main/AndroidManifest.xml
Normal file
4
plugins/nfc/android/src/main/AndroidManifest.xml
Normal file
@@ -0,0 +1,4 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
|
||||
<uses-permission android:name="android.permission.NFC" />
|
||||
</manifest>
|
||||
519
plugins/nfc/android/src/main/java/NfcPlugin.kt
Normal file
519
plugins/nfc/android/src/main/java/NfcPlugin.kt
Normal file
@@ -0,0 +1,519 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package app.tauri.nfc
|
||||
|
||||
import android.app.Activity
|
||||
import android.app.PendingIntent
|
||||
import android.content.Intent
|
||||
import android.content.IntentFilter
|
||||
import android.nfc.NdefMessage
|
||||
import android.nfc.NdefRecord
|
||||
import android.nfc.NfcAdapter
|
||||
import android.nfc.Tag
|
||||
import android.nfc.tech.Ndef
|
||||
import android.nfc.tech.NdefFormatable
|
||||
import android.os.Build
|
||||
import android.os.Parcelable
|
||||
import android.os.PatternMatcher
|
||||
import android.webkit.WebView
|
||||
import app.tauri.Logger
|
||||
import app.tauri.annotation.Command
|
||||
import app.tauri.annotation.InvokeArg
|
||||
import app.tauri.annotation.TauriPlugin
|
||||
import app.tauri.plugin.Invoke
|
||||
import app.tauri.plugin.JSArray
|
||||
import app.tauri.plugin.JSObject
|
||||
import app.tauri.plugin.Plugin
|
||||
import com.fasterxml.jackson.annotation.JsonValue
|
||||
import com.fasterxml.jackson.core.JsonParser
|
||||
import com.fasterxml.jackson.databind.DeserializationContext
|
||||
import com.fasterxml.jackson.databind.JsonDeserializer
|
||||
import com.fasterxml.jackson.databind.JsonNode
|
||||
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
|
||||
import org.json.JSONArray
|
||||
import java.io.IOException
|
||||
import kotlin.concurrent.thread
|
||||
|
||||
sealed class NfcAction {
|
||||
object Read : NfcAction()
|
||||
data class Write(val message: NdefMessage) : NfcAction()
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
class UriFilter {
|
||||
var scheme: String? = null
|
||||
var host: String? = null
|
||||
var pathPrefix: String? = null
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
enum class TechKind(@JsonValue val value: String) {
|
||||
IsoDep("IsoDep"),
|
||||
MifareClassic("MifareClassic"),
|
||||
MifareUltralight("MifareUltralight"),
|
||||
Ndef("Ndef"),
|
||||
NdefFormatable("NdefFormatable"),
|
||||
NfcA("NfcA"),
|
||||
NfcB("NfcB"),
|
||||
NfcBarcode("NfcBarcode"),
|
||||
NfcF("NfcF"),
|
||||
NfcV("NfcV");
|
||||
|
||||
fun className(): String {
|
||||
return when (this) {
|
||||
IsoDep -> {
|
||||
android.nfc.tech.IsoDep::class.java.name
|
||||
}
|
||||
MifareClassic -> {
|
||||
android.nfc.tech.MifareClassic::class.java.name
|
||||
}
|
||||
MifareUltralight -> {
|
||||
android.nfc.tech.MifareUltralight::class.java.name
|
||||
}
|
||||
Ndef -> {
|
||||
android.nfc.tech.Ndef::class.java.name
|
||||
}
|
||||
NdefFormatable -> {
|
||||
android.nfc.tech.NdefFormatable::class.java.name
|
||||
}
|
||||
NfcA -> {
|
||||
android.nfc.tech.NfcA::class.java.name
|
||||
}
|
||||
NfcB -> {
|
||||
android.nfc.tech.NfcB::class.java.name
|
||||
}
|
||||
NfcBarcode -> {
|
||||
android.nfc.tech.NfcBarcode::class.java.name
|
||||
}
|
||||
NfcF -> {
|
||||
android.nfc.tech.NfcF::class.java.name
|
||||
}
|
||||
NfcV -> {
|
||||
android.nfc.tech.NfcV::class.java.name
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun addDataFilters(intentFilter: IntentFilter, uri: UriFilter?, mimeType: String?) {
|
||||
uri?.let { it -> {
|
||||
it.scheme?.let {
|
||||
intentFilter.addDataScheme(it)
|
||||
}
|
||||
it.host?.let {
|
||||
intentFilter.addDataAuthority(it, null)
|
||||
}
|
||||
it.pathPrefix?.let {
|
||||
intentFilter.addDataPath(it, PatternMatcher.PATTERN_PREFIX)
|
||||
}
|
||||
}}
|
||||
mimeType?.let {
|
||||
intentFilter.addDataType(it)
|
||||
}
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
@JsonDeserialize(using = ScanKindDeserializer::class)
|
||||
sealed class ScanKind {
|
||||
@JsonDeserialize
|
||||
class Tag: ScanKind() {
|
||||
var mimeType: String? = null
|
||||
var uri: UriFilter? = null
|
||||
}
|
||||
@JsonDeserialize
|
||||
class Ndef: ScanKind() {
|
||||
var mimeType: String? = null
|
||||
var uri: UriFilter? = null
|
||||
var techLists: Array<Array<TechKind>>? = null
|
||||
}
|
||||
|
||||
fun filters(): Array<IntentFilter>? {
|
||||
return when (this) {
|
||||
is Tag -> {
|
||||
val intentFilter = IntentFilter(NfcAdapter.ACTION_TAG_DISCOVERED)
|
||||
addDataFilters(intentFilter, uri, mimeType)
|
||||
arrayOf(intentFilter)
|
||||
}
|
||||
is Ndef -> {
|
||||
val intentFilter = IntentFilter(if (techLists == null) NfcAdapter.ACTION_NDEF_DISCOVERED else NfcAdapter.ACTION_TECH_DISCOVERED)
|
||||
addDataFilters(intentFilter, uri, mimeType)
|
||||
arrayOf(intentFilter)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fun techLists(): Array<Array<String>>? {
|
||||
return when (this) {
|
||||
is Tag -> null
|
||||
is Ndef -> {
|
||||
techLists?.let {
|
||||
val techs = mutableListOf<Array<String>>()
|
||||
for (techList in it) {
|
||||
val list = mutableListOf<String>()
|
||||
for (tech in techList) {
|
||||
list.add(tech.className())
|
||||
}
|
||||
techs.add(list.toTypedArray())
|
||||
}
|
||||
techs.toTypedArray()
|
||||
} ?: run {
|
||||
null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
internal class ScanKindDeserializer: JsonDeserializer<ScanKind>() {
|
||||
override fun deserialize(
|
||||
jsonParser: JsonParser,
|
||||
deserializationContext: DeserializationContext
|
||||
): ScanKind {
|
||||
val node: JsonNode = jsonParser.codec.readTree(jsonParser)
|
||||
node.get("tag")?.let {
|
||||
return jsonParser.codec.treeToValue(it, ScanKind.Tag::class.java)
|
||||
} ?: node.get("ndef")?.let {
|
||||
return jsonParser.codec.treeToValue(it, ScanKind.Ndef::class.java)
|
||||
} ?: run {
|
||||
throw Error("unknown scan kind $node")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
class ScanOptions {
|
||||
lateinit var kind: ScanKind
|
||||
var keepSessionAlive: Boolean = false
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
class NDEFRecordData {
|
||||
var format: Short = 0
|
||||
var kind: ByteArray = ByteArray(0)
|
||||
var id: ByteArray = ByteArray(0)
|
||||
var payload: ByteArray = ByteArray(0)
|
||||
}
|
||||
|
||||
@InvokeArg
|
||||
class WriteOptions {
|
||||
var kind: ScanKind? = null
|
||||
lateinit var records: Array<NDEFRecordData>
|
||||
}
|
||||
|
||||
class Session(
|
||||
val action: NfcAction,
|
||||
val invoke: Invoke,
|
||||
val keepAlive: Boolean,
|
||||
var tag: Tag? = null,
|
||||
val filters: Array<IntentFilter>? = null,
|
||||
val techLists: Array<Array<String>>? = null
|
||||
)
|
||||
|
||||
@TauriPlugin
|
||||
class NfcPlugin(private val activity: Activity) : Plugin(activity) {
|
||||
private lateinit var webView: WebView
|
||||
|
||||
private var nfcAdapter: NfcAdapter? = null
|
||||
private var session: Session? = null
|
||||
|
||||
override fun load(webView: WebView) {
|
||||
super.load(webView)
|
||||
this.webView = webView
|
||||
this.nfcAdapter = NfcAdapter.getDefaultAdapter(activity.applicationContext)
|
||||
}
|
||||
|
||||
override fun onNewIntent(intent: Intent) {
|
||||
Logger.info("NFC", "onNewIntent")
|
||||
super.onNewIntent(intent)
|
||||
|
||||
val extraTag = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
||||
intent.getParcelableExtra(NfcAdapter.EXTRA_TAG, Tag::class.java)
|
||||
} else {
|
||||
@Suppress("DEPRECATION")
|
||||
intent.getParcelableExtra(NfcAdapter.EXTRA_TAG)
|
||||
}
|
||||
|
||||
extraTag?.let { tag ->
|
||||
session?.let {
|
||||
if (it.keepAlive) {
|
||||
it.tag = tag
|
||||
}
|
||||
}
|
||||
|
||||
when (session?.action) {
|
||||
is NfcAction.Read -> readTag(tag, intent)
|
||||
is NfcAction.Write -> thread {
|
||||
if (session?.action is NfcAction.Write) {
|
||||
try {
|
||||
writeTag(tag, (session?.action as NfcAction.Write).message)
|
||||
session?.invoke?.resolve()
|
||||
} catch (e: Exception) {
|
||||
session?.invoke?.reject(e.toString())
|
||||
} finally {
|
||||
if (this.session?.keepAlive != true) {
|
||||
this.session = null
|
||||
disableNFCInForeground()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
else -> {}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
override fun onPause() {
|
||||
disableNFCInForeground()
|
||||
super.onPause()
|
||||
Logger.info("NFC", "onPause")
|
||||
}
|
||||
|
||||
override fun onResume() {
|
||||
super.onResume()
|
||||
Logger.info("NFC", "onResume")
|
||||
session?.let {
|
||||
enableNFCInForeground(it.filters, it.techLists)
|
||||
}
|
||||
}
|
||||
|
||||
private fun isAvailable(): Pair<Boolean, String?> {
|
||||
val available: Boolean
|
||||
var errorReason: String? = null
|
||||
|
||||
if (this.nfcAdapter === null) {
|
||||
available = false
|
||||
errorReason = "Device does not have NFC capabilities"
|
||||
} else if (this.nfcAdapter?.isEnabled == false) {
|
||||
available = false
|
||||
errorReason = "NFC is disabled in device settings"
|
||||
} else {
|
||||
available = true
|
||||
}
|
||||
|
||||
return Pair(available, errorReason)
|
||||
}
|
||||
|
||||
@Command
|
||||
fun isAvailable(invoke: Invoke) {
|
||||
val ret = JSObject()
|
||||
ret.put("available", isAvailable().first)
|
||||
invoke.resolve(ret)
|
||||
}
|
||||
|
||||
@Command
|
||||
fun scan(invoke: Invoke) {
|
||||
val status = isAvailable()
|
||||
if (!status.first) {
|
||||
invoke.reject("NFC unavailable: " + status.second)
|
||||
return
|
||||
}
|
||||
|
||||
val args = invoke.parseArgs(ScanOptions::class.java)
|
||||
|
||||
val filters = args.kind.filters()
|
||||
val techLists = args.kind.techLists()
|
||||
enableNFCInForeground(filters, techLists)
|
||||
|
||||
session = Session(NfcAction.Read, invoke, args.keepSessionAlive, null, filters, techLists)
|
||||
}
|
||||
|
||||
@Command
|
||||
fun write(invoke: Invoke) {
|
||||
val status = isAvailable()
|
||||
if (!status.first) {
|
||||
invoke.reject("NFC unavailable: " + status.second)
|
||||
return
|
||||
}
|
||||
|
||||
val args = invoke.parseArgs(WriteOptions::class.java)
|
||||
|
||||
val ndefRecords: MutableList<NdefRecord> = ArrayList()
|
||||
for (record in args.records) {
|
||||
ndefRecords.add(NdefRecord(record.format, record.kind, record.id, record.payload))
|
||||
}
|
||||
|
||||
val message = NdefMessage(ndefRecords.toTypedArray())
|
||||
|
||||
session?.let { session ->
|
||||
session.tag?.let {
|
||||
try {
|
||||
writeTag(it, message)
|
||||
invoke.resolve()
|
||||
} catch (e: Exception) {
|
||||
invoke.reject(e.toString())
|
||||
} finally {
|
||||
if (this.session?.keepAlive != true) {
|
||||
this.session = null
|
||||
disableNFCInForeground()
|
||||
}
|
||||
}
|
||||
} ?: run {
|
||||
invoke.reject("connected tag not found, please wait for it to be available and then call write()")
|
||||
}
|
||||
} ?: run {
|
||||
args.kind?.let { kind ->
|
||||
val filters = kind.filters()
|
||||
val techLists = kind.techLists()
|
||||
enableNFCInForeground(filters, techLists)
|
||||
session = Session(NfcAction.Write(message), invoke, true, null, filters, techLists)
|
||||
Logger.warn("NFC", "Write Mode Enabled")
|
||||
} ?: run {
|
||||
invoke.reject("Missing `kind` for write")
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
private fun readTag(tag: Tag, intent: Intent) {
|
||||
try {
|
||||
val rawMessages = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
|
||||
intent.getParcelableArrayExtra(NfcAdapter.EXTRA_NDEF_MESSAGES, Parcelable::class.java)
|
||||
} else {
|
||||
@Suppress("DEPRECATION")
|
||||
intent.getParcelableArrayExtra(NfcAdapter.EXTRA_NDEF_MESSAGES)
|
||||
}
|
||||
|
||||
when (intent.action) {
|
||||
NfcAdapter.ACTION_NDEF_DISCOVERED -> {
|
||||
// For some reason this one never triggers.
|
||||
Logger.info("NFC", "new NDEF intent")
|
||||
readTagInner(tag, rawMessages)
|
||||
}
|
||||
NfcAdapter.ACTION_TECH_DISCOVERED -> {
|
||||
// For some reason this always triggers instead of NDEF_DISCOVERED even though we set ndef filters right now
|
||||
Logger.info("NFC", "new TECH intent")
|
||||
// TODO: handle different techs. Don't assume ndef.
|
||||
readTagInner(tag, rawMessages)
|
||||
}
|
||||
NfcAdapter.ACTION_TAG_DISCOVERED -> {
|
||||
// This should never trigger when an app handles NDEF and TECH
|
||||
// TODO: Don't assume ndef.
|
||||
readTagInner(tag, rawMessages)
|
||||
}
|
||||
}
|
||||
} catch (e: Exception) {
|
||||
session?.invoke?.reject("failed to read tag", e)
|
||||
} finally {
|
||||
if (this.session?.keepAlive != true) {
|
||||
this.session = null
|
||||
}
|
||||
// TODO this crashes? disableNFCInForeground()
|
||||
}
|
||||
}
|
||||
|
||||
private fun readTagInner(tag: Tag?, rawMessages: Array<Parcelable>?) {
|
||||
val ndefMessage = rawMessages?.get(0) as NdefMessage?
|
||||
|
||||
val records = ndefMessage?.records ?: arrayOf()
|
||||
|
||||
val jsonRecords = Array(records.size) { i -> recordToJson(records[i]) }
|
||||
|
||||
val ret = JSObject()
|
||||
if (tag !== null) {
|
||||
ret.put("id", fromU8Array(tag.id))
|
||||
// TODO There's also ndef.type which returns the ndef spec type which may be interesting to know too?
|
||||
ret.put("kind", JSArray.from(tag.techList))
|
||||
}
|
||||
ret.put("records", JSArray.from(jsonRecords))
|
||||
|
||||
session?.invoke?.resolve(ret)
|
||||
}
|
||||
|
||||
private fun writeTag(tag: Tag, message: NdefMessage) {
|
||||
// This should return tags that are already in ndef format
|
||||
val ndefTag = Ndef.get(tag)
|
||||
if (ndefTag !== null) {
|
||||
// We have to connect first to check maxSize.
|
||||
try {
|
||||
ndefTag.connect()
|
||||
} catch (e: IOException) {
|
||||
throw Exception("Couldn't connect to NFC tag", e)
|
||||
}
|
||||
|
||||
if (ndefTag.maxSize < message.toByteArray().size) {
|
||||
throw Exception("The message is too large for the provided NFC tag")
|
||||
} else if (!ndefTag.isWritable) {
|
||||
throw Exception("NFC tag is read-only")
|
||||
} else {
|
||||
try {
|
||||
ndefTag.writeNdefMessage(message)
|
||||
} catch (e: Exception) {
|
||||
throw Exception("Couldn't write message to NFC tag", e)
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
ndefTag.close()
|
||||
} catch (e: IOException) {
|
||||
Logger.error("failed to close tag", e)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// This should cover tags that are not yet in ndef format but can be converted
|
||||
val ndefFormatableTag = NdefFormatable.get(tag)
|
||||
if (ndefFormatableTag !== null) {
|
||||
try {
|
||||
ndefFormatableTag.connect()
|
||||
ndefFormatableTag.format(message)
|
||||
} catch (e: Exception) {
|
||||
throw Exception("Couldn't format tag as Ndef", e)
|
||||
}
|
||||
|
||||
try {
|
||||
ndefFormatableTag.close()
|
||||
} catch (e: IOException) {
|
||||
Logger.error("failed to close tag", e)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// if we get to this line, the tag was neither Ndef nor NdefFormatable compatible
|
||||
throw Exception("Tag doesn't support Ndef format")
|
||||
}
|
||||
|
||||
// TODO: Use ReaderMode instead of ForegroundDispatch
|
||||
private fun enableNFCInForeground(filters: Array<IntentFilter>?, techLists: Array<Array<String>>?) {
|
||||
val flag =
|
||||
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE else PendingIntent.FLAG_UPDATE_CURRENT
|
||||
val pendingIntent = PendingIntent.getActivity(
|
||||
activity, 0,
|
||||
Intent(
|
||||
activity,
|
||||
activity.javaClass
|
||||
).addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP),
|
||||
flag
|
||||
)
|
||||
|
||||
nfcAdapter?.enableForegroundDispatch(activity, pendingIntent, filters, techLists)
|
||||
}
|
||||
|
||||
private fun disableNFCInForeground() {
|
||||
activity.runOnUiThread {
|
||||
nfcAdapter?.disableForegroundDispatch(activity)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private fun fromU8Array(byteArray: ByteArray): JSONArray {
|
||||
val json = JSONArray()
|
||||
for (byte in byteArray) {
|
||||
json.put(byte)
|
||||
}
|
||||
return json
|
||||
}
|
||||
|
||||
private fun recordToJson(record: NdefRecord): JSObject {
|
||||
val json = JSObject()
|
||||
json.put("tnf", record.tnf)
|
||||
json.put("kind", fromU8Array(record.type))
|
||||
json.put("id", fromU8Array(record.id))
|
||||
json.put("payload", fromU8Array(record.payload))
|
||||
return json
|
||||
}
|
||||
13
plugins/nfc/android/src/main/res/xml/nfc_tech_filter.xml
Normal file
13
plugins/nfc/android/src/main/res/xml/nfc_tech_filter.xml
Normal file
@@ -0,0 +1,13 @@
|
||||
<resources xmlns:xliff="urn:oasis:names:tc:xliff:document:1.2">
|
||||
<tech-list>
|
||||
<tech>android.nfc.tech.IsoDep</tech>
|
||||
<tech>android.nfc.tech.NfcA</tech>
|
||||
<tech>android.nfc.tech.NfcB</tech>
|
||||
<tech>android.nfc.tech.NfcF</tech>
|
||||
<tech>android.nfc.tech.NfcV</tech>
|
||||
<tech>android.nfc.tech.Ndef</tech>
|
||||
<tech>android.nfc.tech.NdefFormatable</tech>
|
||||
<tech>android.nfc.tech.MifareClassic</tech>
|
||||
<tech>android.nfc.tech.MifareUltralight</tech>
|
||||
</tech-list>
|
||||
</resources>
|
||||
21
plugins/nfc/android/src/test/java/ExampleUnitTest.kt
Normal file
21
plugins/nfc/android/src/test/java/ExampleUnitTest.kt
Normal file
@@ -0,0 +1,21 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package app.tauri.nfc
|
||||
|
||||
import org.junit.Test
|
||||
|
||||
import org.junit.Assert.*
|
||||
|
||||
/**
|
||||
* Example local unit test, which will execute on the development machine (host).
|
||||
*
|
||||
* See [testing documentation](http://d.android.com/tools/testing).
|
||||
*/
|
||||
class ExampleUnitTest {
|
||||
@Test
|
||||
fun addition_isCorrect() {
|
||||
assertEquals(4, 2 + 2)
|
||||
}
|
||||
}
|
||||
1
plugins/nfc/api-iife.js
Normal file
1
plugins/nfc/api-iife.js
Normal file
@@ -0,0 +1 @@
|
||||
if("__TAURI__"in window){var __TAURI_PLUGIN_NFC__=function(n,e){"use strict";const t=[84],r=[85];var o,c;function a(n,e,t,r){return{format:n,kind:"string"==typeof e?Array.from((new TextEncoder).encode(e)):e,id:"string"==typeof t?Array.from((new TextEncoder).encode(t)):t,payload:"string"==typeof r?Array.from((new TextEncoder).encode(r)):r}}n.TechKind=void 0,(o=n.TechKind||(n.TechKind={}))[o.IsoDep=0]="IsoDep",o[o.MifareClassic=1]="MifareClassic",o[o.MifareUltralight=2]="MifareUltralight",o[o.Ndef=3]="Ndef",o[o.NdefFormatable=4]="NdefFormatable",o[o.NfcA=5]="NfcA",o[o.NfcB=6]="NfcB",o[o.NfcBarcode=7]="NfcBarcode",o[o.NfcF=8]="NfcF",o[o.NfcV=9]="NfcV",n.NFCTypeNameFormat=void 0,(c=n.NFCTypeNameFormat||(n.NFCTypeNameFormat={}))[c.Empty=0]="Empty",c[c.NfcWellKnown=1]="NfcWellKnown",c[c.Media=2]="Media",c[c.AbsoluteURI=3]="AbsoluteURI",c[c.NfcExternal=4]="NfcExternal",c[c.Unknown=5]="Unknown",c[c.Unchanged=6]="Unchanged";const i=["","http://www.","https://www.","http://","https://","tel:","mailto:","ftp://anonymous:anonymous@","ftp://ftp.","ftps://","sftp://","smb://","nfs://","ftp://","dav://","news:","telnet://","imap:","rtsp://","urn:","pop:","sip:","sips:","tftp:","btspp://","btl2cap://","btgoep://","tcpobex://","irdaobex://","file://","urn:epc:id:","urn:epc:tag:","urn:epc:pat:","urn:epc:raw:","urn:epc:","urn:nfc:"];function f(n){const{type:e,...t}=n;return{[e]:t}}return n.RTD_TEXT=t,n.RTD_URI=r,n.isAvailable=async function(){const{available:n}=await e.invoke("plugin:nfc|is_available");return n},n.record=a,n.scan=async function(n,t){return await e.invoke("plugin:nfc|scan",{kind:f(n),...t})},n.textRecord=function(e,r,o="en"){const c=Array.from((new TextEncoder).encode(o+e));return c.unshift(o.length),a(n.NFCTypeNameFormat.NfcWellKnown,t,r??[],c)},n.uriRecord=function(e,t){return a(n.NFCTypeNameFormat.NfcWellKnown,r,t??[],function(n){let e="";i.slice(1).forEach(function(t){0!==e.length&&"urn:"!==e||0!==n.indexOf(t)||(e=t)}),0===e.length&&(e="");const t=Array.from((new TextEncoder).encode(n.slice(e.length))),r=i.indexOf(e);return t.unshift(r),t}(e))},n.write=async function(n,t){const{kind:r,...o}=t??{};r&&(o.kind=f(r)),await e.invoke("plugin:nfc|write",{records:n,...o})},n}({},window.__TAURI__.core);Object.defineProperty(window.__TAURI__,"nfc",{value:__TAURI_PLUGIN_NFC__})}
|
||||
45
plugins/nfc/build.rs
Normal file
45
plugins/nfc/build.rs
Normal file
@@ -0,0 +1,45 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
const COMMANDS: &[&str] = &["is_available", "write", "scan"];
|
||||
|
||||
fn main() {
|
||||
let result = tauri_plugin::Builder::new(COMMANDS)
|
||||
.global_api_script_path("./api-iife.js")
|
||||
.android_path("android")
|
||||
.ios_path("ios")
|
||||
.try_build();
|
||||
|
||||
// when building documentation for Android the plugin build result is always Err() and is irrelevant to the crate documentation build
|
||||
if !(cfg!(docsrs) && std::env::var("TARGET").unwrap().contains("android")) {
|
||||
result.unwrap();
|
||||
}
|
||||
|
||||
// TODO: triple check if this can reference the plugin's xml as it expects rn
|
||||
// TODO: This has to be configurable if we want to support handling nfc tags when the app is not open.
|
||||
tauri_plugin::mobile::update_android_manifest(
|
||||
"NFC PLUGIN",
|
||||
"activity",
|
||||
r#"<intent-filter>
|
||||
<action android:name="android.nfc.action.NDEF_DISCOVERED" />
|
||||
<category android:name="android.intent.category.DEFAULT" />
|
||||
</intent-filter>
|
||||
|
||||
<intent-filter>
|
||||
<action android:name="android.nfc.action.TECH_DISCOVERED" />
|
||||
<category android:name="android.intent.category.DEFAULT" />
|
||||
</intent-filter>
|
||||
|
||||
<intent-filter>
|
||||
<action android:name="android.nfc.action.TAG_DISCOVERED" />
|
||||
<category android:name="android.intent.category.DEFAULT" />
|
||||
</intent-filter>
|
||||
|
||||
<meta-data
|
||||
android:name="android.nfc.action.TECH_DISCOVERED"
|
||||
android:resource="@xml/nfc_tech_filter" />"#
|
||||
.to_string(),
|
||||
)
|
||||
.expect("failed to rewrite AndroidManifest.xml");
|
||||
}
|
||||
31
plugins/nfc/contributors/crabnebula.svg
Normal file
31
plugins/nfc/contributors/crabnebula.svg
Normal file
@@ -0,0 +1,31 @@
|
||||
<svg class="crabnebula-logo" width="100%" height="100%" viewBox="0 0 1204 210" version="1.1"
|
||||
xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xml:space="preserve" xmlns:serif="http://www.serif.com/"
|
||||
style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
|
||||
<style>
|
||||
.crabnebula-logo path,
|
||||
.crabnebula-logo rect {
|
||||
fill: #001e42;
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
.crabnebula-logo path, .crabnebula-logo rect {
|
||||
fill: #fff;
|
||||
}
|
||||
}
|
||||
html[data-color-mode="dark"] .crabnebula-logo path,
|
||||
html[data-color-mode="dark"] .crabnebula-logo rect {
|
||||
fill: #fff;
|
||||
}
|
||||
</style>
|
||||
<path d="M351.903,162.334C344.288,162.334 337.123,160.881 330.41,157.975C323.696,155.069 317.834,151.11 312.824,146.099C307.914,141.089 304.006,135.276 301.101,128.662C298.195,121.948 296.742,114.783 296.742,107.167C296.742,99.55 298.195,92.435 301.101,85.821C304.006,79.107 307.914,73.244 312.824,68.234C317.834,63.223 323.696,59.265 330.41,56.358C337.123,53.452 344.288,51.999 351.903,51.999C357.414,51.999 362.675,52.701 367.685,54.103C372.795,55.507 377.455,57.511 381.663,60.116C385.972,62.622 389.83,65.678 393.237,69.286C396.644,72.793 399.499,76.752 401.804,81.161L380.762,92.586C377.756,87.174 373.848,82.915 369.038,79.808C364.328,76.702 358.617,75.148 351.903,75.148C347.494,75.148 343.386,76 339.578,77.704C335.871,79.407 332.614,81.762 329.809,84.769C327.003,87.675 324.798,91.082 323.195,94.991C321.592,98.799 320.79,102.857 320.79,107.167C320.79,111.476 321.592,115.584 323.195,119.493C324.798,123.301 327.003,126.708 329.809,129.715C332.614,132.621 335.871,134.926 339.578,136.629C343.386,138.333 347.494,139.185 351.903,139.185C358.617,139.185 364.328,137.631 369.038,134.525C373.848,131.418 377.756,127.159 380.762,121.748L401.804,133.172C399.499,137.581 396.644,141.59 393.237,145.198C389.83,148.705 385.972,151.762 381.663,154.367C377.455,156.872 372.795,158.827 367.685,160.23C362.675,161.633 357.414,162.334 351.903,162.334Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M413.821,85.37L436.517,85.37L436.517,96.644C437.72,93.337 439.924,90.481 443.131,88.076C446.437,85.671 450.195,84.468 454.403,84.468C455.506,84.468 456.658,84.518 457.86,84.619C459.063,84.719 460.366,84.969 461.768,85.37L461.768,108.369C460.065,107.768 458.412,107.317 456.808,107.016C455.205,106.716 453.502,106.565 451.698,106.565C446.788,106.565 443.03,108.269 440.425,111.676C437.82,115.083 436.517,119.493 436.517,124.904L436.517,160.53L413.821,160.53L413.821,85.37Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M502.161,162.184C497.251,162.184 492.642,161.132 488.333,159.027C484.125,156.923 480.467,154.117 477.361,150.609C474.255,147.001 471.8,142.843 469.996,138.133C468.193,133.322 467.291,128.261 467.291,122.95C467.291,117.639 468.193,112.628 469.996,107.918C471.8,103.108 474.255,98.949 477.361,95.442C480.467,91.834 484.125,88.978 488.333,86.873C492.642,84.769 497.251,83.717 502.161,83.717C504.666,83.717 506.971,84.017 509.075,84.619C511.28,85.12 513.234,85.821 514.937,86.723C516.741,87.625 518.244,88.627 519.446,89.729C520.749,90.832 521.801,91.884 522.603,92.886L522.603,85.37L545.299,85.37L545.299,160.53L522.603,160.53L522.603,153.014C521.801,154.016 520.749,155.069 519.446,156.171C518.244,157.273 516.741,158.275 514.937,159.177C513.234,160.079 511.28,160.781 509.075,161.282C506.971,161.883 504.666,162.184 502.161,162.184ZM507.272,141.59C512.382,141.59 516.49,139.836 519.597,136.329C522.803,132.821 524.406,128.362 524.406,122.95C524.406,117.539 522.803,113.079 519.597,109.572C516.49,106.064 512.382,104.31 507.272,104.31C502.161,104.31 498.003,106.064 494.796,109.572C491.69,113.079 490.137,117.539 490.137,122.95C490.137,128.362 491.69,132.821 494.796,136.329C498.003,139.836 502.161,141.59 507.272,141.59Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M607.116,162.184C604.611,162.184 602.256,161.883 600.051,161.282C597.947,160.781 595.993,160.079 594.19,159.177C592.486,158.275 590.983,157.273 589.681,156.171C588.378,155.069 587.376,154.016 586.674,153.014L586.674,160.53L563.979,160.53L563.979,47.79L586.674,47.79L586.674,92.886C587.376,91.884 588.378,90.832 589.681,89.729C590.983,88.627 592.486,87.625 594.19,86.723C595.993,85.821 597.947,85.12 600.051,84.619C602.256,84.017 604.611,83.717 607.116,83.717C612.026,83.717 616.585,84.769 620.793,86.873C625.102,88.978 628.81,91.834 631.916,95.442C635.022,98.949 637.477,103.108 639.281,107.918C641.084,112.628 641.986,117.639 641.986,122.95C641.986,128.261 641.084,133.322 639.281,138.133C637.477,142.843 635.022,147.001 631.916,150.609C628.81,154.117 625.102,156.923 620.793,159.027C616.585,161.132 612.026,162.184 607.116,162.184ZM602.005,141.59C607.116,141.59 611.224,139.836 614.33,136.329C617.537,132.821 619.14,128.362 619.14,122.95C619.14,117.539 617.537,113.079 614.33,109.572C611.224,106.064 607.116,104.31 602.005,104.31C596.895,104.31 592.737,106.064 589.53,109.572C586.424,113.079 584.871,117.539 584.871,122.95C584.871,128.362 586.424,132.821 589.53,136.329C592.737,139.836 596.895,141.59 602.005,141.59Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M732.106,160.53L680.101,94.54L680.101,160.53L656.203,160.53L656.203,53.803L676.795,53.803L728.649,119.793L728.649,53.803L752.698,53.803L752.698,160.53L732.106,160.53Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M806.852,162.184C801.341,162.184 796.13,161.282 791.22,159.478C786.411,157.674 782.202,155.069 778.595,151.661C774.988,148.254 772.132,144.145 770.028,139.335C767.923,134.425 766.871,128.963 766.871,122.95C766.871,117.338 767.823,112.177 769.727,107.467C771.731,102.657 774.487,98.498 777.994,94.991C781.601,91.483 785.809,88.727 790.619,86.723C795.429,84.719 800.69,83.717 806.401,83.717C811.311,83.717 816.021,84.518 820.53,86.122C825.139,87.625 829.147,89.93 832.554,93.036C835.961,96.043 838.666,99.851 840.67,104.461C842.775,108.97 843.827,114.282 843.827,120.395C843.827,121.397 843.777,122.549 843.677,123.852C843.677,125.055 843.576,126.558 843.376,128.362L788.816,128.362C789.517,132.871 791.671,136.228 795.279,138.433C798.886,140.538 802.844,141.59 807.153,141.59C811.562,141.59 815.319,140.738 818.425,139.034C821.632,137.231 823.937,135.226 825.339,133.022L842.173,145.649C838.666,150.659 833.857,154.668 827.744,157.674C821.732,160.681 814.768,162.184 806.852,162.184ZM821.281,113.48C820.279,109.471 818.275,106.615 815.269,104.912C812.263,103.108 809.107,102.206 805.8,102.206C804.096,102.206 802.393,102.406 800.69,102.807C798.986,103.208 797.383,103.859 795.88,104.761C794.377,105.663 793.024,106.816 791.822,108.219C790.719,109.622 789.918,111.376 789.417,113.48L821.281,113.48Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M901.265,162.184C898.76,162.184 896.405,161.883 894.201,161.282C892.097,160.781 890.143,160.079 888.339,159.177C886.636,158.275 885.133,157.273 883.83,156.171C882.527,155.069 881.525,154.016 880.824,153.014L880.824,160.53L858.128,160.53L858.128,47.79L880.824,47.79L880.824,92.886C881.525,91.884 882.527,90.832 883.83,89.729C885.133,88.627 886.636,87.625 888.339,86.723C890.143,85.821 892.097,85.12 894.201,84.619C896.405,84.017 898.76,83.717 901.265,83.717C906.175,83.717 910.734,84.769 914.943,86.873C919.252,88.978 922.959,91.834 926.065,95.442C929.172,98.949 931.627,103.108 933.43,107.918C935.234,112.628 936.136,117.639 936.136,122.95C936.136,128.261 935.234,133.322 933.43,138.133C931.627,142.843 929.172,147.001 926.065,150.609C922.959,154.117 919.252,156.923 914.943,159.027C910.734,161.132 906.175,162.184 901.265,162.184ZM896.155,141.59C901.265,141.59 905.374,139.836 908.48,136.329C911.686,132.821 913.29,128.362 913.29,122.95C913.29,117.539 911.686,113.079 908.48,109.572C905.374,106.064 901.265,104.31 896.155,104.31C891.045,104.31 886.886,106.064 883.68,109.572C880.573,113.079 879.02,117.539 879.02,122.95C879.02,128.362 880.573,132.821 883.68,136.329C886.886,139.836 891.045,141.59 896.155,141.59Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M977.812,162.184C968.493,162.184 961.429,159.077 956.619,152.864C951.81,146.651 949.405,138.433 949.405,128.211L949.405,85.37L972.101,85.37L972.101,124.303C972.101,129.815 972.952,134.074 974.656,137.08C976.459,140.087 979.466,141.59 983.674,141.59C987.983,141.59 991.39,140.037 993.895,136.93C996.5,133.823 997.803,128.813 997.803,121.898L997.803,85.37L1020.5,85.37L1020.5,160.53L997.803,160.53L997.803,152.864C995.999,155.469 993.444,157.674 990.137,159.478C986.83,161.282 982.722,162.184 977.812,162.184Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<rect x="1039.11" y="47.79" width="22.701" height="112.74" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M1110.86,162.184C1105.95,162.184 1101.34,161.132 1097.03,159.027C1092.83,156.923 1089.17,154.117 1086.06,150.609C1082.96,147.001 1080.5,142.843 1078.7,138.133C1076.89,133.322 1075.99,128.261 1075.99,122.95C1075.99,117.639 1076.89,112.628 1078.7,107.918C1080.5,103.108 1082.96,98.949 1086.06,95.442C1089.17,91.834 1092.83,88.978 1097.03,86.873C1101.34,84.769 1105.95,83.717 1110.86,83.717C1113.37,83.717 1115.67,84.017 1117.78,84.619C1119.98,85.12 1121.94,85.821 1123.64,86.723C1125.44,87.625 1126.95,88.627 1128.15,89.729C1129.45,90.832 1130.5,91.884 1131.3,92.886L1131.3,85.37L1154,85.37L1154,160.53L1131.3,160.53L1131.3,153.014C1130.5,154.016 1129.45,155.069 1128.15,156.171C1126.95,157.273 1125.44,158.275 1123.64,159.177C1121.94,160.079 1119.98,160.781 1117.78,161.282C1115.67,161.883 1113.37,162.184 1110.86,162.184ZM1115.97,141.59C1121.08,141.59 1125.19,139.836 1128.3,136.329C1131.5,132.821 1133.11,128.362 1133.11,122.95C1133.11,117.539 1131.5,113.079 1128.3,109.572C1125.19,106.064 1121.08,104.31 1115.97,104.31C1110.86,104.31 1106.7,106.064 1103.5,109.572C1100.39,113.079 1098.84,117.539 1098.84,122.95C1098.84,128.362 1100.39,132.821 1103.5,136.329C1106.7,139.836 1110.86,141.59 1115.97,141.59Z" style="fill-rule:nonzero;stroke:black;stroke-width:0.55px;"/>
|
||||
<path d="M146.48,54.585C119.724,89.866 119.878,134.941 146.826,155.264C153.908,160.605 162.136,163.705 170.903,164.732C146.032,184.934 117.382,191.203 98.037,178.045C71.507,160 72.524,112.249 100.309,71.391C123.51,37.273 158.039,18.749 184.247,24.072C170.404,30.195 157.116,40.561 146.48,54.585ZM181.638,99.643C169.141,111.453 154.859,119.304 142.801,121.916C149.921,147.367 177.29,149.323 177.29,149.323C177.29,149.323 193.578,145.578 205.877,117.941C216.005,95.183 215.122,71.668 204.914,59.7C204.065,71.267 195.731,86.324 181.638,99.643Z" style="stroke:black;stroke-width:0.55px;"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 11 KiB |
21
plugins/nfc/contributors/impierce.svg
Normal file
21
plugins/nfc/contributors/impierce.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 14 KiB |
469
plugins/nfc/guest-js/index.ts
Normal file
469
plugins/nfc/guest-js/index.ts
Normal file
@@ -0,0 +1,469 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
/**
|
||||
* Read and write NFC tags on Android and iOS.
|
||||
*
|
||||
* This plugin is mobile only, the APIs reject on desktop platforms.
|
||||
*
|
||||
* @module
|
||||
*/
|
||||
|
||||
import { invoke } from '@tauri-apps/api/core'
|
||||
|
||||
/**
|
||||
* Record Type Definition (RTD) of an NDEF well known text record, the `"T"` (`0x54`) byte.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export const RTD_TEXT = [0x54] // "T"
|
||||
/**
|
||||
* Record Type Definition (RTD) of an NDEF well known URI record, the `"U"` (`0x55`) byte.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export const RTD_URI = [0x55] // "U"
|
||||
|
||||
/**
|
||||
* Filters the tags to scan by the URI of their payload.
|
||||
*
|
||||
* Every property is optional and only the ones that are set take part in the filter.
|
||||
* **Android only**, the iOS implementation ignores this filter.
|
||||
*/
|
||||
export interface UriFilter {
|
||||
/** Only match URIs with this scheme, e.g. `https`. */
|
||||
scheme?: string
|
||||
/** Only match URIs with this authority (host), e.g. `tauri.app`. */
|
||||
host?: string
|
||||
/** Only match URIs whose path starts with this prefix, e.g. `/docs`. */
|
||||
pathPrefix?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* The NFC technologies a tag can support, mirroring the `android.nfc.tech` classes.
|
||||
*
|
||||
* **Android only**, used by the `techLists` filter of an `ndef` {@link ScanKind}.
|
||||
*/
|
||||
export enum TechKind {
|
||||
/** ISO-DEP (ISO 14443-4) properties and I/O operations. */
|
||||
IsoDep,
|
||||
/** MIFARE Classic properties and I/O operations. */
|
||||
MifareClassic,
|
||||
/** MIFARE Ultralight and MIFARE Ultralight C properties and I/O operations. */
|
||||
MifareUltralight,
|
||||
/** NDEF data and operations on tags that are already formatted as NDEF. */
|
||||
Ndef,
|
||||
/** Formatting operations on tags that can be formatted as NDEF but are not yet. */
|
||||
NdefFormatable,
|
||||
/** NFC-A (ISO 14443-3A) properties and I/O operations. */
|
||||
NfcA,
|
||||
/** NFC-B (ISO 14443-3B) properties and I/O operations. */
|
||||
NfcB,
|
||||
/** NFC Barcode (Kovio NFC Barcode) properties and I/O operations. */
|
||||
NfcBarcode,
|
||||
/** NFC-F (JIS 6319-4) properties and I/O operations. */
|
||||
NfcF,
|
||||
/** NFC-V (ISO 15693) properties and I/O operations. */
|
||||
NfcV
|
||||
}
|
||||
|
||||
/**
|
||||
* The kind of scan to perform, which defines which tags are matched.
|
||||
*
|
||||
* Use `tag` to match any discovered tag and `ndef` to only match tags carrying an NDEF message.
|
||||
*/
|
||||
export type ScanKind =
|
||||
| {
|
||||
/** Matches any tag that is discovered, whether it carries an NDEF message or not. */
|
||||
type: 'tag'
|
||||
/** Only match tags whose payload URI matches this filter. **Android only**. */
|
||||
uri?: UriFilter
|
||||
/** Only match tags whose payload has this MIME type, e.g. `text/plain`. **Android only**. */
|
||||
mimeType?: string
|
||||
}
|
||||
| {
|
||||
/** Only matches tags that carry an NDEF message. */
|
||||
type: 'ndef'
|
||||
/** Only match tags whose NDEF payload URI matches this filter. **Android only**. */
|
||||
uri?: UriFilter
|
||||
/**
|
||||
* Only match tags whose NDEF payload has this MIME type, e.g. `text/plain`.
|
||||
* **Android only**.
|
||||
*/
|
||||
mimeType?: string
|
||||
/**
|
||||
* Each of the tech-lists is considered independently and the activity is considered a match if
|
||||
* any single tech-list matches the tag that was discovered.
|
||||
* This provides AND and OR semantics for filtering desired techs.
|
||||
*
|
||||
* See <https://developer.android.com/reference/android/nfc/NfcAdapter#ACTION_TECH_DISCOVERED> for more information.
|
||||
*
|
||||
* Examples
|
||||
*
|
||||
* ```ts
|
||||
* import type { TechKind } from "@tauri-apps/plugin-nfc"
|
||||
*
|
||||
* const techLists = [
|
||||
* // capture anything using NfcF
|
||||
* [TechKind.NfcF],
|
||||
* // capture all MIFARE Classics with NDEF payloads
|
||||
* [TechKind.NfcA, TechKind.MifareClassic, TechKind.Ndef]
|
||||
* ]
|
||||
* ```
|
||||
*/
|
||||
techLists?: TechKind[][]
|
||||
}
|
||||
|
||||
/** Options for the {@link scan} function. */
|
||||
export interface ScanOptions {
|
||||
/**
|
||||
* Whether the connection to the scanned tag must be kept open after the scan resolves,
|
||||
* so that a following {@link write} call writes to that tag instead of scanning a new one.
|
||||
* Defaults to `false`.
|
||||
*/
|
||||
keepSessionAlive?: boolean
|
||||
/** Message displayed in the UI. iOS only. */
|
||||
message?: string
|
||||
/** Message displayed in the UI when the message has been read. iOS only. */
|
||||
successMessage?: string
|
||||
}
|
||||
|
||||
/** Options for the {@link write} function. */
|
||||
export interface WriteOptions {
|
||||
/**
|
||||
* The kind of scan to perform to find the tag to write to.
|
||||
* Required on Android unless a {@link scan} session is kept alive.
|
||||
*/
|
||||
kind?: ScanKind
|
||||
/** Message displayed in the UI when reading the tag. iOS only. */
|
||||
message?: string
|
||||
/** Message displayed in the UI when the tag has been read. iOS only. */
|
||||
successfulReadMessage?: string
|
||||
/** Message displayed in the UI when the message has been written. iOS only. */
|
||||
successMessage?: string
|
||||
}
|
||||
|
||||
/**
|
||||
* The Type Name Format (TNF) of an NDEF record,
|
||||
* which defines how the record type is interpreted.
|
||||
*/
|
||||
export enum NFCTypeNameFormat {
|
||||
/** The record is empty: type, identifier and payload must be empty. */
|
||||
Empty = 0,
|
||||
/**
|
||||
* The record type is an NFC Forum well known type, defined by a Record Type Definition (RTD)
|
||||
* such as {@link RTD_TEXT} or {@link RTD_URI}.
|
||||
*/
|
||||
NfcWellKnown = 1,
|
||||
/** The record type is a MIME media type as defined in RFC 2046, e.g. `text/plain`. */
|
||||
Media = 2,
|
||||
/** The record type is an absolute URI as defined in RFC 3986. */
|
||||
AbsoluteURI = 3,
|
||||
/** The record type is an NFC Forum external type, i.e. a type namespaced by its issuer. */
|
||||
NfcExternal = 4,
|
||||
/**
|
||||
* The record type is unknown: the type must be empty and the payload interpretation
|
||||
* is left to the application.
|
||||
*/
|
||||
Unknown = 5,
|
||||
/**
|
||||
* The record is a middle or last chunk of a chunked record and inherits the type of the
|
||||
* first chunk, so its own type must be empty.
|
||||
*/
|
||||
Unchanged = 6
|
||||
}
|
||||
|
||||
/** An NDEF record read from a scanned tag. */
|
||||
export interface TagRecord {
|
||||
/**
|
||||
* The Type Name Format (TNF) of the record,
|
||||
* which defines how {@link TagRecord.kind} is interpreted.
|
||||
*/
|
||||
tnf: NFCTypeNameFormat
|
||||
/** The record type bytes. */
|
||||
kind: number[]
|
||||
/** The record identifier bytes. Can be empty. */
|
||||
id: number[]
|
||||
/** The record payload bytes. */
|
||||
payload: number[]
|
||||
}
|
||||
|
||||
/** An NFC tag that has been scanned. */
|
||||
export interface Tag {
|
||||
/** The tag identifier bytes, as reported by the operating system. */
|
||||
id: number[]
|
||||
/** The technologies the tag supports, e.g. `["android.nfc.tech.Ndef"]` on Android. */
|
||||
kind: string[]
|
||||
/** The NDEF records stored on the tag. Empty when the tag holds no NDEF message. */
|
||||
records: TagRecord[]
|
||||
}
|
||||
|
||||
/**
|
||||
* An NDEF record to be written to a tag.
|
||||
*
|
||||
* Use {@link record}, {@link textRecord} or {@link uriRecord} to create one.
|
||||
*/
|
||||
export interface NFCRecord {
|
||||
/** The Type Name Format (TNF) of the record. */
|
||||
format: NFCTypeNameFormat
|
||||
/**
|
||||
* The record type, interpreted according to {@link NFCRecord.format}.
|
||||
* For well known records this is a Record Type Definition (RTD) value
|
||||
* such as {@link RTD_TEXT} or {@link RTD_URI}.
|
||||
*/
|
||||
kind: number[]
|
||||
/** The record identifier. Can be empty. */
|
||||
id: number[]
|
||||
/** The record payload bytes. */
|
||||
payload: number[]
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an NDEF record with the given type name format, type, identifier and payload.
|
||||
*
|
||||
* Strings are encoded as UTF-8 byte arrays.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { record, NFCTypeNameFormat, write } from '@tauri-apps/plugin-nfc';
|
||||
* const mimeRecord = record(NFCTypeNameFormat.Media, 'text/plain', '', 'hello world');
|
||||
* await write([mimeRecord], { kind: { type: 'ndef' } });
|
||||
* ```
|
||||
*
|
||||
* @param format The Type Name Format (TNF) of the record.
|
||||
* @param kind The record type, interpreted according to `format`.
|
||||
* @param id The record identifier. Use an empty string or array when the record has none.
|
||||
* @param payload The record payload.
|
||||
* @returns The NDEF record, ready to be written with {@link write}.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export function record(
|
||||
format: NFCTypeNameFormat,
|
||||
kind: string | number[],
|
||||
id: string | number[],
|
||||
payload: string | number[]
|
||||
): NFCRecord {
|
||||
return {
|
||||
format,
|
||||
kind:
|
||||
typeof kind === 'string'
|
||||
? Array.from(new TextEncoder().encode(kind))
|
||||
: kind,
|
||||
id: typeof id === 'string' ? Array.from(new TextEncoder().encode(id)) : id,
|
||||
payload:
|
||||
typeof payload === 'string'
|
||||
? Array.from(new TextEncoder().encode(payload))
|
||||
: payload
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an NDEF well known text record ({@link RTD_TEXT}).
|
||||
*
|
||||
* The payload is the UTF-8 encoded text prefixed by the language code
|
||||
* and by a status byte holding the length of that language code.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { textRecord, write } from '@tauri-apps/plugin-nfc';
|
||||
* await write([textRecord('hello world')], { kind: { type: 'ndef' } });
|
||||
* ```
|
||||
*
|
||||
* @param text The text to store in the record.
|
||||
* @param id The record identifier. Defaults to an empty identifier.
|
||||
* @param language The IANA language code of the text. Defaults to `en`.
|
||||
* @returns The NDEF record, ready to be written with {@link write}.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export function textRecord(
|
||||
text: string,
|
||||
id?: string | number[],
|
||||
language: string = 'en'
|
||||
): NFCRecord {
|
||||
const payload = Array.from(new TextEncoder().encode(language + text))
|
||||
payload.unshift(language.length)
|
||||
return record(NFCTypeNameFormat.NfcWellKnown, RTD_TEXT, id ?? [], payload)
|
||||
}
|
||||
|
||||
const protocols = [
|
||||
'',
|
||||
'http://www.',
|
||||
'https://www.',
|
||||
'http://',
|
||||
'https://',
|
||||
'tel:',
|
||||
'mailto:',
|
||||
'ftp://anonymous:anonymous@',
|
||||
'ftp://ftp.',
|
||||
'ftps://',
|
||||
'sftp://',
|
||||
'smb://',
|
||||
'nfs://',
|
||||
'ftp://',
|
||||
'dav://',
|
||||
'news:',
|
||||
'telnet://',
|
||||
'imap:',
|
||||
'rtsp://',
|
||||
'urn:',
|
||||
'pop:',
|
||||
'sip:',
|
||||
'sips:',
|
||||
'tftp:',
|
||||
'btspp://',
|
||||
'btl2cap://',
|
||||
'btgoep://',
|
||||
'tcpobex://',
|
||||
'irdaobex://',
|
||||
'file://',
|
||||
'urn:epc:id:',
|
||||
'urn:epc:tag:',
|
||||
'urn:epc:pat:',
|
||||
'urn:epc:raw:',
|
||||
'urn:epc:',
|
||||
'urn:nfc:'
|
||||
]
|
||||
|
||||
function encodeURI(uri: string): number[] {
|
||||
let prefix = ''
|
||||
|
||||
protocols.slice(1).forEach(function (protocol) {
|
||||
if (
|
||||
(prefix.length === 0 || prefix === 'urn:')
|
||||
&& uri.indexOf(protocol) === 0
|
||||
) {
|
||||
prefix = protocol
|
||||
}
|
||||
})
|
||||
|
||||
if (prefix.length === 0) {
|
||||
prefix = ''
|
||||
}
|
||||
|
||||
const encoded = Array.from(new TextEncoder().encode(uri.slice(prefix.length)))
|
||||
const protocolCode = protocols.indexOf(prefix)
|
||||
// prepend protocol code
|
||||
encoded.unshift(protocolCode)
|
||||
|
||||
return encoded
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an NDEF well known URI record ({@link RTD_URI}).
|
||||
*
|
||||
* The URI is encoded with the NDEF URI abbreviation scheme: a known prefix such as
|
||||
* `https://` is replaced by the identifier code byte that starts the payload.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { uriRecord, write } from '@tauri-apps/plugin-nfc';
|
||||
* await write([uriRecord('https://tauri.app')], { kind: { type: 'ndef' } });
|
||||
* ```
|
||||
*
|
||||
* @param uri The URI to store in the record.
|
||||
* @param id The record identifier. Defaults to an empty identifier.
|
||||
* @returns The NDEF record, ready to be written with {@link write}.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export function uriRecord(uri: string, id?: string | number[]): NFCRecord {
|
||||
return record(
|
||||
NFCTypeNameFormat.NfcWellKnown,
|
||||
RTD_URI,
|
||||
id ?? [],
|
||||
encodeURI(uri)
|
||||
)
|
||||
}
|
||||
|
||||
function mapScanKind(kind: ScanKind): Record<string, unknown> {
|
||||
const { type: scanKind, ...kindOptions } = kind
|
||||
return { [scanKind]: kindOptions }
|
||||
}
|
||||
|
||||
/**
|
||||
* Scans an NFC tag, resolving when a tag matching the given filters is read.
|
||||
*
|
||||
* See <https://developer.android.com/develop/connectivity/nfc/nfc#ndef> for more information.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { scan } from '@tauri-apps/plugin-nfc';
|
||||
* const tag = await scan({ type: 'tag' });
|
||||
* ```
|
||||
*
|
||||
* @param kind The kind of scan to perform, which defines how tags are matched.
|
||||
* @param options Additional scan options such as the iOS UI messages and whether the
|
||||
* session must be kept alive for a following {@link write} call.
|
||||
* @returns A promise resolving to the tag that has been scanned.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export async function scan(
|
||||
kind: ScanKind,
|
||||
options?: ScanOptions
|
||||
): Promise<Tag> {
|
||||
return await invoke('plugin:nfc|scan', {
|
||||
kind: mapScanKind(kind),
|
||||
...options
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Write to an NFC tag.
|
||||
*
|
||||
* If you did not previously call {@link scan} with {@link ScanOptions.keepSessionAlive} set to true,
|
||||
* it will first scan the tag then write to it.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { uriRecord, write } from '@tauri-apps/plugin-nfc';
|
||||
* await write([uriRecord('https://tauri.app')], { kind: { type: 'ndef' } });
|
||||
* ```
|
||||
*
|
||||
* @param records The NDEF records to write to the tag.
|
||||
* @param options Additional write options such as the kind of scan used to find the tag
|
||||
* and the iOS UI messages.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export async function write(
|
||||
records: NFCRecord[],
|
||||
options?: WriteOptions
|
||||
): Promise<void> {
|
||||
const { kind, ...opts } = options ?? {}
|
||||
if (kind) {
|
||||
// @ts-expect-error map the property
|
||||
opts.kind = mapScanKind(kind)
|
||||
}
|
||||
await invoke('plugin:nfc|write', {
|
||||
records,
|
||||
...opts
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether NFC is supported by the device and currently usable by the app.
|
||||
*
|
||||
* Resolves to `false` on Android when the device has no NFC adapter or NFC is disabled in the
|
||||
* device settings, and on iOS when the `NFCReaderUsageDescription` entry is missing from the
|
||||
* `Info.plist` file or NFC tag reading is unavailable.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { isAvailable } from '@tauri-apps/plugin-nfc';
|
||||
* const canScan = await isAvailable();
|
||||
* ```
|
||||
*
|
||||
* @returns A promise resolving to whether NFC is available on the device.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export async function isAvailable(): Promise<boolean> {
|
||||
const { available }: { available: boolean } = await invoke(
|
||||
'plugin:nfc|is_available'
|
||||
)
|
||||
return available
|
||||
}
|
||||
10
plugins/nfc/ios/.gitignore
vendored
Normal file
10
plugins/nfc/ios/.gitignore
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
.DS_Store
|
||||
/.build
|
||||
/Packages
|
||||
/*.xcodeproj
|
||||
xcuserdata/
|
||||
DerivedData/
|
||||
.swiftpm/config/registries.json
|
||||
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
|
||||
.netrc
|
||||
Package.resolved
|
||||
34
plugins/nfc/ios/Package.swift
Normal file
34
plugins/nfc/ios/Package.swift
Normal file
@@ -0,0 +1,34 @@
|
||||
// swift-tools-version:5.3
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
import PackageDescription
|
||||
|
||||
let package = Package(
|
||||
name: "tauri-plugin-nfc",
|
||||
platforms: [
|
||||
.macOS(.v10_13),
|
||||
.iOS(.v13),
|
||||
],
|
||||
products: [
|
||||
// Products define the executables and libraries a package produces, and make them visible to other packages.
|
||||
.library(
|
||||
name: "tauri-plugin-nfc",
|
||||
type: .static,
|
||||
targets: ["tauri-plugin-nfc"])
|
||||
],
|
||||
dependencies: [
|
||||
.package(name: "Tauri", path: "../.tauri/tauri-api")
|
||||
],
|
||||
targets: [
|
||||
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
|
||||
// Targets can depend on other targets in this package, and on products in packages this package depends on.
|
||||
.target(
|
||||
name: "tauri-plugin-nfc",
|
||||
dependencies: [
|
||||
.byName(name: "Tauri")
|
||||
],
|
||||
path: "Sources")
|
||||
]
|
||||
)
|
||||
3
plugins/nfc/ios/README.md
Normal file
3
plugins/nfc/ios/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Tauri Plugin Nfc
|
||||
|
||||
A description of this package.
|
||||
523
plugins/nfc/ios/Sources/NfcPlugin.swift
Normal file
523
plugins/nfc/ios/Sources/NfcPlugin.swift
Normal file
@@ -0,0 +1,523 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
// https://developer.apple.com/documentation/corenfc/building_an_nfc_tag-reader_app
|
||||
|
||||
import CoreNFC
|
||||
import SwiftRs
|
||||
import Tauri
|
||||
import UIKit
|
||||
import WebKit
|
||||
|
||||
enum ScanKind: Decodable {
|
||||
case ndef, tag
|
||||
}
|
||||
|
||||
struct ScanOptions: Decodable {
|
||||
let kind: ScanKind
|
||||
var keepSessionAlive: Bool?
|
||||
var message: String?
|
||||
var successMessage: String?
|
||||
}
|
||||
|
||||
struct NDEFRecord: Decodable {
|
||||
var format: UInt8?
|
||||
var kind: [UInt8]?
|
||||
var identifier: [UInt8]?
|
||||
var payload: [UInt8]?
|
||||
}
|
||||
|
||||
struct WriteOptions: Decodable {
|
||||
var kind: ScanKind?
|
||||
let records: [NDEFRecord]
|
||||
var message: String?
|
||||
var successMessage: String?
|
||||
var successfulReadMessage: String?
|
||||
}
|
||||
|
||||
enum TagProcessMode {
|
||||
case write(message: NFCNDEFMessage)
|
||||
case read
|
||||
}
|
||||
|
||||
class Session {
|
||||
let nfcSession: NFCReaderSession?
|
||||
let invoke: Invoke
|
||||
var keepAlive: Bool
|
||||
let tagProcessMode: TagProcessMode
|
||||
var tagStatus: NFCNDEFStatus?
|
||||
var tag: NFCNDEFTag?
|
||||
let successfulReadMessage: String?
|
||||
let successfulWriteAlertMessage: String?
|
||||
|
||||
init(
|
||||
nfcSession: NFCReaderSession?,
|
||||
invoke: Invoke,
|
||||
keepAlive: Bool,
|
||||
tagProcessMode: TagProcessMode,
|
||||
successfulReadMessage: String?,
|
||||
successfulWriteAlertMessage: String?
|
||||
) {
|
||||
self.nfcSession = nfcSession
|
||||
self.invoke = invoke
|
||||
self.keepAlive = keepAlive
|
||||
self.tagProcessMode = tagProcessMode
|
||||
self.successfulReadMessage = successfulReadMessage
|
||||
self.successfulWriteAlertMessage = successfulWriteAlertMessage
|
||||
}
|
||||
}
|
||||
|
||||
class NfcStatus {
|
||||
let available: Bool
|
||||
let errorReason: String?
|
||||
|
||||
init(available: Bool, errorReason: String?) {
|
||||
self.available = available
|
||||
self.errorReason = errorReason
|
||||
}
|
||||
}
|
||||
|
||||
class NfcPlugin: Plugin, NFCTagReaderSessionDelegate, NFCNDEFReaderSessionDelegate {
|
||||
var session: Session?
|
||||
var status: NfcStatus!
|
||||
|
||||
public override func load(webview: WKWebView) {
|
||||
var available = false
|
||||
var errorReason: String?
|
||||
|
||||
let entry = Bundle.main.infoDictionary?["NFCReaderUsageDescription"] as? String
|
||||
|
||||
if entry == nil || entry?.count == 0 {
|
||||
errorReason = "missing NFCReaderUsageDescription configuration on the Info.plist file"
|
||||
} else if !NFCNDEFReaderSession.readingAvailable {
|
||||
errorReason =
|
||||
"NFC tag reading unavailable, make sure the Near-Field Communication capability on Xcode is enabled and the device supports NFC tag reading"
|
||||
} else {
|
||||
available = true
|
||||
}
|
||||
|
||||
if let error = errorReason {
|
||||
Logger.error("\(error)")
|
||||
}
|
||||
|
||||
self.status = NfcStatus(available: available, errorReason: errorReason)
|
||||
}
|
||||
|
||||
func tagReaderSessionDidBecomeActive(
|
||||
_ session: NFCTagReaderSession
|
||||
) {
|
||||
Logger.info("tagReaderSessionDidBecomeActive")
|
||||
}
|
||||
|
||||
func tagReaderSession(_ session: NFCTagReaderSession, didDetect tags: [NFCTag]) {
|
||||
let tag = tags.first!
|
||||
|
||||
session.connect(
|
||||
to: tag,
|
||||
completionHandler: { [self] (error) in
|
||||
if let error = error {
|
||||
self.closeSession(session, error: "cannot connect to tag: \(error)")
|
||||
|
||||
} else {
|
||||
let ndefTag: NFCNDEFTag
|
||||
switch tag {
|
||||
case let .feliCa(tag):
|
||||
ndefTag = tag as NFCNDEFTag
|
||||
break
|
||||
case let .miFare(tag):
|
||||
ndefTag = tag as NFCNDEFTag
|
||||
break
|
||||
case let .iso15693(tag):
|
||||
ndefTag = tag as NFCNDEFTag
|
||||
break
|
||||
case let .iso7816(tag):
|
||||
ndefTag = tag as NFCNDEFTag
|
||||
break
|
||||
default:
|
||||
return
|
||||
}
|
||||
|
||||
self.processTag(
|
||||
session: session, tag: ndefTag, metadata: tagMetadata(tag),
|
||||
mode: self.session!.tagProcessMode)
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
|
||||
func tagReaderSession(_ session: NFCTagReaderSession, didInvalidateWithError error: Error) {
|
||||
Logger.error("Tag reader session error \(error)")
|
||||
self.session?.invoke.reject("session invalidated with error: \(error)")
|
||||
self.session = nil
|
||||
}
|
||||
|
||||
func readerSession(_ session: NFCNDEFReaderSession, didDetectNDEFs messages: [NFCNDEFMessage]) {
|
||||
let message = messages.first!
|
||||
// TODO: do we really need this hook?
|
||||
self.session?.invoke.resolve(["records": ndefMessageRecords(message)])
|
||||
}
|
||||
|
||||
func readerSession(_ session: NFCNDEFReaderSession, didDetect tags: [NFCNDEFTag]) {
|
||||
let tag = tags.first!
|
||||
|
||||
session.connect(
|
||||
to: tag,
|
||||
completionHandler: { [self] (error) in
|
||||
if let error = error {
|
||||
self.closeSession(session, error: "cannot connect to tag: \(error)")
|
||||
|
||||
} else {
|
||||
var metadata: JsonObject = [:]
|
||||
if tag.isKind(of: NFCFeliCaTag.self) {
|
||||
metadata["kind"] = ["FeliCa"]
|
||||
metadata["id"] = nil
|
||||
} else if let t = tag as? NFCMiFareTag {
|
||||
metadata["kind"] = ["MiFare"]
|
||||
metadata["id"] = byteArrayFromData(t.identifier)
|
||||
} else if let t = tag as? NFCISO15693Tag {
|
||||
metadata["kind"] = ["ISO15693"]
|
||||
metadata["id"] = byteArrayFromData(t.identifier)
|
||||
} else if let t = tag as? NFCISO7816Tag {
|
||||
metadata["kind"] = ["ISO7816Compatible"]
|
||||
metadata["id"] = byteArrayFromData(t.identifier)
|
||||
}
|
||||
|
||||
self.processTag(
|
||||
session: session, tag: tag, metadata: metadata,
|
||||
mode: self.session!.tagProcessMode)
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
}
|
||||
|
||||
func readerSession(_ session: NFCNDEFReaderSession, didInvalidateWithError error: Error) {
|
||||
if (error as NSError).code
|
||||
== NFCReaderError.Code.readerSessionInvalidationErrorFirstNDEFTagRead.rawValue
|
||||
{
|
||||
// not an error because we're using invalidateAfterFirstRead: true
|
||||
Logger.debug("readerSessionInvalidationErrorFirstNDEFTagRead")
|
||||
} else {
|
||||
Logger.error("NDEF reader session error \(error)")
|
||||
self.session?.invoke.reject("session invalidated with error: \(error)")
|
||||
self.session = nil
|
||||
}
|
||||
}
|
||||
|
||||
private func tagMetadata(_ tag: NFCTag) -> JsonObject {
|
||||
var metadata: JsonObject = [:]
|
||||
|
||||
switch tag {
|
||||
case .feliCa:
|
||||
metadata["kind"] = ["FeliCa"]
|
||||
metadata["id"] = []
|
||||
break
|
||||
case let .miFare(tag):
|
||||
metadata["kind"] = ["MiFare"]
|
||||
metadata["id"] = byteArrayFromData(tag.identifier)
|
||||
break
|
||||
case let .iso15693(tag):
|
||||
metadata["kind"] = ["ISO15693"]
|
||||
metadata["id"] = byteArrayFromData(tag.identifier)
|
||||
break
|
||||
case let .iso7816(tag):
|
||||
metadata["kind"] = ["ISO7816Compatible"]
|
||||
metadata["id"] = byteArrayFromData(tag.identifier)
|
||||
break
|
||||
default:
|
||||
metadata["kind"] = ["Unknown"]
|
||||
metadata["id"] = []
|
||||
break
|
||||
}
|
||||
|
||||
return metadata
|
||||
}
|
||||
|
||||
private func closeSession(_ session: NFCReaderSession) {
|
||||
session.invalidate()
|
||||
self.session = nil
|
||||
}
|
||||
|
||||
private func closeSession(_ session: NFCReaderSession, error: String) {
|
||||
session.invalidate(errorMessage: error)
|
||||
self.session = nil
|
||||
}
|
||||
|
||||
private func processTag<T: NFCNDEFTag>(
|
||||
session: NFCReaderSession, tag: T, metadata: JsonObject, mode: TagProcessMode
|
||||
) {
|
||||
tag.queryNDEFStatus(completionHandler: {
|
||||
[self] (status, capacity, error) in
|
||||
if let error = error {
|
||||
self.closeSession(session, error: "cannot connect to tag: \(error)")
|
||||
} else {
|
||||
switch mode {
|
||||
case .write(let message):
|
||||
self.writeNDEFTag(
|
||||
session: session, status: status, tag: tag, message: message,
|
||||
alertMessage: self.session?.successfulWriteAlertMessage)
|
||||
break
|
||||
case .read:
|
||||
if self.session?.keepAlive == true {
|
||||
self.session!.tagStatus = status
|
||||
self.session!.tag = tag
|
||||
}
|
||||
self.readNDEFTag(
|
||||
session: session, status: status, tag: tag, metadata: metadata,
|
||||
alertMessage: self.session?.successfulReadMessage)
|
||||
break
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
private func writeNDEFTag<T: NFCNDEFTag>(
|
||||
session: NFCReaderSession, status: NFCNDEFStatus, tag: T, message: NFCNDEFMessage,
|
||||
alertMessage: String?
|
||||
) {
|
||||
switch status {
|
||||
case .notSupported:
|
||||
self.closeSession(session, error: "Tag is not an NDEF-formatted tag")
|
||||
break
|
||||
case .readOnly:
|
||||
self.closeSession(session, error: "Read only tag")
|
||||
break
|
||||
case .readWrite:
|
||||
if let currentSession = self.session {
|
||||
tag.writeNDEF(
|
||||
message,
|
||||
completionHandler: { (error) in
|
||||
if let error = error {
|
||||
self.closeSession(session, error: "cannot write to tag: \(error)")
|
||||
} else {
|
||||
if let message = alertMessage {
|
||||
session.alertMessage = message
|
||||
}
|
||||
currentSession.invoke.resolve()
|
||||
|
||||
self.closeSession(session)
|
||||
|
||||
}
|
||||
})
|
||||
}
|
||||
break
|
||||
default:
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
private func readNDEFTag<T: NFCNDEFTag>(
|
||||
session: NFCReaderSession, status: NFCNDEFStatus, tag: T, metadata m: JsonObject,
|
||||
alertMessage: String?
|
||||
) {
|
||||
var metadata: JsonObject = [:]
|
||||
metadata.merge(m) { (_, new) in new }
|
||||
|
||||
switch status {
|
||||
case .notSupported:
|
||||
self.resolveInvoke(message: nil, metadata: metadata)
|
||||
self.closeSession(session)
|
||||
return
|
||||
case .readOnly:
|
||||
metadata["readOnly"] = true
|
||||
break
|
||||
case .readWrite:
|
||||
metadata["readOnly"] = false
|
||||
break
|
||||
default:
|
||||
break
|
||||
}
|
||||
|
||||
tag.readNDEF(completionHandler: {
|
||||
[self] (message, error) in
|
||||
if let error = error {
|
||||
let code = (error as NSError).code
|
||||
if code != 403 {
|
||||
self.closeSession(session, error: "Failed to read: \(error)")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
if let message = alertMessage {
|
||||
session.alertMessage = message
|
||||
}
|
||||
self.resolveInvoke(message: message, metadata: metadata)
|
||||
|
||||
if self.session?.keepAlive != true {
|
||||
self.closeSession(session)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
private func resolveInvoke(message: NFCNDEFMessage?, metadata: JsonObject) {
|
||||
var data: JsonObject = [:]
|
||||
|
||||
data.merge(metadata) { (_, new) in new }
|
||||
|
||||
if let message = message {
|
||||
data["records"] = ndefMessageRecords(message)
|
||||
} else {
|
||||
data["records"] = []
|
||||
}
|
||||
|
||||
self.session?.invoke.resolve(data)
|
||||
}
|
||||
|
||||
private func ndefMessageRecords(_ message: NFCNDEFMessage) -> [JsonObject] {
|
||||
var records: [JsonObject] = []
|
||||
for record in message.records {
|
||||
var recordJson: JsonObject = [:]
|
||||
recordJson["tnf"] = record.typeNameFormat.rawValue
|
||||
recordJson["kind"] = byteArrayFromData(record.type)
|
||||
recordJson["id"] = byteArrayFromData(record.identifier)
|
||||
recordJson["payload"] = byteArrayFromData(record.payload)
|
||||
|
||||
records.append(recordJson)
|
||||
}
|
||||
|
||||
return records
|
||||
}
|
||||
|
||||
private func byteArrayFromData(_ data: Data) -> [UInt8] {
|
||||
var arr: [UInt8] = []
|
||||
for b in data {
|
||||
arr.append(b)
|
||||
}
|
||||
return arr
|
||||
}
|
||||
|
||||
private func dataFromByteArray(_ array: [UInt8]) -> Data {
|
||||
var data = Data(capacity: array.count)
|
||||
|
||||
data.append(contentsOf: array)
|
||||
|
||||
return data
|
||||
}
|
||||
|
||||
@objc func isAvailable(_ invoke: Invoke) {
|
||||
invoke.resolve([
|
||||
"available": self.status.available
|
||||
])
|
||||
}
|
||||
|
||||
@objc public func write(_ invoke: Invoke) throws {
|
||||
if !self.status.available {
|
||||
invoke.reject("NFC reading unavailable: \(self.status.errorReason ?? "")")
|
||||
return
|
||||
}
|
||||
|
||||
let args = try invoke.parseArgs(WriteOptions.self)
|
||||
|
||||
var ndefPayloads = [NFCNDEFPayload]()
|
||||
|
||||
for record in args.records {
|
||||
ndefPayloads.append(
|
||||
NFCNDEFPayload(
|
||||
format: NFCTypeNameFormat(rawValue: record.format ?? 0) ?? .unknown,
|
||||
type: dataFromByteArray(record.kind ?? []),
|
||||
identifier: dataFromByteArray(record.identifier ?? []),
|
||||
payload: dataFromByteArray(record.payload ?? [])
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
if let session = self.session {
|
||||
if let nfcSession = session.nfcSession, let tagStatus = session.tagStatus,
|
||||
let tag = session.tag
|
||||
{
|
||||
session.keepAlive = false
|
||||
self.writeNDEFTag(
|
||||
session: nfcSession, status: tagStatus, tag: tag,
|
||||
message: NFCNDEFMessage(records: ndefPayloads),
|
||||
alertMessage: args.successMessage
|
||||
)
|
||||
} else {
|
||||
invoke.reject(
|
||||
"connected tag not found, please wait for it to be available and then call write()")
|
||||
}
|
||||
} else {
|
||||
self.startScanSession(
|
||||
invoke: invoke,
|
||||
kind: args.kind ?? .ndef,
|
||||
keepAlive: true,
|
||||
invalidateAfterFirstRead: false,
|
||||
tagProcessMode: .write(
|
||||
message: NFCNDEFMessage(records: ndefPayloads)
|
||||
),
|
||||
alertMessage: args.message,
|
||||
successfulReadMessage: args.successfulReadMessage,
|
||||
successfulWriteAlertMessage: args.successMessage
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@objc public func scan(_ invoke: Invoke) throws {
|
||||
if !self.status.available {
|
||||
invoke.reject("NFC reading unavailable: \(self.status.errorReason ?? "")")
|
||||
return
|
||||
}
|
||||
|
||||
let args = try invoke.parseArgs(ScanOptions.self)
|
||||
|
||||
self.startScanSession(
|
||||
invoke: invoke,
|
||||
kind: args.kind,
|
||||
keepAlive: args.keepSessionAlive ?? false,
|
||||
invalidateAfterFirstRead: true,
|
||||
tagProcessMode: .read,
|
||||
alertMessage: args.message,
|
||||
successfulReadMessage: args.successMessage,
|
||||
successfulWriteAlertMessage: nil
|
||||
)
|
||||
}
|
||||
|
||||
private func startScanSession(
|
||||
invoke: Invoke,
|
||||
kind: ScanKind,
|
||||
keepAlive: Bool,
|
||||
invalidateAfterFirstRead: Bool,
|
||||
tagProcessMode: TagProcessMode,
|
||||
alertMessage: String?,
|
||||
successfulReadMessage: String?,
|
||||
successfulWriteAlertMessage: String?
|
||||
) {
|
||||
let nfcSession: NFCReaderSession?
|
||||
|
||||
switch kind {
|
||||
case .tag:
|
||||
nfcSession = NFCTagReaderSession(
|
||||
pollingOption: [.iso14443, .iso15693],
|
||||
delegate: self,
|
||||
queue: DispatchQueue.main
|
||||
)
|
||||
break
|
||||
case .ndef:
|
||||
nfcSession = NFCNDEFReaderSession(
|
||||
delegate: self,
|
||||
queue: DispatchQueue.main,
|
||||
invalidateAfterFirstRead: invalidateAfterFirstRead
|
||||
)
|
||||
break
|
||||
}
|
||||
|
||||
if let message = alertMessage {
|
||||
nfcSession?.alertMessage = message
|
||||
}
|
||||
nfcSession?.begin()
|
||||
|
||||
self.session = Session(
|
||||
nfcSession: nfcSession,
|
||||
invoke: invoke,
|
||||
keepAlive: keepAlive,
|
||||
tagProcessMode: tagProcessMode,
|
||||
successfulReadMessage: successfulReadMessage,
|
||||
successfulWriteAlertMessage: successfulWriteAlertMessage
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@_cdecl("init_plugin_nfc")
|
||||
func initPlugin() -> Plugin {
|
||||
return NfcPlugin()
|
||||
}
|
||||
12
plugins/nfc/ios/Tests/PluginTests/PluginTests.swift
Normal file
12
plugins/nfc/ios/Tests/PluginTests/PluginTests.swift
Normal file
@@ -0,0 +1,12 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
import XCTest
|
||||
@testable import ExamplePlugin
|
||||
|
||||
final class ExamplePluginTests: XCTestCase {
|
||||
func testExample() throws {
|
||||
let plugin = ExamplePlugin()
|
||||
}
|
||||
}
|
||||
30
plugins/nfc/package.json
Normal file
30
plugins/nfc/package.json
Normal file
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"name": "@tauri-apps/plugin-nfc",
|
||||
"version": "2.3.6",
|
||||
"license": "MIT OR Apache-2.0",
|
||||
"authors": [
|
||||
"Tauri Programme within The Commons Conservancy"
|
||||
],
|
||||
"repository": "https://github.com/tauri-apps/plugins-workspace",
|
||||
"type": "module",
|
||||
"types": "./dist-js/index.d.ts",
|
||||
"main": "./dist-js/index.cjs",
|
||||
"module": "./dist-js/index.js",
|
||||
"exports": {
|
||||
"types": "./dist-js/index.d.ts",
|
||||
"import": "./dist-js/index.js",
|
||||
"require": "./dist-js/index.cjs"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "rollup -c"
|
||||
},
|
||||
"files": [
|
||||
"dist-js",
|
||||
"!dist-js/**/*.map",
|
||||
"README.md",
|
||||
"LICENSE"
|
||||
],
|
||||
"dependencies": {
|
||||
"@tauri-apps/api": "^2.11.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
# Automatically generated - DO NOT EDIT!
|
||||
|
||||
"$schema" = "../../schemas/schema.json"
|
||||
|
||||
[[permission]]
|
||||
identifier = "allow-is-available"
|
||||
description = "Enables the is_available command without any pre-configured scope."
|
||||
commands.allow = ["is_available"]
|
||||
|
||||
[[permission]]
|
||||
identifier = "deny-is-available"
|
||||
description = "Denies the is_available command without any pre-configured scope."
|
||||
commands.deny = ["is_available"]
|
||||
13
plugins/nfc/permissions/autogenerated/commands/scan.toml
Normal file
13
plugins/nfc/permissions/autogenerated/commands/scan.toml
Normal file
@@ -0,0 +1,13 @@
|
||||
# Automatically generated - DO NOT EDIT!
|
||||
|
||||
"$schema" = "../../schemas/schema.json"
|
||||
|
||||
[[permission]]
|
||||
identifier = "allow-scan"
|
||||
description = "Enables the scan command without any pre-configured scope."
|
||||
commands.allow = ["scan"]
|
||||
|
||||
[[permission]]
|
||||
identifier = "deny-scan"
|
||||
description = "Denies the scan command without any pre-configured scope."
|
||||
commands.deny = ["scan"]
|
||||
13
plugins/nfc/permissions/autogenerated/commands/write.toml
Normal file
13
plugins/nfc/permissions/autogenerated/commands/write.toml
Normal file
@@ -0,0 +1,13 @@
|
||||
# Automatically generated - DO NOT EDIT!
|
||||
|
||||
"$schema" = "../../schemas/schema.json"
|
||||
|
||||
[[permission]]
|
||||
identifier = "allow-write"
|
||||
description = "Enables the write command without any pre-configured scope."
|
||||
commands.allow = ["write"]
|
||||
|
||||
[[permission]]
|
||||
identifier = "deny-write"
|
||||
description = "Denies the write command without any pre-configured scope."
|
||||
commands.deny = ["write"]
|
||||
103
plugins/nfc/permissions/autogenerated/reference.md
Normal file
103
plugins/nfc/permissions/autogenerated/reference.md
Normal file
@@ -0,0 +1,103 @@
|
||||
## Default Permission
|
||||
|
||||
This permission set configures what kind of
|
||||
operations are available from the nfc plugin.
|
||||
|
||||
#### Granted Permissions
|
||||
|
||||
Checking if the NFC functionality is available
|
||||
and scanning nearby tags is allowed.
|
||||
Writing to tags needs to be manually enabled.
|
||||
|
||||
#### This default permission set includes the following:
|
||||
|
||||
- `allow-is-available`
|
||||
- `allow-scan`
|
||||
|
||||
## Permission Table
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Identifier</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:allow-is-available`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Enables the is_available command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:deny-is-available`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Denies the is_available command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:allow-scan`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Enables the scan command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:deny-scan`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Denies the scan command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:allow-write`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Enables the write command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
`nfc:deny-write`
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Denies the write command without any pre-configured scope.
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
15
plugins/nfc/permissions/default.toml
Normal file
15
plugins/nfc/permissions/default.toml
Normal file
@@ -0,0 +1,15 @@
|
||||
"$schema" = "schemas/schema.json"
|
||||
|
||||
[default]
|
||||
description = """
|
||||
This permission set configures what kind of
|
||||
operations are available from the nfc plugin.
|
||||
|
||||
#### Granted Permissions
|
||||
|
||||
Checking if the NFC functionality is available
|
||||
and scanning nearby tags is allowed.
|
||||
Writing to tags needs to be manually enabled.
|
||||
|
||||
"""
|
||||
permissions = ["allow-is-available", "allow-scan"]
|
||||
342
plugins/nfc/permissions/schemas/schema.json
Normal file
342
plugins/nfc/permissions/schemas/schema.json
Normal file
@@ -0,0 +1,342 @@
|
||||
{
|
||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||||
"title": "PermissionFile",
|
||||
"description": "Permission file that can define a default permission, a set of permissions or a list of inlined permissions.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"default": {
|
||||
"description": "The default permission set for the plugin",
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/definitions/DefaultPermission"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
]
|
||||
},
|
||||
"set": {
|
||||
"description": "A list of permissions sets defined",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/PermissionSet"
|
||||
}
|
||||
},
|
||||
"permission": {
|
||||
"description": "A list of inlined permissions",
|
||||
"default": [],
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Permission"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"DefaultPermission": {
|
||||
"description": "The default permission set of the plugin.\n\nWorks similarly to a permission with the \"default\" identifier.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"permissions"
|
||||
],
|
||||
"properties": {
|
||||
"version": {
|
||||
"description": "The version of the permission.",
|
||||
"type": [
|
||||
"integer",
|
||||
"null"
|
||||
],
|
||||
"format": "uint64",
|
||||
"minimum": 1.0
|
||||
},
|
||||
"description": {
|
||||
"description": "Human-readable description of what the permission does. Tauri convention is to use `<h4>` headings in markdown content for Tauri documentation generation purposes.",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"permissions": {
|
||||
"description": "All permissions this set contains.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"PermissionSet": {
|
||||
"description": "A set of direct permissions grouped together under a new name.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"description",
|
||||
"identifier",
|
||||
"permissions"
|
||||
],
|
||||
"properties": {
|
||||
"identifier": {
|
||||
"description": "A unique identifier for the permission.",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "Human-readable description of what the permission does.",
|
||||
"type": "string"
|
||||
},
|
||||
"permissions": {
|
||||
"description": "All permissions this set contains.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/PermissionKind"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Permission": {
|
||||
"description": "Descriptions of explicit privileges of commands.\n\nIt can enable commands to be accessible in the frontend of the application.\n\nIf the scope is defined it can be used to fine grain control the access of individual or multiple commands.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"identifier"
|
||||
],
|
||||
"properties": {
|
||||
"version": {
|
||||
"description": "The version of the permission.",
|
||||
"type": [
|
||||
"integer",
|
||||
"null"
|
||||
],
|
||||
"format": "uint64",
|
||||
"minimum": 1.0
|
||||
},
|
||||
"identifier": {
|
||||
"description": "A unique identifier for the permission.",
|
||||
"type": "string"
|
||||
},
|
||||
"description": {
|
||||
"description": "Human-readable description of what the permission does. Tauri internal convention is to use `<h4>` headings in markdown content for Tauri documentation generation purposes.",
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"commands": {
|
||||
"description": "Allowed or denied commands when using this permission.",
|
||||
"default": {
|
||||
"allow": [],
|
||||
"deny": []
|
||||
},
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Commands"
|
||||
}
|
||||
]
|
||||
},
|
||||
"scope": {
|
||||
"description": "Allowed or denied scoped when using this permission.",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Scopes"
|
||||
}
|
||||
]
|
||||
},
|
||||
"platforms": {
|
||||
"description": "Target platforms this permission applies. By default all platforms are affected by this permission.",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"items": {
|
||||
"$ref": "#/definitions/Target"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Commands": {
|
||||
"description": "Allowed and denied commands inside a permission.\n\nIf two commands clash inside of `allow` and `deny`, it should be denied by default.",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"allow": {
|
||||
"description": "Allowed command.",
|
||||
"default": [],
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"deny": {
|
||||
"description": "Denied command, which takes priority.",
|
||||
"default": [],
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Scopes": {
|
||||
"description": "An argument for fine grained behavior control of Tauri commands.\n\nIt can be of any serde serializable type and is used to allow or prevent certain actions inside a Tauri command. The configured scope is passed to the command and will be enforced by the command implementation.\n\n## Example\n\n```json { \"allow\": [{ \"path\": \"$HOME/**\" }], \"deny\": [{ \"path\": \"$HOME/secret.txt\" }] } ```",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"allow": {
|
||||
"description": "Data that defines what is allowed by the scope.",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"items": {
|
||||
"$ref": "#/definitions/Value"
|
||||
}
|
||||
},
|
||||
"deny": {
|
||||
"description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.",
|
||||
"type": [
|
||||
"array",
|
||||
"null"
|
||||
],
|
||||
"items": {
|
||||
"$ref": "#/definitions/Value"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Value": {
|
||||
"description": "All supported ACL values.",
|
||||
"anyOf": [
|
||||
{
|
||||
"description": "Represents a null JSON value.",
|
||||
"type": "null"
|
||||
},
|
||||
{
|
||||
"description": "Represents a [`bool`].",
|
||||
"type": "boolean"
|
||||
},
|
||||
{
|
||||
"description": "Represents a valid ACL [`Number`].",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/Number"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Represents a [`String`].",
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"description": "Represents a list of other [`Value`]s.",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Value"
|
||||
}
|
||||
},
|
||||
{
|
||||
"description": "Represents a map of [`String`] keys to [`Value`]s.",
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/definitions/Value"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"Number": {
|
||||
"description": "A valid ACL number.",
|
||||
"anyOf": [
|
||||
{
|
||||
"description": "Represents an [`i64`].",
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
{
|
||||
"description": "Represents a [`f64`].",
|
||||
"type": "number",
|
||||
"format": "double"
|
||||
}
|
||||
]
|
||||
},
|
||||
"Target": {
|
||||
"description": "Platform target.",
|
||||
"oneOf": [
|
||||
{
|
||||
"description": "MacOS.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"macOS"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Windows.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"windows"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Linux.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"linux"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Android.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"android"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "iOS.",
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"iOS"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"PermissionKind": {
|
||||
"type": "string",
|
||||
"oneOf": [
|
||||
{
|
||||
"description": "Enables the is_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-is-available",
|
||||
"markdownDescription": "Enables the is_available command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the is_available command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-is-available",
|
||||
"markdownDescription": "Denies the is_available command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the scan command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-scan",
|
||||
"markdownDescription": "Enables the scan command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the scan command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-scan",
|
||||
"markdownDescription": "Denies the scan command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Enables the write command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "allow-write",
|
||||
"markdownDescription": "Enables the write command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "Denies the write command without any pre-configured scope.",
|
||||
"type": "string",
|
||||
"const": "deny-write",
|
||||
"markdownDescription": "Denies the write command without any pre-configured scope."
|
||||
},
|
||||
{
|
||||
"description": "This permission set configures what kind of\noperations are available from the nfc plugin.\n\n#### Granted Permissions\n\nChecking if the NFC functionality is available\nand scanning nearby tags is allowed.\nWriting to tags needs to be manually enabled.\n\n\n#### This default permission set includes:\n\n- `allow-is-available`\n- `allow-scan`",
|
||||
"type": "string",
|
||||
"const": "default",
|
||||
"markdownDescription": "This permission set configures what kind of\noperations are available from the nfc plugin.\n\n#### Granted Permissions\n\nChecking if the NFC functionality is available\nand scanning nearby tags is allowed.\nWriting to tags needs to be manually enabled.\n\n\n#### This default permission set includes:\n\n- `allow-is-available`\n- `allow-scan`"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
7
plugins/nfc/rollup.config.js
Normal file
7
plugins/nfc/rollup.config.js
Normal file
@@ -0,0 +1,7 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
import { createConfig } from '../../shared/rollup.config.js'
|
||||
|
||||
export default createConfig()
|
||||
34
plugins/nfc/src/error.rs
Normal file
34
plugins/nfc/src/error.rs
Normal file
@@ -0,0 +1,34 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use serde::{ser::Serializer, Serialize};
|
||||
|
||||
/// Alias for a [`std::result::Result`] with the error type [`Error`].
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
/// Errors returned by the NFC plugin.
|
||||
///
|
||||
/// Serializes to the error message string, so it can be returned directly from a command.
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
pub enum Error {
|
||||
/// An I/O error happened.
|
||||
#[error(transparent)]
|
||||
Io(#[from] std::io::Error),
|
||||
/// The call to the Android or iOS plugin implementation failed,
|
||||
/// either because the arguments could not be serialized, the response could not be
|
||||
/// deserialized or the native side rejected the call (e.g. NFC is unavailable
|
||||
/// or the tag could not be read or written).
|
||||
#[cfg(mobile)]
|
||||
#[error(transparent)]
|
||||
PluginInvoke(#[from] tauri::plugin::mobile::PluginInvokeError),
|
||||
}
|
||||
|
||||
impl Serialize for Error {
|
||||
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
serializer.serialize_str(self.to_string().as_ref())
|
||||
}
|
||||
}
|
||||
122
plugins/nfc/src/lib.rs
Normal file
122
plugins/nfc/src/lib.rs
Normal file
@@ -0,0 +1,122 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
//! Read and write NFC tags on Android and iOS.
|
||||
//!
|
||||
//! This plugin is mobile only: the whole crate is gated behind `#[cfg(mobile)]`,
|
||||
//! so it expands to nothing when compiling for Linux, macOS or Windows.
|
||||
//!
|
||||
//! Register the plugin with `init` and use the `NfcExt` trait to reach the
|
||||
//! `Nfc` instance from any `tauri::Manager` implementation (the app handle, a window, ...).
|
||||
|
||||
#![cfg(mobile)]
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tauri::{
|
||||
plugin::{Builder, PluginHandle, TauriPlugin},
|
||||
Manager, Runtime,
|
||||
};
|
||||
|
||||
pub use models::*;
|
||||
|
||||
mod error;
|
||||
mod models;
|
||||
|
||||
pub use error::{Error, Result};
|
||||
|
||||
#[cfg(target_os = "android")]
|
||||
const PLUGIN_IDENTIFIER: &str = "app.tauri.nfc";
|
||||
|
||||
#[cfg(target_os = "ios")]
|
||||
tauri::ios_plugin_binding!(init_plugin_nfc);
|
||||
|
||||
/// Access to the nfc APIs.
|
||||
pub struct Nfc<R: Runtime>(PluginHandle<R>);
|
||||
|
||||
#[derive(Deserialize)]
|
||||
struct IsAvailableResponse {
|
||||
available: bool,
|
||||
}
|
||||
|
||||
#[derive(Serialize)]
|
||||
struct WriteRequest {
|
||||
records: Vec<NfcRecord>,
|
||||
}
|
||||
|
||||
impl<R: Runtime> Nfc<R> {
|
||||
/// Checks whether NFC is supported by the device and currently usable by the app.
|
||||
///
|
||||
/// On Android this is `false` when the device has no NFC adapter or when NFC is
|
||||
/// disabled in the device settings.
|
||||
/// On iOS this is `false` when the `NFCReaderUsageDescription` entry is missing from the
|
||||
/// `Info.plist` file or when NFC tag reading is not available on the device.
|
||||
pub fn is_available(&self) -> crate::Result<bool> {
|
||||
self.0
|
||||
.run_mobile_plugin::<IsAvailableResponse>("isAvailable", ())
|
||||
.map(|r| r.available)
|
||||
.map_err(Into::into)
|
||||
}
|
||||
|
||||
/// Scans an NFC tag, blocking until a tag matching the given [`ScanRequest::kind`] filters
|
||||
/// is read or the scan fails.
|
||||
///
|
||||
/// Set [`ScanRequest::keep_session_alive`] to `true` to keep the connection to the tag open
|
||||
/// after it has been scanned, so that a following [`Self::write`] call writes to that tag.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns an error when NFC is not available (see [`Self::is_available`])
|
||||
/// or when the tag could not be read.
|
||||
pub fn scan(&self, payload: ScanRequest) -> crate::Result<ScanResponse> {
|
||||
self.0
|
||||
.run_mobile_plugin("scan", payload)
|
||||
.map(|v| ScanResponse { tag: v })
|
||||
.map_err(Into::into)
|
||||
}
|
||||
|
||||
/// Writes the given NDEF records to an NFC tag, blocking until the write completes or fails.
|
||||
///
|
||||
/// Because this API does not take a scan kind, on Android it can only write to the tag of an
|
||||
/// ongoing session, so it must be preceded by a [`Self::scan`] call with
|
||||
/// [`ScanRequest::keep_session_alive`] set to `true`.
|
||||
/// On iOS an NDEF reader session is started when there is no ongoing session, and the
|
||||
/// records are written to the first tag that is scanned.
|
||||
///
|
||||
/// # Errors
|
||||
///
|
||||
/// Returns an error when NFC is not available (see [`Self::is_available`]), when there is no
|
||||
/// connected tag on Android, when the tag is read-only, when it cannot hold the message or
|
||||
/// when it does not support the NDEF format.
|
||||
pub fn write(&self, records: Vec<NfcRecord>) -> crate::Result<()> {
|
||||
self.0
|
||||
.run_mobile_plugin("write", WriteRequest { records })
|
||||
.map_err(Into::into)
|
||||
}
|
||||
}
|
||||
|
||||
/// Extensions to [`tauri::App`], [`tauri::AppHandle`], [`tauri::WebviewWindow`], [`tauri::Webview`] and [`tauri::Window`] to access the NFC APIs.
|
||||
pub trait NfcExt<R: Runtime> {
|
||||
/// Returns the [`Nfc`] instance managed by the plugin.
|
||||
fn nfc(&self) -> &Nfc<R>;
|
||||
}
|
||||
|
||||
impl<R: Runtime, T: Manager<R>> crate::NfcExt<R> for T {
|
||||
fn nfc(&self) -> &Nfc<R> {
|
||||
self.state::<Nfc<R>>().inner()
|
||||
}
|
||||
}
|
||||
|
||||
/// Initializes the plugin.
|
||||
pub fn init<R: Runtime>() -> TauriPlugin<R> {
|
||||
Builder::new("nfc")
|
||||
.setup(|app, api| {
|
||||
#[cfg(target_os = "android")]
|
||||
let handle = api.register_android_plugin(PLUGIN_IDENTIFIER, "NfcPlugin")?;
|
||||
#[cfg(target_os = "ios")]
|
||||
let handle = api.register_ios_plugin(init_plugin_nfc)?;
|
||||
app.manage(Nfc(handle));
|
||||
Ok(())
|
||||
})
|
||||
.build()
|
||||
}
|
||||
11
plugins/nfc/src/mobile.rs
Normal file
11
plugins/nfc/src/mobile.rs
Normal file
@@ -0,0 +1,11 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use serde::de::DeserializeOwned;
|
||||
use tauri::{
|
||||
plugin::{PluginApi, PluginHandle},
|
||||
AppHandle, Runtime,
|
||||
};
|
||||
|
||||
use crate::models::*;
|
||||
195
plugins/nfc/src/models.rs
Normal file
195
plugins/nfc/src/models.rs
Normal file
@@ -0,0 +1,195 @@
|
||||
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
use serde::{Deserialize, Serialize, Serializer};
|
||||
use std::fmt::Display;
|
||||
|
||||
/// Arguments of the [`Nfc::scan`](crate::Nfc::scan) API.
|
||||
#[derive(Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct ScanRequest {
|
||||
/// The kind of scan to perform, which defines how tags are matched.
|
||||
pub kind: ScanKind,
|
||||
/// Whether the connection to the scanned tag must be kept open after the scan resolves.
|
||||
///
|
||||
/// When `true`, a following [`Nfc::write`](crate::Nfc::write) call writes to the tag that was
|
||||
/// scanned instead of starting a new session.
|
||||
pub keep_session_alive: bool,
|
||||
}
|
||||
|
||||
/// An NDEF record to be written to a tag.
|
||||
///
|
||||
/// Use [`NFCTypeNameFormat`] to describe how [`Self::kind`] must be interpreted.
|
||||
#[derive(Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct NfcRecord {
|
||||
/// The Type Name Format (TNF) of the record.
|
||||
pub format: NFCTypeNameFormat,
|
||||
/// The record type, interpreted according to [`Self::format`].
|
||||
///
|
||||
/// For [`NFCTypeNameFormat::NfcWellKnown`] records this is a Record Type Definition (RTD)
|
||||
/// value such as `[0x54]` (`RTD_TEXT`) or `[0x55]` (`RTD_URI`).
|
||||
pub kind: Vec<u8>,
|
||||
/// The record identifier. Can be empty.
|
||||
pub id: Vec<u8>,
|
||||
/// The record payload bytes.
|
||||
pub payload: Vec<u8>,
|
||||
}
|
||||
|
||||
/// The Type Name Format (TNF) of an NDEF record, which defines how the record type is interpreted.
|
||||
///
|
||||
/// Serialized as its numeric value.
|
||||
#[derive(serde_repr::Deserialize_repr, serde_repr::Serialize_repr)]
|
||||
#[repr(u8)]
|
||||
pub enum NFCTypeNameFormat {
|
||||
/// The record is empty: type, identifier and payload must be empty.
|
||||
Empty = 0,
|
||||
/// The record type is an NFC Forum well known type, defined by a Record Type Definition (RTD)
|
||||
/// such as `RTD_TEXT` (`[0x54]`) or `RTD_URI` (`[0x55]`).
|
||||
NfcWellKnown = 1,
|
||||
/// The record type is a MIME media type as defined in RFC 2046, e.g. `text/plain`.
|
||||
Media = 2,
|
||||
/// The record type is an absolute URI as defined in RFC 3986.
|
||||
AbsoluteURI = 3,
|
||||
/// The record type is an NFC Forum external type, i.e. a type namespaced by its issuer.
|
||||
NfcExternal = 4,
|
||||
/// The record type is unknown: the type must be empty and the payload interpretation is
|
||||
/// left to the application.
|
||||
Unknown = 5,
|
||||
/// The record is a middle or last chunk of a chunked record and inherits the type of the
|
||||
/// first chunk, so its own type must be empty.
|
||||
Unchanged = 6,
|
||||
}
|
||||
|
||||
/// An NDEF record read from a scanned tag.
|
||||
#[derive(Deserialize)]
|
||||
pub struct NfcTagRecord {
|
||||
/// The Type Name Format (TNF) of the record, which defines how [`Self::kind`] is interpreted.
|
||||
pub tnf: NFCTypeNameFormat,
|
||||
/// The record type bytes.
|
||||
pub kind: Vec<u8>,
|
||||
/// The record identifier bytes. Can be empty.
|
||||
pub id: Vec<u8>,
|
||||
/// The record payload bytes.
|
||||
pub payload: Vec<u8>,
|
||||
}
|
||||
|
||||
/// An NFC tag that has been scanned.
|
||||
#[derive(Deserialize)]
|
||||
pub struct NfcTag {
|
||||
/// The tag identifier, as reported by the operating system.
|
||||
pub id: String,
|
||||
/// The technology the tag supports.
|
||||
pub kind: String,
|
||||
/// The NDEF records stored on the tag. Empty when the tag holds no NDEF message.
|
||||
pub records: Vec<NfcTagRecord>,
|
||||
}
|
||||
|
||||
/// Response of the [`Nfc::scan`](crate::Nfc::scan) API.
|
||||
#[derive(Deserialize)]
|
||||
pub struct ScanResponse {
|
||||
/// The tag that has been scanned.
|
||||
pub tag: NfcTag,
|
||||
}
|
||||
|
||||
/// Filters the tags to scan by the URI of their NDEF payload.
|
||||
///
|
||||
/// Every field is optional and only the ones that are set take part in the filter.
|
||||
/// **Android only**: the iOS implementation ignores this filter.
|
||||
#[derive(Debug, Default, Serialize)]
|
||||
pub struct UriFilter {
|
||||
/// Only match URIs with this scheme, e.g. `https`.
|
||||
scheme: Option<String>,
|
||||
/// Only match URIs with this authority (host), e.g. `tauri.app`.
|
||||
host: Option<String>,
|
||||
/// Only match URIs whose path starts with this prefix, e.g. `/docs`.
|
||||
path_prefix: Option<String>,
|
||||
}
|
||||
|
||||
/// The NFC technologies a tag can support, mirroring the `android.nfc.tech` classes.
|
||||
///
|
||||
/// **Android only**. Serialized as the technology name, e.g. `"IsoDep"`.
|
||||
#[derive(Debug)]
|
||||
pub enum TechKind {
|
||||
/// ISO-DEP (ISO 14443-4) properties and I/O operations.
|
||||
IsoDep,
|
||||
/// MIFARE Classic properties and I/O operations.
|
||||
MifareClassic,
|
||||
/// MIFARE Ultralight and MIFARE Ultralight C properties and I/O operations.
|
||||
MifareUltralight,
|
||||
/// NDEF data and operations on tags that are already formatted as NDEF.
|
||||
Ndef,
|
||||
/// Formatting operations on tags that can be formatted as NDEF but are not yet.
|
||||
NdefFormatable,
|
||||
/// NFC-A (ISO 14443-3A) properties and I/O operations.
|
||||
NfcA,
|
||||
/// NFC-B (ISO 14443-3B) properties and I/O operations.
|
||||
NfcB,
|
||||
/// NFC Barcode (Kovio NFC Barcode) properties and I/O operations.
|
||||
NfcBarcode,
|
||||
/// NFC-F (JIS 6319-4) properties and I/O operations.
|
||||
NfcF,
|
||||
/// NFC-V (ISO 15693) properties and I/O operations.
|
||||
NfcV,
|
||||
}
|
||||
|
||||
impl Display for TechKind {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(
|
||||
f,
|
||||
"{}",
|
||||
match self {
|
||||
Self::IsoDep => "IsoDep",
|
||||
Self::MifareClassic => "MifareClassic",
|
||||
Self::MifareUltralight => "MifareUltralight",
|
||||
Self::Ndef => "Ndef",
|
||||
Self::NdefFormatable => "NdefFormatable",
|
||||
Self::NfcA => "NfcA",
|
||||
Self::NfcB => "NfcB",
|
||||
Self::NfcBarcode => "NfcBarcode",
|
||||
Self::NfcF => "NfcF",
|
||||
Self::NfcV => "NfcV",
|
||||
}
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
impl Serialize for TechKind {
|
||||
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
||||
where
|
||||
S: Serializer,
|
||||
{
|
||||
serializer.serialize_str(&self.to_string())
|
||||
}
|
||||
}
|
||||
|
||||
/// The kind of scan to perform, which defines which tags are matched.
|
||||
#[derive(Debug, Serialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub enum ScanKind {
|
||||
/// Only match tags that carry an NDEF message.
|
||||
Ndef {
|
||||
/// Only match tags whose NDEF payload has this MIME type, e.g. `text/plain`.
|
||||
/// **Android only**.
|
||||
mime_type: Option<String>,
|
||||
/// Only match tags whose NDEF payload URI matches this filter. **Android only**.
|
||||
uri: Option<UriFilter>,
|
||||
/// Only match tags supporting the listed technologies.
|
||||
///
|
||||
/// Each tech list is considered independently and the tag matches when any single tech
|
||||
/// list matches it, which provides AND (inside a list) and OR (between lists) semantics.
|
||||
///
|
||||
/// **Android only**. See
|
||||
/// <https://developer.android.com/reference/android/nfc/NfcAdapter#ACTION_TECH_DISCOVERED>
|
||||
/// for more information.
|
||||
tech_list: Option<Vec<Vec<TechKind>>>,
|
||||
},
|
||||
/// Match any tag that is discovered, whether it carries an NDEF message or not.
|
||||
Tag {
|
||||
/// Only match tags whose payload has this MIME type, e.g. `text/plain`. **Android only**.
|
||||
mime_type: Option<String>,
|
||||
/// Only match tags whose payload URI matches this filter. **Android only**.
|
||||
uri: Option<UriFilter>,
|
||||
},
|
||||
}
|
||||
7
plugins/nfc/tsconfig.json
Normal file
7
plugins/nfc/tsconfig.json
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": "../../tsconfig.base.json",
|
||||
"compilerOptions": {
|
||||
"rootDir": "guest-js"
|
||||
},
|
||||
"include": ["guest-js/*.ts"]
|
||||
}
|
||||
Reference in New Issue
Block a user