@configura/web-api 2.0.0-alpha.8 → 2.0.0

package/dist/io/CfgHistoryManager.js

@@ -1,82 +1,144 @@
-import { mapQueryString, unmapQueryString } from "@configura/web-utilities";
-import { CfgIOManager } from "./CfgIOManager.js";
-import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
-/**
- * This class is used to coordinate writing and reading to the browser history.
- * It handles messages sent from the connectors.
- */
-export class CfgHistoryManager extends CfgWindowEventManager {
-    constructor() {
-        super();
-        this.eventType = "popstate";
-    }
-    static get instance() {
-        if (this._instance === undefined) {
-            this._instance = new CfgHistoryManager();
-        }
-        return this._instance;
-    }
-    /**
-     * Write to the history
-     */
-    send(messageKey, data) {
-        const { qsKeyValues, message, useHistoryPush } = data;
-        // Initial data is before user interaction has happened
-        const initial = message.initial;
-        // At initial we do not replace the URL as we presumable have the defaults
-        const newUrl = initial ? null : CfgHistoryManager._makeUpdatedUrl(qsKeyValues);
-        // ...but we do replace the state so that we can in the future browse back to here
-        const newState = CfgHistoryManager._makeUpdatedState(window.history.state, message, messageKey);
-        if (initial || !useHistoryPush || this.receiveInProgress) {
-            window.history.replaceState(newState, "", newUrl);
-        }
-        else {
-            window.history.pushState(newState, "", newUrl);
-        }
-    }
-    /**
-     * Takes the current in browser URL and updates it with the provided Query String values.
-     * Old Query String is replaced.
-     */
-    static _makeUpdatedUrl(qsKeyValues) {
-        const qs = this._makeUpdatedQueryString(qsKeyValues);
-        return `${window.location.origin}${window.location.pathname}${qs ? "?" : ""}${qs}${window.location.hash}`;
-    }
-    /**
-     * Returns the current in browser Query String updated with the key values provided.
-     * If a value is undefined in the passed map it will be deleted from the Query String.
-     */
-    static _makeUpdatedQueryString(qsKeyValues) {
-        const currentKeyValues = this.currentQsKeyValues();
-        for (const [key, value] of qsKeyValues) {
-            if (value === undefined) {
-                currentKeyValues.delete(key);
-            }
-            else {
-                currentKeyValues.set(key, value);
-            }
-        }
-        return unmapQueryString(currentKeyValues);
-    }
-    /**
-     * @returns The current in browser Query String as a Map
-     */
-    static currentQsKeyValues() {
-        return mapQueryString(window.location.search);
-    }
-    /**
-     * If the passed currentState is a CfgIOContainer it will update it with the
-     * passed message. If not it will create a new CfgIOContainer with the message.
-     */
-    static _makeUpdatedState(currentState, message, messageKey) {
-        let messages = {};
-        if (CfgIOManager.isIOContainer(currentState)) {
-            messages = currentState.messages;
-        }
-        messages[messageKey] = message;
-        return CfgIOManager.makeContainer(messages);
-    }
-    getDataFromEvent(event) {
-        return event.state;
-    }
-}
+import { mapQueryString, Observable, unmapQueryString } from "@configura/web-utilities";
+import { CfgIOManager } from "./CfgIOManager.js";
+import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
+/**
+ * How the history is updated.
+ * @param DoNotWrite Only listens to initial URL-values.
+ * @param Replace Replaces the current history frame at updates.
+ * @param Push Adds history frames at updates.
+ * @param ReplaceAndUpdateUrl Replaces the current history frame at updates and updates the browser URL
+ * @param PushAndUpdateUrl Adds history frames at updates and updates the browser URL
+ */
+export var HistoryMode;
+(function (HistoryMode) {
+    HistoryMode[HistoryMode["DoNotWrite"] = 0] = "DoNotWrite";
+    HistoryMode[HistoryMode["Replace"] = 1] = "Replace";
+    HistoryMode[HistoryMode["Push"] = 2] = "Push";
+    HistoryMode[HistoryMode["ReplaceAndUpdateUrl"] = 3] = "ReplaceAndUpdateUrl";
+    HistoryMode[HistoryMode["PushAndUpdateUrl"] = 4] = "PushAndUpdateUrl";
+})(HistoryMode || (HistoryMode = {}));
+/**
+ * This class is used to coordinate writing and reading to the browser history.
+ * It handles messages sent from the connectors.
+ */
+export class CfgHistoryManager extends CfgWindowEventManager {
+    constructor() {
+        super();
+        this._aggregatedQsKeyValues = new Map();
+        this._urlUpdateObservable = new Observable();
+        this.eventType = "popstate";
+    }
+    static get instance() {
+        if (this._instance === undefined) {
+            this._instance = new CfgHistoryManager();
+        }
+        return this._instance;
+    }
+    /**
+     * @returns The current browser URL updated with the latest updates from
+     *          the Connectors.
+     */
+    getUrl() {
+        return CfgHistoryManager._makeUpdatedUrl(this._aggregatedQsKeyValues);
+    }
+    /**
+     * Listen for updated URL:s. This doesn't have to mean the URL in the
+     * browser has been updated.
+     */
+    listenForUrl(listener) {
+        this._urlUpdateObservable.listen(listener);
+    }
+    /**
+     * Stop listen.
+     */
+    stopListenForUrl(listener) {
+        this._urlUpdateObservable.stopListen(listener);
+    }
+    /**
+     * Write to the history
+     */
+    send(messageKey, data) {
+        const { qsKeyValues, message, mode } = data;
+        for (const keyValue of qsKeyValues) {
+            this._aggregatedQsKeyValues.set(keyValue[0], keyValue[1]);
+        }
+        this._urlUpdateObservable.notifyAll(this.getUrl());
+        if (mode === HistoryMode.DoNotWrite) {
+            return;
+        }
+        // Initial data is before user interaction has happened
+        const initial = message.initial;
+        const url = CfgHistoryManager._makeUpdatedUrl(qsKeyValues);
+        // At initial we do not replace the URL as we presumable have the defaults
+        const writeUrl = initial ||
+            !(mode === HistoryMode.PushAndUpdateUrl || mode === HistoryMode.ReplaceAndUpdateUrl)
+            ? null
+            : url;
+        // ...but we do replace the state so that we can in the future browse back to here
+        const newState = CfgHistoryManager._makeUpdatedState(window.history.state, message, messageKey);
+        if (initial ||
+            mode === HistoryMode.Replace ||
+            mode === HistoryMode.ReplaceAndUpdateUrl ||
+            this.receiveInProgress) {
+            window.history.replaceState(newState, "", writeUrl);
+        }
+        else {
+            window.history.pushState(newState, "", writeUrl);
+        }
+    }
+    /**
+     * Takes the current in browser URL and updates it with the provided Query String values.
+     * Old Query String is replaced.
+     */
+    static _makeUpdatedUrl(qsKeyValues) {
+        const qs = this._makeUpdatedQueryString(qsKeyValues);
+        return `${window.location.origin}${window.location.pathname}${qs ? "?" : ""}${qs}${window.location.hash}`;
+    }
+    /**
+     * Returns the current in browser Query String updated with the key values provided.
+     * If a value is undefined in the passed map it will be deleted from the Query String.
+     */
+    static _makeUpdatedQueryString(qsKeyValues) {
+        const currentKeyValues = this.currentQsKeyValues();
+        for (const [key, value] of qsKeyValues) {
+            if (value === undefined) {
+                currentKeyValues.delete(key);
+            }
+            else {
+                currentKeyValues.set(key, value);
+            }
+        }
+        return unmapQueryString(currentKeyValues);
+    }
+    /**
+     * @returns The current in browser Query String as a Map
+     */
+    static currentQsKeyValues() {
+        return mapQueryString(window.location.search);
+    }
+    /**
+     * If the passed currentState is a CfgIOContainer it will update it with the
+     * passed message. If not it will create a new CfgIOContainer with the message.
+     */
+    static _makeUpdatedState(currentState, message, messageKey) {
+        let messages = {};
+        if (CfgIOManager.isIOContainer(currentState)) {
+            messages = currentState.messages;
+        }
+        messages[messageKey] = message;
+        return CfgIOManager.makeContainer(messages);
+    }
+    getDataFromEvent(event) {
+        return event.state;
+    }
+    static getMessageFromCurrentHistoryState(messageKey) {
+        const state = window.history.state;
+        if (!CfgIOManager.isIOContainer(state)) {
+            return undefined;
+        }
+        if (!CfgIOManager.hasIOContainerMessageKey(state, messageKey)) {
+            return undefined;
+        }
+        return CfgIOManager.getMessageFromIOContainer(state, messageKey);
+    }
+}

