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

package/src/monetization.d.ts

@@ -1,80 +0,0 @@
-/**
- * Provides features related to monetization
- */
-export class Monetization {
-    /**
-     * @param {object} options
-     * @param {string} options.clientId - Mandatory client id
-     * @param {string} options.redirectUri - Redirect uri
-     * @param {string} options.sessionDomain - Example: "https://id.site.com"
-     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO` or `PRO_NO`
-     * @param {object} [options.window]
-     * @throws {SDKError} - If any of options are invalid
-     */
-    constructor({ clientId, redirectUri, env, sessionDomain, window }: {
-        clientId: string;
-        redirectUri: string;
-        sessionDomain: string;
-        env?: string;
-        window?: any;
-    });
-    cache: any;
-    clientId: string;
-    env: string;
-    redirectUri: string;
-    /**
-     * Set SPiD server URL
-     * @private
-     * @param {string} url
-     * @returns {void}
-     */
-    private _setSpidServerUrl;
-    _spid: RESTClient;
-    /**
-     * Set session-service domain
-     * @private
-     * @param {string} domain - real URL — (**not** 'PRE' style env key)
-     * @returns {void}
-     */
-    private _setSessionServiceUrl;
-    _sessionService: RESTClient;
-    /**
-     * Checks if the user has access to a set of products or features.
-     * @param {array} productIds - which products/features to check
-     * @param {number} userId - id of currently logged in user
-     * @throws {SDKError} - If the input is incorrect, or a network call fails in any way
-     * (this will happen if, say, the user is not logged in)
-     * @returns {Object|null} The data object returned from Schibsted account (or `null` if the user
-     * doesn't have access to any of the given products/features)
-     */
-    hasAccess(productIds: any[], userId: number): any;
-    /**
-     * Removes the cached access result.
-     * @param {array} productIds - which products/features to check
-     * @param {number} userId - id of currently logged in user
-     * @returns {void}
-     */
-    clearCachedAccessResult(productIds: any[], userId: number): void;
-    /**
-     * Compute "has access" cache key for the given product ids and user id.
-     * @param {array} productIds - which products/features to check
-     * @param {number} userId - id of currently logged in user
-     * @returns {string}
-     * @private
-     */
-    private _accessCacheKey;
-    /**
-     * Get the url for the end user to review the subscriptions
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the subscriptions review page
-     */
-    subscriptionsUrl(redirectUri?: string): string;
-    /**
-     * Get the url for the end user to review the products
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the products review page
-     */
-    productsUrl(redirectUri?: string): string;
-}
-export default Monetization;
-import RESTClient from "./RESTClient.js";

package/src/payment.d.ts

@@ -1,115 +0,0 @@
-/**
- * Provides features related to payment
- */
-export class Payment {
-    /**
-     * @param {object} options
-     * @param {string} options.clientId - Mandatory client id
-     * @param {string} [options.redirectUri] - Redirect uri
-     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO` or `PRO_NO`
-     * @param {string} [options.publisher] - ZUORA publisher
-     * @param {object} [options.window]
-     *
-     * @throws {SDKError} - If any of options are invalid
-     */
-    constructor({ clientId, redirectUri, env, publisher, window }: {
-        clientId: string;
-        redirectUri?: string;
-        env?: string;
-        publisher?: string;
-        window?: any;
-    });
-    clientId: string;
-    redirectUri: string;
-    window: any;
-    publisher: string;
-    /**
-     * Set SPiD server URL
-     * @private
-     * @param {string} url - real URL or 'PRE' style key
-     * @returns {void}
-     */
-    private _setSpidServerUrl;
-    _spid: RESTClient;
-    /**
-     * Set BFF server URL - real URL or 'PRE' style key
-     * @private
-     * @param {string} url
-     * @returns {void}
-     */
-    private _setBffServerUrl;
-    _bff: RESTClient;
-    /**
-     * Close this.popup if it exists and is open
-     * @private
-     * @returns {void}
-     */
-    private _closePopup;
-    popup: Window;
-    /**
-     * Starts the flow for the paylink in a popup or current window
-     * @param {object} options
-     * @param {string} options.paylink - The paylink
-     * @param {boolean} [options.preferPopup=false] - Should we try to open a popup?
-     * @param {string} [options.redirectUri=this.redirectUri]
-     * @returns {Window|null} - Returns a reference to the popup window, or `null` if no popup was
-     * used
-     */
-    payWithPaylink({ paylink, preferPopup, redirectUri }: {
-        paylink: string;
-        preferPopup?: boolean;
-        redirectUri?: string;
-    }): Window;
-    /**
-     * Get the url for the end user to review the purchase history
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the purchase history review page
-     */
-    purchaseHistoryUrl(redirectUri?: string): string;
-    /**
-     * Get the url for the end user to redeem a voucher code
-     * @param {string} voucherCode
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url
-     */
-    redeemUrl(voucherCode: string, redirectUri?: string): string;
-    /**
-     * @deprecated https://schibsted.ghe.com/user-identity/account-sdk-browser/issues/94
-     *
-     * Get the url for the paylink purchase
-     * @todo Check working-ness for BFF + SPiD
-     * @param {string} paylinkId
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the API endpoint
-     */
-    purchasePaylinkUrl(paylinkId: string, redirectUri?: string): string;
-    /**
-     * Get the url for flow to purchase a product
-     * @param {string} productId
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the products review page
-     */
-    purchaseProductFlowUrl(productId: string, redirectUri?: string): string;
-    /**
-     * Get the url for flow to purchase a product through a campaign and voucher code
-     * @todo Check working-ness for BFF + SPiD
-     * @param {string} campaignId
-     * @param {string} productId
-     * @param {string} [voucherCode]
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the products review page
-     */
-    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
-     * the request and callback. It's also recommended to prevent CSRF
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the buy promo code product flow
-     */
-    purchasePromoCodeProductFlowUrl(code: string, state?: string, redirectUri?: string): string;
-}
-export default Payment;
-import RESTClient from "./RESTClient.js";

