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

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

@@ -29,10 +29,12 @@ const CORE_LOADER_OPTION_KEYS = [
   'maxConcurrency',
   'maxMobileConcurrency',
   'reuseWorkers',
+  'workerTransferBufferCopy',
   '_nodeWorkers',
   '_workerType',
   'limit',
   '_limitMB',
+  'shape',
   'batchSize',
   'batchDebounceMs',
   'metadata',
@@ -235,6 +237,7 @@ function normalizeOptionsInternal(
 
   const userOptions = normalizeLoaderOptions(options);
   mergeNestedFields(mergedOptions, userOptions);
+  applyCoreShapeDefault(mergedOptions, userOptions, loader);
 
   addUrlOptions(mergedOptions, url);
   addDeprecatedTopLevelOptions(mergedOptions);
@@ -242,7 +245,50 @@ function normalizeOptionsInternal(
   return mergedOptions;
 }
 
-// Merge nested options objects
+/**
+ * Applies `options.core.shape` to a loader's scoped `shape` option when that loader declares
+ * shape support and neither global nor user-supplied loader-scoped options override it.
+ * @param mergedOptions fully merged options object being normalized
+ * @param userOptions normalized user-supplied options
+ * @param loader selected loader
+ */
+function applyCoreShapeDefault(
+  mergedOptions: LoaderOptions,
+  userOptions: LoaderOptions,
+  loader: Loader
+): void {
+  const coreShape = mergedOptions.core?.shape;
+  if (coreShape === undefined) {
+    return;
+  }
+
+  const loaderScopedDefaults = loader.options?.[loader.id];
+  if (!isPureObject(loaderScopedDefaults) || !('shape' in loaderScopedDefaults)) {
+    return;
+  }
+
+  const globalLoaderScopedOptions = getGlobalLoaderOptions()[loader.id];
+  if (isPureObject(globalLoaderScopedOptions) && 'shape' in globalLoaderScopedOptions) {
+    return;
+  }
+
+  const userLoaderScopedOptions = userOptions[loader.id];
+  if (isPureObject(userLoaderScopedOptions) && 'shape' in userLoaderScopedOptions) {
+    return;
+  }
+
+  const loaderScopedOptions = mergedOptions[loader.id];
+  mergedOptions[loader.id] = {
+    ...(isPureObject(loaderScopedOptions) ? loaderScopedOptions : {}),
+    shape: coreShape
+  };
+}
+
+/**
+ * Merges one level of nested option objects into the target options record.
+ * @param mergedOptions target options object to mutate
+ * @param options source options object
+ */
 function mergeNestedFields(mergedOptions: LoaderOptions, options: LoaderOptions): void {
   for (const key in options) {
     // Check for nested options
@@ -288,6 +334,11 @@ function cloneLoaderOptions(options: LoaderOptions): LoaderOptions {
   return clonedOptions;
 }
 
+/**
+ * Moves deprecated top-level core option aliases into `options.core` without overwriting
+ * explicitly provided `options.core` values.
+ * @param options loader options to normalize in place
+ */
 function moveDeprecatedTopLevelOptionsToCore(options: LoaderOptions): void {
   if (options.baseUri !== undefined) {
     options.core ||= {};
@@ -298,7 +349,8 @@ function moveDeprecatedTopLevelOptionsToCore(options: LoaderOptions): void {
 
   for (const key of CORE_LOADER_OPTION_KEYS) {
     if ((options as Record<string, unknown>)[key] !== undefined) {
-      const coreOptions = (options.core = options.core || {});
+      options.core ||= {};
+      const coreOptions = options.core;
       const coreRecord = coreOptions as Record<string, unknown>;
       // Treat deprecated top-level core options as aliases to `options.core`, but never override an explicitly
       // provided `options.core` value.
@@ -318,6 +370,11 @@ function moveDeprecatedTopLevelOptionsToCore(options: LoaderOptions): void {
   }
 }
 
+/**
+ * Rehydrates deprecated top-level aliases from `options.core` for compatibility with older
+ * call sites that still read normalized options from the top level.
+ * @param options normalized loader options to mutate in place
+ */
 function addDeprecatedTopLevelOptions(options: LoaderOptions): void {
   const coreOptions = options.core as Record<string, unknown> | undefined;
   if (!coreOptions) {

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

@@ -97,7 +97,7 @@ async function getResponseError(response: Response): Promise<Error> {
       !response.bodyUsed && contentType?.includes('application/json')
         ? await response.json()
         : await response.text();
-  } catch (error) {
+  } catch (_error) {
     // eslint forbids return in a finally statement, so we just catch here
   }
   return new FetchError(message, info);
@@ -112,9 +112,9 @@ async function getInitialDataUrl(
   }
   if (resource instanceof Blob) {
     const blobSlice = resource.slice(0, 5);
-    return await new Promise((resolve) => {
+    return await new Promise(resolve => {
       const reader = new FileReader();
-      reader.onload = (event) => resolve(event?.target?.result as string);
+      reader.onload = event => resolve(event?.target?.result as string);
       reader.readAsDataURL(blobSlice);
     });
   }

package/src/null-loader.ts

@@ -2,13 +2,13 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
+import type {Loader, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {LoaderContext} from '@loaders.gl/loader-utils';
+
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
-import type {Loader, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import {LoaderContext} from '@loaders.gl/loader-utils';
-
 export type NullLoaderOptions = LoaderOptions & {
   null?: {};
 };