@configura/web-api 2.1.0-alpha.2 → 2.1.0-alpha.3

package/dist/CfgReferencePathHelper.d.ts

@@ -1,27 +1,27 @@
-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;
-}
+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,26 +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 {
-}
-/**
- * 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)}`;
+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/index.d.ts

@@ -1,25 +1,25 @@
-export * from "./CatalogueAPI.js";
-export * from "./CfgProduct.js";
-export * from "./CfgReferencePathHelper.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 "./syncGroups/SyncGroupsPathHelper.js";
-export * from "./tasks/formats.js";
-export * from "./tasks/TaskHandler.js";
-export * from "./utilitiesCatalogueData.js";
-export * from "./utilitiesCataloguePermission.js";
-export * from "./utilitiesConfiguration.js";
-export * from "./utilitiesNumericValues.js";
+export * from "./CatalogueAPI.js";
+export * from "./CfgProduct.js";
+export * from "./CfgReferencePathHelper.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 "./syncGroups/SyncGroupsPathHelper.js";
+export * from "./tasks/formats.js";
+export * from "./tasks/TaskHandler.js";
+export * from "./utilitiesCatalogueData.js";
+export * from "./utilitiesCataloguePermission.js";
+export * from "./utilitiesConfiguration.js";
+export * from "./utilitiesNumericValues.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,24 +1,24 @@
-export * from "./CatalogueAPI.js";
-export * from "./CfgProduct.js";
-export * from "./CfgReferencePathHelper.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 "./syncGroups/SyncGroupsPathHelper.js";
-export * from "./tasks/formats.js";
-export * from "./tasks/TaskHandler.js";
-export * from "./utilitiesCatalogueData.js";
-export * from "./utilitiesCataloguePermission.js";
-export * from "./utilitiesConfiguration.js";
-export * from "./utilitiesNumericValues.js";
+export * from "./CatalogueAPI.js";
+export * from "./CfgProduct.js";
+export * from "./CfgReferencePathHelper.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 "./syncGroups/SyncGroupsPathHelper.js";
+export * from "./tasks/formats.js";
+export * from "./tasks/TaskHandler.js";
+export * from "./utilitiesCatalogueData.js";
+export * from "./utilitiesCataloguePermission.js";
+export * from "./utilitiesConfiguration.js";
+export * from "./utilitiesNumericValues.js";

package/dist/io/CfgHistoryManager.d.ts

@@ -1,84 +1,84 @@
-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 {};
+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