package/src/payment.js

@@ -1,211 +0,0 @@
-/* Copyright 2024 Schibsted Products & Technology AS. Licensed under the terms of the MIT license.
- * See LICENSE.md in the project root.
- */
-
-'use strict';
-
-import { assert, isNonEmptyString, isUrl, isStr } from './validate.js';
-import { urlMapper } from './url.js';
-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;
-
-/**
- * Provides features related to payment
- */
-export class Payment {
-    /**
-     * @param {object} options
-     * @param {string} options.clientId - Mandatory client id
-     * @param {string} [options.redirectUri] - Redirect uri
-     * @param {string} [options.env=PRE] - Schibsted account environment: `PRE`, `PRO` or `PRO_NO`
-     * @param {string} [options.publisher] - ZUORA publisher
-     * @param {object} [options.window]
-     *
-     * @throws {SDKError} - If any of options are invalid
-     */
-    constructor({ clientId, redirectUri, env = 'PRE', publisher, window = globalWindow() }) {
-        spidTalk.emulate(window);
-        assert(isNonEmptyString(clientId), 'clientId parameter is required');
-
-        this.clientId = clientId;
-        this.redirectUri = redirectUri;
-        this.window = window;
-        this.publisher = publisher;
-        this._setSpidServerUrl(env);
-        this._setBffServerUrl(env);
-        registerGlobal(window, 'Payment', this);
-    }
-
-    /**
-     * Set SPiD server URL
-     * @private
-     * @param {string} url - real URL or 'PRE' style key
-     * @returns {void}
-     */
-    _setSpidServerUrl(url) {
-        assert(isStr(url), `url parameter is invalid: ${url}`);
-        this._spid = new RESTClient({
-            serverUrl: urlMapper(url, ENDPOINTS.SPiD),
-            defaultParams: { client_id: this.clientId, redirect_uri: this.redirectUri },
-        });
-    }
-
-    /**
-     * Set BFF server URL - real URL or 'PRE' style key
-     * @private
-     * @param {string} url
-     * @returns {void}
-     */
-    _setBffServerUrl(url) {
-        assert(isStr(url), `url parameter is invalid: ${url}`);
-        this._bff = new RESTClient({
-            serverUrl: urlMapper(url, ENDPOINTS.BFF),
-            defaultParams: { client_id: this.clientId, redirect_uri: this.redirectUri },
-        });
-    }
-
-    /**
-     * Close this.popup if it exists and is open
-     * @private
-     * @returns {void}
-     */
-    _closePopup() {
-        if (this.popup) {
-            if (!this.popup.closed) {
-                this.popup.close();
-            }
-            this.popup = null;
-        }
-    }
-
-    /**
-     * Starts the flow for the paylink in a popup or current window
-     * @param {object} options
-     * @param {string} options.paylink - The paylink
-     * @param {boolean} [options.preferPopup=false] - Should we try to open a popup?
-     * @param {string} [options.redirectUri=this.redirectUri]
-     * @returns {Window|null} - Returns a reference to the popup window, or `null` if no popup was
-     * used
-     */
-    payWithPaylink({ paylink, preferPopup, redirectUri = this.redirectUri }) {
-        assert(isUrl(redirectUri), `payWithPaylink(): redirectUri is invalid`);
-        this._closePopup();
-        const url = this.purchasePaylinkUrl(paylink, redirectUri);
-        if (preferPopup) {
-            this.popup =
-                popup.open(this.window, url, 'Schibsted account', { width: 360, height: 570 });
-            if (this.popup) {
-                return this.popup;
-            }
-        }
-        this.window.location.href = url;
-        return null;
-    }
-
-    /**
-     * Get the url for the end user to review the purchase history
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the purchase history review page
-     */
-    purchaseHistoryUrl(redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `purchaseHistoryUrl(): redirectUri is invalid`);
-        return this._spid.makeUrl('account/purchasehistory', { redirect_uri: redirectUri });
-    }
-
-    /**
-     * Get the url for the end user to redeem a voucher code
-     * @param {string} voucherCode
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url
-     */
-    redeemUrl(voucherCode, redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `redeemUrl(): redirectUri is invalid`);
-        return this._spid.makeUrl('account/redeem', { voucher_code: voucherCode });
-    }
-
-    /**
-     * @deprecated https://schibsted.ghe.com/user-identity/account-sdk-browser/issues/94
-     *
-     * Get the url for the paylink purchase
-     * @todo Check working-ness for BFF + SPiD
-     * @param {string} paylinkId
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the API endpoint
-     */
-    purchasePaylinkUrl(paylinkId, redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `purchasePaylinkUrl(): redirectUri is invalid`);
-        assert(isNonEmptyString(paylinkId), `purchasePaylinkUrl(): paylinkId is required`);
-        return this._bff.makeUrl('payment/purchase', {
-            paylink: paylinkId,
-            redirect_uri: redirectUri
-        });
-    }
-
-    /**
-     * Get the url for flow to purchase a product
-     * @param {string} productId
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the products review page
-     */
-    purchaseProductFlowUrl(productId, redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `purchaseProductUrl(): redirectUri is invalid`);
-        assert(isNonEmptyString(productId), `purchaseProductFlowUrl(): productId is required`);
-        return this._bff.makeUrl('flow/checkout', {
-            response_type: 'code',
-            flow: 'payment',
-            product_id: productId,
-            redirect_uri: redirectUri
-        });
-    }
-
-    /**
-     * Get the url for flow to purchase a product through a campaign and voucher code
-     * @todo Check working-ness for BFF + SPiD
-     * @param {string} campaignId
-     * @param {string} productId
-     * @param {string} [voucherCode]
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the products review page
-     */
-    purchaseCampaignFlowUrl(campaignId, productId, voucherCode, redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `purchaseCampaignFlowUrl(): redirectUri is invalid`);
-        assert(isNonEmptyString(campaignId), `purchaseCampaignFlowUrl(): campaignId is required`);
-        assert(isNonEmptyString(productId), `purchaseCampaignFlowUrl(): productId is required`);
-        return this._bff.makeUrl('flow/checkout', {
-            response_type: 'code',
-            flow: 'payment',
-            campaign_id: campaignId,
-            product_id: productId,
-            voucher_code: voucherCode,
-            redirect_uri: redirectUri
-        });
-    }
-
-    /**
-     * @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
-     * the request and callback. It's also recommended to prevent CSRF
-     * @param {string} [redirectUri=this.redirectUri]
-     * @return {string} - The url to the buy promo code product flow
-     */
-    purchasePromoCodeProductFlowUrl(code, state = '', redirectUri = this.redirectUri) {
-        assert(isUrl(redirectUri), `purchasePromoCodeProductFlowUrl(): redirectUri is invalid`);
-        assert(isNonEmptyString(code), `purchasePromoCodeProductFlowUrl(): code is required`);
-        assert(isNonEmptyString(this.publisher), `purchasePromoCodeProductFlowUrl(): publisher is required in the constructor`);
-        return this._bff.makeUrl('payment/purchase/code', {
-            code,
-            publisher: this.publisher,
-            state,
-            redirect_uri: redirectUri
-        });
-    }
-}
-
-export default Payment;

