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

package/dist/io/CfgIOManager.d.ts

@@ -1,54 +1,54 @@
-import { CfgIOWarningSupplier } from "./CfgIOWarningSupplier";
-declare type ConfiguraAttribute = "C0nf1gura";
-declare type ConfiguraShebang = "arug1fn0C";
-declare const CONFIGURA_ATTRIBUTE: ConfiguraAttribute;
-export declare type IOManagerListener = (data: unknown) => Promise<void>;
-/**
- * The container format used when the environment is globally shared with things
- * outside our control. The "shebang" is a magic string that should prevent from a
- * CfgIOContainer being confused with something else.
- */
-export declare type CfgIOContainer = {
-    [CONFIGURA_ATTRIBUTE]: ConfiguraShebang;
-    messages: {
-        [index: string]: unknown;
-    };
-};
-/**
- * Base class for classes handling input and output in globally shared environments.
- */
-export declare abstract class CfgIOManager<S> {
-    private _warningSuppliers;
-    addWarningSupplier(supplier: CfgIOWarningSupplier): void;
-    removeWarningSupplier(supplier: CfgIOWarningSupplier): void;
-    getWarnings(): string[];
-    /**
-     * Listen for the message messageKey being received.
-     */
-    listenForMessage(l: IOManagerListener, messageKey: string): boolean;
-    /**
-     * Removes the listener
-     */
-    stopListenForMessage(l: IOManagerListener): boolean;
-    static isIOContainer: (data: unknown) => data is CfgIOContainer;
-    static hasIOContainerMessageKey: (container: CfgIOContainer, messageKey: string) => boolean;
-    static getMessageFromIOContainer: (container: unknown, messageKey: string) => unknown;
-    static makeContainer: (messages: {
-        [index: string]: unknown;
-    }) => CfgIOContainer;
-    private _receiveInProgress;
-    private static _inhibitAllReceive;
-    get receiveInProgress(): boolean;
-    private _messageListeners;
-    private _getIndexOfMessageListener;
-    get hasMessageListeners(): boolean;
-    protected _containerListener(data: unknown): void;
-    /**
-     * Send the data with messageKey. This can for example be pushing or
-     * replacing on the history stack or sending a message using the
-     * window.message API.
-     */
-    abstract send(messageKey: string, data: S): void;
-}
-export {};
+import { CfgIOWarningSupplier } from "./CfgIOWarningSupplier";
+declare type ConfiguraAttribute = "C0nf1gura";
+declare type ConfiguraShebang = "arug1fn0C";
+declare const CONFIGURA_ATTRIBUTE: ConfiguraAttribute;
+export declare type IOManagerListener = (data: unknown) => Promise<void>;
+/**
+ * The container format used when the environment is globally shared with things
+ * outside our control. The "shebang" is a magic string that should prevent from a
+ * CfgIOContainer being confused with something else.
+ */
+export declare type CfgIOContainer = {
+    [CONFIGURA_ATTRIBUTE]: ConfiguraShebang;
+    messages: {
+        [index: string]: unknown;
+    };
+};
+/**
+ * Base class for classes handling input and output in globally shared environments.
+ */
+export declare abstract class CfgIOManager<S> {
+    private _warningSuppliers;
+    addWarningSupplier(supplier: CfgIOWarningSupplier): void;
+    removeWarningSupplier(supplier: CfgIOWarningSupplier): void;
+    getWarnings(): string[];
+    /**
+     * Listen for the message messageKey being received.
+     */
+    listenForMessage(l: IOManagerListener, messageKey: string): boolean;
+    /**
+     * Removes the listener
+     */
+    stopListenForMessage(l: IOManagerListener): boolean;
+    static isIOContainer: (data: unknown) => data is CfgIOContainer;
+    static hasIOContainerMessageKey: (container: CfgIOContainer, messageKey: string) => boolean;
+    static getMessageFromIOContainer: (container: unknown, messageKey: string) => unknown;
+    static makeContainer: (messages: {
+        [index: string]: unknown;
+    }) => CfgIOContainer;
+    private _receiveInProgress;
+    private static _inhibitAllReceive;
+    get receiveInProgress(): boolean;
+    private _messageListeners;
+    private _getIndexOfMessageListener;
+    get hasMessageListeners(): boolean;
+    protected _containerListener(data: unknown): void;
+    /**
+     * Send the data with messageKey. This can for example be pushing or
+     * replacing on the history stack or sending a message using the
+     * window.message API.
+     */
+    abstract send(messageKey: string, data: S): void;
+}
+export {};
 //# sourceMappingURL=CfgIOManager.d.ts.map

package/dist/io/CfgIOManager.js

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

package/dist/io/CfgIOProdConfConnector.d.ts

