@zip.js/zip.js 2.8.34 → 2.8.36

package/index.d.cts

@@ -197,6 +197,11 @@ declare class TransformStreamLike {
  */
 export function configure(configuration: Configuration): void;
 
+/**
+ * Restores the default configuration of zip.js
+ */
+export function resetConfiguration(): void;
+
 /**
  * Represents the configuration passed to {@link configure}.
  */
@@ -494,6 +499,16 @@ export class Reader<Type> implements Initializable, ReadableReader {
    * Initializes the instance asynchronously
    */
   init?(): Promise<void>;
+  /**
+   * Creates a `ReadableStream` of the data, optionally restricted to a byte range.
+   *
+   * The default implementation reads the data with {@link Reader#readUint8Array}. Custom readers can
+   * override this method to return a stream provided natively by the underlying data source.
+   *
+   * @param options The options.
+   * @returns The `ReadableStream` instance.
+   */
+  createReadable(options?: CreateReadableOptions): ReadableStream<Uint8Array>;
   /**
    * Reads a chunk of data
    *
@@ -504,6 +519,27 @@ export class Reader<Type> implements Initializable, ReadableReader {
   readUint8Array(index: number, length: number): Promise<Uint8Array>;
 }
 
+/**
+ * Represents the options passed to {@link Reader#createReadable}.
+ */
+export interface CreateReadableOptions {
+  /**
+   * The byte offset of the start of the range to read.
+   *
+   * @defaultValue 0
+   */
+  offset?: number;
+  /**
+   * The size of the range to read in bytes (until the end of the data by default).
+   */
+  size?: number;
+  /**
+   * The size in bytes of the chunks emitted by the default implementation (the `chunkSize` value
+   * of the global configuration by default).
+   */
+  chunkSize?: number;
+}
+
 /**
  * Represents a {@link Reader} instance used to read data provided as a `string`.
  */
@@ -617,6 +653,23 @@ export interface HttpRangeOptions {
    * The HTTP headers.
    */
   headers?: Iterable<[string, string]> | Map<string, string>;
+  /**
+   * `true` to throw an {@link ERR_HTTP_RESOURCE_CHANGED} error when the `ETag`, `Last-Modified` or total size headers
+   * returned by a range request differ from the ones returned by the first range request, i.e. when the resource has
+   * been modified while being read. Headers missing from the responses are ignored, note that `Access-Control-Expose-Headers`
+   * must include them when the resource is fetched cross-origin.
+   *
+   * @defaultValue true
+   */
+  checkResourceChanges?: boolean;
+  /**
+   * The maximum size in bytes of the range requests sent to read the data of an entry. The data is
+   * read with as many range requests as necessary, each response body being streamed, so that the
+   * size of a request never depends on the size of the entry.
+   *
+   * @defaultValue 16777216
+   */
+  maximumRangeSize?: number;
 }
 
 /**
@@ -763,6 +816,10 @@ export class SplitDataWriter implements Initializable, WritableWriter {
    * Initializes the instance asynchronously
    */
   init(): Promise<void>;
+  /**
+   * Closes the disk being written, the next disk being opened when more data is written
+   */
+  closeDisk(): Promise<void>;
   /**
    * Creates the {@link SplitDataWriter} instance
    *
@@ -2729,6 +2786,10 @@ export const fs: {
  * HTTP range error
  */
 export const ERR_HTTP_RANGE: string;
+/**
+ * HTTP resource changed while being read error
+ */
+export const ERR_HTTP_RESOURCE_CHANGED: string;
 /**
  * Zip format error
  */

package/index.d.ts

@@ -197,6 +197,11 @@ declare class TransformStreamLike {
  */
 export function configure(configuration: Configuration): void;
 
+/**
+ * Restores the default configuration of zip.js
+ */
+export function resetConfiguration(): void;
+
 /**
  * Represents the configuration passed to {@link configure}.
  */
@@ -494,6 +499,16 @@ export class Reader<Type> implements Initializable, ReadableReader {
    * Initializes the instance asynchronously
    */
   init?(): Promise<void>;
+  /**
+   * Creates a `ReadableStream` of the data, optionally restricted to a byte range.
+   *
+   * The default implementation reads the data with {@link Reader#readUint8Array}. Custom readers can
+   * override this method to return a stream provided natively by the underlying data source.
+   *
+   * @param options The options.
+   * @returns The `ReadableStream` instance.
+   */
+  createReadable(options?: CreateReadableOptions): ReadableStream<Uint8Array>;
   /**
    * Reads a chunk of data
    *
@@ -504,6 +519,27 @@ export class Reader<Type> implements Initializable, ReadableReader {
   readUint8Array(index: number, length: number): Promise<Uint8Array>;
 }
 
+/**
+ * Represents the options passed to {@link Reader#createReadable}.
+ */
+export interface CreateReadableOptions {
+  /**
+   * The byte offset of the start of the range to read.
+   *
+   * @defaultValue 0
+   */
+  offset?: number;
+  /**
+   * The size of the range to read in bytes (until the end of the data by default).
+   */
+  size?: number;
+  /**
+   * The size in bytes of the chunks emitted by the default implementation (the `chunkSize` value
+   * of the global configuration by default).
+   */
+  chunkSize?: number;
+}
+
 /**
  * Represents a {@link Reader} instance used to read data provided as a `string`.
  */
@@ -617,6 +653,23 @@ export interface HttpRangeOptions {
    * The HTTP headers.
    */
   headers?: Iterable<[string, string]> | Map<string, string>;
+  /**
+   * `true` to throw an {@link ERR_HTTP_RESOURCE_CHANGED} error when the `ETag`, `Last-Modified` or total size headers
+   * returned by a range request differ from the ones returned by the first range request, i.e. when the resource has
+   * been modified while being read. Headers missing from the responses are ignored, note that `Access-Control-Expose-Headers`
+   * must include them when the resource is fetched cross-origin.
+   *
+   * @defaultValue true
+   */
+  checkResourceChanges?: boolean;
+  /**
+   * The maximum size in bytes of the range requests sent to read the data of an entry. The data is
+   * read with as many range requests as necessary, each response body being streamed, so that the
+   * size of a request never depends on the size of the entry.
+   *
+   * @defaultValue 16777216
+   */
+  maximumRangeSize?: number;
 }
 
 /**
@@ -763,6 +816,10 @@ export class SplitDataWriter implements Initializable, WritableWriter {
    * Initializes the instance asynchronously
    */
   init(): Promise<void>;
+  /**
+   * Closes the disk being written, the next disk being opened when more data is written
+   */
+  closeDisk(): Promise<void>;
   /**
    * Creates the {@link SplitDataWriter} instance
    *
@@ -2729,6 +2786,10 @@ export const fs: {
  * HTTP range error
  */
 export const ERR_HTTP_RANGE: string;
+/**
+ * HTTP resource changed while being read error
+ */
+export const ERR_HTTP_RESOURCE_CHANGED: string;
 /**
  * Zip format error
  */