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

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;