@alwaysai/device-agent-schemas 3.3.0 → 3.3.1

package/src/common.ts

@@ -0,0 +1,19 @@
+export interface BaseToCloudMessage {
+  deviceId: string;
+  timestamp: string;
+  topic?: string;
+  txId: string;
+}
+
+export interface BaseToClientMessage {
+  deviceId: string;
+  timestamp: string;
+  topic?: string;
+  txId: string;
+}
+
+export interface BaseToDeviceAgentMessage {
+  timestamp: string;
+  topic?: string;
+  txId: string;
+}

package/src/constants.ts

@@ -0,0 +1,141 @@
+import { keyMirror } from './utils';
+
+export const PROJECT_ID_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}$';
+export const DEVICE_ID_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}$';
+export const APP_RELEASE_ID_PATTERN = '[0-9a-z]{64}';
+export const MODEL_ID_PATTERN = '[A-Za-z0-9_]+/[A-Za-z0-9_]*';
+
+export const CLIENT_TOPIC_PREFIX = 'to-client';
+export const CLOUD_TOPIC_PREFIX = 'to-cloud';
+export const DEVICE_TOPIC_PREFIX = 'to-device';
+export const DEVICE_TYPE = 'aai-device';
+
+const toCloudMessageTypeEnum = keyMirror({
+  signed_urls_request: null
+});
+
+const toClientMessageTypeEnum = keyMirror({
+  app_logs: null,
+  app_state: null,
+  device_stats: null,
+  status_response: null
+});
+
+const toDeviceAgentMessageTypeEnum = keyMirror({
+  app_state_control: null,
+  app_version_control: null,
+  app_install_response: null,
+  models_install_response: null,
+  live_state_updates: null,
+  status_response: null,
+  device_action: null
+});
+
+const appStateEnum = keyMirror({
+  up: null,
+  stopped: null,
+  restarting: null
+});
+
+const appStateControlEnum = keyMirror({
+  start: null,
+  stop: null,
+  restart: null
+});
+
+const appVersionControlEnum = keyMirror({
+  install: null,
+  uninstall: null,
+  update_config: null
+});
+
+const liveUpdatesEnum = keyMirror({
+  live_updates: null
+});
+
+const statusEnum = keyMirror({
+  requested: null,
+  in_progress: null,
+  failure: null,
+  success: null,
+  connection_lost: null
+});
+
+const deviceActionEnum = keyMirror({
+  system_restart: null
+});
+
+export const keyMirrors = {
+  toDeviceAgentMessageType: toDeviceAgentMessageTypeEnum,
+  toClientMessageType: toClientMessageTypeEnum,
+  toCloudMessageType: toCloudMessageTypeEnum,
+  appState: appStateEnum,
+  appStateControl: appStateControlEnum,
+  appVersionControl: appVersionControlEnum,
+  liveUpdates: liveUpdatesEnum,
+  statusResponse: statusEnum,
+  deviceAction: deviceActionEnum
+};
+
+export const toCloudMessageTypeValues = Object.values(
+  keyMirrors.toCloudMessageType
+);
+export type ToCloudMessageTypeValue =
+  keyof typeof keyMirrors.toCloudMessageType;
+
+export const toClientMessageTypeValues = Object.values(
+  keyMirrors.toClientMessageType
+);
+export type ToClientMessageTypeValue =
+  keyof typeof keyMirrors.toClientMessageType;
+
+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 toCloudMessageTypeEnum.signed_urls_request;
+
+export const toDeviceAgentMessageTypeValues = Object.values(
+  keyMirrors.toDeviceAgentMessageType
+);
+export type ToDeviceAgentMessageTypeValue =
+  keyof typeof keyMirrors.toDeviceAgentMessageType;
+
+export type AppStateControlMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_state_control;
+
+export type AppVersionControlMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_version_control;
+export type AppInstallResponseMessageType =
+  typeof toDeviceAgentMessageTypeEnum.app_install_response;
+export type ModelsInstallResponseMessageType =
+  typeof toDeviceAgentMessageTypeEnum.models_install_response;
+export type LiveStateUpdatesTogglesMessageType =
+  typeof toDeviceAgentMessageTypeEnum.live_state_updates;
+export type DeviceActionMessageType =
+  typeof toDeviceAgentMessageTypeEnum.device_action;
+
+export const appStateValues = Object.values(keyMirrors.appState);
+export type AppStateValue = keyof typeof keyMirrors.appState;
+
+export const appStateControlValues = Object.values(keyMirrors.appStateControl);
+export type AppStateControlValue = keyof typeof keyMirrors.appStateControl;
+
+export const appVersionControlValues = Object.values(
+  keyMirrors.appVersionControl
+);
+export type AppVersionControlValue = keyof typeof keyMirrors.appVersionControl;
+
+export const liveUpdatesValues = Object.values(keyMirrors.liveUpdates);
+export type LiveUpdatesValue = keyof typeof keyMirrors.liveUpdates;
+
+export const statusResponseValues = Object.values(keyMirrors.statusResponse);
+export type StatusResponseValue = keyof typeof keyMirrors.statusResponse;
+
+export const deviceActionValues = Object.values(keyMirrors.deviceAction);
+export type DeviceActionValue = keyof typeof keyMirrors.deviceAction;

