@vention/machine-logic-ui-sdk 0.27.7 → 0.28.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vention/machine-logic-ui-sdk",
-  "version": "0.27.7",
+  "version": "0.28.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/VentionCo/machine-cloud.git"
@@ -23,5 +23,5 @@
   "module": "./index.esm.js",
   "type": "module",
   "main": "./index.esm.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

package/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./lib/components/virtual-keyboard/virtual-keyboard";
+export * from "./lib/utils/machine-logic-ui-sdk-utils";
+export * from "./lib/mqtt-browser/mqtt-client";
+export * from "./lib/mqtt/mqtt-context";
+export * from "./lib/mqtt/use-mqtt-subscription";
+export * from "./lib/mqtt/generic-mqtt-mapping";

package/src/lib/components/virtual-keyboard/keyboard-layouts.d.ts

@@ -0,0 +1,42 @@
+import { KeyboardLayoutObject } from "react-simple-keyboard";
+export declare enum KeyboardLayoutName {
+    DEFAULT = "default",
+    SHIFT = "shift"
+}
+export declare enum KeyboardKey {
+    SHIFT = "{shift}",
+    CAPS_LOCK = "{lock}",
+    BACKSPACE = "{bksp}",
+    ENTER = "{enter}",
+    SUBMIT = "{submit}",
+    TAB = "{tab}",
+    SPACE = "{space}"
+}
+export declare const KeyboardLayout: {
+    readonly TEXT: KeyboardLayoutObject;
+    readonly NUMERIC: KeyboardLayoutObject;
+};
+export declare const KeyboardDisplay: {
+    readonly "{shift}": "shift ⇧";
+    readonly "{lock}": "caps lock ⇪";
+    readonly "{bksp}": "backspace ⌫";
+    readonly "{enter}": "enter ↵";
+    readonly "{submit}": "submit ✓";
+    readonly "{tab}": "tab ⇥";
+    readonly "{space}": "space";
+};
+export declare const KeyboardLayoutsByInputType: {
+    readonly tel: KeyboardLayoutObject;
+    readonly date: KeyboardLayoutObject;
+    readonly week: KeyboardLayoutObject;
+    readonly text: KeyboardLayoutObject;
+    readonly password: KeyboardLayoutObject;
+    readonly "datetime-local": KeyboardLayoutObject;
+    readonly month: KeyboardLayoutObject;
+    readonly time: KeyboardLayoutObject;
+    readonly email: KeyboardLayoutObject;
+    readonly search: KeyboardLayoutObject;
+    readonly url: KeyboardLayoutObject;
+    readonly textarea: KeyboardLayoutObject;
+};
+export type InputType = keyof typeof KeyboardLayoutsByInputType;

package/src/lib/components/virtual-keyboard/virtual-keyboard.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import "react-simple-keyboard/build/css/index.css";
+export declare const VirtualKeyboard: () => JSX.Element | null;
+export declare const useStyles: import("tss-react").Tss.UseStyles<{
+    theme: import("@mui/material").Theme;
+}, Record<never, unknown>, "virtualKeyboard", import("tss-react/mui").MuiThemeStyleOverridesPluginParams>;

package/src/lib/mqtt/generic-mqtt-mapping.d.ts

@@ -0,0 +1 @@
+export type MqttPayloadByTopic<TMapping extends Record<string, unknown>, T extends keyof TMapping> = TMapping[T];

package/src/lib/mqtt/mqtt-context.d.ts

@@ -0,0 +1,16 @@
+import { MutableRefObject, ReactNode } from "react";
+import { MqttClient } from "mqtt";
+interface MqttContext {
+    client: MqttClient | null;
+    connectionStatus: "connected" | "disconnected" | "error";
+    subscribedTopics: MutableRefObject<Set<string>> | null;
+    addSubscribedTopic: (topic: string) => void;
+    removeSubscribedTopic: (topic: string) => void;
+}
+export declare const mqttContext: import("react").Context<MqttContext>;
+interface Props {
+    children: ReactNode;
+    version?: "v2" | "v3";
+}
+export declare const MqttProvider: (props: Props) => import("react/jsx-runtime").JSX.Element;
+export {};

package/src/lib/mqtt/use-mqtt-subscription.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    topic: string;
+    unsubscribeOnUnmount?: boolean;
+}
+export declare const useMqttSubscription: <TMessage>(props: Props) => TMessage;
+export {};

package/src/lib/mqtt-browser/mqtt-client.d.ts

@@ -0,0 +1,12 @@
+export interface Callback {
+    (topic: string, message: string): void;
+}
+export declare class MqttClient {
+    private mqttClient?;
+    private subscriptions;
+    constructor(url: string, connectCallback?: () => void);
+    connect(url: string, connectCallback?: () => void): void;
+    subscribe(topic: string, regex: RegExp, cb: Callback): void;
+    unsubscribe(topic: string, regex: RegExp, cb: Callback): void;
+    publish(topic: string, message: string, retain?: boolean): void;
+}

package/src/lib/utils/machine-logic-ui-sdk-utils.d.ts

