@alwaysai/device-agent-schemas 2.3.2 → 2.3.4

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (C) alwaysAI, Inc - All Rights Reserved
+
+Use of this source and application via any medium is strictly prohibited if you
+are not an alwaysAI commercial customer in good standing
+
+alwaysAI retains copyright to the source and any derivations thereof
+
+This license file must always be included with the source of this project
+
+Proprietary and confidential
+
+Written by alwaysAI developers <dev@alwaysai.co>, 2024

package/README.md

@@ -50,4 +50,15 @@ You can also incorporated the provided validation methods to ensure that incomin
 ## System Requirements
 
 * `npm` >= 7.0.0
-* `node` >= 16.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/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, validateSystemInformationShadowUpdate, buildBaseShadowMessage, buildUpdateProjectShadowMessage, buildUpdateSystemInfoShadowMessage, ShadowTopics, ShadowNames, getShadowTopic, getDesiredFromMessage } from './shadow-schema';
-export { getToClientTopic, getToCloudTopic, getToDeviceTopic, getShadowTopic, getDesiredFromMessage, AppDetails, ServiceStatus, AppState, AppStateControlValue, AppStateValue, ProjectShadowUpdate, ShadowProjectsUpdateAll, SystemInformationShadowUpdate, ToCloudMessageTypeValue, AppStateControlMessageType, AppLogsMessageType, DeviceStatsMessageType, AppStateMessageType, SignedUrlsRequestMessageType, StatusResponseMessageType, 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, buildAppLogsMessage, buildAppStateMessage, buildDeviceStatsMessage, buildSignedUrlsRequestMessage, buildToClientStatusResponseMessage, buildToDeviceStatusResponseMessage, buildAppVersionControlMessage, buildLiveStateUpdatesToggleMessage, buildAppStateControlMessage, buildDeviceActionMessage, buildBaseShadowMessage, buildUpdateProjectShadowMessage, buildUpdateSystemInfoShadowMessage, keyMirrors, ShadowTopics, ShadowNames, generateTxId };
+import { ProjectShadowUpdate, ShadowProjectsUpdateAll, validateProjectShadowUpdate, validateShadowProjectsUpdateAll, SystemInformationShadowUpdate, SecureTunnelPortInfo, SecureTunnelShadowDescriptionReported, validateSecureTunnelShadowUpdate, validateSystemInformationShadowUpdate, buildBaseShadowMessage, buildUpdateProjectShadowMessage, buildUpdateSystemInfoShadowMessage, buildUpdateSecureTunnelShadowMessage, ShadowTopics, ShadowNames, getShadowTopic, getDesiredFromMessage } from './shadow-schema';
+export { getToClientTopic, getToCloudTopic, getToDeviceTopic, getShadowTopic, getDesiredFromMessage, AppDetails, ServiceStatus, AppState, AppStateControlValue, AppStateValue, ProjectShadowUpdate, ShadowProjectsUpdateAll, SystemInformationShadowUpdate, SecureTunnelPortInfo, SecureTunnelShadowDescriptionReported, ToCloudMessageTypeValue, AppStateControlMessageType, AppLogsMessageType, DeviceStatsMessageType, AppStateMessageType, SignedUrlsRequestMessageType, StatusResponseMessageType, 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, buildUpdateProjectShadowMessage, buildUpdateSystemInfoShadowMessage, buildUpdateSecureTunnelShadowMessage, 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.buildUpdateSystemInfoShadowMessage = exports.buildUpdateProjectShadowMessage = exports.buildBaseShadowMessage = exports.buildDeviceActionMessage = exports.buildAppStateControlMessage = exports.buildLiveStateUpdatesToggleMessage = exports.buildAppVersionControlMessage = exports.buildToDeviceStatusResponseMessage = exports.buildToClientStatusResponseMessage = exports.buildSignedUrlsRequestMessage = exports.buildDeviceStatsMessage = exports.buildAppStateMessage = exports.buildAppLogsMessage = exports.validateSystemInformationShadowUpdate = exports.validateProjectShadowUpdate = exports.validateShadowProjectsUpdateAll = exports.validateToCloudMessage = exports.validateToClientMessage = exports.validateToDeviceAgentMessage = exports.getDesiredFromMessage = exports.getShadowTopic = exports.getToDeviceTopic = exports.getToCloudTopic = exports.getToClientTopic = void 0;
+exports.generateTxId = exports.ShadowTopics = exports.keyMirrors = exports.buildUpdateSecureTunnelShadowMessage = exports.buildUpdateSystemInfoShadowMessage = exports.buildUpdateProjectShadowMessage = 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.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; } });
@@ -27,10 +27,12 @@ Object.defineProperty(exports, "buildToDeviceStatusResponseMessage", { enumerabl
 const shadow_schema_1 = require("./shadow-schema");
 Object.defineProperty(exports, "validateProjectShadowUpdate", { enumerable: true, get: function () { return shadow_schema_1.validateProjectShadowUpdate; } });
 Object.defineProperty(exports, "validateShadowProjectsUpdateAll", { enumerable: true, get: function () { return shadow_schema_1.validateShadowProjectsUpdateAll; } });
+Object.defineProperty(exports, "validateSecureTunnelShadowUpdate", { enumerable: true, get: function () { return shadow_schema_1.validateSecureTunnelShadowUpdate; } });
 Object.defineProperty(exports, "validateSystemInformationShadowUpdate", { enumerable: true, get: function () { return shadow_schema_1.validateSystemInformationShadowUpdate; } });
 Object.defineProperty(exports, "buildBaseShadowMessage", { enumerable: true, get: function () { return shadow_schema_1.buildBaseShadowMessage; } });
 Object.defineProperty(exports, "buildUpdateProjectShadowMessage", { enumerable: true, get: function () { return shadow_schema_1.buildUpdateProjectShadowMessage; } });
 Object.defineProperty(exports, "buildUpdateSystemInfoShadowMessage", { enumerable: true, get: function () { return shadow_schema_1.buildUpdateSystemInfoShadowMessage; } });
+Object.defineProperty(exports, "buildUpdateSecureTunnelShadowMessage", { enumerable: true, get: function () { return shadow_schema_1.buildUpdateSecureTunnelShadowMessage; } });
 Object.defineProperty(exports, "ShadowTopics", { enumerable: true, get: function () { return shadow_schema_1.ShadowTopics; } });
 Object.defineProperty(exports, "getShadowTopic", { enumerable: true, get: function () { return shadow_schema_1.getShadowTopic; } });
 Object.defineProperty(exports, "getDesiredFromMessage", { enumerable: true, get: function () { return shadow_schema_1.getDesiredFromMessage; } });

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

@@ -0,0 +1,30 @@
+{
+    "$id": "https://alwaysai.co/secure-tunnel-schema.json",
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "title": "secure-tunnel",
+    "type": "object",
+    "properties": {
+        "st_ports": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "enabled": {
+                        "type": "boolean"
+                    },
+                    "type": {
+                        "type": "string"
+                    },
+                    "ip": {
+                        "type": "string"
+                    },
+                    "port": {
+                        "type": "number"
+                    }
+                }
+            }
+        }
+    },
+    "required": ["st_ports"],
+    "additionalProperties": false
+}

package/lib/shadow-schema.d.ts

@@ -18,7 +18,7 @@ declare const ShadowNames: {
     'secure-tunnel': "secure-tunnel";
 };
 export declare type ShadowNames = keyof typeof ShadowNames;
-export declare const SHADOW_NAMES: ("projects" | "system-info" | "secure-tunnel")[];
+export declare const SHADOW_NAMES: ("secure-tunnel" | "projects" | "system-info")[];
 export declare const getShadowTopic: (clientId: string, shadowName: ShadowNames, shadowTopic: ShadowTopics) => string;
 export interface ProjectShadowUpdate {
     appConfig?: string;
@@ -84,6 +84,16 @@ export interface SystemInformationShadowUpdate {
     lastBootTime?: string;
 }
 export declare const validateSystemInformationShadowUpdate: import("ajv/dist/types").ValidateFunction<SystemInformationShadowUpdate>;
+export declare type SecureTunnelPortInfo = {
+    enabled: boolean;
+    type: string;
+    ip: string;
+    port: number;
+};
+export declare type SecureTunnelShadowDescriptionReported = {
+    st_ports: SecureTunnelPortInfo[];
+};
+export declare const validateSecureTunnelShadowUpdate: import("ajv/dist/types").ValidateFunction<SecureTunnelShadowDescriptionReported>;
 export declare function buildBaseShadowMessage(clientId: string): {
     clientToken: string;
 };
@@ -105,5 +115,11 @@ export declare function buildUpdateSystemInfoShadowMessage(clientId: string, sys
     };
     clientToken: string;
 };
+export declare function buildUpdateSecureTunnelShadowMessage(reported: SecureTunnelShadowDescriptionReported, clientId: string): {
+    state: {
+        reported: SecureTunnelShadowDescriptionReported;
+    };
+    clientToken: string;
+};
 export {};
 //# sourceMappingURL=shadow-schema.d.ts.map

package/lib/shadow-schema.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildUpdateSystemInfoShadowMessage = exports.buildUpdateProjectShadowMessage = exports.buildBaseShadowMessage = exports.validateSystemInformationShadowUpdate = exports.getDesiredFromMessage = exports.validateShadowProjectsUpdateAll = exports.validateProjectShadowUpdate = exports.getShadowTopic = exports.SHADOW_NAMES = exports.SHADOW_TOPICS = exports.ShadowTopics = void 0;
+exports.buildUpdateSecureTunnelShadowMessage = exports.buildUpdateSystemInfoShadowMessage = exports.buildUpdateProjectShadowMessage = exports.buildBaseShadowMessage = exports.validateSecureTunnelShadowUpdate = exports.validateSystemInformationShadowUpdate = exports.getDesiredFromMessage = exports.validateShadowProjectsUpdateAll = exports.validateProjectShadowUpdate = exports.getShadowTopic = exports.SHADOW_NAMES = exports.SHADOW_TOPICS = exports.ShadowTopics = 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 systemInformationSchema = require("./schemas/system-information-schema.json");
+const secureTunnelSchema = require("./schemas/secure-tunnel-schema.json");
 const commonSchema = require("./schemas/common-schema.json");
 const utils_1 = require("./utils");
 const ajv = new _2019_1.default({
@@ -52,6 +53,8 @@ function getDesiredFromMessage(message) {
 exports.getDesiredFromMessage = getDesiredFromMessage;
 ajv.addSchema(systemInformationSchema, 'system-information-schema.json');
 exports.validateSystemInformationShadowUpdate = ajv.compile(systemInformationSchema);
+ajv.addSchema(secureTunnelSchema, 'secure-tunnel-schema.json');
+exports.validateSecureTunnelShadowUpdate = ajv.compile(secureTunnelSchema);
 /* ============================================================================
                                   Shadow Message Builders
 ============================================================================ */
@@ -72,4 +75,9 @@ function buildUpdateSystemInfoShadowMessage(clientId, systemInfo) {
     return buildUpdateProjectShadowMessage({ clientId, reported: systemInfo });
 }
 exports.buildUpdateSystemInfoShadowMessage = buildUpdateSystemInfoShadowMessage;
+function buildUpdateSecureTunnelShadowMessage(reported, clientId) {
+    const message = Object.assign(Object.assign({}, buildBaseShadowMessage(clientId)), { state: { reported } });
+    return message;
+}
+exports.buildUpdateSecureTunnelShadowMessage = buildUpdateSecureTunnelShadowMessage;
 //# sourceMappingURL=shadow-schema.js.map

package/package.json

@@ -1,25 +1,35 @@
 {
   "name": "@alwaysai/device-agent-schemas",
   "description": "alwaysAI schemas",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts",
+    "lib/**/*.json"
+  ],
   "engines": {
     "npm": ">=7.0.0",
     "node": ">=16.0.0"
   },
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
-    "clean": "rimraf lib packages",
     "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 test:unit",
-    "test:unit": "npm run lint && jest --coverage --testPathPattern='./tests'",
+    "test": "npm run lint && npm run test:unit && npm run build:clean",
     "test:ci": "npm run lint && npm run build && npm run test:unit",
-    "preversion": "npm test && npm run build:clean",
-    "gen-docs": "mkdir -p docs && jsonschema2md -o docs -d src/schemas -e json"
+    "test:unit": "jest --coverage --testPathPattern='./tests/'",
+    "test:watch": "npm run test:unit -- --watch",
+    "preversion": "npm test",
+    "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"
   },
   "dependencies": {
     "ajv": "8.11.0",

package/.eslintignore

@@ -1,4 +0,0 @@
-node_modules
-dist
-lib
-*.d.ts

package/.eslintrc

@@ -1,14 +0,0 @@
-{
-  "extends": [
-    "@alwaysai/eslint-config"
-  ],
-  "overrides": [
-    {
-      "files": ["**/*.test.ts"],
-      "parserOptions": {
-        "project": "./tsconfig.eslint.json"
-      },
-      "env": { "jest": true }
-    }
-  ]
-}

package/.node-version

@@ -1 +0,0 @@
-20.12.2

package/bitbucket-pipelines.yml

@@ -1,10 +0,0 @@
-image: node
-
-pipelines:
-  default:
-    - parallel:
-      - step:
-          name: 'Install, build, lint, and run unit tests'
-          script:
-            - npm install
-            - npm run test:unit

package/development.md

@@ -1,53 +0,0 @@
-# Overview
-The interfaces and schemas for each sub-packet can be found in `src/schemas`. The schemas are imported into `types.ts` and the overall JSONSchemaType as well as the sub-types are created, as are the validation methods. Validation methods are used to type-guard incoming messages, while the interfaces are used to type-guard at development time. This repository is configured as an `npm` package -- while under local development you can use `npm instal --save` along with the path to this repo to use it with the device agent.
-
-# Naming Conventions
-Below is an outline of the general interface structure.
-
-const message: xxxxMessage = {
-  ....,
-  messageType: [`DeviceAgentMessageTypeValue` or `ClientMessageTypeValue`],
-  payload: xxxxMessagePayload : {
-    [type lowercase]: [type is the mirror of the key (uppercase)]
-  }
-}
-
-
-## Upper Level
-The upper level content has the suffix `Message`. This is in keeping with the convention of having the content delivered on MQTT be the 'message'.
-
-## Message Payload
-Each of the `Message` packets have a 'payload', and these sub-packets are one of the following for `DeviceAgentMessage`:
-  - AppStateControlPayload
-  - AppVersionControlPayload
-  - LiveUpdatesTogglePayload
-  - AppInstallCloudResponsePayload
-  - ModelsInstallCloudResponsePayload
-
-For `ClientMessage`, the 'payload' field must be one of the following:
-  - AppLogsPayload
-  - StatusResponsePayload
-  - AppStatePayload
-  - DeviceStatsPayload
-  - SignedUrlsRequestPayload
-
-For all packets, there is a `messageType` field, whose entry helps identify the contents. This field can be used to distinguish which message has been sent, such as in a conditional block. For `ClientMessage`packets, this field is one of `ClientMessageTypeValue` entries and for `DeviceAgentMessage` packets, it is one of `DeviceAgentMessageTypeValue` entries.
-
-## Message Payload Contents
-Additionally, each 'payload' object contains a key that corresponds to the actual useful contents of the 'payload'. The name of the key indicates what type of contents these are.
-
-For instance, the `AppLogsPayload` type has a `messageType`, which is of type `app_logs`, as well as a key `appLogs`, which is of type `AppLogs`.
-
-# To Create New Schemas and Validation Methods
-To create a new message type, create a new `.ts` file in `src/schemas` and create the sub-schema and a corresponding `interface`. If you are using patterns or enums, you can add these to the `src/constants` file and import them as needed. You can them import the schemas into `types.ts` and modify the main schema's `payload` property's `oneOf` list to include the new type. You can then compile a new validation method against the new schema using your newly defined type. You may need to add the schema to the `ajv` instance, however this shouldn't be necessary if the main schema is referencing the new sub-schema. More notes on the development of this repo can be found here: https://alwaysai.atlassian.net/l/c/RdjVyG1d 
-
-# Development Practices
-There are a few development practices we have been using to help keep the schema components modular and re-usable, as well as easy to change.
-  1. Look in `src/constants.ts` and `src/schemas/common-schema.ts` to see if there are any components to re-use, such as the `projectId` schema or `releaseHash` schema. If you develop a component that could be used across multiple schemas, please put it in `src/schemas/common-schema.ts` and then use `$ref` to incorporate it into larger schemas.
-  2. If you develop a schema that requires a pattern, you can define the pattern in `src/constants.ts`.
-  2. If you develop a schema that uses a string, check that the string doesn't need to be more explicitly defined (e.g. with a pattern) and doesn't need to be a re-usable definition.
-  3. Try to create Enum or KeyMirror variables when creating a schema that has a property that can take on one of a set of specific values. Examples of this can be seen in `ssrc/constants.ts` -- the idea is that if the acceptable values change, we only need to change them in one place, and then we can use this set to make a list as well as create the development type guards.
-  3. Create positive and negative examples of data for any new schemas you create, and add these to the tests in `src/types.test.ts`.
-
-# To Run Tests
-Run `npm run test:unit` to run the `types.test.ts` file. You can add valid and invalid data structures to the `validData` and `invalidData` variables and these will be checked as positive and negative tests, respectively.

package/docs/README.md

@@ -1,107 +0,0 @@
-# README
-
-## Top-level Schemas
-
-*   [app\_install](./app-install-schema.md) – `https://alwaysai.co/app-install-schema.json`
-
-*   [app\_install\_response](./app-install-response-schema.md) – `https://alwaysai.co/app-install-response-schema.json`
-
-*   [app\_logs](./app-logs-schema.md) – `https://alwaysai.co/app-logs-schema.json`
-
-*   [app\_state](./app-state-schema.md) – `https://alwaysai.co/app-state-schema.json`
-
-*   [app\_state\_control](./app-state-control-schema.md) – `https://alwaysai.co/app-state-control-schema.json`
-
-*   [app\_uninstall](./app-uninstall-schema.md) – `https://alwaysai.co/app-uninstall-schema.json`
-
-*   [app\_version\_control](./app-version-control-schema.md) – `https://alwaysai.co/app-version-control-schema.json`
-
-*   [cloud\_message](./to-cloud-message-schema.md "The messaging payload structure for messages sent from device agent to the cloud") – `https://alwaysai.co/cloud-message-schema.json`
-
-*   [common](./common-schema.md) – `https://alwaysai.co/common-schema.json`
-
-*   [device\_action](./device-action-schema.md) – `https://alwaysai.co/device-action-schema.json`
-
-*   [device\_stats](./device-stats-schema.md) – `https://alwaysai.co/device-stats-schema.json`
-
-*   [live\_state\_updates](./live-updates-toggle-schema.md) – `https://alwaysai.co/live-updates-toggle-schema.json`
-
-*   [models\_install\_payload](./models-install-payload-schema.md) – `https://alwaysai.co/models-install-payload-schema.json`
-
-*   [models\_install\_response](./models-install-response-schema.md) – `https://alwaysai.co/models-install-response-schema.json`
-
-*   [shadow-projects-update-all](./shadow-projects-update-all-schema.md "The messaging payload structure for shadow's projects update delta") – `https://alwaysai.co/shadow-projects-update-all-schema.json`
-
-*   [shadow\_project\_update\_schema](./shadow-project-update-schema.md "The messaging payload structure for a all properties of a single project shadow update") – `https://alwaysai.co/shadow-project-update-schema.json`
-
-*   [signed\_urls\_request](./signed-urls-request-schema.md) – `https://alwaysai.co/signed-urls-request-schema.json`
-
-*   [status\_response](./status-response-schema.md) – `https://alwaysai.co/status-response-schema.json`
-
-*   [system-information](./system-information-schema.md) – `https://alwaysai.co/system-information-schema.json`
-
-*   [to\_client\_message](./to-client-message-schema.md "The messaging payload structure for messages sent from device agent to clients") – `https://alwaysai.co/to-client-message-schema.json`
-
-*   [to\_device\_agent\_message](./to-device-agent-message-schema.md "A schema that describes the message payload structure for messages sent from clients to device agent") – `https://alwaysai.co/to-device-agent-message-schema.json`
-
-## Other Schemas
-
-### Objects
-
-*   [Untitled object in app\_install\_response](./app-install-response-schema-properties-appinstallresponse.md) – `https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse`
-
-*   [Untitled object in app\_install\_response](./app-install-response-schema-properties-appinstallresponse-properties-appinstallpayload.md) – `https://alwaysai.co/app-install-response-schema.json#/properties/appInstallResponse/properties/appInstallPayload`
-
-*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items`
-
-*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items-properties-appdetails.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/appDetails`
-
-*   [Untitled object in app\_state](./app-state-schema-properties-appstate-items-properties-services-items.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services/items`
-
-*   [Untitled object in device\_stats](./device-stats-schema-properties-cpudetails.md "CPU utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/cpuDetails`
-
-*   [Untitled object in device\_stats](./device-stats-schema-properties-diskdetails.md "Disk utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/diskDetails`
-
-*   [Untitled object in device\_stats](./device-stats-schema-properties-memdetails.md "Memory utilization information") – `https://alwaysai.co/device-stats-schema.json#/properties/memDetails`
-
-*   [Untitled object in live\_state\_updates](./live-updates-toggle-schema-properties-applogs.md) – `https://alwaysai.co/live-updates-toggle-schema.json#/properties/appLogs`
-
-*   [Untitled object in models\_install\_payload](./models-install-payload-schema-items.md) – `https://alwaysai.co/models-install-payload-schema.json#/items`
-
-*   [Untitled object in models\_install\_response](./models-install-response-schema-properties-modelsinstallresponse.md) – `https://alwaysai.co/models-install-response-schema.json#/properties/modelsInstallResponse`
-
-*   [Untitled object in shadow\_project\_update\_schema](./shadow-project-update-schema-properties-envvars.md) – `https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars`
-
-*   [Untitled object in shadow\_project\_update\_schema](./shadow-project-update-schema-properties-envvars-patternproperties-.md) – `https://alwaysai.co/shadow-project-update-schema.json#/properties/envVars/patternProperties/.*`
-
-*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-signedurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/signedUrlsRequest`
-
-*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest`
-
-*   [Untitled object in signed\_urls\_request](./signed-urls-request-schema-properties-modelsonlyurlsrequest-properties-models.md) – `https://alwaysai.co/signed-urls-request-schema.json#/properties/modelsOnlyUrlsRequest/properties/models`
-
-*   [Untitled object in system-information](./system-information-schema-properties-os.md) – `https://alwaysai.co/system-information-schema.json#/properties/os`
-
-*   [Untitled object in system-information](./system-information-schema-properties-cpu.md) – `https://alwaysai.co/system-information-schema.json#/properties/cpu`
-
-*   [Untitled object in system-information](./system-information-schema-properties-disk.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk`
-
-*   [Untitled object in system-information](./system-information-schema-properties-disk-properties-drives-items.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk/properties/drives/items`
-
-*   [Untitled object in system-information](./system-information-schema-properties-device.md) – `https://alwaysai.co/system-information-schema.json#/properties/device`
-
-*   [Untitled object in system-information](./system-information-schema-properties-network.md) – `https://alwaysai.co/system-information-schema.json#/properties/network`
-
-*   [Untitled object in system-information](./system-information-schema-properties-versions.md) – `https://alwaysai.co/system-information-schema.json#/properties/versions`
-
-### Arrays
-
-*   [Untitled array in app\_state](./app-state-schema-properties-appstate.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState`
-
-*   [Untitled array in app\_state](./app-state-schema-properties-appstate-items-properties-services.md) – `https://alwaysai.co/app-state-schema.json#/properties/appState/items/properties/services`
-
-*   [Untitled array in system-information](./system-information-schema-properties-disk-properties-drives.md) – `https://alwaysai.co/system-information-schema.json#/properties/disk/properties/drives`
-
-## Version Note
-
-The schemas linked above follow the JSON Schema Spec version: `https://json-schema.org/draft/2019-09/schema`

package/docs/agent-message-schema-defs-toclient.md

@@ -1,25 +0,0 @@
-# Untitled string in agent\_message Schema
-
-```txt
-https://alwaysai.co/agent-message-schema.json#/$defs/toClient
-```
-
-Messages sent from the agent itself to console client
-
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
-
-## toClient Type
-
-`string`
-
-## toClient Constraints
-
-**pattern**: the string must match the following regular expression: 
-
-```regexp
-to-client/aai-device/([0-9a-z]+-+)+([0-9a-z])+
-```
-
-[try pattern](https://regexr.com/?expression=to-client%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")

package/docs/agent-message-schema-defs-tocloud.md

@@ -1,25 +0,0 @@
-# Untitled string in agent\_message Schema
-
-```txt
-https://alwaysai.co/agent-message-schema.json#/$defs/toCloud
-```
-
-Messages sent from the agent itself to cloud backend
-
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
-
-## toCloud Type
-
-`string`
-
-## toCloud Constraints
-
-**pattern**: the string must match the following regular expression: 
-
-```regexp
-to-cloud/aai-device/([0-9a-z]+-+)+([0-9a-z])+
-```
-
-[try pattern](https://regexr.com/?expression=to-cloud%2Faai-device%2F\(%5B0-9a-z%5D%2B-%2B\)%2B\(%5B0-9a-z%5D\)%2B "try regular expression with regexr.com")

package/docs/agent-message-schema-defs.md

@@ -1,15 +0,0 @@
-# Untitled undefined type in agent\_message Schema
-
-```txt
-https://alwaysai.co/agent-message-schema.json#/$defs
-```
-
-
-
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
-
-## $defs Type
-
-unknown

package/docs/agent-message-schema-properties-deviceid.md

@@ -1,15 +0,0 @@
-# Untitled string in agent\_message Schema
-
-```txt
-https://alwaysai.co/agent-message-schema.json#/properties/deviceId
-```
-
-Device UUID of device sending the message
-
-| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
-| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
-
-## deviceId Type
-
-`string`

package/docs/agent-message-schema-properties-payload-oneof-app_install_status.md

@@ -1,66 +0,0 @@
-# app\_install\_status Schema
-
-```txt
-https://alwaysai.co/app-install-status-schema.json#/properties/payload/oneOf/3
-```
-
-
-
-| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                             |
-| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------------- |
-| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [agent-message-schema.json\*](../out/agent-message-schema.json "open original schema") |
-
-## 3 Type
-
-`object` ([app\_install\_status](agent-message-schema-properties-payload-oneof-app_install_status.md))
-
-# 3 Properties
-
-| Property                              | Type          | Required | Nullable       | Defined by                                                                                                                                                         |
-| :------------------------------------ | :------------ | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [messageType](#messagetype)           | Not specified | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-messagetype.md "https://alwaysai.co/app-install-status-schema.json#/properties/messageType")           |
-| [appInstallStatus](#appinstallstatus) | `object`      | Required | cannot be null | [app\_install\_status](app-install-status-schema-properties-appinstallstatus.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus") |
-
-## messageType
-
-
-
-`messageType`
-
-*   is required
-
-*   Type: unknown
-
-*   cannot be null
-
-*   defined in: [app\_install\_status](app-install-status-schema-properties-messagetype.md "https://alwaysai.co/app-install-status-schema.json#/properties/messageType")
-
-### messageType Type
-
-unknown
-
-### messageType Constraints
-
-**constant**: the value of this property must be equal to:
-
-```json
-"app_install_status"
-```
-
-## appInstallStatus
-
-
-
-`appInstallStatus`
-
-*   is required
-
-*   Type: `object` ([Details](app-install-status-schema-properties-appinstallstatus.md))
-
-*   cannot be null
-
-*   defined in: [app\_install\_status](app-install-status-schema-properties-appinstallstatus.md "https://alwaysai.co/app-install-status-schema.json#/properties/appInstallStatus")
-
-### appInstallStatus Type
-
-`object` ([Details](app-install-status-schema-properties-appinstallstatus.md))