@loaders.gl/core 4.2.0-alpha.3 → 4.2.0-alpha.5

package/dist/lib/loader-utils/loader-context.js

@@ -1,38 +1,57 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { getFetchFunction } from "./get-fetch-function.js";
 import { extractQueryString, stripQueryString } from "../utils/url-utils.js";
 import { path } from '@loaders.gl/loader-utils';
+/**
+ * "sub" loaders invoked by other loaders get a "context" injected on `this`
+ * The context will inject core methods like `parse` and contain information
+ * about loaders and options passed in to the top-level `parse` call.
+ *
+ * @param context
+ * @param options
+ * @param previousContext
+ */
 export function getLoaderContext(context, options, parentContext) {
-  if (parentContext) {
-    return parentContext;
-  }
-  const newContext = {
-    fetch: getFetchFunction(options, context),
-    ...context
-  };
-  if (newContext.url) {
-    const baseUrl = stripQueryString(newContext.url);
-    newContext.baseUrl = baseUrl;
-    newContext.queryString = extractQueryString(newContext.url);
-    newContext.filename = path.filename(baseUrl);
-    newContext.baseUrl = path.dirname(baseUrl);
-  }
-  if (!Array.isArray(newContext.loaders)) {
-    newContext.loaders = null;
-  }
-  return newContext;
+    // For recursive calls, we already have a context
+    // TODO - add any additional loaders to context?
+    if (parentContext) {
+        return parentContext;
+    }
+    const newContext = {
+        fetch: getFetchFunction(options, context),
+        ...context
+    };
+    // Parse URLs so that subloaders can easily generate correct strings
+    if (newContext.url) {
+        const baseUrl = stripQueryString(newContext.url);
+        newContext.baseUrl = baseUrl;
+        newContext.queryString = extractQueryString(newContext.url);
+        newContext.filename = path.filename(baseUrl);
+        newContext.baseUrl = path.dirname(baseUrl);
+    }
+    // Recursive loading does not use single loader
+    if (!Array.isArray(newContext.loaders)) {
+        newContext.loaders = null;
+    }
+    return newContext;
 }
+// eslint-disable-next-line complexity
 export function getLoadersFromContext(loaders, context) {
-  if (loaders && !Array.isArray(loaders)) {
-    return loaders;
-  }
-  let candidateLoaders;
-  if (loaders) {
-    candidateLoaders = Array.isArray(loaders) ? loaders : [loaders];
-  }
-  if (context && context.loaders) {
-    const contextLoaders = Array.isArray(context.loaders) ? context.loaders : [context.loaders];
-    candidateLoaders = candidateLoaders ? [...candidateLoaders, ...contextLoaders] : contextLoaders;
-  }
-  return candidateLoaders && candidateLoaders.length ? candidateLoaders : undefined;
+    // A single loader (non-array) indicates no selection desired. Force select.
+    if (loaders && !Array.isArray(loaders)) {
+        return loaders;
+    }
+    // Create a merged list
+    let candidateLoaders;
+    if (loaders) {
+        candidateLoaders = Array.isArray(loaders) ? loaders : [loaders];
+    }
+    if (context && context.loaders) {
+        const contextLoaders = Array.isArray(context.loaders) ? context.loaders : [context.loaders];
+        candidateLoaders = candidateLoaders ? [...candidateLoaders, ...contextLoaders] : contextLoaders;
+    }
+    // If no loaders, return null to look in globally registered loaders
+    return candidateLoaders && candidateLoaders.length ? candidateLoaders : undefined;
 }
-//# sourceMappingURL=loader-context.js.map

package/dist/lib/loader-utils/loggers.js

@@ -1,49 +1,39 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// probe.gl Log compatible loggers
 import { Log } from '@probe.gl/log';
-export const probeLog = new Log({
-  id: 'loaders.gl'
-});
+export const probeLog = new Log({ id: 'loaders.gl' });
+// Logs nothing
 export class NullLog {
-  log() {
-    return () => {};
-  }
-  info() {
-    return () => {};
-  }
-  warn() {
-    return () => {};
-  }
-  error() {
-    return () => {};
-  }
+    log() {
+        return () => { };
+    }
+    info() {
+        return () => { };
+    }
+    warn() {
+        return () => { };
+    }
+    error() {
+        return () => { };
+    }
 }
