@loaders.gl/compression 4.0.0-alpha.5 → 4.0.0-alpha.7

package/dist/lib/lzo-compression.js

@@ -1,48 +1,58 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { toBuffer } from '@loaders.gl/loader-utils';
-import { Compression } from './compression';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LZOCompression = void 0;
+// LZO
+// import {loadLibrary} from '@loaders.gl/worker-utils';
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const compression_1 = require("./compression");
+// import {isBrowser} from '@loaders.gl/loader-utils';
+// import lzo from 'lzo'; // https://bundlephobia.com/package/lzo
+// import {decompress} from 'lzo-wasm';
+// const LZO_WASM_JS_URL = './node_modules/lzo-wasm/lzo-wasm.js';
+// const LZO_WASM_WASM_URL = './node_modules/lzo-wasm/lzo-wasm.wasm';
 let lzo;
-export class LZOCompression extends Compression {
-  constructor(options) {
-    var _this$options, _this$options$modules;
-
-    super(options);
-
-    _defineProperty(this, "name", 'lzo');
-
-    _defineProperty(this, "extensions", []);
-
-    _defineProperty(this, "contentEncodings", []);
-
-    _defineProperty(this, "isSupported", false);
-
-    _defineProperty(this, "options", void 0);
-
-    this.options = options;
-    lzo = lzo || ((_this$options = this.options) === null || _this$options === void 0 ? void 0 : (_this$options$modules = _this$options.modules) === null || _this$options$modules === void 0 ? void 0 : _this$options$modules.lzo);
-
-    if (!lzo) {
-      throw new Error(this.name);
+/**
+ * Lempel-Ziv-Oberheimer compression / decompression
+ */
+class LZOCompression extends compression_1.Compression {
+    /**
+     * lzo is an injectable dependency due to big size
+     * @param options
+     */
+    constructor(options) {
+        super(options);
+        this.name = 'lzo';
+        this.extensions = [];
+        this.contentEncodings = [];
+        this.isSupported = false; // !isBrowser;
+        this.options = options;
+        lzo = lzo || this.options?.modules?.lzo;
+        if (!lzo) {
+            throw new Error(this.name);
+        }
     }
-  }
-
-  async preload() {}
-
-  async compress(input) {
-    await this.preload();
-    const inputBuffer = toBuffer(input);
-    return lzo.compress(inputBuffer).buffer;
-  }
-
-  async decompress(input) {
-    try {
-      await this.preload();
-      const inputBuffer = toBuffer(input);
-      return lzo.decompress(inputBuffer).buffer;
-    } catch (error) {
-      throw error;
+    async preload() {
+        // await loadLibrary(LZO_WASM_JS_URL);
+        // await loadLibrary(LZO_WASM_WASM_URL);
+    }
+    async compress(input) {
+        await this.preload();
+        // const inputArray = new Uint8Array(input);
+        const inputBuffer = (0, loader_utils_1.toBuffer)(input);
+        return lzo.compress(inputBuffer).buffer;
+    }
+    async decompress(input) {
+        try {
+            await this.preload();
+            // const inputArray = new Uint8Array(input);
+            const inputBuffer = (0, loader_utils_1.toBuffer)(input);
+            return lzo.decompress(inputBuffer).buffer;
+        }
+        catch (error) {
+            // TODO - solve SharedArrayBuffer issues
+            // return decompress(input);
+            throw error;
+        }
     }
-  }
-
 }
-//# sourceMappingURL=lzo-compression.js.map
+exports.LZOCompression = LZOCompression;

package/dist/lib/no-compression.js

@@ -1,37 +1,30 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { Compression } from './compression';
-export class NoCompression extends Compression {
-  constructor(options) {
-    super(options);
-
-    _defineProperty(this, "name", 'uncompressed');
-
-    _defineProperty(this, "extensions", []);
-
-    _defineProperty(this, "contentEncodings", []);
-
-    _defineProperty(this, "isSupported", true);
-
-    _defineProperty(this, "options", void 0);
-
-    this.options = options || {};
-  }
-
-  compressSync(input) {
-    return input;
-  }
-
-  decompressSync(input) {
-    return input;
-  }
-
-  async *compressBatches(asyncIterator) {
-    return yield* asyncIterator;
-  }
-
-  async *decompressBatches(asyncIterator) {
-    return yield* asyncIterator;
-  }
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoCompression = void 0;
+const compression_1 = require("./compression");
+/**
+ * Applies no compression.
+ */
+class NoCompression extends compression_1.Compression {
+    constructor(options) {
+        super(options);
+        this.name = 'uncompressed';
+        this.extensions = [];
+        this.contentEncodings = [];
+        this.isSupported = true;
+        this.options = options || {};
+    }
+    compressSync(input) {
+        return input;
+    }
+    decompressSync(input) {
+        return input;
+    }
+    async *compressBatches(asyncIterator) {
+        return yield* asyncIterator;
+    }
+    async *decompressBatches(asyncIterator) {
+        return yield* asyncIterator;
+    }
 }
-//# sourceMappingURL=no-compression.js.map
+exports.NoCompression = NoCompression;

package/dist/lib/snappy-compression.js

@@ -1,30 +1,27 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { Compression } from './compression';
-import { compress, uncompress } from 'snappyjs';
-export class SnappyCompression extends Compression {
-  constructor(options) {
-    super(options);
-
-    _defineProperty(this, "name", 'snappy');
-
-    _defineProperty(this, "extensions", []);
-
-    _defineProperty(this, "contentEncodings", []);
-
-    _defineProperty(this, "isSupported", true);
-
-    _defineProperty(this, "options", void 0);
-
-    this.options = options || {};
-  }
-
-  compressSync(input) {
-    return compress(input);
-  }
-
-  decompressSync(input) {
-    return uncompress(input);
-  }
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnappyCompression = void 0;
+const compression_1 = require("./compression");
+const snappyjs_1 = require("snappyjs"); // https://bundlephobia.com/package/snappy
+/**
+ * Snappy/zippy compression / decompression
+ */
+class SnappyCompression extends compression_1.Compression {
+    constructor(options) {
+        super(options);
+        this.name = 'snappy';
+        this.extensions = [];
+        this.contentEncodings = [];
+        this.isSupported = true;
+        this.options = options || {};
+    }
+    compressSync(input) {
+        // Accepts arrayBuffer - https://github.com/zhipeng-jia/snappyjs#usage
+        return (0, snappyjs_1.compress)(input);
+    }
+    decompressSync(input) {
+        // Accepts arrayBuffer - https://github.com/zhipeng-jia/snappyjs#usage
+        return (0, snappyjs_1.uncompress)(input);
+    }
 }
-//# sourceMappingURL=snappy-compression.js.map
+exports.SnappyCompression = SnappyCompression;

package/dist/lib/zstd-compression.js

@@ -1,48 +1,47 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { Compression } from './compression';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZstdCompression = void 0;
+const compression_1 = require("./compression");
+// import {ZstdCodec} from 'zstd-codec'; // https://bundlephobia.com/package/zstd-codec
 let ZstdCodec;
 let zstd;
-export class ZstdCompression extends Compression {
-  constructor(options) {
-    var _this$options, _this$options$modules;
-
-    super(options);
-
-    _defineProperty(this, "name", 'zstd');
-
-    _defineProperty(this, "extensions", []);
-
-    _defineProperty(this, "contentEncodings", []);
-
-    _defineProperty(this, "isSupported", true);
-
-    _defineProperty(this, "options", void 0);
-
-    this.options = options;
-    ZstdCodec = (_this$options = this.options) === null || _this$options === void 0 ? void 0 : (_this$options$modules = _this$options.modules) === null || _this$options$modules === void 0 ? void 0 : _this$options$modules['zstd-codec'];
-
-    if (!ZstdCodec) {
-      console.warn("".concat(this.name, " library not installed"));
+/**
+ * Zstandard compression / decompression
+ */
+class ZstdCompression extends compression_1.Compression {
+    /**
+     * zstd-codec is an injectable dependency due to big size
+     * @param options
+     */
+    constructor(options) {
+        super(options);
+        this.name = 'zstd';
+        this.extensions = [];
+        this.contentEncodings = [];
+        this.isSupported = true;
+        this.options = options;
+        ZstdCodec = this.options?.modules?.['zstd-codec'];
+        if (!ZstdCodec) {
+            // eslint-disable-next-line no-console
+            console.warn(`${this.name} library not installed`);
+        }
     }
-  }
-
-  async preload() {
-    if (!zstd && ZstdCodec) {
-      zstd = await new Promise(resolve => ZstdCodec.run(zstd => resolve(zstd)));
+    async preload() {
+        if (!zstd && ZstdCodec) {
+            zstd = await new Promise((resolve) => ZstdCodec.run((zstd) => resolve(zstd)));
+        }
+    }
+    compressSync(input) {
+        const simpleZstd = new zstd.Simple();
+        const inputArray = new Uint8Array(input);
+        return simpleZstd.compress(inputArray).buffer;
+    }
+    decompressSync(input) {
+        const simpleZstd = new zstd.Simple();
+        // var ddict = new zstd.Dict.Decompression(dictData);
+        // var jsonBytes = simpleZstd.decompressUsingDict(jsonZstData, ddict);
+        const inputArray = new Uint8Array(input);
+        return simpleZstd.decompress(inputArray).buffer;
     }
-  }
-
-  compressSync(input) {
-    const simpleZstd = new zstd.Simple();
-    const inputArray = new Uint8Array(input);
-    return simpleZstd.compress(inputArray).buffer;
-  }
-
-  decompressSync(input) {
-    const simpleZstd = new zstd.Simple();
-    const inputArray = new Uint8Array(input);
-    return simpleZstd.decompress(inputArray).buffer;
-  }
-
 }
-//# sourceMappingURL=zstd-compression.js.map
+exports.ZstdCompression = ZstdCompression;

package/dist/types.js

@@ -1,2 +1,2 @@
-export {};
-//# sourceMappingURL=types.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/workers/worker.js

@@ -1,68 +1,77 @@
-import { createWorker } from '@loaders.gl/worker-utils';
-import { NoCompression } from '../lib/no-compression';
-import { BrotliCompression } from '../lib/brotli-compression';
-import { DeflateCompression } from '../lib/deflate-compression';
-import { GZipCompression } from '../lib/gzip-compression';
-import { LZ4Compression } from '../lib/lz4-compression';
-import { SnappyCompression } from '../lib/snappy-compression';
-import { ZstdCompression } from '../lib/zstd-compression';
-import lz4js from 'lz4js';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const worker_utils_1 = require("@loaders.gl/worker-utils");
+// Compressors
+const no_compression_1 = require("../lib/no-compression");
+const brotli_compression_1 = require("../lib/brotli-compression");
+const deflate_compression_1 = require("../lib/deflate-compression");
+const gzip_compression_1 = require("../lib/gzip-compression");
+const lz4_compression_1 = require("../lib/lz4-compression");
+// import {LZOCompression} from '../lib/lzo-compression.js';
+const snappy_compression_1 = require("../lib/snappy-compression");
+const zstd_compression_1 = require("../lib/zstd-compression");
+// Import big dependencies
+// import brotli from 'brotli'; - brotli has problems with decompress in browsers
+// import brotliDecompress from 'brotli/decompress';
+const lz4js_1 = __importDefault(require("lz4js"));
+// import lzo from 'lzo';
+// import {ZstdCodec} from 'zstd-codec';
+// Inject large dependencies through Compression constructor options
 const modules = {
-  lz4js
+    // brotli has problems with decompress in browsers
+    // brotli: {
+    //   decompress: brotliDecompress,
+    //   compress: () => {
+    //     throw new Error('brotli compress');
+    //   }
+    // },
+    lz4js: lz4js_1.default
+    // lzo,
+    // 'zstd-codec': ZstdCodec
 };
-const COMPRESSIONS = [new NoCompression({
-  modules
-}), new BrotliCompression({
-  modules
-}), new DeflateCompression({
-  modules
-}), new GZipCompression({
-  modules
-}), new LZ4Compression({
-  modules
-}), new SnappyCompression({
-  modules
-}), new ZstdCompression({
-  modules
-})];
-createWorker(async (data, options = {}) => {
-  const operation = getOperation(String(options === null || options === void 0 ? void 0 : options.operation));
-  const compression = getCompression(String(options === null || options === void 0 ? void 0 : options.compression));
-
-  switch (operation) {
-    case 'compress':
-      return await compression.compress(data);
-
-    case 'decompress':
-      return await compression.decompress(data);
-
-    default:
-      throw new Error('invalid option');
-  }
+/** @type {Compression[]} */
+const COMPRESSIONS = [
+    new no_compression_1.NoCompression({ modules }),
+    new brotli_compression_1.BrotliCompression({ modules }),
+    new deflate_compression_1.DeflateCompression({ modules }),
+    new gzip_compression_1.GZipCompression({ modules }),
+    // new LZOCompression({modules}),
+    new lz4_compression_1.LZ4Compression({ modules }),
+    new snappy_compression_1.SnappyCompression({ modules }),
+    new zstd_compression_1.ZstdCompression({ modules })
+];
+(0, worker_utils_1.createWorker)(async (data, options = {}) => {
+    const operation = getOperation(String(options?.operation));
+    const compression = getCompression(String(options?.compression));
+    // @ts-ignore
+    switch (operation) {
+        case 'compress':
+            return await compression.compress(data);
+        case 'decompress':
+            return await compression.decompress(data);
+        default:
+            throw new Error('invalid option');
+    }
 });
-
 function getOperation(operation) {
-  switch (operation) {
-    case 'compress':
-    case 'deflate':
-      return 'compress';
-
-    case 'decompress':
-    case 'inflate':
-      return 'decompress';
-
-    default:
-      throw new Error("@loaders.gl/compression: Unsupported operation ".concat(operation, ". Expected 'compress' or 'decompress'"));
-  }
+    switch (operation) {
+        case 'compress':
+        case 'deflate':
+            return 'compress';
+        case 'decompress':
+        case 'inflate':
+            return 'decompress';
+        default:
+            throw new Error(`@loaders.gl/compression: Unsupported operation ${operation}. Expected 'compress' or 'decompress'`);
+    }
 }
-
 function getCompression(name) {
-  const Compression = COMPRESSIONS.find(compression_ => name === compression_.name);
-
-  if (!Compression) {
-    throw new Error("@loaders.gl/compression: Unsupported compression ".concat(name));
-  }
-
-  return Compression;
+    const Compression = COMPRESSIONS.find((compression_) => name === compression_.name);
+    if (!Compression) {
+        throw new Error(`@loaders.gl/compression: Unsupported compression ${name}`);
+    }
+    return Compression;
 }
-//# sourceMappingURL=worker.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/compression",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.7",
   "description": "Decompression and compression plugins for loaders.gl",
   "license": "MIT",
   "publishConfig": {
@@ -18,8 +18,8 @@
     "point cloud"
   ],
   "types": "dist/index.d.ts",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
+  "main": "dist/es5/index.js",
+  "module": "dist/esm/index.js",
   "sideEffects": false,
   "files": [
     "src",
@@ -32,16 +32,18 @@
     "util": false
   },
   "scripts": {
-    "pre-build": "npm run build-bundle && npm run build-worker",
+    "pre-build": "npm run build-bundle && npm run build-worker && npm run build-worker-node",
     "build-bundle": "esbuild src/bundle.ts --outfile=dist/dist.min.js --bundle --minify --sourcemap --external:{fs,path,crypto}",
-    "build-worker": "esbuild src/workers/worker.ts --outfile=dist/compression-worker.js --bundle --minify --sourcemap --external:{fs,path,crypto} --define:__VERSION__=\\\"$npm_package_version\\\""
+    "build-worker": "esbuild src/workers/worker.ts --outfile=dist/compression-worker.js --target=esnext --bundle --minify --sourcemap --external:{fs,path,crypto} --define:__VERSION__=\\\"$npm_package_version\\\"",
+    "build-worker-node": "esbuild src/workers/worker.ts --outfile=dist/compression-worker-node.js --platform=node --target=node16 --bundle --minify --sourcemap --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.5",
-    "@loaders.gl/worker-utils": "4.0.0-alpha.5",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.7",
+    "@loaders.gl/worker-utils": "4.0.0-alpha.7",
     "@types/brotli": "^1.3.0",
     "@types/pako": "^1.0.1",
+    "fflate": "0.7.4",
     "lzo-wasm": "^0.0.4",
     "pako": "1.0.11",
     "snappyjs": "^0.6.1"
@@ -49,14 +51,12 @@
   "optionalDependencies": {
     "brotli": "^1.3.2",
     "lz4js": "^0.2.0",
-    "lzo": "^0.4.11",
     "zstd-codec": "^0.1"
   },
   "devDependencies": {
     "brotli": "^1.3.2",
     "lz4js": "^0.2.0",
-    "lzo": "^0.4.11",
     "zstd-codec": "^0.1"
   },
-  "gitHead": "7a71a54bdf1ddf985cc3af3db90b82e7fa97d025"
+  "gitHead": "afb59c4d8e5d8ebb9c28f111cb0c96c5527d0ffd"
 }

package/src/index.ts

@@ -1,13 +1,14 @@
 export type {CompressionOptions} from './lib/compression';
 
 export {Compression} from './lib/compression';
+
 export {NoCompression} from './lib/no-compression';
 export {DeflateCompression} from './lib/deflate-compression';
 export {GZipCompression} from './lib/gzip-compression';
+export {BrotliCompression} from './lib/brotli-compression';
+export {SnappyCompression} from './lib/snappy-compression';
 export {LZ4Compression} from './lib/lz4-compression';
 export {ZstdCompression} from './lib/zstd-compression';
-export {SnappyCompression} from './lib/snappy-compression';
-export {BrotliCompression} from './lib/brotli-compression';
 export {LZOCompression} from './lib/lzo-compression';
 
 export type {CompressionWorkerOptions} from './compression-worker';

package/src/lib/brotli-compression.ts

@@ -6,7 +6,7 @@ import type brotliNamespace from 'brotli';
 // import brotli from 'brotli';  // https://bundlephobia.com/package/brotli
 import {BrotliDecode} from '../brotli/decode';
 import zlib from 'zlib';
-import {promisify} from '@loaders.gl/loader-utils';
+import {promisify1} from '@loaders.gl/loader-utils';
 
 export type BrotliCompressionOptions = CompressionOptions & {
   brotli?: {
@@ -57,7 +57,7 @@ export class BrotliCompression extends Compression {
   async compress(input: ArrayBuffer): Promise<ArrayBuffer> {
     // On Node.js we can use built-in zlib
     if (!isBrowser && this.options.brotli?.useZlib) {
-      const buffer = await promisify(zlib.brotliCompress)(input);
+      const buffer = await promisify1(zlib.brotliCompress)(input);
       return toArrayBuffer(buffer);
     }
     return this.compressSync(input);
@@ -84,7 +84,7 @@ export class BrotliCompression extends Compression {
   async decompress(input: ArrayBuffer): Promise<ArrayBuffer> {
     // On Node.js we can use built-in zlib
     if (!isBrowser && this.options.brotli?.useZlib) {
-      const buffer = await promisify(zlib.brotliDecompress)(input);
+      const buffer = await promisify1(zlib.brotliDecompress)(input);
       return toArrayBuffer(buffer);
     }
     return this.decompressSync(input);

package/src/lib/deflate-compression.ts

@@ -4,7 +4,7 @@ import {Compression} from './compression';
 import {isBrowser, toArrayBuffer} from '@loaders.gl/loader-utils';
 import pako from 'pako'; // https://bundlephobia.com/package/pako
 import zlib from 'zlib';
-import {promisify} from '@loaders.gl/loader-utils';
+import {promisify1} from '@loaders.gl/loader-utils';
 
 export type DeflateCompressionOptions = CompressionOptions & {
   deflate?: pako.InflateOptions & pako.DeflateOptions & {useZlib?: boolean};
@@ -32,8 +32,8 @@ export class DeflateCompression extends Compression {
     // On Node.js we can use built-in zlib
     if (!isBrowser && this.options.deflate?.useZlib) {
       const buffer = this.options.deflate?.gzip
-        ? await promisify(zlib.gzip)(input)
-        : await promisify(zlib.deflate)(input);
+        ? await promisify1(zlib.gzip)(input)
+        : await promisify1(zlib.deflate)(input);
       return toArrayBuffer(buffer);
     }
     return this.compressSync(input);
@@ -43,8 +43,8 @@ export class DeflateCompression extends Compression {
     // On Node.js we can use built-in zlib
     if (!isBrowser && this.options.deflate?.useZlib) {
       const buffer = this.options.deflate?.gzip
-        ? await promisify(zlib.gunzip)(input)
-        : await promisify(zlib.inflate)(input);
+        ? await promisify1(zlib.gunzip)(input)
+        : await promisify1(zlib.inflate)(input);
       return toArrayBuffer(buffer);
     }
     return this.decompressSync(input);