@loaders.gl/loader-utils 4.1.0-alpha.1 → 4.1.0-alpha.10

package/src/lib/file-provider/file-handle-file.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {FileProvider} from './file-provider';
@@ -12,13 +13,25 @@ export class FileHandleFile implements FileProvider {
   /** The FileHandle from which data is provided */
   private file: NodeFile;
 
-  /** The file length in bytes */
-  private size: bigint;
-
   /** Create a new FileHandleFile */
-  constructor(path: string) {
-    this.file = new NodeFile(path, 'r');
-    this.size = this.file.bigsize;
+  constructor(path: string, append: boolean = false) {
+    this.file = new NodeFile(path, append ? 'a+' : 'r');
+  }
+
+  /**
+   * Truncates the file descriptor.
+   * @param length desired file lenght
+   */
+  async truncate(length: number): Promise<void> {
+    await this.file.truncate(length);
+  }
+
+  /**
+   * Append data to a file.
+   * @param buffer data to append
+   */
+  async append(buffer: Uint8Array): Promise<void> {
+    await this.file.append(buffer);
   }
 
   /** Close file */
@@ -96,6 +109,6 @@ export class FileHandleFile implements FileProvider {
    * the length (in bytes) of the data.
    */
   get length(): bigint {
-    return this.size;
+    return this.file.bigsize;
   }
 }

package/src/lib/files/blob-file.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {ReadableFile} from './file';

package/src/lib/files/file.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 export type Stat = {

package/src/lib/files/http-file.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {ReadableFile, Stat} from './file';

package/src/lib/files/node-file-facade.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {isBrowser} from '../env-utils/globals';
@@ -13,7 +14,7 @@ export class NodeFileFacade implements ReadableFile, WritableFile {
   bigsize: bigint = 0n;
   url: string = '';
 
-  constructor(url: string, flags?: 'r' | 'w' | 'wx', mode?: number) {
+  constructor(url: string, flags?: 'r' | 'w' | 'wx' | 'a+', mode?: number) {
     // Return the actual implementation instance
     if (globalThis.loaders?.NodeFile) {
       return new globalThis.loaders.NodeFile(url, flags, mode);
@@ -35,6 +36,16 @@ export class NodeFileFacade implements ReadableFile, WritableFile {
   async stat(): Promise<Stat> {
     throw NOT_IMPLEMENTED;
   }
+
+  /** Truncates the file descriptor. Only available on NodeFile. */
+  async truncate(length: number): Promise<void> {
+    throw NOT_IMPLEMENTED;
+  }
+
+  /** Append data to a file. Only available on NodeFile. */
+  async append(data: Uint8Array): Promise<void> {
+    throw NOT_IMPLEMENTED;
+  }
   /** Close the file */
   async close(): Promise<void> {}
 }

package/src/lib/filesystems/filesystem.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {ReadableFile, WritableFile} from '../files/file';

package/src/lib/filesystems/node-filesystem-facade.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {isBrowser} from '../env-utils/globals';

package/src/lib/node/buffer.browser.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)

package/src/lib/node/buffer.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // Isolates Buffer references to ensure they are only bundled under Node.js (avoids big webpack polyfill)

package/src/lib/node/stream.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import * as stream from 'stream';

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

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {LoaderOptions} from '../../loader-types';
@@ -18,14 +19,21 @@ export function mergeLoaderOptions<Options extends LoaderOptions>(
 
 function mergeOptionsRecursively(
   baseOptions: Record<string, unknown>,
-  newOptions: Record<string, unknown>
+  newOptions: Record<string, unknown>,
+  level = 0
 ): Record<string, unknown> {
+  // Sanity check (jest test runner overwrites the console object which can lead to infinite recursion)
+  if (level > 3) {
+    return newOptions;
+  }
+
   const options = {...baseOptions};
   for (const [key, newValue] of Object.entries(newOptions)) {
     if (newValue && typeof newValue === 'object' && !Array.isArray(newValue)) {
       options[key] = mergeOptionsRecursively(
         (options[key] as Record<string, unknown>) || {},
-        newOptions[key] as Record<string, unknown>
+        newOptions[key] as Record<string, unknown>,
+        level + 1
       );
       // Object.assign(options[key] as object, newOptions[key]);
     } else {

package/src/lib/sources/data-source.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {LoaderOptions} from '@loaders.gl/loader-utils';

package/src/lib/sources/image-source.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {DataSourceProps} from './data-source';

package/src/lib/sources/image-tile-source.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {ImageType} from './utils/image-type';

package/src/lib/sources/tile-source-adapter.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 
 import {TileSource, GetTileParameters} from './tile-source';
 import {ImageSource, ImageSourceMetadata} from './image-source';

package/src/lib/sources/tile-source.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 /**

package/src/lib/sources/utils/utils.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {LoaderOptions} from '@loaders.gl/loader-utils';

package/src/lib/sources/vector-tile-source.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {TileSource, TileSourceMetadata} from './tile-source';

package/src/loader-types.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {
@@ -180,10 +181,6 @@ export type LoaderWithParser<DataT = any, BatchT = any, LoaderOptionsT = LoaderO
     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 (e.g. fetch stream), return an iterator that yield parsed batches. */
   parseInBatches?: (
     iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>,
@@ -196,6 +193,11 @@ export type LoaderWithParser<DataT = any, BatchT = any, LoaderOptionsT = LoaderO
     options?: LoaderOptionsT,
     context?: LoaderContext
   ) => AsyncIterable<BatchT>;
+
+  /** 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;
 };
 
 /**

package/src/service-types.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import type {ImageSource, ImageSourceProps} from './lib/sources/image-source';

package/src/writer-types.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // WRITERS
@@ -47,6 +48,7 @@ export type Writer<DataT = unknown, BatchT = unknown, WriterOptionsT = WriterOpt
   /** Is the input of this loader text */
   text?: boolean;
 
+  /** Default options for this writer */
   options: WriterOptionsT;
   deprecatedOptions?: Record<string, string>;
 };
@@ -59,13 +61,22 @@ export type WriterWithEncoder<
   BatchT = unknown,
   WriterOptionsT = WriterOptions
 > = Writer<DataT, BatchT, WriterOptionsT> & {
-  encode?(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
+  /** Encode to binary,  asynchronously */
+  encode(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
+  /** Encode to binary, synchronously */
   encodeSync?(data: DataT, options?: WriterOptionsT): ArrayBuffer;
+  /** Encode to binary in batches */
+  encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
 
+  /** Encode to text, asynchronously. For text formats. */
   encodeText?(table: DataT, options?: WriterOptionsT): Promise<string>;
+  /** Encode to text, synchronously. For text formats. */
   encodeTextSync?(table: DataT, options?: WriterOptionsT): string;
-
-  encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
+  /** Encode to text in batched. For text formats. */
+  encodeTextInBatches?(
+    data: AsyncIterable<any>,
+    options?: WriterOptionsT
+  ): AsyncIterable<ArrayBuffer>;
 
   encodeURLtoURL?: (
     inputUrl: string,