@loaders.gl/core 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/lib/loader-utils/get-data.js

@@ -1,129 +1,129 @@
-import { concatenateArrayBuffersAsync } from '@loaders.gl/loader-utils';
-import { isResponse, isReadableStream, isAsyncIterable, isIterable, isIterator, isBlob, isBuffer } from '../../javascript-utils/is-type';
-import { makeIterator } from '../../iterators/make-iterator/make-iterator';
-import { checkResponse, makeResponse } from '../utils/response-utils';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReadableStream = exports.getAsyncIterableFromData = exports.getArrayBufferOrStringFromData = exports.getArrayBufferOrStringFromDataSync = void 0;
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const is_type_1 = require("../../javascript-utils/is-type");
+const make_iterator_1 = require("../../iterators/make-iterator/make-iterator");
+const response_utils_1 = require("../utils/response-utils");
 const ERR_DATA = 'Cannot convert supplied data type';
-export function getArrayBufferOrStringFromDataSync(data, loader, options) {
-  if (loader.text && typeof data === 'string') {
-    return data;
-  }
-
-  if (isBuffer(data)) {
-    data = data.buffer;
-  }
-
-  if (data instanceof ArrayBuffer) {
-    const arrayBuffer = data;
-
-    if (loader.text && !loader.binary) {
-      const textDecoder = new TextDecoder('utf8');
-      return textDecoder.decode(arrayBuffer);
-    }
-
-    return arrayBuffer;
-  }
-
-  if (ArrayBuffer.isView(data)) {
-    if (loader.text && !loader.binary) {
-      const textDecoder = new TextDecoder('utf8');
-      return textDecoder.decode(data);
-    }
-
-    let arrayBuffer = data.buffer;
-    const byteLength = data.byteLength || data.length;
-
-    if (data.byteOffset !== 0 || byteLength !== arrayBuffer.byteLength) {
-      arrayBuffer = arrayBuffer.slice(data.byteOffset, data.byteOffset + byteLength);
-    }
-
-    return arrayBuffer;
-  }
-
-  throw new Error(ERR_DATA);
+// eslint-disable-next-line complexity
+function getArrayBufferOrStringFromDataSync(data, loader, options) {
+    if (loader.text && typeof data === 'string') {
+        return data;
+    }
+    if ((0, is_type_1.isBuffer)(data)) {
+        // @ts-ignore
+        data = data.buffer;
+    }
+    if (data instanceof ArrayBuffer) {
+        const arrayBuffer = data;
+        if (loader.text && !loader.binary) {
+            const textDecoder = new TextDecoder('utf8');
+            return textDecoder.decode(arrayBuffer);
+        }
+        return arrayBuffer;
+    }
+    // We may need to handle offsets
+    if (ArrayBuffer.isView(data)) {
+        // TextDecoder is invoked on typed arrays and will handle offsets
+        if (loader.text && !loader.binary) {
+            const textDecoder = new TextDecoder('utf8');
+            return textDecoder.decode(data);
+        }
+        let arrayBuffer = data.buffer;
+        // Since we are returning the underlying arrayBuffer, we must create a new copy
+        // if this typed array / Buffer is a partial view into the ArryayBuffer
+        // TODO - this is a potentially unnecessary copy
+        const byteLength = data.byteLength || data.length;
+        if (data.byteOffset !== 0 || byteLength !== arrayBuffer.byteLength) {
+            // console.warn(`loaders.gl copying arraybuffer of length ${byteLength}`);
+            arrayBuffer = arrayBuffer.slice(data.byteOffset, data.byteOffset + byteLength);
+        }
+        return arrayBuffer;
+    }
+    throw new Error(ERR_DATA);
 }
-export async function getArrayBufferOrStringFromData(data, loader, options) {
-  const isArrayBuffer = data instanceof ArrayBuffer || ArrayBuffer.isView(data);
-
-  if (typeof data === 'string' || isArrayBuffer) {
-    return getArrayBufferOrStringFromDataSync(data, loader, options);
-  }
-
-  if (isBlob(data)) {
-    data = await makeResponse(data);
-  }
-
-  if (isResponse(data)) {
-    const response = data;
-    await checkResponse(response);
-    return loader.binary ? await response.arrayBuffer() : await response.text();
-  }
-
-  if (isReadableStream(data)) {
-    data = makeIterator(data, options);
-  }
-
-  if (isIterable(data) || isAsyncIterable(data)) {
-    return concatenateArrayBuffersAsync(data);
-  }
-
-  throw new Error(ERR_DATA);
+exports.getArrayBufferOrStringFromDataSync = getArrayBufferOrStringFromDataSync;
+// Convert async iterator to a promise
+async function getArrayBufferOrStringFromData(data, loader, options) {
+    const isArrayBuffer = data instanceof ArrayBuffer || ArrayBuffer.isView(data);
+    if (typeof data === 'string' || isArrayBuffer) {
+        return getArrayBufferOrStringFromDataSync(data, loader, options);
+    }
+    // Blobs and files are FileReader compatible
+    if ((0, is_type_1.isBlob)(data)) {
+        data = await (0, response_utils_1.makeResponse)(data);
+    }
+    if ((0, is_type_1.isResponse)(data)) {
+        const response = data;
+        await (0, response_utils_1.checkResponse)(response);
+        return loader.binary ? await response.arrayBuffer() : await response.text();
+    }
+    if ((0, is_type_1.isReadableStream)(data)) {
+        // @ts-expect-error TS2559 options type
+        data = (0, make_iterator_1.makeIterator)(data, options);
+    }
+    if ((0, is_type_1.isIterable)(data) || (0, is_type_1.isAsyncIterable)(data)) {
+        // Assume arrayBuffer iterator - attempt to concatenate
+        return (0, loader_utils_1.concatenateArrayBuffersAsync)(data);
+    }
+    throw new Error(ERR_DATA);
 }
-export async function getAsyncIterableFromData(data, options) {
-  if (isIterator(data)) {
-    return data;
-  }
-
-  if (isResponse(data)) {
-    const response = data;
-    await checkResponse(response);
-    const body = await response.body;
-    return makeIterator(body, options);
-  }
-
-  if (isBlob(data) || isReadableStream(data)) {
-    return makeIterator(data, options);
-  }
-
-  if (isAsyncIterable(data)) {
-    return data[Symbol.asyncIterator]();
-  }
-
-  return getIterableFromData(data);
+exports.getArrayBufferOrStringFromData = getArrayBufferOrStringFromData;
+async function getAsyncIterableFromData(data, options) {
+    if ((0, is_type_1.isIterator)(data)) {
+        return data;
+    }
+    if ((0, is_type_1.isResponse)(data)) {
+        const response = data;
+        // Note Since this function is not async, we currently can't load error message, just status
+        await (0, response_utils_1.checkResponse)(response);
+        // TODO - bug in polyfill, body can be a Promise under Node.js
+        // eslint-disable-next-line @typescript-eslint/await-thenable
+        const body = await response.body;
+        // TODO - body can be null?
+        return (0, make_iterator_1.makeIterator)(body, options);
+    }
+    if ((0, is_type_1.isBlob)(data) || (0, is_type_1.isReadableStream)(data)) {
+        return (0, make_iterator_1.makeIterator)(data, options);
+    }
+    if ((0, is_type_1.isAsyncIterable)(data)) {
+        return data[Symbol.asyncIterator]();
+    }
+    return getIterableFromData(data);
 }
-export async function getReadableStream(data) {
-  if (isReadableStream(data)) {
-    return data;
-  }
-
-  if (isResponse(data)) {
-    return data.body;
-  }
-
-  const response = await makeResponse(data);
-  return response.body;
+exports.getAsyncIterableFromData = getAsyncIterableFromData;
+async function getReadableStream(data) {
+    if ((0, is_type_1.isReadableStream)(data)) {
+        return data;
+    }
+    if ((0, is_type_1.isResponse)(data)) {
+        // @ts-ignore
+        return data.body;
+    }
+    const response = await (0, response_utils_1.makeResponse)(data);
+    // @ts-ignore
+    return response.body;
 }
-
+exports.getReadableStream = getReadableStream;
+// HELPERS
 function getIterableFromData(data) {
-  if (ArrayBuffer.isView(data)) {
-    return function* oneChunk() {
-      yield data.buffer;
-    }();
-  }
-
-  if (data instanceof ArrayBuffer) {
-    return function* oneChunk() {
-      yield data;
-    }();
-  }
-
-  if (isIterator(data)) {
-    return data;
-  }
-
-  if (isIterable(data)) {
-    return data[Symbol.iterator]();
-  }
-
-  throw new Error(ERR_DATA);
+    // generate an iterator that emits a single chunk
+    if (ArrayBuffer.isView(data)) {
+        return (function* oneChunk() {
+            yield data.buffer;
+        })();
+    }
+    if (data instanceof ArrayBuffer) {
+        return (function* oneChunk() {
+            yield data;
+        })();
+    }
+    if ((0, is_type_1.isIterator)(data)) {
+        return data;
+    }
+    if ((0, is_type_1.isIterable)(data)) {
+        return data[Symbol.iterator]();
+    }
+    throw new Error(ERR_DATA);
 }
-//# sourceMappingURL=get-data.js.map

package/dist/lib/loader-utils/get-fetch-function.d.ts

@@ -0,0 +1,9 @@
+import type { LoaderContext, LoaderOptions } from '@loaders.gl/loader-utils';
+import { fetchFile } from '../fetch/fetch-file';
+/**
+ * Gets the current fetch function from options and context
+ * @param options
+ * @param context
+ */
+export declare function getFetchFunction(options?: LoaderOptions, context?: Omit<LoaderContext, 'fetch'> & Partial<Pick<LoaderContext, 'fetch'>>): ((url: string, options?: RequestInit | undefined) => Promise<Response>) | typeof fetchFile;
+//# sourceMappingURL=get-fetch-function.d.ts.map

package/dist/lib/loader-utils/get-fetch-function.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-fetch-function.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/get-fetch-function.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,aAAa,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAE3E,OAAO,EAAC,SAAS,EAAC,MAAM,qBAAqB,CAAC;AAG9C;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,CAAC,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,8FAuB/E"}

package/dist/lib/loader-utils/get-fetch-function.js

@@ -0,0 +1,31 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetchFunction = void 0;
+const is_type_1 = require("../../javascript-utils/is-type");
+const fetch_file_1 = require("../fetch/fetch-file");
+const option_utils_1 = require("./option-utils");
+/**
+ * Gets the current fetch function from options and context
+ * @param options
+ * @param context
+ */
+function getFetchFunction(options, context) {
+    const globalOptions = (0, option_utils_1.getGlobalLoaderOptions)();
+    const fetchOptions = options || globalOptions;
+    // options.fetch can be a function
+    if (typeof fetchOptions.fetch === 'function') {
+        return fetchOptions.fetch;
+    }
+    // options.fetch can be an options object
+    if ((0, is_type_1.isObject)(fetchOptions.fetch)) {
+        return (url) => (0, fetch_file_1.fetchFile)(url, fetchOptions);
+    }
+    // else refer to context (from parent loader) if available
+    if (context?.fetch) {
+        return context?.fetch;
+    }
+    // else return the default fetch function
+    return fetch_file_1.fetchFile;
+}
+exports.getFetchFunction = getFetchFunction;

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

@@ -1,36 +1,49 @@
-import { getFetchFunction } from './option-utils';
-export function getLoaderContext(context, options, previousContext = null) {
-  if (previousContext) {
-    return previousContext;
-  }
-
-  const resolvedContext = {
-    fetch: getFetchFunction(options, context),
-    ...context
-  };
-
-  if (!Array.isArray(resolvedContext.loaders)) {
-    resolvedContext.loaders = null;
-  }
-
-  return resolvedContext;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLoadersFromContext = exports.getLoaderContext = void 0;
+const get_fetch_function_1 = require("./get-fetch-function");
+/**
+ * "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
+ */
+function getLoaderContext(context, options, previousContext = null) {
+    // For recursive calls, we already have a context
+    // TODO - add any additional loaders to context?
+    if (previousContext) {
+        return previousContext;
+    }
+    const resolvedContext = {
+        fetch: (0, get_fetch_function_1.getFetchFunction)(options, context),
+        ...context
+    };
+    // Recursive loading does not use single loader
+    if (!Array.isArray(resolvedContext.loaders)) {
+        resolvedContext.loaders = null;
+    }
+    return resolvedContext;
 }
-export function getLoadersFromContext(loaders, context) {
-  if (!context && 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 : null;
+exports.getLoaderContext = getLoaderContext;
+// eslint-disable-next-line complexity
+function getLoadersFromContext(loaders, context) {
+    // A single non-array loader is force selected, but only on top-level (context === null)
+    if (!context && 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 : null;
 }
-//# sourceMappingURL=loader-context.js.map
+exports.getLoadersFromContext = getLoadersFromContext;

package/dist/lib/loader-utils/loggers.d.ts

@@ -1,4 +1,5 @@
-export declare const probeLog: any;
+import { Log } from '@probe.gl/log';
+export declare const probeLog: Log;
 export declare class NullLog {
     log(): () => void;
     info(): () => void;

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

@@ -1 +1 @@
-{"version":3,"file":"loggers.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/loggers.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,QAAQ,KAA8B,CAAC;AAGpD,qBAAa,OAAO;IAClB,GAAG;IAGH,IAAI;IAGJ,IAAI;IAGJ,KAAK;CAGN;AAGD,qBAAa,UAAU;IACrB,OAAO,MAAC;;IAKR,GAAG,CAAC,GAAG,IAAI,OAAA;IAGX,IAAI,CAAC,GAAG,IAAI,OAAA;IAGZ,IAAI,CAAC,GAAG,IAAI,OAAA;IAGZ,KAAK,CAAC,GAAG,IAAI,OAAA;CAGd"}
+{"version":3,"file":"loggers.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/loggers.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,GAAG,EAAC,MAAM,eAAe,CAAC;AAElC,eAAO,MAAM,QAAQ,KAA8B,CAAC;AAGpD,qBAAa,OAAO;IAClB,GAAG;IAGH,IAAI;IAGJ,IAAI;IAGJ,KAAK;CAGN;AAGD,qBAAa,UAAU;IACrB,OAAO,MAAC;;IAKR,GAAG,CAAC,GAAG,IAAI,OAAA;IAGX,IAAI,CAAC,GAAG,IAAI,OAAA;IAGZ,IAAI,CAAC,GAAG,IAAI,OAAA;IAGZ,KAAK,CAAC,GAAG,IAAI,OAAA;CAGd"}

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

@@ -1,48 +1,41 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { Log } from 'probe.gl';
-export const probeLog = new Log({
-  id: 'loaders.gl'
-});
-export class NullLog {
-  log() {
-    return () => {};
-  }
-
-  info() {
-    return () => {};
-  }
-
-  warn() {
-    return () => {};
-  }
-
-  error() {
-    return () => {};
-  }
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsoleLog = exports.NullLog = exports.probeLog = void 0;
+// probe.gl Log compatible loggers
+const log_1 = require("@probe.gl/log");
+exports.probeLog = new log_1.Log({ id: 'loaders.gl' });
+// Logs nothing
+class NullLog {
+    log() {
+        return () => { };
+    }
+    info() {
+        return () => { };
+    }
+    warn() {
+        return () => { };
+    }
+    error() {
+        return () => { };
+    }
 }
-export class ConsoleLog {
-  constructor() {
-    _defineProperty(this, "console", void 0);
-
-    this.console = console;
-  }
-
-  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);
-  }
-
+exports.NullLog = NullLog;
+// Logs to console
+class ConsoleLog {
+    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
+exports.ConsoleLog = ConsoleLog;

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

@@ -1,43 +1,52 @@
-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;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeLoader = exports.isLoaderObject = void 0;
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+function isLoaderObject(loader) {
+    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;
+exports.isLoaderObject = isLoaderObject;
+function normalizeLoader(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
+    (0, loader_utils_1.assert)(loader, 'null loader');
+    (0, loader_utils_1.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
+exports.normalizeLoader = normalizeLoader;

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

@@ -1 +1 @@
-{"version":3,"file":"option-defaults.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/option-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAG5D,eAAO,MAAM,sBAAsB,EAAE,aAoBpC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;CAiBlC,CAAC"}
+{"version":3,"file":"option-defaults.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/option-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAI5D,eAAO,MAAM,sBAAsB,EAAE,aAqBpC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;CAiBlC,CAAC"}