package/src/popup.d.ts

@@ -1,10 +0,0 @@
-/**
- * Opens a popup
- * @param {Window} parentWindow - A reference to the window that will open the popup
- * @param {string} url - The URL that the popup will open
- * @param {string} [windowName] - A name for the window
- * @param {object} [windowFeatures] - Window features for the popup (default ones are usually ok)
- * @returns {Window|null} - A reference to the popup window
- * @private
- */
-export function open(parentWindow: Window, url: string, windowName?: string, windowFeatures?: any): Window;

package/src/popup.js

@@ -1,59 +0,0 @@
-/* Copyright 2024 Schibsted Products & Technology AS. Licensed under the terms of the MIT license.
- * See LICENSE.md in the project root.
- */
-
-import { assert, isObject, isUrl, isFunction } from './validate.js';
-import { cloneDefined } from './object.js';
-
-/**
- * Serializes an object to string.
- * @memberof core
- * @private
- * @param {object} obj - for example {a: 'b', c: 1}
- * @return {string} - for example 'a=b,c=1'
- */
-function serialize(obj) {
-    assert(isObject(obj), `Object must be an object but it is '${obj}'`);
-    return Object.keys(obj)
-        .map(key => `${key}=${obj[key]}`)
-        .join(',');
-}
-
-const defaultWindowFeatures = {
-    scrollbars: 'yes',
-    location: 'yes',
-    status: 'no',
-    menubar: 'no',
-    toolbar: 'no',
-    resizable: 'yes'
-};
-
-/**
- * Opens a popup
- * @param {Window} parentWindow - A reference to the window that will open the popup
- * @param {string} url - The URL that the popup will open
- * @param {string} [windowName] - A name for the window
- * @param {object} [windowFeatures] - Window features for the popup (default ones are usually ok)
- * @returns {Window|null} - A reference to the popup window
- * @private
- */
-export function open(parentWindow, url, windowName = '', windowFeatures = {}) {
-    assert(isObject(parentWindow), `window was supposed to be an object but it is ${parentWindow}`);
-    assert(isObject(parentWindow.screen),
-        `window should be a valid Window object but it lacks a 'screen' property`);
-    assert(isFunction(parentWindow.open),
-        `window should be a valid Window object but it lacks an 'open' function`);
-    assert(isUrl(url), 'Invalid URL for popup');
-
-    const { height, width } = parentWindow.screen;
-
-    let mergedFeatures = cloneDefined(defaultWindowFeatures, windowFeatures);
-    if (Number.isFinite(mergedFeatures.width) && Number.isFinite(width)) {
-        mergedFeatures.left = (width - mergedFeatures.width) / 2;
-    }
-    if (Number.isFinite(mergedFeatures.height) && Number.isFinite(height)) {
-        mergedFeatures.top = (height - mergedFeatures.height) / 2;
-    }
-    const features = serialize(mergedFeatures);
-    return parentWindow.open(url, windowName, features);
-}

