@alwaysai/device-agent-schemas 2.3.2 → 2.3.4

package/src/schemas/signed-urls-request-schema.json

@@ -1,42 +0,0 @@
-{
-  "$id": "https://alwaysai.co/signed-urls-request-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "signed_urls_request",
-  "type": "object",
-  "properties": {
-    "signedUrlsRequest": {
-      "type": "object",
-      "properties": {
-        "projectId": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-        },
-        "appReleaseHash": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/appReleaseHash"
-        }
-      },
-      "required": ["projectId", "appReleaseHash"],
-      "additionalProperties": false
-    },
-    "modelsOnlyUrlsRequest": {
-      "type": "object",
-      "properties": {
-        "projectId": {
-          "$ref": "https://alwaysai.co/common-schema.json#/$defs/projectId"
-        },
-        "models": {
-          "type": "object",
-          "patternProperties": {
-            "[A-Za-z0-9_]+/[A-Za-z0-9_]*": {
-              "type": ["integer"]
-            }
-          },
-          "additionalProperties": false
-        }
-      },
-      "required": ["projectId", "models"],
-      "additionalProperties": false
-    }
-  },
-  "required": [],
-  "additionalProperties": false
-}

package/src/schemas/status-response-schema.json

@@ -1,16 +0,0 @@
-{
-  "$id": "https://alwaysai.co/status-response-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "status_response",
-  "type": "object",
-  "properties": {
-    "status": {
-      "enum": ["requested", "in_progress", "failure", "success", "connection_lost"]
-    },
-    "message": {
-      "type": "string"
-    }
-  },
-  "required": ["status"],
-  "additionalProperties": false
-}

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

@@ -1,155 +0,0 @@
-{
-    "$id": "https://alwaysai.co/system-information-schema.json",
-    "$schema": "https://json-schema.org/draft/2019-09/schema",
-    "title": "system-information",
-    "type": "object",
-    "properties": {
-      "os": {
-        "type": "object",
-        "properties": {
-            "platform": {
-              "type": "string"
-            },
-            "distro": {
-              "type": "string"
-            },
-            "release": {
-              "type": "string"
-            },
-            "kernel": {
-              "type": "string"
-            },
-            "architecture": {
-              "type": "string"
-            },
-            "hostname": {
-              "type": "string"
-            }
-        },
-        "additionalProperties": false
-      },
-      "cpu": {
-        "type": "object",
-        "properties": {
-          "manufacturer": {
-            "type": "string"
-          },
-          "brand": {
-            "type": "string"
-          },
-          "vendor": {
-            "type": "string"
-          },
-          "model": {
-            "type": "string"
-          },
-          "cores": {
-            "type": "number"
-          },
-          "physicalCores": {
-            "type": "number"
-          },
-          "efficiencyCores": {
-            "type": "number"
-          },
-          "processors": {
-            "type": "number"
-          }
-        },
-        "additionalProperties": false
-      },
-      "disk": {
-        "type": "object",
-        "properties": {
-          "drives": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "properties": {
-                "device": {
-                  "type": "string"
-                },
-                "type": {
-                  "type": "string"
-                },
-                "name": {
-                  "type": "string"
-                },
-                "vendor": {
-                  "type": "string"
-                },
-                "size": {
-                  "type": "number"
-                }
-              }
-            }
-          }
-        },
-        "additionalProperties": false
-      },
-      "device": {
-        "type": "object",
-        "properties": {
-          "manufacturer": {
-            "type": "string"
-          },
-          "model": {
-            "type": "string"
-          },
-          "version": {
-            "type": "string"
-          },
-          "serial": {
-            "type": "string"
-          },
-          "virtual": {
-            "type": "boolean"
-          }
-        },
-        "additionalProperties": false
-      },
-      "network": {
-        "type": "object",
-        "properties": {
-          "ipv4Address": {
-            "type": "string"
-          },
-          "ipv6Address": {
-            "type": "string"
-          },
-          "macAddress": {
-            "type": "string"
-          }
-        },
-        "additionalProperties": false
-      },
-      "versions": {
-        "type": "object",
-        "properties": {
-          "agent": {
-            "type": "string"
-          },
-          "deviceAgentSchemas": {
-            "type": "string"
-          },
-          "npm": {
-            "type": "string"
-          },
-          "node": {
-            "type": "string"
-          },
-          "docker": {
-            "type": "string"
-          },
-          "dockerCompose": {
-            "type": "string"
-          }
-        },
-        "additionalProperties": false
-      },
-      "lastBootTime": {
-        "type": "string"
-      }
-    },
-    "additionalProperties": false
-  }

package/src/schemas/to-client-message-schema.json

