@zoreal/oauth2-react 0.2.12 → 0.2.13

package/dist/index.d.cts

@@ -56,11 +56,19 @@ interface PairingState {
      * has no QR.
      */
     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. */
     cancel?: () => void;
 }
+/**
+ * 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 ZorealLoginRequestOptions {
     /** Defaults to 'openid'. Scopes that return personal data require flow: 'auth-code'. */
     scope?: string;
@@ -80,6 +88,12 @@ interface ZorealLoginRequestOptions {
      * '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;
     /** Called on each pairing state change. Drive your own UI from this if you render one. */
     onPairingStateChange?: (state: PairingState) => void;
 }
@@ -247,8 +261,10 @@ interface PairingModalProps {
     locale?: string;
     theme?: ZorealTheme;
     timeoutMs?: number;
+    /** Which title the dialog opens with. Defaults to the sign-in wording. */
+    intent?: LoginIntent;
 }
-declare function PairingModal({ state, qrUrl, onCancel, locale, theme, timeoutMs, }: PairingModalProps): react.ReactPortal | null;
+declare function PairingModal({ state, qrUrl, onCancel, locale, theme, timeoutMs, intent, }: PairingModalProps): react.ReactPortal | null;
 
 declare function useZorealLogin(options: {
     flow?: 'browser-direct';
@@ -288,4 +304,12 @@ declare function zorealLogout(): void;
 declare function hasGrantedAllScopesZoreal(response: Pick<ZorealCodeResponse, 'scope'>, firstScope: string, ...restScopes: string[]): boolean;
 declare function hasGrantedAnyScopeZoreal(response: Pick<ZorealCodeResponse, 'scope'>, firstScope: string, ...restScopes: string[]): boolean;
 
-export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };
+/**
+ * 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 AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };

package/dist/index.d.ts

@@ -56,11 +56,19 @@ interface PairingState {
      * has no QR.
      */
     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. */
     cancel?: () => void;
 }
+/**
+ * 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 ZorealLoginRequestOptions {
     /** Defaults to 'openid'. Scopes that return personal data require flow: 'auth-code'. */
     scope?: string;
@@ -80,6 +88,12 @@ interface ZorealLoginRequestOptions {
      * '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;
     /** Called on each pairing state change. Drive your own UI from this if you render one. */
     onPairingStateChange?: (state: PairingState) => void;
 }
@@ -247,8 +261,10 @@ interface PairingModalProps {
     locale?: string;
     theme?: ZorealTheme;
     timeoutMs?: number;
+    /** Which title the dialog opens with. Defaults to the sign-in wording. */
+    intent?: LoginIntent;
 }
-declare function PairingModal({ state, qrUrl, onCancel, locale, theme, timeoutMs, }: PairingModalProps): react.ReactPortal | null;
+declare function PairingModal({ state, qrUrl, onCancel, locale, theme, timeoutMs, intent, }: PairingModalProps): react.ReactPortal | null;
 
 declare function useZorealLogin(options: {
     flow?: 'browser-direct';
@@ -288,4 +304,12 @@ declare function zorealLogout(): void;
 declare function hasGrantedAllScopesZoreal(response: Pick<ZorealCodeResponse, 'scope'>, firstScope: string, ...restScopes: string[]): boolean;
 declare function hasGrantedAnyScopeZoreal(response: Pick<ZorealCodeResponse, 'scope'>, firstScope: string, ...restScopes: string[]): boolean;
 
-export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };
+/**
+ * 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 AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };