@loaders.gl/core 3.1.8 → 3.2.0-alpha.3

package/dist/null-worker.js

@@ -35,16 +35,33 @@
   }
 
   // ../worker-utils/src/lib/worker-farm/worker-body.ts
+  function getParentPort() {
+    let parentPort;
+    try {
+      eval("globalThis.parentPort = require('worker_threads').parentPort");
+      parentPort = globalThis.parentPort;
+    } catch {
+    }
+    return parentPort;
+  }
   var onMessageWrapperMap = new Map();
   var WorkerBody = class {
+    static inWorkerThread() {
+      return typeof self !== "undefined" || Boolean(getParentPort());
+    }
     static set onmessage(onMessage) {
-      self.onmessage = (message) => {
-        if (!isKnownMessage(message)) {
-          return;
-        }
-        const { type, payload } = message.data;
+      function handleMessage(message) {
+        const parentPort3 = getParentPort();
+        const { type, payload } = parentPort3 ? message : message.data;
         onMessage(type, payload);
-      };
+      }
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        parentPort2.on("message", handleMessage);
+        parentPort2.on("exit", () => console.debug("Node worker closing"));
+      } else {
+        globalThis.onmessage = handleMessage;
+      }
     }
     static addEventListener(onMessage) {
       let onMessageWrapper = onMessageWrapperMap.get(onMessage);
@@ -53,22 +70,36 @@
           if (!isKnownMessage(message)) {
             return;
           }
-          const { type, payload } = message.data;
+          const parentPort3 = getParentPort();
+          const { type, payload } = parentPort3 ? message : message.data;
           onMessage(type, payload);
         };
       }
-      self.addEventListener("message", onMessageWrapper);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        console.error("not implemented");
+      } else {
+        globalThis.addEventListener("message", onMessageWrapper);
+      }
     }
     static removeEventListener(onMessage) {
       const onMessageWrapper = onMessageWrapperMap.get(onMessage);
       onMessageWrapperMap.delete(onMessage);
-      self.removeEventListener("message", onMessageWrapper);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        console.error("not implemented");
+      } else {
+        globalThis.removeEventListener("message", onMessageWrapper);
+      }
     }
     static postMessage(type, payload) {
-      if (self) {
-        const data = { source: "loaders.gl", type, payload };
-        const transferList = getTransferList(payload);
-        self.postMessage(data, transferList);
+      const data = { source: "loaders.gl", type, payload };
+      const transferList = getTransferList(payload);
+      const parentPort2 = getParentPort();
+      if (parentPort2) {
+        parentPort2.postMessage(data, transferList);
+      } else {
+        globalThis.postMessage(data, transferList);
       }
     }
   };
