@alwaysai/device-agent-schemas 2.3.2 → 2.3.4

package/src/app-action-schema.ts

@@ -1,71 +0,0 @@
-import {
-  AppInstallResponseMessageType,
-  AppStateControlMessageType,
-  AppStateControlValue,
-  AppVersionControlMessageType,
-  ModelsInstallResponseMessageType,
-  keyMirrors
-} from './constants';
-import { BaseToDeviceAgentMessage } from './types';
-
-export interface AppStateControlPayload {
-  baseCommand: AppStateControlValue;
-  projectId: string;
-}
-
-export interface AppStateControlMessage extends BaseToDeviceAgentMessage {
-  messageType: AppStateControlMessageType;
-  payload: AppStateControlPayload;
-}
-
-export type AppVersionControlInstallPayload = {
-  baseCommand: typeof keyMirrors.appVersionControl.install;
-  projectId: string;
-  appReleaseHash: string;
-};
-
-export type AppVersionControlUninstallPayload = {
-  baseCommand: typeof keyMirrors.appVersionControl.uninstall;
-  projectId: string;
-};
-
-export interface AppVersionControlMessage extends BaseToDeviceAgentMessage {
-  messageType: AppVersionControlMessageType;
-  payload: AppVersionControlInstallPayload | AppVersionControlUninstallPayload;
-}
-
-export type ModelInstallPayload = {
-  id: string;
-  version: number;
-  modelSignedUrl: string;
-};
-
-export type AppInstallPayload = {
-  appSignedUrl: string;
-};
-
-export interface AppInstallResponsePayload {
-  appInstallResponse: {
-    projectId: string;
-    appReleaseHash: string;
-    appInstallPayload: AppInstallPayload;
-    modelsInstallPayload: ModelInstallPayload[];
-  };
-}
-
-export interface AppInstallResponseMessage extends BaseToDeviceAgentMessage {
-  messageType: AppInstallResponseMessageType;
-  payload: AppInstallResponsePayload;
-}
-
-export interface ModelsInstallResponsePayload {
-  modelsInstallResponse: {
-    projectId: string;
-    newModels: ModelInstallPayload[];
-  };
-}
-
-export interface ModelsInstallResponseMessage extends BaseToDeviceAgentMessage {
-  messageType: ModelsInstallResponseMessageType;
-  payload: ModelsInstallResponsePayload;
-}

package/src/app-logs-schema.ts

@@ -1,13 +0,0 @@
-import { AppLogsMessageType } from './constants';
-import { BaseToClientMessage } from './types';
-
-// Application Log Structures
-export interface AppLogsPayload {
-  projectId: string;
-  logChunk: string;
-}
-
-export interface AppLogsMessage extends BaseToClientMessage {
-  messageType: AppLogsMessageType;
-  payload: AppLogsPayload;
-}

package/src/app-state-schema.ts

@@ -1,27 +0,0 @@
-import { AppStateMessageType, AppStateValue } from './constants';
-import { BaseToClientMessage } from './types';
-
-// Application State Structures
-export interface AppDetails {
-  projectId: string;
-  version: string;
-}
-
-export interface ServiceStatus {
-  name: string;
-  state: AppStateValue;
-}
-
-export interface AppState {
-  appDetails: AppDetails;
-  services: ServiceStatus[];
-}
-
-export interface AppStatePayload {
-  appState: AppState[];
-}
-
-export interface AppStateMessage extends BaseToClientMessage {
-  messageType: AppStateMessageType;
-  payload: AppStatePayload;
-}

package/src/constants.ts

