@configura/web-api 1.6.0-iotest.4 → 1.6.0-rc.0

package/dist/io/CfgHistoryToProdConfConnector.js

@@ -1,24 +0,0 @@
-import { CfgHistoryManager } from "./CfgHistoryManager.js";
-import { CfgIOProdConfConnector, prodConfToString, STAGE_PROD_CONF_MESSAGE_KEY, } from "./CfgIOProdConfConnector.js";
-export class CfgHistoryToProdConfConnector extends CfgIOProdConfConnector {
-    /**
-     * @param _useHistoryPush As opposed to replace. Push makes the web browser navigation buttons navigate configuration changes. Replace just updates the URL.
-     */
-    constructor(manager, _useHistoryPush, _qsKey = STAGE_PROD_CONF_MESSAGE_KEY, doValidate = true) {
-        super(manager, doValidate);
-        this._useHistoryPush = _useHistoryPush;
-        this._qsKey = _qsKey;
-    }
-    getInitialProdConf() {
-        return CfgHistoryManager.currentQsKeyValues().get(this._qsKey);
-    }
-    makeSendData(prodConf, initial) {
-        return {
-            message: this.makeMessage(prodConf, initial),
-            qsKeyValues: initial
-                ? undefined
-                : new Map([[STAGE_PROD_CONF_MESSAGE_KEY, prodConfToString(prodConf)]]),
-            useHistoryPush: this._useHistoryPush,
-        };
-    }
-}

package/dist/io/CfgIOCameraConfConnector.d.ts

@@ -1,31 +0,0 @@
-import { Observable } from "@configura/web-utilities";
-import { CfgIOManager } from "./CfgIOManager.js";
-export declare type CfgCameraConf = {
-    yaw?: number;
-    pitch?: number;
-};
-export declare type CfgCameraConfMessage = {
-    version: string;
-    initial: boolean;
-} & CfgCameraConf;
-export declare const STAGE_CAMERA_CONF_MESSAGE_KEY = "stagecameraconf";
-export declare const STAGE_CAMERA_MESSAGE_VERSION = "1.0";
-declare type CameraConfMessageCallback = (message: CfgCameraConfMessage) => Promise<void>;
-declare type CameraConfCallback = (conf: CfgCameraConf) => Promise<void>;
-export declare abstract class CfgIOCameraConfConnector<K extends keyof WindowEventMap, S, M extends CfgIOManager<K, S>> {
-    private readonly _ioManager;
-    private readonly _cameraControl;
-    constructor(_ioManager: M, initialCameraConf: CfgCameraConf, _cameraControl: Observable<CfgCameraConf>);
-    private _delayId;
-    protected abstract makeSendData(cameraConf: CfgCameraConf, initial: boolean): S;
-    makeMessage(cameraConf: CfgCameraConf, initial: boolean): CfgCameraConfMessage;
-    makeMessageListener(callback: CameraConfMessageCallback): (message: unknown) => Promise<void>;
-    /**
-     * Register the callback to listen for Product Configuration messages
-     * @returns A function which when called will cancel listening
-     */
-    listenForMessage(callback: CameraConfMessageCallback): () => void;
-    listenForCamera(callback: CameraConfCallback): () => void;
-}
-export {};
-//# sourceMappingURL=CfgIOCameraConfConnector.d.ts.map

package/dist/io/CfgIOCameraConfConnector.js

