@schibsted/account-sdk-browser 4.3.0 → 4.5.3

package/identity.d.ts

@@ -0,0 +1 @@
+export * from "./src/identity.js";

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./identity.js";
 export * from "./monetization.js";
 export * from "./payment.js";
+export { default as SDKError } from "./src/SDKError.js";

package/monetization.d.ts

@@ -0,0 +1 @@
+export * from "./src/monetization.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schibsted/account-sdk-browser",
-  "version": "4.3.0",
+  "version": "4.5.3",
   "description": "Schibsted account SDK for browsers",
   "main": "index.js",
   "scripts": {

package/payment.d.ts

@@ -0,0 +1 @@
+export * from "./src/payment.js";

package/src/config.d.ts

@@ -12,17 +12,23 @@ export const NAMESPACE: any;
  * @prop {string} ENDPOINTS.SPiD.PRE - Staging environment
  * @prop {string} ENDPOINTS.SPiD.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.SPiD.PRO_NO - Production environment Norway
+ * @prop {string} ENDPOINTS.SPiD.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.SPiD.PRO_DK - Production environment Denmark
  * @prop {object} ENDPOINTS.BFF - Endpoints used with new GDPR-compliant web flows
  * @prop {string} ENDPOINTS.BFF.LOCAL - Local endpoint (for Identity team)
  * @prop {string} ENDPOINTS.BFF.DEV - Dev environment (for Identity team)
  * @prop {string} ENDPOINTS.BFF.PRE - Staging environment
  * @prop {string} ENDPOINTS.BFF.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.BFF.PRO_NO - Production environment Norway
+ * @prop {string} ENDPOINTS.BFF.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.BFF.PRO_DK - Production environment Denmark
  * @prop {object} ENDPOINTS.SESSION_SERVICE - Endpoints to check global user session data
  * @prop {string} ENDPOINTS.SESSION_SERVICE.LOCAL - Local endpoint (for Identity team)
  * @prop {string} ENDPOINTS.SESSION_SERVICE.DEV - Dev environment (for Identity team)
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRE - Staging environment
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_NO - Production environment Norway
+ * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_DK - Production environment Denmark
  */
 declare const config: Object;

package/src/config.js

@@ -29,6 +29,7 @@
  * @prop {string} ENDPOINTS.SPiD.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.SPiD.PRO_NO - Production environment Norway
  * @prop {string} ENDPOINTS.SPiD.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.SPiD.PRO_DK - Production environment Denmark
  * @prop {object} ENDPOINTS.BFF - Endpoints used with new GDPR-compliant web flows
  * @prop {string} ENDPOINTS.BFF.LOCAL - Local endpoint (for Identity team)
  * @prop {string} ENDPOINTS.BFF.DEV - Dev environment (for Identity team)
@@ -36,6 +37,7 @@
  * @prop {string} ENDPOINTS.BFF.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.BFF.PRO_NO - Production environment Norway
  * @prop {string} ENDPOINTS.BFF.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.BFF.PRO_DK - Production environment Denmark
  * @prop {object} ENDPOINTS.SESSION_SERVICE - Endpoints to check global user session data
  * @prop {string} ENDPOINTS.SESSION_SERVICE.LOCAL - Local endpoint (for Identity team)
  * @prop {string} ENDPOINTS.SESSION_SERVICE.DEV - Dev environment (for Identity team)
@@ -43,6 +45,7 @@
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO - Production environment Sweden
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_NO - Production environment Norway
  * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_FI - Production environment Finland
+ * @prop {string} ENDPOINTS.SESSION_SERVICE.PRO_DK - Production environment Denmark
  */
 const config = {
     ENDPOINTS: {
@@ -53,6 +56,7 @@ const config = {
             PRO: 'https://login.schibsted.com',
             PRO_NO: 'https://payment.schibsted.no',
             PRO_FI: 'https://login.schibsted.fi',
+            PRO_DK: 'https://login.schibsted.dk',
         },
         BFF: {
             LOCAL: 'http://id.localhost/authn/',
@@ -61,6 +65,7 @@ const config = {
             PRO: 'https://login.schibsted.com/authn/',
             PRO_NO: 'https://payment.schibsted.no/authn/',
             PRO_FI: 'https://login.schibsted.fi/authn/',
+            PRO_DK: 'https://login.schibsted.dk/authn/',
         },
         SESSION_SERVICE: {
             LOCAL: 'http://session-service.id.localhost',
@@ -69,6 +74,7 @@ const config = {
             PRO: 'https://session-service.login.schibsted.com',
             PRO_NO: 'https://session-service.payment.schibsted.no',
             PRO_FI: 'https://session-service.login.schibsted.fi',
+            PRO_DK: 'https://session-service.login.schibsted.dk',
         },
     },
     NAMESPACE: {
@@ -78,6 +84,7 @@ const config = {
         PRO: 'schibsted.com',
         PRO_NO: 'spid.no',
         PRO_FI: 'schibsted.fi',
+        PRO_DK: 'schibsted.dk',
     }
 };
 

package/src/identity.d.ts

@@ -7,7 +7,7 @@ export class Identity {
      * @param {string} options.clientId - Example: "1234567890abcdef12345678"
      * @param {string} options.sessionDomain - Example: "https://id.site.com"
      * @param {string} options.redirectUri - Example: "https://site.com"
-     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO` or `PRO_NO`
+     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO`, `PRO_NO`, `PRO_FI` or `PRO_DK`
      * @param {function} [options.log] - A function that receives debug log information. If not set,
      * no logging will be done
      * @param {object} [options.window] - window object
@@ -92,16 +92,16 @@ export class Identity {
      * @param {object} [options]
      * @param {number} [options.expiresIn] Override this to set number of seconds before the varnish
      * cookie expires. The default is to use the same time that hasSession responses are cached for
-     * @param {boolean} [options.domain] Override cookie domain. E.g. «vg.no» instead of «www.vg.no»
+     * @param {string} [options.domain] Override cookie domain. E.g. «vg.no» instead of «www.vg.no»
      * @returns {void}
      */
     enableVarnishCookie(options?: {
         expiresIn?: number;
-        domain?: boolean;
+        domain?: string;
     }): void;
     setVarnishCookie: boolean;
     varnishExpiresIn: number;
-    varnishCookieDomain: boolean;
+    varnishCookieDomain: string;
     /**
      * Set the Varnish cookie if configured
      * @private
@@ -237,10 +237,10 @@ export class Identity {
      * @param {number|string} [options.maxAge]
      * @param {string} [options.locale]
      * @param {boolean} [options.oneStepLogin=false]
-     * @param {string} [options.prompt]
+     * @param {string} [options.prompt=select_account]
      * @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 }: LoginOptions): Window;
+    login({ state, acrValues, scope, redirectUri, preferPopup, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt }: LoginOptions): Window | null;
     /**
      * @async
      * @summary Retrieve the sp_id (Varnish ID)
@@ -269,7 +269,7 @@ export class Identity {
      * @param {number|string} [options.maxAge]
      * @param {string} [options.locale]
      * @param {boolean} [options.oneStepLogin=false]
-     * @param {string} [options.prompt]
+     * @param {string} [options.prompt=select_account]
      * @return {string} - The url
      */
     loginUrl({ state, acrValues, scope, redirectUri, loginHint, tag, teaser, maxAge, locale, oneStepLogin, prompt, }: LoginOptions, ...args: any[]): string;
@@ -297,11 +297,12 @@ export class Identity {
      * and store that info in localStorage. Widget will be display only if user is logged in to SSO.
      *
      * @async
-     * @param {LoginOptions} loginParams - the same as `options` param for login function. Login will be called on user
+     * @param {SimplifiedLoginWidgetLoginOptions} loginParams - the same as `options` param for login function. Login will be called on user
      * continue action. `state` might be string or async function.
+     * @param {SimplifiedLoginWidgetOptions} [options] - additional configuration of Simplified Login Widget
      * @return {Promise<boolean|SDKError>} - will resolve to true if widget will be display. Otherwise will throw SDKError
      */
-    showSimplifiedLoginWidget(loginParams: LoginOptions): Promise<boolean | SDKError>;
+    showSimplifiedLoginWidget(loginParams: SimplifiedLoginWidgetLoginOptions, options?: SimplifiedLoginWidgetOptions): Promise<boolean | SDKError>;
 }
 export default Identity;
 export type LoginOptions = {
@@ -352,6 +353,76 @@ export type LoginOptions = {
      * 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
+     */
+    maxAge?: number | string;
+    /**
+     * - Optional parameter to overwrite client locale setting.
+     * New flows supports nb_NO, fi_FI, sv_SE, en_US
+     */
+    locale?: string;
+    /**
+     * - display username and password on one screen
+     */
+    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`
+     */
+    prompt?: string;
+};
+export type SimplifiedLoginWidgetLoginOptions = {
+    /**
+     * - 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>));
+    /**
+     * - Authentication Context Class Reference Values. If
+     * omitted, the user will be asked to authenticate using username+password.
+     * For 2FA (Two-Factor Authentication) possible values are `sms`, `otp` (one time password) and
+     * `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.
+     * Supported values are also 'otp-email' means one time password using email, and 'otp-sms' means
+     * one time password using sms.
+     */
+    acrValues?: 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}
+     */
+    scope?: 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?
+     */
+    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
@@ -498,5 +569,11 @@ export type SimplifiedLoginData = {
      */
     client_name: string;
 };
+export type SimplifiedLoginWidgetOptions = {
+    /**
+     * - expected encoding of simplified login widget. Could be utf-8 (default), iso-8859-1 or iso-8859-15
+     */
+    encoding: string;
+};
 import RESTClient from "./RESTClient";
 import SDKError from "./SDKError";

package/src/identity.js

@@ -48,7 +48,42 @@ const { version } = require('../package.json');
  * @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 {string} [prompt] - String that specifies whether the Authorization Server prompts the
+ * @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`
+ */
+/**
+ * @typedef {object} SimplifiedLoginWidgetLoginOptions
+ * @property {string|function(): (string|Promise<string>)} 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}
+ * @property {string} [acrValues] - Authentication Context Class Reference Values. If
+ * omitted, the user will be asked to authenticate using username+password.
+ * For 2FA (Two-Factor Authentication) possible values are `sms`, `otp` (one time password) and
+ * `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.
+ * Supported values are also 'otp-email' means one time password using email, and 'otp-sms' means
+ * one time password using sms.
+ * @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
+ * 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}
+ * @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} [tag] - Pulse tag
+ * @property {string} [teaser] - Teaser slug. Teaser with given slug will be displayed
+ * in place of default teaser
+ * @property {number|string} [maxAge] - 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
+ * @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 {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`
  */
 
@@ -104,6 +139,11 @@ const { version } = require('../package.json');
  * @property {string} client_name - Client name
  */
 
+/**
+ * @typedef {object} SimplifiedLoginWidgetOptions
+ * @property {string} encoding - expected encoding of simplified login widget. Could be utf-8 (default), iso-8859-1 or iso-8859-15
+ */
+
 const HAS_SESSION_CACHE_KEY = 'hasSession-cache';
 const globalWindow = () => window;
 
@@ -116,7 +156,7 @@ export class Identity extends EventEmitter {
      * @param {string} options.clientId - Example: "1234567890abcdef12345678"
      * @param {string} options.sessionDomain - Example: "https://id.site.com"
      * @param {string} options.redirectUri - Example: "https://site.com"
-     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO` or `PRO_NO`
+     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO`, `PRO_NO`, `PRO_FI` or `PRO_DK`
      * @param {function} [options.log] - A function that receives debug log information. If not set,
      * no logging will be done
      * @param {object} [options.window] - window object
@@ -315,7 +355,7 @@ export class Identity extends EventEmitter {
      * @param {object} [options]
      * @param {number} [options.expiresIn] Override this to set number of seconds before the varnish
      * cookie expires. The default is to use the same time that hasSession responses are cached for
-     * @param {boolean} [options.domain] Override cookie domain. E.g. «vg.no» instead of «www.vg.no»
+     * @param {string} [options.domain] Override cookie domain. E.g. «vg.no» instead of «www.vg.no»
      * @returns {void}
      */
     enableVarnishCookie(options) {
@@ -808,14 +848,20 @@ export class Identity extends EventEmitter {
      * and store that info in localStorage. Widget will be display only if user is logged in to SSO.
      *
      * @async
-     * @param {LoginOptions} loginParams - the same as `options` param for login function. Login will be called on user
+     * @param {SimplifiedLoginWidgetLoginOptions} loginParams - the same as `options` param for login function. Login will be called on user
      * continue action. `state` might be string or async function.
+     * @param {SimplifiedLoginWidgetOptions} [options] - additional configuration of Simplified Login Widget
      * @return {Promise<boolean|SDKError>} - will resolve to true if widget will be display. Otherwise will throw SDKError
      */
-    async showSimplifiedLoginWidget(loginParams) {
+    async showSimplifiedLoginWidget(loginParams, options) {
         // getUserContextData doens't throw exception
         const userData = await this.getUserContextData();
-        const widgetUrl = this._bffService.makeUrl('simplified-login-widget', { client_id: this.clientId }, false);
+
+        const queryParams = { client_id: this.clientId };
+        if (options && options.encoding) {
+            queryParams.encoding = options.encoding;
+        }
+        const widgetUrl = this._bffService.makeUrl('simplified-login-widget', queryParams, false);
 
         const prepareLoginParams = async (loginPrams) => {
             if (typeof loginPrams.state === 'function') {

package/src/payment.d.ts

@@ -101,6 +101,7 @@ export class Payment {
      */
     purchaseCampaignFlowUrl(campaignId: string, productId: string, voucherCode?: string, redirectUri?: string): string;
     /**
+     * @deprecated
      * Get the url for flow to purchase a promo code product with ZUORA
      * @param {string} code - promocode product code
      * @param {string} [state=''] - An opaque value used by the client to maintain state between

package/src/payment.js

@@ -185,6 +185,7 @@ export class Payment {
     }
 
     /**
+     * @deprecated
      * Get the url for flow to purchase a promo code product with ZUORA
      * @param {string} code - promocode product code
      * @param {string} [state=''] - An opaque value used by the client to maintain state between