+// Logs to console
 export class ConsoleLog {
-  constructor() {
-    this.console = void 0;
-    this.console = console;
-  }
-  log() {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    return this.console.log.bind(this.console, ...args);
-  }
-  info() {
-    for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-      args[_key2] = arguments[_key2];
-    }
-    return this.console.info.bind(this.console, ...args);
-  }
-  warn() {
-    for (var _len3 = arguments.length, args = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
-      args[_key3] = arguments[_key3];
-    }
-    return this.console.warn.bind(this.console, ...args);
-  }
-  error() {
-    for (var _len4 = arguments.length, args = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
-      args[_key4] = arguments[_key4];
-    }
-    return this.console.error.bind(this.console, ...args);
-  }
+    constructor() {
+        this.console = console; // eslint-disable-line
+    }
+    log(...args) {
+        return this.console.log.bind(this.console, ...args);
+    }
+    info(...args) {
+        return this.console.info.bind(this.console, ...args);
+    }
+    warn(...args) {
+        return this.console.warn.bind(this.console, ...args);
+    }
+    error(...args) {
+        return this.console.error.bind(this.console, ...args);
+    }
 }
-//# sourceMappingURL=loggers.js.map

package/dist/lib/loader-utils/normalize-loader.js

@@ -1,37 +1,50 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { assert } from '@loaders.gl/loader-utils';
 export function isLoaderObject(loader) {
-  var _loader;
-  if (!loader) {
-    return false;
-  }
-  if (Array.isArray(loader)) {
-    loader = loader[0];
-  }
-  const hasExtensions = Array.isArray((_loader = loader) === null || _loader === void 0 ? void 0 : _loader.extensions);
-  return hasExtensions;
+    if (!loader) {
+        return false;
+    }
+    if (Array.isArray(loader)) {
+        loader = loader[0];
+    }
+    const hasExtensions = Array.isArray(loader?.extensions);
+    /* Now handled by types and worker loaders do not have these
+    let hasParser =
+      loader.parseTextSync ||
+      loader.parseSync ||
+      loader.parse ||
+      loader.parseStream || // TODO Remove, Replace with parseInBatches
+      loader.parseInBatches;
+    */
+    return hasExtensions;
 }
 export function normalizeLoader(loader) {
-  var _loader2, _loader3;
-  assert(loader, 'null loader');
-  assert(isLoaderObject(loader), 'invalid loader');
-  let options;
-  if (Array.isArray(loader)) {
-    options = loader[1];
-    loader = loader[0];
-    loader = {
-      ...loader,
-      options: {
-        ...loader.options,
-        ...options
-      }
-    };
-  }
-  if ((_loader2 = loader) !== null && _loader2 !== void 0 && _loader2.parseTextSync || (_loader3 = loader) !== null && _loader3 !== void 0 && _loader3.parseText) {
-    loader.text = true;
-  }
-  if (!loader.text) {
-    loader.binary = true;
-  }
-  return loader;
+    // This error is fairly easy to trigger by mixing up import statements etc
+    // So we make an exception and add a developer error message for this case
+    // To help new users from getting stuck here
+    assert(loader, 'null loader');
+    assert(isLoaderObject(loader), 'invalid loader');
+    // NORMALIZE [LOADER, OPTIONS] => LOADER
+    // If [loader, options], create a new loaders object with options merged in
+    let options;
+    if (Array.isArray(loader)) {
+        options = loader[1];
+        loader = loader[0];
+        loader = {
+            ...loader,
+            options: { ...loader.options, ...options }
+        };
+    }
+    // NORMALIZE text and binary flags
+    // Ensure at least one of text/binary flags are properly set
+    // @ts-expect-error
+    if (loader?.parseTextSync || loader?.parseText) {
+        loader.text = true;
+    }
+    if (!loader.text) {
+        loader.binary = true;
+    }
+    return loader;
 }
-//# sourceMappingURL=normalize-loader.js.map

package/dist/lib/loader-utils/option-defaults.js

