@loaders.gl/zip 4.1.0-alpha.1 → 4.1.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/zip",
-  "version": "4.1.0-alpha.1",
+  "version": "4.1.0-alpha.3",
   "description": "Zip Archive Loader",
   "license": "MIT",
   "type": "module",
@@ -38,11 +38,11 @@
     "build-bundle": "ocular-bundle ./src/index.ts"
   },
   "dependencies": {
-    "@loaders.gl/compression": "4.1.0-alpha.1",
-    "@loaders.gl/crypto": "4.1.0-alpha.1",
-    "@loaders.gl/loader-utils": "4.1.0-alpha.1",
+    "@loaders.gl/compression": "4.1.0-alpha.3",
+    "@loaders.gl/crypto": "4.1.0-alpha.3",
+    "@loaders.gl/loader-utils": "4.1.0-alpha.3",
     "jszip": "^3.1.5",
     "md5": "^2.3.0"
   },
-  "gitHead": "6a4d3da93d45115ad99861474a43c3f4a0b280a7"
+  "gitHead": "b78075a7cb8d4ecd4aac84805ce74b8ceb400cf7"
 }

package/src/filesystems/zip-filesystem.ts

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

package/src/hash-file-utility.ts

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

package/src/index.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 export {ZipLoader} from './zip-loader';
@@ -13,7 +14,8 @@ export {
 } from './parse-zip/cd-file-header';
 export {
   parseZipLocalFileHeader,
-  signature as localHeaderSignature
+  signature as localHeaderSignature,
+  generateLocalHeader
 } from './parse-zip/local-file-header';
 export {parseEoCDRecord} from './parse-zip/end-of-central-directory';
 export {searchFromTheEnd} from './parse-zip/search-from-the-end';

package/src/lib/tar/header.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // This file is derived from the tar-js code base under MIT license

package/src/lib/tar/tar.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // This file is derived from the tar-js code base under MIT license

package/src/lib/tar/types.ts

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

package/src/lib/tar/utils.ts

@@ -1,4 +1,5 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 // This file is derived from the tar-js code base under MIT license

package/src/parse-zip/cd-file-header.ts

@@ -1,10 +1,11 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
 import {FileProvider, compareArrayBuffers, concatenateArrayBuffers} from '@loaders.gl/loader-utils';
 import {parseEoCDRecord} from './end-of-central-directory';
 import {ZipSignature} from './search-from-the-end';
-import {createZip64Info, NUMBER_SETTERS} from './zip64-info-generation';
+import {createZip64Info, setFieldToNumber} from './zip64-info-generation';
 
 /**
  * zip central directory file header info
@@ -233,8 +234,9 @@ export function generateCDHeader(options: GenerateCDOptions): ArrayBuffer {
   const header = new DataView(new ArrayBuffer(46));
 
   for (const field of ZIP_HEADER_FIELDS) {
-    NUMBER_SETTERS[field.size](
+    setFieldToNumber(
       header,
+      field.size,
       field.offset,
       optionsToUse[field.name ?? ''] ?? field.default ?? 0
     );

package/src/parse-zip/end-of-central-directory.ts

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

package/src/parse-zip/local-file-header.ts

@@ -1,8 +1,10 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import {FileProvider, compareArrayBuffers} from '@loaders.gl/loader-utils';
+import {FileProvider, compareArrayBuffers, concatenateArrayBuffers} from '@loaders.gl/loader-utils';
 import {ZipSignature} from './search-from-the-end';
+import {createZip64Info, setFieldToNumber} from './zip64-info-generation';
 
 /**
  * zip local file header info
@@ -94,3 +96,127 @@ export const parseZipLocalFileHeader = async (
     compressionMethod
   };
 };
+
+/** info that can be placed into cd header */
+type GenerateLocalOptions = {
+  /** CRC-32 of uncompressed data */
+  crc32: number;
+  /** File name */
+  fileName: string;
+  /** File size */
+  length: number;
+};
+
+/**
+ * generates local header for the file
+ * @param options info that can be placed into local header
+ * @returns buffer with header
+ */
+export function generateLocalHeader(options: GenerateLocalOptions): ArrayBuffer {
+  const optionsToUse = {
+    ...options,
+    extraLength: 0,
+    fnlength: options.fileName.length
+  };
+
+  let zip64header: ArrayBuffer = new ArrayBuffer(0);
+
+  const optionsToZip64: any = {};
+  if (optionsToUse.length >= 0xffffffff) {
+    optionsToZip64.size = optionsToUse.length;
+    optionsToUse.length = 0xffffffff;
+  }
+
+  if (Object.keys(optionsToZip64).length) {
+    zip64header = createZip64Info(optionsToZip64);
+    optionsToUse.extraLength = zip64header.byteLength;
+  }
+
+  // base length without file name and extra info is static
+  const header = new DataView(new ArrayBuffer(Number(FILE_NAME_OFFSET)));
+
+  for (const field of ZIP_HEADER_FIELDS) {
+    setFieldToNumber(
+      header,
+      field.size,
+      field.offset,
+      optionsToUse[field.name ?? ''] ?? field.default ?? 0
+    );
+  }
+
+  const encodedName = new TextEncoder().encode(optionsToUse.fileName);
+
+  const resHeader = concatenateArrayBuffers(header.buffer, encodedName, zip64header);
+
+  return resHeader;
+}
+
+const ZIP_HEADER_FIELDS = [
+  // Local file header signature = 0x04034b50
+  {
+    offset: 0,
+    size: 4,
+    default: new DataView(signature.buffer).getUint32(0, true)
+  },
+  // Version needed to extract (minimum)
+  {
+    offset: 4,
+    size: 2,
+    default: 45
+  },
+  // General purpose bit flag
+  {
+    offset: 6,
+    size: 2,
+    default: 0
+  },
+  // Compression method
+  {
+    offset: 8,
+    size: 2,
+    default: 0
+  },
+  // File last modification time
+  {
+    offset: 10,
+    size: 2,
+    default: 0
+  },
+  // File last modification date
+  {
+    offset: 12,
+    size: 2,
+    default: 0
+  },
+  // CRC-32 of uncompressed data
+  {
+    offset: 14,
+    size: 4,
+    name: 'crc32'
+  },
+  // Compressed size (or 0xffffffff for ZIP64)
+  {
+    offset: 18,
+    size: 4,
+    name: 'length'
+  },
+  // Uncompressed size (or 0xffffffff for ZIP64)
+  {
+    offset: 22,
+    size: 4,
+    name: 'length'
+  },
+  // File name length (n)
+  {
+    offset: 26,
+    size: 2,
+    name: 'fnlength'
+  },
+  // Extra field length (m)
+  {
+    offset: 28,
+    size: 2,
+    default: 0,
+    name: 'extraLength'
+  }
+];

