@configura/web-api 1.6.1 → 2.0.0-alpha.2

package/dist/CfgReferencePathHelper.d.ts

@@ -0,0 +1,14 @@
+import { DtoCatalogueParamsWithLang, DtoProductParamsWithLang } from "./CatalogueAPI";
+/**
+ * These methods aims to provide a default suggested way of building
+ * URLs to Products and Catalogues. By using consistent URL:s copy-paste
+ * between systems becomes easy and this can aid when debugging.
+ * Using this format on URL is no requirement. In fact, most of our
+ * integrators do not, as they do not expose the Catalogue-path.
+ * Internally at Configura we try to stick with this format.
+ */
+export declare class CfgReferencePathHelper {
+    static getCataloguePath: (browsingRootUrl: string, catParams: DtoCatalogueParamsWithLang) => string;
+    static getProductPath: (browsingRootUrl: string, productParams: DtoProductParamsWithLang) => string;
+}
+//# sourceMappingURL=CfgReferencePathHelper.d.ts.map

package/dist/CfgReferencePathHelper.js

@@ -0,0 +1,13 @@
+import { encodeURIComponents } from "@configura/web-utilities";
+/**
+ * These methods aims to provide a default suggested way of building
+ * URLs to Products and Catalogues. By using consistent URL:s copy-paste
+ * between systems becomes easy and this can aid when debugging.
+ * Using this format on URL is no requirement. In fact, most of our
+ * integrators do not, as they do not expose the Catalogue-path.
+ * Internally at Configura we try to stick with this format.
+ */
+export class CfgReferencePathHelper {
+}
+CfgReferencePathHelper.getCataloguePath = (browsingRootUrl, catParams) => `${browsingRootUrl}/${encodeURIComponents(catParams.cid, catParams.lang, catParams.enterprise, catParams.prdCat, catParams.prdCatVersion, catParams.vendor, catParams.priceList)}`;
+CfgReferencePathHelper.getProductPath = (browsingRootUrl, productParams) => `${CfgReferencePathHelper.getCataloguePath(browsingRootUrl, productParams)}/product/${encodeURIComponent(productParams.partNumber)}`;

package/dist/ConfigurationConverter.d.ts

@@ -0,0 +1,5 @@
+import { DtoAdditionalProductConfiguration, DtoConfAddProd, DtoConfFeature, DtoConfProd, DtoSelectedOption } from "./CatalogueAPI.js";
+export declare const isDtoConfProdAdditional: (value: DtoConfProd) => value is DtoConfAddProd;
+export declare const convertDtoConfProdToV1: (conf: DtoConfProd, silenceWarnings?: boolean) => DtoAdditionalProductConfiguration;
+export declare const convertDtoConfFeaturesToSelOptions: (features: DtoConfFeature[], silenceWarnings?: boolean) => DtoSelectedOption[];
+//# sourceMappingURL=ConfigurationConverter.d.ts.map

package/dist/ConfigurationConverter.js

