@endo/zip/src/reader.js

A minimal, synchronous Zip reader and writer

// @ts-check

import { BufferReader } from './buffer-reader.js';
import { readZip as readZipFormat } from './format-reader.js';

export class ZipReader {
  /**
   * @param {Uint8Array} data
   * @param {object} [options]
   * @param {string} [options.name]
   */
  constructor(data, options = {}) {
    const { name = '<unknown>' } = options;
    // @ts-expect-error missing properties from ArrayBuffer
    const reader = new BufferReader(data);
    this.files = readZipFormat(reader);
    this.name = name;
  }

  /**
   * @param {string} name
   * @returns {Uint8Array}
   */
  read(name) {
    const file = this.files.get(name);
    if (file === undefined) {
      throw Error(`Cannot find file ${name} in Zip file ${this.name}`);
    }
    return file.content;
  }

  /**
   * @param {string} name
   * @returns {import('./types.js').ArchivedStat=}
   */
  stat(name) {
    const file = this.files.get(name);
    if (file === undefined) {
      return undefined;
    }
    return {
      type: file.type,
      mode: file.mode,
      date: file.date,
      comment: file.comment,
    };
  }
}

/**
 * @param {Uint8Array} data
 * @param {string} location
 * @returns {Promise<import('./types.js').ArchiveReader>}
 */
export const readZip = async (data, location) => {
  const reader = new ZipReader(data, { name: location });
  /** @type {import('./types.js').ReadFn} */
  const read = async path => reader.read(path);
  return { read };
};