uint8arraylist 0.0.0

package/LICENSE

@@ -0,0 +1,2 @@
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,30 @@
+# Uint8ArrayList
+
+> Append and consume bytes using only no-copy operations
+
+## Install
+
+```console
+$ npm i uint8arraylist
+```
+
+## Usage
+
+```js
+import { Uint8ArrayList } from 'uint8arraylist'
+
+const list = new Uint8ArrayList()
+list.append(Uint8Array.from([0, 1, 2]))
+list.append(Uint8Array.from([3, 4, 5]))
+
+list.toUint8Array()
+// -> Uint8Array([0, 1, 2, 3, 4, 5])
+
+list.consume(3)
+list.toUint8Array()
+// -> Uint8Array([3, 4, 5])
+```
+
+## Inspiration
+
+Borrows liberally from [bl](https://www.npmjs.com/package/bl) but only uses native JS types.

package/dist/src/index.d.ts

@@ -0,0 +1,13 @@
+export declare class Uint8ArrayList {
+    private bufs;
+    length: number;
+    constructor(data?: Uint8Array);
+    append(data: Uint8Array): void;
+    get(index: number): number;
+    /**
+     * Remove bytes from the front of the pool
+     */
+    consume(bytes: number): void;
+    toUint8Array(beginInclusive?: number, endExclusive?: number): Uint8Array;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAc;IACnB,MAAM,EAAE,MAAM,CAAA;gBAER,IAAI,CAAC,EAAE,UAAU;IAU9B,MAAM,CAAE,IAAI,EAAE,UAAU;IAKxB,GAAG,CAAE,KAAK,EAAE,MAAM;IAoBlB;;OAEG;IACH,OAAO,CAAE,KAAK,EAAE,MAAM;IAsBtB,YAAY,CAAE,cAAc,GAAE,MAAU,EAAE,YAAY,CAAC,EAAE,MAAM;CAkDhE"}

package/dist/src/index.js

@@ -0,0 +1,91 @@
+import { concat } from 'uint8arrays';
+export class Uint8ArrayList {
+    constructor(data) {
+        this.bufs = [];
+        if (data != null) {
+            this.bufs.push(data);
+        }
+        this.length = this.bufs.reduce((acc, curr) => acc + curr.byteLength, 0);
+    }
+    append(data) {
+        this.bufs.push(data);
+        this.length += data.byteLength;
+    }
+    get(index) {
+        if (index == null || index < 0 || index >= this.length) {
+            throw new RangeError('index is out of bounds');
+        }
+        let offset = 0;
+        for (const buf of this.bufs) {
+            const bufEnd = offset + buf.byteLength;
+            if (index < bufEnd) {
+                return buf[index - offset];
+            }
+            offset = bufEnd;
+        }
+        throw new RangeError('index is out of bounds');
+    }
+    /**
+     * Remove bytes from the front of the pool
+     */
+    consume(bytes) {
+        // first, normalize the argument, in accordance with how Buffer does it
+        bytes = Math.trunc(bytes);
+        // do nothing if not a positive number
+        if (Number.isNaN(bytes) || bytes <= 0) {
+            return;
+        }
+        while (this.bufs.length) {
+            if (bytes >= this.bufs[0].byteLength) {
+                bytes -= this.bufs[0].byteLength;
+                this.length -= this.bufs[0].byteLength;
+                this.bufs.shift();
+            }
+            else {
+                this.bufs[0] = this.bufs[0].subarray(bytes);
+                this.length -= bytes;
+                break;
+            }
+        }
+    }
+    toUint8Array(beginInclusive = 0, endExclusive) {
+        endExclusive = endExclusive ?? (this.length > 0 ? this.length : 0);
+        if (beginInclusive < 0 || endExclusive > this.length) {
+            throw new RangeError('index out of bounds');
+        }
+        let bufs = [];
+        let offset = 0;
+        for (const buf of this.bufs) {
+            const bufStart = offset;
+            const bufEnd = bufStart + buf.byteLength;
+            const sliceStartInBuf = beginInclusive >= bufStart && beginInclusive < bufEnd;
+            const sliceEndsInBuf = endExclusive > bufStart && endExclusive <= bufEnd;
+            const bufInSlice = beginInclusive < bufStart && endExclusive >= bufEnd;
+            offset = bufEnd;
+            let startIndex;
+            let endIndex;
+            if (sliceStartInBuf) {
+                startIndex = beginInclusive - bufStart;
+                endIndex = buf.byteLength;
+            }
+            if (sliceEndsInBuf) {
+                endIndex = endExclusive - bufStart;
+                if (startIndex == null) {
+                    startIndex = 0;
+                }
+            }
+            if (bufInSlice) {
+                startIndex = 0;
+                endIndex = buf.byteLength;
+            }
+            if (startIndex != null && endIndex != null) {
+                bufs.push(buf.subarray(startIndex, endIndex));
+            }
+            if (sliceEndsInBuf) {
+                break;
+            }
+        }
+        return concat(bufs, endExclusive - beginInclusive);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,MAAM,OAAO,cAAc;IAIzB,YAAa,IAAiB;QAC5B,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,IAAI,IAAI,IAAI,IAAI,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACrB;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;IACzE,CAAC;IAED,MAAM,CAAE,IAAgB;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACpB,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAA;IAChC,CAAC;IAED,GAAG,CAAE,KAAa;QAChB,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YACtD,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;SAC/C;QAED,IAAI,MAAM,GAAG,CAAC,CAAA;QAEd,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,UAAU,CAAA;YAEtC,IAAI,KAAK,GAAG,MAAM,EAAE;gBAClB,OAAO,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAA;aAC3B;YAED,MAAM,GAAG,MAAM,CAAA;SAChB;QAED,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAA;IAChD,CAAC;IAED;;OAEG;IACH,OAAO,CAAE,KAAa;QACpB,uEAAuE;QACvE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAEzB,sCAAsC;QACtC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE;YACrC,OAAM;SACP;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACvB,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE;gBACpC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;gBAChC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;gBACtC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAA;aAClB;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;gBAC3C,IAAI,CAAC,MAAM,IAAI,KAAK,CAAA;gBACpB,MAAK;aACN;SACF;IACH,CAAC;IAED,YAAY,CAAE,iBAAyB,CAAC,EAAE,YAAqB;QAC7D,YAAY,GAAG,YAAY,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAElE,IAAI,cAAc,GAAG,CAAC,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE;YACpD,MAAM,IAAI,UAAU,CAAC,qBAAqB,CAAC,CAAA;SAC5C;QAED,IAAI,IAAI,GAAiB,EAAE,CAAA;QAC3B,IAAI,MAAM,GAAG,CAAC,CAAA;QAEd,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,QAAQ,GAAG,MAAM,CAAA;YACvB,MAAM,MAAM,GAAG,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAA;YACxC,MAAM,eAAe,GAAG,cAAc,IAAI,QAAQ,IAAI,cAAc,GAAG,MAAM,CAAA;YAC7E,MAAM,cAAc,GAAG,YAAY,GAAG,QAAQ,IAAI,YAAY,IAAI,MAAM,CAAA;YACxE,MAAM,UAAU,GAAG,cAAc,GAAG,QAAQ,IAAI,YAAY,IAAI,MAAM,CAAA;YACtE,MAAM,GAAG,MAAM,CAAA;YAEf,IAAI,UAA8B,CAAA;YAClC,IAAI,QAA4B,CAAA;YAEhC,IAAI,eAAe,EAAE;gBACnB,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAA;gBACtC,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAA;aAC1B;YAED,IAAI,cAAc,EAAE;gBAClB,QAAQ,GAAG,YAAY,GAAG,QAAQ,CAAA;gBAElC,IAAI,UAAU,IAAI,IAAI,EAAE;oBACtB,UAAU,GAAG,CAAC,CAAA;iBACf;aACF;YAED,IAAI,UAAU,EAAE;gBACd,UAAU,GAAG,CAAC,CAAA;gBACd,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAA;aAC1B;YAED,IAAI,UAAU,IAAI,IAAI,IAAI,QAAQ,IAAI,IAAI,EAAE;gBAC1C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAA;aAC9C;YAED,IAAI,cAAc,EAAE;gBAClB,MAAK;aACN;SACF;QAED,OAAO,MAAM,CAAC,IAAI,EAAE,YAAY,GAAG,cAAc,CAAC,CAAA;IACpD,CAAC;CACF"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "uint8arraylist",
+  "version": "0.0.0",
+  "description": "Append and consume bytes using only no-copy operations",
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "scripts": {
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check dist/src/**/*.js dist/test/**/*.js",
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "aegir test -f ./dist/test/**/*.js",
+    "test:chrome": "npm run test -- -t browser",
+    "test:chrome-webworker": "npm run test -- -t webworker",
+    "test:firefox": "npm run test -- -t browser -- --browser firefox",
+    "test:firefox-webworker": "npm run test -- -t webworker -- --browser firefox",
+    "test:node": "npm run test -- -t node --cov",
+    "test:electron-main": "npm run test -- -t electron-main",
+    "release": "semantic-release"
+  },
+  "author": "Alex Potsides <alex@achingbrain.net>",
+  "license": "Apache-2.0 OR MIT",
+  "devDependencies": {
+    "aegir": "^36.1.3"
+  },
+  "dependencies": {
+    "uint8arrays": "^3.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,117 @@
+import { concat } from 'uint8arrays'
+
+export class Uint8ArrayList {
+  private bufs: Uint8Array[]
+  public length: number
+
+  constructor (data?: Uint8Array) {
+    this.bufs = []
+
+    if (data != null) {
+      this.bufs.push(data)
+    }
+
+    this.length = this.bufs.reduce((acc, curr) => acc + curr.byteLength, 0)
+  }
+
+  append (data: Uint8Array) {
+    this.bufs.push(data)
+    this.length += data.byteLength
+  }
+
+  get (index: number) {
+    if (index == null || index < 0 || index >= this.length) {
+      throw new RangeError('index is out of bounds')
+    }
+
+    let offset = 0
+
+    for (const buf of this.bufs) {
+      const bufEnd = offset + buf.byteLength
+
+      if (index < bufEnd) {
+        return buf[index - offset]
+      }
+
+      offset = bufEnd
+    }
+
+    throw new RangeError('index is out of bounds')
+  }
+
+  /**
+   * Remove bytes from the front of the pool
+   */
+  consume (bytes: number) {
+    // first, normalize the argument, in accordance with how Buffer does it
+    bytes = Math.trunc(bytes)
+
+    // do nothing if not a positive number
+    if (Number.isNaN(bytes) || bytes <= 0) {
+      return
+    }
+
+    while (this.bufs.length) {
+      if (bytes >= this.bufs[0].byteLength) {
+        bytes -= this.bufs[0].byteLength
+        this.length -= this.bufs[0].byteLength
+        this.bufs.shift()
+      } else {
+        this.bufs[0] = this.bufs[0].subarray(bytes)
+        this.length -= bytes
+        break
+      }
+    }
+  }
+
+  toUint8Array (beginInclusive: number = 0, endExclusive?: number) {
+    endExclusive = endExclusive ?? (this.length > 0 ? this.length : 0)
+
+    if (beginInclusive < 0 || endExclusive > this.length) {
+      throw new RangeError('index out of bounds')
+    }
+
+    let bufs: Uint8Array[] = []
+    let offset = 0
+
+    for (const buf of this.bufs) {
+      const bufStart = offset
+      const bufEnd = bufStart + buf.byteLength
+      const sliceStartInBuf = beginInclusive >= bufStart && beginInclusive < bufEnd
+      const sliceEndsInBuf = endExclusive > bufStart && endExclusive <= bufEnd
+      const bufInSlice = beginInclusive < bufStart && endExclusive >= bufEnd
+      offset = bufEnd
+
+      let startIndex: number | undefined
+      let endIndex: number | undefined
+
+      if (sliceStartInBuf) {
+        startIndex = beginInclusive - bufStart
+        endIndex = buf.byteLength
+      }
+
+      if (sliceEndsInBuf) {
+        endIndex = endExclusive - bufStart
+
+        if (startIndex == null) {
+          startIndex = 0
+        }
+      }
+
+      if (bufInSlice) {
+        startIndex = 0
+        endIndex = buf.byteLength
+      }
+
+      if (startIndex != null && endIndex != null) {
+        bufs.push(buf.subarray(startIndex, endIndex))
+      }
+
+      if (sliceEndsInBuf) {
+        break
+      }
+    }
+
+    return concat(bufs, endExclusive - beginInclusive)
+  }
+}