package/src/device-action-schema.ts

@@ -0,0 +1,11 @@
+import { DeviceActionMessageType, DeviceActionValue } from './constants';
+import { BaseToDeviceAgentMessage } from './common';
+
+export interface DeviceActionPayload {
+  action: DeviceActionValue;
+}
+
+export interface DeviceActionMessage extends BaseToDeviceAgentMessage {
+  messageType: DeviceActionMessageType;
+  payload: DeviceActionPayload;
+}

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

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

package/src/device-stats-schema.ts

@@ -0,0 +1,33 @@
+// To Device Status Structures
+
+import { DeviceStatsMessageType } from './constants';
+import { BaseToClientMessage } from './common';
+
+interface CpuDetails {
+  usedPerc?: number;
+  temperature?: number;
+}
+
+interface DiskDetails {
+  usedGb?: number;
+  freeGb?: number;
+}
+
+interface MemDetails {
+  usedMb?: number;
+  freeMb?: number;
+}
+
+export interface DeviceStatsPayload {
+  cpuUsage?: number;
+  diskUtil?: number;
+  usedMemoryPercentage?: number;
+  cpuDetails?: CpuDetails;
+  diskDetails?: DiskDetails;
+  memDetails?: MemDetails;
+}
+
+export interface DeviceStatsMessage extends BaseToClientMessage {
+  messageType: DeviceStatsMessageType;
+  payload: DeviceStatsPayload;
+}

package/src/index.ts

