@alwaysai/device-agent-schemas 0.0.1

package/src/types.ts

@@ -0,0 +1,95 @@
+import Ajv, { JSONSchemaType } from 'ajv';
+import { commonSchema } from './schemas/common-schema';
+import { deviceStatusSchema, DeviceStatsMessage } from './schemas/device-status-schema';
+import {
+  applicationStateSchema,
+  AppStateMessage,
+} from './schemas/application-state-schema';
+import { actionSchema, ActionMessage } from './schemas/action-schema';
+import { applicationLogsSchema, AppLogsMessage } from './schemas/application-logs-schema';
+import { DEVICE_ID_PATTERN } from './constants';
+import { loadSchemaAsObject } from './utils';
+
+// Message Packet Structures
+export interface DeviceAgentMessage {
+  deviceId: string;
+  timestamp: string;
+  topic: string;
+  payload: ActionMessage | DeviceStatsMessage | AppLogsMessage | AppStateMessage;
+}
+
+// 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 Ajv({
+  schemas: [commonSchema],
+});
+
+const messageSchema = loadSchemaAsObject({
+  $id: 'iot_message_schema.json',
+  title: 'Payload',
+  description:
+    'A schema that describes the messaging payload structure for the alwaysAI Device Agent Cloud Connection',
+  type: 'object',
+  properties: {
+    timestamp: {
+      type: 'string',
+    },
+    deviceId: {
+      description: 'The version of the project associated with the message payload.',
+      type: 'string',
+    },
+    topic: {
+      oneOf: [
+        { $ref: '#/$defs/applicationManagementTopic' },
+        { $ref: '#/$defs/deviceManagementTopic' },
+      ],
+    },
+    payload: {
+      oneOf: [
+        { $ref: 'action_schema.json#/$defs/action' },
+        { $ref: 'device_schema.json#/$defs/status' },
+        { $ref: 'state_schema.json#/$defs/applicationState' },
+        { $ref: 'application_logs_schema.json#/$defs/applicationLogs' },
+      ],
+    },
+  },
+  required: ['timestamp', 'deviceId', 'topic', 'payload'],
+  additionalProperties: false,
+  $defs: {
+    applicationManagementTopic: {
+      description:
+        'The specific topic to which the message payload was published, for application management commands.',
+      type: 'string',
+      pattern: `^device/${DEVICE_ID_PATTERN}/topic/application-management`,
+    },
+    deviceManagementTopic: {
+      description:
+        'The specific topic to which the message payload was published, for device management data.',
+      type: 'string',
+      pattern: `^device/${DEVICE_ID_PATTERN}/topic/device-management`,
+    },
+  },
+});
+
+// Device Status Codec and Validation Method
+export const deviceMessageSchemaType: JSONSchemaType<DeviceStatsMessage> =
+  loadSchemaAsObject(deviceStatusSchema);
+export const validateDeviceStatsMessage = ajv.compile(deviceMessageSchemaType);
+
+// Application Log Codec and Validation Method
+export const appLogsMessageSchemaType: JSONSchemaType<AppLogsMessage> =
+  loadSchemaAsObject(applicationLogsSchema);
+export const validateAppLogsMessage = ajv.compile(appLogsMessageSchemaType);
+
+// Application State Codec and Validation Method
+export const appStateMessageSchemaType: JSONSchemaType<AppStateMessage> =
+  loadSchemaAsObject(applicationStateSchema);
+export const validateAppStateMessage = ajv.compile(appStateMessageSchemaType);
+
+export const actionMessageSchemaType: JSONSchemaType<ActionMessage> =
+  loadSchemaAsObject(actionSchema);
+export const validateActionMessage = ajv.compile(actionMessageSchemaType);
+
+// Overall IoT Core Message Codec and Validation Method
+const messageSchemaType: JSONSchemaType<DeviceAgentMessage> = messageSchema;
+export const validateDeviceAgentMessage = ajv.compile(messageSchemaType);

package/src/utils.ts

@@ -0,0 +1,3 @@
+export function loadSchemaAsObject(schema: object) {
+  return JSON.parse(JSON.stringify(schema));
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {}
+}

package/tsconfig.json

@@ -0,0 +1,92 @@
+{
+  "extends": "@alwaysai/tsconfig/nodejs/tsconfig.json",
+  "include": [
+    "src",
+    "src/types/.ts",
+    "src/schemas/.ts"
+  ],
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./lib",
+    // "allowJs": false,
+    "allowSyntheticDefaultImports": true,
+    // "allowUnreachableCode": false,
+    // "allowUnusedLabels": false,
+    "alwaysStrict": false,
+    // "baseUrl": ".",
+    // "build": false,
+    // "charset": "utf8",
+    // "checkJs": false,
+    // "composite": true,
+    "declaration": true,
+    // "declarationDir": ".",
+    "declarationMap": true,
+    // "diagnostics": false,
+    // "disableSizeLimit": false,
+    "downlevelIteration": true,
+    // "emitBOM": false,
+    // "emitDeclarationOnly": false,
+    // "emitDecoratorMetadata": false,
+    // "esModuleInterop": false,
+    // "experimentalDecorators": false,
+    "forceConsistentCasingInFileNames": true,
+    // "importHelpers": false,
+    // "inlineSourceMap": false,
+    // "inlineSources": false,
+    // "isolatedModules": false,
+    // "jsx": "preserve",
+    // "jsxFactory": "React.createElement",
+    // "keyofStringsOnly": false,
+    // "lib": [],
+    // "listEmittedFiles": false,
+    // "listFiles": false,
+    // "locale": "en",
+    // "mapRoot": ".",
+    // "maxNodeModuleJsDepth": 0,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "newLine": "lf",
+    // "noEmit": false,
+    // "noEmitHelpers": false,
+    "noEmitOnError": false,
+    "noErrorTruncation": true,
+    // "noFallthroughCasesInSwitch": false,
+    "noImplicitAny": false,
+    "noImplicitReturns": false,
+    "noImplicitThis": false,
+    // "noImplicitUseStrict": false,
+    // "noLib": false,
+    // "noStrictGenericChecks": false,
+    // "noResolve": false,
+    // "noUnusedLocals": false,
+    // "noUnusedParameters": false,
+    // "out": DEPRECATED
+    // "outDir": "lib",
+    // "outFile": "dist/lib.js",
+    // "paths": [],
+    // "preserveConstEnums": false,
+    // "preserveSymlinks": false,
+    // "preserveWatchOutput": false,
+    // "pretty": true,
+    // "reactNamespace": DEPRECATED
+    // "removeComments": false,
+    "resolveJsonModule": true,
+    // "rootDir": "src",
+    // "rootDirs": ["src"],
+    // "skipDefaultLibCheck": DEPRECATED
+    // "skipLibCheck": false,
+    "sourceMap": true,
+    // "sourceRoot": ".",
+    "strict": false,
+    "strictFunctionTypes": false,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false
+    // "stripInternal": false,
+    // "suppressExcessPropertyErrors": false,
+    // "suppressImplicitAnyIndexErrors": false,
+    // "target": "esnext",
+    // "traceResolution": false,
+    // "types": [],
+    // "typeRoots": [],
+  }
+}