@alwaysai/device-agent-schemas 3.1.0 → 3.1.2

package/README.md

@@ -1,64 +1,5 @@
 # alwaysAI Device Agent Schemas
 
 ## Contents
-* [Documentation](docs/README.md)
 * [Schemas](src/schemas)
 
-The alwaysAI Device Agent Schemas package provides interfaces that represent the messaging interface for communication with the alwaysAI Device Agent, as well as functions for validating JSON data that are being used as device agent messages.
-
-## Use in Development
-Use the provided interfaces as type guards in your development to ensure that proper messages are generated.
-
-The provided interfaces are:
-
-- DeviceStats,
-- DeviceStatsPayload,
-- AppState,
-- AppStateValue,
-- ServiceStatus,
-- AppDetails,
-- AppStatePayload,
-- InstallationStatus,
-- InstallationStatusMessage,
-- AppLogs,
-- AppLogsPayload,
-- AppStateControlValue,
-- AppVersionControlValue,
-- AppStateControl,
-- AppVersionControl,
-- AppActionMessage,
-- AgentActionValue,
-- LiveUpdatesToggles,
-- DeviceAgentMessage,
-- ClientMessage,
-
-## Runtime Message Validation
-You can also incorporated the provided validation methods to ensure that incoming JSON data are properly formatted at runtime.
-
-`validateDeviceAgentMessage` can be used to validate any package as a whole to verify that it is a valid device agent message. There are more granular validation methods for verifying packets for a specific type of device agent message. These methods are:
-
-- validateDeviceStatsMessage,
-- validateAppStateMessage,
-- validateInstallationStatusMessage,
-- validateAppLogsMessage,
-- validateAppActionMessage,
-- validateAgentActionMessage,
-- validateDeviceAgentMessage,
-- validateClientMessage,
-
-
-## System Requirements
-
-* `npm` >= 7.0.0
-* `node` >= 16.0.0
-
-# Release Process
-
-> **NOTE**: Ensure unit tests are passing and new functionality is verified prior to release!
-
-## Release procedure
-To release the package to [npmjs.org](https://www.npmjs.com/package/@alwaysai/device-agent-schemas) follow the steps:
-
-- publish new version: <code>npm run publish:<major|minor|patch></code>
-- watch the [bitbucket pipeline](https://bitbucket.org/alwaysai/device-agent-schemas/pipelines) running, if successful a new version will be created and published to npmjs.org
-- to get the auto-generated commit and tags, simply pull: <code>git pull</code>

package/lib/app-action-schema.d.ts

@@ -1,5 +1,5 @@
 import { AppInstallResponseMessageType, AppStateControlMessageType, AppStateControlValue, AppVersionControlMessageType, ModelsInstallResponseMessageType, keyMirrors } from './constants';
-import { BaseToDeviceAgentMessage } from './types';
+import { BaseToDeviceAgentMessage } from './common';
 export interface AppStateControlPayload {
     baseCommand: AppStateControlValue;
     projectId: string;
@@ -12,6 +12,8 @@ export declare type AppVersionControlInstallPayload = {
     baseCommand: typeof keyMirrors.appVersionControl.install;
     projectId: string;
     appReleaseHash: string;
+    cfg?: string;
+    env_vars?: string;
 };
 export declare type AppVersionControlUninstallPayload = {
     baseCommand: typeof keyMirrors.appVersionControl.uninstall;

package/lib/app-logs-schema.d.ts

@@ -1,5 +1,5 @@
 import { AppLogsMessageType } from './constants';
-import { BaseToClientMessage } from './types';
+import { BaseToClientMessage } from './common';
 export interface AppLogsPayload {
     projectId: string;
     logChunk: string;

package/lib/app-state-schema.d.ts

@@ -1,5 +1,5 @@
 import { AppStateMessageType, AppStateValue } from './constants';
-import { BaseToClientMessage } from './types';
+import { BaseToClientMessage } from './common';
 export interface AppDetails {
     projectId: string;
     version: string;

package/lib/common.d.ts

@@ -0,0 +1,18 @@
+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;
+}
+//# sourceMappingURL=common.d.ts.map

package/lib/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/lib/device-action-schema.d.ts

@@ -1,5 +1,5 @@
 import { DeviceActionMessageType, DeviceActionValue } from './constants';
-import { BaseToDeviceAgentMessage } from './types';
+import { BaseToDeviceAgentMessage } from './common';
 export interface DeviceActionPayload {
     action: DeviceActionValue;
 }

package/lib/device-agent-action-schema.d.ts

@@ -1,5 +1,5 @@
 import { LiveStateUpdatesTogglesMessageType } from './constants';
-import { BaseToDeviceAgentMessage } from './types';
+import { BaseToDeviceAgentMessage } from './common';
 export interface LiveStateUpdatesTogglePayload {
     deviceStats?: boolean;
     appState?: boolean;

package/lib/device-stats-schema.d.ts

@@ -1,5 +1,5 @@
 import { DeviceStatsMessageType } from './constants';
-import { BaseToClientMessage } from './types';
+import { BaseToClientMessage } from './common';
 interface CpuDetails {
     usedPerc?: number;
     temperature?: number;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { validateToDeviceAgentMessage, validateToClientMessage, BaseToDeviceAgentMessage, ToDeviceAgentMessage, ToDeviceAgentMessagePayload, BaseToClientMessage, ToClientMessage, ToClientMessagePayload, BaseToCloudMessage, ToCloudMessage, ToCloudMessagePayload, getToClientTopic, getToCloudTopic, getToDeviceTopic, validateToCloudMessage } from './types';
+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';
@@ -11,5 +11,5 @@ import { SignedUrlsRequestPayload, SignedUrlsRequestMessage } from './signed-url
 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 { getToClientTopic, getToCloudTopic, getToDeviceTopic, getShadowTopic, getDesiredFromMessage, getReportedFromMessage, getUpdateDeltaStateFromMessage, AppDetails, ServiceStatus, AppState, AppStateControlValue, AppStateValue, ProjectShadowUpdate, ShadowProjectsUpdateAll, SystemInformationShadowUpdate, SecureTunnelPortInfo, SecureTunnelShadowUpdate, EnvVars, ToCloudMessageTypeValue, AppStateControlMessageType, AppLogsMessageType, DeviceStatsMessageType, AppStateMessageType, SignedUrlsRequestMessageType, StatusResponseMessageType, ShadowUpdateTypes, ModelInstallPayload, ToClientStatusResponseMessage, ToDeviceStatusResponseMessage, StatusResponseValue, AppStateControlMessage, LiveStateUpdatesTogglePayload, LiveStateUpdatesToggleMessage, DeviceStatsPayload, DeviceStatsMessage, AppStatePayload, AppStateMessage, AppLogsPayload, AppLogsMessage, StatusResponsePayload, AppStateControlPayload, AppVersionControlInstallPayload, AppVersionControlUninstallPayload, AppVersionControlMessage, AppInstallResponsePayload, ModelsInstallResponsePayload, SignedUrlsRequestPayload, SignedUrlsRequestMessage, BaseToDeviceAgentMessage, ToDeviceAgentMessage, ToDeviceAgentMessagePayload, ToDeviceAgentMessageTypeValue, BaseToClientMessage, ToClientMessage, ToClientMessagePayload, ToClientMessageTypeValue, BaseToCloudMessage, ToCloudMessage, ToCloudMessagePayload, DeviceActionPayload, validateToDeviceAgentMessage, validateToClientMessage, validateToCloudMessage, validateShadowProjectsUpdateAll, validateProjectShadowUpdate, validateSystemInformationShadowUpdate, validateSecureTunnelShadowUpdate, validateEnvVarSchemaShadowUpdate, buildAppLogsMessage, buildAppStateMessage, buildDeviceStatsMessage, buildSignedUrlsRequestMessage, buildToClientStatusResponseMessage, buildToDeviceStatusResponseMessage, buildAppVersionControlMessage, buildLiveStateUpdatesToggleMessage, buildAppStateControlMessage, buildDeviceActionMessage, buildBaseShadowMessage, buildUpdateShadowMessage, keyMirrors, ShadowTopics, ShadowNames, generateTxId };
+export { getToClientTopic, getToCloudTopic, getToDeviceTopic, getShadowTopic, getDesiredFromMessage, getReportedFromMessage, getUpdateDeltaStateFromMessage, AppDetails, ServiceStatus, AppState, AppStateControlValue, AppStateValue, ProjectShadowUpdate, ShadowProjectsUpdateAll, SystemInformationShadowUpdate, SecureTunnelPortInfo, SecureTunnelShadowUpdate, EnvVars, ToCloudMessageTypeValue, AppStateControlMessageType, AppLogsMessageType, DeviceStatsMessageType, AppStateMessageType, SignedUrlsRequestMessageType, StatusResponseMessageType, ShadowUpdateTypes, ModelInstallPayload, ToClientStatusResponseMessage, ToDeviceStatusResponseMessage, StatusResponseValue, AppStateControlMessage, LiveStateUpdatesTogglePayload, LiveStateUpdatesToggleMessage, DeviceStatsPayload, DeviceStatsMessage, AppStatePayload, AppStateMessage, AppLogsPayload, AppLogsMessage, StatusResponsePayload, AppStateControlPayload, AppVersionControlInstallPayload, AppVersionControlUninstallPayload, AppVersionControlMessage, AppInstallResponsePayload, ModelsInstallResponsePayload, SignedUrlsRequestPayload, SignedUrlsRequestMessage, ToDeviceAgentMessage, ToDeviceAgentMessagePayload, ToDeviceAgentMessageTypeValue, ToClientMessage, ToClientMessagePayload, ToClientMessageTypeValue, ToCloudMessage, ToCloudMessagePayload, DeviceActionPayload, validateToDeviceAgentMessage, validateToClientMessage, validateToCloudMessage, validateShadowProjectsUpdateAll, validateProjectShadowUpdate, validateSystemInformationShadowUpdate, validateSecureTunnelShadowUpdate, validateEnvVarSchemaShadowUpdate, buildAppLogsMessage, buildAppStateMessage, buildDeviceStatsMessage, buildSignedUrlsRequestMessage, buildToClientStatusResponseMessage, buildToDeviceStatusResponseMessage, buildAppVersionControlMessage, buildLiveStateUpdatesToggleMessage, buildAppStateControlMessage, buildDeviceActionMessage, buildBaseShadowMessage, buildUpdateShadowMessage, keyMirrors, ShadowTopics, ShadowNames, generateTxId };
 //# sourceMappingURL=index.d.ts.map

package/lib/schemas/app-install-response-schema.json

@@ -20,8 +20,7 @@
                             "type": "string"
                         }
                     },
-                    "required": ["appSignedUrl"],
-                    "additionalProperties": false
+                    "required": ["appSignedUrl"]
                 },
                 "modelsInstallPayload": {
                     "$ref": "https://alwaysai.co/models-install-payload-schema.json"
@@ -32,10 +31,8 @@
                 "appReleaseHash",
                 "appInstallPayload",
                 "modelsInstallPayload"
-            ],
-            "additionalProperties": false
+            ]
         }
     },
-    "required": ["appInstallResponse"],
-    "additionalProperties": false
+    "required": ["appInstallResponse"]
 }

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

