@stigmer/zip-structure 3.13.0

package/LICENSE

@@ -0,0 +1,190 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Stigmer Contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/index.d.ts

@@ -0,0 +1,2 @@
+export { EOCD_MIN_SIZE, crc32, parseZipStructure, type ZipStructuralEntry, } from "./zip-structure.js";
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,KAAK,EACL,iBAAiB,EACjB,KAAK,kBAAkB,GACxB,MAAM,oBAAoB,CAAC"}

package/index.js

@@ -0,0 +1,2 @@
+export { EOCD_MIN_SIZE, crc32, parseZipStructure, } from "./zip-structure.js";
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,KAAK,EACL,iBAAiB,GAElB,MAAM,oBAAoB,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@stigmer/zip-structure",
+  "version": "3.13.0",
+  "description": "Policy-free structural ZIP parsing shared by Stigmer's TypeScript processes — central-directory-based entry enumeration (never local-header walks) plus the byte-level archive builder its consumers' tests craft fixtures with",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stigmer/stigmer.git",
+    "directory": "backend/libs/ts/zip-structure"
+  },
+  "engines": {
+    "node": "^22.13.0 || >=23.4.0"
+  },
+  "keywords": [
+    "stigmer",
+    "zip",
+    "central-directory",
+    "structural-parsing"
+  ],
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    },
+    "./testing": {
+      "types": "./testing.d.ts",
+      "import": "./testing.js",
+      "default": "./testing.js"
+    }
+  }
+}

package/src/__tests__/zip-structure.test.ts