@@ -0,0 +1,10 @@
+import { MqttClient } from "../mqtt-browser/mqtt-client";
+export declare const isTouchScreenDevice: () => boolean;
+export declare const isOnEdge: () => boolean;
+export declare const getExecutionEngineHttpUrl: () => string;
+export declare const getMqttWsUrl: (version?: "v2" | "v3") => Promise<string>;
+export declare const connectToMqttAndGetClient: () => Promise<MqttClient>;
+export declare const getMachineCodeProcessHttpUrl: (processName: string) => string;
+export declare const getMqttWsUrlGivenUiIframeUrl: (uiIframeUrl: string) => string;
+export declare const closeCustomUi: () => void;
+export declare const navigateControlCenter: (route: "remoteSupport" | "controlCenterHomepage") => void;

package/index.esm.css

@@ -1,22 +0,0 @@
-/*!
- * 
- *   react-simple-keyboard v3.8.196
- *   https://github.com/hodgef/react-simple-keyboard
- *
- *   Copyright (c) Francisco Hodge (https://github.com/hodgef) and project contributors.
- *
- *   This source code is licensed under the MIT license found in the
- *   LICENSE file in the root directory of this source tree.
- *
- */
-/*!
- * 
- *   simple-keyboard v3.8.134
- *   https://github.com/hodgef/simple-keyboard
- *
- *   Copyright (c) Francisco Hodge (https://github.com/hodgef) and project contributors.
- *
- *   This source code is licensed under the MIT license found in the
- *   LICENSE file in the root directory of this source tree.
- *
- */.hg-theme-default{background-color:#ececec;border-radius:5px;box-sizing:border-box;font-family:HelveticaNeue-Light,Helvetica Neue Light,Helvetica Neue,Helvetica,Arial,Lucida Grande,sans-serif;overflow:hidden;padding:5px;touch-action:manipulation;-webkit-user-select:none;-moz-user-select:none;user-select:none;width:100%}.hg-theme-default .hg-button span,.hg-theme-default .hg-button span svg{pointer-events:none}.hg-theme-default button.hg-button{border-width:0;font-size:inherit}.hg-theme-default .hg-button{display:inline-block;flex-grow:1}.hg-theme-default .hg-row{display:flex}.hg-theme-default .hg-row:not(:last-child){margin-bottom:5px}.hg-theme-default .hg-row .hg-button-container,.hg-theme-default .hg-row .hg-button:not(:last-child){margin-right:5px}.hg-theme-default .hg-row>div:last-child{margin-right:0}.hg-theme-default .hg-row .hg-button-container{display:flex}.hg-theme-default .hg-button{align-items:center;background:#fff;border-bottom:1px solid #b5b5b5;border-radius:5px;box-shadow:0 0 3px -1px rgba(0,0,0,.3);box-sizing:border-box;cursor:pointer;display:flex;height:40px;justify-content:center;padding:5px;-webkit-tap-highlight-color:rgba(0,0,0,0)}.hg-theme-default .hg-button.hg-standardBtn{width:20px}.hg-theme-default .hg-button.hg-activeButton{background:#efefef}.hg-theme-default.hg-layout-numeric .hg-button{align-items:center;display:flex;height:60px;justify-content:center;width:33.3%}.hg-theme-default .hg-button.hg-button-numpadadd,.hg-theme-default .hg-button.hg-button-numpadenter{height:85px}.hg-theme-default .hg-button.hg-button-numpad0{width:105px}.hg-theme-default .hg-button.hg-button-com{max-width:85px}.hg-theme-default .hg-button.hg-standardBtn.hg-button-at{max-width:45px}.hg-theme-default .hg-button.hg-selectedButton{background:rgba(5,25,70,.53);color:#fff}.hg-theme-default .hg-button.hg-standardBtn[data-skbtn=".com"]{max-width:82px}.hg-theme-default .hg-button.hg-standardBtn[data-skbtn="@"]{max-width:60px}.hg-candidate-box{background:#ececec;border-bottom:2px solid #b5b5b5;border-radius:5px;display:inline-flex;margin-top:-10px;position:absolute;transform:translateY(-100%);-webkit-user-select:none;-moz-user-select:none;user-select:none}ul.hg-candidate-box-list{display:flex;flex:1;list-style:none;margin:0;padding:0}li.hg-candidate-box-list-item{align-items:center;display:flex;height:40px;justify-content:center;width:40px}li.hg-candidate-box-list-item:hover{background:rgba(0,0,0,.03);cursor:pointer}li.hg-candidate-box-list-item:active{background:rgba(0,0,0,.1)}.hg-candidate-box-prev:before{content:"◄"}.hg-candidate-box-next:before{content:"►"}.hg-candidate-box-next,.hg-candidate-box-prev{align-items:center;color:#969696;cursor:pointer;display:flex;padding:0 10px}.hg-candidate-box-next{border-bottom-right-radius:5px;border-top-right-radius:5px}.hg-candidate-box-prev{border-bottom-left-radius:5px;border-top-left-radius:5px}.hg-candidate-box-btn-active{color:#444}