@@ -1,140 +0,0 @@
-import { keyMirror } from './utils';
-
-export const PROJECT_ID_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}$';
-export const DEVICE_ID_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}$';
-export const APP_RELEASE_ID_PATTERN = '[0-9a-z]{64}';
-export const MODEL_ID_PATTERN = '[A-Za-z0-9_]+/[A-Za-z0-9_]*';
-
-export const CLIENT_TOPIC_PREFIX = 'to-client';
-export const CLOUD_TOPIC_PREFIX = 'to-cloud';
-export const DEVICE_TOPIC_PREFIX = 'to-device';
-export const DEVICE_TYPE = 'aai-device';
-
-const toCloudMessageTypeEnum = keyMirror({
-  signed_urls_request: null
-});
-
-const toClientMessageTypeEnum = keyMirror({
-  app_logs: null,
-  app_state: null,
-  device_stats: null,
-  status_response: null
-});
-
-const toDeviceAgentMessageTypeEnum = keyMirror({
-  app_state_control: null,
-  app_version_control: null,
-  app_install_response: null,
-  models_install_response: null,
-  live_state_updates: null,
-  status_response: null,
-  device_action: null
-});
-
-const appStateEnum = keyMirror({
-  up: null,
-  stopped: null,
-  restarting: null
-});
-
-const appStateControlEnum = keyMirror({
-  start: null,
-  stop: null,
-  restart: null
-});
-
-const appVersionControlEnum = keyMirror({
-  install: null,
-  uninstall: null
-});
-
-const liveUpdatesEnum = keyMirror({
-  live_updates: null
-});
-
-const statusEnum = keyMirror({
-  requested: null,
-  in_progress: null,
-  failure: null,
-  success: null,
-  connection_lost: null
-});
-
-const deviceActionEnum = keyMirror({
-  system_restart: null
-});
-
-export const keyMirrors = {
-  toDeviceAgentMessageType: toDeviceAgentMessageTypeEnum,
-  toClientMessageType: toClientMessageTypeEnum,
-  toCloudMessageType: toCloudMessageTypeEnum,
-  appState: appStateEnum,
-  appStateControl: appStateControlEnum,
-  appVersionControl: appVersionControlEnum,
-  liveUpdates: liveUpdatesEnum,
-  statusResponse: statusEnum,
-  deviceAction: deviceActionEnum
-};
-
-export const toCloudMessageTypeValues = Object.values(
-  keyMirrors.toCloudMessageType
-);
-export type ToCloudMessageTypeValue =
-  keyof typeof keyMirrors.toCloudMessageType;
-
-export const toClientMessageTypeValues = Object.values(
-  keyMirrors.toClientMessageType
-);
-export type ToClientMessageTypeValue =
-  keyof typeof keyMirrors.toClientMessageType;
-
-export type AppLogsMessageType = typeof toClientMessageTypeEnum.app_logs;
-export type AppStateMessageType = typeof toClientMessageTypeEnum.app_state;
-export type DeviceStatsMessageType =
-  typeof toClientMessageTypeEnum.device_stats;
-export type StatusResponseMessageType =
-  typeof toClientMessageTypeEnum.status_response;
-export type SignedUrlsRequestMessageType =
-  typeof toCloudMessageTypeEnum.signed_urls_request;
-
-export const toDeviceAgentMessageTypeValues = Object.values(
-  keyMirrors.toDeviceAgentMessageType
-);
-export type ToDeviceAgentMessageTypeValue =
-  keyof typeof keyMirrors.toDeviceAgentMessageType;
-
-export type AppStateControlMessageType =
-  typeof toDeviceAgentMessageTypeEnum.app_state_control;
-
-export type AppVersionControlMessageType =
-  typeof toDeviceAgentMessageTypeEnum.app_version_control;
-export type AppInstallResponseMessageType =
-  typeof toDeviceAgentMessageTypeEnum.app_install_response;
-export type ModelsInstallResponseMessageType =
-  typeof toDeviceAgentMessageTypeEnum.models_install_response;
-export type LiveStateUpdatesTogglesMessageType =
-  typeof toDeviceAgentMessageTypeEnum.live_state_updates;
-export type DeviceActionMessageType =
-  typeof toDeviceAgentMessageTypeEnum.device_action;
-
-export const appStateValues = Object.values(keyMirrors.appState);
-export type AppStateValue = keyof typeof keyMirrors.appState;
-
-export const appStateControlValues = Object.values(keyMirrors.appStateControl);
-export type AppStateControlValue = keyof typeof keyMirrors.appStateControl;
-
-export const appVersionControlValues = Object.values(
-  keyMirrors.appVersionControl
-);
-export type AppVersionControlValue = keyof typeof keyMirrors.appVersionControl;
-
-export const liveUpdatesValues = Object.values(keyMirrors.liveUpdates);
-export type LiveUpdatesValue = keyof typeof keyMirrors.liveUpdates;
-
-export const statusResponseValues = Object.values(keyMirrors.statusResponse);
-export type StatusResponseValue = keyof typeof keyMirrors.statusResponse;
-
-export const deviceActionValues = Object.values(keyMirrors.deviceAction);
-export type DeviceActionValue = keyof typeof keyMirrors.deviceAction;

package/src/device-action-schema.ts

@@ -1,11 +0,0 @@
-import { DeviceActionMessageType, DeviceActionValue } from './constants';
-import { BaseToDeviceAgentMessage } from './types';
-
-export interface DeviceActionPayload {
-  action: DeviceActionValue;
-}
-
-export interface DeviceActionMessage extends BaseToDeviceAgentMessage {
-  messageType: DeviceActionMessageType;
-  payload: DeviceActionPayload;
-}

package/src/device-agent-action-schema.ts