@@ -0,0 +1,72 @@
+export const isDtoConfProdAdditional = (value) => "refKey" in value;
+// As this has potential to flood the terminal we only inform once
+let hasInformedAboutProdParams = false;
+let hasInformedAboutGroupCode = false;
+let hasInformedAboutUnit = false;
+export const convertDtoConfProdToV1 = (conf, silenceWarnings = false) => {
+    var _a, _b;
+    if (!silenceWarnings && conf.prodParams !== undefined && !hasInformedAboutProdParams) {
+        hasInformedAboutProdParams = true;
+        console.info("Incoming DtoProductConfiguration contains prodParams. These will be ignored.");
+    }
+    const result = {
+        selOptions: ((_a = conf.features) !== null && _a !== void 0 ? _a : []).map((f) => ({
+            code: "!~!",
+            next: convertDtoConfFeatureToApiSelection(f, silenceWarnings),
+        })),
+        additionalProducts: ((_b = conf.additionalProducts) !== null && _b !== void 0 ? _b : []).map((p) => convertDtoConfProdToV1(p, silenceWarnings)),
+        selected: true,
+    };
+    if (isDtoConfProdAdditional(conf)) {
+        result.refKey = conf.refKey;
+        result.selected = conf.selected;
+    }
+    return result;
+};
+export const convertDtoConfFeaturesToSelOptions = (features, silenceWarnings = false) => (features !== null && features !== void 0 ? features : []).map((f) => ({
+    code: "!~!",
+    next: convertDtoConfFeatureToApiSelection(f, silenceWarnings),
+}));
+const convertDtoConfFeatureToApiSelection = (feature, silenceWarnings) => {
+    const { groupCode, options, unit } = feature;
+    if (!silenceWarnings && groupCode !== undefined && !hasInformedAboutGroupCode) {
+        hasInformedAboutGroupCode = true;
+        console.info("Incoming DtoFeature contains groupCode. It will be ignored.");
+    }
+    if (!silenceWarnings && unit !== undefined && !hasInformedAboutUnit) {
+        hasInformedAboutUnit = true;
+        console.info("Incoming DtoFeature contains a unit. It will be ignored.");
+    }
+    const result = {};
+    for (const option of (options !== null && options !== void 0 ? options : []).filter((o) => o.selected)) {
+        result[option.code] = convertDtoConfOptionToSelectedOption(option, silenceWarnings);
+    }
+    return result;
+};
+const convertDtoConfOptionToSelectedOption = (option, silenceWarnings) => {
+    const { features, code, numericValue } = option;
+    const selectionTrees = (features !== null && features !== void 0 ? features : []).map((f) => convertDtoConfFeatureToApiSelection(f, silenceWarnings));
+    const mergedSelectionTree = {};
+    let anyItems = false;
+    for (const selectionTree of selectionTrees) {
+        if (selectionTree === undefined) {
+            continue;
+        }
+        for (const key of Object.keys(selectionTree)) {
+            if (mergedSelectionTree[key] !== undefined) {
+                console.warn(`The key (${key}) is already used in the selection tree. Option code: "${code}".`);
+                continue;
+            }
+            mergedSelectionTree[key] = selectionTree[key];
+            anyItems = true;
+        }
+    }
+    const selectedOption = {
+        code,
+        numericValue,
+    };
+    if (anyItems) {
+        selectedOption.next = mergedSelectionTree;
+    }
+    return selectedOption;
+};

package/dist/index.d.ts

@@ -1,21 +1,24 @@
-export * from "./CatalogueAPI.js";
-export * from "./CfgProduct.js";
-export * from "./material/CfgMaterialMapping.js";
-export * from "./material/CfgMtrlApplication.js";
-export * from "./material/CfgMtrlApplicationSource.js";
-export * from "./material/CfgMtrlSource.js";
-export * from "./material/CfgMtrlSourceWithMetaData.js";
-export * from "./productConfiguration/CfgFeature.js";
-export * from "./productConfiguration/CfgOption.js";
-export * from "./productConfiguration/CfgProductConfiguration.js";
-export * from "./productConfiguration/filters.js";
-export * from "./productConfiguration/productParamsGenerator.js";
-export * from "./productLoader.js";
-export * from "./syncGroups/SyncGroupsApplyMode.js";
-export * from "./syncGroups/SyncGroupsHandler.js";
-export * from "./tasks/formats.js";
-export * from "./tasks/TaskHandler.js";
-export * from "./utilitiesCatalogueData.js";
-export * from "./utilitiesCataloguePermission.js";
-export * from "./utilitiesNumericValues.js";
+export * from "./CatalogueAPI.js";
+export * from "./CfgProduct.js";
+export * from "./CfgReferencePathHelper.js";
+export * from "./ConfigurationConverter.js";
+export * from "./io/index.js";
+export * from "./material/CfgMaterialMapping.js";
+export * from "./material/CfgMtrlApplication.js";
+export * from "./material/CfgMtrlApplicationSource.js";
+export * from "./material/CfgMtrlSource.js";
+export * from "./material/CfgMtrlSourceWithMetaData.js";
+export * from "./productConfiguration/CfgFeature.js";
+export * from "./productConfiguration/CfgOption.js";
+export * from "./productConfiguration/CfgProductConfiguration.js";
+export * from "./productConfiguration/filters.js";
+export * from "./productConfiguration/productParamsGenerator.js";
+export * from "./productLoader.js";
+export * from "./syncGroups/SyncGroupsApplyMode.js";
+export * from "./syncGroups/SyncGroupsHandler.js";
+export * from "./tasks/formats.js";
+export * from "./tasks/TaskHandler.js";
+export * from "./utilitiesCatalogueData.js";
+export * from "./utilitiesCataloguePermission.js";
+export * from "./utilitiesNumericValues.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,20 +1,23 @@
-export * from "./CatalogueAPI.js";
-export * from "./CfgProduct.js";
-export * from "./material/CfgMaterialMapping.js";
-export * from "./material/CfgMtrlApplication.js";
-export * from "./material/CfgMtrlApplicationSource.js";
-export * from "./material/CfgMtrlSource.js";
-export * from "./material/CfgMtrlSourceWithMetaData.js";
-export * from "./productConfiguration/CfgFeature.js";
-export * from "./productConfiguration/CfgOption.js";
-export * from "./productConfiguration/CfgProductConfiguration.js";
-export * from "./productConfiguration/filters.js";
-export * from "./productConfiguration/productParamsGenerator.js";
-export * from "./productLoader.js";
-export * from "./syncGroups/SyncGroupsApplyMode.js";
-export * from "./syncGroups/SyncGroupsHandler.js";
-export * from "./tasks/formats.js";
-export * from "./tasks/TaskHandler.js";
-export * from "./utilitiesCatalogueData.js";
-export * from "./utilitiesCataloguePermission.js";
-export * from "./utilitiesNumericValues.js";
+export * from "./CatalogueAPI.js";
+export * from "./CfgProduct.js";
+export * from "./CfgReferencePathHelper.js";
+export * from "./ConfigurationConverter.js";
+export * from "./io/index.js";
+export * from "./material/CfgMaterialMapping.js";
+export * from "./material/CfgMtrlApplication.js";
+export * from "./material/CfgMtrlApplicationSource.js";
+export * from "./material/CfgMtrlSource.js";
+export * from "./material/CfgMtrlSourceWithMetaData.js";
+export * from "./productConfiguration/CfgFeature.js";
+export * from "./productConfiguration/CfgOption.js";
+export * from "./productConfiguration/CfgProductConfiguration.js";
+export * from "./productConfiguration/filters.js";
+export * from "./productConfiguration/productParamsGenerator.js";
+export * from "./productLoader.js";
+export * from "./syncGroups/SyncGroupsApplyMode.js";
+export * from "./syncGroups/SyncGroupsHandler.js";
+export * from "./tasks/formats.js";
+export * from "./tasks/TaskHandler.js";
+export * from "./utilitiesCatalogueData.js";
+export * from "./utilitiesCataloguePermission.js";
+export * from "./utilitiesNumericValues.js";

