@alwaysai/device-agent-schemas 2.4.2 → 3.0.0

package/lib/index.d.ts

@@ -10,6 +10,6 @@ import { StatusResponsePayload, ToClientStatusResponseMessage, ToDeviceStatusRes
 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 } from './shadow-schema';
-export { getToClientTopic, getToCloudTopic, getToDeviceTopic, getShadowTopic, getDesiredFromMessage, getReportedFromMessage, getUpdateDeltaStateFromMessage, AppDetails, ServiceStatus, AppState, AppStateControlValue, AppStateValue, ProjectShadowUpdate, ShadowProjectsUpdateAll, SystemInformationShadowUpdate, SecureTunnelPortInfo, SecureTunnelShadowUpdate, 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, buildAppLogsMessage, buildAppStateMessage, buildDeviceStatsMessage, buildSignedUrlsRequestMessage, buildToClientStatusResponseMessage, buildToDeviceStatusResponseMessage, buildAppVersionControlMessage, buildLiveStateUpdatesToggleMessage, buildAppStateControlMessage, buildDeviceActionMessage, buildBaseShadowMessage, buildUpdateShadowMessage, keyMirrors, ShadowTopics, ShadowNames, generateTxId };
+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 };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTxId = exports.ShadowTopics = exports.keyMirrors = exports.buildUpdateShadowMessage = exports.buildBaseShadowMessage = exports.buildDeviceActionMessage = exports.buildAppStateControlMessage = exports.buildLiveStateUpdatesToggleMessage = exports.buildAppVersionControlMessage = exports.buildToDeviceStatusResponseMessage = exports.buildToClientStatusResponseMessage = exports.buildSignedUrlsRequestMessage = exports.buildDeviceStatsMessage = exports.buildAppStateMessage = exports.buildAppLogsMessage = exports.validateSecureTunnelShadowUpdate = exports.validateSystemInformationShadowUpdate = exports.validateProjectShadowUpdate = exports.validateShadowProjectsUpdateAll = exports.validateToCloudMessage = exports.validateToClientMessage = exports.validateToDeviceAgentMessage = exports.getUpdateDeltaStateFromMessage = exports.getReportedFromMessage = exports.getDesiredFromMessage = exports.getShadowTopic = exports.getToDeviceTopic = exports.getToCloudTopic = exports.getToClientTopic = void 0;
+exports.generateTxId = exports.ShadowTopics = exports.keyMirrors = exports.buildUpdateShadowMessage = exports.buildBaseShadowMessage = exports.buildDeviceActionMessage = exports.buildAppStateControlMessage = exports.buildLiveStateUpdatesToggleMessage = exports.buildAppVersionControlMessage = exports.buildToDeviceStatusResponseMessage = exports.buildToClientStatusResponseMessage = exports.buildSignedUrlsRequestMessage = exports.buildDeviceStatsMessage = exports.buildAppStateMessage = exports.buildAppLogsMessage = exports.validateEnvVarSchemaShadowUpdate = exports.validateSecureTunnelShadowUpdate = exports.validateSystemInformationShadowUpdate = exports.validateProjectShadowUpdate = exports.validateShadowProjectsUpdateAll = exports.validateToCloudMessage = exports.validateToClientMessage = exports.validateToDeviceAgentMessage = exports.getUpdateDeltaStateFromMessage = exports.getReportedFromMessage = exports.getDesiredFromMessage = exports.getShadowTopic = exports.getToDeviceTopic = exports.getToCloudTopic = exports.getToClientTopic = void 0;
 // export types here
 const types_1 = require("./types");
 Object.defineProperty(exports, "validateToDeviceAgentMessage", { enumerable: true, get: function () { return types_1.validateToDeviceAgentMessage; } });