@@ -13,8 +13,13 @@
         },
         "appReleaseHash": {
             "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
+        },
+        "appConfig": {
+            "type": "string"
+        },
+        "envVars": {
+            "type": "string"
         }
     },
-    "required": ["baseCommand", "projectId", "appReleaseHash"],
-    "additionalProperties": false
+    "required": ["baseCommand", "projectId", "appReleaseHash"]
 }

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

@@ -11,6 +11,5 @@
             "type": "string"
         }
     },
-    "required": ["projectId", "logChunk"],
-    "additionalProperties": false
+    "required": ["projectId", "logChunk"]
 }

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

@@ -12,6 +12,5 @@
             "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
         }
     },
-    "required": ["baseCommand", "projectId"],
-    "additionalProperties": false
+    "required": ["baseCommand", "projectId"]
 }

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

@@ -19,7 +19,6 @@
                                 "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
                             }
                         },
-                        "additionalProperties": false,
                         "required": ["projectId", "version"]
                     },
                     "services": {
@@ -34,16 +33,13 @@
                                     "enum": ["up", "stopped", "restarting"]
                                 }
                             },
-                            "additionalProperties": false,
                             "required": ["name", "state"]
                         }
                     }
                 },
-                "additionalProperties": false,
                 "required": ["appDetails", "services"]
             }
         }
     },
