@vention/machine-logic-ui-sdk 0.46.1 → 0.47.1

package/index.esm.js

@@ -3115,7 +3115,7 @@ var Headers = safeGetBuiltIn('Headers');
 var RequestPrototype = NativeRequest && NativeRequest.prototype;
 var HeadersPrototype = Headers && Headers.prototype;
 var TypeError$2 = globalThis$5.TypeError;
-var encodeURIComponent$1 = globalThis$5.encodeURIComponent;
+var encodeURIComponent$2 = globalThis$5.encodeURIComponent;
 var fromCharCode$2 = String.fromCharCode;
 var fromCodePoint = getBuiltIn$3('String', 'fromCodePoint');
 var $parseInt$1 = parseInt;
@@ -3280,7 +3280,7 @@ var replacer = function (match) {
 };
 
 var serialize = function (it) {
-  return replace$2(encodeURIComponent$1(it), find, replacer);
+  return replace$2(encodeURIComponent$2(it), find, replacer);
 };
 
 var URLSearchParamsIterator = createIteratorConstructor(function Iterator(params, kind) {
@@ -4744,7 +4744,7 @@ var getInternalSearchParamsState = URLSearchParamsModule.getState;
 
 var NativeURL = globalThis$2.URL;
 var TypeError$1 = globalThis$2.TypeError;
-var encodeURIComponent = globalThis$2.encodeURIComponent;
+var encodeURIComponent$1 = globalThis$2.encodeURIComponent;
 var parseInt$1 = globalThis$2.parseInt;
 var floor = Math.floor;
 var pow = Math.pow;
@@ -4994,7 +4994,7 @@ var userinfoPercentEncodeSet = assign({}, pathPercentEncodeSet, {
 var percentEncode = function (chr, set) {
   var code = codeAt(chr, 0);
   // encodeURIComponent does not encode ', which is in the special-query percent-encode set
-  return code >= 0x20 && code < 0x7F && !hasOwn$2(set, chr) ? chr : chr === "'" && hasOwn$2(set, chr) ? '%27' : encodeURIComponent(chr);
+  return code >= 0x20 && code < 0x7F && !hasOwn$2(set, chr) ? chr : chr === "'" && hasOwn$2(set, chr) ? '%27' : encodeURIComponent$1(chr);
 };
 
 // https://url.spec.whatwg.org/#special-scheme
@@ -5816,7 +5816,7 @@ const getMqttWsUrlGivenMqttPath = (host, mqttPath) => {
   return url.toString();
 };
 
-var _a;
+var _a$1;
 const isTouchScreenDevice = () => "ontouchstart" in window || navigator.maxTouchPoints > 0;
 const isOnEdge = () => {
   return window.location.hostname.startsWith("192.168") || window.location.hostname.startsWith("localhost");
@@ -5827,7 +5827,7 @@ const getExecutionEngineHttpUrl = () => {
 // A host page may give the broker's path on the custom UI's own host, whose cookie authenticates the socket, as this
 // query parameter. It is read once when the SDK loads, before the custom UI's router can rewrite the URL.
 const MQTT_PATH_QUERY_PARAMETER = "mqttPath";
-const mqttPathGivenByHost = new URLSearchParams((_a = globalThis.location) === null || _a === void 0 ? void 0 : _a.search).get(MQTT_PATH_QUERY_PARAMETER);
+const mqttPathGivenByHost = new URLSearchParams((_a$1 = globalThis.location) === null || _a$1 === void 0 ? void 0 : _a$1.search).get(MQTT_PATH_QUERY_PARAMETER);
 const getMqttWsUrl = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (version = "v2") {
   const urlOnEdge = version === "v2" ? "ws://192.168.5.2:9001" : `ws://${window.location.hostname}:9001`;
   if (isOnEdge()) return urlOnEdge;
@@ -5868,6 +5868,31 @@ const navigateControlCenter = route => {
   window.parent.postMessage(`navigateTo${capitalizedRoute}`, "*");
 };
 
+var _a;
+// The host page gives the custom UI its application's id as this query parameter. It is read once when the SDK loads,
+// before the custom UI's router can rewrite the URL.
+const APPLICATION_ID_QUERY_PARAMETER = "applicationId";
+const applicationIdGivenByHost = new URLSearchParams((_a = globalThis.location) === null || _a === void 0 ? void 0 : _a.search).get(APPLICATION_ID_QUERY_PARAMETER);
+/**
+ * The URL of a process of the application `applicationId`, through the engine's proxy:
+ * `<engine>/v1/machineCode/services/<applicationId>/<processName>`. Without an id, the unscoped URL of
+ * getMachineCodeProcessHttpUrl().
+ */
+const getMachineCodeProcessHttpUrlGivenApplicationId = (processName, applicationId) => {
+  const encodedProcessName = encodeURIComponent(processName);
+  if (applicationId === null || applicationId === "") return getMachineCodeProcessHttpUrl(encodedProcessName);
+  return getMachineCodeProcessHttpUrl(`${encodeURIComponent(applicationId)}/${encodedProcessName}`);
+};
+/**
+ * The URL of a process of this custom UI's own application, through the engine's proxy.
+ *
+ * Unlike getMachineCodeProcessHttpUrl(), which names no application and which the engine routes to
+ * whichever application it finds running first, this names the application the host page gave, so each
+ * UI reaches its own backend when several applications run. Without an id from the host, it falls back
+ * to getMachineCodeProcessHttpUrl().
+ */
+const getOwnMachineCodeProcessHttpUrl = processName => getMachineCodeProcessHttpUrlGivenApplicationId(processName, applicationIdGivenByHost);
+
 var uncurryThis$3 = functionUncurryThis;
 
 // eslint-disable-next-line es/no-set -- safe
@@ -6754,4 +6779,4 @@ const useMqttSubscription = props => {
   return message;
 };
 
-export { MqttClient, MqttProvider, VirtualKeyboard, closeCustomUi, connectToMqttAndGetClient, getExecutionEngineHttpUrl, getMachineCodeApiBaseUrl, getMachineCodeProcessHttpUrl, getMqttWsUrl, getMqttWsUrlGivenUiIframeUrl, isOnEdge, isTouchScreenDevice, mqttContext, navigateControlCenter, useMqttSubscription, useStyles };
+export { MqttClient, MqttProvider, VirtualKeyboard, closeCustomUi, connectToMqttAndGetClient, getExecutionEngineHttpUrl, getMachineCodeApiBaseUrl, getMachineCodeProcessHttpUrl, getMachineCodeProcessHttpUrlGivenApplicationId, getMqttWsUrl, getMqttWsUrlGivenUiIframeUrl, getOwnMachineCodeProcessHttpUrl, isOnEdge, isTouchScreenDevice, mqttContext, navigateControlCenter, useMqttSubscription, useStyles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vention/machine-logic-ui-sdk",
-  "version": "0.46.1",
+  "version": "0.47.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/VentionCo/machine-cloud.git"

package/src/index.d.ts

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

package/src/lib/utils/own-process-url.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The URL of a process of the application `applicationId`, through the engine's proxy:
+ * `<engine>/v1/machineCode/services/<applicationId>/<processName>`. Without an id, the unscoped URL of
+ * getMachineCodeProcessHttpUrl().
+ */
+export declare const getMachineCodeProcessHttpUrlGivenApplicationId: (processName: string, applicationId: string | null) => string;
+/**
+ * The URL of a process of this custom UI's own application, through the engine's proxy.
+ *
+ * Unlike getMachineCodeProcessHttpUrl(), which names no application and which the engine routes to
+ * whichever application it finds running first, this names the application the host page gave, so each
+ * UI reaches its own backend when several applications run. Without an id from the host, it falls back
+ * to getMachineCodeProcessHttpUrl().
+ */
+export declare const getOwnMachineCodeProcessHttpUrl: (processName: string) => string;