@octane-xplat/biometrics 0.0.1 → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Alec Larson
+
+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.

package/README.md

@@ -1,3 +1,30 @@
-# @octane-xplat/biometrics
+# `@octane-xplat/biometrics`
 
-Version 0.0.1 is a reservation stub so the automated release can publish this package name. It has no supported API. Use a later release for the implementation.
+Local biometric verification — Face ID / Touch ID / fingerprint or device
+credential — behind one capability object. iOS and Android run
+`@nativescript/biometrics`; web and the macOS AppKit host report
+`supported: false` (WebAuthn is an authentication ceremony, not a
+local-presence check, and the dev host has no LocalAuthentication bridge).
+
+```sh
+pnpm add @octane-xplat/biometrics
+```
+
+```ts
+import { biometrics } from '@octane-xplat/biometrics'
+
+if ((await biometrics.ensure()) === 'granted') {
+	const ok = await biometrics.impl!.verify('Unlock your saved trips')
+}
+```
+
+The shared capability contract: `supported` reports whether an
+implementation exists on this target — branch on it rather than catching —
+`ensure()` resolves `'granted' | 'denied' | 'unsupported'`, and `impl` is
+the service once usable. `verify(reason)` resolves `false` for a declined
+or failed prompt rather than throwing.
+
+Guide: [Using device features](../../docs/platform-services.md);
+per-target availability: [platform notes](../../docs/platform-notes.md).
+Exercised by the harness `Services` screen
+([`packages/app/src/Services.tsrx`](../app/src/Services.tsrx)).

package/package.json

@@ -1,19 +1,69 @@
 {
   "name": "@octane-xplat/biometrics",
-  "version": "0.0.1",
+  "version": "0.9.0",
   "description": "Biometric verification (FaceID/TouchID/fingerprint) for Octane xplat — matching web + NativeScript implementations",
+  "keywords": [
+    "android",
+    "biometrics",
+    "cross-platform",
+    "faceid",
+    "fingerprint",
+    "ios",
+    "nativescript",
+    "octane",
+    "touchid",
+    "web",
+    "xplat"
+  ],
+  "homepage": "https://github.com/octane-xplat/octane-xplat/tree/main/packages/biometrics",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/octane-xplat/octane-xplat.git",
+    "url": "https://github.com/octane-xplat/octane-xplat",
     "directory": "packages/biometrics"
   },
-  "homepage": "https://github.com/octane-xplat/octane-xplat/tree/main/packages/biometrics",
-  "main": "./index.js",
-  "types": "./index.d.ts",
   "files": [
-    "README.md",
-    "index.js",
-    "index.d.ts"
-  ]
-}
+    "src"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "macos": "./src/index.macos.ts",
+      "default": "./src/index.ts"
+    },
+    "./*": "./src/*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nativescript/biometrics": "1.3.1"
+  },
+  "devDependencies": {
+    "@nativescript-community/octane": "0.2.4",
+    "@nativescript/core": "9.1.2",
+    "octane": "0.6.3"
+  },
+  "peerDependencies": {
+    "@nativescript-community/octane": ">=0.2.1 <1",
+    "@nativescript/core": ">=9.1.0 <10",
+    "octane": ">=0.6.3 <1"
+  },
+  "peerDependenciesMeta": {
+    "@nativescript-community/octane": {
+      "optional": true
+    },
+    "@nativescript/core": {
+      "optional": true
+    }
+  },
+  "nativescript": {
+    "platforms": {
+      "android": "9.1.0",
+      "ios": "9.1.0"
+    }
+  },
+  "scripts": {
+    "test:packed": "node tests/packed-consumer.mjs"
+  }
+}

package/src/biometrics.macos.ts

@@ -0,0 +1,9 @@
+// Biometrics — AppKit host leaf. No LocalAuthentication bridge exists on the
+// dev host.
+import type { Capability, BiometricsImpl } from './types'
+
+export const biometrics: Capability<BiometricsImpl> = {
+	supported: false,
+	ensure: async () => 'unsupported',
+	impl: null,
+}

package/src/biometrics.ts

@@ -0,0 +1,24 @@
+// Biometrics — FaceID/TouchID/fingerprint via @nativescript/biometrics.
+import { BiometricAuth } from '@nativescript/biometrics'
+import type { Capability } from './types'
+import type { BiometricsImpl } from './types'
+
+const bio = new BiometricAuth()
+
+export const biometrics: Capability<BiometricsImpl> = {
+	supported: true,
+	async ensure() {
+		const r = await bio.available()
+		return r.any ? 'granted' : 'unsupported'
+	},
+	impl: {
+		async verify(reason) {
+			try {
+				const r = await bio.verifyBiometric({ title: reason })
+				return r.code === 0
+			} catch {
+				return false
+			}
+		},
+	},
+}

package/src/biometrics.web.ts

@@ -0,0 +1,13 @@
+// Biometrics — web leaf. WebAuthn is an authentication ceremony, not a
+// standalone local-presence API: it requires an RP challenge and a registered
+// credential, and may require a user gesture. Do not claim it implements the
+// native verify(reason) contract by creating an ephemeral passkey.
+import type { BiometricsImpl, Capability } from './types'
+
+export const biometrics: Capability<BiometricsImpl> = {
+	supported: false,
+	async ensure() {
+		return 'unsupported'
+	},
+	impl: null,
+}

package/src/index.macos.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export { biometrics } from './biometrics.macos'

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types'
+export { biometrics } from './biometrics'

package/src/types.ts

@@ -0,0 +1,11 @@
+/** Optional capability — never throws for absence (docs/platform-services.md). */
+export interface Capability<T> {
+	supported: boolean
+	ensure(): Promise<'granted' | 'denied' | 'unsupported'>
+	/** usable iff supported && ensured */
+	impl: T | null
+}
+
+export interface BiometricsImpl {
+	verify(reason: string): Promise<boolean>
+}

package/index.d.ts

@@ -1 +0,0 @@
-export {}

package/index.js

@@ -1,2 +0,0 @@
-// Reservation stub; implementation will arrive in a later release.
-module.exports = {}