@openremote/core 1.0.3 → 1.2.0-snapshot.20240512160221

package/dist/console.js

@@ -1,452 +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());
-    });
-};
-import manager from "./index";
-// No ES6 module support in platform lib
-let platform = require('platform');
-export class Console {
-    constructor(realm, autoEnable, enableComplete) {
-        this._autoEnable = false;
-        this._initialised = false;
-        this._initialiseInProgress = false;
-        this._pendingProviderPromises = {};
-        this._pendingProviderEnables = [];
-        this._registrationTimer = null;
-        this._realm = realm;
-        this._autoEnable = autoEnable;
-        this._enableCompleteCallback = enableComplete;
-        // Export this to the window to make it accessible from mobile webview code
-        // @ts-ignore
-        window.OpenRemoteConsole = this;
-        // Check for query parameters to override values
-        let queryParams = new URLSearchParams(window.location.search);
-        let consoleName = queryParams.get("consoleName");
-        let consoleVersion = queryParams.get("consoleVersion");
-        let consolePlatform = queryParams.get("consolePlatform");
-        let consoleProviders = queryParams.get("consoleProviders");
-        let autoEnableStr = queryParams.get("consoleAutoEnable");
-        let requestedProviders = consoleProviders && consoleProviders.length > 0 ? consoleProviders.split(" ") : ["push", "storage"];
-        if (requestedProviders.indexOf("storage") < 0) {
-            requestedProviders.push("storage"); // Storage provider is essential to operation and should always be available
-        }
-        this._pendingProviderEnables = consoleProviders && consoleProviders.length > 0 ? consoleProviders.split(" ") : [];
-        // Look for existing console registration in local storage or just create a new one
-        let consoleReg = Console._createConsoleRegistration();
-        let consoleRegStr = window.localStorage.getItem("OpenRemoteConsole:" + realm);
-        if (consoleRegStr) {
-            try {
-                let storedRegObj = JSON.parse(consoleRegStr);
-                let storedReg = storedRegObj;
-                if (storedReg.id) {
-                    consoleReg.id = storedReg.id;
-                }
-                if (storedReg.name) {
-                    consoleReg.name = storedReg.name;
-                }
-                if (storedReg.providers) {
-                    consoleReg.providers = storedReg.providers;
-                }
-                if (storedReg.apps) {
-                    consoleReg.apps = storedReg.apps;
-                }
-            }
-            catch (e) {
-                console.error("Failed to deserialise console registration");
-            }
-        }
-        let oldProviders = consoleReg.providers;
-        consoleReg.providers = {};
-        for (let providerName of requestedProviders) {
-            let provider = oldProviders && oldProviders.hasOwnProperty(providerName) ? oldProviders[providerName] : {
-                enabled: false,
-                disabled: false
-            };
-            consoleReg.providers[providerName] = provider;
-        }
-        let appName = manager.getAppName();
-        if (appName.length > 0 && consoleReg.apps.indexOf(appName) < 0) {
-            consoleReg.apps.push(appName);
-        }
-        this._registration = consoleReg;
-        if (consoleName) {
-            consoleReg.name = consoleName;
-        }
-        if (consoleVersion) {
-            consoleReg.version = consoleVersion;
-        }
-        if (consolePlatform) {
-            consoleReg.platform = consolePlatform;
-        }
-        if (autoEnableStr) {
-            this._autoEnable = autoEnableStr === "TRUE" || autoEnableStr === "true";
-        }
-    }
-    get registration() {
-        return this._registration;
-    }
-    get autoEnable() {
-        return this._autoEnable;
-    }
-    get pendingProviderEnables() {
-        return this._pendingProviderEnables.slice(0);
-    }
-    get shellApple() {
-        // @ts-ignore
-        return navigator.platform.substr(0, 2) === 'iP' && window.webkit && window.webkit.messageHandlers;
-    }
-    get shellAndroid() {
-        // @ts-ignore
-        return !!window.MobileInterface;
-    }
-    get isMobile() {
-        return this.shellApple || this.shellAndroid;
-    }
-    initialise() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this._initialised || this._initialiseInProgress) {
-                return;
-            }
-            console.debug("Console: initialising");
-            this._initialiseInProgress = true;
-            try {
-                if (this._registration.providers) {
-                    for (let providerName of Object.keys(this._registration.providers)) {
-                        yield this._initialiseProvider(providerName);
-                    }
-                }
-                // Get an ID for this console if it doesn't have one
-                if (!this._registration.id) {
-                    yield this.sendRegistration(0);
-                }
-                this._initialised = true;
-                this._initialiseInProgress = false;
-                if (this._pendingProviderEnables.length === 0) {
-                    yield this.sendRegistration();
-                    this._callCompletedCallback();
-                }
-                else if (this._autoEnable) {
-                    yield this.enableProviders();
-                }
-            }
-            catch (e) {
-                console.error(e);
-            }
-            finally {
-                this._initialiseInProgress = false;
-            }
-        });
-    }
-    // This mechanism doesn't support sending extra data to the providers being enabled and it doesn't allow data
-    // to be retrieved from the replies; if that is required then providers should be manually enabled from the calling app
-    enableProviders() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this._initialised) {
-                throw new Error("Console must be initialised before enabling providers");
-            }
-            for (let index = this._pendingProviderEnables.length - 1; index > -1; index--) {
-                let providerName = this._pendingProviderEnables[index];
-                yield this.enableProvider(providerName);
-            }
-        });
-    }
-    enableProvider(providerName, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this._initialised) {
-                console.debug("Console must be initialised before disabling providers");
-                throw new Error("Console must be initialised before enabling providers");
-            }
-            if (!this._registration.providers.hasOwnProperty(providerName)) {
-                console.debug("Invalid console provider '" + providerName + "'");
-                throw new Error("Invalid console provider '" + providerName + "'");
-            }
-            console.debug("Console: enabling provider '" + providerName + "'");
-            let msg = {
-                provider: providerName,
-                action: "PROVIDER_ENABLE",
-                consoleId: this._registration.id,
-                data
-            };
-            let response = yield this.sendProviderMessage(msg, true);
-            this._registration.providers[providerName].hasPermission = response.hasPermission;
-            this._registration.providers[providerName].success = response.success;
-            this._registration.providers[providerName].enabled = response.success;
-            this._registration.providers[providerName].data = response.data;
-            let index = this._pendingProviderEnables.indexOf(providerName);
-            if (index >= 0) {
-                this._pendingProviderEnables.splice(index, 1);
-                if (this._pendingProviderEnables.length === 0) {
-                    this.sendRegistration();
-                    this._callCompletedCallback();
-                }
-            }
-            return response;
-        });
-    }
-    disableProvider(provider) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this._initialised) {
-                console.debug("Console must be initialised before disabling providers");
-                throw new Error("Console must be initialised before disabling providers");
-            }
-            if (!this._registration.providers.hasOwnProperty(provider)) {
-                console.debug("Invalid console provider '" + provider + "'");
-                throw new Error("Invalid console provider '" + provider + "'");
-            }
-            console.debug("Console: disabling provider '" + provider + "'");
-            let response = yield this.sendProviderMessage({
-                provider: provider,
-                action: "PROVIDER_DISABLE"
-            }, true);
-            this._registration.providers[provider].disabled = true;
-            this._registration.providers[provider].enabled = false;
-            return response;
-        });
-    }
-    sendProviderMessage(message, waitForResponse) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this._registration.providers.hasOwnProperty(message.provider)) {
-                console.debug("Invalid console provider '" + message.provider + "'");
-                throw new Error("Invalid console provider '" + message.provider + "'");
-            }
-            if (!waitForResponse) {
-                this._doSendProviderMessage(message);
-                return;
-            }
-            let promiseName = message.provider + message.action;
-            if (this._pendingProviderPromises[promiseName]) {
-                throw new Error("Message already pending for provider '" + name + "' with action '" + message.action + "'");
-            }
-            return yield new Promise(resolve => {
-                this._pendingProviderPromises[promiseName] = resolve;
-                this._doSendProviderMessage(message);
-            });
-        });
-    }
-    // Uses a delayed mechanism to avoid excessive calls to the server during enabling providers
-    sendRegistration(delay) {
-        if (this._registrationTimer) {
-            window.clearTimeout(this._registrationTimer);
-            this._registrationTimer = null;
-        }
-        delay = delay !== undefined ? delay : 2000;
-        console.debug("Sending registration in: " + delay + "ms");
-        return new Promise((resolve, reject) => {
-            this._registrationTimer = window.setTimeout(() => {
-                this._registrationTimer = null;
-                console.debug("Console: updating registration");
-                try {
-                    manager.rest.api.ConsoleResource.register(this._registration).then((response) => {
-                        if (response.status !== 200) {
-                            throw new Error("Failed to register console");
-                        }
-                        this._registration = response.data;
-                        console.debug("Console: registration successful");
-                        console.debug("Console: updating locally stored registration");
-                        window.localStorage.setItem("OpenRemoteConsole:" + this._realm, JSON.stringify(this._registration));
-                        resolve();
-                    });
-                }
-                catch (e) {
-                    console.error("Failed to register console");
-                    reject("Failed to register console");
-                }
-            });
-        });
-    }
-    storeData(key, value) {
-        this.sendProviderMessage({
-            provider: "storage",
-            action: "STORE",
-            key: key,
-            value: value
-        }, false);
-    }
-    retrieveData(key) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let response = yield this.sendProviderMessage({
-                provider: "storage",
-                action: "RETRIEVE",
-                key: key
-            }, true);
-            if (response && response.value) {
-                return response.value;
-            }
-        });
-    }
-    _postNativeShellMessage(jsonMessage) {
-        if (this.shellAndroid) {
-            // @ts-ignore
-            return window.MobileInterface.postMessage(JSON.stringify(jsonMessage));
-        }
-        if (this.shellApple) {
-            // @ts-ignore
-            return window.webkit.messageHandlers.int.postMessage(jsonMessage);
-        }
-    }
-    _doSendProviderMessage(msg) {
-        if (this.isMobile) {
-            this._postNativeShellMessage({ type: "provider", data: msg });
-        }
-        else {
-            if (!msg.provider || !msg.action) {
-                return;
-            }
-            switch (msg.provider.trim().toUpperCase()) {
-                // TODO: Implement web browser provider handling (web push etc.)
-                case "PUSH":
-                    switch (msg.action.trim().toUpperCase()) {
-                        case "PROVIDER_INIT":
-                            let initResponse = {
-                                action: "PROVIDER_INIT",
-                                provider: "push",
-                                version: "web",
-                                enabled: true,
-                                disabled: false,
-                                hasPermission: true,
-                                requiresPermission: false,
-                                success: true
-                            };
-                            this._handleProviderResponse(JSON.stringify(initResponse));
-                            break;
-                        case "PROVIDER_ENABLE":
-                            let enableResponse = {
-                                action: "PROVIDER_ENABLE",
-                                provider: "push",
-                                hasPermission: true,
-                                success: true
-                            };
-                            this._handleProviderResponse(JSON.stringify(enableResponse));
-                            break;
-                        default:
-                            throw new Error("Unsupported provider '" + msg.provider + "' and action '" + msg.action + "'");
-                    }
-                    break;
-                case "STORAGE":
-                    switch (msg.action) {
-                        case "PROVIDER_INIT":
-                            let initResponse = {
-                                action: "PROVIDER_INIT",
-                                provider: "storage",
-                                version: "1.0.0",
-                                disabled: false,
-                                enabled: true,
-                                hasPermission: true,
-                                requiresPermission: false,
-                                success: true
-                            };
-                            this._handleProviderResponse(JSON.stringify(initResponse));
-                            break;
-                        case "PROVIDER_ENABLE":
-                            let enableResponse = {
-                                action: "PROVIDER_ENABLE",
-                                provider: "storage",
-                                hasPermission: true,
-                                success: true
-                            };
-                            this._handleProviderResponse(JSON.stringify(enableResponse));
-                            break;
-                        case "STORE":
-                            {
-                                let keyValue = msg.key ? msg.key.trim() : null;
-                                if (!keyValue || keyValue.length === 0) {
-                                    throw new Error("Storage provider 'store' action requires a `key`");
-                                }
-                                if (msg.value) {
-                                    if (msg.value === null) {
-                                        window.localStorage.removeItem(keyValue);
-                                    }
-                                    else {
-                                        window.localStorage.setItem(keyValue, msg.value);
-                                    }
-                                }
-                            }
-                            break;
-                        case "RETRIEVE":
-                            {
-                                let keyValue = msg.key ? msg.key.trim() : null;
-                                if (!keyValue || keyValue.length === 0) {
-                                    throw new Error("Storage provider 'retrieve' action requires a `key`");
-                                }
-                                this._handleProviderResponse(JSON.stringify({
-                                    action: "RETRIEVE",
-                                    provider: "storage",
-                                    key: keyValue,
-                                    value: window.localStorage.getItem(keyValue)
-                                }));
-                            }
-                            break;
-                        default:
-                            throw new Error("Unsupported provider '" + msg.provider + "' and action '" + msg.action + "'");
-                    }
-                    break;
-            }
-        }
-    }
-    // This is called by native web view code
-    _handleProviderResponse(msg) {
-        if (!msg) {
-            return;
-        }
-        let msgJson = JSON.parse(msg);
-        let name = msgJson.provider;
-        let action = msgJson.action;
-        let resolve = this._pendingProviderPromises[name + action];
-        if (resolve != null) {
-            this._pendingProviderPromises[name + action] = null;
-            resolve(msgJson);
-        }
-    }
-    _callCompletedCallback() {
-        let callback = this._enableCompleteCallback;
-        this._enableCompleteCallback = null;
-        if (callback) {
-            window.setTimeout(() => {
-                callback();
-            }, 0);
-        }
-    }
-    static _createConsoleRegistration() {
-        let reg = {
-            name: platform.name,
-            version: platform.version,
-            platform: platform.os.toString(),
-            apps: [],
-            model: ((platform.manufacturer ? platform.manufacturer + " " : "") + (platform.product ? platform.product : "")).trim()
-        };
-        return reg;
-    }
-    _initialiseProvider(providerName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            console.debug("Console: initialising provider '" + providerName + "'");
-            let initResponse = yield this.sendProviderMessage({
-                provider: providerName,
-                action: "PROVIDER_INIT"
-            }, true);
-            this._registration.providers[providerName].version = initResponse.version;
-            this._registration.providers[providerName].requiresPermission = initResponse.requiresPermission;
-            this._registration.providers[providerName].hasPermission = initResponse.hasPermission;
-            this._registration.providers[providerName].success = initResponse.success;
-            this._registration.providers[providerName].enabled = initResponse.enabled;
-            this._registration.providers[providerName].disabled = initResponse.disabled;
-            this._registration.providers[providerName].data = initResponse.data;
-            if (!initResponse.success) {
-                console.debug("Provider initialisation failed: '" + providerName + "'");
-                initResponse.disabled = true;
-                this._registration.providers[providerName].disabled = true;
-            }
-            if (initResponse.disabled || initResponse.enabled) {
-                let index = this._pendingProviderEnables.indexOf(providerName);
-                if (index >= 0) {
-                    this._pendingProviderEnables.splice(index, 1);
-                }
-            }
-        });
-    }
-}
-//# sourceMappingURL=console.js.map

package/dist/defaults.js

@@ -1,16 +0,0 @@
-export const DefaultColor4 = "#1b5630"; // Primary
-export const DefaultColor7 = "#FFF"; // Secondary
-export const DefaultColor1 = "#FFF"; // Surface
-export const DefaultColor2 = "#F9F9F9"; // Background
-export const DefaultColor5 = "#CCC"; // Borders and lines
-export const DefaultColor6 = "#be0000"; // Invalid/Error
-export const DefaultColor8 = "#FFF"; // On Primary
-export const DefaultColor3 = "#4c4c4c"; // Text / On Secondary
-export const DefaultColor9 = "#000"; // On Background
-export const DefaultColor10 = "#000"; // On Surface
-export const DefaultColor11 = "#FFF"; // On Error
-export const DefaultBoxShadowBottom = "0 5px 5px -5px rgba(0,0,0,0.3)";
-export const DefaultBoxShadow = "0 1px 3px 0 rgba(0,0,0,0.21)";
-export const DefaultHeaderHeight = "50px";
-export const DefaultDisabledOpacity = "0.3";
-//# sourceMappingURL=defaults.js.map