@loaders.gl/loader-utils 4.0.0-alpha.21 → 4.0.0-alpha.23

package/src/types.ts

@@ -43,338 +43,6 @@ export type NumericArray = number[] | TypedArray;
 
 export type FetchLike = (url: string, options?: RequestInit) => Promise<Response>;
 
-// LOADERS
-
-/**
- * Core Loader Options
- */
-export type LoaderOptions = {
-  /** fetch options or a custom fetch function */
-  fetch?: typeof fetch | FetchLike | RequestInit | null;
-  /** Do not throw on errors */
-  nothrow?: boolean;
-
-  /** loader selection, search first for supplied mimeType */
-  mimeType?: string;
-  /** loader selection, provide fallback mimeType is server does not provide */
-  fallbackMimeType?: string;
-  /** loader selection, avoid searching registered loaders */
-  ignoreRegisteredLoaders?: boolean;
-
-  // general
-  /** Experimental: Supply a logger to the parser */
-  log?: any;
-  /** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
-  useLocalLibraries?: boolean;
-
-  // batched parsing
-
-  /** Size of each batch. `auto` matches batches to size of incoming chunks */
-  batchSize?: number | 'auto';
-  /** Minimal amount of time between batches */
-  batchDebounceMs?: number;
-  /** Stop loading after a given number of rows (compare SQL limit clause) */
-  limit?: 0;
-  /** Experimental: Stop loading after reaching */
-  _limitMB?: 0;
-  /** Generate metadata batches */
-  metadata?: boolean;
-  /** Transforms to run on incoming batches */
-  transforms?: TransformBatches[];
-
-  // workers
-
-  /** CDN load workers from */
-  CDN?: string | null;
-  /** Set to `false` to disable workers */
-  worker?: boolean;
-  /** Number of concurrent workers (per loader) on desktop browser */
-  maxConcurrency?: number;
-  /** Number of concurrent workers (per loader) on mobile browsers */
-  maxMobileConcurrency?: number;
-  /** Set to `false` to prevent reuse workers */
-  reuseWorkers?: boolean;
-  /** Whether to use workers under Node.js (experimental) */
-  _nodeWorkers?: boolean;
-  /** set to 'test' to run local worker */
-  _workerType?: string;
-
-  /** @deprecated `options.batchType` removed, Use `options.<loader>.type` instead */
-  batchType?: 'row' | 'columnar' | 'arrow';
-  /** @deprecated `options.throw removed`, Use `options.nothrow` instead */
-  throws?: boolean;
-  /** @deprecated `options.dataType` no longer used */
-  dataType?: never;
-  /** @deprecated `options.uri` no longer used */
-  uri?: never;
-  /** @deprecated `options.method` removed. Use `options.fetch.method` */
-  method?: never;
-  /** @deprecated `options.headers` removed. Use `options.fetch.headers` */
-  headers?: never;
-  /** @deprecated `options.body` removed. Use `options.fetch.body` */
-  body?: never;
-  /** @deprecated `options.mode` removed. Use `options.fetch.mode` */
-  mode?: never;
-  /** @deprecated `options.credentials` removed. Use `options.fetch.credentials` */
-  credentials?: never;
-  /** @deprecated `options.cache` removed. Use `options.fetch.cache` */
-  cache?: never;
-  /** @deprecated `options.redirect` removed. Use `options.fetch.redirect` */
-  redirect?: never;
-  /** @deprecated `options.referrer` removed. Use `options.fetch.referrer` */
-  referrer?: never;
-  /** @deprecated `options.referrerPolicy` removed. Use `options.fetch.referrerPolicy` */
-  referrerPolicy?: never;
-  /** @deprecated `options.integrity` removed. Use `options.fetch.integrity` */
-  integrity?: never;
-  /** @deprecated `options.keepalive` removed. Use `options.fetch.keepalive` */
-  keepalive?: never;
-  /** @deprecated `options.signal` removed. Use `options.fetch.signal` */
-  signal?: never;
-
-  // Accept other keys (loader options objects, e.g. `options.csv`, `options.json` ...)
-  [loaderId: string]: unknown;
-};
-
-type PreloadOptions = {
-  [key: string]: unknown;
-};
-
-/**
- * A worker loader definition that can be used with `@loaders.gl/core` functions
- */
-export type Loader<DataT = any, BatchT = any, LoaderOptionsT = LoaderOptions> = {
-  /** The result type of this loader  */
-  dataType?: DataT;
-  /** The batched result type of this loader  */
-  batchType?: BatchT;
-
-  /** Default Options */
-  options: LoaderOptionsT;
-  /** Deprecated Options */
-  deprecatedOptions?: Record<string, string | Record<string, string>>;
-
-  /** Human readable name */
-  name: string;
-  /** id should be the same as the field used in LoaderOptions */
-  id: string;
-  /** module is used to generate worker threads, need to be the module directory name */
-  module: string;
-  /** Version should be injected by build tools */
-  version: string;
-  /** A boolean, or a URL */
-  worker?: string | boolean;
-  // end Worker
-
-  /** Which category does this loader belong to */
-  category?: string;
-  /** File extensions that are potential matches with this loader. */
-  extensions: string[];
-  /** MIMETypes that indicate a match with this loader. @note Some MIMETypes are generic and supported by many loaders */
-  mimeTypes: string[];
-
-  /** Is the input of this loader binary */
-  binary?: boolean;
-  /** Is the input of this loader text */
-  text?: boolean;
-
-  /** Test some initial bytes of content to see if this loader might be a match */
-  tests?: (((ArrayBuffer: ArrayBuffer) => boolean) | ArrayBuffer | string)[];
-
-  /** @deprecated */
-  supported?: boolean;
-  /** @deprecated */
-  testText?: (string: string) => boolean;
-};
-
-/**
- * A "bundled" loader definition that can be used with `@loaders.gl/core` functions
- * If a worker loader is supported it will also be supported.
- */
-export type LoaderWithParser<DataT = any, BatchT = any, LoaderOptionsT = LoaderOptions> = Loader<
-  DataT,
-  BatchT,
-  LoaderOptionsT
-> & {
-  /** Perform actions before load. @deprecated Not officially supported. */
-  preload?: Preload;
-  /** Parse atomically from an arraybuffer asynchronously */
-  parse: (
-    arrayBuffer: ArrayBuffer,
-    options?: LoaderOptionsT,
-    context?: LoaderContext
-  ) => Promise<DataT>;
-  /** Parse atomically from an arraybuffer synchronously */
-  parseSync?: (
-    arrayBuffer: ArrayBuffer,
-    options?: LoaderOptionsT,
-    context?: LoaderContext
-  ) => DataT;
-  /** Parse atomically from a string asynchronously */
-  parseText?: (text: string, options?: LoaderOptionsT, context?: LoaderContext) => Promise<DataT>;
-  /** Parse atomically from a string synchronously */
-  parseTextSync?: (text: string, options?: LoaderOptionsT, context?: LoaderContext) => DataT;
-  /** Parse batches of data from an iterator, return an iterator that yield parsed batches. */
-  parseInBatches?: (
-    iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
-    options?: LoaderOptionsT,
-    context?: LoaderContext
-  ) => AsyncIterable<BatchT>;
-  /** Like `parseInBatches` for loaders that don't integrate with fetch. @deprecated Not officially supported. */
-  parseFileInBatches?: (
-    file: Blob,
-    options?: LoaderOptionsT,
-    context?: LoaderContext
-  ) => AsyncIterable<BatchT>;
-};
-
-/**
- * A Loader context is provided as a third parameters to a loader object's
- * parse functions when that loader is called by other loaders rather then
- * directly by the application.
- *
- * - The context object allows the subloaders to be aware of the parameters and
- *   options that the application provided in the top level call.
- * - The context also providedsaccess to parse functions so that the subloader
- *   does not need to include the core module.
- * - In addition, the context's parse functions may also redirect loads from worker
- *   threads back to main thread.
- */
-export type LoaderContext = {
-  /** Loader list provided to top-level loader call plus any sub loaders */
-  loaders?: Loader[] | null;
-  /** If URL is available.  */
-  url?: string;
-  /** the file name component of the URL (leading path and query string removed) */
-  filename?: string;
-  /** the directory name component of the URL (leading path excluding file name and query string) */
-  baseUrl?: string;
-  /** Query string (characters after `?`) */
-  queryString?: string;
-
-  /** Provides access to any application overrides of fetch() */
-  fetch: typeof fetch | FetchLike;
-  /** TBD */
-  response?: Response;
-  /** Parse function. Use instead of importing `core`. In workers, may redirect to main thread */
-  parse: (
-    arrayBuffer: ArrayBuffer,
-    loaders?: Loader | Loader[] | LoaderOptions,
-    options?: LoaderOptions,
-    context?: LoaderContext
-  ) => Promise<any>;
-  /** ParseSync function. Use instead of importing `core`. In workers, may redirect to main thread */
-  parseSync?: (
-    arrayBuffer: ArrayBuffer,
-    loaders?: Loader | Loader[] | LoaderOptions,
-    options?: LoaderOptions,
-    context?: LoaderContext
-  ) => any;
-  /** ParseInBatches function. Use instead of importing `core`.  */
-  parseInBatches?: (
-    iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
-    loaders?: Loader | Loader[] | LoaderOptions,
-    options?: LoaderOptions,
-    context?: LoaderContext
-  ) => AsyncIterable<any> | Promise<AsyncIterable<any>>;
-};
-
-// type Parse = (
-//   arrayBuffer: ArrayBuffer,
-//   options?: LoaderOptions,
-//   context?: LoaderContext
-// ) => Promise<any>;
-// type ParseSync = (
-//   arrayBuffer: ArrayBuffer,
-//   options?: LoaderOptions,
-//   context?: LoaderContext
-// ) => any;
-// type ParseText = (text: string, options?: LoaderOptions) => Promise<any>;
-// type ParseTextSync = (text: string, options?: LoaderOptions) => any;
-// type ParseInBatches = (
-//   iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
-//   options?: LoaderOptions,
-//   context?: LoaderContext
-// ) => AsyncIterable<any>;
-// type ParseFileInBatches = (
-//   file: Blob,
-//   options?: LoaderOptions,
-//   context?: LoaderContext
-// ) => AsyncIterable<any>;
-
-type Preload = (url: string, options?: PreloadOptions) => any;
-
-/** Typescript helper to extract options type from a generic loader type */
-export type LoaderOptionsType<T = Loader> = T extends Loader<any, any, infer Options>
-  ? Options
-  : never;
-/** Typescript helper to extract data type from a generic loader type */
-export type LoaderReturnType<T = Loader> = T extends Loader<infer Return, any, any>
-  ? Return
-  : never;
-/** Typescript helper to extract batch type from a generic loader type */
-export type LoaderBatchType<T = Loader> = T extends Loader<any, infer Batch, any> ? Batch : never;
-
-// WRITERS
-
-/** Options for writers */
-export type WriterOptions = {
-  /** worker source. If is set will be used instead of loading worker from the Internet */
-  source?: string | null;
-  /** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
-  useLocalLibraries?: boolean;
-  /** writer-specific options */
-  [writerId: string]: any;
-};
-
-/**
- * A writer definition that can be used with `@loaders.gl/core` functions
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export type Writer<DataT = unknown, BatchT = unknown, WriterOptionsT = WriterOptions> = {
-  name: string;
-
-  id: string;
-  module: string;
-  version: string;
-  worker?: string | boolean;
-
-  // TODO - are these are needed?
-  extensions?: string[];
-  mimeTypes?: string[];
-  binary?: boolean;
-  text?: boolean;
-
-  options: WriterOptionsT;
-  deprecatedOptions?: Record<string, string>;
-
-  // encodeText?: EncodeText;
-  // encode?: Encode;
-  encodeSync?: EncodeSync;
-  // encodeInBatches?: EncodeInBatches;
-  encodeURLtoURL?: EncodeURLtoURL;
-
-  encode?(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
-  encodeText?(table: DataT, options?: WriterOptionsT): Promise<string> | string;
-  encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
-};
-
-//  type Encode = (data: any, options?: WriterOptions) => Promise<ArrayBuffer>;
-type EncodeSync = (data: any, options?: WriterOptions) => ArrayBuffer;
-// TODO
-// type EncodeText = Function;
-// type EncodeInBatches = Function;
-type EncodeURLtoURL = (
-  inputUrl: string,
-  outputUrl: string,
-  options?: WriterOptions
-) => Promise<string>;
-
-/** Typescript helper to extract the writer options type from a generic writer type */
-export type WriterOptionsType<T = Writer> = T extends Writer<unknown, unknown, infer Options>
-  ? Options
-  : never;
-
 // MISC TYPES
 
 export type TransformBatches = (
@@ -401,37 +69,3 @@ export type BatchableDataType =
   | Iterable<ArrayBuffer>
   | AsyncIterable<ArrayBuffer>
   | Promise<AsyncIterable<ArrayBuffer>>;
-
-/**
- * A FileSystem interface can encapsulate a FileList, a ZipFile, a GoogleDrive etc.
- */
-export interface IFileSystem {
-  /**
-   * Return a list of file names
-   * @param dirname directory name. file system root directory if omitted
-   */
-  readdir(dirname?: string, options?: {recursive?: boolean}): Promise<string[]>;
-
-  /**
-   * Gets information from a local file from the filesystem
-   * @param filename file name to stat
-   * @param options currently unused
-   * @throws if filename is not in local filesystem
-   */
-  stat(filename: string, options?: object): Promise<{size: number}>;
-
-  /**
-   * Fetches a local file from the filesystem (or a URL)
-   * @param filename
-   * @param options
-   */
-  fetch(filename: string, options?: object): Promise<Response>;
-}
-
-type ReadOptions = {buffer?: ArrayBuffer; offset?: number; length?: number; position?: number};
-export interface IRandomAccessReadFileSystem extends IFileSystem {
-  open(path: string, flags: string | number, mode?: any): Promise<any>;
-  close(fd: any): Promise<void>;
-  fstat(fd: any): Promise<object>;
-  read(fd: any, options?: ReadOptions): Promise<{bytesRead: number; buffer: Buffer}>;
-}

package/src/writer-types.ts

@@ -0,0 +1,61 @@
+// loaders.gl, MIT license
+
+// WRITERS
+
+/** Options for writers */
+export type WriterOptions = {
+  /** worker source. If is set will be used instead of loading worker from the Internet */
+  source?: string | null;
+  /** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
+  useLocalLibraries?: boolean;
+  /** writer-specific options */
+  [writerId: string]: any;
+};
+
+/**
+ * A writer definition that can be used with `@loaders.gl/core` functions
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export type Writer<DataT = unknown, BatchT = unknown, WriterOptionsT = WriterOptions> = {
+  name: string;
+
+  id: string;
+  module: string;
+  version: string;
+  worker?: string | boolean;
+
+  // TODO - are these are needed?
+  extensions?: string[];
+  mimeTypes?: string[];
+  binary?: boolean;
+  text?: boolean;
+
+  options: WriterOptionsT;
+  deprecatedOptions?: Record<string, string>;
+
+  // encodeText?: EncodeText;
+  // encode?: Encode;
+  encodeSync?: EncodeSync;
+  // encodeInBatches?: EncodeInBatches;
+  encodeURLtoURL?: EncodeURLtoURL;
+
+  encode?(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
+  encodeText?(table: DataT, options?: WriterOptionsT): Promise<string> | string;
+  encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
+};
+
+//  type Encode = (data: any, options?: WriterOptions) => Promise<ArrayBuffer>;
+type EncodeSync = (data: any, options?: WriterOptions) => ArrayBuffer;
+// TODO
+// type EncodeText = Function;
+// type EncodeInBatches = Function;
+type EncodeURLtoURL = (
+  inputUrl: string,
+  outputUrl: string,
+  options?: WriterOptions
+) => Promise<string>;
+
+/** Typescript helper to extract the writer options type from a generic writer type */
+export type WriterOptionsType<T = Writer> = T extends Writer<unknown, unknown, infer Options>
+  ? Options
+  : never;