@alwaysai/device-agent-schemas 2.1.13 → 2.2.1

package/src/constants.ts

@@ -13,14 +13,14 @@ export const DEVICE_TOPIC_PREFIX = 'to-device';
 export const DEVICE_TYPE = 'aai-device';
 
 const toCloudMessageTypeEnum = keyMirror({
-  signed_urls_request: null,
+  signed_urls_request: null
 });
 
 const toClientMessageTypeEnum = keyMirror({
   app_logs: null,
   app_state: null,
   device_stats: null,
-  status_response: null,
+  status_response: null
 });
 
 const toDeviceAgentMessageTypeEnum = keyMirror({
@@ -30,28 +30,28 @@ const toDeviceAgentMessageTypeEnum = keyMirror({
   models_install_response: null,
   live_state_updates: null,
   status_response: null,
-  device_action: null,
+  device_action: null
 });
 
 const appStateEnum = keyMirror({
   up: null,
   stopped: null,
-  restarting: null,
+  restarting: null
 });
 
 const appStateControlEnum = keyMirror({
   start: null,
   stop: null,
-  restart: null,
+  restart: null
 });
 
 const appVersionControlEnum = keyMirror({
   install: null,
-  uninstall: null,
+  uninstall: null
 });
 
 const liveUpdatesEnum = keyMirror({
-  live_updates: null,
+  live_updates: null
 });
 
 const statusEnum = keyMirror({
@@ -59,11 +59,11 @@ const statusEnum = keyMirror({
   in_progress: null,
   failure: null,
   success: null,
-  connection_lost: null,
+  connection_lost: null
 });
 
 const deviceActionEnum = keyMirror({
-  system_restart: null,
+  system_restart: null
 });
 
 export const keyMirrors = {
@@ -75,24 +75,32 @@ export const keyMirrors = {
   appVersionControl: appVersionControlEnum,
   liveUpdates: liveUpdatesEnum,
   statusResponse: statusEnum,
-  deviceAction: deviceActionEnum,
+  deviceAction: deviceActionEnum
 };
 
-export const toCloudMessageTypeValues = Object.values(keyMirrors.toCloudMessageType);
-export type ToCloudMessageTypeValue = keyof typeof keyMirrors.toCloudMessageType;
+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 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 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,
+  keyMirrors.toDeviceAgentMessageType
 );
 export type ToDeviceAgentMessageTypeValue =
   keyof typeof keyMirrors.toDeviceAgentMessageType;
@@ -108,7 +116,8 @@ export type ModelsInstallResponseMessageType =
   typeof toDeviceAgentMessageTypeEnum.models_install_response;
 export type LiveStateUpdatesTogglesMessageType =
   typeof toDeviceAgentMessageTypeEnum.live_state_updates;
-export type DeviceActionMessageType = typeof toDeviceAgentMessageTypeEnum.device_action;
+export type DeviceActionMessageType =
+  typeof toDeviceAgentMessageTypeEnum.device_action;
 
 export const appStateValues = Object.values(keyMirrors.appState);
 export type AppStateValue = keyof typeof keyMirrors.appState;
@@ -116,7 +125,9 @@ 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 const appVersionControlValues = Object.values(
+  keyMirrors.appVersionControl
+);
 export type AppVersionControlValue = keyof typeof keyMirrors.appVersionControl;
 
 export const liveUpdatesValues = Object.values(keyMirrors.liveUpdates);

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

@@ -10,7 +10,8 @@ export interface LiveStateUpdatesTogglePayload {
   };
 }
 
-export interface LiveStateUpdatesToggleMessage extends BaseToDeviceAgentMessage {
+export interface LiveStateUpdatesToggleMessage
+  extends BaseToDeviceAgentMessage {
   messageType: LiveStateUpdatesTogglesMessageType;
   payload: LiveStateUpdatesTogglePayload;
 }

package/src/device-stats-schema.ts

@@ -4,18 +4,18 @@ import { DeviceStatsMessageType } from './constants';
 import { BaseToClientMessage } from './types';
 
 interface CpuDetails {
-  usedPerc: number;
-  temperature: number;
+  usedPerc?: number | null;
+  temperature?: number | null;
 }
 
 interface DiskDetails {
-  usedGb: number;
-  freeGb: number;
+  usedGb?: number | null;
+  freeGb?: number | null;
 }
 
 interface MemDetails {
-  usedMb: number;
-  freeMb: number;
+  usedMb?: number | null;
+  freeMb?: number | null;
 }
 
 export interface DeviceStatsPayload {

package/src/index.ts

@@ -14,7 +14,7 @@ import {
   getToClientTopic,
   getToCloudTopic,
   getToDeviceTopic,
-  validateToCloudMessage,
+  validateToCloudMessage
 } from './types';
 import { generateTxId } from './utils';
 import {
@@ -22,7 +22,7 @@ import {
   AppState,
   ServiceStatus,
   AppStatePayload,
-  AppStateMessage,
+  AppStateMessage
 } from './app-state-schema';
 import { AppLogsPayload, AppLogsMessage } from './app-logs-schema';
 import {
@@ -33,7 +33,7 @@ import {
   AppVersionControlInstallPayload,
   AppVersionControlUninstallPayload,
   AppVersionControlMessage,
-  ModelInstallPayload,
+  ModelInstallPayload
 } from './app-action-schema';
 import {
   ToClientMessageTypeValue,
@@ -48,23 +48,22 @@ import {
   SignedUrlsRequestMessageType,
   StatusResponseMessageType,
   StatusResponseValue,
-  ToCloudMessageTypeValue,
+  ToCloudMessageTypeValue
 } from './constants';
 import {
   LiveStateUpdatesTogglePayload,
-  LiveStateUpdatesToggleMessage,
+  LiveStateUpdatesToggleMessage
 } from './device-agent-action-schema';
 import { DeviceStatsPayload, DeviceStatsMessage } from './device-stats-schema';
 import {
   StatusResponsePayload,
   ToClientStatusResponseMessage,
-  ToDeviceStatusResponseMessage,
+  ToDeviceStatusResponseMessage
 } from './status-response-schema';
 import {
   SignedUrlsRequestPayload,
-  SignedUrlsRequestMessage,
+  SignedUrlsRequestMessage
 } from './signed-urls-request-schema';
-import { SystemInformationPayload } from './system-information-schema';
 import { DeviceActionPayload } from './device-action-schema';
 import {
   buildAppLogsMessage,
@@ -76,20 +75,40 @@ import {
   buildDeviceStatsMessage,
   buildSignedUrlsRequestMessage,
   buildToClientStatusResponseMessage,
-  buildToDeviceStatusResponseMessage,
+  buildToDeviceStatusResponseMessage
 } from './message-builders';
+import {
+  ProjectShadowUpdate,
+  ShadowProjectsUpdateAll,
+  validateProjectShadowUpdate,
+  validateShadowProjectsUpdateAll,
+  SystemInformationShadowUpdate,
+  validateSystemInformationShadowUpdate,
+  buildBaseShadowMessage,
+  buildUpdateProjectShadowMessage,
+  buildUpdateSystemInfoShadowMessage,
+  ShadowTopics,
+  ShadowNames,
+  getShadowTopic,
+  getDesiredFromMessage
+} from './shadow-schema';
 
 export {
   // getters
   getToClientTopic,
   getToCloudTopic,
   getToDeviceTopic,
+  getShadowTopic,
+  getDesiredFromMessage,
   // types
   AppDetails,
   ServiceStatus,
   AppState,
   AppStateControlValue,
   AppStateValue,
+  ProjectShadowUpdate,
+  ShadowProjectsUpdateAll,
+  SystemInformationShadowUpdate,
   // messageTypes
   ToCloudMessageTypeValue,
   AppStateControlMessageType,
@@ -121,9 +140,6 @@ export {
   ModelsInstallResponsePayload,
   SignedUrlsRequestPayload,
   SignedUrlsRequestMessage,
-  SystemInformationPayload,
-  DeviceActionPayload,
-  // generic messages
   BaseToDeviceAgentMessage,
   ToDeviceAgentMessage,
   ToDeviceAgentMessagePayload,
@@ -135,10 +151,14 @@ export {
   BaseToCloudMessage,
   ToCloudMessage,
   ToCloudMessagePayload,
+  DeviceActionPayload,
   // message validators
   validateToDeviceAgentMessage,
   validateToClientMessage,
   validateToCloudMessage,
+  validateShadowProjectsUpdateAll,
+  validateProjectShadowUpdate,
+  validateSystemInformationShadowUpdate,
   // message builders
   buildAppLogsMessage,
   buildAppStateMessage,
@@ -150,8 +170,13 @@ export {
   buildLiveStateUpdatesToggleMessage,
   buildAppStateControlMessage,
   buildDeviceActionMessage,
+  buildBaseShadowMessage,
+  buildUpdateProjectShadowMessage,
+  buildUpdateSystemInfoShadowMessage,
   // key mirrors
   keyMirrors,
+  ShadowTopics,
+  ShadowNames,
   // utilities
-  generateTxId,
+  generateTxId
 };

package/src/message-builders.ts

@@ -3,7 +3,7 @@ import {
   AppStateControlPayload,
   AppVersionControlInstallPayload,
   AppVersionControlMessage,
-  AppVersionControlUninstallPayload,
+  AppVersionControlUninstallPayload
 } from './app-action-schema';
 import { AppLogsMessage, AppLogsPayload } from './app-logs-schema';
 import { AppStateMessage, AppStatePayload } from './app-state-schema';
@@ -13,19 +13,22 @@ import {
   DeviceStatsMessageType,
   SignedUrlsRequestMessageType,
   StatusResponseMessageType,
-  keyMirrors,
+  keyMirrors
 } from './constants';
-import { DeviceActionMessage, DeviceActionPayload } from './device-action-schema';
+import {
+  DeviceActionMessage,
+  DeviceActionPayload
+} from './device-action-schema';
 import {
   LiveStateUpdatesToggleMessage,
-  LiveStateUpdatesTogglePayload,
+  LiveStateUpdatesTogglePayload
 } from './device-agent-action-schema';
 import { DeviceStatsMessage, DeviceStatsPayload } from './device-stats-schema';
 import { SignedUrlsRequestMessage } from './signed-urls-request-schema';
 import {
   StatusResponsePayload,
   ToClientStatusResponseMessage,
-  ToDeviceStatusResponseMessage,
+  ToDeviceStatusResponseMessage
 } from './status-response-schema';
 import {
   BaseToClientMessage,
@@ -34,37 +37,43 @@ import {
   ToCloudMessagePayload,
   getToClientTopic,
   getToCloudTopic,
-  getToDeviceTopic,
+  getToDeviceTopic
 } from './types';
 
-function buildBaseToClientMessage(clientId: string, txId: string): BaseToClientMessage {
+function buildBaseToClientMessage(
+  clientId: string,
+  txId: string
+): BaseToClientMessage {
   const baseClientMessage = {
     timestamp: new Date().toUTCString(),
     deviceId: clientId,
     topic: getToClientTopic(clientId),
-    txId,
+    txId
   };
   return baseClientMessage;
 }
 
 function buildBaseToDeviceMessage(
   deviceId: string,
-  txId: string,
+  txId: string
 ): BaseToDeviceAgentMessage {
   const baseToDeviceMessage = {
     timestamp: new Date().toUTCString(),
     topic: getToDeviceTopic(deviceId),
-    txId,
+    txId
   };
   return baseToDeviceMessage;
 }
 
-function buildBaseToCloudMessage(deviceId: string, txId: string): BaseToCloudMessage {
+function buildBaseToCloudMessage(
+  deviceId: string,
+  txId: string
+): BaseToCloudMessage {
   const baseToCloudMessage = {
     deviceId,
     timestamp: new Date().toUTCString(),
     topic: getToCloudTopic(deviceId),
-    txId,
+    txId
   };
   return baseToCloudMessage;
 }
@@ -75,14 +84,15 @@ function buildBaseToCloudMessage(deviceId: string, txId: string): BaseToCloudMes
 function buildAppLogsMessage(
   clientId: string,
   payload: AppLogsPayload,
-  txId: string,
+  txId: string
 ): AppLogsMessage {
   const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const messageType: AppLogsMessageType = keyMirrors.toClientMessageType.app_logs;
+  const messageType: AppLogsMessageType =
+    keyMirrors.toClientMessageType.app_logs;
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -91,14 +101,15 @@ function buildAppLogsMessage(
 function buildAppStateMessage(
   clientId: string,
   payload: AppStatePayload,
-  txId: string,
+  txId: string
 ): AppStateMessage {
   const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const messageType: AppStateMessageType = keyMirrors.toClientMessageType.app_state;
+  const messageType: AppStateMessageType =
+    keyMirrors.toClientMessageType.app_state;
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -107,7 +118,7 @@ function buildAppStateMessage(
 function buildToClientStatusResponseMessage(
   clientId: string,
   payload: StatusResponsePayload,
-  txId: string,
+  txId: string
 ): ToClientStatusResponseMessage {
   const baseMessage = buildBaseToClientMessage(clientId, txId);
   const messageType: StatusResponseMessageType =
@@ -115,7 +126,7 @@ function buildToClientStatusResponseMessage(
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -124,14 +135,15 @@ function buildToClientStatusResponseMessage(
 function buildDeviceStatsMessage(
   clientId: string,
   payload: DeviceStatsPayload,
-  txId: string,
+  txId: string
 ): DeviceStatsMessage {
-  const messageType: DeviceStatsMessageType = keyMirrors.toClientMessageType.device_stats;
+  const messageType: DeviceStatsMessageType =
+    keyMirrors.toClientMessageType.device_stats;
   const baseMessage = buildBaseToClientMessage(clientId, txId);
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -142,7 +154,7 @@ function buildDeviceStatsMessage(
 function buildToDeviceStatusResponseMessage(
   clientId: string,
   payload: StatusResponsePayload,
-  txId: string,
+  txId: string
 ): ToDeviceStatusResponseMessage {
   const baseMessage = buildBaseToDeviceMessage(clientId, txId);
   const messageType: StatusResponseMessageType =
@@ -150,7 +162,7 @@ function buildToDeviceStatusResponseMessage(
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -159,14 +171,14 @@ function buildToDeviceStatusResponseMessage(
 function buildAppVersionControlMessage(
   deviceId: string,
   payload: AppVersionControlInstallPayload | AppVersionControlUninstallPayload,
-  txId: string,
+  txId: string
 ): AppVersionControlMessage {
   const messageType = keyMirrors.toDeviceAgentMessageType.app_version_control;
   const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -175,14 +187,14 @@ function buildAppVersionControlMessage(
 function buildLiveStateUpdatesToggleMessage(
   deviceId: string,
   payload: LiveStateUpdatesTogglePayload,
-  txId: string,
+  txId: string
 ): LiveStateUpdatesToggleMessage {
   const messageType = keyMirrors.toDeviceAgentMessageType.live_state_updates;
   const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -191,14 +203,14 @@ function buildLiveStateUpdatesToggleMessage(
 function buildAppStateControlMessage(
   deviceId: string,
   payload: AppStateControlPayload,
-  txId: string,
+  txId: string
 ): AppStateControlMessage {
   const messageType = keyMirrors.toDeviceAgentMessageType.app_state_control;
   const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -206,14 +218,14 @@ function buildAppStateControlMessage(
 function buildDeviceActionMessage(
   deviceId: string,
   payload: DeviceActionPayload,
-  txId: string,
+  txId: string
 ): DeviceActionMessage {
   const messageType = keyMirrors.toDeviceAgentMessageType.device_action;
   const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -224,7 +236,7 @@ function buildDeviceActionMessage(
 function buildSignedUrlsRequestMessage(
   clientId: string,
   payload: ToCloudMessagePayload,
-  txId: string,
+  txId: string
 ): SignedUrlsRequestMessage {
   const baseMessage = buildBaseToCloudMessage(clientId, txId);
   const messageType: SignedUrlsRequestMessageType =
@@ -232,7 +244,7 @@ function buildSignedUrlsRequestMessage(
   const message = {
     ...baseMessage,
     messageType,
-    payload,
+    payload
   };
   return message;
 }
@@ -247,5 +259,5 @@ export {
   buildAppVersionControlMessage,
   buildLiveStateUpdatesToggleMessage,
   buildAppStateControlMessage,
-  buildDeviceActionMessage,
+  buildDeviceActionMessage
 };

package/src/schemas/device-stats-schema.json

@@ -21,10 +21,16 @@
       "description": "CPU utilization information",
       "properties": {
         "usedPerc": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         },
         "temperature": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         }
       }
     },
@@ -33,10 +39,16 @@
       "description": "Disk utilization information",
       "properties": {
         "usedGb": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         },
         "freeGb": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         }
       }
     },
@@ -45,10 +57,16 @@
       "description": "Memory utilization information",
       "properties": {
         "usedMb": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         },
         "freeMb": {
-          "type": "number"
+          "type": [
+            "number",
+            "null"
+          ]
         }
       }
     }

package/src/schemas/shadow-project-update-schema.json

@@ -0,0 +1,30 @@
+{
+  "$id": "https://alwaysai.co/shadow-project-update-schema.json",
+  "title": "shadow_project_update_schema",
+  "description": "The messaging payload structure for a all properties of a single project shadow update",
+  "type": "object",
+  "nullable": true,
+  "properties": {
+    "appConfig": {
+      "type": "string"
+    },
+    "envVars": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "patternProperties":{
+            ".*": {
+              "type": ["string", "null"]
+            }
+          },
+          "required": []
+        }
+      },
+      "required": [],
+      "additionalProperties": true
+    }
+  },
+  "required": [],
+  "additionalProperties": true
+}

package/src/schemas/shadow-projects-update-all-schema.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://alwaysai.co/shadow-projects-update-all-schema.json",
+  "title": "shadow-projects-update-all",
+  "description": "The messaging payload structure for shadow's projects update delta",
+  "type": "object",
+  "patternProperties": {
+    ".*": {
+      "type": ["object","null"],
+      "$ref": "https://alwaysai.co/shadow-project-update-schema.json"
+    }
+  },
+  "propertyNames": {
+    "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
+  },
+  "required": [],
+  "additionalProperties": true
+}