package/src/parse-zip/search-from-the-end.ts

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

package/src/parse-zip/zip64-info-generation.ts

@@ -41,15 +41,31 @@ export function createZip64Info(options: Zip64Options): ArrayBuffer {
  * @param offset offset of the writing start
  * @param value value to be written
  */
-type NumberSetter = (header: DataView, offset: number, value: number) => void;
+type NumberSetter = (header: DataView, offset: number, value: number | bigint) => void;
+
+/**
+ * Writes values into buffer according to the bytes amount
+ * @param header header where to write the data
+ * @param fieldSize size of the field in bytes
+ * @param fieldOffset offset of the field
+ * @param value value to be written
+ */
+export function setFieldToNumber(
+  header: DataView,
+  fieldSize: number,
+  fieldOffset: number,
+  value: number | bigint
+): void {
+  NUMBER_SETTERS[fieldSize](header, fieldOffset, value);
+}
 
 /** functions to write values into buffer according to the bytes amount */
-export const NUMBER_SETTERS: {[key: number]: NumberSetter} = {
+const NUMBER_SETTERS: {[key: number]: NumberSetter} = {
   2: (header, offset, value) => {
-    header.setUint16(offset, value, true);
+    header.setUint16(offset, Number(value), true);
   },
   4: (header, offset, value) => {
-    header.setUint32(offset, value, true);
+    header.setUint32(offset, Number(value), true);
   },
   8: (header, offset, value) => {
     header.setBigUint64(offset, BigInt(value), true);

package/src/tar-builder.ts

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

package/src/zip-loader.ts

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

package/src/zip-writer.ts

@@ -1,9 +1,13 @@
-// loaders.gl, MIT license
+// loaders.gl
+// SPDX-License-Identifier: MIT
 // Copyright (c) vis.gl contributors
 
-import type {Writer, WriterOptions} from '@loaders.gl/loader-utils';
+import type {WriterWithEncoder, WriterOptions} from '@loaders.gl/loader-utils';
 import JSZip, {JSZipGeneratorOptions} from 'jszip';
 
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
 export type ZipWriterOptions = WriterOptions & {
   zip?: {
     onUpdate?: (metadata: {percent: number}) => void;
@@ -15,19 +19,27 @@ export type ZipWriterOptions = WriterOptions & {
 /**
  * Zip exporter
  */
-export const ZipWriter: Writer<FileReaderEventMap, never, ZipWriterOptions> = {
+export const ZipWriter: WriterWithEncoder<Record<string, ArrayBuffer>, never, ZipWriterOptions> = {
   name: 'Zip Archive',
+  id: 'zip',
+  module: 'zip',
+  version: VERSION,
   extensions: ['zip'],
   category: 'archive',
   mimeTypes: ['application/zip'],
-  // @ts-ignore
+  options: {
+    zip: {
+      onUpdate: () => {}
+    },
+    jszip: {}
+  },
   encode: encodeZipAsync
 };
 
 async function encodeZipAsync(
   fileMap: Record<string, ArrayBuffer>,
   options: ZipWriterOptions = {}
-) {
+): Promise<ArrayBuffer> {
   const jsZip = new JSZip();
   // add files to the zip
   for (const subFileName in fileMap) {
@@ -38,14 +50,16 @@ async function encodeZipAsync(
     jsZip.file(subFileName, subFileData, options?.jszip || {});
   }
 
-  // always generate the full zip as an arraybuffer
-  const jszipOptions: JSZipGeneratorOptions = {...options?.jszip, type: 'arraybuffer'};
-  const {onUpdate = () => {}} = options;
+  const zipOptions = {...ZipWriter.options.zip, ...options?.zip};
+  const jszipOptions: JSZipGeneratorOptions = {...ZipWriter.options?.jszip, ...options.jszip};
 
   try {
-    return await jsZip.generateAsync(jszipOptions, onUpdate);
+    return await jsZip.generateAsync(
+      {...jszipOptions, type: 'arraybuffer'}, // generate an arraybuffer
+      zipOptions.onUpdate
+    );
   } catch (error) {
-    options.log.error(`Unable to write zip archive: ${error}`);
+    options.log.error(`Unable to encode zip archive: ${error}`);
     throw error;
   }
 }