@alwaysai/device-agent-schemas 1.2.0 → 2.0.0

package/src/constants.ts

@@ -10,15 +10,15 @@ export const CLOUD_TOPIC_PREFIX = 'to-cloud';
 export const DEVICE_TOPIC_PREFIX = 'to-device';
 export const DEVICE_TYPE = 'aai-device';
 
-const agentMessageTypeEnum = keyMirror({
+const toClientMessageTypeEnum = keyMirror({
   app_logs: null,
   app_state: null,
   device_stats: null,
-  app_install_status: null,
+  status_response: null,
   signed_urls_request: null,
 });
 
-const clientMessageTypeEnum = keyMirror({
+const toDeviceAgentMessageTypeEnum = keyMirror({
   app_state_control: null,
   app_version_control: null,
   app_install_cloud_response: null,
@@ -47,7 +47,7 @@ const liveUpdatesEnum = keyMirror({
   live_updates: null,
 });
 
-const appInstallStatusEnum = keyMirror({
+const statusEnum = keyMirror({
   requested: null,
   in_progress: null,
   failure: null,
@@ -55,21 +55,42 @@ const appInstallStatusEnum = keyMirror({
 });
 
 export const keyMirrors = {
-  agentMessageType: agentMessageTypeEnum,
-  clientMessageType: clientMessageTypeEnum,
+  deviceAgentMessageType: toDeviceAgentMessageTypeEnum,
+  clientMessageType: toClientMessageTypeEnum,
   appState: appStateEnum,
   appStateControl: appStateControlEnum,
   appVersionControl: appVersionControlEnum,
   liveUpdates: liveUpdatesEnum,
-  appInstallStatus: appInstallStatusEnum,
+  statusResponse: statusEnum,
 };
 
-export const agentMessageTypeValues = Object.values(keyMirrors.agentMessageType);
-export type AgentMessageTypeValue = keyof typeof keyMirrors.agentMessageType;
-
 export const clientMessageTypeValues = Object.values(keyMirrors.clientMessageType);
 export type ClientMessageTypeValue = keyof typeof keyMirrors.clientMessageType;
 
+export type AppLogsMessageType = typeof toClientMessageTypeEnum.app_logs;
+export type AppStateMessageType = typeof toClientMessageTypeEnum.app_state;
+export type DeviceStatsMessageType = typeof toClientMessageTypeEnum.device_stats;
+export type StatusResponseMessageType = typeof toClientMessageTypeEnum.status_response;
+export type SignedUrlsRequestMessageType =
+  typeof toClientMessageTypeEnum.signed_urls_request;
+
+export const deviceAgentMessageTypeValues = Object.values(
+  keyMirrors.deviceAgentMessageType,
+);
+export type DeviceAgentMessageTypeValue = keyof typeof keyMirrors.deviceAgentMessageType;
+
+export type AppStateControlMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_state_control;
+
+export type AppVersionControlMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_version_control;
+export type AppInstallCloudResponseMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_install_cloud_response;
+export type ModelsInstallCloudResponseMessageType =
+  typeof toDeviceAgentMessageTypeEnum.models_install_cloud_response;
+export type LiveStateUpdatesTogglesMessageType =
+  typeof toDeviceAgentMessageTypeEnum.live_state_updates;
+
 export const appStateValues = Object.values(keyMirrors.appState);
 export type AppStateValue = keyof typeof keyMirrors.appState;
 
@@ -82,5 +103,5 @@ export type AppVersionControlValue = keyof typeof keyMirrors.appVersionControl;
 export const liveUpdatesValues = Object.values(keyMirrors.liveUpdates);
 export type LiveUpdatesValue = keyof typeof keyMirrors.liveUpdates;
 
-export const appInstallStatusValues = Object.values(keyMirrors.appInstallStatus);
-export type AppInstallStatusValue = keyof typeof keyMirrors.appInstallStatus;
+export const statusResponseValues = Object.values(keyMirrors.statusResponse);
+export type StatusResponseValue = keyof typeof keyMirrors.statusResponse;

package/src/device-agent-action-schema.ts

@@ -0,0 +1,16 @@
+import { LiveStateUpdatesTogglesMessageType } from './constants';
+import { BaseDeviceAgentMessage } from './types';
+
+export interface LiveStateUpdatesTogglePayload {
+  deviceStats?: boolean;
+  appState?: boolean;
+  appLogs?: {
+    projectId: string;
+    toggle: boolean;
+  };
+}
+
+export interface LiveStateUpdatesToggleMessage extends BaseDeviceAgentMessage {
+  messageType: LiveStateUpdatesTogglesMessageType;
+  payload: LiveStateUpdatesTogglePayload;
+}

package/src/device-stats-schema.ts

@@ -0,0 +1,15 @@
+// Device Status Structures
+
+import { DeviceStatsMessageType } from './constants';
+import { BaseClientMessage } from './types';
+
+export interface DeviceStatsPayload {
+  cpuUsage: number;
+  diskUtil: number;
+  usedMemoryPercentage: number;
+}
+
+export interface DeviceStatsMessage extends BaseClientMessage {
+  messageType: DeviceStatsMessageType;
+  payload: DeviceStatsPayload;
+}

package/src/index.ts

@@ -2,40 +2,57 @@
 import {
   validateDeviceAgentMessage,
   validateClientMessage,
+  BaseDeviceAgentMessage,
   DeviceAgentMessage,
-  ClientMessage,
   DeviceAgentMessagePayload,
+  BaseClientMessage,
+  ClientMessage,
   ClientMessagePayload,
   getClientTopic,
   getCloudTopic,
   getDeviceTopic,
 } from './types';
 import {
-  AppDetailsPacket,
-  AppStatePacket,
-  ServiceStatusPacket,
+  AppDetails,
+  AppState,
+  ServiceStatus,
+  AppStatePayload,
   AppStateMessage,
-} from './schemas/agent/application-state-schema';
-import { AppLogsPacket, AppLogsMessage } from './schemas/agent/application-logs-schema';
+} from './app-state-schema';
+import { AppLogsPayload, AppLogsMessage } from './app-logs-schema';
 import {
-  AppInstallCloudResponseMessage,
-  AppStateControlPacket,
+  AppInstallCloudResponsePayload,
+  ModelsInstallCloudResponsePayload,
   AppStateControlMessage,
-  AppVersionControlPacket,
+  AppStateControlPayload,
+  AppVersionControlInstallPayload,
+  AppVersionControlUninstallPayload,
   AppVersionControlMessage,
   ModelInstallPayload,
-} from './schemas/client/application-action-schema';
+} from './app-action-schema';
+import {
+  ClientMessageTypeValue,
+  DeviceAgentMessageTypeValue,
+  AppStateControlValue,
+  AppStateValue,
+  keyMirrors,
+  AppStateControlMessageType,
+  AppLogsMessageType,
+  DeviceStatsMessageType,
+  AppStateMessageType,
+  SignedUrlsRequestMessageType,
+  StatusResponseMessageType,
+} from './constants';
 import {
-  LiveUpdatesToggleMessage,
-  LiveUpdatesToggles,
-} from './schemas/client/device-agent-action-schema';
-import { DeviceStatsMessage } from './schemas/agent/device-status-schema';
+  LiveStateUpdatesTogglePayload,
+  LiveStateUpdatesToggleMessage,
+} from './device-agent-action-schema';
+import { DeviceStatsPayload, DeviceStatsMessage } from './device-stats-schema';
+import { StatusResponsePayload, StatusResponseMessage } from './status-response-schema';
 import {
-  AppInstallStatusMessage,
-  AppInstallStatusPacket,
-} from './schemas/agent/app-install-status-schema';
-import { AppStateControlValue, AppStateValue, keyMirrors } from './constants';
-import { SignedUrlsRequestMessage } from './schemas/agent/request-data-from-cloud';
+  SignedUrlsRequestPayload,
+  SignedUrlsRequestMessage,
+} from './signed-urls-request-schema';
 
 export {
   // getters
@@ -43,32 +60,48 @@ export {
   getCloudTopic,
   getDeviceTopic,
   // types
-  AppLogsPacket,
-  AppDetailsPacket,
-  ServiceStatusPacket,
-  AppStatePacket,
-  ModelInstallPayload,
-  AppInstallStatusPacket,
-  AppStateControlPacket,
-  AppVersionControlPacket,
+  AppDetails,
+  ServiceStatus,
+  AppState,
   AppStateControlValue,
   AppStateValue,
-  LiveUpdatesToggles,
-  DeviceAgentMessagePayload,
-  ClientMessagePayload,
+  // messageTypes
+  AppStateControlMessageType,
+  AppLogsMessageType,
+  DeviceStatsMessageType,
+  AppStateMessageType,
+  SignedUrlsRequestMessageType,
+  StatusResponseMessageType,
   // messages
+  ModelInstallPayload,
+  StatusResponseMessage,
+  AppStateControlMessage,
+  LiveStateUpdatesTogglePayload,
+  LiveStateUpdatesToggleMessage,
+  DeviceStatsPayload,
   DeviceStatsMessage,
+  AppStatePayload,
   AppStateMessage,
+  AppLogsPayload,
   AppLogsMessage,
-  AppInstallStatusMessage,
-  AppStateControlMessage,
+  StatusResponsePayload,
+  AppStateControlPayload,
+  AppVersionControlInstallPayload,
+  AppVersionControlUninstallPayload,
   AppVersionControlMessage,
-  AppInstallCloudResponseMessage,
-  LiveUpdatesToggleMessage,
+  AppInstallCloudResponsePayload,
+  ModelsInstallCloudResponsePayload,
+  SignedUrlsRequestPayload,
   SignedUrlsRequestMessage,
   // generic messages
+  BaseDeviceAgentMessage,
   DeviceAgentMessage,
+  DeviceAgentMessagePayload,
+  BaseClientMessage,
   ClientMessage,
+  ClientMessagePayload,
+  ClientMessageTypeValue,
+  DeviceAgentMessageTypeValue,
   // message validators
   validateDeviceAgentMessage,
   validateClientMessage,

package/src/schemas/app-install-cloud-response-schema.json

@@ -0,0 +1,41 @@
+{
+  "$id": "https://alwaysai.co/app-install-cloud-response-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_install_cloud_response",
+  "type": "object",
+  "properties": {
+    "appInstallCloudResponse": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "appReleaseHash": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+        },
+        "appInstallPayload": {
+          "type": "object",
+          "properties": {
+            "appSignedUrl": {
+              "type": "string"
+            }
+          },
+          "required": ["appSignedUrl"],
+          "additionalProperties": false
+        },
+        "modelsInstallPayload": {
+          "$ref": "https://alwaysai.co/models-install-payload-schema.json"
+        }
+      },
+      "required": [
+        "projectId",
+        "appReleaseHash",
+        "appInstallPayload",
+        "modelsInstallPayload"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": ["appInstallCloudResponse"],
+  "additionalProperties": false
+}

package/src/schemas/app-install-schema.json

@@ -0,0 +1,20 @@
+{
+  "$id": "https://alwaysai.co/app-install-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_install",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["install"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    },
+    "appReleaseHash": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+    }
+  },
+  "required": ["baseCommand", "projectId", "appReleaseHash"],
+  "additionalProperties": false
+}

package/src/schemas/app-logs-schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "https://alwaysai.co/app-logs-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_logs",
+  "type": "object",
+  "properties": {
+    "appLogs": {
+      "type": "object",
+      "properties": {
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        },
+        "logChunk": {
+          "type": "string"
+        }
+      },
+      "required": ["projectId", "logChunk"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["appLogs"],
+  "additionalProperties": false
+}

package/src/schemas/app-state-control-schema.json

@@ -0,0 +1,24 @@
+{
+  "$id": "https://alwaysai.co/app-state-control-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_state_control",
+  "type": "object",
+  "properties": {
+    "appStateControl": {
+      "type": "object",
+      "properties": {
+        "baseCommand": {
+          "type": "string",
+          "enum": ["start", "stop", "restart"]
+        },
+        "projectId": {
+          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+        }
+      },
+      "required": ["baseCommand", "projectId"],
+      "additionalProperties": false
+    }
+  },
+  "required": ["appStateControl"],
+  "additionalProperties": false
+}

package/src/schemas/app-state-schema.json

@@ -0,0 +1,49 @@
+{
+  "$id": "https://alwaysai.co/app-state-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_state",
+  "type": "object",
+  "properties": {
+    "appState": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "appDetails": {
+            "type": "object",
+            "properties": {
+              "projectId": {
+                "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+              },
+              "version": {
+                "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+              }
+            },
+            "additionalProperties": false,
+            "required": ["projectId", "version"]
+          },
+          "services": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "state": {
+                  "enum": ["up", "stopped", "restarting"]
+                }
+              },
+              "additionalProperties": false,
+              "required": ["name", "state"]
+            }
+          }
+        },
+        "additionalProperties": false,
+        "required": ["appDetails", "services"]
+      }
+    }
+  },
+  "additionalProperties": false,
+  "required": ["appState"]
+}

package/src/schemas/app-uninstall-schema.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://alwaysai.co/app-uninstall-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_uninstall",
+  "type": "object",
+  "properties": {
+    "baseCommand": {
+      "type": "string",
+      "enum": ["uninstall"]
+    },
+    "projectId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+    }
+  },
+  "required": ["baseCommand", "projectId"],
+  "additionalProperties": false
+}

package/src/schemas/app-version-control-schema.json

@@ -0,0 +1,20 @@
+{
+  "$id": "https://alwaysai.co/app-version-control-schema.json",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "title": "app_version_control",
+  "type": "object",
+  "properties": {
+    "appVersionControl": {
+      "oneOf": [
+        {
+          "$ref": "https://alwaysai.co/app-install-schema.json"
+        },
+        {
+          "$ref": "https://alwaysai.co/app-uninstall-schema.json"
+        }
+      ]
+    }
+  },
+  "required": ["appVersionControl"],
+  "additionalProperties": false
+}

package/src/schemas/client-message-schema.json

@@ -0,0 +1,117 @@
+{
+  "$id": "https://alwaysai.co/client-message-schema.json",
+  "title": "client_message",
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "description": "The messaging payload structure for messages sent from device agent to clients",
+  "type": "object",
+  "properties": {
+    "timestamp": {
+      "type": "string"
+    },
+    "deviceId": {
+      "description": "Device UUID of device sending the message",
+      "type": "string"
+    },
+    "topic": {
+      "oneOf": [{ "$ref": "#/$defs/toCloud" }, { "$ref": "#/$defs/toClient" }]
+    },
+    "messageType": {
+      "type": "string",
+      "enum": [
+        "device_stats",
+        "app_state",
+        "status_response",
+        "app_logs",
+        "signed_urls_request"
+      ]
+    },
+    "txId": {
+      "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
+    },
+    "payload": {
+      "oneOf": [
+        { "$ref": "https://alwaysai.co/device-stats-schema.json" },
+        { "$ref": "https://alwaysai.co/app-state-schema.json" },
+        { "$ref": "https://alwaysai.co/app-logs-schema.json" },
+        { "$ref": "https://alwaysai.co/status-response-schema.json" },
+        { "$ref": "https://alwaysai.co/signed-urls-request-schema.json" }
+      ]
+    }
+  },
+  "allOf":[
+  {
+    "if": {
+      "properties": {
+        "messageType": { "const": "device_stats" }
+      }
+    },
+    "then": {
+      "properties": {
+        "payload": {"$ref": "https://alwaysai.co/device-stats-schema.json"}
+      }
+    }
+  },
+  {
+    "if": {
+      "properties": {
+        "messageType": { "const": "app_state" }
+      }
+    },
+    "then": {
+      "properties": {
+        "payload": {"$ref": "https://alwaysai.co/app-state-schema.json"}
+      }
+    }
+  },
+  {
+    "if": {
+      "properties": {
+        "messageType": { "const": "status_response" }
+      }
+    },
+    "then": {
+      "properties": {
+        "payload": {"$ref": "https://alwaysai.co/status-response-schema.json"}
+      }
+    }
+  },
+  {
+    "if": {
+      "properties": {
+        "messageType": { "const": "app_logs" }
+      }
+    },
+    "then": {
+      "properties": {
+        "payload": {"$ref": "https://alwaysai.co/app-logs-schema.json"}
+      }
+    }
+  },
+  {
+    "if": {
+      "properties": {
+        "messageType": { "const": "signed_urls_request" }
+      }
+    },
+    "then": {
+      "properties": {
+        "payload": {"$ref": "https://alwaysai.co/signed-urls-request-schema.json"}
+      }
+    }
+  }
+  ],
+  "required": ["timestamp", "deviceId", "txId", "payload", "messageType"],
+  "additionalProperties": false,
+  "$defs": {
+    "toCloud": {
+      "description": "Messages sent from the device agent to cloud backend client",
+      "type": "string",
+      "pattern": "to-cloud/aai-device/([0-9a-z]+-+)+([0-9a-z])+"
+    },
+    "toClient": {
+      "description": "Messages sent from the device agent to console client",
+      "type": "string",
+      "pattern": "to-client/aai-device/([0-9a-z]+-+)+([0-9a-z])+"
+    }
+  }
+}

package/src/schemas/common-schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://alwaysai.co/common-schema.json",
+  "title": "common",
+  "$defs": {
+    "projectId": {
+      "description": "The specific project associated with the message payload.",
+      "type": "string",
+      "pattern": "([0-9a-z]+-+)+([0-9a-z])+"
+    },
+    "appReleaseHash": {
+      "description": "The version of the project associated with the message payload.",
+      "type": "string",
+      "pattern": "[0-9a-z]{64}"
+    },
+    "modelId":  {
+      "description": "The id of a model",
+      "type": "string",
+      "pattern": "[A-Za-z0-9_]+/[A-Za-z0-9_]*"
+    },
+    "txId": {
+      "type": "string",
+      "minLength": 36,
+      "maxLength": 36,
+      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+    }
+  }
+}