@@ -36,4 +36,5 @@ Object.defineProperty(exports, "getShadowTopic", { enumerable: true, get: functi
 Object.defineProperty(exports, "getDesiredFromMessage", { enumerable: true, get: function () { return shadow_schema_1.getDesiredFromMessage; } });
 Object.defineProperty(exports, "getReportedFromMessage", { enumerable: true, get: function () { return shadow_schema_1.getReportedFromMessage; } });
 Object.defineProperty(exports, "getUpdateDeltaStateFromMessage", { enumerable: true, get: function () { return shadow_schema_1.getUpdateDeltaStateFromMessage; } });
+Object.defineProperty(exports, "validateEnvVarSchemaShadowUpdate", { enumerable: true, get: function () { return shadow_schema_1.validateEnvVarSchemaShadowUpdate; } });
 //# sourceMappingURL=index.js.map

package/lib/schemas/env-var-schema.json

@@ -0,0 +1,18 @@
+{
+    "$id": "https://alwaysai.co/env-var-schema.json",
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "title": "env-var",
+    "type": "object",
+    "patternProperties": {
+        ".*": {
+            "type": "object",
+            "patternProperties": {
+                "^[^\\s]+$": {
+                    "type": "string"
+                }
+            },
+            "additionalProperties": false
+        }
+    },
+    "additionalProperties": false
+}

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

@@ -0,0 +1,30 @@
+{
+    "$id": "https://alwaysai.co/shadow-project-update-legacy-schema.json",
+    "title": "shadow_project_update_legacy_schema",
+    "description": "[LEGACY] The messaging payload structure for 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/lib/schemas/shadow-project-update-schema.json

@@ -9,20 +9,7 @@
             "type": "string"
         },
         "envVars": {
-            "type": "object",
-            "patternProperties": {
-                ".*": {
-                    "type": "object",
-                    "patternProperties": {
-                        ".*": {
-                            "type": ["string", "null"]
-                        }
-                    },
-                    "required": []
-                }
-            },
-            "required": [],
-            "additionalProperties": true
+            "type": "string"
         }
     },
     "required": [],

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

@@ -6,7 +6,10 @@
     "patternProperties": {
         ".*": {
             "type": ["object", "null"],
-            "$ref": "https://alwaysai.co/shadow-project-update-schema.json"
+            "anyOf": [
+                { "$ref": "https://alwaysai.co/shadow-project-update-schema.json" },
+                { "$ref": "https://alwaysai.co/shadow-project-update-legacy-schema.json" }
+            ]
         }
     },
     "propertyNames": {

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

@@ -44,16 +44,16 @@
                     "type": "string"
                 },
                 "cores": {
-                    "type": "number"
+                    "type": "string"
                 },
                 "physicalCores": {
-                    "type": "number"
+                    "type": "string"
                 },
                 "efficiencyCores": {
-                    "type": "number"
+                    "type": "string"
                 },
                 "processors": {
-                    "type": "number"
+                    "type": "string"
                 }
             },
             "additionalProperties": false
@@ -79,13 +79,15 @@
                                 "type": "string"
                             },
                             "size": {
-                                "type": "number"
+                                "type": "string"
                             }
-                        }
+                        },
+                        "additionalProperties": false
                     }
                 }
             },