package/dist/io/CfgHistoryToProdConfConnector.d.ts

@@ -1,21 +1,22 @@
-import { DtoProductConfiguration } from "../CatalogueAPI.js";
-import { CfgHistoryManager, CfgHistoryManagerSendData } from "./CfgHistoryManager.js";
-import { CfgIOProdConfConnector, CfgProdConfMessage } from "./CfgIOProdConfConnector.js";
-export declare function dtoConfToString(conf: DtoProductConfiguration): string;
-export declare function stringToDtoConf(conf: string): DtoProductConfiguration;
-/**
- * Instantiating this will make the browser history (and URL) update with the product configuration.
- */
-export declare class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector<CfgHistoryManagerSendData<CfgProdConfMessage>> {
-    private readonly _useHistoryPush;
-    private readonly _qsKey;
-    /**
-     * @param _useHistoryPush As opposed to replace. Push makes the web browser navigation buttons navigate configuration changes. Replace just updates the URL.
-     * @param _qsKey The Query String key for product configuration.
-     * @param doValidate When popping from the history stack (navigating in the browser), should a navigate call be sent to the server to verify that the product configuration is still valid?
-     */
-    constructor(manager: CfgHistoryManager, _useHistoryPush: boolean, _qsKey?: string, doValidate?: boolean);
-    protected getInitialProdConf(): DtoProductConfiguration | undefined;
-    protected makeSendData(conf: DtoProductConfiguration, initial: boolean): CfgHistoryManagerSendData<CfgProdConfMessage>;
-}
+import { DtoProductConf } from "../CatalogueAPI.js";
+import { CfgHistoryManager, CfgHistoryManagerSendData, HistoryMode } from "./CfgHistoryManager.js";
+import { CfgIOProdConfConnector, CfgProdConfMessage } from "./CfgIOProdConfConnector.js";
+/**
+ * Instantiating this will make the browser history (and URL) update with the product configuration.
+ */
+export declare class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector<CfgHistoryManagerSendData<CfgProdConfMessage>> {
+    private readonly _mode;
+    private readonly _qsKey;
+    private static getInitialProdConf;
+    static make(manager: CfgHistoryManager, mode: HistoryMode, qsKey?: string): {
+        instance: CfgHistoryToProdConfConnector;
+        initial: DtoProductConf | undefined;
+    };
+    /**
+     * @param _mode
+     * @param _qsKey The Query String key for product configuration.
+     */
+    private constructor();
+    protected makeSendData(conf: DtoProductConf, initial: boolean): CfgHistoryManagerSendData<CfgProdConfMessage>;
+}
 //# sourceMappingURL=CfgHistoryToProdConfConnector.d.ts.map

