@vention/machine-apps-components 0.2.10 → 0.3.1

package/README.md

@@ -304,7 +304,7 @@ type LogType = "error" | "warning" | "info"
 interface LogEntry {
   id: string
   date: string // ISO or locale string parsable by Date
-  type: LogType
+  level: LogType
   code: string
   message: string
   description: string

package/index.esm.js

@@ -1063,8 +1063,8 @@ const LogsTable = memo(({
       })
     });
   }
-  const getTypeClassName = type => {
-    switch (type) {
+  const getTypeClassName = level => {
+    switch (level) {
       case "error":
         return classes.errorType;
       case "warning":
@@ -1075,15 +1075,15 @@ const LogsTable = memo(({
         return "";
     }
   };
-  const renderTypeIcon = type => {
-    if (type === "error") {
+  const renderTypeIcon = level => {
+    if (level === "error") {
       return jsx(VentionIcon, {
         size: 20,
         type: "alert-circle-filled",
         color: theme.palette.error.main
       });
     }
-    if (type === "warning") {
+    if (level === "warning") {
       return jsx(VentionIcon, {
         size: 20,
         type: "alert-triangle-filled",
@@ -1157,7 +1157,7 @@ const LogsTable = memo(({
               className: classes.iconCell,
               children: jsx(Box, {
                 className: classes.iconWrapper,
-                children: renderTypeIcon(log.type)
+                children: renderTypeIcon(log.level)
               })
             }), jsx(TableCell, {
               children: jsx(Typography, {
@@ -1166,11 +1166,11 @@ const LogsTable = memo(({
                 children: formatDate(log.date)
               })
             }), jsx(TableCell, {
-              className: cx(classes.typeCell, getTypeClassName(log.type)),
+              className: cx(classes.typeCell, getTypeClassName(log.level)),
               children: jsx(Typography, {
                 variant: "heading24Medium",
                 className: classes.tableText,
-                children: log.type
+                children: log.level
               })
             }), jsx(TableCell, {
               children: jsx(Typography, {
@@ -1708,4 +1708,60 @@ const useStyles = tss.create(({
   }
 }));
 
-export { LogFilterForm, LogsPagination, LogsPanel, LogsTable, NavigationBar, NavigationConfirmationModal, PasswordProtectionModal, Sidebar, StatusTopBar, TimeLabel, formatDateToInput, parseLogDate };
+/**
+ * This module provides utilities for generating API base URLs for machine apps.
+ * It automatically detects the environment and returns the appropriate URL:
+ * - Local/Edge: http://hostname:8000
+ * - Deployed: Uses passthrough URL for digital twin infrastructure
+ */
+/**
+ * Gets the execution engine HTTP URL for deployed environments
+ * @param processName - The name of the process/service
+ * @returns The full URL for the execution engine API
+ */
+function getExecutionEngineHttpUrl(processName) {
+  const {
+    href,
+    port,
+    hostname,
+    origin
+  } = window.location;
+  const pathParts = new URL(href).pathname.split("/").filter(Boolean);
+  const passthroughIndex = pathParts.indexOf("passthrough");
+  const hmiIndex = pathParts.indexOf("hmi");
+  const sessionId = passthroughIndex >= 0 && passthroughIndex < pathParts.length - 1 ? pathParts[passthroughIndex + 1] : hmiIndex > 0 ? pathParts[hmiIndex - 1] : "";
+  const basePath = `/digital-twin/machine-motion/passthrough/${sessionId}/80/v1/machineCode/services/${processName}`;
+  const isDev = port === "5173" || hostname === "localhost";
+  const baseOrigin = isDev ? "https://digital-twin.vention.foo" : origin;
+  return `${baseOrigin}${basePath}`;
+}
+/**
+ * Checks if the current environment is running on edge (local controller)
+ * @returns true if running on edge, false otherwise
+ */
+function isOnEdge() {
+  return window.location.hostname.startsWith("192.168") || window.location.hostname.startsWith("localhost");
+}
+/**
+ * Gets the API base URL for the specified process/service
+ * @param options - Configuration options including process name and optional edge port
+ * @returns The API base URL for all backend API calls
+ * @example
+ * ```ts
+ * const apiUrl = getApiBaseUrl({ processName: "ai-operator" })
+ * // Returns: http://192.168.1.100:8000 (on edge)
+ * // or https://digital-twin.../passthrough/.../ai-operator (deployed)
+ * ```
+ */
+function getApiBaseUrl(options) {
+  const {
+    processName,
+    edgePort = 8000
+  } = options;
+  if (isOnEdge()) {
+    return `http://${window.location.hostname}:${edgePort}`;
+  }
+  return getExecutionEngineHttpUrl(processName);
+}
+
+export { LogFilterForm, LogsPagination, LogsPanel, LogsTable, NavigationBar, NavigationConfirmationModal, PasswordProtectionModal, Sidebar, StatusTopBar, TimeLabel, closeCustomUi, formatDateToInput, getApiBaseUrl, isOnEdge, isTouchScreenDevice, navigateControlCenter, parseLogDate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vention/machine-apps-components",
-  "version": "0.2.10",
+  "version": "0.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/VentionCo/machine-cloud.git"
@@ -18,7 +18,7 @@
     "react": "17.0.2",
     "react-router-dom": "^6.0.0",
     "@mui/material": "^5.0.0",
-    "@ventionco/machine-ui": "3.30.3"
+    "@ventionco/machine-ui": "3.30.4"
   },
   "devDependencies": {
     "@nx/vite": "21.1.3",

package/src/index.d.ts

@@ -10,3 +10,5 @@ export * from "./lib/logs/log-filter-form";
 export * from "./lib/logs/logs-panel";
 export * from "./lib/logs/logs-pagination";
 export type { LogEntry, LogFilterFormValues, SortOrder, LogType, PaginationMode, PaginationConfig, LogsPanelHandle, } from "./lib/logs/logs-panel";
+export * from "./lib/utils/api-config-utils";
+export * from "./lib/utils/device-utils";

package/src/lib/logs/logs-panel.d.ts

@@ -3,7 +3,7 @@ export type LogType = "error" | "warning" | "info";
 export interface LogEntry {
     id: string;
     date: string;
-    type: LogType;
+    level: LogType;
     code: string;
     message: string;
     description: string;

package/src/lib/utils/api-config-utils.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This module provides utilities for generating API base URLs for machine apps.
+ * It automatically detects the environment and returns the appropriate URL:
+ * - Local/Edge: http://hostname:8000
+ * - Deployed: Uses passthrough URL for digital twin infrastructure
+ */
+interface ApiConfigOptions {
+    /**
+     * The name of the process/service (e.g., "ai-operator", "my-service")
+     */
+    processName: string;
+    /**
+     * Optional custom port for edge/local development (default: 8000)
+     */
+    edgePort?: number;
+}
+/**
+ * Checks if the current environment is running on edge (local controller)
+ * @returns true if running on edge, false otherwise
+ */
+export declare function isOnEdge(): boolean;
+/**
+ * Gets the API base URL for the specified process/service
+ * @param options - Configuration options including process name and optional edge port
+ * @returns The API base URL for all backend API calls
+ * @example
+ * ```ts
+ * const apiUrl = getApiBaseUrl({ processName: "ai-operator" })
+ * // Returns: http://192.168.1.100:8000 (on edge)
+ * // or https://digital-twin.../passthrough/.../ai-operator (deployed)
+ * ```
+ */
+export declare function getApiBaseUrl(options: ApiConfigOptions): string;
+export {};