@alwaysai/device-agent-schemas 2.3.3 → 2.3.5

package/src/shadow-schema.ts

@@ -1,208 +0,0 @@
-import Ajv2019 from 'ajv/dist/2019';
-import * as shadowProjectsUpdateAllSchema from './schemas/shadow-projects-update-all-schema.json';
-import * as shadowProjectUpdateSchema from './schemas/shadow-project-update-schema.json';
-import * as systemInformationSchema from './schemas/system-information-schema.json';
-import * as secureTunnelSchema from './schemas/secure-tunnel-schema.json';
-import * as commonSchema from './schemas/common-schema.json';
-
-import { keyMirror } from './utils';
-
-const ajv = new Ajv2019({
-  allErrors: true,
-  schemas: [commonSchema]
-});
-
-/* ============================================================================
-                                  Shadow Topics
-============================================================================ */
-
-const SHADOW_PREFIX = `$aws/things/`;
-
-export const ShadowTopics = keyMirror({
-  get: null,
-  'get/accepted': null,
-  'get/rejected': null,
-  update: null,
-  'update/delta': null,
-  'update/accepted': null,
-  'update/rejected': null,
-  delete: null,
-  'delete/accepted': null,
-  'delete/rejected': null
-});
-export type ShadowTopics = keyof typeof ShadowTopics;
-export const SHADOW_TOPICS = Object.keys(ShadowTopics) as ShadowTopics[];
-
-const ShadowNames = keyMirror({
-  projects: null,
-  'system-info': null,
-  'secure-tunnel': null
-});
-export type ShadowNames = keyof typeof ShadowNames;
-export const SHADOW_NAMES = Object.keys(ShadowNames) as ShadowNames[];
-
-export const getShadowTopic = (
-  clientId: string,
-  shadowName: ShadowNames,
-  shadowTopic: ShadowTopics
-) => `${SHADOW_PREFIX}${clientId}/shadow/name/${shadowName}/${shadowTopic}`;
-
-/* ============================================================================
-                                  Project Shadow
-============================================================================ */
-
-export interface ProjectShadowUpdate {
-  appConfig?: string;
-  envVars?: {
-    [service: string]: {
-      [key: string]: string | null;
-    };
-  };
-}
-
-export interface ShadowProjectsUpdateAll {
-  [projectId: string]: ProjectShadowUpdate | null;
-}
-
-// Shadow Message validator functions
-ajv.addSchema(shadowProjectUpdateSchema, 'shadow-project-update-schema.json');
-export const validateProjectShadowUpdate = ajv.compile<ProjectShadowUpdate>(
-  shadowProjectUpdateSchema
-);
-
-ajv.addSchema(
-  shadowProjectsUpdateAllSchema,
-  'shadow-projects-update-all-schema.json'
-);
-export const validateShadowProjectsUpdateAll =
-  ajv.compile<ShadowProjectsUpdateAll>(shadowProjectsUpdateAllSchema);
-
-export function getDesiredFromMessage(message) {
-  if (message?.state?.desired) {
-    return message.state.desired;
-  } else return null;
-}
-
-/* ============================================================================
-                                  System Information Shadow
-============================================================================ */
-
-export interface SystemInformationShadowUpdate {
-  os?: {
-    platform?: string;
-    distro?: string;
-    release?: string;
-    kernel?: string;
-    architecture?: string;
-    hostname?: string;
-  };
-  cpu?: {
-    manufacturer?: string;
-    brand?: string;
-    vendor?: string;
-    model?: string;
-    cores?: number;
-    physicalCores?: number;
-    efficiencyCores?: number;
-  };
-  disk?: {
-    drives: {
-      device?: string;
-      type?: string;
-      name?: string;
-      vendor?: string;
-      size?: number;
-    }[];
-  };
-  device?: {
-    manufacturer?: string;
-    model?: string;
-    version?: string;
-    serial?: string;
-    virtual?: boolean;
-  };
-  network?: {
-    ipv4Address?: string;
-    ipv6Address?: string;
-    macAddress?: string;
-  };
-  versions?: {
-    agent?: string;
-    deviceAgentSchemas?: string;
-    npm?: string;
-    node?: string;
-    docker?: string;
-    dockerCompose?: string;
-  };
-  lastBootTime?: string;
-}
-
-ajv.addSchema(systemInformationSchema, 'system-information-schema.json');
-export const validateSystemInformationShadowUpdate =
-  ajv.compile<SystemInformationShadowUpdate>(systemInformationSchema);
-
-/* ============================================================================
-                                  Secure Tunnel Shadow
-============================================================================ */
-
-export type SecureTunnelPortInfo = {
-  enabled: boolean;
-  type: string;
-  ip: string;
-  port: number;
-};
-
-export type SecureTunnelShadowDescriptionReported = {
-  st_ports: SecureTunnelPortInfo[];
-};
-
-ajv.addSchema(secureTunnelSchema, 'secure-tunnel-schema.json');
-export const validateSecureTunnelShadowUpdate =
-  ajv.compile<SecureTunnelShadowDescriptionReported>(secureTunnelSchema);
-
-/* ============================================================================
-                                  Shadow Message Builders
-============================================================================ */
-
-export function buildBaseShadowMessage(clientId: string) {
-  const baseShadowMessage = {
-    clientToken: clientId
-  };
-  return baseShadowMessage;
-}
-
-export function buildUpdateProjectShadowMessage({
-  clientId,
-  reported,
-  desired
-}: {
-  clientId: string;
-  reported?: ShadowProjectsUpdateAll | SystemInformationShadowUpdate;
-  desired?: ShadowProjectsUpdateAll;
-}) {
-  const state = { reported, desired };
-
-  const message = {
-    ...buildBaseShadowMessage(clientId),
-    state
-  };
-  return message;
-}
-
-export function buildUpdateSystemInfoShadowMessage(
-  clientId: string,
-  systemInfo: SystemInformationShadowUpdate
-) {
-  return buildUpdateProjectShadowMessage({ clientId, reported: systemInfo });
-}
-
-export function buildUpdateSecureTunnelShadowMessage(
-  reported: SecureTunnelShadowDescriptionReported,
-  clientId: string
-) {
-  const message = {
-    ...buildBaseShadowMessage(clientId),
-    state: { reported }
-  };
-  return message;
-}