package/src/url.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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
- */
-export function urlMapper(url: string, urlMap: any): string;

package/src/validate.d.ts

@@ -1,64 +0,0 @@
-/**
- * A utility function that throws an SDKError if an assertion fails. It's mostly useful for
- * validating function inputs.
- * @memberof core
- * @param {boolean} condition - The condition that we're asserting
- * @param {string} [message = Assertion failed] - The error message
- * @throws {SDKError} - If the condition is falsy it throws the appropriate error
- * @return {void}
- */
-export function assert(condition: boolean, message?: string): void;
-/**
- * Checks if a value is a string or not
- * @memberof core
- * @param {*} value - The value to check
- * @return {boolean}
- */
-export function isStr(value: any): boolean;
-/**
- * Checks if a value is a non-empty string
- * @memberof core
- * @param {*} value - The value to check
- * @return {boolean}
- */
-export function isNonEmptyString(value: any): boolean;
-/**
- * checks if a given value is an object (but not null)
- * @memberof core
- * @param {*} value - The value to check
- * @return {boolean}
- */
-export function isObject(value: any): boolean;
-/**
- * Checks if a given value is an object with at least one own key
- * @memberof core
- * @param {*} value - The value to check
- * @return {boolean}
- */
-export function isNonEmptyObj(value: any): boolean;
-/**
- * Checks if a given string is a valid URL
- * @memberof core
- * @param {string} value - The string to be tested
- * @param {...string} mandatoryFields - A list of mandatory fields that should exist in the parsed
- * URL object
- * @return {boolean}
- */
-export function isUrl(value: string, ...mandatoryFields: string[]): boolean;
-/**
- * Checks if a given value is a function
- * @memberof core
- * @param {*} value - The value to check
- * @return {boolean}
- */
-export function isFunction(value: any): boolean;
-/**
- * Checks if a string matches any of the strings in a set of possibilities
- * @memberof core
- * @param {string} value
- * @param {string[]} possibilities - An array of strings that'll be used to check the string
- * inclusion. Note that for performance reasons, we don't validate this parameter.
- * @param {boolean} [caseSensitive=false] - Should the check be case sensitive
- * @return {boolean}
- */
-export function isStrIn(value: string, possibilities: string[], caseSensitive?: boolean): boolean;

package/src/version.d.ts

@@ -1,2 +0,0 @@
-declare const version: string;
-export default version;