@@ -1,72 +0,0 @@
-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());
-    });
-};
-// Chrome is not happy if history updates are sent to rapidly.
-// And message receivers probably don't want to get flooded either.
-const THROTTLING_DELAY = 100;
-export const STAGE_CAMERA_CONF_MESSAGE_KEY = "stagecameraconf";
-export const STAGE_CAMERA_MESSAGE_VERSION = "1.0";
-export class CfgIOCameraConfConnector {
-    constructor(_ioManager, initialCameraConf, _cameraControl) {
-        this._ioManager = _ioManager;
-        this._cameraControl = _cameraControl;
-        _ioManager.send(STAGE_CAMERA_CONF_MESSAGE_KEY, this.makeSendData(initialCameraConf, true));
-        this.listenForMessage((message) => __awaiter(this, void 0, void 0, function* () {
-            if (this._delayId !== undefined) {
-                return;
-            }
-            _cameraControl.notifyAll(message, this);
-        }));
-        this.listenForCamera((cameraConf) => __awaiter(this, void 0, void 0, function* () {
-            window.clearTimeout(this._delayId);
-            this._delayId = window.setTimeout(() => {
-                _ioManager.send(STAGE_CAMERA_CONF_MESSAGE_KEY, this.makeSendData(cameraConf, false));
-                this._delayId = undefined;
-            }, THROTTLING_DELAY);
-        }));
-    }
-    makeMessage(cameraConf, initial) {
-        return {
-            version: STAGE_CAMERA_MESSAGE_VERSION,
-            initial,
-            yaw: cameraConf.yaw,
-            pitch: cameraConf.pitch,
-        };
-    }
-    makeMessageListener(callback) {
-        return (message) => __awaiter(this, void 0, void 0, function* () {
-            const cameraConfMessage = message;
-            const version = cameraConfMessage.version;
-            if (version !== "1.0") {
-                console.error(`The a message was passed with an unsupported version "${version}". Currently only ${STAGE_CAMERA_MESSAGE_VERSION} is supported.`);
-                return;
-            }
-            yield callback(cameraConfMessage);
-        });
-    }
-    /**
-     * Register the callback to listen for Product Configuration messages
-     * @returns A function which when called will cancel listening
-     */
-    listenForMessage(callback) {
-        const ioManager = this._ioManager;
-        const listener = this.makeMessageListener(callback);
-        ioManager.listen(listener, STAGE_CAMERA_CONF_MESSAGE_KEY);
-        return () => {
-            ioManager.stopListen(listener);
-        };
-    }
-    listenForCamera(callback) {
-        const cameraControl = this._cameraControl;
-        cameraControl.listen(callback, this);
-        return () => {
-            cameraControl.stopListen(callback);
-        };
-    }
-}

package/dist/io/CfgIOManager.d.ts

@@ -1,29 +0,0 @@
-declare type ConfiguraShebang = "c0nf1guraarug1fn0c";
-declare type Listener = (m: unknown) => Promise<void>;
-export declare type CfgIOContainer = {
-    shebang: ConfiguraShebang;
-    messages: {
-        [index: string]: unknown;
-    };
-};
-export declare abstract class CfgIOManager<K extends keyof WindowEventMap, S> {
-    static isIOContainer: (data: any) => data is CfgIOContainer;
-    static hasIOContainerMessageKey: (container: CfgIOContainer, messageKey: string) => boolean;
-    static getMessageFromIOContainer: (container: any, messageKey: string) => unknown;
-    static makeContainer: (messages: {
-        [index: string]: unknown;
-    }) => CfgIOContainer;
-    private _inhibitSend;
-    private _listeners;
-    private _getIndexOfListener;
-    listen: (l: Listener, messageKey: string) => void;
-    stopListen: (l: Listener) => void;
-    private _containerListenerBound;
-    protected _containerListener(event: WindowEventMap[K]): void;
-    send: (messageKey: string, data: S) => void;
-    protected abstract doSend(messageKey: string, data: S): void;
-    protected abstract readonly eventType: K;
-    protected abstract getDataFromEvent(event: WindowEventMap[K]): unknown;
-}
-export {};
-//# sourceMappingURL=CfgIOManager.d.ts.map

package/dist/io/CfgIOManager.js

