feat: make application protocols into a package (#10)

* feat: add validation for LTE messages

- Add entry point in dist/index.js
- index.ts takes a message and validates appId, messageType, and data

* build: change tsconfig to target es2015

* build: include dist

Author: MagWeaver

.gitignore

@@ -1,4 +1,3 @@
-dist/
 node_modules/
 npm-debug.log
 .idea/

__tests__/validateMessageSchema.spec.ts

@@ -0,0 +1,59 @@
+import { isMessageValid } from '../index';
+
+const validGPSLTEMessage = {
+    appId: 'GPS',
+    messageType: 'DATA',
+    data:
+        '$GPGGA,141856.00,6326.27336,N,01028.08721,E,1,09,0.81,34.7,M,39.8,M,,*64',
+};
+
+const invalidGPSLTEMessageAppId = {
+    appId: 'MAGNETIC', // appId is not supported
+    messageType: 'DATA',
+    data: '{x: 0.5, y: 0.2, z: 0.3}',
+};
+
+const invalidGPSLTEMessageType = {
+    appId: 'GPS',
+    messageType: 'COORDINATES', // message type is not supported
+    data:
+        '$GPGGA,141856.00,6326.27336,N,01028.08721,E,1,09,0.81,34.7,M,39.8,M,,*64',
+};
+
+const invalidGPSLTEMessageData = {
+    appId: 'GPS',
+    messageType: 'DATA',
+    data: '$GPWPL,5128.62,N,00027.58,W,EGLL*59', // GPWPL - waypoint location format, this is not supported
+};
+
+describe('schema validation', () => {
+    beforeEach(() => {
+        console.error = jest.fn();
+    });
+
+    afterEach(() => {
+        (console.error as jest.Mock).mockRestore();
+    });
+
+    it('should return true for a valid schema', () => {
+        expect(isMessageValid(validGPSLTEMessage)).toBe(true);
+    });
+    it('should return false for a schema with invalid appId', () => {
+        expect(isMessageValid(invalidGPSLTEMessageAppId)).toBe(false);
+        expect((console.error as jest.Mock).mock.calls[0][0]).toBe(
+            'Schema does not exist',
+        );
+    });
+    it('should return false for a schema with invalid message type', () => {
+        expect(isMessageValid(invalidGPSLTEMessageType)).toBe(false);
+        expect((console.error as jest.Mock).mock.calls[0][0]).toBe(
+            'validation error',
+        );
+    });
+    it('should return false for an invalid schema data', () => {
+        expect(isMessageValid(invalidGPSLTEMessageData)).toBe(false);
+        expect((console.error as jest.Mock).mock.calls[0][0]).toBe(
+            'validation error',
+        );
+    });
+});

dist/index.d.ts

@@ -0,0 +1,12 @@
+export declare enum AppId {
+    Gps = "GPS",
+    Flip = "FLIP",
+    Gen = "GEN",
+    Temp = "TEMP",
+    Humid = "HUMID",
+    AirPress = "AIR_PRESS",
+    RSRP = "RSRP",
+    Button = "BUTTON",
+    Device = "DEVICE"
+}
+export declare const isMessageValid: (message: any) => boolean;

dist/index.js

@@ -0,0 +1,38 @@
+import * as Ajv from 'ajv';
+import * as path from 'path';
+import * as fs from 'fs';
+const ajv = new Ajv();
+export var AppId;
+(function (AppId) {
+    AppId["Gps"] = "GPS";
+    AppId["Flip"] = "FLIP";
+    AppId["Gen"] = "GEN";
+    AppId["Temp"] = "TEMP";
+    AppId["Humid"] = "HUMID";
+    AppId["AirPress"] = "AIR_PRESS";
+    AppId["RSRP"] = "RSRP";
+    AppId["Button"] = "BUTTON";
+    AppId["Device"] = "DEVICE";
+})(AppId || (AppId = {}));
+const getJsonSchema = (appId) => {
+    const filePath = path.join(__dirname, 'schemas', `${appId.toLowerCase()}.json`);
+    const schema = fs.readFileSync(filePath, 'utf8');
+    return JSON.parse(schema);
+};
+export const isMessageValid = (message) => {
+    const appId = message.appId;
+    let jsonSchema;
+    try {
+        jsonSchema = getJsonSchema(appId);
+    }
+    catch (e) {
+        console.error('Schema does not exist', e);
+        return false;
+    }
+    const compiledSchema = ajv.compile(jsonSchema);
+    const isValid = compiledSchema(message);
+    if (!isValid) {
+        console.error('validation error', compiledSchema.errors);
+    }
+    return isValid;
+};

index.ts

@@ -0,0 +1,44 @@
+import * as Ajv from 'ajv';
+import * as path from 'path';
+import * as fs from 'fs';
+
+const ajv = new Ajv();
+
+export enum AppId {
+    Gps = 'GPS',
+    Flip = 'FLIP',
+    Gen = 'GEN',
+    Temp = 'TEMP',
+    Humid = 'HUMID',
+    AirPress = 'AIR_PRESS',
+    RSRP = 'RSRP',
+    Button = 'BUTTON',
+    Device = 'DEVICE',
+}
+
+const getJsonSchema = (appId: AppId) => {
+    const filePath = path.join(__dirname, 'schemas', `${appId.toLowerCase()}.json`);
+    const schema = fs.readFileSync(filePath, 'utf8');
+    return JSON.parse(schema);
+};
+
+export const isMessageValid = (message: any): boolean => {
+    const appId = message.appId;
+    let jsonSchema;
+
+    try {
+        jsonSchema = getJsonSchema(appId);
+    } catch (e) {
+        console.error('Schema does not exist', e);
+        return false;
+    }
+
+    const compiledSchema = ajv.compile(jsonSchema);
+    const isValid = compiledSchema(message) as boolean;
+
+    if (!isValid) {
+        console.error('validation error', compiledSchema.errors);
+    }
+
+    return isValid;
+};

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@nrfcloud/application-protocols",
   "version": "1.0.0",
+  "main": "dist/index.js",
   "description": "Contains the application protocol definition for long-range devices connecting to nRF Connect for Cloud",
   "scripts": {
     "test": "jest",

schemas/press.json renamed to schemas/air_press.json

@@ -1,15 +1,16 @@
 {
     "compilerOptions": {
-        "module": "commonjs",
-        "target": "es2017",
+        "module": "es2015",
+        "target": "es2015",
         "strict": true,
         "outDir": "dist/",
+        "moduleResolution": "node",
         "declaration": true,
         "skipLibCheck": true,
         "noUnusedParameters": true,
         "noUnusedLocals": true
     },
     "include": [
-        "src/**/*"
+        "index.ts"
     ]
 }