@@ -0,0 +1,124 @@
+/**
+ * The structural layer's own suite. Until the lib extraction this module
+ * was tested only through its consumers (the runner's zip-extract and
+ * attachment-injector suites); per ci.ts-libs' contract a lib change must
+ * fail attributably here even when no consumer file moved.
+ */
+import { inflateRawSync } from "node:zlib";
+import { describe, expect, it } from "vitest";
+
+import { buildZip } from "../testing.js";
+import { parseZipStructure } from "../zip-structure.js";
+
+function text(bytes: Uint8Array): string {
+  return new TextDecoder().decode(bytes);
+}
+
+describe("parseZipStructure", () => {
+  it("enumerates stored entries with names, sizes, and payload views", () => {
+    const zip = buildZip([
+      { name: "SKILL.md", content: "# Skill" },
+      { name: "references/schema.md", content: "tables" },
+    ]);
+
+    const entries = parseZipStructure(zip);
+    expect(entries).toHaveLength(2);
+    expect(entries[0]!.name).toBe("SKILL.md");
+    expect(entries[0]!.compressionMethod).toBe(0);
+    expect(entries[0]!.uncompressedSize).toBe("# Skill".length);
+    expect(entries[0]!.compressedSize).toBe("# Skill".length);
+    expect(text(entries[0]!.compressedData)).toBe("# Skill");
+    expect(entries[1]!.name).toBe("references/schema.md");
+  });
+
+  it("inflates a deflated entry's payload back to the original bytes", () => {
+    const content = "compressed with deflate, long enough to actually shrink ".repeat(8);
+    const zip = buildZip([{ name: "notes.txt", content, method: "deflated" }]);
+
+    const [entry] = parseZipStructure(zip);
+    expect(entry!.compressionMethod).toBe(8);
+    expect(text(new Uint8Array(inflateRawSync(entry!.compressedData)))).toBe(content);
+  });
+
+  it("reads sizes from the central directory for streaming entries (zeroed local headers, #450)", () => {
+    const content = "streamed by Go's archive/zip writer";
+    const zip = buildZip([{ name: "streamed.md", content, streaming: true }]);
+
+    const [entry] = parseZipStructure(zip);
+    expect(entry!.uncompressedSize).toBe(content.length);
+    expect(text(entry!.compressedData)).toBe(content);
+  });
+
+  it("marks directory entries", () => {
+    const zip = buildZip([
+      { name: "references/", content: "" },
+      { name: "references/data.md", content: "data" },
+    ]);
+
+    const entries = parseZipStructure(zip);
+    expect(entries[0]!.isDirectory).toBe(true);
+    expect(entries[1]!.isDirectory).toBe(false);
+  });
+
+  it("locates the EOCD behind a trailing archive comment", () => {
+    const zip = buildZip([{ name: "a.md", content: "a" }], { comment: "trailing comment" });
+    expect(parseZipStructure(zip)).toHaveLength(1);
+  });
+
+  it("is not fooled by EOCD signature bytes inside the comment", () => {
+    // The four signature bytes ("PK\x05\x06") occur INSIDE the comment; a
+    // signature-only scan would lock onto them and misparse. The parser
+    // requires the candidate record to point at a real central directory.
+    const zip = buildZip([{ name: "a.md", content: "a" }], {
+      comment: "x PK\x05\x06 y padding padding padding",
+    });
+    const entries = parseZipStructure(zip);
+    expect(entries).toHaveLength(1);
+    expect(entries[0]!.name).toBe("a.md");
+  });
+
+  it("parses a genuinely empty archive to zero entries", () => {
+    const zip = buildZip([]);
+    expect(parseZipStructure(zip)).toEqual([]);
+  });
+
+  it("throws when the central directory and EOCD are missing (truncated download)", () => {
+    const zip = buildZip([{ name: "a.md", content: "a" }], { omitCentralDirectory: true });
+    expect(() => parseZipStructure(zip)).toThrow("no end-of-central-directory record found");
+  });
+
+  it("throws on a corrupted central directory record", () => {
+    const zip = buildZip([{ name: "a.md", content: "a" }]);
+    // The EOCD's central-directory-offset field (u32 at EOCD+16) locates the
+    // record; corrupt the record's signature byte behind it. The EOCD scan
+    // then rejects the record (directoryLooksReal fails) and no other valid
+    // EOCD exists.
+    const view = new DataView(zip.buffer, zip.byteOffset, zip.byteLength);
+    const eocdPos = zip.length - 22; // no comment in this fixture
+    const cdOffset = view.getUint32(eocdPos + 16, true);
+    zip[cdOffset] = 0x00;
+    expect(() => parseZipStructure(zip)).toThrow("no end-of-central-directory record found");
+  });
+
+  it("exposes versionMadeBy and externalAttributes verbatim for policy layers", () => {
+    // A Unix-creator entry carrying a POSIX mode in the attribute high bits
+    // (0o120777 = a symlink) — the raw facts the server's safearchive-parity
+    // pre-filter decodes. The structural layer must not interpret them.
+    const symlinkMode = (0o120777 << 16) >>> 0;
+    const zip = buildZip([
+      {
+        name: "link",
+        content: "target",
+        versionMadeBy: 0x0314, // high byte 3 = Unix, low byte 20
+        externalAttributes: symlinkMode,
+      },
+      { name: "plain.md", content: "plain" },
+    ]);
+
+    const entries = parseZipStructure(zip);
+    expect(entries[0]!.versionMadeBy).toBe(0x0314);
+    expect(entries[0]!.externalAttributes).toBe(symlinkMode);
+    expect(entries[1]!.versionMadeBy).toBe(20);
+    expect(entries[1]!.externalAttributes).toBe(0);
+  });
+});

package/src/index.ts

@@ -0,0 +1,6 @@
+export {
+  EOCD_MIN_SIZE,
+  crc32,
+  parseZipStructure,
+  type ZipStructuralEntry,
+} from "./zip-structure.js";

package/src/testing.ts