package/dist/io/CfgHistoryManager.d.ts

@@ -0,0 +1,51 @@
+import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
+declare type CfgHistoryManagerMessageData = {
+    initial: boolean;
+};
+/**
+ * The collected data used when sending. For history this both contains the message, which is
+ * used as the "state" in the history-frame, and the qsKeyValues, which are used in the URL.
+ * When navigating back and forth the stage (message) is used to restore the old state. When
+ * opening a window with no prior history the Query String will be used.
+ */
+export declare type CfgHistoryManagerSendData<D> = {
+    message: D;
+    useHistoryPush: boolean;
+    qsKeyValues: Map<string, string | undefined>;
+};
+/**
+ * This class does nothing on it's own. It is used to coordinate writing to the history, that
+ * is, updating the browsing history.
+ */
+export declare class CfgHistoryManager extends CfgWindowEventManager<"popstate", CfgHistoryManagerSendData<CfgHistoryManagerMessageData>> {
+    private static _instance;
+    static get instance(): CfgHistoryManager;
+    private constructor();
+    /**
+     * Write to the history
+     */
+    send(messageKey: string, data: CfgHistoryManagerSendData<CfgHistoryManagerMessageData>): void;
+    /**
+     * Takes the current in browser URL and updates it with the provided Query String values.
+     * Old Query String is replaced.
+     */
+    private static _makeUpdatedUrl;
+    /**
+     * 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.
+     */
+    private static _makeUpdatedQueryString;
+    /**
+     * @returns The current in browser Query String as a Map
+     */
+    static currentQsKeyValues(): Map<string, string>;
+    /**
+     * 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.
+     */
+    private static _makeUpdatedState;
+    protected readonly eventType = "popstate";
+    protected getDataFromEvent(event: PopStateEvent): unknown;
+}
+export {};
+//# sourceMappingURL=CfgHistoryManager.d.ts.map

package/dist/io/CfgHistoryManager.js

