Drop node dependencies (#48)

Author: devongovett

.github/workflows/node.js.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
 
     steps:
     - uses: actions/checkout@v2

.gitignore

@@ -2,3 +2,5 @@
 coverage.html
 coverage/
 node_modules/
+.parcel-cache
+dist

README.md

@@ -17,38 +17,30 @@ This is just a small example of what Restructure can do. Check out the API docum
 below for more information.
 
 ```javascript
-var r = require('restructure');
+import * as r from 'restructure';
 
-var Person = new r.Struct({
+let Person = new r.Struct({
   name: new r.String(r.uint8, 'utf8'),
   age: r.uint8
 });
 
 // decode a person from a buffer
-var stream = new r.DecodeStream(buffer);
-Person.decode(stream); // returns an object with the fields defined above
+let value = Person.fromBuffer(new Uint8Array([/* ... */])); // returns an object with the fields defined above
 
 // encode a person from an object
-// pipe the stream to a destination, such as a file
-var stream = new r.EncodeStream();
-stream.pipe(fs.createWriteStream('out.bin'));
-
-Person.encode(stream, {
+let buffer = Person.toBuffer({
   name: 'Devon',
   age: 21
 });
-
-stream.end();
 ```
 
-
 ## API
 
 All of the following types support three standard methods:
 
-* `decode(stream)` - decodes an instance of the type from the given DecodeStream
+* `fromBuffer(buffer)` - decodes an instance of the type from the given Uint8Array
 * `size(value)` - returns the amount of space the value would take if encoded
-* `encode(stream, value)` - encodes the given value into the given EncodeStream
+* `toBuffer(value)` - encodes the given value into a Uint8Array
 
 Restructure supports a wide variety of types, but if you need to write your own for
 some custom use that cannot be represented by them, you can do so by just implementing
@@ -143,7 +135,7 @@ bitfield.encode(stream, result);
 
 ### Buffer
 
-Extracts a slice of the buffer to a Node `Buffer`.  The length can be a constant, or taken from
+Extracts a slice of the buffer to a `Uint8Array`.  The length can be a constant, or taken from
 a previous field in the parent structure.
 
 ```javascript
@@ -162,8 +154,9 @@ var struct = new r.Struct({
 A `String` maps a JavaScript string to and from binary encodings.  The length can be a constant, taken
 from a previous field in the parent structure, or encoded using a number type immediately before the string.
 
-Supported encodings include `'ascii'`, `'utf8'`, `'ucs2'`, `'utf16le'`, `'utf16be'`, and if you also install
-[iconv-lite](https://github.com/ashtuchkin/iconv-lite), many other legacy codecs.
+Fully supported encodings include `'ascii'`, `'utf8'`, `'ucs2'`, `'utf16le'`, `'utf16be'`. Decoding is also possible
+with any encoding supported by [TextDecoder](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings),
+however encoding these is not supported.
 
 ```javascript
 // fixed length, ascii encoding by default

index.js

@@ -1,19 +1,17 @@
-exports.EncodeStream    = require('./src/EncodeStream');
-exports.DecodeStream    = require('./src/DecodeStream');
-exports.Array           = require('./src/Array');
-exports.LazyArray       = require('./src/LazyArray');
-exports.Bitfield        = require('./src/Bitfield');
-exports.Boolean         = require('./src/Boolean');
-exports.Buffer          = require('./src/Buffer');
-exports.Enum            = require('./src/Enum');
-exports.Optional        = require('./src/Optional');
-exports.Reserved        = require('./src/Reserved');
-exports.String          = require('./src/String');
-exports.Struct          = require('./src/Struct');
-exports.VersionedStruct = require('./src/VersionedStruct');
+export {EncodeStream} from './src/EncodeStream.js';
+export {DecodeStream} from './src/DecodeStream.js';
+export {Array} from './src/Array.js';
+export {LazyArray} from './src/LazyArray.js';
+export {Bitfield} from './src/Bitfield.js';
+export {Boolean} from './src/Boolean.js';
+export {Buffer} from './src/Buffer.js';
+export {Enum} from './src/Enum.js';
+export {Optional} from './src/Optional.js';
+export {Reserved} from './src/Reserved.js';
+export {String} from './src/String.js';
+export {Struct} from './src/Struct.js';
+export {VersionedStruct} from './src/VersionedStruct.js';
 
-const utils             = require('./src/utils');
-const NumberT           = require('./src/Number');
-const Pointer           = require('./src/Pointer');
-
-Object.assign(exports, utils, NumberT, Pointer);
+export * from './src/utils.js';
+export * from './src/Number.js';
+export * from './src/Pointer.js';

package.json

@@ -2,19 +2,25 @@
   "name": "restructure",
   "version": "2.0.1",
   "description": "Declaratively encode and decode binary data",
-  "main": "index.js",
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./index.js",
+  "source": "./index.js",
+  "exports": {
+    "import": "./index.js",
+    "require": "./dist/main.cjs"
+  },
+  "targets": {
+    "module": false
+  },
   "devDependencies": {
-    "chai": "~4.2.0",
-    "concat-stream": "~2.0.0",
-    "coveralls": "^3.0.11",
-    "iconv-lite": "^0.5.1",
-    "mocha": "~7.1.1",
-    "nyc": "^15.0.1"
+    "mocha": "^10.0.0",
+    "parcel": "^2.6.1"
   },
   "scripts": {
-    "test": "mocha --reporter spec",
-    "cover": "nyc --reporter=html --reporter=text mocha",
-    "coveralls": "nyc report --reporter=text-lcov | coveralls"
+    "test": "mocha",
+    "build": "parcel build",
+    "prepublishOnly": "parcel build"
   },
   "repository": {
     "type": "git",

src/Array.js

@@ -1,8 +1,10 @@
-const {Number:NumberT} = require('./Number');
-const utils = require('./utils');
+import {Base} from './Base.js';
+import {Number as NumberT} from './Number.js';
+import * as utils from './utils.js';
 
-class ArrayT {
+class ArrayT extends Base {
   constructor(type, length, lengthType = 'count') {
+    super();
     this.type = type;
     this.length = length;
     this.lengthType = lengthType;
@@ -52,21 +54,25 @@ class ArrayT {
     return res;
   }
 
-  size(array, ctx) {
+  size(array, ctx, includePointers = true) {
     if (!array) {
       return this.type.size(null, ctx) * utils.resolveLength(this.length, null, ctx);
     }
 
     let size = 0;
     if (this.length instanceof NumberT) {
       size += this.length.size();
-      ctx = {parent: ctx};
+      ctx = {parent: ctx, pointerSize: 0};
     }
 
     for (let item of array) {
       size += this.type.size(item, ctx);
     }
 
+    if (ctx && includePointers && this.length instanceof NumberT) {
+      size += ctx.pointerSize;
+    }
+    
     return size;
   }
 
@@ -79,7 +85,7 @@ class ArrayT {
         parent
       };
 
-      ctx.pointerOffset = stream.pos + this.size(array, ctx);
+      ctx.pointerOffset = stream.pos + this.size(array, ctx, false);
       this.length.encode(stream, array.length);
     }
 
@@ -91,11 +97,10 @@ class ArrayT {
       let i = 0;
       while (i < ctx.pointers.length) {
         const ptr = ctx.pointers[i++];
-        ptr.type.encode(stream, ptr.val);
+        ptr.type.encode(stream, ptr.val, ptr.parent);
       }
     }
-
   }
 }
 
-module.exports = ArrayT;
+export {ArrayT as Array};

src/Base.js

@@ -0,0 +1,17 @@
+import {DecodeStream} from './DecodeStream.js';
+import {EncodeStream} from './EncodeStream.js';
+
+export class Base {
+  fromBuffer(buffer) {
+    let stream = new DecodeStream(buffer);
+    return this.decode(stream);
+  }
+
+  toBuffer(value) {
+    let size = this.size(value);
+    let buffer = new Uint8Array(size);
+    let stream = new EncodeStream(buffer);
+    this.encode(stream, value);
+    return buffer;
+  }
+}

src/Bitfield.js

@@ -1,8 +1,12 @@
-class Bitfield {
+import {Base} from './Base.js';
+
+export class Bitfield extends Base {
   constructor(type, flags = []) {
+    super();
     this.type = type;
     this.flags = flags;
   }
+
   decode(stream) {
     const val = this.type.decode(stream);
 
@@ -33,5 +37,3 @@ class Bitfield {
     return this.type.encode(stream, val);
   }
 }
-
-module.exports = Bitfield;

src/Boolean.js

@@ -1,5 +1,8 @@
-class BooleanT {
+import {Base} from './Base.js';
+
+export class BooleanT extends Base {
   constructor(type) {
+    super();
     this.type = type;
   }
 
@@ -16,4 +19,4 @@ class BooleanT {
   }
 }
 
-module.exports = BooleanT;
+export {BooleanT as Boolean};

src/Buffer.js

@@ -1,10 +1,13 @@
-const utils = require('./utils');
-const {Number:NumberT} = require('./Number');
+import {Base} from './Base.js';
+import {Number as NumberT} from './Number.js';
+import * as utils from './utils.js';
 
-class BufferT {
+export class BufferT extends Base {
   constructor(length) {
+    super();
     this.length = length;
   }
+  
   decode(stream, parent) {
     const length = utils.resolveLength(this.length, stream, parent);
     return stream.readBuffer(length);
@@ -15,7 +18,12 @@ class BufferT {
       return utils.resolveLength(this.length, null, parent);
     }
 
-    return val.length;
+    let len = val.length;
+    if (this.length instanceof NumberT) {
+      len += this.length.size();
+    }
+
+    return len;
   }
 
   encode(stream, buf, parent) {
@@ -27,4 +35,4 @@ class BufferT {
   }
 }
 
-module.exports = BufferT;
+export {BufferT as Buffer};