@@ -0,0 +1,205 @@
+/**
+ * Byte-level ZIP fixture builder for the structural parser's consumers'
+ * tests (exported as `@stigmer/zip-structure/testing`). Moved here from the
+ * runner's src/__test-utils__/zip-fixtures.ts when the lib was extracted —
+ * the lib's own tests, the runner's, and the TS server's skill-gate tests
+ * all craft archives with it, and one builder keeps their fixture shapes
+ * from drifting apart.
+ *
+ * Emits complete, real-shaped archives — local file headers (optionally
+ * streaming-style, the Go stdlib writer's default), payloads, central
+ * directory, and EOCD — because that is the only shape that can reach the
+ * runner: both editions' skill push gates validate artifacts with
+ * central-directory-based readers (see zip-structure.ts's module doc).
+ * Earlier fixtures emitted local headers only, a shape no real ZIP writer
+ * produces, and were coupled to the old parser's front-to-back walk.
+ *
+ * Mirrors the conformance suite's `zipFilesStreaming()`
+ * (test/conformance/src/support/skills.ts) so unit fixtures and
+ * cross-edition fixtures share one shape.
+ */
+
+import { deflateRawSync } from "node:zlib";
+
+import { crc32 } from "./zip-structure.js";
+
+export interface ZipFixtureFile {
+  name: string;
+  /** Text content is UTF-8 encoded; pass bytes directly for binary payloads. */
+  content: string | Uint8Array;
+  /** Compression method for the entry. Defaults to stored. */
+  method?: "stored" | "deflated";
+  /**
+   * Emit the entry the way Go's archive/zip does by default: general-purpose
+   * flag bit 3 set, zeroed sizes in the local header, and a trailing data
+   * descriptor (with the conventional signature) carrying the real values.
+   */
+  streaming?: boolean;
+  /**
+   * Lie about the entry's uncompressed size everywhere the writer would
+   * declare it (local header, data descriptor, central directory). Models a
+   * crafted archive whose declarations disagree with its actual payload —
+   * the input class the attachment injector's declared-size enforcement
+   * exists to reject (issue #567).
+   */
+  declaredUncompressedSize?: number;
+  /**
+   * The central directory's "version made by" field. Defaults to 20
+   * (MS-DOS creator, the historical fixture value). Set the high byte to
+   * 3 (`0x0300 | 20`) to model a Unix creator, which makes readers
+   * interpret `externalAttributes`' high 16 bits as a POSIX mode — how
+   * symlink and device entries are represented (the server's
+   * safearchive-parity pre-filter fixtures need this).
+   */
+  versionMadeBy?: number;
+  /** The central directory's external file attributes field. Defaults to 0. */
+  externalAttributes?: number;
+}
+
+export interface ZipFixtureOptions {
+  /** Trailing archive comment appended after the EOCD record. */
+  comment?: string;
+  /**
+   * Drop the central directory and EOCD, leaving only local headers and
+   * payloads. No real ZIP writer produces this shape — it models a download
+   * truncated before the archive's index.
+   */
+  omitCentralDirectory?: boolean;
+}
+
+/** Build a ZIP archive from path + content pairs. */
+export function buildZip(files: ZipFixtureFile[], options?: ZipFixtureOptions): Uint8Array {
+  const out = new ByteWriter();
+
+  interface WrittenEntry {
+    nameBytes: Uint8Array;
+    payload: Uint8Array;
+    declaredUncompressed: number;
+    crc: number;
+    flags: number;
+    method: number;
+    versionMadeBy: number;
+    externalAttributes: number;
+    localHeaderOffset: number;
+  }
+  const written: WrittenEntry[] = [];
+
+  for (const file of files) {
+    const contentBytes =
+      typeof file.content === "string" ? new TextEncoder().encode(file.content) : file.content;
+    const deflated = file.method === "deflated";
+    const payload = deflated ? new Uint8Array(deflateRawSync(contentBytes)) : contentBytes;
+    const entry: WrittenEntry = {
+      nameBytes: new TextEncoder().encode(file.name),
+      payload,
+      declaredUncompressed: file.declaredUncompressedSize ?? contentBytes.length,
+      crc: crc32(contentBytes),
+      flags: file.streaming ? 0x0008 : 0,
+      method: deflated ? 8 : 0,
+      versionMadeBy: file.versionMadeBy ?? 20,
+      externalAttributes: file.externalAttributes ?? 0,
+      localHeaderOffset: out.length,
+    };
+    written.push(entry);
+
+    out.u32(0x04034b50); // local file header signature
+    out.u16(20); // version needed to extract
+    out.u16(entry.flags);
+    out.u16(entry.method);
+    out.u16(0); // mod time
+    out.u16(0); // mod date
+    out.u32(file.streaming ? 0 : entry.crc);
+    out.u32(file.streaming ? 0 : payload.length);
+    out.u32(file.streaming ? 0 : entry.declaredUncompressed);
+    out.u16(entry.nameBytes.length);
+    out.u16(0); // extra field length
+    out.raw(entry.nameBytes);
+    out.raw(payload);
+
+    if (file.streaming) {
+      out.u32(0x08074b50); // data descriptor signature (Go writes it)
+      out.u32(entry.crc);
+      out.u32(payload.length);
+      out.u32(entry.declaredUncompressed);
+    }
+  }
+
+  if (options?.omitCentralDirectory) {
+    return out.toUint8Array();
+  }
+
+  const centralDirectoryOffset = out.length;
+  for (const entry of written) {
+    out.u32(0x02014b50); // central directory record signature
+    out.u16(entry.versionMadeBy);
+    out.u16(20); // version needed to extract
+    out.u16(entry.flags);
+    out.u16(entry.method);
+    out.u16(0); // mod time
+    out.u16(0); // mod date
+    out.u32(entry.crc);
+    out.u32(entry.payload.length);
+    out.u32(entry.declaredUncompressed);
+    out.u16(entry.nameBytes.length);
+    out.u16(0); // extra field length
+    out.u16(0); // comment length
+    out.u16(0); // disk number start
+    out.u16(0); // internal attributes
+    out.u32(entry.externalAttributes);
+    out.u32(entry.localHeaderOffset);
+    out.raw(entry.nameBytes);
+  }
+  const centralDirectorySize = out.length - centralDirectoryOffset;
+
+  const commentBytes = new TextEncoder().encode(options?.comment ?? "");
+  out.u32(0x06054b50); // EOCD signature
+  out.u16(0); // disk number
+  out.u16(0); // disk with central directory
+  out.u16(written.length); // entries on this disk
+  out.u16(written.length); // total entries
+  out.u32(centralDirectorySize);
+  out.u32(centralDirectoryOffset);
+  out.u16(commentBytes.length);
+  out.raw(commentBytes);
+
+  return out.toUint8Array();
+}
+
+// Chunked assembly instead of a number[]-per-byte accumulator: fixtures at
+// the injector's 100 MB zip-bomb limit are built from payload-sized chunks,
+// which a per-byte spread-push cannot survive (argument-count overflow).
+class ByteWriter {
+  private readonly chunks: Uint8Array[] = [];
+  private size = 0;
+
+  get length(): number {
+    return this.size;
+  }
+
+  u16(v: number): void {
+    this.raw(new Uint8Array([v & 0xff, (v >>> 8) & 0xff]));
+  }
+
+  u32(v: number): void {
+    this.raw(new Uint8Array([v & 0xff, (v >>> 8) & 0xff, (v >>> 16) & 0xff, (v >>> 24) & 0xff]));
+  }
+
+  raw(b: Uint8Array): void {
+    this.chunks.push(b);
+    this.size += b.length;
+  }
+
+  toUint8Array(): Uint8Array {
+    const result = new Uint8Array(this.size);
+    let offset = 0;
+    for (const chunk of this.chunks) {
+      result.set(chunk, offset);
+      offset += chunk.length;
+    }
+    return result;
+  }
+}
+
+// CRC-32 comes from the structural module (one implementation for the
+// parser's consumers and this builder; semantically identical to the
+// conformance suite's inline bit-loop helper).