@@ -0,0 +1,82 @@
+import { mapQueryString, unmapQueryString } from "@configura/web-utilities";
+import { CfgIOManager } from "./CfgIOManager.js";
+import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
+/**
+ * This class does nothing on it's own. It is used to coordinate writing to the history, that
+ * is, updating the browsing history.
+ */
+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;
+    }
+}

package/dist/io/CfgHistoryToProdConfConnector.d.ts

@@ -0,0 +1,21 @@
+import { DtoConfProd } from "../CatalogueAPI.js";
+import { CfgHistoryManager, CfgHistoryManagerSendData } from "./CfgHistoryManager.js";
+import { CfgIOProdConfConnector, CfgProdConfMessage } from "./CfgIOProdConfConnector.js";
+export declare function dtoConfToString(conf: DtoConfProd): string;
+export declare function stringToDtoConf(conf: string): DtoConfProd;
+/**
+ * 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(): DtoConfProd | undefined;
+    protected makeSendData(conf: DtoConfProd, initial: boolean): CfgHistoryManagerSendData<CfgProdConfMessage>;
+}
+//# sourceMappingURL=CfgHistoryToProdConfConnector.d.ts.map

package/dist/io/CfgHistoryToProdConfConnector.js

@@ -0,0 +1,56 @@
+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, CfgProdConfMessageVersions.V2dot0, 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: this.makeMessage(conf, initial),
+            qsKeyValues: new Map([[STAGE_PROD_CONF_MESSAGE_KEY, dtoConfToString(conf)]]),
+            useHistoryPush: this._useHistoryPush,
+        };
+    }
+}

package/dist/io/CfgIOManager.d.ts

@@ -0,0 +1,49 @@
+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 {};
+//# sourceMappingURL=CfgIOManager.d.ts.map

package/dist/io/CfgIOManager.js

@@ -0,0 +1,115 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const CONFIGURA_ATTRIBUTE = "C0nf1gura";
+const CONFIGURA_SHEBANG = "arug1fn0C";
+// Support function. Did not manage to check both attribute and value in one step
+const hasConfiguraAttribute = (data) => {
+    return typeof data === "object" && data !== null;
+};
+/**
+ * Base class for classes handling input and output in globally shared environments.
+ */
+export class CfgIOManager {
+    constructor() {
+        // A lock to avoid circular write. Asynchronous conditions can make this not be enough.
+        // Avoid creating pre-conditions where this can happen.
+        this._receiveInProgress = false;
+        this._messageListeners = [];
+        this._getIndexOfMessageListener = (l) => this._messageListeners.findIndex((item) => l === item.l);
+    }
+    /**
+     * Listen for the message messageKey being received.
+     */
+    listenForMessage(l, messageKey) {
+        if (this._getIndexOfMessageListener(l) !== -1) {
+            console.warn("Tried to add listener twice");
+            return false;
+        }
+        this._messageListeners.push({ l, messageKey });
+        return true;
+    }
+    /**
+     * Removes the listener
+     */
+    stopListenForMessage(l) {
+        const i = this._getIndexOfMessageListener(l);
+        if (i === -1) {
+            console.warn("Tried to stopListen on unknown listener");
+            return false;
+        }
+        this._messageListeners.splice(i, 1);
+        return true;
+    }
+    get receiveInProgress() {
+        return this._receiveInProgress;
+    }
+    get hasMessageListeners() {
+        return 0 < this._messageListeners.length;
+    }
+    _containerListener(data) {
+        if (CfgIOManager._inhibitAllReceive) {
+            return;
+        }
+        if (!CfgIOManager.isIOContainer(data)) {
+            return;
+        }
+        CfgIOManager._inhibitAllReceive = true;
+        this._receiveInProgress = true;
+        // The 15 or so rows below is one of the cases where I believe building a clever
+        // data structure of so would probably be worse for performance than just looping
+        // as the subscribers are expected to be very few
+        const listeners = this._messageListeners;
+        const allMessageKeys = listeners.reduce((a, c) => {
+            a.add(c.messageKey);
+            return a;
+        }, new Set());
+        const promises = [];
+        (() => __awaiter(this, void 0, void 0, function* () {
+            for (const messageKey of allMessageKeys) {
+                if (!CfgIOManager.hasIOContainerMessageKey(data, messageKey)) {
+                    continue;
+                }
+                const message = CfgIOManager.getMessageFromIOContainer(data, messageKey);
+                for (const item of listeners) {
+                    if (item.messageKey !== messageKey) {
+                        continue;
+                    }
+                    // async, not waiting. Might need to change.
+                    promises.push(item.l(message));
+                }
+            }
+        }))();
+        Promise.all(promises)
+            .then(() => {
+            this._receiveInProgress = false;
+            CfgIOManager._inhibitAllReceive = false;
+        })
+            .catch(() => {
+            this._receiveInProgress = false;
+            CfgIOManager._inhibitAllReceive = false;
+        });
+    }
+}
+CfgIOManager.isIOContainer = (data) => hasConfiguraAttribute(data) && data[CONFIGURA_ATTRIBUTE] === CONFIGURA_SHEBANG;
+CfgIOManager.hasIOContainerMessageKey = (container, messageKey) => messageKey in container.messages;
+CfgIOManager.getMessageFromIOContainer = (container, messageKey) => {
+    if (!CfgIOManager.isIOContainer(container)) {
+        throw new Error("The passed data was not a CfgIOContainer. It is to be expected that such data messages can arrive, so please use isIOContainer function to filter them out before calling this.");
+    }
+    if (!CfgIOManager.hasIOContainerMessageKey(container, messageKey)) {
+        throw new Error(`The passed data did not have the messageKey "${messageKey}". You can test for this using hasIOContainerMessageKey function.`);
+    }
+    return container.messages[messageKey];
+};
+CfgIOManager.makeContainer = (messages) => ({
+    [CONFIGURA_ATTRIBUTE]: CONFIGURA_SHEBANG,
+    messages,
+});
+CfgIOManager._inhibitAllReceive = false;

