@configura/web-api 2.0.0-alpha.14 → 2.0.0-alpha.17

package/dist/CatalogueAPI.d.ts

@@ -1,3 +1,8 @@
+/** AdditionalProductConf */
+export interface DtoAdditionalProductConf extends DtoProductConf {
+    refKey: string;
+    selected: boolean;
+}
 /** AdditionalProductConfiguration */
 export interface DtoAdditionalProductConfiguration {
     refKey?: string;
@@ -5,11 +10,6 @@ export interface DtoAdditionalProductConfiguration {
     selOptions: Array<DtoSelectedOption>;
     additionalProducts?: Array<DtoAdditionalProductConfiguration>;
 }
-/** AdditionalProductConfigurationV2 */
-export interface DtoAdditionalProductConfigurationV2 extends DtoProductConfiguration {
-    refKey: string;
-    selected: boolean;
-}
 /** AdditionalProductRef */
 export interface DtoAdditionalProductRef {
     refKey: string;
@@ -52,7 +52,7 @@ export interface DtoCatalogueParams extends DtoCatalogueParamsWithoutCid {
 export interface DtoCatalogueParamsWithLang extends DtoCatalogueParams {
     lang: string;
 }
-/** CatalogueParamsWithoutCid */
+/** CatalogueParamsWithoutCid - To identify one catalogue the Portfolio ID CID is needed in addition to the parameters in this object. However as of now CID is not used in API calls and therefore this version without CID is needed. */
 export interface DtoCatalogueParamsWithoutCid {
     enterprise: string;
     prdCat: string;
@@ -127,12 +127,12 @@ export interface DtoFeature {
     syncGroup?: DtoSyncGroup;
     unit?: string;
 }
-/** FeatureConfiguration */
-export interface DtoFeatureConfiguration {
+/** FeatureConf */
+export interface DtoFeatureConf {
     code: string;
     groupCode?: string;
     unit?: string;
-    options?: Array<DtoOptionConfiguration>;
+    options?: Array<DtoOptionConf>;
 }
 /** FeatureRef */
 export interface DtoFeatureRef {
@@ -248,12 +248,12 @@ export interface DtoOption {
     upcharge?: number;
     priceCodes?: Array<string>;
 }
-/** OptionConfiguration */
-export interface DtoOptionConfiguration {
+/** OptionConf */
+export interface DtoOptionConf {
     code: string;
     selected: boolean;
     numericValue?: DtoValueWithUnit;
-    features?: Array<DtoFeatureConfiguration>;
+    features?: Array<DtoFeatureConf>;
 }
 /** Orientation */
 export interface DtoOrientation {
@@ -353,10 +353,10 @@ export interface DtoProductCatalogueInfo {
     exchangeRate: number;
     lastModified: string;
 }
-/** ProductConfiguration */
-export interface DtoProductConfiguration {
-    features?: Array<DtoFeatureConfiguration>;
-    additionalProducts?: Array<DtoAdditionalProductConfigurationV2>;
+/** ProductConf - This is intended to eventually supersede AdditionalProductConfiguration as the format for sending/receiving how a Product is configured. */
+export interface DtoProductConf {
+    features?: Array<DtoFeatureConf>;
+    additionalProducts?: Array<DtoAdditionalProductConf>;
     prodParams?: DtoProductParamsWithLang;
 }
 /** ProductData */

package/dist/CfgProduct.d.ts

@@ -1,5 +1,5 @@
 import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
-import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParams, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductConfiguration, DtoProductParamsWithLang, DtoTransform } from "./CatalogueAPI.js";
+import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParams, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductConf, DtoProductParamsWithLang, DtoTransform } from "./CatalogueAPI.js";
 import { CfgMeasureDefinition } from "./CfgMeasure.js";
 import { _CfgFeatureInternal } from "./productConfiguration/CfgFeature.js";
 import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
@@ -93,8 +93,15 @@ export declare class _CfgProductInternal {
     get selected(): boolean;
     readonly isAdditionalProduct: boolean;
     clone(parent?: _CfgProductInternal, root?: _CfgProductInternal): Promise<_CfgProductInternal>;
+    /** Mark this and its descendants as destroyed and remove all listeners */
     destroy: () => void;
+    /**
+     * Internal use. Used when this product is an additional product, and
+     * changing a parent product has made the settings for this product
+     * change.
+     */
     _updateAdditionalProdRef(p: DtoAdditionalProductRef): void;
+    get hasRootFeaturesChanged(): boolean;
     get description(): string | undefined;
     get rootNodeSources(): RootNodeSource[] | undefined;
     get mtrlApplications(): DtoMtrlApplication[] | undefined;
@@ -136,8 +143,8 @@ export declare class _CfgProductInternal {
     _additionalProductHasChanged: (freshRef: CfgProduct, bubbleMode: CfgProductBubbleMode, committed: boolean) => Promise<void>;
     /** Called by the configuration to tell its parent that it has changed. */
     _configurationHasChanged: (freshRef: CfgProductConfiguration, bubbleMode: ProductConfigurationBubbleMode, committed: boolean) => Promise<void>;
-    getDtoConfiguration: (includeExtendedData: boolean, includeProductParams: boolean) => DtoProductConfiguration;
-    setDtoConfiguration: (s: DtoProductConfiguration, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
+    getDtoConf: (includeExtendedData: boolean, includeProductParams: boolean) => DtoProductConf;
+    setDtoConf: (s: DtoProductConf, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     setApiSelection: (s: DtoAdditionalProductConfiguration, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     copyFrom: (source: _CfgProductInternal, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     private _setApiSelectionWithOtherProduct;
@@ -218,6 +225,18 @@ export declare class CfgProduct {
      *  assumed to always be legal.
      */
     setSelected: (v: boolean) => Promise<boolean>;
+    /**
+     * Functional selection is a Catalogues feature where selecting Options on Features result in that you
+     * "jump" to another Product as a result of the Validate call. You normally do not notice that a functional
+     * selection has occurred except for the styleNr changing. Functional selection can change which Features
+     * from the original product call are used as root Features. This can in turn affect if serialized
+     * configuration can be applied or not.
+     *
+     * The SDK can currently only apply serialized configuration if the list of root Features has not changed.
+     * For this reason, when functional selection has happened, extracting data for external systems might work
+     * well, but reapplying back into Stage will probably fail.
+     */
+    get hasRootFeaturesChanged(): boolean;
     get rawProductData(): CfgProductData;
     get uuid(): string;
     get unit(): LengthUnit;
@@ -254,11 +273,43 @@ export declare class CfgProduct {
      * Gets what selections has been made on the product, recursively including product
      * configuration, optional products and additional products. Used when a full view of all
      * selections on a product is needed, such as when doing Render or Export.
+     * @deprecated getDtoConf provides a newer format.
+     * @see getDtoConf
      */
     getApiSelection: () => DtoAdditionalProductConfiguration;
-    getDtoConfiguration: (includeExtendedData?: boolean, includeProductParams?: boolean) => DtoProductConfiguration;
-    setDtoConfiguration: (s: DtoProductConfiguration, doValidate?: boolean) => Promise<boolean>;
-    setApiSelection: (s: DtoAdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
+    /**
+     * Applies the configuration (selections) in the passed object onto the product recursively
+     * including product configuration, optional products and additional products.
+     * @param doValidate Makes a server side validation call. These are necessary to ensure that
+     *                   the right models are loaded.
+     * @deprecated setDtoConf uses a newer format.
+     */
+    setApiSelection: (configuration: DtoAdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
+    /**
+     * A newer alternative version of getApiSelection. This returns the configuration (selections)
+     * on the product, recursively including product configuration, optional products and additional
+     * products.
+     * This version has the following advantages over getApiSelection:
+     * - The format is clearer, designed to be readable
+     * - Makes less assumptions about the structure in the Product being unchanging over time. In
+     *   particular, the Feature codes are included in the data, so that changes to what Features
+     *   are used in a Product is less likely to lead to unexpected results.
+     * - You can request ExtendedData and/or ProductParams to be included in the result. This extra
+     *   data is ignored when passed back into the API, but it can be very useful for external
+     *   applications.
+     * The other version (getApiSelection) has the advantage of using a format directly compatible with the API:s.
+     * @param includeExtendedData  Includes extra data which is not an actual part of the configuration,
+     *                             i.e. units and groupCodes
+     * @param includeProductParams Includes what Product this was generated for, and the same for any
+     *                             Additional Products.
+     */
+    getDtoConf: (includeExtendedData?: boolean, includeProductParams?: boolean) => DtoProductConf;
+    /**
+     * A newer alternative version of setApiSelection.
+     * @param doValidate Makes a server side validation call. These are necessary to ensure that
+     *                   the right models are loaded.
+     */
+    setDtoConf: (configuration: DtoProductConf, doValidate?: boolean) => Promise<boolean>;
     listenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
     stopListenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
     stopAllListenForChange: () => void;

package/dist/CfgProduct.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { AggregatedLoadingObservable, assert, assertDefined, augmentErrorMessage, compareArrays, count, Observable, toLengthUnit, } from "@configura/web-utilities";
 import { CfgMeasureDefinition } from "./CfgMeasure.js";
-import { convertDtoProductConfigurationToV1 } from "./ConfigurationConverter.js";
+import { convertDtoProductConfToV1 } from "./ConfigurationConverter.js";
 import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
 import { CfgProductConfiguration } from "./productConfiguration/CfgProductConfiguration.js";
 import { collectAdditionalProductRefs } from "./productConfiguration/utilitiesProductConfiguration.js";
@@ -67,11 +67,13 @@ export class _CfgProductInternal {
         this._destroyed = false;
         this.additionalProducts = [];
         this.changeObservable = new Observable();
+        /** Mark this and its descendants as destroyed and remove all listeners */
         this.destroy = () => {
+            var _a;
             this._destroyed = true;
             this.changeObservable.stopAllListen();
             this.configuration.stopAllListenForChange();
-            for (const additionalProduct of this.additionalProducts || []) {
+            for (const additionalProduct of (_a = this.additionalProducts) !== null && _a !== void 0 ? _a : []) {
                 additionalProduct.destroy();
             }
         };
@@ -140,9 +142,9 @@ export class _CfgProductInternal {
                     return;
             }
         });
-        this.getDtoConfiguration = (includeExtendedData, includeProductParams) => {
+        this.getDtoConf = (includeExtendedData, includeProductParams) => {
             const conf = {};
-            const features = this.configuration._internal.getDtoConfiguration(includeExtendedData);
+            const features = this.configuration._internal.getDtoConf(includeExtendedData);
             if (0 < features.length) {
                 conf.features = features;
             }
@@ -151,7 +153,7 @@ export class _CfgProductInternal {
             }
             const additionalProducts = this.additionalProducts;
             if (0 < additionalProducts.length) {
-                conf.additionalProducts = additionalProducts.map((p) => p._internal.getDtoConfiguration(includeExtendedData, includeProductParams));
+                conf.additionalProducts = additionalProducts.map((p) => p._internal.getDtoConf(includeExtendedData, includeProductParams));
             }
             if (this.isAdditionalProduct) {
                 const refKey = this.refKey;
@@ -164,14 +166,14 @@ export class _CfgProductInternal {
             }
             return conf;
         };
-        this.setDtoConfiguration = (s, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
-            return yield this.setApiSelection(convertDtoProductConfigurationToV1(s), doValidate, productLoaderForGroupedLoad);
+        this.setDtoConf = (s, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
+            return yield this.setApiSelection(convertDtoProductConfToV1(s), doValidate, productLoaderForGroupedLoad);
         });
         this.setApiSelection = (s, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
             return yield this._setApiSelectionWithOtherProduct(s, doValidate, productLoaderForGroupedLoad, undefined);
         });
         this.copyFrom = (source, doValidate, productLoaderForGroupedLoad) => __awaiter(this, void 0, void 0, function* () {
-            return yield this._setApiSelectionWithOtherProduct(convertDtoProductConfigurationToV1(source.getDtoConfiguration(false, false)), doValidate, productLoaderForGroupedLoad, source);
+            return yield this._setApiSelectionWithOtherProduct(convertDtoProductConfToV1(source.getDtoConf(false, false)), doValidate, productLoaderForGroupedLoad, source);
         });
         this._setApiSelectionWithOtherProduct = (s, doValidate, productLoaderForGroupedLoad, sourceProduct) => __awaiter(this, void 0, void 0, function* () {
             // Wrap with cache will make getProduct for this function call use the same server call
@@ -312,7 +314,7 @@ export class _CfgProductInternal {
             const token = this.loadingObservable.startChildLoading();
             this._revalidateInProgressToken = token;
             try {
-                const response = yield productLoader.postValidate(correctDefaultsOnCatalogueParams(this.prodParams), { selOptions: configuration.getApiSelection() });
+                const response = yield productLoader.postValidate(correctDefaultsOnCatalogueParams(this.prodParams), { selOptions: configuration._internal.getApiSelection() });
                 // The revalidateInProgressToken is used to know if some other revalidate
                 // call has happened after this call, thereby making this call obsolete.
                 // This is a bit crude in that it does not actually cancel previous validate
@@ -350,7 +352,7 @@ export class _CfgProductInternal {
                 return true;
             }
             catch (e) {
-                throw augmentErrorMessage(e, "Validate product configuration request failure");
+                throw augmentErrorMessage(e, `Validate product configuration request (${this.prodParams.partNumber}) failure`);
             }
             finally {
                 this.loadingObservable.stopChildLoading(token);
@@ -435,7 +437,7 @@ export class _CfgProductInternal {
                 var _a;
                 const p = new _CfgProductInternal(() => {
                     initSuccess(p);
-                }, initFail, this._productLoaderRaw, this.prodParams, this.settings, this.optional, this.selected, this._configuration.rootFeatureRefs, this._configuration.allRawFeatures, this.uuid, this._rawUnit, this._rawProductData, this.configuration.getApiSelection(), new AggregatedLoadingObservable(), parent, root, this._additionalProductRef, (_a = this._syncGroupHandler) === null || _a === void 0 ? void 0 : _a.clone());
+                }, initFail, this._productLoaderRaw, this.prodParams, this.settings, this.optional, this.selected, this._configuration.rootFeatureRefs, this._configuration.allRawFeatures, this.uuid, this._rawUnit, this._rawProductData, this.configuration._internal.getApiSelection(), new AggregatedLoadingObservable(), parent, root, this._additionalProductRef, (_a = this._syncGroupHandler) === null || _a === void 0 ? void 0 : _a.clone());
             });
             for (const additionalProduct of this.additionalProducts) {
                 product.additionalProducts.push(CfgProduct._makeNewRefFrom(yield additionalProduct._internal.clone(product, root || product)));
@@ -443,12 +445,21 @@ export class _CfgProductInternal {
             return product;
         });
     }
+    /**
+     * Internal use. Used when this product is an additional product, and
+     * changing a parent product has made the settings for this product
+     * change.
+     */
     _updateAdditionalProdRef(p) {
         this._additionalProductRef = p;
         if (p.optional !== this.optional) {
             this._selected = p.optional ? false : undefined;
         }
     }
+    get hasRootFeaturesChanged() {
+        return (this._configuration._internal.hasRootFeaturesChanged ||
+            this.additionalProducts.some((p) => p._internal.hasRootFeaturesChanged));
+    }
     get description() {
         var _a, _b;
         return (_b = (_a = this._additionalProductRef) === null || _a === void 0 ? void 0 : _a.refDescription) !== null && _b !== void 0 ? _b : this._rawProductData.description;
@@ -611,7 +622,7 @@ prodParams, settings, optional, loadingObservable, parent, root, additionalProdu
         return product;
     }
     catch (e) {
-        throw augmentErrorMessage(e, "Load product request failure");
+        throw augmentErrorMessage(e, `Load product request (${prodParams.partNumber}) failure`);
     }
 });
 export class CfgProduct {
@@ -650,11 +661,43 @@ export class CfgProduct {
          * Gets what selections has been made on the product, recursively including product
          * configuration, optional products and additional products. Used when a full view of all
          * selections on a product is needed, such as when doing Render or Export.
+         * @deprecated getDtoConf provides a newer format.
+         * @see getDtoConf
+         */
+        this.getApiSelection = () => convertDtoProductConfToV1(this._internal.getDtoConf(false, false), true);
+        /**
+         * Applies the configuration (selections) in the passed object onto the product recursively
+         * including product configuration, optional products and additional products.
+         * @param doValidate Makes a server side validation call. These are necessary to ensure that
+         *                   the right models are loaded.
+         * @deprecated setDtoConf uses a newer format.
+         */
+        this.setApiSelection = (configuration, doValidate = true) => __awaiter(this, void 0, void 0, function* () { return yield this._internal.setApiSelection(configuration, doValidate); });
+        /**
+         * A newer alternative version of getApiSelection. This returns the configuration (selections)
+         * on the product, recursively including product configuration, optional products and additional
+         * products.
+         * This version has the following advantages over getApiSelection:
+         * - The format is clearer, designed to be readable
+         * - Makes less assumptions about the structure in the Product being unchanging over time. In
+         *   particular, the Feature codes are included in the data, so that changes to what Features
+         *   are used in a Product is less likely to lead to unexpected results.
+         * - You can request ExtendedData and/or ProductParams to be included in the result. This extra
+         *   data is ignored when passed back into the API, but it can be very useful for external
+         *   applications.
+         * The other version (getApiSelection) has the advantage of using a format directly compatible with the API:s.
+         * @param includeExtendedData  Includes extra data which is not an actual part of the configuration,
+         *                             i.e. units and groupCodes
+         * @param includeProductParams Includes what Product this was generated for, and the same for any
+         *                             Additional Products.
+         */
+        this.getDtoConf = (includeExtendedData = false, includeProductParams = false) => this._internal.getDtoConf(includeExtendedData, includeProductParams);
+        /**
+         * A newer alternative version of setApiSelection.
+         * @param doValidate Makes a server side validation call. These are necessary to ensure that
+         *                   the right models are loaded.
          */
-        this.getApiSelection = () => convertDtoProductConfigurationToV1(this._internal.getDtoConfiguration(false, false), true);
-        this.getDtoConfiguration = (includeExtendedData = false, includeProductParams = false) => this._internal.getDtoConfiguration(includeExtendedData, includeProductParams);
-        this.setDtoConfiguration = (s, doValidate = true) => __awaiter(this, void 0, void 0, function* () { return yield this._internal.setDtoConfiguration(s, doValidate); });
-        this.setApiSelection = (s, doValidate = true) => __awaiter(this, void 0, void 0, function* () { return yield this._internal.setApiSelection(s, doValidate); });
+        this.setDtoConf = (configuration, doValidate = true) => __awaiter(this, void 0, void 0, function* () { return yield this._internal.setDtoConf(configuration, doValidate); });
         this.listenForChange = (l) => this._internal.changeObservable.listen(l);
         this.stopListenForChange = (l) => this._internal.changeObservable.stopListen(l);
         this.stopAllListenForChange = () => this._internal.changeObservable.stopAllListen();
@@ -733,6 +776,21 @@ export class CfgProduct {
     get visible() {
         return this._internal.visible;
     }
+    // A similar text to the one below exists in global-message-managers.md and should be kept in sync.
+    /**
+     * Functional selection is a Catalogues feature where selecting Options on Features result in that you
+     * "jump" to another Product as a result of the Validate call. You normally do not notice that a functional
+     * selection has occurred except for the styleNr changing. Functional selection can change which Features
+     * from the original product call are used as root Features. This can in turn affect if serialized
+     * configuration can be applied or not.
+     *
+     * The SDK can currently only apply serialized configuration if the list of root Features has not changed.
+     * For this reason, when functional selection has happened, extracting data for external systems might work
+     * well, but reapplying back into Stage will probably fail.
+     */
+    get hasRootFeaturesChanged() {
+        return this._internal.hasRootFeaturesChanged;
+    }
     get rawProductData() {
         return this._internal.rawProductData;
     }

package/dist/ConfigurationConverter.d.ts

@@ -1,14 +1,14 @@
-import { DtoAdditionalProductConfiguration, DtoAdditionalProductConfigurationV2, DtoFeatureConfiguration, DtoProductConfiguration, DtoSelectedOption } from "./CatalogueAPI.js";
-export declare const isDtoProductConfigurationAdditional: (value: DtoProductConfiguration) => value is DtoAdditionalProductConfigurationV2;
-export declare const convertDtoProductConfigurationToV1: (conf: DtoProductConfiguration, silenceWarnings?: boolean) => DtoAdditionalProductConfiguration;
-export declare const convertDtoFeatureConfigurationsToSelOptions: (features: DtoFeatureConfiguration[], silenceWarnings?: boolean) => DtoSelectedOption[];
+import { DtoAdditionalProductConf, DtoAdditionalProductConfiguration, DtoFeatureConf, DtoProductConf, DtoSelectedOption } from "./CatalogueAPI.js";
+export declare const isDtoProductConfAdditional: (value: DtoProductConf) => value is DtoAdditionalProductConf;
+export declare const convertDtoProductConfToV1: (conf: DtoProductConf, silenceWarnings?: boolean) => DtoAdditionalProductConfiguration;
+export declare const convertDtoFeatureConfsToSelOptions: (features: DtoFeatureConf[], silenceWarnings?: boolean) => DtoSelectedOption[];
 /**
  * Serializes and compacts the configuration into a format especially suited for URLs
  */
-export declare const dtoProductConfigurationToCompactString: (conf: DtoProductConfiguration) => string;
+export declare const dtoProductConfigurationToCompactString: (conf: DtoProductConf) => string;
 /**
  * Deserializes and inflates the configuration from the compacted format
  */
-export declare const compactStringToDtoProductConfiguration: (versionAndConf: string) => DtoProductConfiguration;
-export declare const stripExtendedDataFromDtoProductConfiguration: (conf: DtoProductConfiguration) => DtoProductConfiguration;
+export declare const compactStringToDtoProductConf: (versionAndConf: string) => DtoProductConf;
+export declare const stripExtendedDataFromDtoProductConf: (conf: DtoProductConf) => DtoProductConf;
 //# sourceMappingURL=ConfigurationConverter.d.ts.map

package/dist/ConfigurationConverter.js

@@ -1,33 +1,33 @@
-export const isDtoProductConfigurationAdditional = (value) => "refKey" in value;
+export const isDtoProductConfAdditional = (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 convertDtoProductConfigurationToV1 = (conf, silenceWarnings = false) => {
+export const convertDtoProductConfToV1 = (conf, silenceWarnings = false) => {
     var _a, _b;
     if (!silenceWarnings && conf.prodParams !== undefined && !hasInformedAboutProdParams) {
         hasInformedAboutProdParams = true;
-        console.info("Incoming DtoProductConfiguration contains prodParams. These will be ignored.");
+        console.info("Incoming DtoProductConf contains prodParams. These will be ignored.");
     }
     const result = {
         selOptions: ((_a = conf.features) !== null && _a !== void 0 ? _a : []).map((f) => ({
             code: "!~!",
-            next: convertDtoFeatureConfigurationToApiSelection(f, silenceWarnings),
+            next: convertDtoFeatureConfToApiSelection(f, silenceWarnings),
         })),
-        additionalProducts: ((_b = conf.additionalProducts) !== null && _b !== void 0 ? _b : []).map((p) => convertDtoProductConfigurationToV1(p, silenceWarnings)),
+        additionalProducts: ((_b = conf.additionalProducts) !== null && _b !== void 0 ? _b : []).map((p) => convertDtoProductConfToV1(p, silenceWarnings)),
         selected: true,
     };
-    if (isDtoProductConfigurationAdditional(conf)) {
+    if (isDtoProductConfAdditional(conf)) {
         result.refKey = conf.refKey;
         result.selected = conf.selected;
     }
     return result;
 };
-export const convertDtoFeatureConfigurationsToSelOptions = (features, silenceWarnings = false) => (features !== null && features !== void 0 ? features : []).map((f) => ({
+export const convertDtoFeatureConfsToSelOptions = (features, silenceWarnings = false) => (features !== null && features !== void 0 ? features : []).map((f) => ({
     code: "!~!",
-    next: convertDtoFeatureConfigurationToApiSelection(f, silenceWarnings),
+    next: convertDtoFeatureConfToApiSelection(f, silenceWarnings),
 }));
-const convertDtoFeatureConfigurationToApiSelection = (feature, silenceWarnings) => {
+const convertDtoFeatureConfToApiSelection = (feature, silenceWarnings) => {
     const { groupCode, options, unit } = feature;
     if (!silenceWarnings && groupCode !== undefined && !hasInformedAboutGroupCode) {
         hasInformedAboutGroupCode = true;
@@ -39,13 +39,13 @@ const convertDtoFeatureConfigurationToApiSelection = (feature, silenceWarnings)
     }
     const result = {};
     for (const option of (options !== null && options !== void 0 ? options : []).filter((o) => o.selected)) {
-        result[option.code] = convertDtoOptionConfigurationToSelectedOption(option, silenceWarnings);
+        result[option.code] = convertDtoOptionConfToSelectedOption(option, silenceWarnings);
     }
     return result;
 };
-const convertDtoOptionConfigurationToSelectedOption = (option, silenceWarnings) => {
+const convertDtoOptionConfToSelectedOption = (option, silenceWarnings) => {
     const { features, code, numericValue } = option;
-    const selectionTrees = (features !== null && features !== void 0 ? features : []).map((f) => convertDtoFeatureConfigurationToApiSelection(f, silenceWarnings));
+    const selectionTrees = (features !== null && features !== void 0 ? features : []).map((f) => convertDtoFeatureConfToApiSelection(f, silenceWarnings));
     const mergedSelectionTree = {};
     let anyItems = false;
     for (const selectionTree of selectionTrees) {
@@ -76,7 +76,7 @@ const swapForUrlAdaptedRegex = /[-~_{}"]/g;
 const shortToLong = new Map();
 const longToShort = new Map();
 // The replacement scheme here assumes this will only be used for keys
-// in DtoProductConfiguration and the knowledge that it contains no one
+// in DtoProductConf and the knowledge that it contains no one
 // one char keys.
 for (const [long, short] of [
     ["configuration", "c"],
@@ -116,17 +116,17 @@ const jsonStringSwapCharsForUrl = (data) => data.replace(swapForUrlAdaptedRegex,
             throw new Error(`Unexpected char "${char}" in swap for URL`);
     }
 });
-const compactDtoProductConfigurationJsonKeys = (data) => data.replace(jsonKeyRegex, (_, key) => { var _a; return `"${(_a = longToShort.get(key)) !== null && _a !== void 0 ? _a : key}":`; });
-const expandDtoProductConfigurationJsonKeys = (data) => data.replace(jsonKeyRegex, (_, key) => { var _a; return `"${(_a = shortToLong.get(key)) !== null && _a !== void 0 ? _a : key}":`; });
+const compactDtoProductConfJsonKeys = (data) => data.replace(jsonKeyRegex, (_, key) => { var _a; return `"${(_a = longToShort.get(key)) !== null && _a !== void 0 ? _a : key}":`; });
+const expandDtoProductConfJsonKeys = (data) => data.replace(jsonKeyRegex, (_, key) => { var _a; return `"${(_a = shortToLong.get(key)) !== null && _a !== void 0 ? _a : key}":`; });
 /**
  * Serializes and compacts the configuration into a format especially suited for URLs
  */
 export const dtoProductConfigurationToCompactString = (conf) => "v1" +
-    jsonStringSwapCharsForUrl(compactDtoProductConfigurationJsonKeys(JSON.stringify(conf, undefined, "")));
+    jsonStringSwapCharsForUrl(compactDtoProductConfJsonKeys(JSON.stringify(conf, undefined, "")));
 /**
  * Deserializes and inflates the configuration from the compacted format
  */
-export const compactStringToDtoProductConfiguration = (versionAndConf) => {
+export const compactStringToDtoProductConf = (versionAndConf) => {
     const match = versionedRegex.exec(versionAndConf);
     if (match === null) {
         throw new Error("Could not match version string");
@@ -138,29 +138,29 @@ export const compactStringToDtoProductConfiguration = (versionAndConf) => {
     if (conf === "") {
         throw new Error("No conf found");
     }
-    return JSON.parse(expandDtoProductConfigurationJsonKeys(jsonStringSwapCharsForUrl(conf)));
+    return JSON.parse(expandDtoProductConfJsonKeys(jsonStringSwapCharsForUrl(conf)));
 };
-export const stripExtendedDataFromDtoProductConfiguration = (conf) => {
+export const stripExtendedDataFromDtoProductConf = (conf) => {
     var _a, _b;
     return ({
-        features: (_a = conf.features) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoFeatureConfiguration),
+        features: (_a = conf.features) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoFeatureConf),
         additionalProducts: (_b = conf.additionalProducts) === null || _b === void 0 ? void 0 : _b.map(stripExtendedDataFromDtoAdditionalProductConfiguration),
     });
 };
-const stripExtendedDataFromDtoAdditionalProductConfiguration = (conf) => (Object.assign(Object.assign({}, stripExtendedDataFromDtoProductConfiguration(conf)), { refKey: conf.refKey, selected: conf.selected }));
-const stripExtendedDataFromDtoFeatureConfiguration = (conf) => {
+const stripExtendedDataFromDtoAdditionalProductConfiguration = (conf) => (Object.assign(Object.assign({}, stripExtendedDataFromDtoProductConf(conf)), { refKey: conf.refKey, selected: conf.selected }));
+const stripExtendedDataFromDtoFeatureConf = (conf) => {
     var _a;
     return ({
         code: conf.code,
-        options: (_a = conf.options) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoOptionConfiguration),
+        options: (_a = conf.options) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoOptionConf),
     });
 };
-const stripExtendedDataFromDtoOptionConfiguration = (conf) => {
+const stripExtendedDataFromDtoOptionConf = (conf) => {
     var _a;
     return ({
         code: conf.code,
         selected: conf.selected,
         numericValue: conf.numericValue,
-        features: (_a = conf.features) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoFeatureConfiguration),
+        features: (_a = conf.features) === null || _a === void 0 ? void 0 : _a.map(stripExtendedDataFromDtoFeatureConf),
     });
 };

package/dist/io/CfgHistoryManager.d.ts

@@ -2,6 +2,21 @@ import { CfgWindowEventManager } from "./CfgWindowEventManager.js";
 declare type CfgHistoryManagerMessageData = {
     initial: boolean;
 };
+/**
+ * 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 declare enum HistoryMode {
+    DoNotWrite = 0,
+    Replace = 1,
+    Push = 2,
+    ReplaceAndUpdateUrl = 3,
+    PushAndUpdateUrl = 4
+}
 /**
  * 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 query string
@@ -11,7 +26,7 @@ declare type CfgHistoryManagerMessageData = {
  */
 export declare type CfgHistoryManagerSendData<D> = {
     message: D;
-    useHistoryPush: boolean;
+    mode: HistoryMode;
     qsKeyValues: Map<string, string | undefined>;
 };
 /**
@@ -22,6 +37,22 @@ export declare class CfgHistoryManager extends CfgWindowEventManager<"popstate",
     private static _instance;
     static get instance(): CfgHistoryManager;
     private constructor();
+    private _aggregatedQsKeyValues;
+    private _urlUpdateObservable;
+    /**
+     * @returns The current browser URL updated with the latest updates from
+     *          the Connectors.
+     */
+    getUrl(): string;
+    /**
+     * Listen for updated URL:s. This doesn't have to mean the URL in the
+     * browser has been updated.
+     */
+    listenForUrl(listener: (url: string) => void): void;
+    /**
+     * Stop listen.
+     */
+    stopListenForUrl(listener: (url: string) => void): void;
     /**
      * Write to the history
      */
@@ -47,6 +78,7 @@ export declare class CfgHistoryManager extends CfgWindowEventManager<"popstate",
     private static _makeUpdatedState;
     protected readonly eventType = "popstate";
     protected getDataFromEvent(event: PopStateEvent): unknown;
+    static getMessageFromCurrentHistoryState(messageKey: string): unknown | undefined;
 }
 export {};
 //# sourceMappingURL=CfgHistoryManager.d.ts.map