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

package/dist/CfgReferencePathHelper.d.ts

@@ -1,14 +1,27 @@
-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;
-}
+import { DtoCatalogueParamsWithCidAndLang, DtoProductParamsWithCidAndLang } 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 {
+    /**
+     * Use to generate URLs in our reference format. This is the format Configura uses in our integrations.
+     * @param browsingRootUrl The URL where Stage browsing begins
+     * @param catParams What catalogue to generate URL for.
+     * @returns An URL to a catalogue
+     */
+    static getCataloguePath: (browsingRootUrl: string, catParams: DtoCatalogueParamsWithCidAndLang) => string;
+    /**
+     * Use to generate URLs in our reference format. This is the format Configura uses in our integrations.
+     * @param browsingRootUrl The URL where Stage browsing begins
+     * @param productParams What product to generate URL for.
+     * @param separator Optional, defaults to "product", but can be changed to indicate another function.
+     * @returns An URL to a product
+     */
+    static getProductPath: (browsingRootUrl: string, productParams: DtoProductParamsWithCidAndLang, separator?: string) => string;
+}
 //# sourceMappingURL=CfgReferencePathHelper.d.ts.map

package/dist/CfgReferencePathHelper.js

@@ -1,13 +1,26 @@
-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)}`;
+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 {
+}
+/**
+ * Use to generate URLs in our reference format. This is the format Configura uses in our integrations.
+ * @param browsingRootUrl The URL where Stage browsing begins
+ * @param catParams What catalogue to generate URL for.
+ * @returns An URL to a catalogue
+ */
+CfgReferencePathHelper.getCataloguePath = (browsingRootUrl, catParams) => `${browsingRootUrl}/${encodeURIComponents(catParams.cid, catParams.lang, catParams.enterprise, catParams.prdCat, catParams.prdCatVersion, catParams.vendor, catParams.priceList)}`;
+/**
+ * Use to generate URLs in our reference format. This is the format Configura uses in our integrations.
+ * @param browsingRootUrl The URL where Stage browsing begins
+ * @param productParams What product to generate URL for.
+ * @param separator Optional, defaults to "product", but can be changed to indicate another function.
+ * @returns An URL to a product
+ */
+CfgReferencePathHelper.getProductPath = (browsingRootUrl, productParams, separator = "product") => `${CfgReferencePathHelper.getCataloguePath(browsingRootUrl, productParams)}/${separator}/${encodeURIComponent(productParams.partNumber)}`;

package/dist/ConfigurationConverter.d.ts

@@ -1,5 +1,18 @@
-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[];
+import { DtoAdditionalProductConf, DtoAdditionalProductConfiguration, DtoFeatureConf, DtoProductConf, DtoSelectedOption } from "./CatalogueAPI.js";
+/** Is the newer version of product configuration */
+export declare const isProductConf: (value: DtoAdditionalProductConfiguration | DtoProductConf) => value is DtoAdditionalProductConf;
+/** Is the older version of product configuration */
+export declare const isAdditionalProductConfiguration: (value: DtoAdditionalProductConfiguration | DtoProductConf) => value is DtoAdditionalProductConfiguration;
+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: DtoProductConf) => string;
+/**
+ * Deserializes and inflates the configuration from the compacted format
+ */
+export declare const compactStringToDtoProductConf: (versionAndConf: string) => DtoProductConf;
+export declare const stripExtendedDataFromDtoProductConf: (conf: DtoProductConf) => DtoProductConf;
 //# sourceMappingURL=ConfigurationConverter.d.ts.map

package/dist/ConfigurationConverter.js

@@ -1,72 +1,175 @@
-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;
-};
+/** Is the newer version of product configuration */
+export const isProductConf = (value) => !("selOptions" in value);
+/** Is the older version of product configuration */
+export const isAdditionalProductConfiguration = (value) => "selOptions" 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 convertDtoProductConfToV1 = (conf, silenceWarnings = false) => {
+    var _a, _b;
+    if (!silenceWarnings && conf.prodParams !== undefined && !hasInformedAboutProdParams) {
+        hasInformedAboutProdParams = true;
+        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: convertDtoFeatureConfToApiSelection(f, silenceWarnings),
+        })),
+        additionalProducts: ((_b = conf.additionalProducts) !== null && _b !== void 0 ? _b : []).map((p) => convertDtoProductConfToV1(p, silenceWarnings)),
+        selected: true,
+    };
+    if (isDtoProductConfAdditional(conf)) {
+        result.refKey = conf.refKey;
+        result.selected = conf.selected;
+    }
+    return result;
+};
+export const convertDtoFeatureConfsToSelOptions = (features, silenceWarnings = false) => (features !== null && features !== void 0 ? features : []).map((f) => ({
+    code: "!~!",
+    next: convertDtoFeatureConfToApiSelection(f, silenceWarnings),
+}));
+const convertDtoFeatureConfToApiSelection = (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] = convertDtoOptionConfToSelectedOption(option, silenceWarnings);
+    }
+    return result;
+};
+const convertDtoOptionConfToSelectedOption = (option, silenceWarnings) => {
+    const { features, code, numericValue } = option;
+    const selectionTrees = (features !== null && features !== void 0 ? features : []).map((f) => convertDtoFeatureConfToApiSelection(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;
+};
+const versionedRegex = /^v(\d+)(.+)$/;
+const jsonKeyRegex = /"([^"]+)":/g;
+const swapForUrlAdaptedRegex = /[-~_{}"]/g;
+const shortToLong = new Map();
+const longToShort = new Map();
+// The replacement scheme here assumes this will only be used for keys
+// in DtoProductConf and the knowledge that it contains no one
+// one char keys.
+for (const [long, short] of [
+    ["configuration", "c"],
+    ["additionalProducts", "a"],
+    ["prodParams", "p"],
+    ["refKey", "r"],
+    ["selected", "s"],
+    ["features", "f"],
+    ["code", "d"],
+    ["options", "o"],
+    ["numericValue", "n"],
+    ["groupCode", "g"],
+    ["unit", "u"],
+    ["syncGroupState", "sgs"],
+    ["selectOne", "so"],
+    ["selectMany", "sm"],
+    ["syncCode", "sc"],
+    ["optionCode", "oc"],
+]) {
+    shortToLong.set(short, long);
+    longToShort.set(long, short);
+}
+/**
+ * As certain chars are abundant in JSON but less abundant in the actual data
+ * we swap these so that frequent characters do not need to be URL-encoded.
+ */
+const jsonStringSwapCharsForUrl = (data) => data.replace(swapForUrlAdaptedRegex, (char) => {
+    switch (char) {
+        case "{":
+            return "~";
+        case "}":
+            return "-";
+        case '"':
+            return "_";
+        case "~":
+            return "{";
+        case "-":
+            return "}";
+        case "_":
+            return '"';
+        default:
+            throw new Error(`Unexpected char "${char}" in swap for URL`);
+    }
+});
+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(compactDtoProductConfJsonKeys(JSON.stringify(conf, undefined, "")));
+/**
+ * Deserializes and inflates the configuration from the compacted format
+ */
+export const compactStringToDtoProductConf = (versionAndConf) => {
+    const match = versionedRegex.exec(versionAndConf);
+    if (match === null) {
+        throw new Error("Could not match version string");
+    }
+    const [, version, conf] = match;
+    if (version !== "1") {
+        throw new Error("Unknown packed URL version");
+    }
+    if (conf === "") {
+        throw new Error("No conf found");
+    }
+    return JSON.parse(expandDtoProductConfJsonKeys(jsonStringSwapCharsForUrl(conf)));
+};
+export const stripExtendedDataFromDtoProductConf = (conf) => {
+    var _a, _b;
+    return ({
+        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({}, 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(stripExtendedDataFromDtoOptionConf),
+    });
+};
+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(stripExtendedDataFromDtoFeatureConf),
+    });
+};

package/dist/index.d.ts

@@ -1,24 +1,24 @@
-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";
+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,23 +1,23 @@
-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";
+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

@@ -1,51 +1,84 @@
-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 {};
+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
+ * key-values 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;
+    mode: HistoryMode;
+    qsKeyValues: Map<string, string | undefined>;
+};
+/**
+ * This class is used to coordinate writing and reading to the browser history.
+ * It handles messages sent from the connectors.
+ */
+export declare class CfgHistoryManager extends CfgWindowEventManager<"popstate", CfgHistoryManagerSendData<CfgHistoryManagerMessageData>> {
+    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
+     */
+    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;
+    static getMessageFromCurrentHistoryState(messageKey: string): unknown | undefined;
+}
+export {};
 //# sourceMappingURL=CfgHistoryManager.d.ts.map