-    "additionalProperties": false,
     "required": ["appState"]
 }

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

@@ -12,6 +12,5 @@
             "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
         }
     },
-    "required": ["baseCommand", "projectId"],
-    "additionalProperties": false
+    "required": ["baseCommand", "projectId"]
 }

package/lib/schemas/device-action-schema.json

@@ -9,6 +9,5 @@
             "enum": ["system_restart"]
         }
     },
-    "required": ["action"],
-    "additionalProperties": false
+    "required": ["action"]
 }

package/lib/schemas/device-agent-status-schema.json

@@ -21,14 +21,12 @@
                     "type": "string"
                 }
             },
-            "additionalProperties": false,
             "required": [
                 "status",
                 "message"
             ]
         }
     },
-    "additionalProperties": false,
     "required": [
         "passthrough"
     ]

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

@@ -53,6 +53,5 @@
             }
         }
     },
-    "additionalProperties": false,
     "required": []
 }

package/lib/schemas/live-updates-toggle-schema.json

@@ -20,10 +20,8 @@
                     "type": "boolean"
                 }
             },
-            "required": ["projectId", "toggle"],
-            "additionalProperties": false
+            "required": ["projectId", "toggle"]
         }
     },
-    "required": [],
-    "additionalProperties": false
+    "required": []
 }

