Export the underlying XdrReader and XdrWriter object (#116)

* Add raw Reader/Writer export, better Array check
* Upgrade dependencies

Author: Shaptic

CHANGELOG.md

@@ -6,6 +6,14 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+## [v3.1.0](https://github.com/stellar/js-xdr/compare/v3.0.1...v3.1.0)
+
+### Added
+* The raw, underlying `XdrReader` and `XdrWriter` types are now exposed by the library for reading without consuming the entire stream ([#116](https://github.com/stellar/js-xdr/pull/116)).
+
+### Fixed
+* Added additional type checks for passing a bytearray-like object to `XdrReader`s and improves the error with details ([#116](https://github.com/stellar/js-xdr/pull/116)).
+
 
 ## [v3.0.1](https://github.com/stellar/js-xdr/compare/v3.0.0...v3.0.1)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stellar/js-xdr",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Read/write XDR encoded data structures (RFC 4506)",
   "main": "lib/xdr.js",
   "browser": "dist/xdr.js",
@@ -48,17 +48,17 @@
     "ui": "bdd"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.3",
-    "@babel/eslint-parser": "^7.23.3",
-    "@babel/preset-env": "^7.23.3",
-    "@babel/register": "^7.22.15",
+    "@babel/core": "^7.23.9",
+    "@babel/eslint-parser": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "@babel/register": "^7.23.7",
     "babel-loader": "^9.1.3",
     "buffer": "^6.0.3",
     "chai": "^4.3.10",
-    "eslint": "^8.53.0",
+    "eslint": "^8.56.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prefer-import": "^0.0.1",
     "eslint-plugin-prettier": "^4.2.1",
@@ -74,8 +74,8 @@
     "prettier": "^2.8.7",
     "sinon": "^15.2.0",
     "sinon-chai": "^3.7.0",
-    "terser-webpack-plugin": "^5.3.7",
-    "webpack": "^5.89.0",
+    "terser-webpack-plugin": "^5.3.10",
+    "webpack": "^5.90.0",
     "webpack-cli": "^5.0.2"
   }
 }

src/index.js

@@ -1,2 +1,5 @@
 export * from './types';
 export * from './config';
+
+export { XdrReader } from './serialization/xdr-reader';
+export { XdrWriter } from './serialization/xdr-writer';

src/serialization/xdr-reader.js

@@ -10,10 +10,14 @@ export class XdrReader {
    */
   constructor(source) {
     if (!Buffer.isBuffer(source)) {
-      if (source instanceof Array) {
+      if (
+        source instanceof Array ||
+        Array.isArray(source) ||
+        ArrayBuffer.isView(source)
+      ) {
         source = Buffer.from(source);
       } else {
-        throw new XdrReaderError('source not specified');
+        throw new XdrReaderError(`source invalid: ${source}`);
       }
     }