@@ -1,89 +0,0 @@
-const CONFIGURA_SHEBANG = "c0nf1guraarug1fn0c";
-export class CfgIOManager {
-    constructor() {
-        // A lock to avoid circular write
-        this._inhibitSend = false;
-        this._listeners = [];
-        this._getIndexOfListener = (l) => this._listeners.findIndex((item) => l === item.l);
-        this.listen = (l, messageKey) => {
-            if (this._getIndexOfListener(l) !== -1) {
-                console.warn("Tried to add listener twice");
-                return;
-            }
-            const startListenToWindow = this._listeners.length === 0;
-            this._listeners.push({ l, messageKey });
-            if (startListenToWindow) {
-                window.addEventListener(this.eventType, this._containerListenerBound);
-            }
-        };
-        this.stopListen = (l) => {
-            const i = this._getIndexOfListener(l);
-            if (i === -1) {
-                console.warn("Tried to stopListen on unknown listener");
-                return;
-            }
-            this._listeners.splice(i, 1);
-            if (this._listeners.length === 0) {
-                window.removeEventListener(this.eventType, this._containerListenerBound);
-            }
-        };
-        this._containerListenerBound = this._containerListener.bind(this);
-        this.send = (messageKey, data) => {
-            if (this._inhibitSend) {
-                return;
-            }
-            this.doSend(messageKey, data);
-        };
-    }
-    _containerListener(event) {
-        const data = this.getDataFromEvent(event);
-        if (!CfgIOManager.isIOContainer(data)) {
-            return;
-        }
-        // 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._listeners;
-        const allMessageKeys = listeners.reduce((a, c) => {
-            a.add(c.messageKey);
-            return a;
-        }, new Set());
-        this._inhibitSend = true;
-        const promises = [];
-        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;
-                }
-                promises.push(item.l(message));
-            }
-        }
-        Promise.all(promises)
-            .then(() => {
-            this._inhibitSend = false;
-        })
-            .catch(() => {
-            this._inhibitSend = false;
-        });
-    }
-}
-CfgIOManager.isIOContainer = (data) => data && data.shebang === 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.`);
-    }
-    // It is assumed that if a message arrives with the right subMessageKey it can cast to T
-    return container.messages[messageKey];
-};
-CfgIOManager.makeContainer = (messages) => ({
-    shebang: CONFIGURA_SHEBANG,
-    messages,
-});

package/dist/io/CfgIOProdConfConnector.d.ts

@@ -1,36 +0,0 @@
-import { AdditionalProductConfiguration } from "../CatalogueAPI.js";
-import { CfgProduct, CfgProductChangeNotification } from "../CfgProduct.js";
-import { CfgIOManager } from "./CfgIOManager.js";
-export declare type CfgProdConfMessage = {
-    version: string;
-    initial: boolean;
-    prodConf: AdditionalProductConfiguration;
-};
-export declare const STAGE_PROD_CONF_MESSAGE_KEY = "stageprodconf";
-export declare const STAGE_PROD_CONF_MESSAGE_VERSION = "1.0";
-declare type ProdConfMessageCallback = (message: CfgProdConfMessage) => Promise<void>;
-declare type ProdConfCallback = (prodConf: AdditionalProductConfiguration) => Promise<void>;
-export declare function prodConfToString(conf: AdditionalProductConfiguration): string;
-export declare function stringToProdConf(conf: string): AdditionalProductConfiguration;
-export declare abstract class CfgIOProdConfConnector<K extends keyof WindowEventMap, S, M extends CfgIOManager<K, S>> {
-    private readonly _ioManager;
-    private readonly _doValidate;
-    protected _product: CfgProduct | undefined;
-    private _stopListenToMessage;
-    private _stopListenToProdConf;
-    constructor(_ioManager: M, _doValidate: boolean);
-    setProduct: (product: CfgProduct | undefined) => Promise<void>;
-    protected abstract getInitialProdConf(): string | undefined;
-    protected abstract makeSendData(prodConf: AdditionalProductConfiguration, initial: boolean): S;
-    makeMessage(prodConf: AdditionalProductConfiguration, initial: boolean): CfgProdConfMessage;
-    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
-     */
-    listenForMessage(callback: ProdConfMessageCallback): () => void;
-    makeProdConfListener(callback: ProdConfCallback): (n: CfgProductChangeNotification) => void;
-    listenForProdConf(product: CfgProduct, callback: ProdConfCallback): () => void;
-}
-export {};
-//# sourceMappingURL=CfgIOProdConfConnector.d.ts.map

package/dist/io/CfgIOProdConfConnector.js

@@ -1,102 +0,0 @@
-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());
-    });
-};
-export const STAGE_PROD_CONF_MESSAGE_KEY = "stageprodconf";
-export const STAGE_PROD_CONF_MESSAGE_VERSION = "1.0";
-export function prodConfToString(conf) {
-    return JSON.stringify(conf, undefined, "");
-}
-export function stringToProdConf(conf) {
-    return JSON.parse(conf);
-}
-export class CfgIOProdConfConnector {
-    constructor(_ioManager, _doValidate) {
-        this._ioManager = _ioManager;
-        this._doValidate = _doValidate;
-        this._stopListenToMessage = undefined;
-        this._stopListenToProdConf = undefined;
-        this.setProduct = (product) => __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            const currentProduct = this._product;
-            const newProduct = product;
-            this._product = newProduct;
-            // If same product don't do anything at all
-            if (currentProduct !== undefined &&
-                newProduct !== undefined &&
-                currentProduct.isBackedBySame(newProduct)) {
-                return;
-            }
-            if (currentProduct !== undefined) {
-                (_a = this._stopListenToMessage) === null || _a === void 0 ? void 0 : _a.call(this);
-                (_b = this._stopListenToProdConf) === null || _b === void 0 ? void 0 : _b.call(this);
-            }
-            if (newProduct === undefined) {
-                return;
-            }
-            if (currentProduct === undefined) {
-                const initialProdConf = this.getInitialProdConf();
-                if (initialProdConf !== undefined) {
-                    yield newProduct.setApiSelection(stringToProdConf(initialProdConf), this._doValidate);
-                }
-            }
-            this._ioManager.send(STAGE_PROD_CONF_MESSAGE_KEY, this.makeSendData(newProduct.getApiSelection(), true));
-            this._stopListenToMessage = this.listenForMessage((message) => __awaiter(this, void 0, void 0, function* () {
-                yield newProduct.setApiSelection(message.prodConf, this._doValidate);
-            }));
-            this._stopListenToProdConf = this.listenForProdConf(newProduct, (prodConf) => __awaiter(this, void 0, void 0, function* () {
-                this._ioManager.send(STAGE_PROD_CONF_MESSAGE_KEY, this.makeSendData(prodConf, false));
-            }));
-        });
-    }
-    makeMessage(prodConf, initial) {
-        return {
-            version: STAGE_PROD_CONF_MESSAGE_VERSION,
-            initial,
-            prodConf,
-        };
-    }
-    makeMessageListener(callback) {
-        return (message) => __awaiter(this, void 0, void 0, function* () {
-            const prodConfMessage = message;
-            const version = prodConfMessage.version;
-            if (version !== "1.0") {
-                console.error(`The a message was passed with an unsupported version "${version}". Currently only ${STAGE_PROD_CONF_MESSAGE_VERSION} is supported.`);
-                return;
-            }
-            yield callback(prodConfMessage);
-        });
-    }
-    /**
-     * Register the callback to listen for Product Configuration messages
-     * @returns A function which when called will cancel listening
-     */
-    listenForMessage(callback) {
-        const ioManager = this._ioManager;
-        const listener = this.makeMessageListener(callback);
-        ioManager.listen(listener, STAGE_PROD_CONF_MESSAGE_KEY);
-        return () => {
-            ioManager.stopListen(listener);
-        };
-    }
-    makeProdConfListener(callback) {
-        return (n) => {
-            if (!n.committed) {
-                return;
-            }
-            callback(n.freshRef.getApiSelection());
-        };
-    }
-    listenForProdConf(product, callback) {
-        const listener = this.makeProdConfListener(callback);
-        product.listenForChange(listener);
-        return () => {
-            product.stopListenForChange(listener);
-        };
-    }
-}

package/dist/io/CfgWindowMessageManager.d.ts

@@ -1,13 +0,0 @@
-import { CfgIOManager } from "./CfgIOManager.js";
-export declare type CfgWindowMessageManagerSendData = unknown;
-export declare class CfgWindowMessageManager extends CfgIOManager<"message", CfgWindowMessageManagerSendData> {
-    private readonly _remoteEnds;
-    private readonly _targetOrigin;
-    private readonly _acceptableMessageOrigin?;
-    constructor(_remoteEnds: Window[], _targetOrigin?: string, _acceptableMessageOrigin?: string | undefined);
-    protected doSend(messageKey: string, data: unknown): void;
-    protected _containerListener(event: MessageEvent<any>): void;
-    protected readonly eventType = "message";
-    protected getDataFromEvent(event: MessageEvent<any>): unknown;
-}
-//# sourceMappingURL=CfgWindowMessageManager.d.ts.map

package/dist/io/CfgWindowMessageManager.js

@@ -1,33 +0,0 @@
-import { CfgIOManager } from "./CfgIOManager.js";
-export class CfgWindowMessageManager extends CfgIOManager {
-    constructor(_remoteEnds, _targetOrigin = "*", _acceptableMessageOrigin) {
-        super();
-        this._remoteEnds = _remoteEnds;
-        this._targetOrigin = _targetOrigin;
-        this._acceptableMessageOrigin = _acceptableMessageOrigin;
-        this.eventType = "message";
-        for (const remote of _remoteEnds) {
-            if (remote === window) {
-                console.warn("You are providing your own window as a remote end.");
-            }
-        }
-    }
-    doSend(messageKey, data) {
-        const container = CfgIOManager.makeContainer({
-            [messageKey]: data,
-        });
-        for (const remoteEnd of this._remoteEnds) {
-            remoteEnd.postMessage(container, this._targetOrigin);
-        }
-    }
-    _containerListener(event) {
-        if (this._acceptableMessageOrigin !== undefined &&
-            event.origin !== this._acceptableMessageOrigin) {
-            return;
-        }
-        super._containerListener(event);
-    }
-    getDataFromEvent(event) {
-        return event.data;
-    }
-}

package/dist/io/CfgWindowMessageToCameraConfConnector.d.ts

@@ -1,6 +0,0 @@
-import { CfgCameraConf, CfgIOCameraConfConnector } from "./CfgIOCameraConfConnector.js";
-import { CfgWindowMessageManager, CfgWindowMessageManagerSendData } from "./CfgWindowMessageManager.js";
-export declare class CfgWindowMessageToCameraConfConnector extends CfgIOCameraConfConnector<"message", CfgWindowMessageManagerSendData, CfgWindowMessageManager> {
-    protected makeSendData(cameraConf: CfgCameraConf, initial: boolean): CfgWindowMessageManagerSendData;
-}
-//# sourceMappingURL=CfgWindowMessageToCameraConfConnector.d.ts.map

package/dist/io/CfgWindowMessageToCameraConfConnector.js

@@ -1,6 +0,0 @@
-import { CfgIOCameraConfConnector } from "./CfgIOCameraConfConnector.js";
-export class CfgWindowMessageToCameraConfConnector extends CfgIOCameraConfConnector {
-    makeSendData(cameraConf, initial) {
-        return this.makeMessage(cameraConf, initial);
-    }
-}

package/dist/io/CfgWindowMessageToProdConfConnector.d.ts

@@ -1,14 +0,0 @@
-import { AdditionalProductConfiguration } from "../CatalogueAPI.js";
-import { CfgIOProdConfConnector } from "./CfgIOProdConfConnector.js";
-import { CfgWindowMessageManager, CfgWindowMessageManagerSendData } from "./CfgWindowMessageManager.js";
-/**
- * Instantiating the class will expose your product to:
- * - Listen for configuration changes posted to this window
- * - Send configuration changes using sendMessage
- */
-export declare class CfgWindowMessageToProdConfConnector extends CfgIOProdConfConnector<"message", CfgWindowMessageManagerSendData, CfgWindowMessageManager> {
-    constructor(manager: CfgWindowMessageManager, doValidate?: boolean);
-    protected getInitialProdConf(): string | undefined;
-    protected makeSendData(prodConf: AdditionalProductConfiguration, initial: boolean): CfgWindowMessageManagerSendData;
-}
-//# sourceMappingURL=CfgWindowMessageToProdConfConnector.d.ts.map

package/dist/io/CfgWindowMessageToProdConfConnector.js

@@ -1,17 +0,0 @@
-import { CfgIOProdConfConnector } from "./CfgIOProdConfConnector.js";
-/**
- * Instantiating the class will expose your product to:
- * - Listen for configuration changes posted to this window
- * - Send configuration changes using sendMessage
- */
-export class CfgWindowMessageToProdConfConnector extends CfgIOProdConfConnector {
-    constructor(manager, doValidate = true) {
-        super(manager, doValidate);
-    }
-    getInitialProdConf() {
-        return undefined;
-    }
-    makeSendData(prodConf, initial) {
-        return this.makeMessage(prodConf, initial);
-    }
-}