@@ -1,40 +1,44 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { isBrowser } from '@loaders.gl/loader-utils';
 import { ConsoleLog } from "./loggers.js";
 export const DEFAULT_LOADER_OPTIONS = {
-  fetch: null,
-  mimeType: undefined,
-  nothrow: false,
-  log: new ConsoleLog(),
-  useLocalLibraries: false,
-  CDN: 'https://unpkg.com/@loaders.gl',
-  worker: true,
-  maxConcurrency: 3,
-  maxMobileConcurrency: 1,
-  reuseWorkers: isBrowser,
-  _nodeWorkers: false,
-  _workerType: '',
-  limit: 0,
-  _limitMB: 0,
-  batchSize: 'auto',
-  batchDebounceMs: 0,
-  metadata: false,
-  transforms: []
+    // baseUri
+    fetch: null,
+    mimeType: undefined,
+    nothrow: false,
+    log: new ConsoleLog(), // A probe.gl compatible (`log.log()()` syntax) that just logs to console
+    useLocalLibraries: false,
+    CDN: 'https://unpkg.com/@loaders.gl',
+    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: 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,
+    _limitMB: 0,
+    batchSize: 'auto',
+    batchDebounceMs: 0,
+    metadata: false, // TODO - currently only implemented for parseInBatches, adds initial metadata batch,
+    transforms: []
 };
 export const REMOVED_LOADER_OPTIONS = {
-  throws: 'nothrow',
-  dataType: '(no longer used)',
-  uri: 'baseUri',
-  method: 'fetch.method',
-  headers: 'fetch.headers',
-  body: 'fetch.body',
-  mode: 'fetch.mode',
-  credentials: 'fetch.credentials',
-  cache: 'fetch.cache',
-  redirect: 'fetch.redirect',
-  referrer: 'fetch.referrer',
-  referrerPolicy: 'fetch.referrerPolicy',
-  integrity: 'fetch.integrity',
-  keepalive: 'fetch.keepalive',
-  signal: 'fetch.signal'
+    throws: 'nothrow',
+    dataType: '(no longer used)',
+    uri: 'baseUri',
+    // Warn if fetch options are used on top-level
+    method: 'fetch.method',
+    headers: 'fetch.headers',
+    body: 'fetch.body',
+    mode: 'fetch.mode',
+    credentials: 'fetch.credentials',
+    cache: 'fetch.cache',
+    redirect: 'fetch.redirect',
+    referrer: 'fetch.referrer',
+    referrerPolicy: 'fetch.referrerPolicy',
+    integrity: 'fetch.integrity',
+    keepalive: 'fetch.keepalive',
+    signal: 'fetch.signal'
 };
-//# sourceMappingURL=option-defaults.js.map

package/dist/lib/loader-utils/option-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"option-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/option-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAKpE;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,iBAAiB,CASxD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,aAAa,CAKtD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAK7D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,GAAG,CAAC,EAAE,MAAM,GACX,aAAa,CAMf"}
+{"version":3,"file":"option-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/option-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAKpE;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,iBAAiB,CAWxD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,IAAI,aAAa,CAKtD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAK7D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,GAAG,CAAC,EAAE,MAAM,GACX,aAAa,CAMf"}

package/dist/lib/loader-utils/option-utils.js

@@ -1,106 +1,159 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { isPureObject, isObject } from "../../javascript-utils/is-type.js";
 import { probeLog, NullLog } from "./loggers.js";
 import { DEFAULT_LOADER_OPTIONS, REMOVED_LOADER_OPTIONS } from "./option-defaults.js";
