@symbiote-native/local-auth 0.4.0 → 1.0.0

package/README.md

@@ -3,11 +3,11 @@
 A wrapper package for [SymbioteNative](../../README.md) that makes
 [`expo-local-authentication`](https://github.com/expo/expo/tree/main/packages/expo-local-authentication)
 — FaceID/TouchID on iOS, the Fingerprint/Biometric API on Android — usable from **every**
-adapter, React, Vue, and Angular, not just React. Unlike this repo's other Expo wrapper
+adapter, React, Vue, Svelte, Solid, and Angular, not just React. Unlike this repo's other Expo wrapper
 ([`@symbiote-native/sensors`](../sensors), an `EventEmitter` + live-subscription surface),
 every function here is a one-shot async call with no per-instance state, so there is no hook/
-composable/service to wrap — the React, Vue, and Angular entry points are plain re-exports of
-the same `core`.
+composable/service to wrap — the React, Vue, Svelte, Solid, and Angular entry points are plain
+re-exports of the same `core`.
 
 ## Install
 
@@ -55,9 +55,10 @@ src/core/     hasHardwareAsync / isEnrolledAsync / getEnrolledLevelAsync /
 src/angular/  @symbiote-native/local-auth/angular — export * from '../core'
 ```
 
-`./react`, `./vue`, and `./svelte` are `exports`-map aliases straight onto `src/core/` — no
-physical per-framework file, since there's nothing to subscribe to or clean up. `./angular` stays
-a physical file/subpath since Angular ships through a separate `ngc`/AOT build (`build-ngc/`).
+`./react`, `./vue`, `./svelte`, and `./solid` are `exports`-map aliases straight onto
+`src/core/` — no physical per-framework file, since there's nothing to subscribe to or clean up.
+`./angular` stays a physical file/subpath since Angular ships through a separate `ngc`/AOT build
+(`build-ngc/`).
 
 ## Use it
 
@@ -164,6 +165,108 @@ function handleAuthenticate(): void {
 </template>
 ```
 
+```svelte
+<!-- Svelte -->
+<script lang="ts">
+  import { Platform, Pressable, Text, View } from '@symbiote-native/svelte';
+  import {
+    authenticateAsync,
+    cancelAuthenticate,
+    hasHardwareAsync,
+    isEnrolledAsync,
+  } from '@symbiote-native/local-auth/svelte';
+  import type { ILocalAuthenticationResult } from '@symbiote-native/local-auth/svelte';
+
+  let hasHardware = $state(false);
+  let isEnrolled = $state(false);
+  let authResult = $state<ILocalAuthenticationResult | null>(null);
+
+  $effect(() => {
+    hasHardwareAsync().then(value => (hasHardware = value));
+    isEnrolledAsync().then(value => (isEnrolled = value));
+  });
+
+  function handleAuthenticate(): void {
+    authenticateAsync({ promptMessage: 'Confirm it is you' }).then(value => {
+      authResult = value;
+    });
+  }
+</script>
+
+<View>
+  <Text>
+    {hasHardware && isEnrolled ? 'Ready to authenticate' : 'No biometrics enrolled'}
+  </Text>
+  <Pressable onPress={handleAuthenticate}>
+    <Text>Authenticate</Text>
+  </Pressable>
+  {#if Platform.OS === 'android'}
+    <Pressable onPress={() => cancelAuthenticate()}>
+      <Text>Cancel</Text>
+    </Pressable>
+  {/if}
+  {#if authResult}
+    <Text>{authResult.success ? 'Success' : `Failed: ${authResult.error}`}</Text>
+  {/if}
+</View>
+```
+
+```tsx
+// Solid
+import { Show, createSignal, onMount } from 'solid-js';
+import { Platform, Pressable, Text, View } from '@symbiote-native/solid';
+import {
+  authenticateAsync,
+  cancelAuthenticate,
+  hasHardwareAsync,
+  isEnrolledAsync,
+} from '@symbiote-native/local-auth/solid';
+import type { ILocalAuthenticationResult } from '@symbiote-native/local-auth/solid';
+
+function LocalAuthScreen() {
+  const [hasHardware, setHasHardware] = createSignal(false);
+  const [isEnrolled, setIsEnrolled] = createSignal(false);
+  const [authResult, setAuthResult] =
+    createSignal<ILocalAuthenticationResult | null>(null);
+
+  onMount(() => {
+    void hasHardwareAsync().then(setHasHardware);
+    void isEnrolledAsync().then(setIsEnrolled);
+  });
+
+  const handleAuthenticate = () => {
+    void authenticateAsync({ promptMessage: 'Confirm it is you' }).then(
+      setAuthResult,
+    );
+  };
+
+  return (
+    <View>
+      <Text>
+        {hasHardware() && isEnrolled()
+          ? 'Ready to authenticate'
+          : 'No biometrics enrolled'}
+      </Text>
+      <Pressable onPress={handleAuthenticate}>
+        <Text>Authenticate</Text>
+      </Pressable>
+      {Platform.OS === 'android' && (
+        <Pressable onPress={() => cancelAuthenticate()}>
+          <Text>Cancel</Text>
+        </Pressable>
+      )}
+      <Show when={authResult()} keyed>
+        {result => (
+          <Text>
+            {result.success ? 'Success' : `Failed: ${result.error}`}
+          </Text>
+        )}
+      </Show>
+    </View>
+  );
+}
+```
+
 ```ts
 // Angular
 import { Component, signal } from '@angular/core';
@@ -226,17 +329,19 @@ export class LocalAuthScreen {
 ```
 
 There's no per-instance service to `inject()` in the Angular case — every function is a plain
-free function off the core package, called straight from the constructor. All three examples are
-trimmed from the real canary demo screens (`examples/expo-react/screens/LocalAuthScreen.tsx`,
+free function off the core package, called straight from the constructor. The React/Vue/Angular
+examples are trimmed from the real canary demo screens
+(`examples/expo-react/screens/LocalAuthScreen.tsx`,
 `examples/expo-vue-sfc/screens/LocalAuthScreen.vue`, `examples/expo-vue-tsx/screens/LocalAuthScreen.tsx`,
 `examples/expo-angular/src/screens/LocalAuthScreen.ts`), which also cover
-`getEnrolledLevelAsync`/`supportedAuthenticationTypesAsync` and render a capabilities card.
+`getEnrolledLevelAsync`/`supportedAuthenticationTypesAsync` and render a capabilities card. No
+canary demo screen exists yet for Svelte/Solid — the two snippets above follow the same surface.
 
 ## API
 
 Free functions, no event stream, no per-instance state — upstream ships a handful of async
-functions and two enums, not a subscribable sensor, so the React/Vue/Angular entry points above
-are plain re-exports of `core` with nothing adapter-specific to add.
+functions and two enums, not a subscribable sensor, so the React/Vue/Svelte/Solid/Angular entry
+points above are plain re-exports of `core` with nothing adapter-specific to add.
 
 ```ts
 hasHardwareAsync(): Promise<boolean>
@@ -260,6 +365,8 @@ import {
 // or the framework-scoped entry points — identical surface, re-exported verbatim:
 import { authenticateAsync } from '@symbiote-native/local-auth/react';
 import { authenticateAsync } from '@symbiote-native/local-auth/vue';
+import { authenticateAsync } from '@symbiote-native/local-auth/svelte';
+import { authenticateAsync } from '@symbiote-native/local-auth/solid';
 import { authenticateAsync } from '@symbiote-native/local-auth/angular';
 ```
 
@@ -286,10 +393,11 @@ a view or per-instance state. Tests inject a fake native-module object in place
 `src/core/types.test.ts`, `vitest`) — no `installFabric()`, no ViewConfig. Native rendering itself
 is verified on-device (see the parent [README](../../README.md) for the project's testing model).
 
-Native autolinking wiring is done in the four Expo canary apps
-(`examples/expo-react`, `examples/expo-vue-sfc`, `examples/expo-vue-tsx`, `examples/expo-angular`)
-— iOS Podfile/`AppDelegate.swift` + `NSFaceIDUsageDescription`, Android Gradle/
-`MainApplication.kt` + `USE_BIOMETRIC`, all four confirmed present. The one remaining gap: this
-package isn't yet demoed in the plain, non-Expo `examples/react`/`vue-sfc`/`vue-tsx`/`angular`
-canaries, since an `expo-modules-core` package needs the `expo-modules-autolinking` wiring only
-the `examples/expo-*` apps have set up so far.
+Native autolinking wiring is done in all six Expo canary apps
+(`examples/expo-react`, `examples/expo-vue-sfc`, `examples/expo-vue-tsx`, `examples/expo-svelte`,
+`examples/expo-solid`, `examples/expo-angular`) — iOS Podfile/`AppDelegate.swift` +
+`NSFaceIDUsageDescription`, Android Gradle/`MainApplication.kt` + `USE_BIOMETRIC`, all six
+confirmed present. The one remaining gap: this package isn't yet demoed in the plain, non-Expo
+`examples/react`/`vue-sfc`/`vue-tsx`/`svelte`/`solid`/`angular` canaries, since an
+`expo-modules-core` package needs the `expo-modules-autolinking` wiring only the
+`examples/expo-*` apps have set up so far.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@symbiote-native/local-auth",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "expo-local-authentication wrapped for SymbioteNative — one framework-agnostic core, built once and reachable from the React, Vue, Svelte, Solid, and Angular adapters. FaceID/TouchID on iOS, the Fingerprint/Biometric API on Android.",
   "license": "MIT",
   "repository": {
@@ -13,6 +13,18 @@
     "url": "https://github.com/OneEyed1366/symbiote-native/issues"
   },
   "author": "Andrey Prokopenko <psevdoproger@gmail.com>",
+  "keywords": [
+    "react-native",
+    "symbiote-native",
+    "expo-local-authentication",
+    "react",
+    "vue",
+    "svelte",
+    "solid",
+    "angular",
+    "biometrics",
+    "face-id"
+  ],
   "type": "module",
   "main": "./build/core/index.js",
   "module": "./build/core/index.js",
@@ -62,19 +74,19 @@
     "invariant": "^2.2.4"
   },
   "peerDependencies": {
-    "@symbiote-native/angular": ">=0.6.2",
-    "@symbiote-native/engine": ">=0.1.7",
-    "@symbiote-native/react": ">=0.2.8",
-    "@symbiote-native/solid": ">=0.0.1",
-    "@symbiote-native/svelte": ">=0.1.0",
-    "@symbiote-native/vue": ">=0.3.8",
     "@angular/core": ">=20",
     "@vue/runtime-core": "^3.5.13",
     "react": ">=19.0.0",
     "react-native": ">=0.86",
     "solid-js": ">=1.9.0",
     "svelte": ">=5.56.0",
-    "vue": ">=3.5.0"
+    "vue": ">=3.5.0",
+    "@symbiote-native/angular": "^1.0.0",
+    "@symbiote-native/engine": "^0.4.0",
+    "@symbiote-native/react": "^1.0.0",
+    "@symbiote-native/solid": "^1.0.0",
+    "@symbiote-native/svelte": "^1.0.0",
+    "@symbiote-native/vue": "^1.0.0"
   },
   "peerDependenciesMeta": {
     "@symbiote-native/angular": {
@@ -123,13 +135,13 @@
     "solid-js": "^1.9.14",
     "svelte": "^5.56.0",
     "typescript": "~6.0.0",
-    "@symbiote-native/angular": "0.8.0",
-    "@symbiote-native/engine": "0.3.0",
-    "@symbiote-native/react": "0.4.0",
-    "@symbiote-native/solid": "0.1.0",
-    "@symbiote-native/svelte": "0.3.0",
-    "@symbiote-native/test-utils": "0.2.0",
-    "@symbiote-native/vue": "0.5.0"
+    "@symbiote-native/angular": "1.0.0",
+    "@symbiote-native/engine": "0.4.0",
+    "@symbiote-native/react": "1.0.0",
+    "@symbiote-native/solid": "1.0.0",
+    "@symbiote-native/svelte": "1.0.0",
+    "@symbiote-native/test-utils": "0.3.0",
+    "@symbiote-native/vue": "1.0.0"
   },
   "scripts": {
     "typecheck": "tsc --build",