@schibsted/account-sdk-browser 6.0.0-alpha.13 → 6.0.0-alpha.15

package/README.md

@@ -31,6 +31,10 @@ If this is a new site and you do not have a `sessionDomain` yet, contact
 
 ## Development
 
+Dependencies are installed from [Schibsted Artifactory](https://artifactory.schibsted.io) (see [`.npmrc`](./.npmrc)),
+so npm must be authenticated to it before `npm install`. The private `@schibsted/consent-url-utils` package is
+bundled into `dist/` by Vite during `npm run build`, so SDK consumers do not need access to it.
+
 Install dependencies and run the standard checks:
 
 ```sh

package/dist/account.d.ts

@@ -102,10 +102,11 @@ export declare class Account {
      * Call this from a user gesture when `preferPopup` is enabled, otherwise browser popup blockers
      * may block the popup and the SDK will fall back to redirect navigation.
      *
-     * @param options - Login URL parameters.
+     * @param options - Login URL parameters. When `state` is omitted, the configured
+     * `generateState` function provides it.
      * @returns A popup window reference when a popup is opened; otherwise `null`.
      */
-    login(options: LoginOptions): Window | null;
+    login(options?: LoginOptions): Window | null;
     /**
      * Logs the user out from the brand Session Service session and redirects the browser.
      *
@@ -115,9 +116,10 @@ export declare class Account {
     /**
      * Builds the login URL without navigating the browser.
      *
-     * @param options - Login URL parameters.
+     * @param options - Login URL parameters. When `state` is omitted, the configured
+     * `generateState` function provides it.
      */
-    loginUrl(options: LoginOptions): string;
+    loginUrl(options?: LoginOptions): string;
     /**
      * Builds the logout URL without navigating the browser.
      *
@@ -134,13 +136,14 @@ export declare class Account {
      * Loads and displays the simplified login widget when user context is available.
      *
      * Your application decides how often to call this method. The `state` field in `loginParams`
-     * may be a string or a function that resolves to a string.
+     * may be a string or a function that resolves to a string. When omitted, the configured
+     * `generateState` function provides it.
      * Widget open and cancel events can be observed with `on()`.
      *
      * @returns `true` when the widget was displayed.
      * @throws {SDKError} If user context data is missing or the widget script cannot be loaded.
      */
-    showSimplifiedLoginWidget(loginParams: SimplifiedLoginWidgetLoginOptions, options?: SimplifiedLoginWidgetOptions): Promise<boolean>;
+    showSimplifiedLoginWidget(loginParams?: SimplifiedLoginWidgetLoginOptions, options?: SimplifiedLoginWidgetOptions): Promise<boolean>;
     /**
      * Enables or disables caching for subsequent session lookups.
      *

package/dist/consents.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Reads consents from the Schibsted Sourcepoint integration, the default consent reader.
+ * Pages without the integration have no consents to forward, so they are skipped before
+ * `getConsentsSync` would warn about the missing consent manager on every login URL.
+ * @private
+ */
+export declare function readSourcepointConsents(window: Window): URLSearchParams | null;
+/**
+ * Sets the given parameters on a URL, replacing previous values of the same parameters.
+ * @private
+ * @param href
+ * @param consentParams
+ * @return - The URL with the parameters replaced
+ */
+export declare function replaceConsentParams(href: string, consentParams: URLSearchParams): string;
+/**
+ * Refreshes consents of already rendered login links right before the browser follows them.
+ * Links are often generated before the user answers the consent dialog, so their consents are stale.
+ * The listener runs in the capture phase, before page handlers read the link.
+ * @private
+ * @param document
+ * @param options
+ * @param options.isLoginUrl - Tells whether a URL is a login URL to refresh
+ * @param options.getConsentParams - Current consent parameters
+ */
+export declare function refreshLoginLinksOnActivation(document: Document, { isLoginUrl, getConsentParams, }: {
+    isLoginUrl: (href: string) => boolean;
+    getConsentParams: () => URLSearchParams;
+}): void;

package/dist/identity.d.ts

@@ -18,6 +18,8 @@ export declare class Identity {
     private readonly env;
     private readonly log?;
     private readonly callbackBeforeRedirect;
+    private readonly getConsents;
+    private readonly generateState?;
     private readonly sessionStorageCache;
     private readonly localStorageCache;
     private enableSessionCaching;
@@ -43,13 +45,18 @@ export declare class Identity {
      * @param options.sessionDomain - Example: "https://id.site.com"
      * @param options.redirectUri - Example: "https://site.com"
      * @param options.env - Schibsted account environment: `PRE` (default), `PRO`, `PRO_NO`, `PRO_FI` or `PRO_DK`
-     * @param options.log - A function that receives debug log information. If not set,
-     * no logging will be done
+     * @param options.log - Receives debug logs and consent reader errors.
+     * Without it, consent reader errors are reported through console.warn.
      * @param options.window - window object
      * @param options.callbackBeforeRedirect - callback triggered before session refresh redirect happen
+     * @param options.getConsents - reads consents forwarded in login URLs.
+     * Defaults to the Schibsted Sourcepoint integration
+     * @param options.generateState - generates the OAuth state when login options do not provide one
      * @throws {SDKError} - If any of options are invalid
      */
-    constructor({ clientId, redirectUri, sessionDomain, env, log, window, callbackBeforeRedirect, }: IdentityOptions);
+    constructor({ clientId, redirectUri, sessionDomain, env, log, window, callbackBeforeRedirect, getConsents, generateState, }: IdentityOptions);
+    /** @internal */
+    enableLoginLinkRefresh(): void;
     addEventListener(type: AccountEventName, listener: EventListener): void;
     removeEventListener(type: AccountEventName, listener: EventListener): void;
     /**
@@ -256,7 +263,7 @@ export declare class Identity {
     /**
      * Generates the link to the new login page that'll be used in the popup or redirect flow
      * @param options
-     * @param options.state
+     * @param options.state - defaults to the value returned by `generateState`
      * @param options.acrValues
      * @param options.scope
      * @param options.redirectUri
@@ -273,6 +280,19 @@ export declare class Identity {
      * @return - The url
      */
     loginUrl({ state, acrValues, scope, redirectUri, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, xDomainId, xEnvironmentId, originCampaign, }: LoginOptions): string;
+    /**
+     * Reads the current consent parameters. A failing consent reader must not prevent a login,
+     * so the failure is logged and the login continues without consents.
+     * @private
+     * @return - Consent query parameters; empty when unavailable
+     */
+    private getConsentParams;
+    /**
+     * Tells whether a URL is a login URL generated by this instance
+     * @private
+     * @param href
+     */
+    private isLoginUrl;
     /**
      * The url for logging the user out
      * @param redirectUri

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export { default as SDKError } from './sdk-error.js';
 export { isConnectedSessionResponse, isConnectedSessionWithUserIdResponse, isSessionFailureResponse, isSessionSuccessResponse, } from './session-response.js';
 export type { AccountConfig, AccountEventListener, AccountEventMap, AccountEventName, LoginRequestedEventDetail, LogoutRequestedEventDetail, } from './types/account.js';
 export type { AccountEnvironment, LogFunction } from './types/common.js';
-export type { LoginOptions, SimplifiedLoginData, SimplifiedLoginWidgetLoginOptions, SimplifiedLoginWidgetOptions, } from './types/login.js';
+export type { ConsentReader } from './types/identity.js';
+export type { LoginOptions, SimplifiedLoginData, SimplifiedLoginWidgetLoginOptions, SimplifiedLoginWidgetOptions, StateGenerator, } from './types/login.js';
 export type { HasAccessResult } from './types/monetization.js';
 export type { ConnectedSessionResponse, ConnectedSessionWithUserIdResponse, RedirectSessionResponse, SessionFailureResponse, SessionResponse, SessionSuccessResponse, SessionUserId, } from './types/session.js';