fix: DateTime type decoding, add file and bytes metric type defs

Author: jedwards1211

spBv1.0.d.ts

@@ -146,13 +146,25 @@ export type TemplateMetric = MetricBase & {
   value: Template
 }
 
+export type BytesMetric = MetricBase & {
+  type: 'Bytes'
+  value: Bytes
+}
+
+export type FileMetric = MetricBase & {
+  type: 'File'
+  value: Bytes
+}
+
 export type Metric =
   | NumberMetric
   | BooleanMetric
   | StringMetric
   | DateTimeMetric
   | DataSetMetric
   | TemplateMetric
+  | BytesMetric
+  | FileMetric
 
 export type NumberParameter = {
   name?: string
@@ -194,3 +206,6 @@ export type Payload = {
 
 export function encodePayload(payload: Payload): Uint8Array
 export function decodePayload(payload: Uint8Array): Payload
+
+export function encodeType(typeString: string): number
+export function decodeType(typeInt: number): string | null | undefined

spBv1.0.js

@@ -275,6 +275,8 @@ function decodeType(typeInt) {
       return 'Boolean'
     case 12:
       return 'String'
+    case 13:
+      return 'DateTime'
     case 14:
       return 'Text'
     case 15:

spBv1.0.js.flow

@@ -176,6 +176,18 @@ export type TemplateMetric = {|
   value: Template,
 |}
 
+export type BytesMetric = {|
+  ...MetricBase,
+  type: 'Bytes',
+  value: Bytes,
+|}
+
+export type FileMetric = {|
+  ...MetricBase,
+  type: 'File',
+  value: Bytes,
+|}
+
 export type Metric =
   | NumberMetric
   | BigIntMetric
@@ -184,6 +196,8 @@ export type Metric =
   | DateTimeMetric
   | DataSetMetric
   | TemplateMetric
+  | BytesMetric
+  | FileMetric
 
 export type NumberParameter = {|
   name?: ?string,

test/spBv1.0.test.js

@@ -3,15 +3,19 @@ const { expect } = require('chai')
 const { encodePayload, decodePayload } = require('../spBv1.0')
 
 function checkRoundTrip(value, type, expected) {
-  const actual = decodePayload(
+  const decoded = decodePayload(
     encodePayload({
       timestamp: Date.now(),
       metrics: [{ value, type }],
     })
-  ).metrics[0].value
+  ).metrics[0]
 
-  if (expected !== expected) expect(actual).to.be.NaN
-  else expect(actual).to.equal(expected !== undefined ? expected : value)
+  if (expected !== expected) expect(decoded.value).to.be.NaN
+  else
+    expect(decoded.value).to.deep.equal(
+      expected !== undefined ? expected : value
+    )
+  expect(decoded.type).to.equal(type)
 }
 
 const floatBuf = Buffer.alloc(4)
@@ -70,4 +74,18 @@ describe(`spBv1.0`, function () {
     checkRoundTrip(float(0x7f7fffff), 'Float')
     checkRoundTrip(float(0x7fc00000), 'Float', NaN)
   })
+  it(`DateTime`, function () {
+    checkRoundTrip(123412341n, 'DateTime')
+    checkRoundTrip(
+      new Date('Jan 1 2021'),
+      'DateTime',
+      BigInt(new Date('Jan 1 2021').getTime()) // eslint-disable-line no-undef
+    )
+  })
+  it(`Bytes`, function () {
+    checkRoundTrip(Buffer.from([0, 1, 2, 3]), 'Bytes')
+  })
+  it(`File`, function () {
+    checkRoundTrip(Buffer.from([0, 1, 2, 3]), 'File')
+  })
 })

test/spBv1.0typeTest.js.flow

@@ -3,30 +3,31 @@
 import * as sparkplug from '../spBv1.0'
 
 // $FlowFixMe
-sparkplug.encodePayload({ })
+sparkplug.encodePayload({})
 
 sparkplug.encodePayload({
-  timestamp: Date.now()
+  timestamp: Date.now(),
 })
 
 sparkplug.encodePayload({
   timestamp: Date.now(),
   metrics: [
-    {value: null, type: 'UInt8'},
-    {value: 2, type: 'UInt8'},
-    {value: 2, type: 'Int8'},
-    {value: 2, type: 'Float'},
-    {value: 2, type: 'DateTime'},
-    {value: new Date(), type: 'DateTime'},
-    {value: null, type: 'String'},
-    {value: 'blah', type: 'String'},
-    {value: null, type: 'Boolean'},
-    {value: true, type: 'Boolean'},
+    { value: null, type: 'UInt8' },
+    { value: 2, type: 'UInt8' },
+    { value: 2, type: 'Int8' },
+    { value: 2, type: 'Float' },
+    { value: 2, type: 'DateTime' },
+    { value: new Date(), type: 'DateTime' },
+    { value: null, type: 'String' },
+    { value: 'blah', type: 'String' },
+    { value: null, type: 'Boolean' },
+    { value: true, type: 'Boolean' },
     // $FlowFixMe
-    {value: 'hello', type: 'UInt8'},
+    { value: 'hello', type: 'UInt8' },
     // $FlowFixMe
-    {value: 2, type: 'String'},
+    { value: 2, type: 'String' },
     // $FlowFixMe
-    {value: 2, type: 'Boolean'},
-  ]
+    { value: 2, type: 'Boolean' },
+    { value: Buffer.from([0, 1, 2]), type: 'Bytes' },
+  ],
 })