@alwaysai/device-agent-schemas 2.0.4 → 2.1.1

package/src/schemas/{device-agent-message-schema.json → to-device-agent-message-schema.json}

@@ -1,7 +1,7 @@
 {
-  "$id": "https://alwaysai.co/device-agent-message-schema.json",
+  "$id": "https://alwaysai.co/to-device-agent-message-schema.json",
   "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "device_agent_message",
+  "title": "to_device_agent_message",
   "description":
     "A schema that describes the message payload structure for messages sent from clients to device agent",
   "type": "object",
@@ -15,8 +15,8 @@
       "enum": [
         "app_state_control",
         "app_version_control",
-        "app_install_cloud_response",
-        "models_install_cloud_response",
+        "app_install_response",
+        "models_install_response",
         "live_state_updates"
       ]
     },
@@ -27,8 +27,8 @@
       "oneOf": [
         { "$ref": "https://alwaysai.co/app-state-control-schema.json" },
         { "$ref": "https://alwaysai.co/app-version-control-schema.json" },
-        { "$ref": "https://alwaysai.co/app-install-cloud-response-schema.json" },
-        { "$ref": "https://alwaysai.co/models-install-cloud-response-schema.json" },
+        { "$ref": "https://alwaysai.co/app-install-response-schema.json" },
+        { "$ref": "https://alwaysai.co/models-install-response-schema.json" },
         { "$ref": "https://alwaysai.co/live-updates-toggle-schema.json" }
       ]
     }
@@ -61,24 +61,24 @@
     {
       "if": {
         "properties": {
-          "messageType": { "const": "app_install_cloud_response" }
+          "messageType": { "const": "app_install_response" }
         }
       },
       "then": {
         "properties": {
-          "payload": {"$ref": "https://alwaysai.co/app-install-cloud-response-schema.json"}
+          "payload": {"$ref": "https://alwaysai.co/app-install-response-schema.json"}
         }
       }
     },
     {
       "if": {
         "properties": {
-          "messageType": { "const": "models_install_cloud_response" }
+          "messageType": { "const": "models_install_response" }
         }
       },
       "then": {
         "properties": {
-          "payload": {"$ref": "https://alwaysai.co/models-install-cloud-response-schema.json"}
+          "payload": {"$ref": "https://alwaysai.co/models-install-response-schema.json"}
         }
       }
     },

package/src/signed-urls-request-schema.ts

@@ -1,5 +1,5 @@
 import { SignedUrlsRequestMessageType } from './constants';
-import { BaseClientMessage } from './types';
+import { BaseToClientMessage } from './types';
 
 type ModelsObject = {
   [modelId: string]: number;
@@ -16,7 +16,7 @@ export interface SignedUrlsRequestPayload {
   };
 }
 
