@schibsted/account-sdk-browser 5.2.7 → 6.0.0-alpha.10

package/src/session-response.ts

@@ -0,0 +1,100 @@
+/* Copyright 2026 Schibsted Products & Technology AS. Licensed under the terms of the MIT license.
+ * See LICENSE.md in the project root.
+ */
+
+import type {
+    ConnectedSessionResponse,
+    ConnectedSessionWithUserIdResponse,
+    NormalizedSessionPayload,
+    RedirectSessionPayload,
+    SessionFailureResponse,
+    SessionResponse,
+    SessionSuccessResponse,
+} from './types/session.js';
+import { isObject, isStr } from './validate.js';
+
+/**
+ * Checks whether a value is a successful session response.
+ *
+ * @param value - The value to check.
+ * @group Session
+ */
+export function isSessionSuccessResponse(value: unknown): value is SessionSuccessResponse {
+    return isObject(value) && typeof value.result === 'boolean';
+}
+
+/**
+ * Checks whether a successful session response represents a user connected to the merchant.
+ *
+ * @param value - The value to check.
+ * @group Session
+ */
+export function isConnectedSessionResponse(value: unknown): value is ConnectedSessionResponse {
+    return isSessionSuccessResponse(value) && value.result === true;
+}
+
+/**
+ * Checks whether a value is a session failure response.
+ *
+ * @param value - The value to check.
+ * @group Session
+ */
+export function isSessionFailureResponse(value: unknown): value is SessionFailureResponse {
+    return isObject(value) && Boolean(value.error);
+}
+
+export function isRedirectSessionPayload(value: unknown): value is RedirectSessionPayload {
+    return isObject(value) && Object.keys(value).length === 1 && isStr(value.redirectURL);
+}
+
+/**
+ * Checks whether a connected session response contains a usable user id.
+ *
+ * @param value - The value to check.
+ * @group Session
+ */
+export function isConnectedSessionWithUserIdResponse(
+    value: SessionResponse,
+): value is ConnectedSessionWithUserIdResponse {
+    return isConnectedSessionResponse(value) && typeof value.userId === 'number';
+}
+
+/**
+ * Converts an unknown Session Service `hasSession` payload into one of the shapes the SDK knows how
+ * to handle.
+ *
+ * This function is intentionally tolerant because `hasSession()` historically resolved unknown
+ * object payloads instead of rejecting them. The SDK relies on that behavior for backwards
+ * compatibility with clients that check the raw response themselves.
+ *
+ * The normal cases are:
+ * - regular success payloads with a boolean `result`;
+ * - failure payloads wrapped as `{ error, response? }`;
+ * - Safari/session-refresh redirect payloads shaped as `{ redirectURL }`.
+ *
+ * Any other object is preserved as an unrecognized response so callers can still receive it.
+ * Non-object values are normalized to `{}`, matching the old "empty response" fallback used by
+ * `hasSession()` and cached-session reads.
+ *
+ * This is used both for network responses parsed by `RESTClient` and for values restored from the
+ * session cache, so the rest of the Identity flow can switch on typed guards instead of repeatedly
+ * re-validating unknown data.
+ *
+ * @internal
+ */
+export function normalizeSessionResponse(value: unknown): NormalizedSessionPayload {
+    if (isRedirectSessionPayload(value)) {
+        return value;
+    }
+    if (isSessionFailureResponse(value)) {
+        return value;
+    }
+    if (isSessionSuccessResponse(value)) {
+        return value;
+    }
+    if (isObject(value)) {
+        return value;
+    }
+
+    return {};
+}

package/src/{spidTalk.js → spid-talk.ts}

@@ -2,13 +2,12 @@
  * See LICENSE.md in the project root.
  */
 
-'use strict';
-
 /**
  * A workaround for how Schibsted account handles JSONP calls in the browser
  * @private
  */
 
