electron-webauthn 1.2.0 → 1.3.0

package/README.md

@@ -24,6 +24,7 @@ The root `electron-webauthn` package is a cross-platform shim that lazy-loads `@
 - Credential authentication (assertions) with existing credentials
 - Seamless integration with Electron's native window system
 - Passkey listing via `listPasskeys` (macOS 13.3+)
+- Explicit passkey-listing authorization APIs with `getListPasskeyAuthorizationStatus` and `requestListPasskeyAuthorization`
 - PRF (Pseudo-Random Function) extension support
 - Large Blob extension support for reading/writing credential-specific data
 - User verification preference configuration (preferred, required, discouraged)
@@ -88,7 +89,7 @@ This library implements the W3C WebAuthn standard using Apple's native Authentic
 
 ## Error Handling
 
-`createCredential`, `getCredential`, and `listPasskeys` all return a result object with a `success` field. Always check this field:
+`createCredential`, `getCredential`, `getListPasskeyAuthorizationStatus`, `requestListPasskeyAuthorization`, and `listPasskeys` all return a result object with a `success` field. Always check this field:
 
 ```typescript
 const result = await createCredential(publicKeyOptions, additionalOptions);
@@ -126,7 +127,14 @@ console.log("Credential ID:", result.data.credentialId);
 `listPasskeys` returns an `Error` object (not a string code) when unsuccessful:
 
 ```typescript
-const result = await listPasskeys("example.com");
+const permission = await getListPasskeyAuthorizationStatus();
+if (permission.success && permission.status === "notDetermined") {
+  await requestListPasskeyAuthorization();
+}
+
+const result = await listPasskeys("example.com", {
+  requestAuthorization: false,
+});
 
 if (!result.success) {
   console.error("Failed to list passkeys:", result.error.message);
@@ -153,6 +161,12 @@ console.log(`Found ${result.credentials.length} passkeys`);
 
 - **NotAllowedError**: No valid credentials available for the specified rpId
 
+#### Passkey Authorization / Listing
+
+- **`getListPasskeyAuthorizationStatus()`**: Returns `authorized`, `denied`, or `notDetermined` without prompting
+- **`requestListPasskeyAuthorization()`**: Shows the macOS permission prompt only when the current state is `notDetermined`
+- **`listPasskeys(..., { requestAuthorization: false })`**: Returns an `Error` when permission has not been decided yet instead of triggering the prompt automatically
+
 ## Feature Support
 
 **Currently Supported:**

package/dist/index.d.ts

@@ -1,8 +1,10 @@
-import type { CreateCredentialResult, GetCredentialResult, ListPasskeysError, ListPasskeysResult, WebauthnCreateRequestOptions, WebauthnGetRequestOptions, WebauthnModule } from "@electron-webauthn/types";
-export type { CreateCredentialErrorCodes, CreateCredentialResult, CreateCredentialSuccessData, CreateCredentialSuccessResult, CreateCredentialErrorResult, GetCredentialErrorCodes, GetCredentialResult, GetCredentialSuccessData, GetCredentialSuccessResult, GetCredentialErrorResult, ListPasskeysError, ListPasskeysResult, PasskeyCredential, WebauthnCreateRequestOptions, WebauthnGetRequestOptions, WebauthnModule, } from "@electron-webauthn/types";
+import type { CreateCredentialResult, GetCredentialResult, ListPasskeysOptions, ListPasskeysError, ListPasskeysResult, PasskeyAuthorizationError, PasskeyAuthorizationResult, WebauthnCreateRequestOptions, WebauthnGetRequestOptions, WebauthnModule } from "@electron-webauthn/types";
+export type { CreateCredentialErrorCodes, CreateCredentialResult, CreateCredentialSuccessData, CreateCredentialSuccessResult, CreateCredentialErrorResult, GetCredentialErrorCodes, GetCredentialResult, GetCredentialSuccessData, GetCredentialSuccessResult, GetCredentialErrorResult, ListPasskeysOptions, ListPasskeysError, ListPasskeysResult, PasskeyAuthorizationError, PasskeyAuthorizationResult, PasskeyAuthorizationStatus, PasskeyCredential, WebauthnCreateRequestOptions, WebauthnGetRequestOptions, WebauthnModule, } from "@electron-webauthn/types";
 type MacosLoader = () => Promise<WebauthnModule>;
 export declare function createCredential(publicKeyOptions: PublicKeyCredentialCreationOptions | undefined, additionalOptions: WebauthnCreateRequestOptions): Promise<CreateCredentialResult>;
 export declare function getCredential(publicKeyOptions: PublicKeyCredentialRequestOptions | undefined, additionalOptions: WebauthnGetRequestOptions): Promise<GetCredentialResult>;
-export declare function listPasskeys(relyingPartyId: string): Promise<ListPasskeysResult | ListPasskeysError>;
+export declare function getListPasskeyAuthorizationStatus(): Promise<PasskeyAuthorizationResult | PasskeyAuthorizationError>;
+export declare function requestListPasskeyAuthorization(): Promise<PasskeyAuthorizationResult | PasskeyAuthorizationError>;
+export declare function listPasskeys(relyingPartyId: string, options?: ListPasskeysOptions): Promise<ListPasskeysResult | ListPasskeysError>;
 export declare function __setMacosLoaderForTesting(loader: MacosLoader | null): void;
 export declare function __setPlatformForTesting(platform: NodeJS.Platform | null): void;

package/dist/index.js

@@ -12,6 +12,10 @@ const unsupportedListResult = {
     success: false,
     error: new Error("electron-webauthn is only available on macOS. Install @electron-webauthn/macos on Darwin hosts."),
 };
+const unsupportedPasskeyAuthorizationResult = {
+    success: false,
+    error: new Error("electron-webauthn is only available on macOS. Install @electron-webauthn/macos on Darwin hosts."),
+};
 let moduleCache = null;
 let modulePromise = null;
 let platformOverride = null;
@@ -59,12 +63,26 @@ export async function getCredential(publicKeyOptions, additionalOptions) {
     }
     return module.getCredential(publicKeyOptions, additionalOptions);
 }
-export async function listPasskeys(relyingPartyId) {
+export async function getListPasskeyAuthorizationStatus() {
+    const module = await getMacosModule();
+    if (!module) {
+        return unsupportedPasskeyAuthorizationResult;
+    }
+    return module.getListPasskeyAuthorizationStatus();
+}
+export async function requestListPasskeyAuthorization() {
+    const module = await getMacosModule();
+    if (!module) {
+        return unsupportedPasskeyAuthorizationResult;
+    }
+    return module.requestListPasskeyAuthorization();
+}
+export async function listPasskeys(relyingPartyId, options) {
     const module = await getMacosModule();
     if (!module) {
         return unsupportedListResult;
     }
-    return module.listPasskeys(relyingPartyId);
+    return module.listPasskeys(relyingPartyId, options);
 }
 export function __setMacosLoaderForTesting(loader) {
     macosLoader = loader ?? defaultLoader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-webauthn",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "repository": "https://github.com/iamEvanYT/electron-webauthn.git",
   "homepage": "https://github.com/iamEvanYT/electron-webauthn#readme",
   "description": "Cross-platform loader for native WebAuthn support on macOS.",
@@ -32,12 +32,12 @@
     "@types/bun": "latest"
   },
   "peerDependencies": {
-    "typescript": "^5"
+    "typescript": "^6.0.2"
   },
   "dependencies": {
-    "@electron-webauthn/types": "^1.2.0"
+    "@electron-webauthn/types": "^1.3.0"
   },
   "optionalDependencies": {
-    "@electron-webauthn/macos": "^1.2.0"
+    "@electron-webauthn/macos": "^1.3.0"
   }
 }