feat(versioned-configs): add version to serialized config

ExploratoryEngineering · Dec 3, 2018 · 6985bb9 · 6985bb9
1 parent 609eab5
commit 6985bb9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/DataMapperChain.spec.ts b/src/DataMapperChain.spec.ts
@@ -3,6 +3,8 @@ import { Mappers } from "./Mappers";
 import { IDataValue, IMapper, IMapperConfig, IOutputType } from "./Typings";
 
 const { Base64, Chunk, FromJSON, HexToFloat, HexToInt, Offset } = Mappers;
+// tslint:disable-next-line:no-var-requires
+const { version } = require("../package.json");
 
 class MapperMock implements IMapper {
   initParams: any = {};
@@ -71,14 +73,14 @@ describe("Data mapper chain", () => {
       dataMapperChain.mappers = [];
 
       const serializedConfig = dataMapperChain.serializeConfig();
-      expect(serializedConfig).toBe(`{"name":"Test","mappers":[]}`);
+      expect(serializedConfig).toBe(`{"name":"Test","version":"${version}","mappers":[]}`);
     });
 
     it("should correctly serialize with mapper", () => {
       dataMapperChain.addMapper(new MapperMock());
 
       const serializedConfig = dataMapperChain.serializeConfig();
-      expect(serializedConfig).toBe(`{"name":"","mappers":[{"id":"MOCK","params":{"p1":1,"p2":"2"}}]}`);
+      expect(serializedConfig).toBe(`{"name":"","version":"${version}","mappers":[{"id":"MOCK","params":{"p1":1,"p2":"2"}}]}`);
     });
 
     it("should correctly deserialize with no mappers", () => {

diff --git a/src/DataMapperChain.ts b/src/DataMapperChain.ts
@@ -2,6 +2,7 @@ import { IBase64Config, IChunkConfig, IFromJSONConfig, IHexToFloatConfig, IHexTo
 import { AVAILABLE_MAPPERS_TYPES, Mappers } from "./Mappers";
 import { IDataValue, IMapper, IMapperConfig, IMapperType } from "./Typings";
 
+const CURRENT_VERSION = "0.6.0";
 const { Base64, Chunk, FromJSON, HexToFloat, HexToInt, Offset } = Mappers;
 
 /**
@@ -63,6 +64,7 @@ export class DataMapperChain {
   serializeConfig(): string {
     return JSON.stringify({
       name: this.name,
+      version: CURRENT_VERSION,
       mappers: this.mappers.map((mapper) => {
         return mapper.config();
       }),