package/lib/schemas/models-install-payload-schema.json

@@ -16,7 +16,6 @@
                 "type": "string"
             }
         },
-        "required": ["id", "version", "modelSignedUrl"],
-        "additionalProperties": false
+        "required": ["id", "version", "modelSignedUrl"]
     }
 }

package/lib/schemas/models-install-response-schema.json

@@ -14,10 +14,8 @@
                     "$ref": "https://alwaysai.co/models-install-payload-schema.json"
                 }
             },
-            "required": ["projectId", "newModels"],
-            "additionalProperties": false
+            "required": ["projectId", "newModels"]
         }
     },
-    "required": ["modelsInstallResponse"],
-    "additionalProperties": false
+    "required": ["modelsInstallResponse"]
 }

package/lib/schemas/secure-tunnel-schema.json

@@ -9,7 +9,6 @@
             "items": {
                 "type": "object",
                 "required": ["enabled", "type", "ip", "port"],
-                "additionalProperties": false,
                 "properties": {
                     "enabled": {
                         "type": "boolean"

package/lib/schemas/shadow-project-update-legacy-schema.json

@@ -18,13 +18,13 @@
                             "type": ["string", "null"]
                         }
                     },
-                    "required": []
+                    "required": [],
+                    "additionalProperties": false
                 }
             },
             "required": [],
-            "additionalProperties": true
+            "additionalProperties": false
         }
     },
-    "required": [],
-    "additionalProperties": true
+    "required": []
 }

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

@@ -12,6 +12,5 @@
             "type": "string"
         }
     },
-    "required": [],
-    "additionalProperties": true
+    "required": []
 }

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

@@ -16,5 +16,5 @@
         "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
     },
     "required": [],
-    "additionalProperties": true
+    "additionalProperties": false
 }

package/lib/schemas/signed-urls-request-schema.json

@@ -14,8 +14,7 @@
                     "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
                 }
             },
-            "required": ["projectId", "appReleaseHash"],
-            "additionalProperties": false
+            "required": ["projectId", "appReleaseHash"]
         },
         "modelsOnlyUrlsRequest": {
             "type": "object",
@@ -33,10 +32,8 @@
                     "additionalProperties": false
                 }
             },
-            "required": ["projectId", "models"],
-            "additionalProperties": false
+            "required": ["projectId", "models"]
         }
     },
-    "required": [],
-    "additionalProperties": false
+    "required": []
 }

package/lib/schemas/status-response-schema.json

@@ -11,6 +11,5 @@
             "type": "string"
         }
     },
-    "required": ["status"],
-    "additionalProperties": false
+    "required": ["status"]
 }

package/lib/schemas/system-information-schema.json