@@ -0,0 +1,192 @@
+// export types here
+import {
+  validateToDeviceAgentMessage,
+  validateToClientMessage,
+  ToDeviceAgentMessage,
+  ToDeviceAgentMessagePayload,
+  ToClientMessage,
+  ToClientMessagePayload,
+  ToCloudMessage,
+  ToCloudMessagePayload,
+  getToClientTopic,
+  getToCloudTopic,
+  getToDeviceTopic,
+  validateToCloudMessage
+} from './types';
+import { generateTxId } from './utils';
+import {
+  AppDetails,
+  AppState,
+  ServiceStatus,
+  AppStatePayload,
+  AppStateMessage
+} from './app-state-schema';
+import { AppLogsPayload, AppLogsMessage } from './app-logs-schema';
+import {
+  AppInstallResponsePayload,
+  ModelsInstallResponsePayload,
+  AppStateControlMessage,
+  AppStateControlPayload,
+  AppVersionControlInstallPayload,
+  AppVersionControlUninstallPayload,
+  AppVersionControlUpdateConfigPayload,
+  AppVersionControlMessage,
+  ModelInstallPayload
+} from './app-action-schema';
+import {
+  ToClientMessageTypeValue,
+  ToDeviceAgentMessageTypeValue,
+  AppStateControlValue,
+  AppStateValue,
+  keyMirrors,
+  AppStateControlMessageType,
+  AppLogsMessageType,
+  DeviceStatsMessageType,
+  AppStateMessageType,
+  SignedUrlsRequestMessageType,
+  StatusResponseMessageType,
+  StatusResponseValue,
+  ToCloudMessageTypeValue
+} from './constants';
+import {
+  LiveStateUpdatesTogglePayload,
+  LiveStateUpdatesToggleMessage
+} from './device-agent-action-schema';
+import { DeviceStatsPayload, DeviceStatsMessage } from './device-stats-schema';
+import {
+  StatusResponsePayload,
+  ToClientStatusResponseMessage,
+  ToDeviceStatusResponseMessage
+} from './status-response-schema';
+import {
+  SignedUrlsRequestPayload,
+  SignedUrlsRequestMessage
+} from './signed-urls-request-schema';
+import { DeviceActionPayload } from './device-action-schema';
+import {
+  buildAppLogsMessage,
+  buildAppStateMessage,
+  buildAppVersionControlMessage,
+  buildLiveStateUpdatesToggleMessage,
+  buildAppStateControlMessage,
+  buildDeviceActionMessage,
+  buildDeviceStatsMessage,
+  buildSignedUrlsRequestMessage,
+  buildToClientStatusResponseMessage,
+  buildToDeviceStatusResponseMessage
+} from './message-builders';
+import {
+  ProjectShadowUpdate,
+  ShadowProjectsUpdateAll,
+  validateProjectShadowUpdate,
+  validateShadowProjectsUpdateAll,
+  SystemInformationShadowUpdate,
+  SecureTunnelPortInfo,
+  SecureTunnelShadowUpdate,
+  validateSecureTunnelShadowUpdate,
+  validateSystemInformationShadowUpdate,
+  buildBaseShadowMessage,
+  buildUpdateShadowMessage,
+  ShadowTopics,
+  ShadowNames,
+  getShadowTopic,
+  getDesiredFromMessage,
+  getReportedFromMessage,
+  getUpdateDeltaStateFromMessage,
+  ShadowUpdateTypes,
+  EnvVars,
+  validateEnvVarSchemaShadowUpdate
+} from './shadow-schema';
+
+export {
+  // getters
+  getToClientTopic,
+  getToCloudTopic,
+  getToDeviceTopic,
+  getShadowTopic,
+  getDesiredFromMessage,
+  getReportedFromMessage,
+  getUpdateDeltaStateFromMessage,
+  // types
+  AppDetails,
+  ServiceStatus,
+  AppState,
+  AppStateControlValue,
+  AppStateValue,
+  ProjectShadowUpdate,
+  ShadowProjectsUpdateAll,
+  SystemInformationShadowUpdate,
+  SecureTunnelPortInfo,
+  SecureTunnelShadowUpdate,
+  EnvVars,
+  // messageTypes
+  ToCloudMessageTypeValue,
+  AppStateControlMessageType,
+  AppLogsMessageType,
+  DeviceStatsMessageType,
+  AppStateMessageType,
+  SignedUrlsRequestMessageType,
+  StatusResponseMessageType,
+  ShadowUpdateTypes,
+  // messages and payloads
+  ModelInstallPayload,
+  ToClientStatusResponseMessage,
+  ToDeviceStatusResponseMessage,
+  StatusResponseValue,
+  AppStateControlMessage,
+  LiveStateUpdatesTogglePayload,
+  LiveStateUpdatesToggleMessage,
+  DeviceStatsPayload,
+  DeviceStatsMessage,
+  AppStatePayload,
+  AppStateMessage,
+  AppLogsPayload,
+  AppLogsMessage,
+  StatusResponsePayload,
+  AppStateControlPayload,
+  AppVersionControlInstallPayload,
+  AppVersionControlUninstallPayload,
+  AppVersionControlUpdateConfigPayload,
+  AppVersionControlMessage,
+  AppInstallResponsePayload,
+  ModelsInstallResponsePayload,
+  SignedUrlsRequestPayload,
+  SignedUrlsRequestMessage,
+  ToDeviceAgentMessage,
+  ToDeviceAgentMessagePayload,
+  ToDeviceAgentMessageTypeValue,
+  ToClientMessage,
+  ToClientMessagePayload,
+  ToClientMessageTypeValue,
+  ToCloudMessage,
+  ToCloudMessagePayload,
+  DeviceActionPayload,
+  // message validators
+  validateToDeviceAgentMessage,
+  validateToClientMessage,
+  validateToCloudMessage,
+  validateShadowProjectsUpdateAll,
+  validateProjectShadowUpdate,
+  validateSystemInformationShadowUpdate,
+  validateSecureTunnelShadowUpdate,
+  validateEnvVarSchemaShadowUpdate,
+  // message builders
+  buildAppLogsMessage,
+  buildAppStateMessage,
+  buildDeviceStatsMessage,
+  buildSignedUrlsRequestMessage,
+  buildToClientStatusResponseMessage,
+  buildToDeviceStatusResponseMessage,
+  buildAppVersionControlMessage,
+  buildLiveStateUpdatesToggleMessage,
+  buildAppStateControlMessage,
+  buildDeviceActionMessage,
+  buildBaseShadowMessage,
+  buildUpdateShadowMessage,
+  // key mirrors
+  keyMirrors,
+  ShadowTopics,
+  ShadowNames,
+  // utilities
+  generateTxId
+};

