BoolArrays and updated README.md (#15)

* fix `type`, `length`, and `digits` bug

Added a function (`isSpecialType`) to aid in recognizing special types from normal objects.

* Fix indentation.

* Add information about what `digits` does

* Add BoolArrays

Added BoolArrays, potential in the future to have some sort of schema (i.e. to be BoolObjects).

Author: Codezilluh

README.md

@@ -57,7 +57,10 @@ import { uint8, int16, uint16, int64, string8 } from '@geckos.io/typed-array-buf
 
 const playerSchema = BufferSchema.schema('player', {
   id: uint8,
+  // The length parameter controls the length of a String8 or String16
   name: { type: string8, length: 6 },
+  // The digits parameter controls where the decimal point is placed
+  // Therefore, it divides the maximum and minimum values by 10^n
   x: { type: int16, digits: 2 },
   y: { type: int16, digits: 2 }
 })
@@ -171,4 +174,9 @@ export const float64 = { _type: 'Float64Array', _bytes: 8 }
 export const string8 = { _type: 'String8', _bytes: 1 }
 /** 2 bytes per character */
 export const string16 = { _type: 'String16', _bytes: 2 }
+
+/** An array of 7 booleans */
+export const bool8 = { _type: 'BitArray8', _bytes: 1 }
+/** An array of 15 booleans */
+export const bool16 = { _type: 'BitArray16', _bytes: 2 }
 ```

src/deep-sort-object.ts

@@ -12,7 +12,7 @@
 
 import { isPlainObject } from 'is-plain-object'
 
-const isPlainArray = (arr: any) => Array.isArray(arr)
+const isPlainArray = (arr: any) => Array.isArray(arr) && (arr.length > 0 ? typeof arr[0] == "object" : true)
 
 const isValue = (val: any) => !isPlainObject(val) && !isPlainArray(val)
 

src/index.ts

@@ -1,3 +1,3 @@
 export { Lib as BufferSchema } from './lib'
 export { Model } from './model'
-export { int8, uint8, int16, uint16, int32, uint32, int64, uint64, float32, float64, string8, string16 } from './views'
+export { int8, uint8, int16, uint16, int32, uint32, int64, uint64, float32, float64, string8, string16, bool8, bool16 } from './views'

src/schema.ts

@@ -21,7 +21,7 @@ export class Schema {
   }
 
   private isSpecialType(prop: object) {
-    let propKeys = Object.keys(prop).filter(k => k != "type" && k != "digits" && k != "length")
+    let propKeys = Object.keys(prop).filter(k => k != 'type' && k != 'digits' && k != 'length')
 
     return !propKeys.length
   }

src/serialize.ts

@@ -21,11 +21,27 @@ export class Serialize {
   }
 
   private isSpecialType(prop: object) {
-    let propKeys = Object.keys(prop).filter(k => k != "type" && k != "digits" && k != "length")
+    let propKeys = Object.keys(prop).filter(k => k != 'type' && k != 'digits' && k != 'length')
 
     return !propKeys.length
   }
 
+  private boolArrayToInt(array: any) {
+    // start with 1 to avoid errors such as 010 -> 10
+    // now it will be 1010 which will not simplify
+    let string = '1'
+    for (var i = 0; i < array.length; i++) {
+	    string += +(!!array[i])
+    }
+    return parseInt(string, 2)
+  }
+
+  private intToBoolArray(int: number) {
+    // convert string to array, map the numbers to bools,
+    // and remove the initial 1
+    return [...(int >>> 0).toString(2)].map(e=> e == '0' ? false : true).slice(1)
+  }
+
   public flatten(schema: any, data: any) {
     let flat: any[] = []
 
@@ -43,12 +59,19 @@ export class Serialize {
       // console.log('-------')
       // console.log('data', typeof data, data)
 
-      for (let property in data) {
+      let property: any
+      for (property in data) {
         if (data.hasOwnProperty(property)) {
           if (typeof data[property] === 'object') {
             // if data is array, but schemas is flat, use index 0 on the next iteration
-            if (Array.isArray(data)) flatten(schema, data[parseInt(property)])
-            else flatten(schema[property], data[property])
+            if (Array.isArray(data)) {
+              flatten(schema, data[parseInt(property)])
+            } else if (schema[property]?._type === "BitArray8" || schema[property]?._type === "BitArray16") {
+              flat.push({
+                d: this.boolArrayToInt(data[property]),
+                t: schema[property]._type
+              })
+            } else flatten(schema[property], data[property])
           }
           //---
           else {
@@ -64,11 +87,13 @@ export class Serialize {
               }
               flat.push({ d: data[property], t: schema[property].type._type })
             } else {
-              // crop strings to default length of 12 characters if nothing else is specified
-              if (schema[property]._type === 'String8' || schema[property]._type === 'String16') {
-                data[property] = this.cropString(data[property], 12)
+              if (schema[property]?._type) {
+                // crop strings to default length of 12 characters if nothing else is specified
+                if (schema[property]?._type === 'String8' || schema[property]?._type === 'String16') {
+                  data[property] = this.cropString(data[property], 12)
+                }
+                flat.push({ d: data[property], t: schema[property]._type })
               }
-              flat.push({ d: data[property], t: schema[property]._type })
             }
           }
         } else {
@@ -133,6 +158,12 @@ export class Serialize {
       } else if (f.t === 'Float64Array') {
         this._dataView.setFloat64(this._bytes, f.d)
         this._bytes += 8
+      } else if (f.t === 'BitArray8') {
+        this._dataView.setUint8(this._bytes, f.d)
+        this._bytes++
+      } else if (f.t === 'BitArray16') {
+        this._dataView.setUint16(this._bytes, f.d)
+        this._bytes += 2
       } else {
         console.log('ERROR: Something unexpected happened!')
       }
@@ -271,6 +302,14 @@ export class Serialize {
                 value = view.getFloat64(bytes)
                 bytes += _bytes
               }
+              if (_type === 'BitArray8') {
+                value = this.intToBoolArray(view.getUint8(bytes))
+                bytes += _bytes
+              }
+              if (_type === 'BitArray16') {
+                value = this.intToBoolArray(view.getUint16(bytes))
+                bytes += _bytes
+              }
 
               // apply special types options
               if (typeof value === 'number' && specialTypes?.digits) {

src/views.ts

@@ -30,3 +30,8 @@ export const float64 = { _type: 'Float64Array', _bytes: 8 }
 export const string8 = { _type: 'String8', _bytes: 1 }
 /** 2 bytes per character */
 export const string16 = { _type: 'String16', _bytes: 2 }
+
+/** An array of 7 booleans */
+export const bool8 = { _type: 'BitArray8', _bytes: 1 }
+/** An array of 15 booleans */
+export const bool16 = { _type: 'BitArray16', _bytes: 2 }

test/dataViews.test.js

@@ -12,7 +12,9 @@ const {
   float32,
   float64,
   string8,
-  string16
+  string16,
+  bool8,
+  bool16
 } = require('../lib/index.js')
 
 describe('dataViews test', () => {
@@ -29,7 +31,9 @@ describe('dataViews test', () => {
     j: float64,
     k: string8,
     kk: { type: string8, length: 24 },
-    l: string16
+    l: string16,
+    m: bool8,
+    n: bool16
   })
 
   const snapshotSchema = BufferSchema.schema('snapshot', {
@@ -55,7 +59,9 @@ describe('dataViews test', () => {
         j: 1.123456789,
         k: 'This line is too long.',
         kk: 'This line is too long.',
-        l: 'Эта строка слишком длинная.'
+        l: 'Эта строка слишком длинная.',
+        m: [true, false, false],
+        n: [true, true, false, true, true, true, false, false, false, true]
       }
     ]
   }
@@ -67,6 +73,8 @@ describe('dataViews test', () => {
     buffer = SnapshotModel.toBuffer(data)
     data = SnapshotModel.fromBuffer(buffer)
 
+    expect(data.players[0].m[2]).toBe(false)
+    expect(data.players[0].n[7]).toBe(false)
     expect(data.players[0].g).toBe(now)
     expect(data.players[0].h).toBe(now)
     expect(data.players[0].k).toBe('This line is')

test/serializeDeserialize.test.js

@@ -1,21 +1,24 @@
-const { BufferSchema, Model, uint8, uint32, string8, int16 } = require('../lib/index.js')
+const { BufferSchema, Model, uint8, uint32, string8, int16, bool8 } = require('../lib/index.js')
 
 // see: https://github.com/geckosio/typed-array-buffer-schema/issues/7
 describe('serialize deserialize', () => {
   const movementSchema = BufferSchema.schema('movement', {
     sequenceNumber: uint32,
     horizontal: uint8,
-    vertical: uint8
+    vertical: uint8,
+    options: bool8
   })
   const movementModel = new Model(movementSchema)
 
   const inOrder = {
     sequenceNumber: 2,
     horizontal: 4,
-    vertical: 4
+    vertical: 4,
+    options: [false, true, false]
   }
   const notInOrder = {
     horizontal: 4,
+    options: [false, true, false],
     vertical: 4,
     sequenceNumber: 2
   }
@@ -27,6 +30,7 @@ describe('serialize deserialize', () => {
     expect(deserialized.sequenceNumber).toBe(2)
     expect(deserialized.horizontal).toBe(4)
     expect(deserialized.vertical).toBe(4)
+    expect(deserialized.options[1]).toBe(true)
   })
 
   it('should work if NOT defined in order', () => {
@@ -36,6 +40,7 @@ describe('serialize deserialize', () => {
     expect(deserialized.sequenceNumber).toBe(2)
     expect(deserialized.horizontal).toBe(4)
     expect(deserialized.vertical).toBe(4)
+    expect(deserialized.options[1]).toBe(true)
   })
 })
 
@@ -60,7 +65,8 @@ describe('serialize deserialize (complex)', () => {
     players: [playerSchema],
     time: uint32,
     stats: TimerSchema,
-    castles: [castleSchema]
+    castles: [castleSchema],
+    config: bool8
   })
 
   const gameModel = new Model(gameSchema)
@@ -79,7 +85,8 @@ describe('serialize deserialize (complex)', () => {
     players: [
       { id: 25, x: 788, y: -14 },
       { x: 1, y: 2, id: 87 }
-    ]
+    ],
+    config: [true, false, true, true, true]
   }
 
   it('should work if defined randomly', () => {
@@ -92,5 +99,6 @@ describe('serialize deserialize (complex)', () => {
     expect(deserialized.name.trim()).toBe('myGame')
     expect(deserialized.time).toBe(timeInSeconds)
     expect(deserialized.stats.time).toBe(timeInSeconds)
+    expect(deserialized.config[1]).toBe(false)
   })
 })

test/simple.test.js

@@ -1,4 +1,4 @@
-const { BufferSchema, Model, uint8, int16, uint16, string8 } = require('../lib/index.js')
+const { BufferSchema, Model, uint8, int16, uint16, string8, bool8 } = require('../lib/index.js')
 
 describe('simple test', () => {
   const castleSchema = BufferSchema.schema('castle', {
@@ -22,7 +22,8 @@ describe('simple test', () => {
   const snapshotSchema = BufferSchema.schema('snapshot', {
     time: uint16,
     single: uint8,
-    data: { list: [listSchema], players: [playerSchema], castles: [castleSchema] }
+    data: { list: [listSchema], players: [playerSchema], castles: [castleSchema] },
+    serverConfig: bool8
   })
 
   const SnapshotModel = new Model(snapshotSchema)
@@ -51,7 +52,8 @@ describe('simple test', () => {
           y: -14
         }
       ]
-    }
+    },
+    serverConfig: [true, false, true, false, false]
   }
 
   let buffer
@@ -66,7 +68,7 @@ describe('simple test', () => {
     const uint8 = new Uint8Array(buffer)
 
     expect(typeof buffer).toBe('object')
-    expect(uint8.buffer.byteLength).toBe(40)
+    expect(uint8.buffer.byteLength).toBe(41)
   })
 
   test('should fromBuffer', () => {