@ismail-elkorchi/bytefold 0.6.0

package/dist/reader/ZipReader.d.ts

@@ -0,0 +1,89 @@
+import type { ZipAuditOptions, ZipAuditReport, ZipEntry, ZipLimits, ZipNormalizeOptions, ZipNormalizeReport, ZipProfile, ZipReaderIterOptions, ZipReaderOpenOptions, ZipReaderOptions, ZipWarning } from '../types.js';
+import { type RandomAccess } from './RandomAccess.js';
+import { type EocdResult } from './eocd.js';
+import { type ZipEntryRecord } from './centralDirectory.js';
+import { type OpenEntryOptions } from './entryStream.js';
+/** Read ZIP archives from bytes, streams, or URLs. */
+export declare class ZipReader {
+    /** @internal */
+    protected readonly profile: ZipProfile;
+    /** @internal */
+    protected readonly strict: boolean;
+    /** @internal */
+    protected readonly limits: Required<ZipLimits>;
+    /** @internal */
+    protected readonly warningsList: ZipWarning[];
+    /** @internal */
+    protected entriesList: ZipEntryRecord[] | null;
+    /** @internal */
+    protected readonly password: string | undefined;
+    /** @internal */
+    protected readonly storeEntries: boolean;
+    /** @internal */
+    protected eocd: EocdResult | null;
+    /** @internal */
+    protected readonly signal: AbortSignal | undefined;
+    /** @internal */
+    protected readonly reader: RandomAccess;
+    /** @internal */
+    protected constructor(reader: RandomAccess, options?: ZipReaderOptions);
+    /** @internal */
+    static fromRandomAccess(reader: RandomAccess, options?: ZipReaderOptions): Promise<ZipReader>;
+    /** Create a reader from in-memory bytes. */
+    static fromUint8Array(data: Uint8Array, options?: ZipReaderOptions): Promise<ZipReader>;
+    /** Create a reader from a readable stream. */
+    static fromStream(stream: ReadableStream<Uint8Array>, options?: ZipReaderOptions): Promise<ZipReader>;
+    /** Create a reader from a URL using HTTP range requests when possible. */
+    static fromUrl(url: string | URL, options?: ZipReaderOptions & {
+        http?: {
+            headers?: Record<string, string>;
+            cache?: {
+                blockSize?: number;
+                maxBlocks?: number;
+            };
+            signal?: AbortSignal;
+            snapshotPolicy?: 'require-strong-etag' | 'best-effort';
+        };
+    }): Promise<ZipReader>;
+    /** Return stored entries (requires shouldStoreEntries=true). */
+    entries(): ZipEntry[];
+    /** Return non-fatal warnings encountered during parsing. */
+    warnings(): ZipWarning[];
+    /** Iterate entries lazily (or from cached entries). */
+    iterEntries(options?: ZipReaderIterOptions): AsyncGenerator<ZipEntry>;
+    /** Iterate entries with a callback. */
+    forEachEntry(fn: (entry: ZipEntry) => void | Promise<void>, options?: ZipReaderIterOptions): Promise<void>;
+    /** Open a decoded stream for an entry. */
+    open(entry: ZipEntry, options?: ZipReaderOpenOptions): Promise<ReadableStream<Uint8Array>>;
+    /** Open a raw (compressed) stream for an entry. */
+    openRaw(entry: ZipEntry, options?: ZipReaderOpenOptions): Promise<ReadableStream<Uint8Array>>;
+    /** @internal */
+    protected openEntryStream(entry: ZipEntryRecord, options: OpenEntryOptions): Promise<ReadableStream<Uint8Array>>;
+    /** Normalize to a writable stream, producing a report. */
+    normalizeToWritable(writable: WritableStream<Uint8Array>, options?: ZipNormalizeOptions): Promise<ZipNormalizeReport>;
+    /** Audit the archive and return a report of issues. */
+    audit(options?: ZipAuditOptions): Promise<ZipAuditReport>;
+    /** Audit and throw if the archive fails the selected profile. */
+    assertSafe(options?: ZipAuditOptions): Promise<void>;
+    /** Release underlying resources held by the reader. */
+    close(): Promise<void>;
+    /** Async dispose hook for using with `using` in supported runtimes. */
+    [Symbol.asyncDispose](): Promise<void>;
+    /** @internal */
+    private init;
+    /** @internal */
+    private loadEntries;
+    /** @internal */
+    private applyEntryLimits;
+    /** @internal */
+    private resolveAuditSettings;
+    /** @internal */
+    private resolveSignal;
+    /** @internal */
+    private normalizeToSink;
+    /** @internal */
+    private collectNormalizedEntries;
+}
+/** @internal */
+export declare function __getZipDefaultsForProfile(profile: ZipProfile): Required<ZipLimits>;
+//# sourceMappingURL=ZipReader.d.ts.map

