@zoreal/oauth2-js 0.1.19 → 0.1.21

package/dist/index.d.cts

@@ -139,6 +139,13 @@ interface StartLoginOptions {
      * sign-in. See LoginIntent for what is inferred when this is omitted.
      */
     intent?: LoginIntent;
+    /**
+     * The control the person used to start this login, held busy with the
+     * pairing modal's light round it until the login ends, and let go on
+     * every outcome. Pass the button from your click handler. Nothing else is
+     * needed: no wrapper, no busy state of your own.
+     */
+    control?: HTMLElement;
     /** 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. */
@@ -211,6 +218,17 @@ interface LoginHandle<T> {
 
 declare function startLogin(options: BrowserDirectLoginOptions): LoginHandle<ZorealCredentialResponse>;
 declare function startLogin(options: AuthCodeLoginOptions): LoginHandle<ZorealCodeResponse>;
+/**
+ * Finishes a same-device sign-in on the page the ZOREAL ID app reopened.
+ *
+ * Call it on every page load where `startLogin` can be called. It answers
+ * null at once when this page load is not a return; otherwise it takes the
+ * flow saved before the tap, polls the pairing named in the fragment, and
+ * resolves the way `startLogin` would have: an ID token in browser-direct
+ * mode, the code and the verifier in auth-code mode. The fragment is removed
+ * from the address bar as it is read.
+ */
+declare function resumeLogin(options: Pick<StartLoginOptions, 'clientId' | 'issuer' | 'onState' | 'control'>): LoginHandle<ZorealCredentialResponse | ZorealCodeResponse> | null;
 
 /**
  * The pairing modal, in plain DOM.
@@ -310,7 +328,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.19";
+declare const SDK_VERSION = "0.1.21";
 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. */
@@ -466,4 +484,4 @@ declare function unsafeClaims(idToken: string): Record<string, unknown>;
  */
 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 };
+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, resumeLogin, startLogin, startPairing, unsafeClaims };

package/dist/index.d.ts

@@ -139,6 +139,13 @@ interface StartLoginOptions {
      * sign-in. See LoginIntent for what is inferred when this is omitted.
      */
     intent?: LoginIntent;
+    /**
+     * The control the person used to start this login, held busy with the
+     * pairing modal's light round it until the login ends, and let go on
+     * every outcome. Pass the button from your click handler. Nothing else is
+     * needed: no wrapper, no busy state of your own.
+     */
+    control?: HTMLElement;
     /** 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. */
@@ -211,6 +218,17 @@ interface LoginHandle<T> {
 
 declare function startLogin(options: BrowserDirectLoginOptions): LoginHandle<ZorealCredentialResponse>;
 declare function startLogin(options: AuthCodeLoginOptions): LoginHandle<ZorealCodeResponse>;
+/**
+ * Finishes a same-device sign-in on the page the ZOREAL ID app reopened.
+ *
+ * Call it on every page load where `startLogin` can be called. It answers
+ * null at once when this page load is not a return; otherwise it takes the
+ * flow saved before the tap, polls the pairing named in the fragment, and
+ * resolves the way `startLogin` would have: an ID token in browser-direct
+ * mode, the code and the verifier in auth-code mode. The fragment is removed
+ * from the address bar as it is read.
+ */
+declare function resumeLogin(options: Pick<StartLoginOptions, 'clientId' | 'issuer' | 'onState' | 'control'>): LoginHandle<ZorealCredentialResponse | ZorealCodeResponse> | null;
 
 /**
  * The pairing modal, in plain DOM.
@@ -310,7 +328,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.19";
+declare const SDK_VERSION = "0.1.21";
 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. */
@@ -466,4 +484,4 @@ declare function unsafeClaims(idToken: string): Record<string, unknown>;
  */
 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 };
+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, resumeLogin, startLogin, startPairing, unsafeClaims };