@loaders.gl/core 4.3.0-alpha.8 → 4.3.0-beta.2

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

@@ -3,9 +3,17 @@
 // Copyright (c) vis.gl contributors
 
 import {isTable, makeBatchFromTable, type Batch} from '@loaders.gl/schema';
-import type {Loader, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import type {LoaderContext, BatchableDataType} from '@loaders.gl/loader-utils';
-import type {LoaderBatchType, LoaderOptionsType} from '@loaders.gl/loader-utils';
+import type {
+  Loader,
+  LoaderWithParser,
+  LoaderOptions,
+  LoaderContext,
+  BatchableDataType,
+  LoaderOptionsType,
+  LoaderBatchType,
+  LoaderArrayOptionsType,
+  LoaderArrayBatchType
+} from '@loaders.gl/loader-utils';
 import {concatenateArrayBuffersAsync} from '@loaders.gl/loader-utils';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
 import {normalizeOptions} from '../loader-utils/option-utils';
@@ -33,15 +41,19 @@ export async function parseInBatches<
 /**
  * Parses `data` using one of the supplied loaders
  */
-export async function parseInBatches(
+export async function parseInBatches<
+  LoaderArrayT extends Loader[],
+  OptionsT extends LoaderOptions = LoaderArrayOptionsType<LoaderArrayT>
+>(
   data: BatchableDataType,
-  loaders: Loader[],
-  options?: LoaderOptions,
+  loaders: LoaderArrayT,
+  options?: OptionsT,
   context?: LoaderContext
-): Promise<AsyncIterable<unknown>>;
+): Promise<LoaderArrayBatchType<LoaderArrayT>>;
 
 /**
  * Parses `data` in batches by selecting a pre-registered loader
+ * @deprecated Loader registration is deprecated, use parseInBatches(data, loaders, options) instead
  */
 export async function parseInBatches(
   data: BatchableDataType,

package/src/lib/api/parse-sync.ts

@@ -2,9 +2,17 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Loader, LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import type {LoaderContext, SyncDataType} from '@loaders.gl/loader-utils';
-import type {LoaderOptionsType, LoaderReturnType} from '@loaders.gl/loader-utils';
+import type {
+  Loader,
+  LoaderWithParser,
+  LoaderOptions,
+  LoaderContext,
+  SyncDataType,
+  LoaderOptionsType,
+  LoaderReturnType,
+  LoaderArrayOptionsType,
+  LoaderArrayReturnType
+} from '@loaders.gl/loader-utils';
 import {selectLoaderSync} from './select-loader';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
 import {normalizeOptions} from '../loader-utils/option-utils';
@@ -30,15 +38,19 @@ export function parseSync<
 /**
  * Parses `data` synchronously by matching one of the supplied loaders
  */
-export function parseSync(
+export function parseSync<
+  LoaderArrayT extends Loader[],
+  OptionsT extends LoaderOptions = LoaderArrayOptionsType<LoaderArrayT>
+>(
   data: SyncDataType,
-  loaders: Loader[],
-  options?: LoaderOptions,
+  loaders: LoaderArrayT,
+  options?: OptionsT,
   context?: LoaderContext
-): unknown;
+): LoaderArrayReturnType<LoaderArrayT>;
 
 /**
  * Parses `data` synchronously by matching a pre=registered loader
+ * @deprecated Loader registration is deprecated, use parseSync(data, loaders, options) instead
  */
 export function parseSync(data: SyncDataType, options?: LoaderOptions): unknown;
 

package/src/lib/api/parse.ts

@@ -2,15 +2,22 @@
 // SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Loader, LoaderContext, LoaderOptions} from '@loaders.gl/loader-utils';
-import type {DataType, LoaderWithParser} from '@loaders.gl/loader-utils';
-import type {LoaderOptionsType, LoaderReturnType} from '@loaders.gl/loader-utils';
-import {parseWithWorker, canParseWithWorker} from '@loaders.gl/loader-utils';
+import type {
+  Loader,
+  LoaderContext,
+  LoaderOptions,
+  DataType,
+  LoaderWithParser,
+  LoaderOptionsType,
+  LoaderReturnType,
+  LoaderArrayOptionsType,
+  LoaderArrayReturnType
+} from '@loaders.gl/loader-utils';
+import {parseWithWorker, canParseWithWorker, mergeLoaderOptions} from '@loaders.gl/loader-utils';
 import {assert, validateWorkerVersion} from '@loaders.gl/worker-utils';
 import {isLoaderObject} from '../loader-utils/normalize-loader';
 import {isResponse} from '../../javascript-utils/is-type';
 import {normalizeOptions} from '../loader-utils/option-utils';
-import {mergeLoaderOptions} from '@loaders.gl/loader-utils';
 import {getArrayBufferOrStringFromData} from '../loader-utils/get-data';
 import {getLoaderContext, getLoadersFromContext} from '../loader-utils/loader-context';
 import {getResourceUrl} from '../utils/resource-utils';
@@ -34,15 +41,19 @@ export async function parse<
 /**
  * Parses `data` asynchronously by matching one of the supplied loader
  */
-export async function parse(
+export async function parse<
+  LoaderArrayT extends Loader[],
+  OptionsT extends LoaderOptions = LoaderArrayOptionsType<LoaderArrayT>
+>(
   data: DataType | Promise<DataType>,
-  loaders: Loader[],
-  options?: LoaderOptions,
+  loaders: LoaderArrayT,
+  options?: OptionsT,
   context?: LoaderContext
-): Promise<unknown>;
+): Promise<LoaderArrayReturnType<LoaderArrayT>>;
 
 /**
  * Parses data asynchronously by matching a pre-registered loader
+ * @deprecated Loader registration is deprecated, use parse(data, loaders, options) instead
  */
 export async function parse(
   data: DataType | Promise<DataType>,

package/src/lib/api/register-loaders.ts

@@ -16,7 +16,11 @@ const getGlobalLoaderRegistry = () => {
   return state.loaderRegistry;
 };
 
-/** Register a list of global loaders */
+/**
+ * Register a list of global loaders
+ * @note Registration erases loader type information.
+ * @deprecated It is recommended that applications manage loader registration. This function will likely be remove in loaders.gl v5
+ */
 export function registerLoaders(loaders: Loader[] | Loader) {
   const loaderRegistry = getGlobalLoaderRegistry();
 
@@ -31,6 +35,9 @@ export function registerLoaders(loaders: Loader[] | Loader) {
   }
 }
 
+/**
+ * @deprecated It is recommended that applications manage loader registration. This function will likely be remove in loaders.gl v5
+ */
 export function getRegisteredLoaders(): Loader[] {
   return getGlobalLoaderRegistry();
 }