@corbado/autocapture 1.1.0 → 1.2.0

package/dist/{types-CXJAj2DU.d.ts → types-lamU1Fd3.d.mts}

@@ -18,7 +18,9 @@ type CaptureHandle = {
     disconnect(): void;
 };
 /** Normalized Credential Management mediation. Missing mediation defaults to `optional`. */
-type WebAuthnMediation = "silent" | "optional" | "conditional" | "required" | "unknown";
+type CredentialMediation = "silent" | "optional" | "conditional" | "required" | "unknown";
+/** Normalized Credential Management mediation of a WebAuthn ceremony. */
+type WebAuthnMediation = CredentialMediation;
 /** Normalized Credential Management UI mode for authentication ceremonies. */
 type WebAuthnUiMode = "default" | "immediate" | "unknown";
 /** Browser-native facts that remain stable for one ceremony. */
@@ -107,6 +109,74 @@ type WebAuthnCaptureHandle = CaptureHandle & {
     /** Surface this capture attached to; `"none"` when `mode` is `"unavailable"`. */
     readonly surface: WebAuthnAttachSurface | "none";
 };
+/** FedCM request context. Missing context defaults to `signin`. */
+type FederatedIdentityContext = "signin" | "signup" | "use" | "continue" | "unknown";
+/** FedCM UI mode: `passive` is a prompt the browser shows by itself, `active` follows a user gesture. Missing mode defaults to `passive`. */
+type FederatedIdentityMode = "passive" | "active" | "unknown";
+/** An identity provider named in a FedCM request. Nonce and parameters are never read. */
+type FederatedIdentityProvider = {
+    /** The provider's FedCM config file URL; it names the provider. */
+    configURL: string;
+    /** The relying party's public client ID at the provider. */
+    clientId?: string;
+};
+type FederatedIdentityBase = {
+    /** Identifier shared by all events belonging to the same request. */
+    requestId: string;
+};
+type FederatedIdentityStartedEvent = FederatedIdentityBase & {
+    phase: "started";
+    /** Providers with a string `configURL`, in request order. */
+    providers: FederatedIdentityProvider[];
+    context: FederatedIdentityContext;
+    mode: FederatedIdentityMode;
+    mediation: CredentialMediation;
+    /** Whether transient user activation was active when the request started, when exposed by the browser. */
+    userActivation?: boolean;
+};
+type FederatedIdentityCompletedEvent = FederatedIdentityBase & {
+    phase: "completed";
+    /** Config file URL of the provider whose account was chosen, when the browser exposes it. */
+    configURL?: string;
+    /** Whether the browser chose the account without user interaction, when exposed. */
+    isAutoSelected?: boolean;
+};
+type FederatedIdentityFailedEvent = FederatedIdentityBase & {
+    phase: "failed";
+    /**
+     * DOM exception name, or `UnknownError`. Typical values: `NotAllowedError` (declined or blocked),
+     * `NetworkError` (no account, provider unavailable or cooldown), `AbortError`,
+     * `IdentityCredentialError` (the provider refused after an account was chosen). `NoCredential`
+     * when the request resolved without a credential.
+     */
+    errorName: string;
+    /** Error code of an `IdentityCredentialError`, when non-empty. */
+    code?: string;
+    /** Present when the request signal was aborted before settlement. */
+    aborted?: true;
+};
+/**
+ * Lifecycle event of a FedCM request (`navigator.credentials.get({ identity })`). Tokens, nonces,
+ * parameters and login hints never appear in events.
+ */
+type FederatedIdentityEvent = FederatedIdentityStartedEvent | FederatedIdentityCompletedEvent | FederatedIdentityFailedEvent;
+/** Options for {@link captureFederatedIdentity}. */
+type FederatedIdentityCaptureOptions = {
+    /** Receives FedCM lifecycle events. Return values are not awaited. */
+    onEvent: (event: FederatedIdentityEvent) => void;
+    /** Optional diagnostic logger. */
+    logger?: Logger;
+    /**
+     * Highest surface capture may attach to when no other capture is attached yet; see
+     * {@link WebAuthnCaptureOptions.attach}. Defaults to `"methods"`.
+     */
+    attach?: WebAuthnAttachSurface;
+};
+/** Handle returned by {@link captureFederatedIdentity}. */
+type FederatedIdentityCaptureHandle = CaptureHandle & {
+    /** Surface the shared attachment uses; `"none"` when `mode` is `"unavailable"`. */
+    readonly surface: WebAuthnAttachSurface | "none";
+};
 /** Network API used for an observed exchange. */
 type NetworkTransport = "xhr" | "fetch";
 /** Direction of a projected body within an observed network exchange. */