package/dist/io/CfgIOProdConfConnector.d.ts

@@ -0,0 +1,53 @@
+import { DtoAdditionalProductConfiguration, DtoConfProd } from "../CatalogueAPI.js";
+import { CfgProduct, CfgProductChangeNotification } from "../CfgProduct.js";
+import { CfgIOManager } from "./CfgIOManager.js";
+export declare type CfgProdConfMessageV1 = {
+    version: "1.0";
+    conf: DtoAdditionalProductConfiguration;
+};
+export declare type CfgProdConfMessageV2 = {
+    version: "2.0";
+    conf: DtoConfProd;
+};
+export declare type CfgProdConfMessage = {
+    initial: boolean;
+    subMessages: (CfgProdConfMessageV1 | CfgProdConfMessageV2)[];
+};
+export declare enum CfgProdConfMessageVersions {
+    V1dot0 = 1,
+    V2dot0 = 2
+}
+export declare const STAGE_PROD_CONF_MESSAGE_KEY = "stageprodconf";
+declare type ProdConfMessageCallback = (message: CfgProdConfMessage) => Promise<void>;
+declare type ProdConfCallback = (conf: DtoConfProd) => Promise<void>;
+/**
+ * Base class for connecting the product configuration to an IO channel
+ */
+export declare abstract class CfgIOProdConfConnector<S> {
+    private readonly _ioManager;
+    private readonly _doValidate;
+    private readonly _sendVersions;
+    private readonly _includeExtendedDataInSend;
+    private readonly _includeProdParamsInSend;
+    private _product;
+    private _stopListenToMessage;
+    private _stopListenToProdConf;
+    constructor(_ioManager: CfgIOManager<S>, _doValidate: boolean, _sendVersions: CfgProdConfMessageVersions, _includeExtendedDataInSend: boolean, // Only v2.0
+    _includeProdParamsInSend: boolean);
+    destroy: () => void;
+    setProduct: (product: CfgProduct | undefined) => Promise<void>;
+    private _send;
+    protected getInitialProdConf(): DtoConfProd | undefined;
+    protected abstract makeSendData(conf: DtoConfProd, initial: boolean): S;
+    makeMessage(conf: DtoConfProd, initial: boolean): CfgProdConfMessage;
+    makeMessageListener(callback: ProdConfMessageCallback): (message: unknown) => Promise<void>;
+    /**
+     * Register the callback to listen for Product Configuration messages
+     * @returns A function which when called will cancel listening
+     */
+    listenForMessage(callback: ProdConfMessageCallback): () => void;
+    makeProdConfListener(callback: ProdConfCallback): (n: CfgProductChangeNotification) => void;
+    listenForProdConf(product: CfgProduct, callback: ProdConfCallback): () => void;
+}
+export {};
+//# sourceMappingURL=CfgIOProdConfConnector.d.ts.map