@configura/web-api 2.0.0-alpha.3 → 2.0.0-alpha.6

package/dist/CfgProduct.js

@@ -164,9 +164,11 @@ export class _CfgProductInternal {
             }
             return conf;
         };
-        this.setDtoConf = (s, doValidate, productLoaderForGroupedLoad) => this.setApiSelection(convertDtoConfProdToV1(s), doValidate, productLoaderForGroupedLoad);
+        this.setDtoConf = (s, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.setApiSelection(convertDtoConfProdToV1(s), doValidate, productLoaderForGroupedLoad);
+        });
         this.setApiSelection = (s, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
-            return this._setApiSelectionWithOtherProduct(s, doValidate, productLoaderForGroupedLoad, undefined);
+            return yield this._setApiSelectionWithOtherProduct(s, doValidate, productLoaderForGroupedLoad, undefined);
         });
         this.copyFrom = (source, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
             return yield this._setApiSelectionWithOtherProduct(convertDtoConfProdToV1(source.getDtoConf(false, false)), doValidate, productLoaderForGroupedLoad, source);
@@ -203,8 +205,8 @@ export class _CfgProductInternal {
             const sourceProductAdditionalProducts = sourceProduct === null || sourceProduct === void 0 ? void 0 : sourceProduct.additionalProducts;
             assert(!sourceProductAdditionalProducts ||
                 additionalProductsCount === sourceProductAdditionalProducts.length, `Passed sourceProduct does not have the same number of additional products as this.`);
-            if ((yield Promise.all(apiSelectionAdditionalProducts.map((apiSelectionAdditionalProduct, index) => {
-                var _a;
+            if ((yield Promise.all(apiSelectionAdditionalProducts.map((apiSelectionAdditionalProduct) => __awaiter(this, void 0, void 0, function* () {
+                var _b;
                 const refKey = apiSelectionAdditionalProduct.refKey;
                 assertDefined(refKey, "Additional product api configurations must have refKey.");
                 const i = additionalProducts.findIndex((a) => refKey === a.refKey);
@@ -212,12 +214,12 @@ export class _CfgProductInternal {
                 let sourceProductAdditionalProduct = undefined;
                 if (sourceProductAdditionalProducts !== undefined) {
                     sourceProductAdditionalProduct =
-                        (_a = sourceProductAdditionalProducts.find((a) => refKey === a.refKey)) === null || _a === void 0 ? void 0 : _a._internal;
+                        (_b = sourceProductAdditionalProducts.find((a) => refKey === a.refKey)) === null || _b === void 0 ? void 0 : _b._internal;
                     assertDefined(sourceProductAdditionalProduct, "Additional product not found in sourceProduct");
                 }
                 const additionalProduct = additionalProducts.splice(i, 1)[0]; // Splicing like this is okay because this is done synchronous. The setCon. is what is async.
-                return additionalProduct._internal._setApiSelectionWithOtherProduct(apiSelectionAdditionalProduct, doValidate, productLoaderForGroupedLoad, sourceProductAdditionalProduct);
-            }))).some((b) => b)) {
+                return yield additionalProduct._internal._setApiSelectionWithOtherProduct(apiSelectionAdditionalProduct, doValidate, productLoaderForGroupedLoad, sourceProductAdditionalProduct);
+            })))).some((b) => b)) {
                 change = true;
             }
             if (doValidate && configurationChange) {
@@ -596,12 +598,13 @@ prodParams, settings, optional, loadingObservable, parent, root, additionalProdu
         const productResponse = yield productLoaderForGroupedLoad.getProduct(correctDefaultsOnCatalogueParams(prodParams));
         const { productData, rootFeatureRefs, features: allRawFeatures, uuid, unit, } = productResponse;
         const product = yield new Promise((initSuccess, initFail) => {
+            var _a;
             const p = new _CfgProductInternal(() => {
                 // We absolutely do not want anyone to assign to this._configuration. So we want that field private.
                 // But we can not set the api selection synchronously. And the product configuration needs "this". So we use this callback.
                 // Feel free to find a nicer more readable solution :)
                 initSuccess(p);
-            }, initFail, productLoaderRaw, prodParams, settings, optional, !optional, rootFeatureRefs, allRawFeatures, uuid, unit, productData, productData.partsData.selOptions || [], loadingObservable, parent, root, additionalProductRef, syncGroupHandler);
+            }, initFail, productLoaderRaw, prodParams, settings, optional, !optional, rootFeatureRefs, allRawFeatures, uuid, unit, productData, (_a = productData.partsData.selOptions) !== null && _a !== void 0 ? _a : [], loadingObservable, parent, root, additionalProductRef, syncGroupHandler);
         });
         yield product._syncAndLoadAdditionalProducts(productLoaderForGroupedLoad);
         // Product is guaranteed to be root

package/dist/io/CfgHistoryManager.d.ts

@@ -10,9 +10,19 @@ declare type CfgHistoryManagerMessageData = {
  */
 export declare type CfgHistoryManagerSendData<D> = {
     message: D;
-    useHistoryPush: boolean;
+    historyWriteMode: CfgHistoryWriteMode;
     qsKeyValues: Map<string, string | undefined>;
 };
+/**
+ * @param Replace Just updates the URL
+ * @param Push Push makes the web browser navigation buttons navigate configuration changes.
+ * @param DoNotWrite Do not update the history at all.
+ */
+export declare enum CfgHistoryWriteMode {
+    Replace = "Replace",
+    Push = "Push",
+    DoNotWrite = "DoNotWrite"
+}
 /**
  * This class does nothing on it's own. It is used to coordinate writing to the history, that
  * is, updating the browsing history.

package/dist/io/CfgHistoryManager.js

@@ -1,6 +1,17 @@
 import { mapQueryString, unmapQueryString } from "@configura/web-utilities";
 import { CfgIOManager } from "./CfgIOManager.js";
 import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
+/**
+ * @param Replace Just updates the URL
+ * @param Push Push makes the web browser navigation buttons navigate configuration changes.
+ * @param DoNotWrite Do not update the history at all.
+ */
+export var CfgHistoryWriteMode;
+(function (CfgHistoryWriteMode) {
+    CfgHistoryWriteMode["Replace"] = "Replace";
+    CfgHistoryWriteMode["Push"] = "Push";
+    CfgHistoryWriteMode["DoNotWrite"] = "DoNotWrite";
+})(CfgHistoryWriteMode || (CfgHistoryWriteMode = {}));
 /**
  * This class does nothing on it's own. It is used to coordinate writing to the history, that
  * is, updating the browsing history.
@@ -20,14 +31,17 @@ export class CfgHistoryManager extends CfgWindowEventManager {
      * Write to the history
      */
     send(messageKey, data) {
-        const { qsKeyValues, message, useHistoryPush } = data;
+        const { qsKeyValues, message, historyWriteMode } = data;
+        if (historyWriteMode === CfgHistoryWriteMode.DoNotWrite) {
+            return;
+        }
         // 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) {
+        if (initial || historyWriteMode === CfgHistoryWriteMode.Replace || this.receiveInProgress) {
             window.history.replaceState(newState, "", newUrl);
         }
         else {

package/dist/io/CfgHistoryToProdConfConnector.d.ts

@@ -1,5 +1,5 @@
 import { DtoConfProd } from "../CatalogueAPI.js";
-import { CfgHistoryManager, CfgHistoryManagerSendData } from "./CfgHistoryManager.js";
+import { CfgHistoryManager, CfgHistoryManagerSendData, CfgHistoryWriteMode } from "./CfgHistoryManager.js";
 import { CfgIOProdConfConnector, CfgProdConfMessage } from "./CfgIOProdConfConnector.js";
 export declare function dtoConfToString(conf: DtoConfProd): string;
 export declare function stringToDtoConf(conf: string): DtoConfProd;
@@ -7,14 +7,14 @@ 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 _historyWriteMode;
     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 _historyWriteMode What way to update history.
      * @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);
+    constructor(manager: CfgHistoryManager, _historyWriteMode: CfgHistoryWriteMode, _qsKey?: string, doValidate?: boolean);
     protected getInitialProdConf(): DtoConfProd | undefined;
     protected makeSendData(conf: DtoConfProd, initial: boolean): CfgHistoryManagerSendData<CfgProdConfMessage>;
 }

package/dist/io/CfgHistoryToProdConfConnector.js

@@ -1,4 +1,4 @@
-import { CfgHistoryManager } from "./CfgHistoryManager.js";
+import { CfgHistoryManager, } from "./CfgHistoryManager.js";
 import { CfgIOProdConfConnector, CfgProdConfMessageVersions, STAGE_PROD_CONF_MESSAGE_KEY, } from "./CfgIOProdConfConnector.js";
 const jsonKeyRegex = /"([^"]+)":/g;
 const keyMap = [
@@ -30,13 +30,13 @@ export function stringToDtoConf(conf) {
  */
 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 _historyWriteMode What way to update history.
      * @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) {
+    constructor(manager, _historyWriteMode, _qsKey = STAGE_PROD_CONF_MESSAGE_KEY, doValidate = true) {
         super(manager, doValidate, CfgProdConfMessageVersions.V2dot0, false, false);
-        this._useHistoryPush = _useHistoryPush;
+        this._historyWriteMode = _historyWriteMode;
         this._qsKey = _qsKey;
     }
     getInitialProdConf() {
@@ -50,7 +50,7 @@ export class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector {
         return {
             message: this.makeMessage(conf, initial),
             qsKeyValues: new Map([[STAGE_PROD_CONF_MESSAGE_KEY, dtoConfToString(conf)]]),
-            useHistoryPush: this._useHistoryPush,
+            historyWriteMode: this._historyWriteMode,
         };
     }
 }

package/dist/io/CfgIOProdConfConnector.d.ts

@@ -1,18 +1,22 @@
 import { DtoAdditionalProductConfiguration, DtoConfProd } from "../CatalogueAPI.js";
 import { CfgProduct, CfgProductChangeNotification } from "../CfgProduct.js";
 import { CfgIOManager } from "./CfgIOManager.js";
+export declare const isCfgProdConfMessage: (data: unknown) => data is CfgProdConfMessageV1 | CfgProdConfMessageV2;
 export declare type CfgProdConfMessageV1 = {
     version: "1.0";
     conf: DtoAdditionalProductConfiguration;
 };
+export declare const isCfgProdConfMessageV1: (data: unknown) => data is CfgProdConfMessageV1;
 export declare type CfgProdConfMessageV2 = {
     version: "2.0";
     conf: DtoConfProd;
 };
+export declare const isCfgProdConfMessageV2: (data: unknown) => data is CfgProdConfMessageV2;
 export declare type CfgProdConfMessage = {
     initial: boolean;
     subMessages: (CfgProdConfMessageV1 | CfgProdConfMessageV2)[];
 };
+export declare const getHighestVersionProdConfMessage: (subMessages: (CfgProdConfMessageV1 | CfgProdConfMessageV2)[]) => CfgProdConfMessageV1 | CfgProdConfMessageV2;
 export declare enum CfgProdConfMessageVersions {
     V1dot0 = 1,
     V2dot0 = 2

package/dist/io/CfgIOProdConfConnector.js

@@ -8,6 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { convertDtoConfProdToV1 } from "../ConfigurationConverter.js";
+export const isCfgProdConfMessage = (data) => typeof data === "object" && data !== null && "version" in data && "conf" in data;
+export const isCfgProdConfMessageV1 = (data) => isCfgProdConfMessage(data) && data.version === "1.0";
+export const isCfgProdConfMessageV2 = (data) => isCfgProdConfMessage(data) && data.version === "2.0";
+export const getHighestVersionProdConfMessage = (subMessages) => subMessages
+    .slice(1)
+    .reduce((a, c) => (a.version < c.version ? c : a), subMessages[0]);
 export var CfgProdConfMessageVersions;
 (function (CfgProdConfMessageVersions) {
     CfgProdConfMessageVersions[CfgProdConfMessageVersions["V1dot0"] = 1] = "V1dot0";
@@ -65,16 +71,14 @@ export class CfgIOProdConfConnector {
                     console.warn(`${STAGE_PROD_CONF_MESSAGE_KEY} message without any submessages. Unexpected.`);
                     return;
                 }
-                const highestVersionMessage = subMessages
-                    .slice(1)
-                    .reduce((a, c) => (a.version < c.version ? c : a), subMessages[0]);
-                switch (highestVersionMessage.version) {
-                    case "1.0":
-                        yield newProduct.setApiSelection(highestVersionMessage.conf, this._doValidate);
-                        return;
-                    case "2.0":
-                        yield newProduct.setDtoConf(highestVersionMessage.conf, this._doValidate);
-                        return;
+                const highestVersionMessage = getHighestVersionProdConfMessage(subMessages);
+                if (isCfgProdConfMessageV1(highestVersionMessage)) {
+                    yield newProduct.setApiSelection(highestVersionMessage.conf, this._doValidate);
+                    return;
+                }
+                if (isCfgProdConfMessageV2(highestVersionMessage)) {
+                    yield newProduct.setDtoConf(highestVersionMessage.conf, this._doValidate);
+                    return;
                 }
                 throw new Error("Unknown message version");
             }));

package/dist/io/CfgWindowMessageManager.js

@@ -64,6 +64,9 @@ export class CfgWindowMessageManager extends CfgWindowEventManager {
         return super.stopListenForMessage(l);
     }
     send(messageKey, data) {
+        if (this.receiveInProgress) {
+            return;
+        }
         const container = CfgIOManager.makeContainer({
             [messageKey]: data,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/web-api",
-	"version": "2.0.0-alpha.3",
+	"version": "2.0.0-alpha.6",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -23,7 +23,7 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@configura/web-utilities": "2.0.0-alpha.3"
+		"@configura/web-utilities": "2.0.0-alpha.6"
 	},
-	"gitHead": "293660b8d8663638e531c2c44274ffffb1465e04"
+	"gitHead": "91edc6834460f70904b9914292a5869ad6e8b245"
 }