-            "additionalProperties": false
+            "additionalProperties": false,
+            "required": []
         },
         "device": {
             "type": "object",

package/lib/shadow-schema.d.ts

@@ -25,6 +25,10 @@ export declare const SHADOW_NAMES: ("secure-tunnel" | "projects" | "system-info"
 export declare const getShadowTopic: (clientId: string, shadowName: ShadowNames, shadowTopic: ShadowTopics) => string;
 export declare type ShadowUpdateTypes = ShadowProjectsUpdateAll | SystemInformationShadowUpdate | SecureTunnelShadowUpdate;
 export interface ProjectShadowUpdate {
+    appConfig?: string;
+    envVars?: string;
+}
+export interface ProjectShadowUpdateLegacy {
     appConfig?: string;
     envVars?: {
         [service: string]: {
@@ -36,6 +40,7 @@ export interface ShadowProjectsUpdateAll {
     [projectId: string]: ProjectShadowUpdate | null;
 }
 export declare const validateProjectShadowUpdate: import("ajv/dist/types").ValidateFunction<ProjectShadowUpdate>;
+export declare const validateLegacyProjectShadowUpdate: import("ajv/dist/types").ValidateFunction<ProjectShadowUpdateLegacy>;
 export declare const validateShadowProjectsUpdateAll: import("ajv/dist/types").ValidateFunction<ShadowProjectsUpdateAll>;
 export interface SystemInformationShadowUpdate {
     os?: {
@@ -51,9 +56,10 @@ export interface SystemInformationShadowUpdate {
         brand?: string;
         vendor?: string;
         model?: string;
-        cores?: number;
-        physicalCores?: number;
-        efficiencyCores?: number;
+        cores?: string;
+        physicalCores?: string;
+        efficiencyCores?: string;
+        processors?: string;
     };
     disk?: {
         drives: {
@@ -61,7 +67,7 @@ export interface SystemInformationShadowUpdate {
             type?: string;
             name?: string;
             vendor?: string;
-            size?: number;
+            size?: string;
         }[];
     };
     device?: {
@@ -87,6 +93,12 @@ export interface SystemInformationShadowUpdate {
     lastBootTime?: string;
 }
 export declare const validateSystemInformationShadowUpdate: import("ajv/dist/types").ValidateFunction<SystemInformationShadowUpdate>;
+export interface EnvVars {
+    [service: string]: {
+        [name: string]: string | null;
+    };
+}
+export declare const validateEnvVarSchemaShadowUpdate: import("ajv/dist/types").ValidateFunction<EnvVars>;
 export declare type SecureTunnelPortInfo = {
     enabled: boolean;
     type: string;

package/lib/shadow-schema.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildBaseShadowMessage = exports.buildUpdateShadowMessage = exports.validateSecureTunnelShadowUpdate = exports.validateSystemInformationShadowUpdate = exports.validateShadowProjectsUpdateAll = exports.validateProjectShadowUpdate = exports.getShadowTopic = exports.SHADOW_NAMES = exports.SHADOW_TOPICS = exports.ShadowTopics = exports.getUpdateDeltaStateFromMessage = exports.getReportedFromMessage = exports.getDesiredFromMessage = void 0;
+exports.buildBaseShadowMessage = exports.buildUpdateShadowMessage = exports.validateSecureTunnelShadowUpdate = exports.validateEnvVarSchemaShadowUpdate = exports.validateSystemInformationShadowUpdate = exports.validateShadowProjectsUpdateAll = exports.validateLegacyProjectShadowUpdate = exports.validateProjectShadowUpdate = exports.getShadowTopic = exports.SHADOW_NAMES = exports.SHADOW_TOPICS = exports.ShadowTopics = exports.getUpdateDeltaStateFromMessage = exports.getReportedFromMessage = exports.getDesiredFromMessage = void 0;
 const _2019_1 = require("ajv/dist/2019");
 const shadowProjectsUpdateAllSchema = require("./schemas/shadow-projects-update-all-schema.json");
 const shadowProjectUpdateSchema = require("./schemas/shadow-project-update-schema.json");
+const shadowProjectUpdateLegacySchema = require("./schemas/shadow-project-update-legacy-schema.json");
 const systemInformationSchema = require("./schemas/system-information-schema.json");
 const secureTunnelSchema = require("./schemas/secure-tunnel-schema.json");
 const commonSchema = require("./schemas/common-schema.json");
+const envVarSchema = require("./schemas/env-var-schema.json");
 const utils_1 = require("./utils");
 const ajv = new _2019_1.default({
     allErrors: true,
@@ -66,10 +68,14 @@ exports.getShadowTopic = getShadowTopic;
 // Shadow Message validator functions
 ajv.addSchema(shadowProjectUpdateSchema, 'shadow-project-update-schema.json');
 exports.validateProjectShadowUpdate = ajv.compile(shadowProjectUpdateSchema);
+ajv.addSchema(shadowProjectUpdateLegacySchema, 'shadow-project-update-legacy-schema.json');
+exports.validateLegacyProjectShadowUpdate = ajv.compile(shadowProjectUpdateSchema);
 ajv.addSchema(shadowProjectsUpdateAllSchema, 'shadow-projects-update-all-schema.json');
 exports.validateShadowProjectsUpdateAll = ajv.compile(shadowProjectsUpdateAllSchema);
 ajv.addSchema(systemInformationSchema, 'system-information-schema.json');
 exports.validateSystemInformationShadowUpdate = ajv.compile(systemInformationSchema);
+ajv.addSchema(envVarSchema, 'env-var-schema.json');
+exports.validateEnvVarSchemaShadowUpdate = ajv.compile(envVarSchema);
 ajv.addSchema(secureTunnelSchema, 'secure-tunnel-schema.json');
 exports.validateSecureTunnelShadowUpdate = ajv.compile(secureTunnelSchema);
 /* ============================================================================

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@alwaysai/device-agent-schemas",
   "description": "alwaysAI schemas",
-  "version": "2.4.2",
+  "version": "3.0.0",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [