@alwaysai/device-agent-schemas 2.3.3 → 2.3.4

package/src/message-builders.ts

@@ -1,263 +0,0 @@
-import {
-  AppStateControlMessage,
-  AppStateControlPayload,
-  AppVersionControlInstallPayload,
-  AppVersionControlMessage,
-  AppVersionControlUninstallPayload
-} from './app-action-schema';
-import { AppLogsMessage, AppLogsPayload } from './app-logs-schema';
-import { AppStateMessage, AppStatePayload } from './app-state-schema';
-import {
-  AppLogsMessageType,
-  AppStateMessageType,
-  DeviceStatsMessageType,
-  SignedUrlsRequestMessageType,
-  StatusResponseMessageType,
-  keyMirrors
-} from './constants';
-import {
-  DeviceActionMessage,
-  DeviceActionPayload
-} from './device-action-schema';
-import {
-  LiveStateUpdatesToggleMessage,
-  LiveStateUpdatesTogglePayload
-} from './device-agent-action-schema';
-import { DeviceStatsMessage, DeviceStatsPayload } from './device-stats-schema';
-import { SignedUrlsRequestMessage } from './signed-urls-request-schema';
-import {
-  StatusResponsePayload,
-  ToClientStatusResponseMessage,
-  ToDeviceStatusResponseMessage
-} from './status-response-schema';
-import {
-  BaseToClientMessage,
-  BaseToCloudMessage,
-  BaseToDeviceAgentMessage,
-  ToCloudMessagePayload,
-  getToClientTopic,
-  getToCloudTopic,
-  getToDeviceTopic
-} from './types';
-
-function buildBaseToClientMessage(
-  clientId: string,
-  txId: string
-): BaseToClientMessage {
-  const baseClientMessage = {
-    timestamp: new Date().toUTCString(),
-    deviceId: clientId,
-    topic: getToClientTopic(clientId),
-    txId
-  };
-  return baseClientMessage;
-}
-
-function buildBaseToDeviceMessage(
-  deviceId: string,
-  txId: string
-): BaseToDeviceAgentMessage {
-  const baseToDeviceMessage = {
-    timestamp: new Date().toUTCString(),
-    topic: getToDeviceTopic(deviceId),
-    txId
-  };
-  return baseToDeviceMessage;
-}
-
-function buildBaseToCloudMessage(
-  deviceId: string,
-  txId: string
-): BaseToCloudMessage {
-  const baseToCloudMessage = {
-    deviceId,
-    timestamp: new Date().toUTCString(),
-    topic: getToCloudTopic(deviceId),
-    txId
-  };
-  return baseToCloudMessage;
-}
-
-// toClient Message Builders
-
-// app logs
-function buildAppLogsMessage(
-  clientId: string,
-  payload: AppLogsPayload,
-  txId: string
-): AppLogsMessage {
-  const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const messageType: AppLogsMessageType =
-    keyMirrors.toClientMessageType.app_logs;
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// app state
-function buildAppStateMessage(
-  clientId: string,
-  payload: AppStatePayload,
-  txId: string
-): AppStateMessage {
-  const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const messageType: AppStateMessageType =
-    keyMirrors.toClientMessageType.app_state;
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// status response
-function buildToClientStatusResponseMessage(
-  clientId: string,
-  payload: StatusResponsePayload,
-  txId: string
-): ToClientStatusResponseMessage {
-  const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const messageType: StatusResponseMessageType =
-    keyMirrors.toClientMessageType.status_response;
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// device stats
-function buildDeviceStatsMessage(
-  clientId: string,
-  payload: DeviceStatsPayload,
-  txId: string
-): DeviceStatsMessage {
-  const messageType: DeviceStatsMessageType =
-    keyMirrors.toClientMessageType.device_stats;
-  const baseMessage = buildBaseToClientMessage(clientId, txId);
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// toDevice Message Builders
-
-// status response
-function buildToDeviceStatusResponseMessage(
-  clientId: string,
-  payload: StatusResponsePayload,
-  txId: string
-): ToDeviceStatusResponseMessage {
-  const baseMessage = buildBaseToDeviceMessage(clientId, txId);
-  const messageType: StatusResponseMessageType =
-    keyMirrors.toClientMessageType.status_response;
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// app version control
-function buildAppVersionControlMessage(
-  deviceId: string,
-  payload: AppVersionControlInstallPayload | AppVersionControlUninstallPayload,
-  txId: string
-): AppVersionControlMessage {
-  const messageType = keyMirrors.toDeviceAgentMessageType.app_version_control;
-  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// live state updates toggle
-function buildLiveStateUpdatesToggleMessage(
-  deviceId: string,
-  payload: LiveStateUpdatesTogglePayload,
-  txId: string
-): LiveStateUpdatesToggleMessage {
-  const messageType = keyMirrors.toDeviceAgentMessageType.live_state_updates;
-  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// app state control
-function buildAppStateControlMessage(
-  deviceId: string,
-  payload: AppStateControlPayload,
-  txId: string
-): AppStateControlMessage {
-  const messageType = keyMirrors.toDeviceAgentMessageType.app_state_control;
-  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-function buildDeviceActionMessage(
-  deviceId: string,
-  payload: DeviceActionPayload,
-  txId: string
-): DeviceActionMessage {
-  const messageType = keyMirrors.toDeviceAgentMessageType.device_action;
-  const baseMessage = buildBaseToDeviceMessage(deviceId, txId);
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-// toCloud Message Builders
-
-// signed URLs
-function buildSignedUrlsRequestMessage(
-  clientId: string,
-  payload: ToCloudMessagePayload,
-  txId: string
-): SignedUrlsRequestMessage {
-  const baseMessage = buildBaseToCloudMessage(clientId, txId);
-  const messageType: SignedUrlsRequestMessageType =
-    keyMirrors.toCloudMessageType.signed_urls_request;
-  const message = {
-    ...baseMessage,
-    messageType,
-    payload
-  };
-  return message;
-}
-
-export {
-  buildAppLogsMessage,
-  buildAppStateMessage,
-  buildSignedUrlsRequestMessage,
-  buildToClientStatusResponseMessage,
-  buildToDeviceStatusResponseMessage,
-  buildDeviceStatsMessage,
-  buildAppVersionControlMessage,
-  buildLiveStateUpdatesToggleMessage,
-  buildAppStateControlMessage,
-  buildDeviceActionMessage
-};

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

@@ -1,41 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-install-response-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_install_response",
-  "type": "object",
-  "properties": {
-    "appInstallResponse": {
-      "type": "object",
-      "properties": {
-        "projectId": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-        },
-        "appReleaseHash": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
-        },
-        "appInstallPayload": {
-          "type": "object",
-          "properties": {
-            "appSignedUrl": {
-              "type": "string"
-            }
-          },
-          "required": ["appSignedUrl"],
-          "additionalProperties": false
-        },
-        "modelsInstallPayload": {
-          "$ref": "https://alwaysai.co/models-install-payload-schema.json"
-        }
-      },
-      "required": [
-        "projectId",
-        "appReleaseHash",
-        "appInstallPayload",
-        "modelsInstallPayload"
-      ],
-      "additionalProperties": false
-    }
-  },
-  "required": ["appInstallResponse"],
-  "additionalProperties": false
-}

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

@@ -1,20 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-install-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_install",
-  "type": "object",
-  "properties": {
-    "baseCommand": {
-      "type": "string",
-      "enum": ["install"]
-    },
-    "projectId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-    },
-    "appReleaseHash": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
-    }
-  },
-  "required": ["baseCommand", "projectId", "appReleaseHash"],
-  "additionalProperties": false
-}

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

@@ -1,16 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-logs-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_logs",
-  "type": "object",
-  "properties": {
-    "projectId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-    },
-    "logChunk": {
-      "type": "string"
-    }
-  },
-  "required": ["projectId", "logChunk"],
-  "additionalProperties": false
-}

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

@@ -1,17 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-state-control-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_state_control",
-  "type": "object",
-  "properties": {
-    "baseCommand": {
-      "type": "string",
-      "enum": ["start", "stop", "restart"]
-    },
-    "projectId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-    }
-  },
-  "required": ["baseCommand", "projectId"],
-  "additionalProperties": false
-}

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

@@ -1,49 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-state-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_state",
-  "type": "object",
-  "properties": {
-    "appState": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "appDetails": {
-            "type": "object",
-            "properties": {
-              "projectId": {
-                "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-              },
-              "version": {
-                "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
-              }
-            },
-            "additionalProperties": false,
-            "required": ["projectId", "version"]
-          },
-          "services": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "name": {
-                  "type": "string"
-                },
-                "state": {
-                  "enum": ["up", "stopped", "restarting"]
-                }
-              },
-              "additionalProperties": false,
-              "required": ["name", "state"]
-            }
-          }
-        },
-        "additionalProperties": false,
-        "required": ["appDetails", "services"]
-      }
-    }
-  },
-  "additionalProperties": false,
-  "required": ["appState"]
-}

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

@@ -1,17 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-uninstall-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_uninstall",
-  "type": "object",
-  "properties": {
-    "baseCommand": {
-      "type": "string",
-      "enum": ["uninstall"]
-    },
-    "projectId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-    }
-  },
-  "required": ["baseCommand", "projectId"],
-  "additionalProperties": false
-}

package/src/schemas/app-version-control-schema.json

@@ -1,14 +0,0 @@
-{
-  "$id": "https://alwaysai.co/app-version-control-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "app_version_control",
-  "type": "object",
-  "oneOf": [
-    {
-      "$ref": "https://alwaysai.co/app-install-schema.json"
-    },
-    {
-      "$ref": "https://alwaysai.co/app-uninstall-schema.json"
-    }
-  ]
-}

package/src/schemas/common-schema.json

@@ -1,27 +0,0 @@
-{
-  "$id": "https://alwaysai.co/common-schema.json",
-  "title": "common",
-  "$defs": {
-    "projectId": {
-      "description": "The specific project associated with the message payload.",
-      "type": "string",
-      "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
-    },
-    "appReleaseHash": {
-      "description": "The version of the project associated with the message payload.",
-      "type": "string",
-      "pattern": "[0-9a-z]{64}"
-    },
-    "modelId":  {
-      "description": "The id of a model",
-      "type": "string",
-      "pattern": "[A-Za-z0-9_]+/[A-Za-z0-9_]*"
-    },
-    "txId": {
-      "type": "string",
-      "minLength": 36,
-      "maxLength": 36,
-      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
-    }
-  }
-}

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