@@ -25,8 +25,7 @@
                 "hostname": {
                     "type": "string"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "cpu": {
             "type": "object",
@@ -55,8 +54,7 @@
                 "processors": {
                     "type": "string"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "disk": {
             "type": "object",
@@ -81,12 +79,10 @@
                             "size": {
                                 "type": "string"
                             }
-                        },
-                        "additionalProperties": false
+                        }
                     }
                 }
             },
-            "additionalProperties": false,
             "required": []
         },
         "device": {
@@ -107,8 +103,7 @@
                 "virtual": {
                     "type": "boolean"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "network": {
             "type": "object",
@@ -122,8 +117,7 @@
                 "macAddress": {
                     "type": "string"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "versions": {
             "type": "object",
@@ -146,12 +140,10 @@
                 "dockerCompose": {
                     "type": "string"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "lastBootTime": {
             "type": "string"
         }
-    },
-    "additionalProperties": false
+    }
 }

package/lib/schemas/to-client-message-schema.json

@@ -28,14 +28,10 @@
             "$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" }
-            ]
+            "type": "object"
         }
     },
+    "required": ["timestamp", "deviceId", "messageType", "txId", "payload"],
     "allOf": [
         {
             "if": {
@@ -86,8 +82,6 @@
             }
         }
     ],
-    "required": ["timestamp", "deviceId", "txId", "payload", "messageType"],
-    "additionalProperties": false,
     "$defs": {
         "toClient": {
             "description": "Messages sent from the device agent to console client",

package/lib/schemas/to-cloud-message-schema.json

@@ -25,9 +25,7 @@
             "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
         },
         "payload": {
-            "oneOf": [
-                { "$ref": "https://alwaysai.co/signed-urls-request-schema.json" }
-            ]
+            "type": "object"
         }
     },
     "allOf": [
@@ -45,7 +43,6 @@
         }
     ],
     "required": ["timestamp", "deviceId", "txId", "payload", "messageType"],
-    "additionalProperties": false,
     "$defs": {
         "toCloud": {
             "description": "Messages sent from the device agent to cloud backend client",

package/lib/schemas/to-device-agent-message-schema.json

@@ -14,6 +14,7 @@
             "enum": [
                 "app_state_control",
                 "app_version_control",
+                "fleet_app_version_control",
                 "app_install_response",
                 "models_install_response",
                 "live_state_updates",
@@ -25,17 +26,10 @@
             "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
         },
         "payload": {
-            "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-response-schema.json" },
-                { "$ref": "https://alwaysai.co/models-install-response-schema.json" },
-                { "$ref": "https://alwaysai.co/live-updates-toggle-schema.json" },
-                { "$ref": "https://alwaysai.co/device-action-schema.json" },
-                { "$ref": "https://alwaysai.co/status-response-schema.json" }
-            ]
+            "type": "object"
         }
     },
+    "required": ["messageType", "timestamp", "txId", "payload"],
     "allOf": [
         {
             "if": {
@@ -122,8 +116,6 @@
             }
         }
     ],
