@schibsted/account-sdk-browser 5.2.2 → 5.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schibsted/account-sdk-browser",
-  "version": "5.2.2",
+  "version": "5.2.5",
   "description": "Schibsted account SDK for browsers",
   "main": "index.js",
   "type": "module",

package/src/global-registry.js

@@ -0,0 +1,20 @@
+
+/**
+ * Registers a component as a property on the provided global object, if not already registered, and dispatches an event to notify listeners.
+ * The event is dispatched on `document` and will have the name `$sch${componentClassName}:ready` and a `detail` property with the instance.
+ *
+ * @param {any} global typically `window`
+ * @param {string} componentClassName the name of the component to register, 'identity', 'monetization' or 'payment'
+ * @param {any} instance the instance of the component to register
+ * @returns {void}
+ */
+export const registerGlobal = (global, componentClassName, instance) => {
+    const prefixedName = `sch${componentClassName}`;
+    if (!(global)[prefixedName]) {
+        (global)[prefixedName] = instance;
+    }
+    if (typeof global.dispatchEvent === 'function') {
+        global.dispatchEvent(new CustomEvent(`${prefixedName}:ready`, { detail: { instance } }));
+    }
+}
+

package/src/identity.d.ts

@@ -305,9 +305,11 @@ export class Identity extends TinyEmitter {
      * @param {boolean} [options.oneStepLogin=false]
      * @param {string} [options.prompt=select_account]
      * @param {string} [options.xDomainId]
+     * @param {string} [options.xEnvironmentId]
+     * @param {string} [options.originCampaign]
      * @return {Window|null} - Reference to popup window if created (or `null` otherwise)
      */
-    login({ state, acrValues, scope, redirectUri, preferPopup, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, xDomainId }: LoginOptions): Window | null;
+    login({ state, acrValues, scope, redirectUri, preferPopup, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, xDomainId, xEnvironmentId, originCampaign }: LoginOptions): Window | null;
     /**
      * @async
      * @summary Retrieve the sp_id (Varnish ID)
@@ -337,9 +339,12 @@ export class Identity extends TinyEmitter {
      * @param {string} [options.locale]
      * @param {boolean} [options.oneStepLogin=false]
      * @param {string} [options.prompt=select_account]
+     * @param {string} [options.xDomainId]
+     * @param {string} [options.xEnvironmentId]
+     * @param {string} [options.originCampaign]
      * @return {string} - The url
      */
-    loginUrl({ state, acrValues, scope, redirectUri, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, }: LoginOptions, ...args: any[]): string;
+    loginUrl({ state, acrValues, scope, redirectUri, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, xDomainId, xEnvironmentId, originCampaign }: LoginOptions, ...args: any[]): string;
     /**
      * The url for logging the user out
      * @param {string} [redirectUri=this.redirectUri]
@@ -444,7 +449,14 @@ export type LoginOptions = {
      * - 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;
 };
 export type SimplifiedLoginWidgetLoginOptions = {
     /**
@@ -518,6 +530,15 @@ export type SimplifiedLoginWidgetLoginOptions = {
      * - 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;
+
 };
 export type HasSessionSuccessResponse = {
     /**

package/src/identity.js

@@ -15,6 +15,7 @@ import RESTClient from './RESTClient.js';
 import SDKError from './SDKError.js';
 import * as spidTalk from './spidTalk.js';
 import version from './version.js';
+import { registerGlobal } from './global-registry.js';
 
 /**
  * @typedef {object} LoginOptions
@@ -26,7 +27,7 @@ import version from './version.js';
  * `password` (will force password confirmation, even if user is already logged in), `eid`. Those values might
  * be mixed as space-separated string. To make sure that user has authenticated with 2FA you need
  * to verify AMR (Authentication Methods References) claim in ID token.
- * Might also be used to ensure additional acr (sms, otp) for already logged in users.
+ * Might also be used to ensure additional acr (sms, otp) for already logged-in users.
  * Supported value is also 'otp-email' means one time password using email.
  * @property {string} [scope] - 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
@@ -36,7 +37,7 @@ import version from './version.js';
  * @property {string} [redirectUri] - Redirect uri that will receive the
  * code. Must exactly match a redirectUri from your client in self-service
  * @property {boolean} [preferPopup] - Should we try to open a popup window?
- * @property {string} [loginHint] - user email or UUID hint
+ * @property {string} [loginHint] - User email or UUID hint
  * @property {string} [tag] - Pulse tag
  * @property {string} [teaser] - Teaser slug. Teaser with given slug will be displayed
  * in place of default teaser
@@ -46,9 +47,12 @@ import version from './version.js';
  * spec section 3.1.2.1 for more information
  * @property {string} [locale] - Optional parameter to overwrite client locale setting.
  * New flows supports nb_NO, fi_FI, sv_SE, en_US
- * @property {boolean} [oneStepLogin] - display username and password on one screen
+ * @property {boolean} [oneStepLogin] - Display username and password on one screen
  * @property {string} [prompt] - String that specifies whether the Authorization Server prompts the
- * End-User for reauthentication or confirm account screen. Supported values: `select_account` or `login`
+ * End-User for re-authentication or confirm account screen. Supported values: `select_account` or `login`
+ * @property {string} [xDomainId] - Identifier for cross-domain tracking in Pulse
+ * @property {string} [xEnvironmentId] - Environment for cross-domain tracking in Pulse
+ * @property {string} [originCampaign] - Campaign identifier for tracking in Pulse
  */
 /**
  * @typedef {object} SimplifiedLoginWidgetLoginOptions
@@ -60,7 +64,7 @@ import version from './version.js';
  * `password` (will force password confirmation, even if user is already logged in). Those values might
  * be mixed as space-separated string. To make sure that user has authenticated with 2FA you need
  * to verify AMR (Authentication Methods References) claim in ID token.
- * Might also be used to ensure additional acr (sms, otp) for already logged in users.
+ * Might also be used to ensure additional acr (sms, otp) for already logged-in users.
  * Supported value is also 'otp-email' means one time password using email.
  * @property {string} [scope] - 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
@@ -70,7 +74,7 @@ import version from './version.js';
  * @property {string} [redirectUri] - Redirect uri that will receive the
  * code. Must exactly match a redirectUri from your client in self-service
  * @property {boolean} [preferPopup] - Should we try to open a popup window?
- * @property {string} [loginHint] - user email or UUID hint
+ * @property {string} [loginHint] - User email or UUID hint
  * @property {string} [tag] - Pulse tag
  * @property {string} [teaser] - Teaser slug. Teaser with given slug will be displayed
  * in place of default teaser
@@ -80,9 +84,12 @@ import version from './version.js';
  * spec section 3.1.2.1 for more information
  * @property {string} [locale] - Optional parameter to overwrite client locale setting.
  * New flows supports nb_NO, fi_FI, sv_SE, en_US
- * @property {boolean} [oneStepLogin] - display username and password on one screen
+ * @property {boolean} [oneStepLogin] - Display username and password on one screen
  * @property {string} [prompt] - String that specifies whether the Authorization Server prompts the
  * End-User for reauthentication or confirm account screen. Supported values: `select_account` or `login`
+ * @property {string} [xDomainId] - Identifier for cross-domain tracking in Pulse
+ * @property {string} [xEnvironmentId] - Environment for cross-domain tracking in Pulse
+ * @property {string} [originCampaign] - Campaign identifier for tracking in Pulse
  */
 
 /**
@@ -212,6 +219,9 @@ export class Identity extends EventEmitter {
         this._setGlobalSessionServiceUrl(env);
 
         this._unblockSessionCall();
+
+        registerGlobal(window, 'Identity', this);
+
     }
 
     /**
@@ -834,6 +844,7 @@ export class Identity extends EventEmitter {
             return null;
         }
     }
+
     /**
      * If a popup is desired, this function needs to be called in response to a user event (like
      * click or tap) in order to work correctly. Otherwise the popup will be blocked by the
@@ -855,6 +866,8 @@ export class Identity extends EventEmitter {
      * @param {boolean} [options.oneStepLogin=false]
      * @param {string} [options.prompt=select_account]
      * @param {string} [options.xDomainId]
+     * @param {string} [options.xEnvironmentId]
+     * @param {string} [options.originCampaign]
      * @return {Window|null} - Reference to popup window if created (or `null` otherwise)
      */
     login({
@@ -870,7 +883,9 @@ export class Identity extends EventEmitter {
         locale = '',
         oneStepLogin = false,
         prompt = 'select_account',
-        xDomainId = ''
+        xDomainId = '',
+        xEnvironmentId = '',
+        originCampaign = ''
     }) {
         this._closePopup();
         this.sessionStorageCache.delete(HAS_SESSION_CACHE_KEY);
@@ -886,7 +901,9 @@ export class Identity extends EventEmitter {
             locale,
             oneStepLogin,
             prompt,
-            xDomainId
+            xDomainId,
+            xEnvironmentId,
+            originCampaign
         });
 
         if (preferPopup) {
@@ -943,6 +960,9 @@ export class Identity extends EventEmitter {
      * @param {string} [options.locale]
      * @param {boolean} [options.oneStepLogin=false]
      * @param {string} [options.prompt=select_account]
+     * @param {string} [options.xDomainId]
+     * @param {string} [options.xEnvironmentId]
+     * @param {string} [options.originCampaign]
      * @return {string} - The url
      */
     loginUrl({
@@ -957,7 +977,9 @@ export class Identity extends EventEmitter {
         locale = '',
         oneStepLogin = false,
         prompt = 'select_account',
-        xDomainId = ''
+        xDomainId = '',
+        xEnvironmentId = '',
+        originCampaign = ''
     }) {
         if (typeof arguments[0] !== 'object') {
             // backward compatibility
@@ -991,7 +1013,9 @@ export class Identity extends EventEmitter {
             locale,
             one_step_login: oneStepLogin || '',
             prompt: acrValues ? '' : prompt,
-            x_domain_id: xDomainId
+            x_domain_id: xDomainId,
+            x_env_id: xEnvironmentId,
+            utm_campaign: originCampaign
         });
     }
 
@@ -1061,7 +1085,6 @@ export class Identity extends EventEmitter {
             return loginPrams;
         }
 
-
         return new Promise(
             (resolve, reject) => {
                 if (!userData || !userData.display_text || !userData.identifier) {

package/src/monetization.js

@@ -13,6 +13,7 @@ import Cache from './cache.js';
 import * as spidTalk from './spidTalk.js';
 import SDKError from './SDKError.js';
 import version from './version.js';
+import { registerGlobal } from './global-registry.js';
 
 const globalWindow = () => window;
 
@@ -45,6 +46,7 @@ export class Monetization extends EventEmitter {
             assert(isUrl(sessionDomain), 'sessionDomain parameter is not a valid URL');
             this._setSessionServiceUrl(sessionDomain);
         }
+        registerGlobal(window, 'Monetization', this);
     }
 
     /**

package/src/payment.js

@@ -10,6 +10,7 @@ import { ENDPOINTS } from './config.js';
 import * as popup from './popup.js';
 import RESTClient from './RESTClient.js';
 import * as spidTalk from './spidTalk.js';
+import { registerGlobal } from './global-registry.js';
 
 const globalWindow = () => window;
 
@@ -37,6 +38,7 @@ export class Payment {
         this.publisher = publisher;
         this._setSpidServerUrl(env);
         this._setBffServerUrl(env);
+        registerGlobal(window, 'Payment', this);
     }
 
     /**

package/src/version.js

@@ -1,5 +1,5 @@
 // Automatically generated in 'npm version' by scripts/genversion.js
 
 'use strict'
-const version = '5.2.2';
+const version = '5.2.5';
 export default version;