@@ -80,19 +111,20 @@
   // ../loader-utils/src/lib/worker-loader-utils/create-loader-worker.ts
   var requestId = 0;
   function createLoaderWorker(loader) {
-    if (typeof self === "undefined") {
+    if (!WorkerBody.inWorkerThread()) {
       return;
     }
     WorkerBody.onmessage = async (type, payload) => {
       switch (type) {
         case "process":
           try {
-            const { input, options = {} } = payload;
+            const { input, options = {}, context = {} } = payload;
             const result = await parseData({
               loader,
               arrayBuffer: input,
               options,
               context: {
+                ...context,
                 parse: parseOnMainThread
               }
             });
@@ -152,7 +184,13 @@
   }
 
   // src/null-loader.ts
-  var VERSION = true ? "3.1.8" : "latest";
+  var VERSION = true ? "3.2.0-alpha.3" : "latest";
+  function parseSync(arrayBuffer, options, context) {
+    if (!options.null.echoParameters)
+      return null;
+    context = context && JSON.parse(JSON.stringify(context));
+    return { arrayBuffer, options, context };
+  }
   var NullLoader = {
     name: "Null loader",
     id: "null",
@@ -160,16 +198,18 @@
     version: VERSION,
     mimeTypes: ["application/x.empty"],
     extensions: ["null"],
-    parse: async (arrayBuffer) => arrayBuffer,
-    parseSync: (arrayBuffer) => arrayBuffer,
-    parseInBatches: async function* generator(asyncIterator) {
+    parse: async (arrayBuffer, options, context) => parseSync(arrayBuffer, options, context),
+    parseSync,
+    parseInBatches: async function* generator(asyncIterator, options, context) {
       for await (const batch of asyncIterator) {
-        yield batch;
+        yield parseSync(batch, options, context);
       }
     },
     tests: [() => false],
     options: {
-      null: {}
+      null: {
+        echoParameters: false
+      }
     }
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/core",
-  "version": "3.1.8",
+  "version": "3.2.0-alpha.3",
   "description": "Framework-independent loaders for 3D graphics formats",
   "license": "MIT",
   "publishConfig": {
@@ -25,6 +25,8 @@
     "fs": false,
     "stream": false,
     "./src/iterators/make-stream/make-node-stream.ts": "./src/iterators/make-stream/make-dom-stream.ts",
+    "./src/iterators/make-stream/make-node-stream.js": "./src/iterators/make-stream/make-dom-stream.js",
+    "./dist/iterators/make-stream/make-node-stream.js": "./dist/iterators/make-stream/make-dom-stream.js",
     "./dist/es5/iterators/make-stream/make-node-stream.js": "./dist/es5/iterators/make-stream/make-dom-stream.js",
     "./dist/esm/iterators/make-stream/make-node-stream.js": "./dist/esm/iterators/make-stream/make-dom-stream.js"
   },
@@ -40,10 +42,10 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/loader-utils": "3.1.8",
-    "@loaders.gl/worker-utils": "3.1.8",
+    "@loaders.gl/loader-utils": "3.2.0-alpha.3",
+    "@loaders.gl/worker-utils": "3.2.0-alpha.3",
     "@probe.gl/log": "^3.5.0",
     "probe.gl": "^3.4.0"
   },
-  "gitHead": "0ef07b4e9fc20f5a882224cf241c6fd1bad898d8"
+  "gitHead": "f0d4b801efeb7094283106352ee759eccfb21f10"
 }

package/src/index.ts

@@ -6,7 +6,7 @@ export {readFileSync} from './lib/fetch/read-file';
 export {writeFile, writeFileSync} from './lib/fetch/write-file';
 
 // CONFIGURATION
-export {setLoaderOptions} from './lib/api/set-loader-options';
+export {setLoaderOptions, getLoaderOptions} from './lib/api/loader-options';
 export {registerLoaders} from './lib/api/register-loaders';
 export {selectLoader, selectLoaderSync} from './lib/api/select-loader';
 

package/src/lib/api/encode.ts

@@ -1,8 +1,10 @@
-import type {Writer, LoaderOptions} from '@loaders.gl/loader-utils';
+import {Writer, LoaderOptions, canEncodeWithWorker} from '@loaders.gl/loader-utils';
+import {processOnWorker} from '@loaders.gl/worker-utils';
 import {concatenateArrayBuffers, resolvePath} from '@loaders.gl/loader-utils';
 import {isBrowser} from '@loaders.gl/loader-utils';
 import {writeFile} from '../fetch/write-file';
 import {fetchFile} from '../fetch/fetch-file';
+import {getLoaderOptions} from './loader-options';
 
 /**
  * Encode loaded data into a binary ArrayBuffer using the specified Writer.
@@ -12,6 +14,12 @@ export async function encode(
   writer: Writer,
   options?: LoaderOptions
 ): Promise<ArrayBuffer> {
+  const globalOptions = getLoaderOptions();
+  options = {...globalOptions, ...options};
+  if (canEncodeWithWorker(writer, options)) {
+    return await processOnWorker(writer, data, options);
+  }
+
   // TODO Merge default writer options with options argument like it is done in load module.
   if (writer.encode) {
     return await writer.encode(data, options);

package/src/lib/api/loader-options.ts

@@ -0,0 +1,2 @@
+export {setGlobalOptions as setLoaderOptions} from '../loader-utils/option-utils';
+export {getGlobalLoaderOptions as getLoaderOptions} from '../loader-utils/option-utils';

package/src/lib/api/parse.ts

@@ -2,6 +2,7 @@ import type {DataType, Loader, LoaderContext, LoaderOptions} from '@loaders.gl/l
 import {assert, validateWorkerVersion} from '@loaders.gl/worker-utils';
 import {parseWithWorker, canParseWithWorker} from '@loaders.gl/loader-utils';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
+import {isResponse} from '../../javascript-utils/is-type';
 import {normalizeOptions} from '../loader-utils/option-utils';
 import {getArrayBufferOrStringFromData} from '../loader-utils/get-data';
 import {getLoaderContext, getLoadersFromContext} from '../loader-utils/loader-context';
@@ -62,6 +63,14 @@ export async function parse(
 async function parseWithLoader(loader, data, options, context) {
   validateWorkerVersion(loader);
 
+  if (isResponse(data)) {
+    // Serialize to support passing the response to web worker
+    const response = data as Response;
+    const {ok, redirected, status, statusText, type, url} = response;
+    const headers = Object.fromEntries(response.headers.entries());
+    context.response = {headers, ok, redirected, status, statusText, type, url};
+  }
+
   data = await getArrayBufferOrStringFromData(data, loader, options);
 
   // First check for synchronous text parser, wrap results in promises

package/src/lib/api/select-loader.ts

@@ -104,6 +104,7 @@ export function selectLoaderSync(
 }
 
 /** Implements loaders selection logic */
+// eslint-disable-next-line complexity
 function selectLoaderInternal(
   data: Response | Blob | ArrayBuffer | string,
   loaders: Loader[],

package/src/lib/loader-utils/option-defaults.ts

@@ -1,4 +1,5 @@
 import type {LoaderOptions} from '@loaders.gl/loader-utils';
+import {isBrowser} from '@loaders.gl/loader-utils';
 import {ConsoleLog} from './loggers';
 
 export const DEFAULT_LOADER_OPTIONS: LoaderOptions = {
@@ -12,7 +13,8 @@ export const DEFAULT_LOADER_OPTIONS: LoaderOptions = {
   worker: true, // By default, use worker if provided by loader.
   maxConcurrency: 3, // How many worker instances should be created for each loader.
   maxMobileConcurrency: 1, // How many worker instances should be created for each loader on mobile devices.
-  reuseWorkers: true, // By default reuse workers,
+  reuseWorkers: isBrowser, // By default reuse workers in browser (Node.js refuses to terminate if browsers are running)
+  _nodeWorkers: false, // By default do not support node workers
   _workerType: '', // 'test' to use locally generated workers
 
   limit: 0,

package/src/lib/loader-utils/option-utils.ts

@@ -26,9 +26,12 @@ export function getGlobalLoaderState(): GlobalLoaderState {
   return loaders._state;
 }
 
-// Store global loader options on the global object to increase chances of cross loaders-version interoperability
-// NOTE: This use case is not reliable but can help when testing new versions of loaders.gl with existing frameworks
-const getGlobalLoaderOptions = () => {
+/**
+ * Store global loader options on the global object to increase chances of cross loaders-version interoperability
+ * NOTE: This use case is not reliable but can help when testing new versions of loaders.gl with existing frameworks
+ * @returns global loader options merged with default loader options
+ */
+export const getGlobalLoaderOptions = () => {
   const state = getGlobalLoaderState();
   // Ensure all default loader options from this library are mentioned
   state.globalOptions = state.globalOptions || {...DEFAULT_LOADER_OPTIONS};

package/src/lib/utils/response-utils.ts

@@ -65,7 +65,7 @@ export async function checkResponse(response: Response): Promise<void> {
 export function checkResponseSync(response: Response): void {
   if (!response.ok) {
     let message = `${response.status} ${response.statusText}`;
-    message = message.length > 60 ? `${message.slice(60)}...` : message;
+    message = message.length > 60 ? `${message.slice(0, 60)}...` : message;
     throw new Error(message);
   }
 }
@@ -81,7 +81,7 @@ async function getResponseError(response): Promise<string> {
       text += ` ${await response.text()}`;
     }
     message += text;
-    message = message.length > 60 ? `${message.slice(60)}...` : message;
+    message = message.length > 60 ? `${message.slice(0, 60)}...` : message;
   } catch (error) {
     // eslint forbids return in a finally statement, so we just catch here
   }

package/src/null-loader.ts

@@ -21,6 +21,16 @@ export const NullWorkerLoader: Loader = {
   }
 };
 
+/**
+ * Returns arguments passed to the parse API in a format that can be transfered to a
+ * web worker. The `context` parameter is stripped using JSON.stringify & parse.
+ */
+function parseSync(arrayBuffer, options, context) {
+  if (!options.null.echoParameters) return null;
+  context = context && JSON.parse(JSON.stringify(context));
+  return {arrayBuffer, options, context};
+}
+
 /**
  * Loads any data and returns null (or optionally passes through data unparsed)
  */
@@ -31,15 +41,17 @@ export const NullLoader: LoaderWithParser = {
   version: VERSION,
   mimeTypes: ['application/x.empty'],
   extensions: ['null'],
-  parse: async (arrayBuffer) => arrayBuffer,
-  parseSync: (arrayBuffer) => arrayBuffer,
-  parseInBatches: async function* generator(asyncIterator) {
+  parse: async (arrayBuffer, options, context) => parseSync(arrayBuffer, options, context),
+  parseSync,
+  parseInBatches: async function* generator(asyncIterator, options, context) {
     for await (const batch of asyncIterator) {
-      yield batch;
+      yield parseSync(batch, options, context);
     }
   },
   tests: [() => false],
   options: {
-    null: {}
+    null: {
+      echoParameters: false
+    }
   }
 };

package/dist/es5/lib/api/set-loader-options.js

@@ -1,13 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.setLoaderOptions = setLoaderOptions;
-
-var _optionUtils = require("../loader-utils/option-utils");
-
-function setLoaderOptions(options) {
-  (0, _optionUtils.setGlobalOptions)(options);
-}
-//# sourceMappingURL=set-loader-options.js.map

package/dist/es5/lib/api/set-loader-options.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/lib/api/set-loader-options.ts"],"names":["setLoaderOptions","options"],"mappings":";;;;;;;AAAA;;AAMO,SAASA,gBAAT,CAA0BC,OAA1B,EAAiD;AACtD,qCAAiBA,OAAjB;AACD","sourcesContent":["import {setGlobalOptions} from '../loader-utils/option-utils';\n\n/**\n * Set global loader options\n * @param options\n */\nexport function setLoaderOptions(options: object): void {\n  setGlobalOptions(options);\n}\n"],"file":"set-loader-options.js"}

package/dist/esm/lib/api/set-loader-options.js

@@ -1,5 +0,0 @@
-import { setGlobalOptions } from '../loader-utils/option-utils';
-export function setLoaderOptions(options) {
-  setGlobalOptions(options);
-}
-//# sourceMappingURL=set-loader-options.js.map

package/dist/esm/lib/api/set-loader-options.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../../src/lib/api/set-loader-options.ts"],"names":["setGlobalOptions","setLoaderOptions","options"],"mappings":"AAAA,SAAQA,gBAAR,QAA+B,8BAA/B;AAMA,OAAO,SAASC,gBAAT,CAA0BC,OAA1B,EAAiD;AACtDF,EAAAA,gBAAgB,CAACE,OAAD,CAAhB;AACD","sourcesContent":["import {setGlobalOptions} from '../loader-utils/option-utils';\n\n/**\n * Set global loader options\n * @param options\n */\nexport function setLoaderOptions(options: object): void {\n  setGlobalOptions(options);\n}\n"],"file":"set-loader-options.js"}

package/dist/lib/api/set-loader-options.d.ts

@@ -1,6 +0,0 @@
-/**
- * Set global loader options
- * @param options
- */
-export declare function setLoaderOptions(options: object): void;
-//# sourceMappingURL=set-loader-options.d.ts.map

package/dist/lib/api/set-loader-options.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"set-loader-options.d.ts","sourceRoot":"","sources":["../../../src/lib/api/set-loader-options.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAEtD"}

package/dist/lib/api/set-loader-options.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setLoaderOptions = void 0;
-const option_utils_1 = require("../loader-utils/option-utils");
-/**
- * Set global loader options
- * @param options
- */
-function setLoaderOptions(options) {
-    (0, option_utils_1.setGlobalOptions)(options);
-}
-exports.setLoaderOptions = setLoaderOptions;

package/src/lib/api/set-loader-options.ts

@@ -1,9 +0,0 @@
-import {setGlobalOptions} from '../loader-utils/option-utils';
-
-/**
- * Set global loader options
- * @param options
- */
-export function setLoaderOptions(options: object): void {
-  setGlobalOptions(options);
-}