@patrickdk77/archive-defuse 0.0.0-stage → 0.1.0

package/dist/engine.d.ts

@@ -0,0 +1,44 @@
+import type { Entry, Meter } from './model';
+import { type ArchiveDisarmResult, type ArchiveInspection, type ArchiveOptions, type ByteSink, type ByteSource, type PluginContext } from './types';
+export declare const DEFAULT_LIMITS: {
+    entries: number;
+    decompressedBytes: number;
+    totalDecompressedBytes: number;
+    compressionRatio: number;
+    nestingDepth: number;
+    dictionaryBytes: number;
+};
+/** The key under which archive-defuse hands its run's options to a plugin. No other package can name it. */
+export declare const RUN_OPTIONS: unique symbol;
+/** A plugin context as archive-defuse makes it. */
+export type RunContext = PluginContext & {
+    [RUN_OPTIONS]?: ArchiveOptions;
+};
+/** The passwords to try on an encrypted entry, in order, with the empty password last. */
+export declare const passwordsOf: (options: ArchiveOptions) => string[];
+/** The limits of a run, with the defaults filled in. */
+export declare const limitsOf: (options: ArchiveOptions) => typeof DEFAULT_LIMITS & {
+    fileSize?: number;
+    timeMs?: number;
+};
+/** A meter for one entry: its own decoded size, the run's total, the ratio, and the deadline. */
+export declare function makeMeter(e: Entry, limits: typeof DEFAULT_LIMITS, deadline: number | undefined, totals: {
+    decoded: number;
+}): Meter & {
+    total: number;
+};
+/** Inspects an archive without changing it. The source is closed when the run ends. */
+export declare function inspectArchiveSource(source: ByteSource, options?: ArchiveOptions): Promise<ArchiveInspection>;
+/**
+ * Writes a defused copy of `source` to `sink`. Nothing reaches the sink unless the output passes inspection. The
+ * source is closed when the run ends.
+ */
+export declare function disarmArchiveSource(source: ByteSource, sink: ByteSink, options?: ArchiveOptions): Promise<ArchiveDisarmResult>;
+/** Internal entry that carries the nesting depth for archives inside other files, and the deadline they share with the upload. */
+export declare function disarmAtDepth(source: ByteSource, sink: ByteSink, options: ArchiveOptions, depth: number, deadline?: number | undefined): Promise<ArchiveDisarmResult>;
+/** Inspects archive bytes. */
+export declare function inspectArchive(bytes: Uint8Array, options?: ArchiveOptions): Promise<ArchiveInspection>;
+/** Defuses archive bytes. `bytes` holds the output unless the archive was rejected. */
+export declare function disarmArchive(bytes: Uint8Array, options?: ArchiveOptions): Promise<ArchiveDisarmResult & {
+    bytes?: Uint8Array;
+}>;