@loaders.gl/core 3.4.0-alpha.1 → 3.4.0-alpha.3

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLoadersFromContext = exports.getLoaderContext = void 0;
-const option_utils_1 = require("./option-utils");
+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
@@ -18,7 +18,7 @@ function getLoaderContext(context, options, previousContext = null) {
         return previousContext;
     }
     const resolvedContext = {
-        fetch: (0, option_utils_1.getFetchFunction)(options, context),
+        fetch: (0, get_fetch_function_1.getFetchFunction)(options, context),
         ...context
     };
     // Recursive loading does not use single loader

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

@@ -1,12 +1,10 @@
-import type { Loader, LoaderContext, LoaderOptions } from '@loaders.gl/loader-utils';
+import type { Loader, LoaderOptions } from '@loaders.gl/loader-utils';
 /**
  * Global state for loaders.gl. Stored on `global.loaders._state`
  */
 type GlobalLoaderState = {
     loaderRegistry: Loader[];
-    globalOptions: {
-        [key: string]: any;
-    };
+    globalOptions: LoaderOptions;
 };
 /**
  * Helper for safely accessing global loaders.gl variables
@@ -18,14 +16,12 @@ export declare function getGlobalLoaderState(): GlobalLoaderState;
  * 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 declare const getGlobalLoaderOptions: () => {
-    [key: string]: any;
-};
+export declare const getGlobalLoaderOptions: () => LoaderOptions;
 /**
  * Set global loader options
  * @param options
  */
-export declare function setGlobalOptions(options: object): void;
+export declare function setGlobalOptions(options: LoaderOptions): void;
 /**
  * Merges options with global opts and loader defaults, also injects baseUri
  * @param options
@@ -33,12 +29,6 @@ export declare function setGlobalOptions(options: object): void;
  * @param loaders
  * @param url
  */
