@loaders.gl/zip 4.0.0-alpha.22 → 4.0.0-alpha.24

package/dist/zip-loader.js

@@ -1,61 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports._typecheckZipLoader = exports.ZipLoader = void 0;
-const jszip_1 = __importDefault(require("jszip"));
-// __VERSION__ is injected by babel-plugin-version-inline
-// @ts-ignore TS2304: Cannot find name '__VERSION__'.
-const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
-exports.ZipLoader = {
-    id: 'zip',
-    module: 'zip',
-    name: 'Zip Archive',
-    version: VERSION,
-    extensions: ['zip'],
-    mimeTypes: ['application/zip'],
-    category: 'archive',
-    tests: ['PK'],
-    options: {},
-    parse: parseZipAsync
-};
-// TODO - Could return a map of promises, perhaps as an option...
-async function parseZipAsync(data, options = {}) {
-    const promises = [];
-    const fileMap = {};
-    try {
-        const jsZip = new jszip_1.default();
-        const zip = await jsZip.loadAsync(data, options);
-        // start to load each file in this zip
-        zip.forEach((relativePath, zipEntry) => {
-            const subFilename = zipEntry.name;
-            const promise = loadZipEntry(jsZip, subFilename, options).then((arrayBufferOrError) => {
-                fileMap[relativePath] = arrayBufferOrError;
-            });
-            // Ensure Promise.all doesn't ignore rejected promises.
-            promises.push(promise);
-        });
-        await Promise.all(promises);
-        return fileMap;
-    }
-    catch (error) {
-        // @ts-ignore
-        options.log.error(`Unable to read zip archive: ${error}`);
-        throw error;
-    }
-}
-async function loadZipEntry(jsZip, subFilename, options = {}) {
-    // jszip supports both arraybuffer and text, the main loaders.gl types
-    // https://stuk.github.io/jszip/documentation/api_zipobject/async.html
-    try {
-        const arrayBuffer = await jsZip.file(subFilename).async(options.dataType || 'arraybuffer');
-        return arrayBuffer;
-    }
-    catch (error) {
-        options.log.error(`Unable to read ${subFilename} from zip archive: ${error}`);
-        // Store error in place of data in map
-        return error;
-    }
-}
-exports._typecheckZipLoader = exports.ZipLoader;

package/dist/zip-writer.js

@@ -1,37 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZipWriter = void 0;
-const jszip_1 = __importDefault(require("jszip"));
-/**
- * Zip exporter
- */
-exports.ZipWriter = {
-    name: 'Zip Archive',
-    extensions: ['zip'],
-    category: 'archive',
-    mimeTypes: ['application/zip'],
-    // @ts-ignore
-    encode: encodeZipAsync
-};
-async function encodeZipAsync(fileMap, options = {}) {
-    const jsZip = new jszip_1.default();
-    // add files to the zip
-    for (const subFileName in fileMap) {
-        const subFileData = fileMap[subFileName];
-        // jszip supports both arraybuffer and string data (the main loaders.gl types)
-        // https://stuk.github.io/jszip/documentation/api_zipobject/async.html
-        jsZip.file(subFileName, subFileData, options);
-    }
-    // always generate the full zip as an arraybuffer
-    options = Object.assign({}, options, {
-        type: 'arraybuffer'
-    });
-    const { onUpdate = () => { } } = options;
-    return jsZip.generateAsync(options, onUpdate).catch((error) => {
-        options.log.error(`Unable to write zip archive: ${error}`);
-        throw error;
-    });
-}

package/src/file-provider/data-view-file.ts