-    "required": ["timestamp", "txId", "payload", "messageType"],
-    "additionalProperties": false,
     "$defs": {
         "toDevice": {
             "description": "Topic on which messages are sent to device agent.",

package/lib/signed-urls-request-schema.d.ts

@@ -1,5 +1,5 @@
 import { SignedUrlsRequestMessageType } from './constants';
-import { BaseToClientMessage } from './types';
+import { BaseToClientMessage } from './common';
 declare type ModelsObject = {
     [modelId: string]: number;
 };

package/lib/status-response-schema.d.ts

@@ -1,5 +1,6 @@
+import { BaseToDeviceAgentMessage } from './common';
 import { StatusResponseMessageType, StatusResponseValue } from './constants';
-import { BaseToClientMessage, BaseToDeviceAgentMessage } from './types';
+import { BaseToClientMessage } from './common';
 export interface StatusResponsePayload {
     status: StatusResponseValue;
     message?: string;

package/lib/types.d.ts

@@ -9,29 +9,12 @@ import { DeviceActionMessage, DeviceActionPayload } from './device-action-schema
 export declare const getToClientTopic: (deviceUuid: string, deviceType?: string) => string;
 export declare const getToCloudTopic: (deviceUuid: string, deviceType?: string) => string;
 export declare const getToDeviceTopic: (deviceUuid: string, deviceType?: string) => string;
-export interface BaseToClientMessage {
-    deviceId: string;
-    timestamp: string;
-    topic?: string;
-    txId: string;
-}
 export declare type ToClientMessage = AppLogsMessage | ToClientStatusResponseMessage | AppStateMessage | DeviceStatsMessage;
 export declare type ToClientMessagePayload = AppLogsPayload | AppStatePayload | DeviceStatsPayload | StatusResponsePayload;
-export declare const validateToClientMessage: import("ajv/dist/types").ValidateFunction<BaseToClientMessage>;
-export interface BaseToCloudMessage {
-    deviceId: string;
-    timestamp: string;
-    topic?: string;
-    txId: string;
-}
+export declare const validateToClientMessage: import("ajv/dist/types").ValidateFunction<ToClientMessage>;
 export declare type ToCloudMessage = SignedUrlsRequestMessage;
 export declare type ToCloudMessagePayload = SignedUrlsRequestPayload;
-export declare const validateToCloudMessage: import("ajv/dist/types").ValidateFunction<BaseToCloudMessage>;
-export interface BaseToDeviceAgentMessage {
-    timestamp: string;
-    topic?: string;
-    txId: string;
-}
+export declare const validateToCloudMessage: import("ajv/dist/types").ValidateFunction<SignedUrlsRequestMessage>;
 export declare type ToDeviceAgentMessage = AppStateControlMessage | AppVersionControlMessage | LiveStateUpdatesToggleMessage | ToDeviceStatusResponseMessage | AppInstallResponseMessage | ModelsInstallResponseMessage | DeviceActionMessage;
 export declare type ToDeviceAgentMessagePayload = AppStateControlPayload | AppVersionControlInstallPayload | AppVersionControlUninstallPayload | LiveStateUpdatesTogglePayload | StatusResponsePayload | AppInstallResponsePayload | ModelsInstallResponsePayload | DeviceActionPayload;
 export declare const validateToDeviceAgentMessage: import("ajv/dist/types").ValidateFunction<ToDeviceAgentMessage>;

package/lib/types.js

@@ -25,6 +25,7 @@ const deviceActionSchema = require("./schemas/device-action-schema.json");
 // automatically be added in the compile step due to $ref usage (and $id lookup)
 const ajv = new _2019_1.default({
     allErrors: true,
+    verbose: true,
     schemas: [commonSchema]
 });
 const getToClientTopic = (deviceUuid, deviceType = constants_1.DEVICE_TYPE) => `${constants_1.CLIENT_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwaysai/device-agent-schemas",
   "description": "alwaysAI schemas",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -18,7 +18,6 @@
     "build:clean": "npm run clean && npm run build",
     "build:watch": "tsc --project . --watch",
     "clean": "rimraf lib packages coverage",
-    "gen-docs": "mkdir -p docs && jsonschema2md -o docs -d src/schemas -e json",
     "lint": "eslint . --ext .ts",
     "lint:fix": "npm run lint -- --fix",
     "test": "npm run lint && npm run test:unit && npm run build:clean",
@@ -29,14 +28,13 @@
     "postversion": "npm publish",
     "publish:major": "git push && git tag -f major && git push -f origin major && git tag -d major",
     "publish:minor": "git push && git tag -f minor && git push -f origin minor && git tag -d minor",
-    "publish:patch": "git push && git tag -f patch && git push -f origin patch && git tag -d patch"
+    "publish:patch": "[ \"$(git rev-parse --abbrev-ref HEAD)\" = \"main\" ] && git pull && git push && git tag -f patch && git push -f origin patch && git tag -d patch || echo \"Error: Not on main branch\""
   },
   "dependencies": {
     "ajv": "8.11.0",
     "uuid": "9.0.0"
   },
   "devDependencies": {
-    "@adobe/jsonschema2md": "^7.1.5",
     "@alwaysai/eslint-config": "^0.1.3",
     "@alwaysai/tsconfig": "^0.0.1",
     "@types/jest": "27.0.3",