-export declare function normalizeOptions(options: object, loader: Loader, loaders?: Loader[], url?: string): object;
-/**
- * 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'>>): any;
+export declare function normalizeOptions(options: LoaderOptions, loader: Loader, loaders?: Loader[], url?: string): LoaderOptions;
 export {};
 //# sourceMappingURL=option-utils.d.ts.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":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAKnF;;GAEG;AACH,KAAK,iBAAiB,GAAG;IACvB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAAC;CACrC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,oBAAoB,IAAI,iBAAiB,CASxD;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB;;CAKlC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAItD;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,GAAG,CAAC,EAAE,MAAM,GACX,MAAM,CAMR;AAED;;;;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,OAuB/E"}
+{"version":3,"file":"option-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/loader-utils/option-utils.ts"],"names":[],"mappings":"AAEA,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,eAAO,MAAM,sBAAsB,QAAO,aAKzC,CAAC;AAEF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAI7D;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,8 +1,8 @@
 "use strict";
+// loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFetchFunction = exports.normalizeOptions = exports.setGlobalOptions = exports.getGlobalLoaderOptions = exports.getGlobalLoaderState = void 0;
+exports.normalizeOptions = exports.setGlobalOptions = exports.getGlobalLoaderOptions = exports.getGlobalLoaderState = void 0;
 const is_type_1 = require("../../javascript-utils/is-type");
-const fetch_file_1 = require("../fetch/fetch-file");
 const loggers_1 = require("./loggers");
 const option_defaults_1 = require("./option-defaults");
 /**
@@ -55,30 +55,6 @@ function normalizeOptions(options, loader, loaders, url) {
     return normalizeOptionsInternal(loader, options, url);
 }
 exports.normalizeOptions = normalizeOptions;
-/**
- * Gets the current fetch function from options and context
- * @param options
- * @param context
- */
-function getFetchFunction(options, context) {
-    const globalOptions = (0, exports.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;
 // VALIDATE OPTIONS
 /**
  * Warn for unsupported options
@@ -169,11 +145,14 @@ function mergeNestedFields(mergedOptions, options) {
         // else: No need to merge nested opts, and the initial merge already copied over the nested options
     }
 }
-// Harvest information from the url
-// 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?
+/**
+ * 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;

package/dist/lib/progress/fetch-progress.js

@@ -17,8 +17,8 @@ onDone = () => { }, onError = () => { }) {
         return response;
     }
     const contentLength = response.headers.get('content-length') || 0;
-    const totalBytes = contentLength && parseInt(contentLength);
-    if (!(contentLength > 0)) {
+    const totalBytes = contentLength ? parseInt(contentLength) : 0;
+    if (!(totalBytes > 0)) {
         return response;
     }
     // Currently override only implemented in browser

package/dist/null-worker.js

@@ -184,7 +184,7 @@
   }
 
   // src/null-loader.ts
-  var VERSION = true ? "3.4.0-alpha.1" : "latest";
+  var VERSION = true ? "3.4.0-alpha.3" : "latest";
   function parseSync(arrayBuffer, options, context) {
     if (!options.null.echoParameters)
       return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/core",
-  "version": "3.4.0-alpha.1",
+  "version": "3.4.0-alpha.3",
   "description": "The core API for working with loaders.gl loaders and writers",
   "license": "MIT",
   "publishConfig": {
@@ -42,9 +42,9 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/loader-utils": "3.4.0-alpha.1",
-    "@loaders.gl/worker-utils": "3.4.0-alpha.1",
-    "@probe.gl/log": "^3.5.0"
+    "@loaders.gl/loader-utils": "3.4.0-alpha.3",
+    "@loaders.gl/worker-utils": "3.4.0-alpha.3",
+    "@probe.gl/log": "^4.0.1"
   },
-  "gitHead": "4085b0323050e4361614471319a1fb4729547bbf"
+  "gitHead": "a954528dd1d78a1f128d8f6b07e4baeb7a296924"
 }

package/src/iterators/make-stream/make-node-stream.ts

@@ -1,4 +1,10 @@
-import {Readable, ReadableOptions} from 'stream';
+import type {ReadableOptions} from 'stream';
+import * as Stream from 'stream';
+
+class _Readable {}
+
+type ReadableType = Stream.Readable | _Readable;
+const Readable = Stream.Readable || _Readable;
 
 export type MakeStreamOptions = ReadableOptions;
 
@@ -6,7 +12,7 @@ export type MakeStreamOptions = ReadableOptions;
 export function makeStream<ArrayBuffer>(
   source: Iterable<ArrayBuffer> | AsyncIterable<ArrayBuffer>,
   options?: ReadableOptions
-): Readable {
+): ReadableType {
   const iterator = source[Symbol.asyncIterator]
     ? source[Symbol.asyncIterator]()
     : source[Symbol.iterator]();

package/src/lib/api/encode.ts

@@ -1,4 +1,4 @@
-import {Writer, LoaderOptions, canEncodeWithWorker} from '@loaders.gl/loader-utils';
+import {Writer, WriterOptions, 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';
@@ -12,9 +12,10 @@ import {getLoaderOptions} from './loader-options';
 export async function encode(
   data: any,
   writer: Writer,
-  options?: LoaderOptions
+  options?: WriterOptions
 ): Promise<ArrayBuffer> {
-  const globalOptions = getLoaderOptions();
+  const globalOptions = getLoaderOptions() as WriterOptions;
+  // const globalOptions: WriterOptions = {}; // getWriterOptions();
   options = {...globalOptions, ...options};
   if (canEncodeWithWorker(writer, options)) {
     return await processOnWorker(writer, data, options);
@@ -71,7 +72,7 @@ export async function encode(
 /**
  * Encode loaded data into a binary ArrayBuffer using the specified Writer.
  */
-export function encodeSync(data: any, writer: Writer, options?: LoaderOptions): ArrayBuffer {
+export function encodeSync(data: any, writer: Writer, options?: WriterOptions): ArrayBuffer {
   if (writer.encodeSync) {
     return writer.encodeSync(data, options);
   }
@@ -87,7 +88,7 @@ export function encodeSync(data: any, writer: Writer, options?: LoaderOptions):
 export async function encodeText(
   data: any,
   writer: Writer,
-  options?: LoaderOptions
+  options?: WriterOptions
 ): Promise<string> {
   if (writer.text && writer.encodeText) {
     return await writer.encodeText(data, options);
@@ -107,7 +108,7 @@ export async function encodeText(
 export function encodeInBatches(
   data: any,
   writer: Writer,
-  options?: LoaderOptions
+  options?: WriterOptions
 ): AsyncIterable<ArrayBuffer> {
   if (writer.encodeInBatches) {
     const dataIterator = getIterator(data);

package/src/lib/api/load-in-batches.ts

@@ -1,6 +1,6 @@
 import type {LoaderWithParser, LoaderOptions, LoaderContext} from '@loaders.gl/loader-utils';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
-import {getFetchFunction} from '../loader-utils/option-utils';
+import {getFetchFunction} from '../loader-utils/get-fetch-function';
 
 import {parseInBatches} from './parse-in-batches';
 

package/src/lib/api/load.ts

@@ -1,7 +1,7 @@
 import type {DataType, Loader, LoaderContext, LoaderOptions} from '@loaders.gl/loader-utils';
 import {isBlob} from '../../javascript-utils/is-type';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
-import {getFetchFunction} from '../loader-utils/option-utils';
+import {getFetchFunction} from '../loader-utils/get-fetch-function';
 
 import {parse} from './parse';
 
@@ -41,9 +41,10 @@ export async function load(
 
   if (isBlob(url)) {
     // The fetch response object will contain blob.name
+    // @ts-expect-error TODO - This may not work for overridden fetch functions
     data = await fetch(url);
   }
 
   // Data is loaded (at least we have a `Response` object) so time to hand over to `parse`
-  return await parse(data, loaders, options);
+  return await parse(data, loaders as Loader[], options);
 }

package/src/lib/loader-utils/get-fetch-function.ts

@@ -0,0 +1,38 @@
+// loaders.gl, MIT license
+
+import type {LoaderContext, LoaderOptions} from '@loaders.gl/loader-utils';
+import {isObject} from '../../javascript-utils/is-type';
+import {fetchFile} from '../fetch/fetch-file';
+import {getGlobalLoaderOptions} from './option-utils';
+
+/**
+ * Gets the current fetch function from options and context
+ * @param options
+ * @param context
+ */
+export function getFetchFunction(
+  options?: LoaderOptions,
+  context?: Omit<LoaderContext, 'fetch'> & Partial<Pick<LoaderContext, 'fetch'>>
+) {
+  const globalOptions = 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 (isObject(fetchOptions.fetch)) {
+    return (url) => fetchFile(url, fetchOptions as RequestInit);
+  }
+
+  // else refer to context (from parent loader) if available
+  if (context?.fetch) {
+    return context?.fetch;
+  }
+
+  // else return the default fetch function
+  return fetchFile;
+}

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

@@ -1,5 +1,5 @@
 import type {Loader, LoaderOptions, LoaderContext} from '@loaders.gl/loader-utils';
-import {getFetchFunction} from './option-utils';
+import {getFetchFunction} from './get-fetch-function';
 
 /**
  * "sub" loaders invoked by other loaders get a "context" injected on `this`

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

@@ -1,14 +1,16 @@
-import type {Loader, LoaderContext, LoaderOptions} from '@loaders.gl/loader-utils';
+// loaders.gl, MIT license
+
+import type {Loader, LoaderOptions} from '@loaders.gl/loader-utils';
 import {isPureObject, isObject} from '../../javascript-utils/is-type';
-import {fetchFile} from '../fetch/fetch-file';
 import {probeLog, NullLog} from './loggers';
 import {DEFAULT_LOADER_OPTIONS, REMOVED_LOADER_OPTIONS} from './option-defaults';
+
 /**
  * Global state for loaders.gl. Stored on `global.loaders._state`
  */
 type GlobalLoaderState = {
   loaderRegistry: Loader[];
-  globalOptions: {[key: string]: any};
+  globalOptions: LoaderOptions;
 };
 
 /**
@@ -31,7 +33,7 @@ export function getGlobalLoaderState(): GlobalLoaderState {
  * 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 = () => {
+export const getGlobalLoaderOptions = (): LoaderOptions => {
   const state = getGlobalLoaderState();
   // Ensure all default loader options from this library are mentioned
   state.globalOptions = state.globalOptions || {...DEFAULT_LOADER_OPTIONS};
@@ -42,7 +44,7 @@ export const getGlobalLoaderOptions = () => {
  * Set global loader options
  * @param options
  */
-export function setGlobalOptions(options: object): void {
+export function setGlobalOptions(options: LoaderOptions): void {
   const state = getGlobalLoaderState();
   const globalOptions = getGlobalLoaderOptions();
   state.globalOptions = normalizeOptionsInternal(globalOptions, options);
@@ -56,11 +58,11 @@ export function setGlobalOptions(options: object): void {
  * @param url
  */
 export function normalizeOptions(
-  options: object,
+  options: LoaderOptions,
   loader: Loader,
   loaders?: Loader[],
   url?: string
-): object {
+): LoaderOptions {
   loaders = loaders || [];
   loaders = Array.isArray(loaders) ? loaders : [loaders];
 
@@ -68,38 +70,6 @@ export function normalizeOptions(
   return normalizeOptionsInternal(loader, options, url);
 }
 
-/**
- * Gets the current fetch function from options and context
- * @param options
- * @param context
- */
-export function getFetchFunction(
-  options?: LoaderOptions,
-  context?: Omit<LoaderContext, 'fetch'> & Partial<Pick<LoaderContext, 'fetch'>>
-) {
-  const globalOptions = 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 (isObject(fetchOptions.fetch)) {
-    return (url) => 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 fetchFile;
-}
-
 // VALIDATE OPTIONS
 
 /**
@@ -214,11 +184,14 @@ function mergeNestedFields(mergedOptions, options) {
   }
 }
 
-// Harvest information from the url
-// 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?
+/**
+ * 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?: string) {
   if (url && !('baseUri' in options)) {
     options.baseUri = url;

package/src/lib/progress/fetch-progress.ts

@@ -20,8 +20,8 @@ export default async function fetchProgress(
     return response;
   }
   const contentLength = response.headers.get('content-length') || 0;
-  const totalBytes = contentLength && parseInt(contentLength);
-  if (!(contentLength > 0)) {
+  const totalBytes = contentLength ? parseInt(contentLength) : 0;
+  if (!(totalBytes > 0)) {
     return response;
   }
   // Currently override only implemented in browser