Issue #28: Removed build step for bitjs.io now that all browsers (Firefox 114+) support ES Module Workers.

Author: codedread

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.1.0] - 2023-05-28
+
+### Added
+
+- Starter thinking around a Media API.
+
+### Changed
+
+- Change console.warn to a console.error when importing archive.js.
+
+### Removed
+
+- Removed build step for bitjs.io now that all browsers (Firefox 114+) support ES Module Workers.
+
+## [1.0.11] - 2023-02-15
+
+### Added
+
+- Add sniffer support for the ICO format.
+- Add unit test coverage via c8.
+
+### Fixed
+
+- Fixes for the audio/flac codec type.

archive/archive.js

@@ -14,6 +14,7 @@ import { UnarchiveAppendEvent, UnarchiveErrorEvent, UnarchiveEvent, UnarchiveEve
          UnarchiveProgressEvent, UnarchiveStartEvent, Unarchiver,
          UnrarrerInternal, UntarrerInternal, UnzipperInternal,
          getUnarchiverInternal } from './decompress-internal.js';
+import { Unzipper, Unrarrer, Untarrer, getUnarchiver } from './decompress.js';
 
 export {
   UnarchiveAppendEvent,
@@ -26,65 +27,7 @@ export {
   UnarchiveProgressEvent,
   UnarchiveStartEvent,
   Unarchiver,
+  Unzipper, Unrarrer, Untarrer, getUnarchiver
 } 
 
-/**
- * All extracted files returned by an Unarchiver will implement
- * the following interface:
- */
-
-/**
- * @typedef UnarchivedFile
- * @property {string} filename
- * @property {Uint8Array} fileData
- */
-
-/**
- * The goal is to make this testable - send getUnarchiver() an array buffer of
- * an archive, call start on the unarchiver, expect the returned result.
- *
- * Problem: It relies on Web Workers, and that won't work in a nodejs context.
- * Solution: Make archive.js very thin, have it feed web-specific things into
- *           an internal module that is isomorphic JavaScript.
- *
- * TODO:
- * - write unit tests for archive-internal.js that use the nodejs Worker
- *   equivalent.
- * - maybe use @pgriess/node-webworker or @audreyt/node-webworker-threads or
- *   just node's worker_threads ?
- */
-
-const createWorkerFn = (scriptFilename) => new Worker(scriptFilename);
-
-function warn() {
-  console.warn(`Stop using archive.js and use decompress.js instead. This module will be removed.`);
-}
-
-// Thin wrappers of unarchivers for clients who want to construct a specific
-// unarchiver themselves rather than use getUnarchiver().
-export class Unzipper extends UnzipperInternal {
-  constructor(ab, options) { warn(); super(ab, createWorkerFn, options); }
-}
-
-export class Unrarrer extends UnrarrerInternal {
-  constructor(ab, options) { warn(); super(ab, createWorkerFn, options); }
-}
-
-export class Untarrer extends UntarrerInternal {
-  constructor(ab, options) { warn(); super(ab, createWorkerFn, options); }
-}
-
-/**
- * Factory method that creates an unarchiver based on the byte signature found
- * in the arrayBuffer.
- * @param {ArrayBuffer} ab The ArrayBuffer to unarchive. Note that this ArrayBuffer
- *     must not be referenced after calling this method, as the ArrayBuffer is marked
- *     as Transferable and sent to a Worker thread once start() is called.
- * @param {Object|string} options An optional object of options, or a string
- *     representing where the path to the unarchiver script files.
- * @returns {Unarchiver}
- */
-export function getUnarchiver(ab, options = {}) {
-  warn();
-  return getUnarchiverInternal(ab, createWorkerFn, options);
-}
+console.error(`bitjs: Stop importing archive.js, this module will be removed. Import decompress.js instead.`);

archive/decompress.js

@@ -53,7 +53,7 @@ export {
 *   just node's worker_threads ?
 */
 
-const createWorkerFn = (scriptFilename) => new Worker(scriptFilename);
+const createWorkerFn = (scriptFilename) => new Worker(scriptFilename, { type: 'module' });
 
 // Thin wrappers of compressors for clients who want to construct a specific
 // unarchiver themselves rather than use getUnarchiver().

archive/rarvm.js

@@ -6,6 +6,8 @@
  * Copyright(c) 2017 Google Inc.
  */
 
+import { BitStream } from '../io/bitstream.js';
+
 /**
  * CRC Implementation.
  */
@@ -104,13 +106,13 @@ function CRC(startCRC, arr) {
 /**
  * RarVM Implementation.
  */
-const VM_MEMSIZE = 0x40000;
-const VM_MEMMASK = (VM_MEMSIZE - 1);
-const VM_GLOBALMEMADDR = 0x3C000;
-const VM_GLOBALMEMSIZE = 0x2000;
-const VM_FIXEDGLOBALSIZE = 64;
-const MAXWINSIZE = 0x400000;
-const MAXWINMASK = (MAXWINSIZE - 1);
+export const VM_MEMSIZE = 0x40000;
+export const VM_MEMMASK = (VM_MEMSIZE - 1);
+export const VM_GLOBALMEMADDR = 0x3C000;
+export const VM_GLOBALMEMSIZE = 0x2000;
+export const VM_FIXEDGLOBALSIZE = 64;
+export const MAXWINSIZE = 0x400000;
+export const MAXWINMASK = (MAXWINSIZE - 1);
 
 /**
  */
@@ -448,7 +450,7 @@ const StdList = [
 /**
  * @constructor
  */
-class RarVM {
+export class RarVM {
   constructor() {
     /** @private {Uint8Array} */
     this.mem_ = null;
@@ -486,7 +488,7 @@ class RarVM {
   /**
    * @param {VM_PreparedOperand} op
    * @param {boolean} byteMode
-   * @param {bitjs.io.BitStream} bstream A rtl bit stream.
+   * @param {BitStream} bstream A rtl bit stream.
    */
   decodeArg(op, byteMode, bstream) {
     const data = bstream.peekBits(16);
@@ -808,7 +810,7 @@ class RarVM {
 
     //InitBitInput();
     //memcpy(InBuf,Code,Min(CodeSize,BitInput::MAX_SIZE));
-    const bstream = new bitjs.io.BitStream(code.buffer, true /* rtl */);
+    const bstream = new BitStream(code.buffer, true /* rtl */);
 
     // Calculate the single byte XOR checksum to check validity of VM code.
     let xorSum = 0;
@@ -970,7 +972,7 @@ class RarVM {
   /**
    * Static function that reads in the next set of bits for the VM
    * (might return 4, 8, 16 or 32 bits).
-   * @param {bitjs.io.BitStream} bstream A RTL bit stream.
+   * @param {BitStream} bstream A RTL bit stream.
    * @returns {number} The value of the bits read.
    */
   static readData(bstream) {

archive/unrar.js

@@ -12,10 +12,10 @@
 // present.
 
 // This file expects to be invoked as a Worker (see onmessage below).
-importScripts('../io/bitstream-worker.js');
-importScripts('../io/bytestream-worker.js');
-importScripts('../io/bytebuffer-worker.js');
-importScripts('rarvm.js');
+import { BitStream } from '../io/bitstream.js';
+import { ByteStream } from '../io/bytestream.js';
+import { ByteBuffer } from '../io/bytebuffer.js';
+import { VM_GLOBALMEMADDR, VM_GLOBALMEMSIZE, VM_FIXEDGLOBALSIZE, MAXWINMASK } from './rarvm.js';
 
 const UnarchiveState = {
   NOT_STARTED: 0,
@@ -86,7 +86,7 @@ const ENDARC_HEAD = 0x7b;
  */
 class RarVolumeHeader {
   /**
-   * @param {bitjs.io.ByteStream} bstream
+   * @param {ByteStream} bstream
    */
   constructor(bstream) {
     let headBytesRead = 0;
@@ -316,19 +316,19 @@ const RD = { //rep decode
 };
 
 /**
- * @type {Array<bitjs.io.ByteBuffer>}
+ * @type {Array<ByteBuffer>}
  */
 const rOldBuffers = [];
 
 /**
  * The current buffer we are unpacking to.
- * @type {bitjs.io.ByteBuffer}
+ * @type {ByteBuffer}
  */
 let rBuffer;
 
 /**
  * The buffer of the final bytes after filtering (only used in Unpack29).
- * @type {bitjs.io.ByteBuffer}
+ * @type {ByteBuffer}
  */
 let wBuffer;
 
@@ -346,7 +346,7 @@ let wBuffer;
 
 /**
  * Read in Huffman tables for RAR
- * @param {bitjs.io.BitStream} bstream
+ * @param {BitStream} bstream
  */
 function RarReadTables(bstream) {
   const BitLength = new Array(rBC);
@@ -491,7 +491,7 @@ function RarMakeDecodeTables(BitLength, offset, dec, size) {
 
 // TODO: implement
 /**
- * @param {bitjs.io.BitStream} bstream
+ * @param {BitStream} bstream
  * @param {boolean} Solid
  */
 function Unpack15(bstream, Solid) {
@@ -500,7 +500,7 @@ function Unpack15(bstream, Solid) {
 
 /**
  * Unpacks the bit stream into rBuffer using the Unpack20 algorithm.
- * @param {bitjs.io.BitStream} bstream
+ * @param {BitStream} bstream
  * @param {boolean} Solid
  */
 function Unpack20(bstream, Solid) {
@@ -694,7 +694,7 @@ function InitFilters() {
  */
 function RarAddVMCode(firstByte, vmCode) {
   VM.init();
-  const bstream = new bitjs.io.BitStream(vmCode.buffer, true /* rtl */);
+  const bstream = new BitStream(vmCode.buffer, true /* rtl */);
 
   let filtPos;
   if (firstByte & 0x80) {
@@ -864,7 +864,7 @@ function RarAddVMCode(firstByte, vmCode) {
 
 
 /**
- * @param {!bitjs.io.BitStream} bstream
+ * @param {!BitStream} bstream
  */
 function RarReadVMCode(bstream) {
   const firstByte = bstream.readBits(8);
@@ -886,7 +886,7 @@ function RarReadVMCode(bstream) {
 
 /**
  * Unpacks the bit stream into rBuffer using the Unpack29 algorithm.
- * @param {bitjs.io.BitStream} bstream
+ * @param {BitStream} bstream
  * @param {boolean} Solid
  */
 function Unpack29(bstream, Solid) {
@@ -1258,9 +1258,9 @@ function unpack(v) {
   // TODO: implement what happens when unpVer is < 15
   const Ver = v.header.unpVer <= 15 ? 15 : v.header.unpVer;
   const Solid = v.header.flags.LHD_SOLID;
-  const bstream = new bitjs.io.BitStream(v.fileData.buffer, true /* rtl */, v.fileData.byteOffset, v.fileData.byteLength);
+  const bstream = new BitStream(v.fileData.buffer, true /* rtl */, v.fileData.byteOffset, v.fileData.byteLength);
 
-  rBuffer = new bitjs.io.ByteBuffer(v.header.unpackedSize);
+  rBuffer = new ByteBuffer(v.header.unpackedSize);
 
   if (logToConsole) {
     info('Unpacking ' + v.filename + ' RAR v' + Ver);
@@ -1276,7 +1276,7 @@ function unpack(v) {
       break;
     case 29: // rar 3.x compression
     case 36: // alternative hash
-      wBuffer = new bitjs.io.ByteBuffer(rBuffer.data.length);
+      wBuffer = new ByteBuffer(rBuffer.data.length);
       Unpack29(bstream, Solid);
       break;
   } // switch(method)
@@ -1290,7 +1290,7 @@ function unpack(v) {
  */
 class RarLocalFile {
   /**
-   * @param {bitjs.io.ByteStream} bstream
+   * @param {ByteStream} bstream
    */
   constructor(bstream) {
     this.header = new RarVolumeHeader(bstream);
@@ -1325,7 +1325,7 @@ class RarLocalFile {
 
         // Create a new buffer and copy it over.
         const len = this.header.packSize;
-        const newBuffer = new bitjs.io.ByteBuffer(len);
+        const newBuffer = new ByteBuffer(len);
         newBuffer.insertBytes(this.fileData);
         this.fileData = newBuffer.data;
       } else {
@@ -1402,7 +1402,7 @@ onmessage = function (event) {
 
   // This is the very first time we have been called. Initialize the bytestream.
   if (!bytestream) {
-    bytestream = new bitjs.io.ByteStream(bytes);
+    bytestream = new ByteStream(bytes);
 
     currentFilename = '';
     currentFileNumber = 0;

archive/untar.js

@@ -11,7 +11,7 @@
  */
 
 // This file expects to be invoked as a Worker (see onmessage below).
-importScripts('../io/bytestream-worker.js');
+import { ByteStream } from '../io/bytestream.js';
 
 const UnarchiveState = {
   NOT_STARTED: 0,
@@ -166,7 +166,7 @@ onmessage = function (event) {
 
   // This is the very first time we have been called. Initialize the bytestream.
   if (!bytestream) {
-    bytestream = new bitjs.io.ByteStream(bytes);
+    bytestream = new ByteStream(bytes);
   } else {
     bytestream.push(bytes);
   }