package/src/signed-urls-request-schema.ts

@@ -1,22 +0,0 @@
-import { SignedUrlsRequestMessageType } from './constants';
-import { BaseToClientMessage } from './types';
-
-type ModelsObject = {
-  [modelId: string]: number;
-};
-
-export interface SignedUrlsRequestPayload {
-  signedUrlsRequest?: {
-    projectId: string;
-    appReleaseHash: string;
-  };
-  modelsOnlyUrlsRequest?: {
-    projectId: string;
-    models: ModelsObject;
-  };
-}
-
-export interface SignedUrlsRequestMessage extends BaseToClientMessage {
-  messageType: SignedUrlsRequestMessageType;
-  payload: SignedUrlsRequestPayload;
-}

package/src/status-response-schema.ts

@@ -1,18 +0,0 @@
-import { StatusResponseMessageType, StatusResponseValue } from './constants';
-import { BaseToClientMessage, BaseToDeviceAgentMessage } from './types';
-
-export interface StatusResponsePayload {
-  status: StatusResponseValue;
-  message?: string;
-}
-
-export interface ToClientStatusResponseMessage extends BaseToClientMessage {
-  messageType: StatusResponseMessageType;
-  payload: StatusResponsePayload;
-}
-
-export interface ToDeviceStatusResponseMessage
-  extends BaseToDeviceAgentMessage {
-  messageType: StatusResponseMessageType;
-  payload: StatusResponsePayload;
-}

package/src/types.ts