+/**
+ * Helper for safely accessing global loaders.gl variables
+ * Wraps initialization of global variable in function to defeat overly aggressive tree-shakers
+ */
 export function getGlobalLoaderState() {
-  globalThis.loaders = globalThis.loaders || {};
-  const {
-    loaders
-  } = globalThis;
-  loaders._state = loaders._state || {};
-  return loaders._state;
+    // @ts-ignore
+    globalThis.loaders = globalThis.loaders || {};
+    // @ts-ignore
+    const { loaders } = globalThis;
+    // Add _state object to keep separate from modules added to globalThis.loaders
+    if (!loaders._state) {
+        loaders._state = {};
+    }
+    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
+ * @returns global loader options merged with default loader options
+ */
 export function getGlobalLoaderOptions() {
-  const state = getGlobalLoaderState();
-  state.globalOptions = state.globalOptions || {
-    ...DEFAULT_LOADER_OPTIONS
-  };
-  return state.globalOptions;
+    const state = getGlobalLoaderState();
+    // Ensure all default loader options from this library are mentioned
+    state.globalOptions = state.globalOptions || { ...DEFAULT_LOADER_OPTIONS };
+    return state.globalOptions;
 }
+/**
+ * Set global loader options
+ * @param options
+ */
 export function setGlobalOptions(options) {
-  const state = getGlobalLoaderState();
-  const globalOptions = getGlobalLoaderOptions();
-  state.globalOptions = normalizeOptionsInternal(globalOptions, options);
+    const state = getGlobalLoaderState();
+    const globalOptions = getGlobalLoaderOptions();
+    // @ts-expect-error First param looks incorrect
+    state.globalOptions = normalizeOptionsInternal(globalOptions, options);
 }
+/**
+ * Merges options with global opts and loader defaults, also injects baseUri
+ * @param options
+ * @param loader
+ * @param loaders
+ * @param url
+ */
 export function normalizeOptions(options, loader, loaders, url) {
-  loaders = loaders || [];
-  loaders = Array.isArray(loaders) ? loaders : [loaders];
-  validateOptions(options, loaders);
-  return normalizeOptionsInternal(loader, options, url);
+    loaders = loaders || [];
+    loaders = Array.isArray(loaders) ? loaders : [loaders];
+    validateOptions(options, loaders);
+    return normalizeOptionsInternal(loader, options, url);
 }
+// VALIDATE OPTIONS
+/**
+ * Warn for unsupported options
+ * @param options
+ * @param loaders
+ */
 function validateOptions(options, loaders) {
-  validateOptionsObject(options, null, DEFAULT_LOADER_OPTIONS, REMOVED_LOADER_OPTIONS, loaders);
-  for (const loader of loaders) {
-    const idOptions = options && options[loader.id] || {};
-    const loaderOptions = loader.options && loader.options[loader.id] || {};
-    const deprecatedOptions = loader.deprecatedOptions && loader.deprecatedOptions[loader.id] || {};
-    validateOptionsObject(idOptions, loader.id, loaderOptions, deprecatedOptions, loaders);
-  }
+    // Check top level options
+    validateOptionsObject(options, null, DEFAULT_LOADER_OPTIONS, REMOVED_LOADER_OPTIONS, loaders);
+    for (const loader of loaders) {
+        // Get the scoped, loader specific options from the user supplied options
+        const idOptions = ((options && options[loader.id]) || {});
+        // Get scoped, loader specific default and deprecated options from the selected loader
+        const loaderOptions = (loader.options && loader.options[loader.id]) || {};
+        const deprecatedOptions = (loader.deprecatedOptions && loader.deprecatedOptions[loader.id]) || {};
+        // Validate loader specific options
+        // @ts-ignore
+        validateOptionsObject(idOptions, loader.id, loaderOptions, deprecatedOptions, loaders);
+    }
 }
+// eslint-disable-next-line max-params, complexity
 function validateOptionsObject(options, id, defaultOptions, deprecatedOptions, loaders) {
-  const loaderName = id || 'Top level';
-  const prefix = id ? `${id}.` : '';
-  for (const key in options) {
-    const isSubOptions = !id && isObject(options[key]);
-    const isBaseUriOption = key === 'baseUri' && !id;
-    const isWorkerUrlOption = key === 'workerUrl' && id;
-    if (!(key in defaultOptions) && !isBaseUriOption && !isWorkerUrlOption) {
-      if (key in deprecatedOptions) {
-        probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' no longer supported, use \'${deprecatedOptions[key]}\'`)();
-      } else if (!isSubOptions) {
-        const suggestion = findSimilarOption(key, loaders);
-        probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' not recognized. ${suggestion}`)();
-      }
+    const loaderName = id || 'Top level';
+    const prefix = id ? `${id}.` : '';
+    for (const key in options) {
+        // If top level option value is an object it could options for a loader, so ignore
+        const isSubOptions = !id && isObject(options[key]);
+        const isBaseUriOption = key === 'baseUri' && !id;
+        const isWorkerUrlOption = key === 'workerUrl' && id;
+        // <loader>.workerUrl requires special handling as it is now auto-generated and no longer specified as a default option.
+        if (!(key in defaultOptions) && !isBaseUriOption && !isWorkerUrlOption) {
+            // Issue deprecation warnings
+            if (key in deprecatedOptions) {
+                probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' no longer supported, use \'${deprecatedOptions[key]}\'`)();
+            }
+            else if (!isSubOptions) {
+                const suggestion = findSimilarOption(key, loaders);
+                probeLog.warn(`${loaderName} loader option \'${prefix}${key}\' not recognized. ${suggestion}`)();
+            }
+        }
     }
-  }
 }
 function findSimilarOption(optionKey, loaders) {
-  const lowerCaseOptionKey = optionKey.toLowerCase();
-  let bestSuggestion = '';
-  for (const loader of loaders) {
-    for (const key in loader.options) {
-      if (optionKey === key) {
-        return `Did you mean \'${loader.id}.${key}\'?`;
-      }
-      const lowerCaseKey = key.toLowerCase();
-      const isPartialMatch = lowerCaseOptionKey.startsWith(lowerCaseKey) || lowerCaseKey.startsWith(lowerCaseOptionKey);
-      if (isPartialMatch) {
-        bestSuggestion = bestSuggestion || `Did you mean \'${loader.id}.${key}\'?`;
-      }
+    const lowerCaseOptionKey = optionKey.toLowerCase();
+    let bestSuggestion = '';
+    for (const loader of loaders) {
+        for (const key in loader.options) {
+            if (optionKey === key) {
+                return `Did you mean \'${loader.id}.${key}\'?`;
+            }
+            const lowerCaseKey = key.toLowerCase();
+            const isPartialMatch = lowerCaseOptionKey.startsWith(lowerCaseKey) || lowerCaseKey.startsWith(lowerCaseOptionKey);
+            if (isPartialMatch) {
+                bestSuggestion = bestSuggestion || `Did you mean \'${loader.id}.${key}\'?`;
+            }
+        }
     }
-  }
-  return bestSuggestion;
+    return bestSuggestion;
 }
 function normalizeOptionsInternal(loader, options, url) {
-  const loaderDefaultOptions = loader.options || {};
-  const mergedOptions = {
-    ...loaderDefaultOptions
-  };
-  addUrlOptions(mergedOptions, url);
-  if (mergedOptions.log === null) {
-    mergedOptions.log = new NullLog();
-  }
-  mergeNestedFields(mergedOptions, getGlobalLoaderOptions());
-  mergeNestedFields(mergedOptions, options);
-  return mergedOptions;
+    const loaderDefaultOptions = loader.options || {};
+    const mergedOptions = { ...loaderDefaultOptions };
+    addUrlOptions(mergedOptions, url);
+    // LOGGING: options.log can be set to `null` to defeat logging
+    if (mergedOptions.log === null) {
+        mergedOptions.log = new NullLog();
+    }
+    mergeNestedFields(mergedOptions, getGlobalLoaderOptions());
+    mergeNestedFields(mergedOptions, options);
+    return mergedOptions;
 }
+// Merge nested options objects
 function mergeNestedFields(mergedOptions, options) {
-  for (const key in options) {
-    if (key in options) {
-      const value = options[key];
-      if (isPureObject(value) && isPureObject(mergedOptions[key])) {
-        mergedOptions[key] = {
-          ...mergedOptions[key],
-          ...options[key]
-        };
-      } else {
-        mergedOptions[key] = options[key];
-      }
+    for (const key in options) {
+        // Check for nested options
+        // object in options => either no key in defaultOptions or object in defaultOptions
+        if (key in options) {
+            const value = options[key];
+            if (isPureObject(value) && isPureObject(mergedOptions[key])) {
+                mergedOptions[key] = {
+                    ...mergedOptions[key],
+                    ...options[key]
+                };
+            }
+            else {
+                mergedOptions[key] = options[key];
+            }
+        }
+        // else: No need to merge nested opts, and the initial merge already copied over the nested options
     }
-  }
 }
+/**
+ * Harvest information from the url
+ * @deprecated This is mainly there to support a hack in the GLTFLoader
+ * TODO - baseUri should be a directory, i.e. remove file component from baseUri
+ * TODO - extract extension?
+ * TODO - extract query parameters?
+ * TODO - should these be injected on context instead of options?
+ */
 function addUrlOptions(options, url) {
-  if (url && !('baseUri' in options)) {
-    options.baseUri = url;
-  }
+    if (url && !('baseUri' in options)) {
+        options.baseUri = url;
+    }
 }
-//# sourceMappingURL=option-utils.js.map