@@ -1,14 +0,0 @@
-{
-    "$id": "https://alwaysai.co/device-action-schema.json",
-    "$schema": "https://json-schema.org/draft/2019-09/schema",
-    "title": "device_action",
-    "type": "object",
-    "properties": {
-        "action": {
-            "type": "string",
-            "enum": ["system_restart"]
-        }
-    },
-    "required": ["action"],
-    "additionalProperties": false
-  }

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

@@ -1,58 +0,0 @@
-{
-  "$id": "https://alwaysai.co/device-stats-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "device_stats",
-  "type": "object",
-  "properties": {
-    "cpuUsage": {
-      "type": "number",
-      "description": "The percentage of the CPU that is currently being used."
-    },
-    "diskUtil": {
-      "type": "number",
-      "description": "The percentage of the drive storage that is being used."
-    },
-    "usedMemoryPercentage": {
-      "type": "number",
-      "description": "The percentage of the memory that is being used."
-    },
-    "cpuDetails": {
-      "type": "object",
-      "description": "CPU utilization information",
-      "properties": {
-        "usedPerc": {
-          "type": ["number"]
-        },
-        "temperature": {
-          "type": ["number"]
-        }
-      }
-    },
-    "diskDetails": {
-      "type": "object",
-      "description": "Disk utilization information",
-      "properties": {
-        "usedGb": {
-          "type": ["number"]
-        },
-        "freeGb": {
-          "type": ["number"]
-        }
-      }
-    },
-    "memDetails": {
-      "type": "object",
-      "description": "Memory utilization information",
-      "properties": {
-        "usedMb": {
-          "type": ["number"]
-        },
-        "freeMb": {
-          "type": ["number"]
-        }
-      }
-    }
-  },
-  "additionalProperties": false,
-  "required": []
-}

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

@@ -1,29 +0,0 @@
-{
-  "$id": "https://alwaysai.co/live-updates-toggle-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "live_state_updates",
-  "type": "object",
-  "properties": {
-    "deviceStats": {
-      "type": "boolean"
-    },
-    "appState": {
-      "type": "boolean"
-    },
-    "appLogs": {
-      "type": "object",
-      "properties": {
-        "projectId": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-        },
-        "toggle": {
-          "type": "boolean"
-        }
-      },
-      "required": ["projectId", "toggle"],
-      "additionalProperties": false
-    }
-  },
-  "required": [],
-  "additionalProperties": false
-}

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

@@ -1,22 +0,0 @@
-{
-  "$id": "https://alwaysai.co/models-install-payload-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "models_install_payload",
-  "type": "array",
-  "items": {
-    "type": "object",
-    "properties": {
-      "id": {
-        "$ref": "https://alwaysai.co/common-schema.json#/$defs/modelId"
-      },
-      "version": {
-        "type": "number"
-      },
-      "modelSignedUrl": {
-        "type": "string"
-      }
-    },
-    "required": ["id", "version", "modelSignedUrl"],
-    "additionalProperties": false
-  }
-}

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

@@ -1,23 +0,0 @@
-{
-  "$id": "https://alwaysai.co/models-install-response-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "models_install_response",
-  "type": "object",
-  "properties": {
-    "modelsInstallResponse": {
-      "type": "object",
-      "properties": {
-        "projectId": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-        },
-        "newModels": {
-          "$ref": "https://alwaysai.co/models-install-payload-schema.json"
-        }
-      },
-      "required": ["projectId", "newModels"],
-      "additionalProperties": false
-    }
-  },
-  "required": ["modelsInstallResponse"],
-  "additionalProperties": false
-}

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

@@ -1,30 +0,0 @@
-{
-  "$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/src/schemas/shadow-project-update-schema.json

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