@zoreal/oauth2-js 0.1.13 → 0.1.15

package/dist/index.d.cts

@@ -53,6 +53,8 @@ interface PairingState {
      * you and arrives through this callback.
      */
     qrRefreshSeconds?: number;
+    /** What the dialog says the code is for, resolved once per login. */
+    intent?: LoginIntent;
     /** True when the flow resolved to the app link (mobile) rather than a QR. */
     appLink?: boolean;
     /** Abandons this pairing: stops the poll. Wire it to your UI's cancel control. */
@@ -104,6 +106,12 @@ type ZorealTheme = 'auto' | 'light' | 'dark';
  * own pairing UI want this.
  */
 type PairingUI = 'modal' | 'none';
+/**
+ * What the pairing dialog says it is for. Resolved from the request when not
+ * given: document scopes make it 'identify', an identifier-only request with
+ * a liveness capture makes it 'presence', and the rest is 'sign-in'.
+ */
+type LoginIntent = 'sign-in' | 'identify' | 'presence';
 interface StartLoginOptions {
     /** The asset token from the ZOREAL dashboard, ast_... */
     clientId: string;
@@ -125,6 +133,12 @@ interface StartLoginOptions {
     app_state?: string;
     /** 'auto' renders a QR on desktop and an app link on mobile, which is what you want. */
     display?: 'auto' | 'qr' | 'link';
+    /**
+     * What the dialog tells the holder they are scanning for. Set it when the
+     * scope does not say: a presence check that asks for a name is still not a
+     * sign-in. See LoginIntent for what is inferred when this is omitted.
+     */
+    intent?: LoginIntent;
     /** Sent to the provider so the pairing surface speaks the visitor's language. */
     locale?: string;
     /** Called on each pairing state change. Drive your UI from this. */
@@ -218,6 +232,8 @@ interface PairingModalOptions {
     locale?: string;
     theme?: ZorealTheme;
     timeoutMs?: number;
+    /** Which title the dialog opens with. Defaults to the sign-in wording. */
+    intent?: LoginIntent;
 }
 interface PairingModalHandle {
     /** Re-render from a new pairing state. */
@@ -289,7 +305,7 @@ declare function mountPairingModal(state: PairingState, options: PairingModalOpt
  *                                  auth-code mode leaves it to the RP backend.
  */
 declare const WIRE_VERSION = 1;
-declare const SDK_VERSION = "0.1.13";
+declare const SDK_VERSION = "0.1.15";
 declare const SDK_NAME = "@zoreal/oauth2-js";
 declare const DEFAULT_ISSUER = "https://id.zoreal.com";
 /** Pending TTL is short. Poll gently; over-polling cancels the request. */
@@ -434,4 +450,12 @@ declare function generateState(): string;
  */
 declare function unsafeClaims(idToken: string): Record<string, unknown>;
 
-export { type AcrValue, type AuthCodeLoginOptions, type BrowserDirectLoginOptions, DEFAULT_ISSUER, DEFAULT_PAIRING_TIMEOUT_MS, DEFAULT_QR_REFRESH_SECONDS, type ErrorCode, FlowAbandonedError, type LoginHandle, type NonOAuthError, OAuthFlowError, POLL_INTERVAL_ENROLLING_MS, POLL_INTERVAL_MS, type PairCreated, type PairDisplay, type PairImmediate, type PairStartResponse, type PairStatusResponse, type PairingModalHandle, type PairingModalOptions, type PairingState, type PairingUI, SDK_NAME, SDK_VERSION, type SelectBy, type StartLoginOptions, type StartPairingParams, type TokenResponse, WIRE_VERSION, type ZorealCodeResponse, type ZorealCredentialResponse, type ZorealTheme, challengeS256, exchangeCode, generateState, generateVerifier, isMobileUserAgent, mountPairingModal, pollUntilApproved, startLogin, startPairing, unsafeClaims };
+/**
+ * What the pairing dialog says it is for. An explicit intent wins. Otherwise
+ * a request for document attributes is an identification; a request for the
+ * identifier alone with a liveness capture is a presence check, since nothing
+ * is being logged into; everything else is a sign-in.
+ */
+declare function resolveIntent(intent: LoginIntent | undefined, scope: string | undefined, acrValues: string | readonly string[] | undefined): LoginIntent;
+
+export { type AcrValue, type AuthCodeLoginOptions, type BrowserDirectLoginOptions, DEFAULT_ISSUER, DEFAULT_PAIRING_TIMEOUT_MS, DEFAULT_QR_REFRESH_SECONDS, type ErrorCode, FlowAbandonedError, type LoginHandle, type LoginIntent, type NonOAuthError, OAuthFlowError, POLL_INTERVAL_ENROLLING_MS, POLL_INTERVAL_MS, type PairCreated, type PairDisplay, type PairImmediate, type PairStartResponse, type PairStatusResponse, type PairingModalHandle, type PairingModalOptions, type PairingState, type PairingUI, SDK_NAME, SDK_VERSION, type SelectBy, type StartLoginOptions, type StartPairingParams, type TokenResponse, WIRE_VERSION, type ZorealCodeResponse, type ZorealCredentialResponse, type ZorealTheme, challengeS256, exchangeCode, generateState, generateVerifier, isMobileUserAgent, mountPairingModal, pollUntilApproved, resolveIntent, startLogin, startPairing, unsafeClaims };

package/dist/index.d.ts

@@ -53,6 +53,8 @@ interface PairingState {
      * you and arrives through this callback.
      */
     qrRefreshSeconds?: number;
+    /** What the dialog says the code is for, resolved once per login. */
+    intent?: LoginIntent;
     /** True when the flow resolved to the app link (mobile) rather than a QR. */
     appLink?: boolean;
     /** Abandons this pairing: stops the poll. Wire it to your UI's cancel control. */
@@ -104,6 +106,12 @@ type ZorealTheme = 'auto' | 'light' | 'dark';
  * own pairing UI want this.
  */
 type PairingUI = 'modal' | 'none';
+/**
+ * What the pairing dialog says it is for. Resolved from the request when not
+ * given: document scopes make it 'identify', an identifier-only request with
+ * a liveness capture makes it 'presence', and the rest is 'sign-in'.
+ */
+type LoginIntent = 'sign-in' | 'identify' | 'presence';
 interface StartLoginOptions {
     /** The asset token from the ZOREAL dashboard, ast_... */
     clientId: string;
@@ -125,6 +133,12 @@ interface StartLoginOptions {
     app_state?: string;
     /** 'auto' renders a QR on desktop and an app link on mobile, which is what you want. */
     display?: 'auto' | 'qr' | 'link';
+    /**
+     * What the dialog tells the holder they are scanning for. Set it when the
+     * scope does not say: a presence check that asks for a name is still not a
+     * sign-in. See LoginIntent for what is inferred when this is omitted.
+     */
+    intent?: LoginIntent;
     /** Sent to the provider so the pairing surface speaks the visitor's language. */
     locale?: string;
     /** Called on each pairing state change. Drive your UI from this. */
@@ -218,6 +232,8 @@ interface PairingModalOptions {
     locale?: string;
     theme?: ZorealTheme;
     timeoutMs?: number;
+    /** Which title the dialog opens with. Defaults to the sign-in wording. */
+    intent?: LoginIntent;
 }
 interface PairingModalHandle {
     /** Re-render from a new pairing state. */
@@ -289,7 +305,7 @@ declare function mountPairingModal(state: PairingState, options: PairingModalOpt
  *                                  auth-code mode leaves it to the RP backend.
  */
 declare const WIRE_VERSION = 1;
-declare const SDK_VERSION = "0.1.13";
+declare const SDK_VERSION = "0.1.15";
 declare const SDK_NAME = "@zoreal/oauth2-js";
 declare const DEFAULT_ISSUER = "https://id.zoreal.com";
 /** Pending TTL is short. Poll gently; over-polling cancels the request. */
@@ -434,4 +450,12 @@ declare function generateState(): string;
  */
 declare function unsafeClaims(idToken: string): Record<string, unknown>;
 
-export { type AcrValue, type AuthCodeLoginOptions, type BrowserDirectLoginOptions, DEFAULT_ISSUER, DEFAULT_PAIRING_TIMEOUT_MS, DEFAULT_QR_REFRESH_SECONDS, type ErrorCode, FlowAbandonedError, type LoginHandle, type NonOAuthError, OAuthFlowError, POLL_INTERVAL_ENROLLING_MS, POLL_INTERVAL_MS, type PairCreated, type PairDisplay, type PairImmediate, type PairStartResponse, type PairStatusResponse, type PairingModalHandle, type PairingModalOptions, type PairingState, type PairingUI, SDK_NAME, SDK_VERSION, type SelectBy, type StartLoginOptions, type StartPairingParams, type TokenResponse, WIRE_VERSION, type ZorealCodeResponse, type ZorealCredentialResponse, type ZorealTheme, challengeS256, exchangeCode, generateState, generateVerifier, isMobileUserAgent, mountPairingModal, pollUntilApproved, startLogin, startPairing, unsafeClaims };
+/**
+ * What the pairing dialog says it is for. An explicit intent wins. Otherwise
+ * a request for document attributes is an identification; a request for the
+ * identifier alone with a liveness capture is a presence check, since nothing
+ * is being logged into; everything else is a sign-in.
+ */
+declare function resolveIntent(intent: LoginIntent | undefined, scope: string | undefined, acrValues: string | readonly string[] | undefined): LoginIntent;
+
+export { type AcrValue, type AuthCodeLoginOptions, type BrowserDirectLoginOptions, DEFAULT_ISSUER, DEFAULT_PAIRING_TIMEOUT_MS, DEFAULT_QR_REFRESH_SECONDS, type ErrorCode, FlowAbandonedError, type LoginHandle, type LoginIntent, type NonOAuthError, OAuthFlowError, POLL_INTERVAL_ENROLLING_MS, POLL_INTERVAL_MS, type PairCreated, type PairDisplay, type PairImmediate, type PairStartResponse, type PairStatusResponse, type PairingModalHandle, type PairingModalOptions, type PairingState, type PairingUI, SDK_NAME, SDK_VERSION, type SelectBy, type StartLoginOptions, type StartPairingParams, type TokenResponse, WIRE_VERSION, type ZorealCodeResponse, type ZorealCredentialResponse, type ZorealTheme, challengeS256, exchangeCode, generateState, generateVerifier, isMobileUserAgent, mountPairingModal, pollUntilApproved, resolveIntent, startLogin, startPairing, unsafeClaims };