@@ -1,17 +0,0 @@
-import { LiveStateUpdatesTogglesMessageType } from './constants';
-import { BaseToDeviceAgentMessage } from './types';
-
-export interface LiveStateUpdatesTogglePayload {
-  deviceStats?: boolean;
-  appState?: boolean;
-  appLogs?: {
-    projectId: string;
-    toggle: boolean;
-  };
-}
-
-export interface LiveStateUpdatesToggleMessage
-  extends BaseToDeviceAgentMessage {
-  messageType: LiveStateUpdatesTogglesMessageType;
-  payload: LiveStateUpdatesTogglePayload;
-}

package/src/device-stats-schema.ts

@@ -1,33 +0,0 @@
-// To Device Status Structures
-
-import { DeviceStatsMessageType } from './constants';
-import { BaseToClientMessage } from './types';
-
-interface CpuDetails {
-  usedPerc?: number;
-  temperature?: number;
-}
-
-interface DiskDetails {
-  usedGb?: number;
-  freeGb?: number;
-}
-
-interface MemDetails {
-  usedMb?: number;
-  freeMb?: number;
-}
-
-export interface DeviceStatsPayload {
-  cpuUsage?: number;
-  diskUtil?: number;
-  usedMemoryPercentage?: number;
-  cpuDetails?: CpuDetails;
-  diskDetails?: DiskDetails;
-  memDetails?: MemDetails;
-}
-
-export interface DeviceStatsMessage extends BaseToClientMessage {
-  messageType: DeviceStatsMessageType;
-  payload: DeviceStatsPayload;
-}

package/src/index.ts

@@ -1,182 +0,0 @@
-// export types here
-import {
-  validateToDeviceAgentMessage,
-  validateToClientMessage,
-  BaseToDeviceAgentMessage,
-  ToDeviceAgentMessage,
-  ToDeviceAgentMessagePayload,
-  BaseToClientMessage,
-  ToClientMessage,
-  ToClientMessagePayload,
-  BaseToCloudMessage,
-  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';
-import {
-  AppInstallResponsePayload,
-  ModelsInstallResponsePayload,
-  AppStateControlMessage,
-  AppStateControlPayload,
-  AppVersionControlInstallPayload,
-  AppVersionControlUninstallPayload,
-  AppVersionControlMessage,
-  ModelInstallPayload
-} from './app-action-schema';
-import {
-  ToClientMessageTypeValue,
-  ToDeviceAgentMessageTypeValue,
-  AppStateControlValue,
-  AppStateValue,
-  keyMirrors,
-  AppStateControlMessageType,
-  AppLogsMessageType,
-  DeviceStatsMessageType,
-  AppStateMessageType,
-  SignedUrlsRequestMessageType,
-  StatusResponseMessageType,
-  StatusResponseValue,
-  ToCloudMessageTypeValue
-} from './constants';
-import {
-  LiveStateUpdatesTogglePayload,
-  LiveStateUpdatesToggleMessage
-} from './device-agent-action-schema';
-import { DeviceStatsPayload, DeviceStatsMessage } from './device-stats-schema';
-import {
-  StatusResponsePayload,
-  ToClientStatusResponseMessage,
-  ToDeviceStatusResponseMessage
-} from './status-response-schema';
-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 {
-  // getters
-  getToClientTopic,
-  getToCloudTopic,
-  getToDeviceTopic,
-  getShadowTopic,
-  getDesiredFromMessage,
-  // types
-  AppDetails,
-  ServiceStatus,
-  AppState,
-  AppStateControlValue,
-  AppStateValue,
-  ProjectShadowUpdate,
-  ShadowProjectsUpdateAll,
-  SystemInformationShadowUpdate,
-  // messageTypes
-  ToCloudMessageTypeValue,
-  AppStateControlMessageType,
-  AppLogsMessageType,
-  DeviceStatsMessageType,
-  AppStateMessageType,
-  SignedUrlsRequestMessageType,
-  StatusResponseMessageType,
-  // messages and payloads
-  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,
-  // message validators
-  validateToDeviceAgentMessage,
-  validateToClientMessage,
-  validateToCloudMessage,
-  validateShadowProjectsUpdateAll,
-  validateProjectShadowUpdate,
-  validateSystemInformationShadowUpdate,
-  // message builders
-  buildAppLogsMessage,
-  buildAppStateMessage,
-  buildDeviceStatsMessage,
-  buildSignedUrlsRequestMessage,
-  buildToClientStatusResponseMessage,
-  buildToDeviceStatusResponseMessage,
-  buildAppVersionControlMessage,
-  buildLiveStateUpdatesToggleMessage,
-  buildAppStateControlMessage,
-  buildDeviceActionMessage,
-  buildBaseShadowMessage,
-  buildUpdateProjectShadowMessage,
-  buildUpdateSystemInfoShadowMessage,
-  // key mirrors
-  keyMirrors,
-  ShadowTopics,
-  ShadowNames,
-  // utilities
-  generateTxId
-};