package/dist/reader/ZipReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ZipReader.d.ts","sourceRoot":"","sources":["../../src/reader/ZipReader.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,eAAe,EACf,cAAc,EACd,QAAQ,EAGR,SAAS,EAET,mBAAmB,EACnB,kBAAkB,EAClB,UAAU,EAEV,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,UAAU,EACX,MAAM,aAAa,CAAC;AACrB,OAAO,EAAwC,KAAK,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE5F,OAAO,EAAY,KAAK,UAAU,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,EAAkC,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAkBzF,sDAAsD;AACtD,qBAAa,SAAS;IACpB,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IACvC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACnC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC/C,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,UAAU,EAAE,CAAM;IACnD,gBAAgB;IAChB,SAAS,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,IAAI,CAAQ;IACtD,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAChD,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IACzC,gBAAgB;IAChB,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAAQ;IACzC,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC;IACnD,gBAAgB;IAChB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAExC,gBAAgB;IAChB,SAAS,aACP,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,gBAAgB;IAY5B,gBAAgB;WACH,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAMnG,4CAA4C;WAC/B,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC;IAO7F,8CAA8C;WACjC,UAAU,CACrB,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAClC,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC,SAAS,CAAC;IAcrB,0EAA0E;WAC7D,OAAO,CAClB,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,OAAO,CAAC,EAAE,gBAAgB,GAAG;QAC3B,IAAI,CAAC,EAAE;YACL,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACjC,KAAK,CAAC,EAAE;gBAAE,SAAS,CAAC,EAAE,MAAM,CAAC;gBAAC,SAAS,CAAC,EAAE,MAAM,CAAA;aAAE,CAAC;YACnD,MAAM,CAAC,EAAE,WAAW,CAAC;YACrB,cAAc,CAAC,EAAE,qBAAqB,GAAG,aAAa,CAAC;SACxD,CAAC;KACH,GACA,OAAO,CAAC,SAAS,CAAC;IAiBrB,gEAAgE;IAChE,OAAO,IAAI,QAAQ,EAAE;IAWrB,4DAA4D;IAC5D,QAAQ,IAAI,UAAU,EAAE;IAIxB,uDAAuD;IAChD,WAAW,CAAC,OAAO,CAAC,EAAE,oBAAoB,GAAG,cAAc,CAAC,QAAQ,CAAC;IAqC5E,uCAAuC;IACjC,YAAY,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMhH,0CAA0C;IACpC,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAqBhG,mDAAmD;IAC7C,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IASnG,gBAAgB;cACA,eAAe,CAC7B,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAItC,0DAA0D;IACpD,mBAAmB,CACvB,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,EACpC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,kBAAkB,CAAC;IAK9B,uDAAuD;IACjD,KAAK,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAmV/D,iEAAiE;IAC3D,UAAU,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAY1D,uDAAuD;IACjD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,uEAAuE;IACjE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5C,gBAAgB;YACF,IAAI;IAgBlB,gBAAgB;YACF,WAAW;IAOzB,gBAAgB;IAChB,OAAO,CAAC,gBAAgB;IAsBxB,gBAAgB;IAChB,OAAO,CAAC,oBAAoB;IAuB5B,gBAAgB;IAChB,OAAO,CAAC,aAAa;IAIrB,gBAAgB;YACF,eAAe;IAoS7B,gBAAgB;YACF,wBAAwB;CA8JvC;AAoMD,gBAAgB;AAChB,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAEnF"}