+import './globals.js';
 import { isFunction } from './validate.js';
 
 /**
@@ -20,20 +19,19 @@ import { isFunction } from './validate.js';
  * The old SPiD JSONP APIs relied on SPiD.Talk.response(callbackName, data) but fetch-jsonp merely
  * calls window[callbackName](data) which is more common practice. This module simply acts as an
  * adapter to modernize the old mechanism until we support CORS. To see how the SPiD solution works,
- * try to run a simple JSONP request or debug it in netowrk tab. This module will be removed when
- * CORS is supported.
- * @memberof core
- * @param {object} global - a reference to the global object
- * @return {void}
+ * try to run a simple JSONP request or debug it in the network tab. This module will be removed
+ * when CORS is supported.
+ * @param global - A reference to the global object, typically the `Window`.
  */
-export function emulate(global) {
-    if (global.SPiD === null || typeof global.SPiD !== 'object') {
+export function emulate(global: Window): void {
+    if (!global.SPiD || typeof global.SPiD !== 'object') {
         global.SPiD = {};
     }
-    if (global.SPiD.Talk === null || typeof global.SPiD.Talk !== 'object') {
-        global.SPiD.Talk = {}
+    if (!global.SPiD.Talk || typeof global.SPiD.Talk !== 'object') {
+        global.SPiD.Talk = {};
     }
     if (!isFunction(global.SPiD.Talk.response)) {
-        global.SPiD.Talk.response = (callbackName, data) => global[callbackName](data);
+        global.SPiD.Talk.response = (callbackName: string, data: unknown) =>
+            (global as any)[callbackName](data);
     }
 }

package/src/types/account.ts

@@ -0,0 +1,55 @@
+import type { AccountBaseConfig, LogFunction } from './common';
+import type { IdentityBeforeRedirectCallback, VarnishCookieOptions } from './identity';
+import type { SessionResponse } from './session';
+
+/**
+ * Configuration used to create an {@link Account} instance.
+ *
+ * @group Configuration
+ */
+export type AccountConfig = AccountBaseConfig & {
+    /** Receives debug log information. If not set, no logging will be done. */
+    log?: LogFunction;
+    /** Callback triggered before a session refresh redirect happens. */
+    callbackBeforeRedirect?: IdentityBeforeRedirectCallback;
+    /** Product or feature ids used by `hasAccess()` when no ids are passed to the method. */
+    defaultProductIds?: string[];
+    /** Optional Varnish cookie setup applied during Account initialization. */
+    varnish?: VarnishCookieOptions;
+};
+
+type LoginRequestedEventDetail = {
+    url: string;
+    method: 'popup' | 'default';
+};
+
+type LogoutRequestedEventDetail = {
+    url: string;
+};
+
+export type AccountEventMap = {
+    /** Emitted with the login URL and method when `login()` initiates a login flow. */
+    loginRequested: CustomEvent<LoginRequestedEventDetail>;
+    /** Emitted with the logout URL when `logout()` is called. */
+    logoutRequested: CustomEvent<LogoutRequestedEventDetail>;
+    /** Emitted when `hasSession()` detects a change in the stored session state. */
+    sessionUpdated: CustomEvent<SessionResponse>;
+    /** Emitted when the simplified login widget is displayed. */
+    simplifiedLoginOpened: Event;
+    /** Emitted when the simplified login widget is closed. */
+    simplifiedLoginCancelled: Event;
+};
+
+/** Account event names emitted by the SDK. */
+export type AccountEventName = keyof AccountEventMap;
+
+/**
+ * Native event listener used by Account event subscriptions.
+ *
+ * Payload-bearing events are `CustomEvent` instances and expose their payload through `detail`.
+ *
+ * @group Events
+ */
+export type AccountEventListener<EventName extends AccountEventName = AccountEventName> = (
+    event: AccountEventMap[EventName],
+) => void;

package/src/types/common.ts

@@ -0,0 +1,32 @@
+/* Common types used across the SDK */
+
+/**
+ * Log callback used by the SDK for debug output.
+ * Receives a pre-formatted log line.
+ *
+ * @group Configuration
+ */
+export type LogFunction = (message: string) => void;
+
+/**
+ * Supported Schibsted account environment keys.
+ *
+ * @group Configuration
+ */
+export type AccountEnvironment = 'LOCAL' | 'DEV' | 'PRE' | 'PRO' | 'PRO_NO' | 'PRO_FI' | 'PRO_DK';
+
+/**
+ * Shared Account configuration fields.
+ */
+export type AccountBaseConfig = {
+    /** Mandatory client id. Example: "1234567890abcdef12345678" */
+    clientId: string;
+    /** Redirect uri. Example: "https://site.com" */
+    redirectUri: string;
+    /** Session Service domain. Example: "https://id.site.com" */
+    sessionDomain: string;
+    /** Schibsted account environment. Defaults to PRE. */
+    env?: AccountEnvironment;
+    /** Window object to use. Defaults to the global `window`. */
+    window?: Window;
+};

package/src/types/identity.ts

@@ -0,0 +1,26 @@
+import type { AccountBaseConfig, LogFunction } from './common';
+
+/**
+ * Callback invoked before the SDK performs a full-page session refresh redirect.
+ */
+export type IdentityBeforeRedirectCallback = () => void | Promise<void>;
+
+/**
+ * Options accepted by the {@link Identity} constructor.
+ */
+export type IdentityOptions = AccountBaseConfig & {
+    /** Receives debug log information. If not set, no logging will be done. */
+    log?: LogFunction;
+    /** Callback triggered before a session refresh redirect happens. */
+    callbackBeforeRedirect?: IdentityBeforeRedirectCallback;
+};
+
+/**
+ * Options for {@link Identity#enableVarnishCookie}.
+ */
+export type VarnishCookieOptions = {
+    /** Override number of seconds before the Varnish cookie expires. */
+    expiresIn?: number;
+    /** Override cookie domain. E.g. "vg.no" instead of "www.vg.no". */
+    domain?: string;
+};

package/src/types/login.ts

@@ -0,0 +1,150 @@
+/**
+ * Options accepted by {@link Account#login} and related login URL helpers.
+ *
+ * @group Login & Widget
+ */
+export type LoginOptions = {
+    /**
+     * An opaque value used by the client to maintain state between the request and callback.
+     * It's also recommended to prevent CSRF {@link https://tools.ietf.org/html/rfc6749#section-10.12}
+     */
+    state: string;
+    /**
+     * Authentication Context Class Reference values. If omitted, the default account flow is used.
+     * Supported values include `password`, `otp`, `sms`, `otp-email`, `eid`, `eid-no`, `eid-se`,
+     * `eid-fi`, and `eid-dk`. Values other than `otp-email` may be combined as a space-separated
+     * string. Verify the AMR (Authentication Methods References) claim in the ID token on your
+     * backend if you need to enforce a completed authentication method.
+     */
+    acrValues?:
+        | 'password'
+        | 'otp'
+        | 'sms'
+        | 'eid-dk'
+        | 'eid-no'
+        | 'eid-se'
+        | 'eid-fi'
+        | 'eid'
+        | 'otp-email'
+        | (string & {});
+    /**
+     * The OAuth scopes for the tokens. This is a list of scopes, separated by space. If the list
+     * of scopes contains `openid`, the generated tokens includes the id token which can be useful
+     * for getting information about the user. Omitting scope is allowed, while `invalid_scope` is
+     * returned when the client asks for a scope you aren't allowed to request.
+     * {@link https://tools.ietf.org/html/rfc6749#section-3.3}
+     * Defaults to `openid`.
+     */
+    scope?: 'openid' | (string & {});
+    /**
+     * Redirect uri that will receive the code. Must exactly match a redirectUri from your client
+     * in self-service
+     */
+    redirectUri?: string;
+    /** Should we try to open a popup window? Defaults to `false`. */
+    preferPopup?: boolean;
+    /** user email or UUID hint */
+    loginHint?: string;
+    /** Pulse tag */
+    tag?: string;
+    /** Teaser slug. Teaser with given slug will be displayed in place of default teaser */
+    teaser?: string;
+    /**
+     * Specifies the allowable elapsed time in seconds since the last time the End-User was actively
+     * authenticated. If last authentication time is more than maxAge seconds in the past,
+     * re-authentication will be required. See the OpenID Connect spec section 3.1.2.1 for more
+     * information. Prefer a number of seconds; strings remain accepted for legacy callers.
+     */
+    maxAge?: number | string;
+    /**
+     * Optional parameter to overwrite client locale setting.
+     * New flows supports nb_NO, fi_FI, sv_SE, en_US
+     */
+    locale?: 'nb_NO' | 'fi_FI' | 'sv_SE' | 'en_US';
+    /** display username and password on one screen. Defaults to `false`. */
+    oneStepLogin?: boolean;
+    /**
+     * String that specifies whether the Authorization Server prompts the End-User for
+     * reauthentication or confirm account screen. Supported values: `select_account` or `login`.
+     * Defaults to `select_account`.
+     */
+    prompt?: 'select_account' | 'login';
+    /** Identifier for cross-domain tracking in Pulse */
+    xDomainId?: string;
+    /** Environment for cross-domain tracking in Pulse */
+    xEnvironmentId?: string;
+    /** Campaign identifier for tracking in Pulse */
+    originCampaign?: string;
+};
+
+/**
+ * Identical to {@link LoginOptions} except that `state` may also be a (possibly async) function;
+ * all other fields reuse the `LoginOptions` documentation.
+ *
+ * @group Login & Widget
+ */
+export type SimplifiedLoginWidgetLoginOptions = Omit<LoginOptions, 'state'> & {
+    /**
+     * An opaque value used by the client to maintain state between the request and callback.
+     * It's also recommended to prevent CSRF {@link https://tools.ietf.org/html/rfc6749#section-10.12}
+     */
+    state: string | (() => string | Promise<string>);
+};
+
+/**
+ * Minimal user information used by the simplified login widget flow.
+ *
+ * @group Login & Widget
+ */
+export type SimplifiedLoginData = {
+    /** Deprecated: User UUID used as `loginHint` for {@link Account#login}. */
+    identifier: string;
+    /** Human-readable user identifier */
+    display_text: string;
+    /** Client name */
+    client_name: string;
+    /** Provider id used by the simplified login widget when supplied by the backend. */
+    provider_id?: string;
+};
+
+/**
+ * Configuration options for {@link Account#showSimplifiedLoginWidget}.
+ *
+ * @group Login & Widget
+ */
+export type SimplifiedLoginWidgetOptions = {
+    /** expected encoding of simplified login widget. Could be utf-8 (default), iso-8859-1 or iso-8859-15 */
+    encoding?: string;
+    /**
+     * expected locale of simplified login widget. Should be provided in a short format like 'nb',
+     * 'sv'. If not set, a value from the env variable is used.
+     */
+    locale?: 'nb' | 'sv' | 'fi' | 'da' | 'en';
+};
+
+export type SimplifiedLoginWidgetInitialParams = {
+    displayText: string;
+    env: string;
+    clientName: string;
+    clientId: string;
+    providerId?: string;
+    locale?: SimplifiedLoginWidgetOptions['locale'];
+    windowWidth: () => number;
+    windowOnResize: (handler: () => void) => void;
+};
+
+export type SimplifiedLoginWidgetHandler = () => void | Promise<void>;
+
+export type OpenSimplifiedLoginWidget = (
+    initialParams: SimplifiedLoginWidgetInitialParams,
+    loginHandler: SimplifiedLoginWidgetHandler,
+    loginNotYouHandler: SimplifiedLoginWidgetHandler,
+    initHandler: SimplifiedLoginWidgetHandler,
+    cancelLoginHandler: SimplifiedLoginWidgetHandler,
+) => unknown;
+
+export const hasOpenSimplifiedLoginWidget = (
+    targetWindow: Window,
+): targetWindow is Window & { openSimplifiedLoginWidget: OpenSimplifiedLoginWidget } => {
+    return typeof targetWindow.openSimplifiedLoginWidget === 'function';
+};

package/src/types/monetization.ts

@@ -0,0 +1,29 @@
+import type { AccountBaseConfig } from './common';
+import type { SessionUserId } from './session';
+
+/**
+ * Result returned by the Session Service `/hasAccess` endpoint, describing whether the user
+ * is entitled to a requested set of products/features.
+ *
+ * @group Access Checks
+ */
+export interface HasAccessResult {
+    /** Whether the user is entitled to at least one of the requested products/features. */
+    entitled: boolean;
+    /** How long this result stays valid, in seconds, before the cache entry expires. */
+    ttl: number;
+    /** Feature ids the user is allowed to access. */
+    allowedFeatures: string[];
+    /** User id the access result belongs to. */
+    userId: SessionUserId;
+    /** Globally unique user id the access result belongs to. */
+    uuid: string;
+    /** Signed response payload. */
+    sig: string;
+}
+
+/**
+ * Options accepted by the {@link Monetization} constructor.
+ */
+export type MonetizationOptions = Pick<AccountBaseConfig, 'clientId' | 'env' | 'window'> &
+    Partial<Pick<AccountBaseConfig, 'redirectUri' | 'sessionDomain'>>;

package/src/types/session.ts

@@ -0,0 +1,169 @@
+/* Copyright 2026 Schibsted Products & Technology AS. Licensed under the terms of the MIT license.
+ * See LICENSE.md in the project root.
+ */
+
+/**
+ * Numeric Schibsted Account user id.
+ *
+ * @group Session
+ */
+export type SessionUserId = number;
+
+// Session Service object payloads.
+
+/**
+ * Successful response returned from {@link Account#hasSession}.
+ *
+ * `result` means the has-session call itself succeeded. `result: true` means the user is
+ * connected to the merchant; `result: false` means a session may exist, but the user is not
+ * connected to this client.
+ *
+ * @group Session
+ */
+export type SessionSuccessResponse = {
+    /** Response status code. Example: 200. */
+    code?: number;
+    /** Response type. Example: 'OK'. */
+    type?: string;
+    /** Human-readable response description. Example: 'OK'. */
+    description?: string;
+    /**
+     * Is the user connected to the merchant? This means the merchant id is in the list of
+     * merchants connected to this user.
+     */
+    result: boolean;
+    /** Connection status string. Deprecated; use `Account.isConnected()`. Example: 'connected'. */
+    userStatus?: string;
+    /** Cookie base domain used as the `SP_ID` cookie domain fallback. Example: 'spid.no'. */
+    baseDomain?: string;
+    /** Legacy session id. Obsolete. Example: '58eca10fdbb9f6df72c3368f'. */
+    id?: string;
+    /** A numeric user id which is unique per realm (country). Example: 37162 */
+    userId?: SessionUserId;
+    /** Globally unique user id. Example: 'b3b23aa7-34f2-5d02-a10e-5a3455c6ab2c' */
+    uuid?: string;
+    /** Session token used for the `SP_ID` cookie. Example: 'eyJjbGllbnRfaWQ...'. */
+    sp_id?: string;
+    /** Session response TTL in seconds. Example: 300. */
+    expiresIn?: number;
+    /** Server time as a Unix timestamp in seconds. Example: 1506285759. */
+    serverTime?: number;
+    /**
+     * Example: 'NCdzXaz4ZRb7...' The sig parameter is a concatenation of an HMAC SHA-256
+     * signature string, a dot (.) and a base64url encoded JSON object (session).
+     * {@link http://techdocs.spid.no/sdks/js/response-signature-and-validation/}
+     */
+    sig?: string;
+    /** User display name. Example: 'batman'. */
+    displayName?: string;
+    /** User given name. Example: 'Bruce'. */
+    givenName?: string;
+    /** User family name. Example: 'Wayne'. */
+    familyName?: string;
+    /** User gender value. Example: 'male', 'female', 'undisclosed'. */
+    gender?: string;
+    /** User profile photo URL. Example: 'http://www.srv.com/some/picture.jpg' . */
+    photo?: string;
+    /** Whether tracking is enabled for this session. Example: true. */
+    tracking?: boolean;
+    /** Whether the client agreement is accepted. Example: true. */
+    clientAgreementAccepted?: boolean;
+    /** Whether the default agreement is accepted. Example: true. */
+    defaultAgreementAccepted?: boolean;
+    /** Pairwise user id for this client. Example: 'b2a23caa...'. */
+    pairId?: string;
+    /** User SDRN. Example: 'sdrn:spid.no:user:12345'. */
+    sdrn?: string;
+};
+
+/**
+ * Successful has-session response for a user connected to the merchant.
+ *
+ * @group Session
+ */
+export type ConnectedSessionResponse = SessionSuccessResponse & {
+    result: true;
+};
+
+/**
+ * Connected session response that also carries a usable user id.
+ *
+ * @group Session
+ */
+export type ConnectedSessionWithUserIdResponse = ConnectedSessionResponse & {
+    userId: SessionUserId;
+};
+
+/**
+ * Failure payload returned by Session Service.
+ *
+ * API and network failures usually reject with {@link SDKError}; this shape represents a failure
+ * payload when one is returned by Session Service and reaches the has-session flow.
+ *
+ * @group Session
+ */
+export type SessionFailureResponse = {
+    /** Failure payload returned by Session Service. Usually an object, but tests also pass strings. */
+    error: string | number | boolean | object;
+    response?: {
+        /** Response status code. Example: 404. */
+        code: number;
+        /** Response type. Example: 'NOT_FOUND'. */
+        type: string;
+        /** Human-readable response description. Example: 'No session found'. */
+        description: string;
+        /** Cookie base domain used as the `SP_ID` cookie domain fallback. Example: 'spid.no'. */
+        baseDomain?: string;
+        /** Time span in milliseconds. Example: 30 * 60 * 1000 (for 30 minutes) */
+        expiresIn?: number;
+        result?: boolean;
+        /** Server time in seconds since the Unix Epoch. Example: 1506287788 */
+        serverTime?: number;
+        [key: string]: string | number | boolean | object | null | undefined;
+    };
+};
+
+/**
+ * Object response that does not match one of the SDK-known has-session shapes.
+ *
+ * This intentionally includes `{}`. Historically `hasSession()` could resolve an empty object or
+ * other object payloads that callers inspected themselves, so the SDK preserves those responses.
+ *
+ * @group Session
+ */
+export type UnrecognizedSessionResponse = object;
+
+/**
+ * Redirect URL returned by `hasSession()` when Session Service needs a full-page session refresh.
+ *
+ * @group Session
+ */
+export type RedirectSessionResponse = string;
+
+export type SessionObjectResponse =
+    | SessionSuccessResponse
+    | SessionFailureResponse
+    | UnrecognizedSessionResponse;
+
+export type RedirectSessionPayload = {
+    redirectURL: string;
+};
+
+/**
+ * Internal shape returned by `normalizeSessionResponse()` before `hasSession()` post-processing.
+ *
+ * It includes regular Session Service object responses and redirect responses used for full-page
+ * session refresh.
+ */
+export type NormalizedSessionPayload = SessionObjectResponse | RedirectSessionPayload;
+
+/**
+ * Public response union returned from {@link Account#hasSession}.
+ *
+ * @group Session
+ */
+export type SessionResponse =
+    | SessionSuccessResponse
+    | SessionFailureResponse
+    | UnrecognizedSessionResponse
+    | RedirectSessionResponse;

package/src/{url.js → url.ts}

@@ -2,20 +2,16 @@
  * See LICENSE.md in the project root.
  */
 
-'use strict'
-
-import { assert, isNonEmptyString, isUrl, isNonEmptyObj } from './validate.js';
+import { assert, isNonEmptyObj, isNonEmptyString, isUrl } from './validate.js';
 
 /**
  * A simple utility function that allows looking up URLs from a dictionary
- * @memberof core
- * @param {string} url - A url like http://example.com, or a key used for lookup
- * @param {object<string,string>} urlMap - A map of URLs like
- * `{ DEV: 'http://dev.example.com' }`
- * @throws {SDKError} - If the url is not an string or is an empty string
- * @return {string} The url that points to the server
+ * @param url - A url like http://example.com, or a key used for lookup
+ * @param urlMap - A map of URLs like `{ DEV: 'http://dev.example.com' }`
+ * @returns The resolved URL: the mapped value when `url` is a known key, otherwise `url` itself
+ * @throws {SDKError} - If the url is not a string or is an empty string
  */
-export function urlMapper(url, urlMap) {
+export function urlMapper(url: string, urlMap: Record<string, string>): string {
     assert(isNonEmptyString(url), `"url" param must be a non empty string: ${typeof url}`);
     if (isNonEmptyObj(urlMap) && isUrl(urlMap[url])) {
         return urlMap[url];