@@ -1,175 +0,0 @@
-import Ajv2019 from 'ajv/dist/2019';
-import {
-  CLIENT_TOPIC_PREFIX,
-  CLOUD_TOPIC_PREFIX,
-  DEVICE_TOPIC_PREFIX,
-  DEVICE_TYPE
-} from './constants';
-import * as commonSchema from './schemas/common-schema.json';
-import * as deviceStatsSchema from './schemas/device-stats-schema.json';
-import * as appStateSchema from './schemas/app-state-schema.json';
-import * as appLogsSchema from './schemas/app-logs-schema.json';
-import * as statusResponseSchema from './schemas/status-response-schema.json';
-import * as signedUrlsRequestSchema from './schemas/signed-urls-request-schema.json';
-import * as toDeviceAgentMessageSchema from './schemas/to-device-agent-message-schema.json';
-import * as modelsInstallPayloadSchema from './schemas/models-install-payload-schema.json';
-import * as appInstallSchema from './schemas/app-install-schema.json';
-import * as appUninstallSchema from './schemas/app-uninstall-schema.json';
-import * as toClientMessageSchema from './schemas/to-client-message-schema.json';
-import * as toCloudMessageSchema from './schemas/to-cloud-message-schema.json';
-import * as appStateControlSchema from './schemas/app-state-control-schema.json';
-import * as appVersionControlSchema from './schemas/app-version-control-schema.json';
-import * as appInstallResponseSchema from './schemas/app-install-response-schema.json';
-import * as modelsInstallResponseSchema from './schemas/models-install-response-schema.json';
-import * as liveUpdatesTogglesSchema from './schemas/live-updates-toggle-schema.json';
-import * as deviceActionSchema from './schemas/device-action-schema.json';
-import { AppLogsMessage, AppLogsPayload } from './app-logs-schema';
-import {
-  AppInstallResponseMessage,
-  AppInstallResponsePayload,
-  AppStateControlMessage,
-  AppStateControlPayload,
-  AppVersionControlInstallPayload,
-  AppVersionControlMessage,
-  AppVersionControlUninstallPayload,
-  ModelsInstallResponseMessage,
-  ModelsInstallResponsePayload
-} from './app-action-schema';
-import {
-  LiveStateUpdatesToggleMessage,
-  LiveStateUpdatesTogglePayload
-} from './device-agent-action-schema';
-import {
-  StatusResponsePayload,
-  ToClientStatusResponseMessage,
-  ToDeviceStatusResponseMessage
-} from './status-response-schema';
-import { AppStateMessage, AppStatePayload } from './app-state-schema';
-import {
-  SignedUrlsRequestMessage,
-  SignedUrlsRequestPayload
-} from './signed-urls-request-schema';
-import { DeviceStatsMessage, DeviceStatsPayload } from './device-stats-schema';
-import {
-  DeviceActionMessage,
-  DeviceActionPayload
-} from './device-action-schema';
-
-// Note: the other schemas do not need to be added, because they will
-// automatically be added in the compile step due to $ref usage (and $id lookup)
-const ajv = new Ajv2019({
-  allErrors: true,
-  schemas: [commonSchema]
-});
-
-export const getToClientTopic = (
-  deviceUuid: string,
-  deviceType: string = DEVICE_TYPE
-) => `${CLIENT_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
-
-export const getToCloudTopic = (
-  deviceUuid: string,
-  deviceType: string = DEVICE_TYPE
-) => `${CLOUD_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
-
-export const getToDeviceTopic = (
-  deviceUuid: string,
-  deviceType: string = DEVICE_TYPE
-) => `${DEVICE_TOPIC_PREFIX}/${deviceType}/${deviceUuid}`;
-
-/* ============================================================================
-                              ToClient Message
-============================================================================ */
-
-export interface BaseToClientMessage {
-  deviceId: string;
-  timestamp: string;
-  topic?: string;
-  txId: string;
-}
-
-export type ToClientMessage =
-  | AppLogsMessage
-  | ToClientStatusResponseMessage
-  | AppStateMessage
-  | DeviceStatsMessage;
-
-export type ToClientMessagePayload =
-  | AppLogsPayload
-  | AppStatePayload
-  | DeviceStatsPayload
-  | StatusResponsePayload;
-
-ajv.addSchema(deviceStatsSchema, 'device-stats-schema.json');
-ajv.addSchema(appStateSchema, 'app-state-schema.json');
-ajv.addSchema(appLogsSchema, 'app-logs-schema.json');
-ajv.addSchema(statusResponseSchema, 'status-response-schema.json');
-ajv.addSchema(toClientMessageSchema, 'to-client-message-schema.json');
-export const validateToClientMessage = ajv.compile<BaseToClientMessage>(
-  toClientMessageSchema
-);
-
-/* ============================================================================
-                                  ToCloud Message
-============================================================================ */
-
-export interface BaseToCloudMessage {
-  deviceId: string;
-  timestamp: string;
-  topic?: string;
-  txId: string;
-}
-
-export type ToCloudMessage = SignedUrlsRequestMessage;
-
-export type ToCloudMessagePayload = SignedUrlsRequestPayload;
-
-ajv.addSchema(signedUrlsRequestSchema, 'signed-urls-request-schema.json');
-export const validateToCloudMessage =
-  ajv.compile<BaseToCloudMessage>(toCloudMessageSchema);
-
-/* ============================================================================
-                                  To Device Agent Message
-============================================================================ */
-
-export interface BaseToDeviceAgentMessage {
-  timestamp: string;
-  topic?: string;
-  txId: string;
-}
-
-export type ToDeviceAgentMessage =
-  | AppStateControlMessage
-  | AppVersionControlMessage
-  | LiveStateUpdatesToggleMessage
-  | ToDeviceStatusResponseMessage
-  | AppInstallResponseMessage
-  | ModelsInstallResponseMessage
-  | DeviceActionMessage;
-
-export type ToDeviceAgentMessagePayload =
-  | AppStateControlPayload
-  | AppVersionControlInstallPayload
-  | AppVersionControlUninstallPayload
-  | LiveStateUpdatesTogglePayload
-  | StatusResponsePayload
-  | AppInstallResponsePayload
-  | ModelsInstallResponsePayload
-  | DeviceActionPayload;
-
-ajv.addSchema(modelsInstallPayloadSchema, 'models-install-payload-schema.json');
-ajv.addSchema(appInstallSchema, 'app-install-schema.json');
-ajv.addSchema(appUninstallSchema, 'app-uninstall-schema.json');
-ajv.addSchema(appStateControlSchema, 'app-state-control-schema.json');
-ajv.addSchema(appVersionControlSchema, 'app-version-control-schema.json');
-ajv.addSchema(appInstallResponseSchema, 'app-install-response-schema.json');
-ajv.addSchema(
-  modelsInstallResponseSchema,
-  'models-install-response-schema.json'
-);
-ajv.addSchema(liveUpdatesTogglesSchema, 'live-updates-toggle-schema.json');
-ajv.addSchema(deviceActionSchema, 'device-action-schema.json');
-
-export const validateToDeviceAgentMessage = ajv.compile<ToDeviceAgentMessage>(
-  toDeviceAgentMessageSchema
-);

package/src/utils.ts

@@ -1,21 +0,0 @@
-import { v4 as uuidv4 } from 'uuid';
-
-export function loadSchemaAsObject(schema: object) {
-  return JSON.parse(JSON.stringify(schema));
-}
-
-/* eslint-disable */
-export function keyMirror<T extends object>(obj: T): { [K in keyof T]: K } {
-  const newObj = {};
-  for (const key in obj) {
-    if (obj.hasOwnProperty(key)) {
-      newObj[String(key)] = key;
-    }
-  }
-  return newObj as { [K in keyof T]: K };
-}
-/* eslint-enable */
-
-export function generateTxId(): string {
-  return uuidv4();
-}

package/tests/constants.test.ts

@@ -1,41 +0,0 @@
-import {
-  APP_RELEASE_ID_PATTERN,
-  CLIENT_TOPIC_PREFIX,
-  CLOUD_TOPIC_PREFIX,
-  DEVICE_TOPIC_PREFIX,
-  DEVICE_TYPE,
-  MODEL_ID_PATTERN,
-  PROJECT_ID_PATTERN
-} from '../src/constants';
-import * as commonSchema from '../src/schemas/common-schema.json';
-import * as toClientMessageSchema from '../src/schemas/to-client-message-schema.json';
-import * as toCloudMessageSchema from '../src/schemas/to-cloud-message-schema.json';
-import * as toDeviceAgentMessageSchema from '../src/schemas/to-device-agent-message-schema.json';
-
-describe('Validate regex in schemas matches constants', () => {
-  test('to-client-message-schema', () => {
-    expect(toClientMessageSchema.$defs.toClient.pattern).toEqual(
-      `${CLIENT_TOPIC_PREFIX}/${DEVICE_TYPE}/${PROJECT_ID_PATTERN}`
-    );
-  });
-
-  test('to-cloud-message-schema', () => {
-    expect(toCloudMessageSchema.$defs.toCloud.pattern).toEqual(
-      `${CLOUD_TOPIC_PREFIX}/${DEVICE_TYPE}/${PROJECT_ID_PATTERN}`
-    );
-  });
-
-  test('to-device-agent-message-schema', () => {
-    expect(toDeviceAgentMessageSchema.$defs.toDevice.pattern).toEqual(
-      `^${DEVICE_TOPIC_PREFIX}/${DEVICE_TYPE}/${PROJECT_ID_PATTERN}`
-    );
-  });
-
-  test('common-schema', () => {
-    expect(commonSchema.$defs.projectId.pattern).toEqual(PROJECT_ID_PATTERN);
-    expect(commonSchema.$defs.appReleaseHash.pattern).toEqual(
-      APP_RELEASE_ID_PATTERN
-    );
-    expect(commonSchema.$defs.modelId.pattern).toEqual(MODEL_ID_PATTERN);
-  });
-});

package/tests/shadow-schema.test.ts

@@ -1,192 +0,0 @@
-import {
-  getShadowTopic,
-  validateShadowProjectsUpdateAll,
-  buildBaseShadowMessage,
-  buildUpdateProjectShadowMessage,
-  buildUpdateSystemInfoShadowMessage,
-  SystemInformationShadowUpdate,
-  ShadowProjectsUpdateAll,
-  SecureTunnelShadowDescriptionReported,
-  buildUpdateSecureTunnelShadowMessage
-} from '../src/shadow-schema';
-
-const validShadowProjectsUpdateStructures: ShadowProjectsUpdateAll[] = [
-  {
-    '1111e3b3-1d06-4c90-839c-8dcbb60b1053': {
-      appConfig: 'stringified_json'
-    }
-  },
-  {
-    '2222e3b3-1d06-4c90-839c-8dcbb60b1053': {
-      envVars: {
-        alwaysai: {
-          VAR0: 'VAL0',
-          VAR1: 'VAL1'
-        }
-      }
-    }
-  },
-  {
-    '3333e3b3-1d06-4c90-839c-8dcbb60b1053': {
-      appConfig: 'stringified_json',
-      envVars: {
-        alwaysai: {
-          VAR0: 'VAL0',
-          VAR1: 'VAL1'
-        }
-      }
-    }
-  },
-  {
-    '4444e3b3-1d06-4c90-839c-8dcbb60b1053': {
-      appConfig: 'stringified_json'
-    },
-    '5555e3b3-1d06-4c90-839c-8dcbb60b1053': {
-      envVars: {
-        alwaysai: {
-          VAR0: 'VAL0',
-          VAR1: 'VAL1'
-        }
-      }
-    }
-  },
-  {
-    '6666e3b3-1d06-4c90-839c-8dcbb60b1053': null
-  }
-];
-
-const invalidShadowProjectsUpdateStructures = [
-  {
-    project0: {
-      appConfig: {
-        key: 'value'
-      }
-    }
-  },
-  {
-    project0: {
-      envVars: 'unexpected-string'
-    }
-  }
-];
-
-const validBaseMessage = {
-  clientToken: '111'
-};
-const validSystemInfoMessage = {
-  clientToken: '111',
-  state: {
-    reported: {
-      cpu: {
-        brand: 'walmart'
-      }
-    }
-  }
-};
-const validShadowUpdateMessage = {
-  clientToken: '111',
-  state: {
-    reported: {
-      ...validShadowProjectsUpdateStructures[0],
-      ...validShadowProjectsUpdateStructures[1]
-    }
-  }
-};
-const validSecureTunnelUpdateMessage = {
-  clientToken: '111',
-  state: {
-    reported: {
-      st_ports: [
-        { enabled: false, type: 'test', ip: '141.193.213.20', port: 13 }
-      ]
-    }
-  }
-};
-
-const validGetAccepted: ShadowProjectsUpdateAll[] = [];
-validShadowProjectsUpdateStructures.forEach((updateDelta) => {
-  validGetAccepted.push(updateDelta);
-});
-validGetAccepted.push({});
-
-function validateSuccess(items, validateFunc) {
-  items.forEach((item) => {
-    const valid = validateFunc(item);
-    if (!valid) {
-      // eslint-disable-next-line no-console
-      console.log(item);
-      // eslint-disable-next-line no-console
-      console.log(validateShadowProjectsUpdateAll.errors);
-    }
-    expect(valid).toBe(true);
-  });
-}
-
-function validateFailure(items, validateFunc) {
-  items.forEach((item) => {
-    expect(validateFunc(item)).toBe(false);
-  });
-}
-
-describe('Test project shadow messages', () => {
-  test('valid update delta', () => {
-    validateSuccess(validGetAccepted, validateShadowProjectsUpdateAll);
-  });
-
-  test('test invalid client message', () => {
-    validateFailure(
-      invalidShadowProjectsUpdateStructures,
-      validateShadowProjectsUpdateAll
-    );
-  });
-
-  test('valid base shadow message', () => {
-    const baseMessage = buildBaseShadowMessage('111');
-    expect(baseMessage).toEqual(validBaseMessage);
-  });
-  test('valid update project shadow message', () => {
-    const reported: ShadowProjectsUpdateAll = {
-      '1111e3b3-1d06-4c90-839c-8dcbb60b1053': {
-        appConfig: 'stringified_json'
-      },
-      '2222e3b3-1d06-4c90-839c-8dcbb60b1053': {
-        envVars: {
-          alwaysai: {
-            VAR0: 'VAL0',
-            VAR1: 'VAL1'
-          }
-        }
-      }
-    };
-    const message = buildUpdateProjectShadowMessage({
-      clientId: '111',
-      reported
-    });
-    expect(message).toEqual(validShadowUpdateMessage);
-  });
-  test('valid update system info shadow message', () => {
-    const systemInfo: SystemInformationShadowUpdate = {
-      cpu: { brand: 'walmart' }
-    };
-    const message = buildUpdateSystemInfoShadowMessage('111', systemInfo);
-    expect(message).toEqual(validSystemInfoMessage);
-  });
-  test('valid update secure tunnel shadow message', () => {
-    const reported: SecureTunnelShadowDescriptionReported = {
-      st_ports: [
-        { enabled: false, type: 'test', ip: '141.193.213.20', port: 13 }
-      ]
-    };
-    const message = buildUpdateSecureTunnelShadowMessage(reported, '111');
-    expect(message).toEqual(validSecureTunnelUpdateMessage);
-  });
-});
-
-describe('Test project shadow topic generation', () => {
-  test('shadow topic get', () => {
-    const shadowTopic = getShadowTopic('111', 'projects', 'get/accepted');
-    expect(shadowTopic).toEqual(
-      '$aws/things/111/shadow/name/projects/get/accepted'
-    );
-  });
-});