@@ -1,57 +1,65 @@
-import { DtoAdditionalProductConfiguration, DtoProductConf } from "../CatalogueAPI.js";
-import { CfgProduct, CfgProductChangeNotification } from "../CfgProduct.js";
-import { CfgIOManager } from "./CfgIOManager.js";
-import { CfgIOWarningSupplier } from "./CfgIOWarningSupplier.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: DtoProductConf;
-};
-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
-}
-export declare const STAGE_PROD_CONF_MESSAGE_KEY = "stageprodconf";
-declare type ProdConfMessageCallback = (message: CfgProdConfMessage) => Promise<void>;
-declare type ProdConfCallback = (conf: DtoProductConf) => Promise<void>;
-/**
- * Base class for connecting the product configuration to an IO channel
- */
-export declare abstract class CfgIOProdConfConnector<S> implements CfgIOWarningSupplier {
-    protected readonly _ioManager: CfgIOManager<S>;
-    private readonly _includeExtendedDataInSend;
-    private readonly _includeProdParamsInSend;
-    protected _product: CfgProduct | undefined;
-    private _stopListenToMessage;
-    private _stopListenToProdConf;
-    constructor(_ioManager: CfgIOManager<S>, _includeExtendedDataInSend: boolean, // Only for v2.0
-    _includeProdParamsInSend: boolean);
-    destroy(): void;
-    getWarnings(): string[];
-    setProduct: (product: CfgProduct | undefined) => Promise<void>;
-    private _send;
-    protected getInitialProdConf(): DtoProductConf | undefined;
-    protected abstract makeSendData(conf: DtoProductConf, initial: boolean): S;
-    static makeMessage(conf: DtoProductConf, initial: boolean, sendVersions: CfgProdConfMessageVersions): CfgProdConfMessage;
-    static makeMessageListener(callback: ProdConfMessageCallback): (message: unknown) => Promise<void>;
-    /**
-     * Register the callback to listen for Product Configuration messages
-     * @returns A function which when called will cancel listening
-     */
-    static listenForMessage<S>(callback: ProdConfMessageCallback, ioManager: CfgIOManager<S>): () => void;
-    static makeProdConfListener(callback: ProdConfCallback, includeExtendedDataInSend: boolean, includeProdParamsInSend: boolean): (n: CfgProductChangeNotification) => void;
-    static listenForProdConf(product: CfgProduct, callback: ProdConfCallback, includeExtendedDataInSend: boolean, includeProdParamsInSend: boolean): () => void;
-}
-export {};
+import { DtoAdditionalProductConfiguration, DtoProductConf } from "../CatalogueAPI.js";
+import { CfgProduct, CfgProductChangeNotification } from "../CfgProduct.js";
+import { CfgIOManager } from "./CfgIOManager.js";
+import { CfgIOWarningSupplier } from "./CfgIOWarningSupplier.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: DtoProductConf;
+};
+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
+}
+/**
+ * @param ExtendedData   Includes extra data, i.e. units and groupCodes
+ * @param ProductParams  Includes what Product this was generated for, and the same for any Additional Products.
+ * @param SyncGroupState Includes the current sync group state
+ */
+export declare enum CfgProdConfParts {
+    NoExtra = 0,
+    ExtendedData = 1,
+    ProdParams = 2,
+    SyncGroupState = 4
+}
+export declare const STAGE_PROD_CONF_MESSAGE_KEY = "stageprodconf";
+declare type ProdConfMessageCallback = (message: CfgProdConfMessage) => Promise<void>;
+declare type ProdConfCallback = (conf: DtoProductConf) => Promise<void>;
+/**
+ * Base class for connecting the product configuration to an IO channel
+ */
+export declare abstract class CfgIOProdConfConnector<S> implements CfgIOWarningSupplier {
+    protected readonly _ioManager: CfgIOManager<S>;
+    private readonly _includeInSend;
+    protected _product: CfgProduct | undefined;
+    private _stopListenToMessage;
+    private _stopListenToProdConf;
+    constructor(_ioManager: CfgIOManager<S>, _includeInSend: CfgProdConfParts);
+    destroy(): void;
+    getWarnings(): string[];
+    setProduct: (product: CfgProduct | undefined) => Promise<void>;
+    private _send;
+    protected abstract makeSendData(conf: DtoProductConf, initial: boolean): S;
+    static makeMessage: (conf: DtoProductConf, initial: boolean, sendVersions: CfgProdConfMessageVersions) => CfgProdConfMessage;
+    static makeMessageListener: (callback: ProdConfMessageCallback) => (message: unknown) => Promise<void>;
+    /**
+     * Register the callback to listen for Product Configuration messages
+     * @returns A function which when called will cancel listening
+     */
+    static listenForMessage<S>(callback: ProdConfMessageCallback, ioManager: CfgIOManager<S>): () => void;
+    static makeProdConfListener: (callback: ProdConfCallback, includeInSend: CfgProdConfParts) => (n: CfgProductChangeNotification) => void;
+    static listenForProdConf(product: CfgProduct, callback: ProdConfCallback, includeInSend: CfgProdConfParts): () => void;
+}
+export {};
 //# sourceMappingURL=CfgIOProdConfConnector.d.ts.map