package/src/message-builders.ts

@@ -0,0 +1,269 @@
+import {
+  AppStateControlMessage,
+  AppStateControlPayload,
+  AppVersionControlInstallPayload,
+  AppVersionControlMessage,
+  AppVersionControlUninstallPayload,
+  AppVersionControlUpdateConfigPayload
+} from './app-action-schema';
+import { AppLogsMessage, AppLogsPayload } from './app-logs-schema';
+import { AppStateMessage, AppStatePayload } from './app-state-schema';
+import {
+  BaseToClientMessage,
+  BaseToCloudMessage,
+  BaseToDeviceAgentMessage
+} from './common';
+import {
+  AppLogsMessageType,
+  AppStateMessageType,
+  DeviceStatsMessageType,
+  SignedUrlsRequestMessageType,
+  StatusResponseMessageType,
+  keyMirrors
+} from './constants';
+import {
+  DeviceActionMessage,
+  DeviceActionPayload
+} from './device-action-schema';
+import {
+  LiveStateUpdatesToggleMessage,
+  LiveStateUpdatesTogglePayload
+} from './device-agent-action-schema';
+import { DeviceStatsMessage, DeviceStatsPayload } from './device-stats-schema';
+import { SignedUrlsRequestMessage } from './signed-urls-request-schema';
+import {
+  StatusResponsePayload,
+  ToClientStatusResponseMessage,
+  ToDeviceStatusResponseMessage
+} from './status-response-schema';
+import {
+  ToCloudMessagePayload,
+  getToClientTopic,
+  getToCloudTopic,
+  getToDeviceTopic
+} from './types';
+
+function buildBaseToClientMessage(
+  clientId: string,
+  txId: string
+): BaseToClientMessage {
+  const baseClientMessage = {
+    timestamp: new Date().toUTCString(),
+    deviceId: clientId,
+    topic: getToClientTopic(clientId),
+    txId
+  };
+  return baseClientMessage;
+}
+
+function buildBaseToDeviceMessage(
+  deviceId: string,
+  txId: string
+): BaseToDeviceAgentMessage {
+  const baseToDeviceMessage = {
+    timestamp: new Date().toUTCString(),
+    topic: getToDeviceTopic(deviceId),
+    txId
+  };
+  return baseToDeviceMessage;
+}
+
+function buildBaseToCloudMessage(
+  deviceId: string,
+  txId: string
+): BaseToCloudMessage {
+  const baseToCloudMessage = {
+    deviceId,
+    timestamp: new Date().toUTCString(),
+    topic: getToCloudTopic(deviceId),
+    txId
+  };
+  return baseToCloudMessage;
+}
+
+// toClient Message Builders
+
+// app logs
+function buildAppLogsMessage(
+  clientId: string,
+  payload: AppLogsPayload,
+  txId: string
+): AppLogsMessage {
+  const baseMessage = buildBaseToClientMessage(clientId, txId);
+  const messageType: AppLogsMessageType =
+    keyMirrors.toClientMessageType.app_logs;
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// app state
+function buildAppStateMessage(
+  clientId: string,
+  payload: AppStatePayload,
+  txId: string
+): AppStateMessage {
+  const baseMessage = buildBaseToClientMessage(clientId, txId);
+  const messageType: AppStateMessageType =
+    keyMirrors.toClientMessageType.app_state;
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// status response
+function buildToClientStatusResponseMessage(
+  clientId: string,
+  payload: StatusResponsePayload,
+  txId: string
+): ToClientStatusResponseMessage {
+  const baseMessage = buildBaseToClientMessage(clientId, txId);
+  const messageType: StatusResponseMessageType =
+    keyMirrors.toClientMessageType.status_response;
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// device stats
+function buildDeviceStatsMessage(
+  clientId: string,
+  payload: DeviceStatsPayload,
+  txId: string
+): DeviceStatsMessage {
+  const messageType: DeviceStatsMessageType =
+    keyMirrors.toClientMessageType.device_stats;
+  const baseMessage = buildBaseToClientMessage(clientId, txId);
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// toDevice Message Builders
+
+// status response
+function buildToDeviceStatusResponseMessage(
+  clientId: string,
+  payload: StatusResponsePayload,
+  txId: string
+): ToDeviceStatusResponseMessage {
+  const baseMessage = buildBaseToDeviceMessage(clientId, txId);
+  const messageType: StatusResponseMessageType =
+    keyMirrors.toClientMessageType.status_response;
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// app version control
+function buildAppVersionControlMessage(
+  deviceId: string,
+  payload:
+    | AppVersionControlInstallPayload
+    | AppVersionControlUninstallPayload
+    | AppVersionControlUpdateConfigPayload,
+  txId: string
+): AppVersionControlMessage {
+  const messageType = keyMirrors.toDeviceAgentMessageType.app_version_control;
+  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// live state updates toggle
+function buildLiveStateUpdatesToggleMessage(
+  deviceId: string,
+  payload: LiveStateUpdatesTogglePayload,
+  txId: string
+): LiveStateUpdatesToggleMessage {
+  const messageType = keyMirrors.toDeviceAgentMessageType.live_state_updates;
+  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// app state control
+function buildAppStateControlMessage(
+  deviceId: string,
+  payload: AppStateControlPayload,
+  txId: string
+): AppStateControlMessage {
+  const messageType = keyMirrors.toDeviceAgentMessageType.app_state_control;
+  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+function buildDeviceActionMessage(
+  deviceId: string,
+  payload: DeviceActionPayload,
+  txId: string
+): DeviceActionMessage {
+  const messageType = keyMirrors.toDeviceAgentMessageType.device_action;
+  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+// toCloud Message Builders
+
+// signed URLs
+function buildSignedUrlsRequestMessage(
+  clientId: string,
+  payload: ToCloudMessagePayload,
+  txId: string
+): SignedUrlsRequestMessage {
+  const baseMessage = buildBaseToCloudMessage(clientId, txId);
+  const messageType: SignedUrlsRequestMessageType =
+    keyMirrors.toCloudMessageType.signed_urls_request;
+  const message = {
+    ...baseMessage,
+    messageType,
+    payload
+  };
+  return message;
+}
+
+export {
+  buildAppLogsMessage,
+  buildAppStateMessage,
+  buildSignedUrlsRequestMessage,
+  buildToClientStatusResponseMessage,
+  buildToDeviceStatusResponseMessage,
+  buildDeviceStatsMessage,
+  buildAppVersionControlMessage,
+  buildLiveStateUpdatesToggleMessage,
+  buildAppStateControlMessage,
+  buildDeviceActionMessage
+};