@@ -1,72 +0,0 @@
-import {FileProvider} from './file-provider';
-
-/**
- * Checks if bigint can be converted to number and convert it if possible
- * @param bigint bigint to be converted
- * @returns number
- */
-const toNumber = (bigint: bigint) => {
-  if (bigint > Number.MAX_SAFE_INTEGER) {
-    throw new Error('Offset is out of bounds');
-  }
-  return Number(bigint);
-};
-
-/** Provides file data using DataView */
-export class DataViewFile implements FileProvider {
-  /** The DataView from which data is provided */
-  private file: DataView;
-
-  constructor(file: DataView) {
-    this.file = file;
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  async destroy(): Promise<void> {}
-
-  /**
-   * Gets an unsigned 8-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint8(offset: bigint): Promise<number> {
-    return this.file.getUint8(toNumber(offset));
-  }
-
-  /**
-   * Gets an unsigned 16-bit intege at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint16(offset: bigint): Promise<number> {
-    return this.file.getUint16(toNumber(offset), true);
-  }
-
-  /**
-   * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint32(offset: bigint): Promise<number> {
-    return this.file.getUint32(toNumber(offset), true);
-  }
-
-  /**
-   * Gets an unsigned 64-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getBigUint64(offset: bigint): Promise<bigint> {
-    return this.file.getBigUint64(toNumber(offset), true);
-  }
-
-  /**
-   * returns an ArrayBuffer whose contents are a copy of this file bytes from startOffset, inclusive, up to endOffset, exclusive.
-   * @param startOffset The offset, in bytes, from the start of the file where to start reading the data.
-   * @param endOffset The offset, in bytes, from the start of the file where to end reading the data.
-   */
-  async slice(startOffset: bigint, endOffset: bigint): Promise<ArrayBuffer> {
-    return this.file.buffer.slice(toNumber(startOffset), toNumber(endOffset));
-  }
-
-  /** the length (in bytes) of the data. */
-  get length() {
-    return BigInt(this.file.byteLength);
-  }
-}

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

@@ -1,114 +0,0 @@
-import {FileProvider} from '@loaders.gl/zip';
-import {FileHandle} from './file-handle';
-
-/**
- * Provides file data using node fs library
- */
-export class FileHandleFile implements FileProvider {
-  /**
-   * Returns a new copy of FileHandleFile
-   * @param path The path to the file in file system
-   */
-  static async from(path: string): Promise<FileHandleFile> {
-    const fileDescriptor = await FileHandle.open(path);
-    return new FileHandleFile(fileDescriptor, fileDescriptor.stat.size);
-  }
-
-  /**
-   * The FileHandle from which data is provided
-   */
-  private fileDescriptor: FileHandle;
-
-  /**
-   * The file length in bytes
-   */
-  private size: bigint;
-
-  private constructor(fileDescriptor: FileHandle, size: bigint) {
-    this.fileDescriptor = fileDescriptor;
-    this.size = size;
-  }
-
-  /** Close file */
-  async destroy(): Promise<void> {
-    await this.fileDescriptor.close();
-  }
-
-  /**
-   * Gets an unsigned 8-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint8(offset: bigint): Promise<number> {
-    const val = new Uint8Array(
-      (await this.fileDescriptor.read(Buffer.alloc(1), 0, 1, offset)).buffer.buffer
-    ).at(0);
-    if (val === undefined) {
-      throw new Error('something went wrong');
-    }
-    return val;
-  }
-
-  /**
-   * Gets an unsigned 16-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint16(offset: bigint): Promise<number> {
-    const val = new Uint16Array(
-      (await this.fileDescriptor.read(Buffer.alloc(2), 0, 2, offset)).buffer.buffer
-    ).at(0);
-    if (val === undefined) {
-      throw new Error('something went wrong');
-    }
-    return val;
-  }
-
-  /**
-   * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getUint32(offset: bigint): Promise<number> {
-    const val = new Uint32Array(
-      (await this.fileDescriptor.read(Buffer.alloc(4), 0, 4, offset)).buffer.buffer
-    ).at(0);
-    if (val === undefined) {
-      throw new Error('something went wrong');
-    }
-    return val;
-  }
-
-  /**
-   * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  async getBigUint64(offset: bigint): Promise<bigint> {
-    const val = new BigInt64Array(
-      (await this.fileDescriptor.read(Buffer.alloc(8), 0, 8, offset)).buffer.buffer
-    ).at(0);
-    if (val === undefined) {
-      throw new Error('something went wrong');
-    }
-    return val;
-  }
-
-  /**
-   * returns an ArrayBuffer whose contents are a copy of this file bytes from startOffset, inclusive, up to endOffset, exclusive.
-   * @param startOffsset The offset, in byte, from the start of the file where to start reading the data.
-   * @param endOffset The offset, in bytes, from the start of the file where to end reading the data.
-   */
-  async slice(startOffsset: bigint, endOffset: bigint): Promise<ArrayBuffer> {
-    const bigLength = endOffset - startOffsset;
-    if (bigLength > Number.MAX_SAFE_INTEGER) {
-      throw new Error('too big slice');
-    }
-    const length = Number(bigLength);
-    return (await this.fileDescriptor.read(Buffer.alloc(length), 0, length, startOffsset)).buffer
-      .buffer;
-  }
-
-  /**
-   * the length (in bytes) of the data.
-   */
-  get length(): bigint {
-    return this.size;
-  }
-}

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

@@ -1,73 +0,0 @@
-import {read, open, close, stat, BigIntStats} from 'fs';
-
-/** file reading result */
-export type FileReadResult = {
-  /** amount of the bytes read */
-  bytesRead: number;
-  /** the buffer filled with data from file*/
-  buffer: Buffer;
-};
-
-/** Object handling file info */
-export class FileHandle {
-  private fileDescriptor: number;
-  private stats: BigIntStats;
-  private constructor(fileDescriptor: number, stats: BigIntStats) {
-    this.fileDescriptor = fileDescriptor;
-    this.stats = stats;
-  }
-  /**
-   * Opens a `FileHandle`.
-   *
-   * @param path path to the file
-   * @return Fulfills with a {FileHandle} object.
-   */
-
-  static open = async (path: string): Promise<FileHandle> => {
-    const [fd, stats] = await Promise.all([
-      new Promise<number>((s) => {
-        open(path, undefined, undefined, (_err, fd) => s(fd));
-      }),
-      new Promise<BigIntStats>((s) => {
-        stat(path, {bigint: true}, (_err, stats) => s(stats));
-      })
-    ]);
-    return new FileHandle(fd, stats);
-  };
-
-  /** Close file */
-  async close(): Promise<void> {
-    return new Promise<void>((resolve) => {
-      close(this.fileDescriptor, (_err) => resolve());
-    });
-  }
-
-  /**
-   * Reads data from the file and stores that in the given buffer.
-   *
-   * If the file is not modified concurrently, the end-of-file is reached when the
-   * number of bytes read is zero.
-   * @param buffer A buffer that will be filled with the file data read.
-   * @param offset The location in the buffer at which to start filling.
-   * @param length The number of bytes to read.
-   * @param position The location where to begin reading data from the file. If `null`, data will be read from the current file position, and the position will be updated. If `position` is an
-   * integer, the current file position will remain unchanged.
-   * @return Fulfills upon success with a FileReadResult object
-   */
-  read = (
-    buffer: Buffer,
-    offset: number,
-    length: number,
-    position: number | bigint
-  ): Promise<FileReadResult> => {
-    return new Promise((s) => {
-      read(this.fileDescriptor, buffer, offset, length, position, (_err, bytesRead, buffer) =>
-        s({bytesRead, buffer})
-      );
-    });
-  };
-
-  get stat(): BigIntStats {
-    return this.stats;
-  }
-}

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

@@ -1,56 +0,0 @@
-/**
- * Interface for providing file data
- */
-export interface FileProvider {
-  /**
-   * Cleanup class data
-   */
-  destroy(): Promise<void>;
-  /**
-   * Gets an unsigned 8-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  getUint8(offset: bigint): Promise<number>;
-
-  /**
-   * Gets an unsigned 16-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the start of the file where to read the data.
-   */
-  getUint16(offset: bigint): Promise<number>;
-
-  /**
-   * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in bytes, from the file of the view where to read the data.
-   */
-  getUint32(offset: bigint): Promise<number>;
-
-  /**
-   * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
-   * @param offset The offset, in byte, from the file of the view where to read the data.
-   */
-  getBigUint64(offset: bigint): Promise<bigint>;
-
-  /**
-   * returns an ArrayBuffer whose contents are a copy of this file bytes from startOffset, inclusive, up to endOffset, exclusive.
-   * @param startOffset The offset, in bytes, from the start of the file where to start reading the data.
-   * @param endOffset The offset, in bytes, from the start of the file where to end reading the data.
-   */
-  slice(startOffset: bigint, endOffset: bigint): Promise<ArrayBuffer>;
-
-  /**
-   * the length (in bytes) of the data.
-   */
-  length: bigint;
-}
-
-/**
- * Check is the object has FileProvider members
- * @param fileProvider - tested object
- */
-export const isFileProvider = (fileProvider: unknown) => {
-  return (
-    (fileProvider as FileProvider)?.getUint8 &&
-    (fileProvider as FileProvider)?.slice &&
-    (fileProvider as FileProvider)?.length
-  );
-};