@@ -244,4 +314,4 @@ type NavigationCaptureOptions = {
     logger?: Logger;
 };
 
-export type { CaptureHandle as C, HttpExchange as H, Logger as L, NetworkCaptureOptions as N, WebAuthnCaptureOptions as W, WebAuthnCaptureHandle as a, NavigationCaptureOptions as b, HttpRequestStarted as c, NavigationEvent as d, NavigationSource as e, NetworkBodyDirection as f, NetworkBodyProjectionContext as g, NetworkBodyProjector as h, NetworkTransport as i, WebAuthnAttachSurface as j, WebAuthnCeremonyCompletedEvent as k, WebAuthnCeremonyContext as l, WebAuthnCeremonyEvent as m, WebAuthnCeremonyFailedEvent as n, WebAuthnCeremonyStartedEvent as o, WebAuthnMediation as p, WebAuthnUiMode as q };
+export type { CaptureHandle as C, FederatedIdentityCaptureOptions as F, HttpExchange as H, Logger as L, NetworkCaptureOptions as N, WebAuthnCaptureOptions as W, WebAuthnCaptureHandle as a, FederatedIdentityCaptureHandle as b, NavigationCaptureOptions as c, CredentialMediation as d, FederatedIdentityCompletedEvent as e, FederatedIdentityContext as f, FederatedIdentityEvent as g, FederatedIdentityFailedEvent as h, FederatedIdentityMode as i, FederatedIdentityProvider as j, FederatedIdentityStartedEvent as k, HttpRequestStarted as l, NavigationEvent as m, NavigationSource as n, NetworkBodyDirection as o, NetworkBodyProjectionContext as p, NetworkBodyProjector as q, NetworkTransport as r, WebAuthnAttachSurface as s, WebAuthnCeremonyCompletedEvent as t, WebAuthnCeremonyContext as u, WebAuthnCeremonyEvent as v, WebAuthnCeremonyFailedEvent as w, WebAuthnCeremonyStartedEvent as x, WebAuthnMediation as y, WebAuthnUiMode as z };

package/dist/{types-CXJAj2DU.d.mts → types-lamU1Fd3.d.ts}

@@ -18,7 +18,9 @@ type CaptureHandle = {
     disconnect(): void;
 };
 /** Normalized Credential Management mediation. Missing mediation defaults to `optional`. */
-type WebAuthnMediation = "silent" | "optional" | "conditional" | "required" | "unknown";
+type CredentialMediation = "silent" | "optional" | "conditional" | "required" | "unknown";
+/** Normalized Credential Management mediation of a WebAuthn ceremony. */
+type WebAuthnMediation = CredentialMediation;
 /** Normalized Credential Management UI mode for authentication ceremonies. */
 type WebAuthnUiMode = "default" | "immediate" | "unknown";
 /** Browser-native facts that remain stable for one ceremony. */
@@ -107,6 +109,74 @@ type WebAuthnCaptureHandle = CaptureHandle & {
     /** Surface this capture attached to; `"none"` when `mode` is `"unavailable"`. */
     readonly surface: WebAuthnAttachSurface | "none";
 };
