@loaders.gl/worker-utils 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/lib/library-utils/library-utils.js

@@ -1,88 +1,170 @@
-import { global, isBrowser, isWorker } from '../env-utils/globals';
-import * as node from '../node/require-utils.node';
-import { assert } from '../env-utils/assert';
-import { VERSION as __VERSION__ } from '../env-utils/version';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLibraryUrl = exports.loadLibrary = void 0;
+/* global importScripts */
+const globals_1 = require("../env-utils/globals");
+const node = __importStar(require("../node/require-utils.node"));
+const assert_1 = require("../env-utils/assert");
+const version_1 = require("../env-utils/version");
+/**
+ * TODO - unpkg.com doesn't seem to have a `latest` specifier for alpha releases...
+ * 'beta' on beta branch, 'latest' on prod branch
+ */
 const LATEST = 'beta';
-const VERSION = typeof "4.0.0-alpha.5" !== 'undefined' ? "4.0.0-alpha.5" : LATEST;
-const loadLibraryPromises = {};
-export async function loadLibrary(libraryUrl, moduleName = null, options = {}) {
-  if (moduleName) {
-    libraryUrl = getLibraryUrl(libraryUrl, moduleName, options);
-  }
-
-  loadLibraryPromises[libraryUrl] = loadLibraryPromises[libraryUrl] || loadLibraryFromFile(libraryUrl);
-  return await loadLibraryPromises[libraryUrl];
+const VERSION = typeof version_1.VERSION !== 'undefined' ? version_1.VERSION : LATEST;
+const loadLibraryPromises = {}; // promises
+/**
+ * Dynamically loads a library ("module")
+ *
+ * - wasm library: Array buffer is returned
+ * - js library: Parse JS is returned
+ *
+ * Method depends on environment
+ * - browser - script element is created and installed on document
+ * - worker - eval is called on global context
+ * - node - file is required
+ *
+ * @param libraryUrl
+ * @param moduleName
+ * @param options
+ */
+async function loadLibrary(libraryUrl, moduleName = null, options = {}) {
+    if (moduleName) {
+        libraryUrl = getLibraryUrl(libraryUrl, moduleName, options);
+    }
+    // Ensure libraries are only loaded once
+    loadLibraryPromises[libraryUrl] =
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        loadLibraryPromises[libraryUrl] || loadLibraryFromFile(libraryUrl);
+    return await loadLibraryPromises[libraryUrl];
 }
-export function getLibraryUrl(library, moduleName, options) {
-  if (library.startsWith('http')) {
-    return library;
-  }
-
-  const modules = options.modules || {};
-
-  if (modules[library]) {
-    return modules[library];
-  }
-
-  if (!isBrowser) {
-    return "modules/".concat(moduleName, "/dist/libs/").concat(library);
-  }
-
-  if (options.CDN) {
-    assert(options.CDN.startsWith('http'));
-    return "".concat(options.CDN, "/").concat(moduleName, "@").concat(VERSION, "/dist/libs/").concat(library);
-  }
-
-  if (isWorker) {
-    return "../src/libs/".concat(library);
-  }
-
-  return "modules/".concat(moduleName, "/src/libs/").concat(library);
+exports.loadLibrary = loadLibrary;
+// TODO - sort out how to resolve paths for main/worker and dev/prod
+function getLibraryUrl(library, moduleName, options) {
+    // Check if already a URL
+    if (library.startsWith('http')) {
+        return library;
+    }
+    // Allow application to import and supply libraries through `options.modules`
+    const modules = options.modules || {};
+    if (modules[library]) {
+        return modules[library];
+    }
+    // Load from local files, not from CDN scripts in Node.js
+    // TODO - needs to locate the modules directory when installed!
+    if (!globals_1.isBrowser) {
+        return `modules/${moduleName}/dist/libs/${library}`;
+    }
+    // In browser, load from external scripts
+    if (options.CDN) {
+        (0, assert_1.assert)(options.CDN.startsWith('http'));
+        return `${options.CDN}/${moduleName}@${VERSION}/dist/libs/${library}`;
+    }
+    // TODO - loading inside workers requires paths relative to worker script location...
+    if (globals_1.isWorker) {
+        return `../src/libs/${library}`;
+    }
+    return `modules/${moduleName}/src/libs/${library}`;
 }
-
+exports.getLibraryUrl = getLibraryUrl;
 async function loadLibraryFromFile(libraryUrl) {
-  if (libraryUrl.endsWith('wasm')) {
-    const response = await fetch(libraryUrl);
-    return await response.arrayBuffer();
-  }
-
-  if (!isBrowser) {
-    try {
-      return node && node.requireFromFile && (await node.requireFromFile(libraryUrl));
-    } catch {
-      return null;
+    if (libraryUrl.endsWith('wasm')) {
+        const response = await fetch(libraryUrl);
+        return await response.arrayBuffer();
+    }
+    if (!globals_1.isBrowser) {
+        try {
+            return node && node.requireFromFile && (await node.requireFromFile(libraryUrl));
+        }
+        catch {
+            return null;
+        }
+    }
+    if (globals_1.isWorker) {
+        return importScripts(libraryUrl);
     }
-  }
-
-  if (isWorker) {
-    return importScripts(libraryUrl);
-  }
-
-  const response = await fetch(libraryUrl);
-  const scriptSource = await response.text();
-  return loadLibraryFromString(scriptSource, libraryUrl);
+    // TODO - fix - should be more secure than string parsing since observes CORS
+    // if (isBrowser) {
+    //   return await loadScriptFromFile(libraryUrl);
+    // }
+    const response = await fetch(libraryUrl);
+    const scriptSource = await response.text();
+    return loadLibraryFromString(scriptSource, libraryUrl);
+}
+/*
+async function loadScriptFromFile(libraryUrl) {
+  const script = document.createElement('script');
+  script.src = libraryUrl;
+  return await new Promise((resolve, reject) => {
+    script.onload = data => {
+      resolve(data);
+    };
+    script.onerror = reject;
+  });
 }
-
+*/
+// TODO - Needs security audit...
+//  - Raw eval call
+//  - Potentially bypasses CORS
+// Upside is that this separates fetching and parsing
+// we could create a`LibraryLoader` or`ModuleLoader`
 function loadLibraryFromString(scriptSource, id) {
-  if (!isBrowser) {
-    return node.requireFromString && node.requireFromString(scriptSource, id);
-  }
-
-  if (isWorker) {
-    eval.call(global, scriptSource);
+    if (!globals_1.isBrowser) {
+        return node.requireFromString && node.requireFromString(scriptSource, id);
+    }
+    if (globals_1.isWorker) {
+        // Use lvalue trick to make eval run in global scope
+        eval.call(globals_1.global, scriptSource); // eslint-disable-line no-eval
+        // https://stackoverflow.com/questions/9107240/1-evalthis-vs-evalthis-in-javascript
+        // http://perfectionkills.com/global-eval-what-are-the-options/
+        return null;
+    }
+    const script = document.createElement('script');
+    script.id = id;
+    // most browsers like a separate text node but some throw an error. The second method covers those.
+    try {
+        script.appendChild(document.createTextNode(scriptSource));
+    }
+    catch (e) {
+        script.text = scriptSource;
+    }
+    document.body.appendChild(script);
     return null;
-  }
-
-  const script = document.createElement('script');
-  script.id = id;
-
-  try {
-    script.appendChild(document.createTextNode(scriptSource));
-  } catch (e) {
-    script.text = scriptSource;
-  }
-
-  document.body.appendChild(script);
-  return null;
 }
-//# sourceMappingURL=library-utils.js.map
+// TODO - technique for module injection into worker, from THREE.DracoLoader...
+/*
+function combineWorkerWithLibrary(worker, jsContent) {
+  var fn = wWorker.toString();
+  var body = [
+    '// injected',
+    jsContent,
+    '',
+    '// worker',
+    fn.substring(fn.indexOf('{') + 1, fn.lastIndexOf('}'))
+  ].join('\n');
+  this.workerSourceURL = URL.createObjectURL(new Blob([body]));
+}
+*/

package/dist/lib/node/require-utils.node.js

@@ -1,43 +1,60 @@
-import Module from 'module';
-import path from 'path';
-export async function requireFromFile(filename) {
-  if (filename.startsWith('http')) {
-    const response = await fetch(filename);
-    const code = await response.text();
-    return requireFromString(code);
-  }
-
-  if (!filename.startsWith('/')) {
-    filename = "".concat(process.cwd(), "/").concat(filename);
-  }
-
-  return require(filename);
+"use strict";
+// Fork of https://github.com/floatdrop/require-from-string/blob/master/index.js
+// Copyright (c) Vsevolod Strukchinsky <floatdrop@gmail.com> (github.com/floatdrop)
+// MIT license
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireFromString = exports.requireFromFile = void 0;
+// this file is not visible to webpack (it is excluded in the package.json "browser" field).
+const module_1 = __importDefault(require("module"));
+const path_1 = __importDefault(require("path"));
+// Node.js Dynamically require from file
+// Relative names are resolved relative to cwd
+// This indirect function is provided because webpack will try to bundle `module.require`.
+// this file is not visible to webpack (it is excluded in the package.json "browser" field).
+async function requireFromFile(filename) {
+    if (filename.startsWith('http')) {
+        const response = await fetch(filename);
+        const code = await response.text();
+        return requireFromString(code);
+    }
+    if (!filename.startsWith('/')) {
+        filename = `${process.cwd()}/${filename}`;
+    }
+    return require(filename);
 }
-export function requireFromString(code, filename = '', options) {
-  var _options, _options2;
-
-  if (typeof filename === 'object') {
-    options = filename;
-    filename = '';
-  }
-
-  if (typeof code !== 'string') {
-    throw new Error("code must be a string, not ".concat(typeof code));
-  }
-
-  const paths = Module._nodeModulePaths(path.dirname(filename));
-
-  const parent = module.parent;
-  const newModule = new Module(filename, parent);
-  newModule.filename = filename;
-  newModule.paths = [].concat(((_options = options) === null || _options === void 0 ? void 0 : _options.prependPaths) || []).concat(paths).concat(((_options2 = options) === null || _options2 === void 0 ? void 0 : _options2.appendPaths) || []);
-
-  newModule._compile(code, filename);
-
-  if (parent && parent.children) {
-    parent.children.splice(parent.children.indexOf(newModule), 1);
-  }
-
-  return newModule.exports;
+exports.requireFromFile = requireFromFile;
+// Dynamically require from string
+// - `code` - Required - Type: string - Module code.
+// - `filename` - Type: string - Default: '' - Optional filename.
+// - `options.appendPaths` Type: Array List of paths, that will be appended to module paths.
+// Useful, when you want to be able require modules from these paths.
+// - `options.prependPaths` Type: Array Same as appendPaths, but paths will be prepended.
+function requireFromString(code, filename = '', options) {
+    if (typeof filename === 'object') {
+        options = filename;
+        filename = '';
+    }
+    if (typeof code !== 'string') {
+        throw new Error(`code must be a string, not ${typeof code}`);
+    }
+    // @ts-ignore
+    const paths = module_1.default._nodeModulePaths(path_1.default.dirname(filename));
+    const parent = module.parent;
+    // @ts-ignore
+    const newModule = new module_1.default(filename, parent);
+    newModule.filename = filename;
+    newModule.paths = []
+        .concat(options?.prependPaths || [])
+        .concat(paths)
+        .concat(options?.appendPaths || []);
+    // @ts-ignore
+    newModule._compile(code, filename);
+    if (parent && parent.children) {
+        parent.children.splice(parent.children.indexOf(newModule), 1);
+    }
+    return newModule.exports;
 }
-//# sourceMappingURL=require-utils.node.js.map
+exports.requireFromString = requireFromString;

package/dist/lib/node/worker_threads-browser.d.ts

@@ -0,0 +1,7 @@
+export declare class Worker {
+    terminate(): void;
+}
+export { Worker as NodeWorker };
+export { Worker as NodeWorkerType };
+export declare const parentPort: null;
+//# sourceMappingURL=worker_threads-browser.d.ts.map

package/dist/lib/node/worker_threads-browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker_threads-browser.d.ts","sourceRoot":"","sources":["../../../src/lib/node/worker_threads-browser.ts"],"names":[],"mappings":"AAIA,qBAAa,MAAM;IAEjB,SAAS;CACV;AAED,OAAO,EAAC,MAAM,IAAI,UAAU,EAAC,CAAC;AAC9B,OAAO,EAAC,MAAM,IAAI,cAAc,EAAC,CAAC;AAElC,eAAO,MAAM,UAAU,MAAO,CAAC"}

package/dist/lib/node/worker_threads-browser.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parentPort = exports.NodeWorkerType = exports.NodeWorker = exports.Worker = void 0;
+// Browser fills for Node.js built-in `worker_threads` module.
+// These fills are non-functional, and just intended to ensure that
+// `import 'worker_threads` doesn't break browser builds.
+// The replacement is done in package.json browser field
+class Worker {
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    terminate() { }
+}
+exports.Worker = Worker;
+exports.NodeWorker = Worker;
+exports.NodeWorkerType = Worker;
+exports.parentPort = null;

package/dist/lib/node/worker_threads.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" />
+import * as WorkerThreads from 'worker_threads';
+export * from 'worker_threads';
+export declare const NodeWorker: typeof WorkerThreads.Worker;
+export type NodeWorkerType = WorkerThreads.Worker;
+//# sourceMappingURL=worker_threads.d.ts.map

package/dist/lib/node/worker_threads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker_threads.d.ts","sourceRoot":"","sources":["../../../src/lib/node/worker_threads.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,aAAa,MAAM,gBAAgB,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,eAAO,MAAM,UAAU,6BAAuB,CAAC;AAC/C,MAAM,MAAM,cAAc,GAAG,aAAa,CAAC,MAAM,CAAC"}

package/dist/lib/node/worker_threads.js

@@ -0,0 +1,33 @@
+"use strict";
+// loaders.gl, MIT license
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NodeWorker = void 0;
+const WorkerThreads = __importStar(require("worker_threads"));
+__exportStar(require("worker_threads"), exports);
+exports.NodeWorker = WorkerThreads.Worker;

package/dist/lib/process-utils/child-process-proxy.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import * as ChildProcess from 'child_process';
-export declare type ChildProcessProxyProps = {
+export type ChildProcessProxyProps = {
     command: string;
     arguments: string[];
     /** Whether to add a port specified arg */

package/dist/lib/process-utils/child-process-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"child-process-proxy.d.ts","sourceRoot":"","sources":["../../../src/lib/process-utils/child-process-proxy.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAG9C,oBAAY,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8DAA8D;IAC9D,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,KAAK,CAAC,EAAE,YAAY,CAAC,wBAAwB,CAAC;IAC9C,yBAAyB;IACzB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC7C,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;CAChD,CAAC;AAaF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,sBAAsB,CAAsB;IACnD,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,IAAI,CAAa;IACzB,OAAO,CAAC,YAAY,CAAC,CAAM;gBAGf,EAAC,EAAqB,EAAC;;KAAK;IAIxC,qDAAqD;IAC/C,KAAK,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAsD3D,oCAAoC;IAC9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,yBAAyB;IACnB,IAAI,CAAC,UAAU,GAAE,MAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjD,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAM9C,aAAa;CAKd"}
+{"version":3,"file":"child-process-proxy.d.ts","sourceRoot":"","sources":["../../../src/lib/process-utils/child-process-proxy.ts"],"names":[],"mappings":";AAIA,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAG9C,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,0CAA0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8DAA8D;IAC9D,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4CAA4C;IAC5C,KAAK,CAAC,EAAE,YAAY,CAAC,wBAAwB,CAAC;IAC9C,yBAAyB;IACzB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC7C,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;CAChD,CAAC;AAaF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,sBAAsB,CAAsB;IACnD,OAAO,CAAC,YAAY,CAA0C;IAC9D,OAAO,CAAC,IAAI,CAAa;IACzB,OAAO,CAAC,YAAY,CAAC,CAAM;gBAGf,EAAC,EAAqB,EAAC;;KAAK;IAIxC,qDAAqD;IAC/C,KAAK,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAsD3D,oCAAoC;IAC9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,yBAAyB;IACnB,IAAI,CAAC,UAAU,GAAE,MAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjD,WAAW,CAAC,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI;IAM9C,aAAa;CAKd"}