-export interface SignedUrlsRequestMessage extends BaseClientMessage {
+export interface SignedUrlsRequestMessage extends BaseToClientMessage {
   messageType: SignedUrlsRequestMessageType;
   payload: SignedUrlsRequestPayload;
 }

package/src/status-response-schema.ts

@@ -1,12 +1,12 @@
 import { StatusResponseMessageType, StatusResponseValue } from './constants';
-import { BaseClientMessage } from './types';
+import { BaseToClientMessage } from './types';
 
 export interface StatusResponsePayload {
   status: StatusResponseValue;
   message?: string;
 }
 
-export interface StatusResponseMessage extends BaseClientMessage {
+export interface StatusResponseMessage extends BaseToClientMessage {
   messageType: StatusResponseMessageType;
   payload: StatusResponsePayload;
 }

package/src/types.test.ts

@@ -1,19 +1,25 @@
-import { clientMessageTypeValues, deviceAgentMessageTypeValues } from './constants';
 import {
-  validateClientMessage,
-  validateDeviceAgentMessage,
-  getCloudTopic,
-  getClientTopic,
-  getDeviceTopic,
+  toClientMessageTypeValues,
+  toCloudMessageTypeValues,
+  toDeviceAgentMessageTypeValues,
+} from './constants';
+import {
+  validateToClientMessage,
+  validateToDeviceAgentMessage,
+  getToCloudTopic,
+  getToClientTopic,
+  getToDeviceTopic,
+  validateToCloudMessage,
 } from './types';
 import { generateTxId } from './utils';
 
 const validTxId = generateTxId();
-const validClientMessages = [
+
+const validToCloudMessages = [
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getCloudTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToCloudTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'signed_urls_request',
     payload: {
@@ -24,10 +30,72 @@ const validClientMessages = [
       },
     },
   },
+];
+
+const invalidToCloudMessages = [
+  {
+    timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
+    deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
+    topic: getToCloudTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    // missing txId
+    messageType: 'signed_urls_request',
+    payload: {
+      signedUrlsRequest: {
+        projectId: 'b8f8e280-0c59-46e7-911e-7b897263ebc3',
+        appReleaseHash:
+          'c36d58b6a5b5c09e5d46da8a5315f01c20f8c7ff0087b1e31e6e334a702ee8ba',
+      },
+    },
+  },
+  {
+    timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
+    deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
+    topic: getToCloudTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    txId: validTxId,
+    messageType: 'app_logs', // incorrect messageType
+    payload: {
+      signedUrlsRequest: {
+        projectId: 'b8f8e280-0c59-46e7-911e-7b897263ebc3',
+        appReleaseHash:
+          'c36d58b6a5b5c09e5d46da8a5315f01c20f8c7ff0087b1e31e6e334a702ee8ba',
+      },
+    },
+  },
+  {
+    timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
+    deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
+    topic: getToCloudTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    txId: validTxId,
+    messageType: 'signed_urls_request',
+    payload: {
+      signedUrlsRequest: {
+        // missing releaseHash
+        projectId: 'b8f8e280-0c59-46e7-911e-7b897263ebc3',
+      },
+    },
+  },
+  // wrong type -- ToClientMessage
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    txId: validTxId,
+    messageType: 'device_stats',
+    payload: {
+      deviceStats: {
+        cpuUsage: 50,
+        diskUtil: 40,
+        usedMemoryPercentage: 70,
+      },
+    },
+  },
+];
+
+const validToClientMessages = [
+  {
+    timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
+    deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'device_stats',
     payload: {
@@ -39,7 +107,7 @@ const validClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_logs',
     payload: {
@@ -50,7 +118,7 @@ const validClientMessages = [
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_state',
     payload: {
@@ -73,7 +141,7 @@ const validClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'status_response',
     payload: {
@@ -83,7 +151,7 @@ const validClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'status_response',
     payload: {
@@ -115,12 +183,12 @@ const validClientMessages = [
   },
 ];
 
-const invalidClientMessages = [
+const invalidToClientMessages = [
   // invalid txId -> too short
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: '124gabaA',
     messageType: 'device_stats',
     payload: {
@@ -136,7 +204,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'device_stats',
     payload: {
@@ -152,7 +220,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'device_stats',
     payload: {
@@ -167,7 +235,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Mon, 06 Jun 2022 20:21:46 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_state',
     payload: {
@@ -181,7 +249,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_logs',
     payload: {
@@ -194,7 +262,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'status_response',
     payload: {
@@ -206,7 +274,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     messageType: 'status_response',
     payload: {
       txId: validTxId,
@@ -217,7 +285,7 @@ const invalidClientMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
     deviceId: '68195e4f-045c-4a9e-ae50-b87ed4d611f7',
-    topic: getClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToClientTopic('68195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: 'dagagfadb',
     messageType: 'status_response',
     payload: {
@@ -226,10 +294,10 @@ const invalidClientMessages = [
   },
 ];
 
-const validDeviceAgentMessages = [
+const validToDeviceAgentMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'live_state_updates',
     payload: {
@@ -239,7 +307,7 @@ const validDeviceAgentMessages = [
   },
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_state_control',
     payload: {
@@ -249,7 +317,7 @@ const validDeviceAgentMessages = [
   },
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_version_control',
     payload: {
@@ -260,7 +328,7 @@ const validDeviceAgentMessages = [
   },
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_version_control',
     payload: {
@@ -280,10 +348,10 @@ const validDeviceAgentMessages = [
   },
 ];
 
-const invalidDeviceAgentMessages = [
+const invalidToDeviceAgentMessages = [
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'live_updates',
     payload: {
@@ -304,7 +372,7 @@ const invalidDeviceAgentMessages = [
   },
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_state_control',
     payload: {
@@ -315,7 +383,7 @@ const invalidDeviceAgentMessages = [
   // Missing appReleaseHash
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_version_control',
     payload: {
@@ -328,7 +396,7 @@ const invalidDeviceAgentMessages = [
   // Missing projectId
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     txId: validTxId,
     messageType: 'app_version_control',
     payload: {
@@ -340,7 +408,7 @@ const invalidDeviceAgentMessages = [
   // missing txId
   {
     timestamp: 'Fri, 27 May 2022 03:47:15 GMT',
-    topic: getDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
+    topic: getToDeviceTopic('8195e4f-045c-4a9e-ae50-b87ed4d611f7'),
     messageType: 'app_version_control',
     payload: {
       appVersionControl: {
@@ -350,42 +418,74 @@ const invalidDeviceAgentMessages = [
   },
 ];
 
-test('test valid device agent message', () => {
-  validDeviceAgentMessages.forEach((item) => {
-    const valid = validateDeviceAgentMessage(item);
+/* ============================================================================
+                                  Test To Device Agent Message
+============================================================================ */
+
+test('test valid to device agent message', () => {
+  validToDeviceAgentMessages.forEach((item) => {
+    const valid = validateToDeviceAgentMessage(item);
+    if (!valid) {
+      // eslint-disable-next-line no-console
+      console.log(item);
+      // eslint-disable-next-line no-console
+      console.log(validateToDeviceAgentMessage.errors);
+    }
+    expect(valid).toBe(true);
+    expect(item.messageType in toDeviceAgentMessageTypeValues);
+  });
+});
+
+test('test invalid to device agent message', () => {
+  invalidToDeviceAgentMessages.forEach((item) => {
+    expect(validateToDeviceAgentMessage(item)).toBe(false);
+  });
+});
+
+/* ============================================================================
+                                  Test To Cloud Message
+============================================================================ */
+
+test('test valid to cloud message', () => {
+  validToCloudMessages.forEach((item) => {
+    const valid = validateToCloudMessage(item);
     if (!valid) {
       // eslint-disable-next-line no-console
       console.log(item);
       // eslint-disable-next-line no-console
-      console.log(validateDeviceAgentMessage.errors);
+      console.log(validateToCloudMessage.errors);
     }
     expect(valid).toBe(true);
-    expect(item.messageType in deviceAgentMessageTypeValues);
+    expect(item.messageType in toCloudMessageTypeValues);
   });
 });
 
-test('test invalid device agent message', () => {
-  invalidDeviceAgentMessages.forEach((item) => {
-    expect(validateDeviceAgentMessage(item)).toBe(false);
+test('test invalid to cloud message', () => {
+  invalidToCloudMessages.forEach((item) => {
+    expect(validateToCloudMessage(item)).toBe(false);
   });
 });
 
-test('test valid client message', () => {
-  validClientMessages.forEach((item) => {
-    const valid = validateClientMessage(item);
+/* ============================================================================
+                                  Test To Client Message
+============================================================================ */
+
+test('test valid to client message', () => {
+  validToClientMessages.forEach((item) => {
+    const valid = validateToClientMessage(item);
     if (!valid) {
       // eslint-disable-next-line no-console
       console.log(item);
       // eslint-disable-next-line no-console
-      console.log(validateClientMessage.errors);
+      console.log(validateToClientMessage.errors);
     }
     expect(valid).toBe(true);
-    expect(item.messageType in clientMessageTypeValues);
+    expect(item.messageType in toClientMessageTypeValues);
   });
 });
 
-test('test invalid client message', () => {
-  invalidClientMessages.forEach((item) => {
-    expect(validateClientMessage(item)).toBe(false);
+test('test invalid to client message', () => {
+  invalidToClientMessages.forEach((item) => {
+    expect(validateToClientMessage(item)).toBe(false);
   });
 });

package/src/types.ts

@@ -11,27 +11,28 @@ import * as appStateSchema from './schemas/app-state-schema.json';
 import * as appLogsSchema from './schemas/app-logs-schema.json';
 import * as statusResponseSchema from './schemas/status-response-schema.json';
 import * as signedUrlsRequestSchema from './schemas/signed-urls-request-schema.json';
-import * as deviceAgentMessageSchema from './schemas/device-agent-message-schema.json';
+import * as toDeviceAgentMessageSchema from './schemas/to-device-agent-message-schema.json';
 import * as modelsInstallPayloadSchema from './schemas/models-install-payload-schema.json';
 import * as appInstallSchema from './schemas/app-install-schema.json';
 import * as appUninstallSchema from './schemas/app-uninstall-schema.json';
-import * as clientMessageSchema from './schemas/client-message-schema.json';
+import * as toClientMessageSchema from './schemas/to-client-message-schema.json';
+import * as toCloudMessageSchema from './schemas/to-cloud-message-schema.json';
 import * as appStateControlSchema from './schemas/app-state-control-schema.json';
 import * as appVersionControlSchema from './schemas/app-version-control-schema.json';
-import * as appInstallCloudResponseSchema from './schemas/app-install-cloud-response-schema.json';
-import * as modelsInstallCloudResponseSchema from './schemas/models-install-cloud-response-schema.json';
+import * as appInstallResponseSchema from './schemas/app-install-response-schema.json';
+import * as modelsInstallResponseSchema from './schemas/models-install-response-schema.json';
 import * as liveUpdatesTogglesSchema from './schemas/live-updates-toggle-schema.json';
 import { AppLogsMessage, AppLogsPayload } from './app-logs-schema';
 import {
-  AppInstallCloudResponseMessage,
-  AppInstallCloudResponsePayload,
+  AppInstallResponseMessage,
+  AppInstallResponsePayload,
   AppStateControlMessage,
   AppStateControlPayload,
   AppVersionControlInstallPayload,
   AppVersionControlMessage,
   AppVersionControlUninstallPayload,
-  ModelsInstallCloudResponseMessage,
-  ModelsInstallCloudResponsePayload,
+  ModelsInstallResponseMessage,
+  ModelsInstallResponsePayload,
 } from './app-action-schema';
 import {
   LiveStateUpdatesToggleMessage,
@@ -52,87 +53,101 @@ const ajv = new Ajv2019({
   schemas: [commonSchema],
 });
 
-export const getClientTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
+export const getToClientTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
   `${CLIENT_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
 
-export const getCloudTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
+export const getToCloudTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
   `${CLOUD_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
 
-export const getDeviceTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
+export const getToDeviceTopic = (deviceUuid: string, deviceType: string = DEVICE_TYPE) =>
   `${DEVICE_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
 
 /* ============================================================================
-                              Client Message
+                              ToClient Message
 ============================================================================ */
 
-export interface BaseClientMessage {
+export interface BaseToClientMessage {
   deviceId: string;
   timestamp: string;
   topic?: string;
   txId: string;
 }
 
-export type ClientMessage =
+export type ToClientMessage =
   | AppLogsMessage
   | StatusResponseMessage
   | AppStateMessage
-  | SignedUrlsRequestMessage
   | DeviceStatsMessage;
 
-export type ClientMessagePayload =
+export type ToClientMessagePayload =
   | AppLogsPayload
   | AppStatePayload
   | DeviceStatsPayload
-  | StatusResponsePayload
-  | SignedUrlsRequestPayload;
+  | StatusResponsePayload;
 
 ajv.addSchema(deviceStatsSchema, 'device-stats-schema.json');
 ajv.addSchema(appStateSchema, 'app-state-schema.json');
 ajv.addSchema(appLogsSchema, 'app-logs-schema.json');
 ajv.addSchema(statusResponseSchema, 'status-response-schema.json');
+ajv.addSchema(toClientMessageSchema, 'to-client-message-schema.json');
+export const validateToClientMessage =
+  ajv.compile<BaseToClientMessage>(toClientMessageSchema);
+
+/* ============================================================================
+                                  ToCloud Message
+============================================================================ */
+
+export interface BaseToCloudMessage {
+  deviceId: string;
+  timestamp: string;
+  topic?: string;
+  txId: string;
+}
+
+export type ToCloudMessage = SignedUrlsRequestMessage;
+
+export type ToCloudMessagePayload = SignedUrlsRequestPayload;
+
 ajv.addSchema(signedUrlsRequestSchema, 'signed-urls-request-schema.json');
-ajv.addSchema(clientMessageSchema, 'client-message-schema.json');
-export const validateClientMessage = ajv.compile<BaseClientMessage>(clientMessageSchema);
+export const validateToCloudMessage =
+  ajv.compile<BaseToCloudMessage>(toCloudMessageSchema);
 
 /* ============================================================================
-                                  Device Agent Message
+                                  To Device Agent Message
 ============================================================================ */
 
-export interface BaseDeviceAgentMessage {
+export interface BaseToDeviceAgentMessage {
   timestamp: string;
   topic?: string;
   txId: string;
 }
 
-export type DeviceAgentMessage =
+export type ToDeviceAgentMessage =
   | AppStateControlMessage
   | AppVersionControlMessage
   | LiveStateUpdatesToggleMessage
   | StatusResponseMessage
-  | AppInstallCloudResponseMessage
-  | ModelsInstallCloudResponseMessage;
+  | AppInstallResponseMessage
+  | ModelsInstallResponseMessage;
 
-export type DeviceAgentMessagePayload =
+export type ToDeviceAgentMessagePayload =
   | AppStateControlPayload
   | AppVersionControlInstallPayload
   | AppVersionControlUninstallPayload
   | LiveStateUpdatesTogglePayload
   | StatusResponsePayload
-  | AppInstallCloudResponsePayload
-  | ModelsInstallCloudResponsePayload;
+  | AppInstallResponsePayload
+  | ModelsInstallResponsePayload;
 
 ajv.addSchema(modelsInstallPayloadSchema, 'models-install-payload-schema.json');
 ajv.addSchema(appInstallSchema, 'app-install-schema.json');
 ajv.addSchema(appUninstallSchema, 'app-uninstall-schema.json');
 ajv.addSchema(appStateControlSchema, 'app-state-control-schema.json');
 ajv.addSchema(appVersionControlSchema, 'app-version-control-schema.json');
-ajv.addSchema(appInstallCloudResponseSchema, 'app-install-cloud-response-schema.json');
-ajv.addSchema(
-  modelsInstallCloudResponseSchema,
-  'model-install-cloud-response-schema.json',
-);
+ajv.addSchema(appInstallResponseSchema, 'app-install-response-schema.json');
+ajv.addSchema(modelsInstallResponseSchema, 'models-install-response-schema.json');
 ajv.addSchema(liveUpdatesTogglesSchema, 'live-updates-toggle-schema.json');
 
-export const validateDeviceAgentMessage = ajv.compile<DeviceAgentMessage>(
-  deviceAgentMessageSchema,
+export const validateToDeviceAgentMessage = ajv.compile<ToDeviceAgentMessage>(
+  toDeviceAgentMessageSchema,
 );