+/** FedCM request context. Missing context defaults to `signin`. */
+type FederatedIdentityContext = "signin" | "signup" | "use" | "continue" | "unknown";
+/** FedCM UI mode: `passive` is a prompt the browser shows by itself, `active` follows a user gesture. Missing mode defaults to `passive`. */
+type FederatedIdentityMode = "passive" | "active" | "unknown";
+/** An identity provider named in a FedCM request. Nonce and parameters are never read. */
+type FederatedIdentityProvider = {
+    /** The provider's FedCM config file URL; it names the provider. */
+    configURL: string;
+    /** The relying party's public client ID at the provider. */
+    clientId?: string;
+};
+type FederatedIdentityBase = {
+    /** Identifier shared by all events belonging to the same request. */
+    requestId: string;
+};
+type FederatedIdentityStartedEvent = FederatedIdentityBase & {
+    phase: "started";
+    /** Providers with a string `configURL`, in request order. */
+    providers: FederatedIdentityProvider[];
+    context: FederatedIdentityContext;
+    mode: FederatedIdentityMode;
+    mediation: CredentialMediation;
+    /** Whether transient user activation was active when the request started, when exposed by the browser. */
+    userActivation?: boolean;
+};
+type FederatedIdentityCompletedEvent = FederatedIdentityBase & {
+    phase: "completed";
+    /** Config file URL of the provider whose account was chosen, when the browser exposes it. */
+    configURL?: string;
+    /** Whether the browser chose the account without user interaction, when exposed. */
+    isAutoSelected?: boolean;
+};
+type FederatedIdentityFailedEvent = FederatedIdentityBase & {
+    phase: "failed";
+    /**
+     * DOM exception name, or `UnknownError`. Typical values: `NotAllowedError` (declined or blocked),
+     * `NetworkError` (no account, provider unavailable or cooldown), `AbortError`,
+     * `IdentityCredentialError` (the provider refused after an account was chosen). `NoCredential`
+     * when the request resolved without a credential.
+     */
+    errorName: string;
+    /** Error code of an `IdentityCredentialError`, when non-empty. */
+    code?: string;
+    /** Present when the request signal was aborted before settlement. */
+    aborted?: true;
+};
+/**
+ * Lifecycle event of a FedCM request (`navigator.credentials.get({ identity })`). Tokens, nonces,
+ * parameters and login hints never appear in events.
+ */
+type FederatedIdentityEvent = FederatedIdentityStartedEvent | FederatedIdentityCompletedEvent | FederatedIdentityFailedEvent;
+/** Options for {@link captureFederatedIdentity}. */
+type FederatedIdentityCaptureOptions = {
+    /** Receives FedCM lifecycle events. Return values are not awaited. */
+    onEvent: (event: FederatedIdentityEvent) => void;
+    /** Optional diagnostic logger. */
+    logger?: Logger;
+    /**
+     * Highest surface capture may attach to when no other capture is attached yet; see
+     * {@link WebAuthnCaptureOptions.attach}. Defaults to `"methods"`.
+     */
+    attach?: WebAuthnAttachSurface;
+};
+/** Handle returned by {@link captureFederatedIdentity}. */
+type FederatedIdentityCaptureHandle = CaptureHandle & {
+    /** Surface the shared attachment uses; `"none"` when `mode` is `"unavailable"`. */
+    readonly surface: WebAuthnAttachSurface | "none";
+};
 /** Network API used for an observed exchange. */
 type NetworkTransport = "xhr" | "fetch";
 /** Direction of a projected body within an observed network exchange. */
@@ -244,4 +314,4 @@ type NavigationCaptureOptions = {
     logger?: Logger;
 };
 
-export type { CaptureHandle as C, HttpExchange as H, Logger as L, NetworkCaptureOptions as N, WebAuthnCaptureOptions as W, WebAuthnCaptureHandle as a, NavigationCaptureOptions as b, HttpRequestStarted as c, NavigationEvent as d, NavigationSource as e, NetworkBodyDirection as f, NetworkBodyProjectionContext as g, NetworkBodyProjector as h, NetworkTransport as i, WebAuthnAttachSurface as j, WebAuthnCeremonyCompletedEvent as k, WebAuthnCeremonyContext as l, WebAuthnCeremonyEvent as m, WebAuthnCeremonyFailedEvent as n, WebAuthnCeremonyStartedEvent as o, WebAuthnMediation as p, WebAuthnUiMode as q };
+export type { CaptureHandle as C, FederatedIdentityCaptureOptions as F, HttpExchange as H, Logger as L, NetworkCaptureOptions as N, WebAuthnCaptureOptions as W, WebAuthnCaptureHandle as a, FederatedIdentityCaptureHandle as b, NavigationCaptureOptions as c, CredentialMediation as d, FederatedIdentityCompletedEvent as e, FederatedIdentityContext as f, FederatedIdentityEvent as g, FederatedIdentityFailedEvent as h, FederatedIdentityMode as i, FederatedIdentityProvider as j, FederatedIdentityStartedEvent as k, HttpRequestStarted as l, NavigationEvent as m, NavigationSource as n, NetworkBodyDirection as o, NetworkBodyProjectionContext as p, NetworkBodyProjector as q, NetworkTransport as r, WebAuthnAttachSurface as s, WebAuthnCeremonyCompletedEvent as t, WebAuthnCeremonyContext as u, WebAuthnCeremonyEvent as v, WebAuthnCeremonyFailedEvent as w, WebAuthnCeremonyStartedEvent as x, WebAuthnMediation as y, WebAuthnUiMode as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@corbado/autocapture",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Observer-style capture helpers for WebAuthn ceremonies, selected network exchanges, in-app navigation, and composed event paths.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",