@@ -1,98 +0,0 @@
-{
-  "$id": "https://alwaysai.co/to-client-message-schema.json",
-  "title": "to_client_message",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "description": "The messaging payload structure for messages sent from device agent to clients",
-  "type": "object",
-  "properties": {
-    "timestamp": {
-      "type": "string"
-    },
-    "deviceId": {
-      "description": "Device UUID of device sending the message",
-      "type": "string"
-    },
-    "topic": {
-      "oneOf": [{ "$ref": "#/$defs/toClient" }]
-    },
-    "messageType": {
-      "type": "string",
-      "enum": [
-        "device_stats",
-        "app_state",
-        "status_response",
-        "app_logs"
-      ]
-    },
-    "txId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
-    },
-    "payload": {
-      "oneOf": [
-        { "$ref": "https://alwaysai.co/device-stats-schema.json" },
-        { "$ref": "https://alwaysai.co/app-state-schema.json" },
-        { "$ref": "https://alwaysai.co/app-logs-schema.json" },
-        { "$ref": "https://alwaysai.co/status-response-schema.json" }
-      ]
-    }
-  },
-  "allOf":[
-  {
-    "if": {
-      "properties": {
-        "messageType": { "const": "device_stats" }
-      }
-    },
-    "then": {
-      "properties": {
-        "payload": {"$ref": "https://alwaysai.co/device-stats-schema.json"}
-      }
-    }
-  },
-  {
-    "if": {
-      "properties": {
-        "messageType": { "const": "app_state" }
-      }
-    },
-    "then": {
-      "properties": {
-        "payload": {"$ref": "https://alwaysai.co/app-state-schema.json"}
-      }
-    }
-  },
-  {
-    "if": {
-      "properties": {
-        "messageType": { "const": "status_response" }
-      }
-    },
-    "then": {
-      "properties": {
-        "payload": {"$ref": "https://alwaysai.co/status-response-schema.json"}
-      }
-    }
-  },
-  {
-    "if": {
-      "properties": {
-        "messageType": { "const": "app_logs" }
-      }
-    },
-    "then": {
-      "properties": {
-        "payload": {"$ref": "https://alwaysai.co/app-logs-schema.json"}
-      }
-    }
-  }
-  ],
-  "required": ["timestamp", "deviceId", "txId", "payload", "messageType"],
-  "additionalProperties": false,
-  "$defs": {
-    "toClient": {
-      "description": "Messages sent from the device agent to console client",
-      "type": "string",
-      "pattern": "to-client/aai-device/[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/to-cloud-message-schema.json

@@ -1,56 +0,0 @@
-{
-  "$id": "https://alwaysai.co/cloud-message-schema.json",
-  "title": "cloud_message",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "description": "The messaging payload structure for messages sent from device agent to the cloud",
-  "type": "object",
-  "properties": {
-    "timestamp": {
-      "type": "string"
-    },
-    "deviceId": {
-      "description": "Device UUID of device sending the message",
-      "type": "string"
-    },
-    "topic": {
-      "oneOf": [{ "$ref": "#/$defs/toCloud" }]
-    },
-    "messageType": {
-      "type": "string",
-      "enum": [
-        "signed_urls_request"
-      ]
-    },
-    "txId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
-    },
-    "payload": {
-      "oneOf": [
-        { "$ref": "https://alwaysai.co/signed-urls-request-schema.json" }
-      ]
-    }
-  },
-  "allOf":[
-  {
-    "if": {
-      "properties": {
-        "messageType": { "const": "signed_urls_request" }
-      }
-    },
-    "then": {
-      "properties": {
-        "payload": {"$ref": "https://alwaysai.co/signed-urls-request-schema.json"}
-      }
-    }
-  }
-  ],
-  "required": ["timestamp", "deviceId", "txId", "payload", "messageType"],
-  "additionalProperties": false,
-  "$defs": {
-    "toCloud": {
-      "description": "Messages sent from the device agent to cloud backend client",
-      "type": "string",
-      "pattern": "to-cloud/aai-device/[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/to-device-agent-message-schema.json

@@ -1,135 +0,0 @@
-{
-  "$id": "https://alwaysai.co/to-device-agent-message-schema.json",
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "title": "to_device_agent_message",
-  "description":
-    "A schema that describes the message payload structure for messages sent from clients to device agent",
-  "type": "object",
-  "properties": {
-    "timestamp": {
-      "type": "string"
-    },
-    "topic": { "$ref": "#/$defs/toDevice" },
-    "messageType": {
-      "type": "string",
-      "enum": [
-        "app_state_control",
-        "app_version_control",
-        "app_install_response",
-        "models_install_response",
-        "live_state_updates",
-        "device_action",
-        "status_response"
-      ]
-    },
-    "txId": {
-      "$ref": "https://alwaysai.co/common-schema.json#/$defs/txId"
-    },
-    "payload": {
-      "oneOf": [
-        { "$ref": "https://alwaysai.co/app-state-control-schema.json" },
-        { "$ref": "https://alwaysai.co/app-version-control-schema.json" },
-        { "$ref": "https://alwaysai.co/app-install-response-schema.json" },
-        { "$ref": "https://alwaysai.co/models-install-response-schema.json" },
-        { "$ref": "https://alwaysai.co/live-updates-toggle-schema.json" },
-        { "$ref": "https://alwaysai.co/device-action-schema.json" },
-        { "$ref": "https://alwaysai.co/status-response-schema.json" }
-      ]
-    }
-  },
-  "allOf":[
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "app_state_control" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/app-state-control-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "app_version_control" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/app-version-control-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "app_install_response" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/app-install-response-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "models_install_response" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/models-install-response-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "live_state_updates" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/live-updates-toggle-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "device_action" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/device-action-schema.json"}
-        }
-      }
-    },
-    {
-      "if": {
-        "properties": {
-          "messageType": { "const": "status_response" }
-        }
-      },
-      "then": {
-        "properties": {
-          "payload": {"$ref": "https://alwaysai.co/status-response-schema.json"}
-        }
-      }
-    }
-    ],
-  "required": ["timestamp", "txId", "payload", "messageType"],
-  "additionalProperties": false,
-  "$defs": {
-    "toDevice": {
-      "description": "Topic on which messages are sent to device agent.",
-      "type": "string",
-      "pattern": "^to-device/aai-device/[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/shadow-schema.ts

@@ -1,177 +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 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);
-
-/* ============================================================================
-                                  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 });
-}