@loaders.gl/core 5.0.0-alpha.1 → 5.0.0-alpha.11

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

@@ -3,7 +3,7 @@
 // Copyright (c) vis.gl contributors
 
 import type {LoaderContext, LoaderOptions, FetchLike} from '@loaders.gl/loader-utils';
-import {isObject} from '@loaders.gl/loader-utils';
+import {createAuthenticatedFetch, isObject} from '@loaders.gl/loader-utils';
 import {fetchFile} from '../fetch/fetch-file';
 import {getGlobalLoaderOptions} from './option-utils';
 
@@ -21,22 +21,23 @@ export function getFetchFunction(
 
   const loaderOptions = options || globalOptions;
   const fetchOption = loaderOptions.fetch ?? loaderOptions.core?.fetch;
+  let fetchFunction: FetchLike;
 
   // options.fetch can be a function
   if (typeof fetchOption === 'function') {
-    return fetchOption;
+    fetchFunction = fetchOption;
+  } else if (isObject(fetchOption)) {
+    fetchFunction = context?.fetch || fetchFile;
+  } else if (context?.fetch) {
+    fetchFunction = context.fetch;
+  } else {
+    fetchFunction = fetchFile;
   }
 
-  // options.fetch can be an options object
-  if (isObject(fetchOption)) {
-    return url => fetchFile(url, fetchOption 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;
+  return createAuthenticatedFetch({
+    fetch: fetchFunction,
+    credentials: loaderOptions.core?.credentials || [],
+    authentications: loaderOptions.core?.authentications,
+    fetchOptions: isObject(fetchOption) ? (fetchOption as RequestInit) : undefined
+  });
 }

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

@@ -19,17 +19,22 @@ type LoaderContextProps = Omit<LoaderContext, 'fetch' | 'coreApi'> &
  *
  * @param context
  * @param options
- * @param previousContext
+ * @param parentContext
  */
 export function getLoaderContext(
   context: LoaderContextProps,
   options: StrictLoaderOptions,
   parentContext: LoaderContext | null
 ): LoaderContext {
-  // For recursive calls, we already have a context
+  // For recursive calls, preserve the context while applying this loader's options
   // TODO - add any additional loaders to context?
   if (parentContext) {
-    return parentContext;
+    return {
+      ...parentContext,
+      coreApi: parentContext.coreApi || context.coreApi || coreApi,
+      _parse: parentContext._parse || context._parse,
+      fetch: getFetchFunction(options, parentContext)
+    };
   }
 
   const newContext: LoaderContext = {

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

@@ -7,6 +7,7 @@ import {isBrowser} from '@loaders.gl/loader-utils';
 import {ConsoleLog} from './loggers';
 
 export const DEFAULT_LOADER_OPTIONS: LoaderOptions = {
+  searchParams: undefined,
   core: {
     baseUrl: undefined,
     // baseUrl
@@ -18,9 +19,11 @@ export const DEFAULT_LOADER_OPTIONS: LoaderOptions = {
     shape: undefined,
     log: new ConsoleLog(), // A probe.gl compatible (`log.log()()` syntax) that just logs to console
     useLocalLibraries: false,
+    subloaders: undefined,
 
     CDN: 'https://unpkg.com/@loaders.gl',
     worker: true, // By default, use worker if provided by loader.
+    workerThreshold: 0.1,
     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)

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

@@ -26,6 +26,7 @@ const CORE_LOADER_OPTION_KEYS = [
   'useLocalLibraries',
   'CDN',
   'worker',
+  'workerThreshold',
   'maxConcurrency',
   'maxMobileConcurrency',
   'reuseWorkers',
@@ -41,6 +42,40 @@ const CORE_LOADER_OPTION_KEYS = [
   'transforms'
 ] as const;
 
+/**
+ * Appends loader search parameters to a URL while preserving existing parameters and fragments.
+ * @param url URL to update
+ * @param options Loader options containing optional search parameters
+ * @returns URL with the configured parameters appended
+ */
+export function applySearchParamsToUrl(url: string, options?: LoaderOptions): string {
+  const searchParams = options?.searchParams;
+  if (!searchParams || Object.keys(searchParams).length === 0 || /^(?:data|blob):/i.test(url)) {
+    return url;
+  }
+
+  const hashIndex = url.indexOf('#');
+  const hash = hashIndex >= 0 ? url.slice(hashIndex) : '';
+  const urlWithoutHash = hashIndex >= 0 ? url.slice(0, hashIndex) : url;
+  const queryIndex = urlWithoutHash.indexOf('?');
+  const path = queryIndex >= 0 ? urlWithoutHash.slice(0, queryIndex) : urlWithoutHash;
+  const query = queryIndex >= 0 ? urlWithoutHash.slice(queryIndex + 1) : '';
+  const existingSearchParams = new URLSearchParams(query);
+  const appendedSearchParams = new URLSearchParams();
+  for (const [key, value] of Object.entries(searchParams)) {
+    if (!existingSearchParams.has(key)) {
+      appendedSearchParams.set(key, String(value));
+    }
+  }
+
+  const serializedAppendedSearchParams = appendedSearchParams.toString();
+  return `${path}${queryIndex >= 0 ? `?${query}` : ''}${
+    serializedAppendedSearchParams
+      ? `${queryIndex >= 0 ? '&' : '?'}${serializedAppendedSearchParams}`
+      : ''
+  }${hash}`;
+}
+
 /**
  * Global state for loaders.gl. Stored on `globalThis.loaders._state`
  */
@@ -111,7 +146,10 @@ export function normalizeOptions(
   loaders = Array.isArray(loaders) ? loaders : [loaders];
 
   validateOptions(options, loaders);
-  return normalizeLoaderOptions(normalizeOptionsInternal(loader, options, url));
+  validateWorkerThreshold(options);
+  const normalizedOptions = normalizeLoaderOptions(normalizeOptionsInternal(loader, options, url));
+  validateWorkerThreshold(normalizedOptions);
+  return normalizedOptions;
 }
 
 /**
@@ -159,6 +197,14 @@ function validateOptions(options: LoaderOptions, loaders: Loader[]): void {
   }
 }
 
+/** Validates the automatic worker-selection threshold. */
+function validateWorkerThreshold(options: LoaderOptions): void {
+  const threshold = options.core?.workerThreshold;
+  if (threshold !== undefined && (!Number.isFinite(threshold) || threshold < 0 || threshold > 1)) {
+    throw new Error('core.workerThreshold must be a finite number between 0 and 1');
+  }
+}
+
 // eslint-disable-next-line max-params, complexity
 function validateOptionsObject(
   options: LoaderOptions,

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

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {isResponse} from '@loaders.gl/loader-utils';
+import {encodeArrayBufferToBase64, isResponse} from '@loaders.gl/loader-utils';
 import {FetchError} from '../fetch/fetch-error';
 import {getResourceContentLength, getResourceUrl, getResourceMIMEType} from './resource-utils';
 import {shortenUrlForDisplay} from './url-utils';
@@ -120,18 +120,8 @@ async function getInitialDataUrl(
   }
   if (resource instanceof ArrayBuffer) {
     const slice = resource.slice(0, INITIAL_DATA_LENGTH);
-    const base64 = arrayBufferToBase64(slice);
+    const base64 = encodeArrayBufferToBase64(slice);
     return `data:base64,${base64}`;
   }
   return null;
 }
-
-// https://stackoverflow.com/questions/9267899/arraybuffer-to-base64-encoded-string
-function arrayBufferToBase64(buffer: ArrayBuffer): string {
-  let binary = '';
-  const bytes = new Uint8Array(buffer);
-  for (let i = 0; i < bytes.byteLength; i++) {
-    binary += String.fromCharCode(bytes[i]);
-  }
-  return btoa(binary);
-}