package/dist/io/CfgHistoryToProdConfConnector.js

@@ -1,56 +1,50 @@
-import { CfgHistoryManager } from "./CfgHistoryManager.js";
-import { CfgIOProdConfConnector, CfgProdConfMessageVersions, STAGE_PROD_CONF_MESSAGE_KEY, } from "./CfgIOProdConfConnector.js";
-const jsonKeyRegex = /"([^"]+)":/g;
-const keyMap = [
-    ["configuration", "cn"],
-    ["additionalProducts", "as"],
-    ["prodParams", "pp"],
-    ["refKey", "rk"],
-    ["selected", "se"],
-    ["features", "fs"],
-    ["code", "cd"],
-    ["options", "os"],
-    ["numericValue", "nu"],
-    ["groupCode", "gc"],
-    ["unit", "un"],
-];
-// todo: Could be worth making faster
-const toCompact = (key) => { var _a, _b; return (_b = (_a = keyMap.find((i) => i[0] === key)) === null || _a === void 0 ? void 0 : _a[1]) !== null && _b !== void 0 ? _b : key; };
-const toExpanded = (key) => { var _a, _b; return (_b = (_a = keyMap.find((i) => i[1] === key)) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : key; };
-export function dtoConfToString(conf) {
-    const stringified = JSON.stringify(conf, undefined, "");
-    return stringified.replace(jsonKeyRegex, (_, key) => `"${toCompact(key)}":`);
-}
-export function stringToDtoConf(conf) {
-    const expandedKeys = conf.replace(jsonKeyRegex, (_, key) => `"${toExpanded(key)}":`);
-    return JSON.parse(expandedKeys);
-}
-/**
- * Instantiating this will make the browser history (and URL) update with the product configuration.
- */
-export class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector {
-    /**
-     * @param _useHistoryPush As opposed to replace. Push makes the web browser navigation buttons navigate configuration changes. Replace just updates the URL.
-     * @param _qsKey The Query String key for product configuration.
-     * @param doValidate When popping from the history stack (navigating in the browser), should a navigate call be sent to the server to verify that the product configuration is still valid?
-     */
-    constructor(manager, _useHistoryPush, _qsKey = STAGE_PROD_CONF_MESSAGE_KEY, doValidate = true) {
-        super(manager, doValidate, false, false);
-        this._useHistoryPush = _useHistoryPush;
-        this._qsKey = _qsKey;
-    }
-    getInitialProdConf() {
-        const s = CfgHistoryManager.currentQsKeyValues().get(this._qsKey);
-        if (s === undefined) {
-            return undefined;
-        }
-        return stringToDtoConf(s);
-    }
-    makeSendData(conf, initial) {
-        return {
-            message: CfgIOProdConfConnector.makeMessage(conf, initial, CfgProdConfMessageVersions.V2dot0),
-            qsKeyValues: new Map([[STAGE_PROD_CONF_MESSAGE_KEY, dtoConfToString(conf)]]),
-            useHistoryPush: this._useHistoryPush,
-        };
-    }
-}
+import { augmentErrorMessage } from "@configura/web-utilities";
+import { compactStringToDtoProductConf, dtoProductConfigurationToCompactString, } from "../ConfigurationConverter.js";
+import { CfgHistoryManager } from "./CfgHistoryManager.js";
+import { CfgIOProdConfConnector, CfgProdConfMessageVersions, CfgProdConfParts, getHighestVersionProdConfMessage, isCfgProdConfMessageV2, STAGE_PROD_CONF_MESSAGE_KEY, } from "./CfgIOProdConfConnector.js";
+/**
+ * Instantiating this will make the browser history (and URL) update with the product configuration.
+ */
+export class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector {
+    /**
+     * @param _mode
+     * @param _qsKey The Query String key for product configuration.
+     */
+    constructor(manager, _mode, _qsKey) {
+        super(manager, CfgProdConfParts.SyncGroupState);
+        this._mode = _mode;
+        this._qsKey = _qsKey;
+    }
+    static getInitialProdConf(qsKey) {
+        // First try to use the state, if that doesn't work use the query string
+        const initialMessage = CfgHistoryManager.getMessageFromCurrentHistoryState(STAGE_PROD_CONF_MESSAGE_KEY);
+        if (initialMessage !== undefined) {
+            const highestVersionMessage = getHighestVersionProdConfMessage(initialMessage.subMessages);
+            if (isCfgProdConfMessageV2(highestVersionMessage)) {
+                return highestVersionMessage.conf;
+            }
+        }
+        try {
+            const s = CfgHistoryManager.currentQsKeyValues().get(qsKey);
+            if (s === undefined) {
+                return undefined;
+            }
+            return compactStringToDtoProductConf(s);
+        }
+        catch (err) {
+            throw augmentErrorMessage(err, "Failed read configuration from query string");
+        }
+    }
+    static make(manager, mode, qsKey = STAGE_PROD_CONF_MESSAGE_KEY) {
+        const initial = this.getInitialProdConf(qsKey);
+        const instance = new CfgHistoryToProdConfConnector(manager, mode, qsKey);
+        return { instance, initial };
+    }
+    makeSendData(conf, initial) {
+        return {
+            message: CfgIOProdConfConnector.makeMessage(conf, initial, CfgProdConfMessageVersions.V2dot0),
+            qsKeyValues: new Map([[this._qsKey, dtoProductConfigurationToCompactString(conf)]]),
+            mode: this._mode,
+        };
+    }
+}

package/dist/io/CfgIOManager.d.ts

@@ -1,49 +1,54 @@
-declare type ConfiguraAttribute = "C0nf1gura";
-declare type ConfiguraShebang = "arug1fn0C";
-declare const CONFIGURA_ATTRIBUTE: ConfiguraAttribute;
-export declare type IOManagerListener = (data: unknown) => Promise<void>;
-/**
- * The container format used when the environment is globally shared with things
- * outside our control. The "shebang" is a magic string that should prevent from a
- * CfgIOContainer being confused with something else.
- */
-export declare type CfgIOContainer = {
-    [CONFIGURA_ATTRIBUTE]: ConfiguraShebang;
-    messages: {
-        [index: string]: unknown;
-    };
-};
-/**
- * Base class for classes handling input and output in globally shared environments.
- */
-export declare abstract class CfgIOManager<S> {
-    /**
-     * Listen for the message messageKey being received.
-     */
-    listenForMessage(l: IOManagerListener, messageKey: string): boolean;
-    /**
-     * Removes the listener
-     */
-    stopListenForMessage(l: IOManagerListener): boolean;
-    static isIOContainer: (data: unknown) => data is CfgIOContainer;
-    static hasIOContainerMessageKey: (container: CfgIOContainer, messageKey: string) => boolean;
-    static getMessageFromIOContainer: (container: unknown, messageKey: string) => unknown;
-    static makeContainer: (messages: {
-        [index: string]: unknown;
-    }) => CfgIOContainer;
-    private _receiveInProgress;
-    private static _inhibitAllReceive;
-    get receiveInProgress(): boolean;
-    private _messageListeners;
-    private _getIndexOfMessageListener;
-    get hasMessageListeners(): boolean;
-    protected _containerListener(data: unknown): void;
-    /**
-     * Send the data with messageKey. This can for example be pushing or
-     * replacing on the history stack or sending a message using the
-     * window.message API.
-     */
-    abstract send(messageKey: string, data: S): void;
-}
-export {};
+import { CfgIOWarningSupplier } from "./CfgIOWarningSupplier";
+declare type ConfiguraAttribute = "C0nf1gura";
+declare type ConfiguraShebang = "arug1fn0C";
+declare const CONFIGURA_ATTRIBUTE: ConfiguraAttribute;
+export declare type IOManagerListener = (data: unknown) => Promise<void>;
+/**
+ * The container format used when the environment is globally shared with things
+ * outside our control. The "shebang" is a magic string that should prevent from a
+ * CfgIOContainer being confused with something else.
+ */
+export declare type CfgIOContainer = {
+    [CONFIGURA_ATTRIBUTE]: ConfiguraShebang;
+    messages: {
+        [index: string]: unknown;
+    };
+};
+/**
+ * Base class for classes handling input and output in globally shared environments.
+ */
+export declare abstract class CfgIOManager<S> {
+    private _warningSuppliers;
+    addWarningSupplier(supplier: CfgIOWarningSupplier): void;
+    removeWarningSupplier(supplier: CfgIOWarningSupplier): void;
+    getWarnings(): string[];
+    /**
+     * Listen for the message messageKey being received.
+     */
+    listenForMessage(l: IOManagerListener, messageKey: string): boolean;
+    /**
+     * Removes the listener
+     */
+    stopListenForMessage(l: IOManagerListener): boolean;
+    static isIOContainer: (data: unknown) => data is CfgIOContainer;
+    static hasIOContainerMessageKey: (container: CfgIOContainer, messageKey: string) => boolean;
+    static getMessageFromIOContainer: (container: unknown, messageKey: string) => unknown;
+    static makeContainer: (messages: {
+        [index: string]: unknown;
+    }) => CfgIOContainer;
+    private _receiveInProgress;
+    private static _inhibitAllReceive;
+    get receiveInProgress(): boolean;
+    private _messageListeners;
+    private _getIndexOfMessageListener;
+    get hasMessageListeners(): boolean;
+    protected _containerListener(data: unknown): void;
+    /**
+     * Send the data with messageKey. This can for example be pushing or
+     * replacing on the history stack or sending a message using the
+     * window.message API.
+     */
+    abstract send(messageKey: string, data: S): void;
+}
+export {};
 //# sourceMappingURL=CfgIOManager.d.ts.map