@stll/folio-core 0.64.1 → 0.65.0

package/dist/docx/packageParts.js

@@ -1,6 +1,5 @@
-import { decodeText, encodeUtf8 } from "../utils/textEncoding.js";
+import { decodeText } from "../utils/textEncoding.js";
 import { Result } from "better-result";
-import { writeZipPart } from "@stll/docx-core/zip";
 // src/docx/packageParts.ts
 /**
 * What a repack carries out of the source package, and the guarantee that
@@ -99,11 +98,11 @@ const isUnsafePackagePath = (path) => {
 };
 /** Drop the entries whose path a save refuses. Every other part survives. */
 const removeUnsafeEntries = (zip) => {
-	for (const [path, file] of Object.entries(zip.files)) if (!file.dir && isUnsafePackagePath(path)) zip.remove(path);
+	for (const path of zip.paths()) if (isUnsafePackagePath(path)) zip.delete(path);
 };
 const presentPartPaths = (zip) => {
 	const present = /* @__PURE__ */ new Set();
-	for (const [path, file] of Object.entries(zip.files)) if (!file.dir) present.add(normalizePartPath(path));
+	for (const path of zip.paths()) present.add(normalizePartPath(path));
 	return present;
 };
 const isPresent = (present, partPath) => present.has(normalizePartPath(partPath)) || present.has(normalizePartPath(decodePartName(partPath) ?? ""));
@@ -121,25 +120,18 @@ const relationshipTarget = (element, relsPath) => {
 */
 const readRelationshipParts = async (zip) => {
 	const parts = [];
-	for (const [path, file] of Object.entries(zip.files)) {
-		if (file.dir || !normalizePartPath(path).endsWith(".rels")) continue;
+	for (const file of zip.entries()) {
+		const { path } = file;
+		if (!normalizePartPath(path).endsWith(".rels")) continue;
 		parts.push({
 			path,
-			xml: await file.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }))
+			xml: await file.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }))
 		});
 	}
 	return parts;
 };
 const writePart = ({ zip, path, xml, compressionLevel }) => {
-	writeZipPart({
-		zip,
-		path,
-		data: encodeUtf8(xml),
-		options: {
-			compression: "DEFLATE",
-			compressionOptions: { level: compressionLevel }
-		}
-	});
+	zip.set(path, xml, { level: compressionLevel });
 };
 /**
 * Make the package internally consistent before it is written: every internal
@@ -183,11 +175,11 @@ const reconcilePackageReferences = async (zip, compressionLevel) => {
 		});
 	}
 	for (const [partPath, ids] of removedIdsByOwningPart) {
-		const file = zip.file(partPath);
+		const file = zip.entry(partPath);
 		if (!file) continue;
 		const idPattern = [...ids].map((id) => escapeRegExp(id)).join("|");
 		const referencePattern = new RegExp(`\\s+r:[A-Za-z]+\\s*=\\s*(?<quote>["'])(?<id>${idPattern})\\k<quote>`, "gu");
-		const xml = await file.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }));
+		const xml = await file.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }));
 		const removedIds = /* @__PURE__ */ new Set();
 		const scrubbed = xml.replaceAll(referencePattern, (...args) => {
 			const groups = args.at(-1);
@@ -204,10 +196,10 @@ const reconcilePackageReferences = async (zip, compressionLevel) => {
 			for (const id of removedIds) repair.orphanedIdReferences.push(`${partPath}|${id}`);
 		}
 	}
-	const contentTypes = zip.file(CONTENT_TYPES_PATTERN)[0];
+	const contentTypes = zip.entries().find(({ path }) => CONTENT_TYPES_PATTERN.test(path));
 	if (!contentTypes) return repair;
 	let droppedOverride = false;
-	const prunedContentTypes = (await contentTypes.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }))).replaceAll(CONTENT_TYPE_ELEMENT, (element) => {
+	const prunedContentTypes = (await contentTypes.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }))).replaceAll(CONTENT_TYPE_ELEMENT, (element) => {
 		const partName = PART_NAME_ATTRIBUTE.exec(element)?.groups?.["value"];
 		if (partName === void 0 || isPresent(present, partName)) return element;
 		repair.danglingOverrides.push(normalizePartPath(decodePartName(partName) ?? partName));
@@ -216,7 +208,7 @@ const reconcilePackageReferences = async (zip, compressionLevel) => {
 	});
 	if (droppedOverride) writePart({
 		zip,
-		path: contentTypes.name,
+		path: contentTypes.path,
 		xml: prunedContentTypes,
 		compressionLevel
 	});
@@ -255,9 +247,10 @@ const checkPackageIntegrity = async (zip) => {
 		}
 		if (owningPart !== void 0) idsByOwningPart.set(owningPart, ids);
 	}
-	for (const [path, file] of Object.entries(zip.files)) {
-		if (file.dir || !normalizePartPath(path).endsWith(".xml")) continue;
-		const xml = await file.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }));
+	for (const file of zip.entries()) {
+		const { path } = file;
+		if (!normalizePartPath(path).endsWith(".xml")) continue;
+		const xml = await file.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }));
 		const ids = idsByOwningPart.get(path);
 		for (const match of xml.matchAll(REFERENCE_ATTRIBUTE)) {
 			const id = match.groups?.["id"];

package/dist/docx/parser.js

@@ -37,7 +37,7 @@ import { parseSettings } from "./settingsParser.js";
 import { parseStylesPackage } from "./styleParser.js";
 import { applyThemeFontLang, parseTheme } from "./themeParser.js";
 import { UNBALANCED_MOVE_RANGE_WARNING, normalizeTrackedMoveRanges } from "./trackedMoveRangeNormalization.js";
-import { getEntryUncompressedSize, getMediaMimeType, mediaToDataUrl, replaceRawDocxXmlParts, unzipDocx } from "./unzip.js";
+import { getMediaMimeType, mediaToDataUrl, replaceRawDocxXmlParts, unzipDocx } from "./unzip.js";
 import { renderWmfSvg } from "./wmfSvg.js";
 import { getAttribute, getChildElements, getLocalName, parseXml, parseXmlDocument } from "./xmlParser.js";
 import { FOLIO_XML_RESOURCE_LIMITS } from "./xmlResourceLimits.js";
@@ -123,11 +123,10 @@ const extractAltChunkPlainText = async (xml, context) => {
 	if (!relationship || relationship.targetMode === "External" || relationship.type !== ALT_CHUNK_RELATIONSHIP_TYPE && relationship.type !== ALT_CHUNK_STRICT_RELATIONSHIP_TYPE) return;
 	const partPath = resolveRelativePath(context.relationshipsPath, relationship.target);
 	if (contentTypeOf(context.raw.contentTypesXml, partPath)?.split(";")[0]?.trim().toLowerCase() !== "text/plain") return;
-	const file = context.raw.originalZip.file(partPath);
+	const file = context.raw.originalZip.entry(partPath);
 	if (!file) return;
-	const declaredSize = getEntryUncompressedSize(file);
-	if (declaredSize === null || declaredSize > context.budget.remainingBytes) return void 0;
-	const bytes = await file.async("uint8array");
+	if (file.size > context.budget.remainingBytes) return void 0;
+	const bytes = await file.bytes();
 	if (bytes.byteLength > context.budget.remainingBytes) return;
 	context.budget.remainingBytes -= bytes.byteLength;
 	try {

package/dist/docx/removeHeaderFooterParts.d.ts

@@ -1,9 +1,9 @@
 import { document_d_exports } from "../types/document.js";
 import { RemovedSectionReference } from "../internal/sectionEndpointResolution.js";
-import JSZip from "jszip";
+import { ZipArchive } from "@stll/docx-core/zip";
 type RemoveResolvedHeaderFooterPartsOptions = {
   document: document_d_exports.Document;
-  zip: JSZip;
+  zip: ZipArchive;
   removedReferences: readonly RemovedSectionReference[];
   compressionLevel: number;
 };

package/dist/docx/removeHeaderFooterParts.js

@@ -1,11 +1,10 @@
-import { decodeText, encodeUtf8 } from "../utils/textEncoding.js";
+import { decodeText } from "../utils/textEncoding.js";
 import { isUnsafePackagePath } from "./packageParts.js";
 import { parseRelationships, resolveRelativePath } from "./relsParser.js";
 import { captureVerbatimXml } from "./verbatimCapture.js";
 import { OFFICE_RELATIONSHIP_NAMESPACE_URIS, cloneElement, getAttribute, getLocalName, getNamespaceUri, parseXmlDocument } from "./xmlParser.js";
 import { panic } from "better-result";
 import { OOXML_NS } from "@stll/docx-utils";
-import { writeZipPart } from "@stll/docx-core/zip";
 // src/docx/removeHeaderFooterParts.ts
 const DOCUMENT_RELS_PATH = "word/_rels/document.xml.rels";
 const officeRelationshipHasType = (type, kind) => [...OFFICE_RELATIONSHIP_NAMESPACE_URIS].some((namespace) => type === `${namespace}/${kind}`);
@@ -17,9 +16,9 @@ const withoutChildren = (xml, remove) => {
 /** Remove only parts whose last selection was explicitly resolved out of the document. */
 const removeResolvedHeaderFooterParts = async ({ document, zip, removedReferences, compressionLevel }) => {
 	if (removedReferences.length === 0) return;
-	const relsFile = zip.file(DOCUMENT_RELS_PATH);
+	const relsFile = zip.entry(DOCUMENT_RELS_PATH);
 	if (!relsFile) return panic("A resolved header/footer part has no document relationships");
-	const relsXml = await relsFile.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }));
+	const relsXml = await relsFile.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }));
 	const relationships = parseRelationships(relsXml);
 	const removedIds = /* @__PURE__ */ new Set();
 	const candidates = /* @__PURE__ */ new Set();
@@ -38,61 +37,45 @@ const removeResolvedHeaderFooterParts = async ({ document, zip, removedReference
 		if (removedIds.has(relationship.id) || relationship.targetMode === "External") continue;
 		candidates.delete(resolveRelativePath(DOCUMENT_RELS_PATH, relationship.target));
 	}
-	for (const file of Object.values(zip.files)) {
-		if (file.dir || !file.name.endsWith(".rels") || file.name === DOCUMENT_RELS_PATH) continue;
-		const otherRelationships = parseRelationships(await file.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true })));
-		for (const relationship of otherRelationships.values()) if (relationship.targetMode !== "External") candidates.delete(resolveRelativePath(file.name, relationship.target));
+	for (const file of zip.entries()) {
+		if (!file.path.endsWith(".rels") || file.path === DOCUMENT_RELS_PATH) continue;
+		const otherRelationships = parseRelationships(await file.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true })));
+		for (const relationship of otherRelationships.values()) if (relationship.targetMode !== "External") candidates.delete(resolveRelativePath(file.path, relationship.target));
 	}
 	const retiredMedia = /* @__PURE__ */ new Set();
 	for (const path of candidates) {
 		const slash = path.lastIndexOf("/");
 		const relsPath = `${path.slice(0, slash + 1)}_rels/${path.slice(slash + 1)}.rels`;
-		const partRels = zip.file(relsPath);
+		const partRels = zip.entry(relsPath);
 		if (!partRels) continue;
-		for (const relationship of parseRelationships(await partRels.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }))).values()) {
+		for (const relationship of parseRelationships(await partRels.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }))).values()) {
 			if (!officeRelationshipHasType(relationship.type, "image") || relationship.targetMode === "External") continue;
 			const mediaPath = resolveRelativePath(relsPath, relationship.target);
 			if (!isUnsafePackagePath(mediaPath) && mediaPath.startsWith("word/media/")) retiredMedia.add(mediaPath);
 		}
 	}
 	const compressionOptions = { level: compressionLevel };
-	writeZipPart({
-		zip,
-		path: DOCUMENT_RELS_PATH,
-		data: encodeUtf8(withoutChildren(relsXml, (child) => getNamespaceUri(child) === OOXML_NS.pr && getLocalName(child.name) === "Relationship" && removedIds.has(getAttribute(child, null, "Id") ?? ""))),
-		options: {
-			compression: "DEFLATE",
-			compressionOptions
-		}
-	});
+	zip.set(DOCUMENT_RELS_PATH, withoutChildren(relsXml, (child) => getNamespaceUri(child) === OOXML_NS.pr && getLocalName(child.name) === "Relationship" && removedIds.has(getAttribute(child, null, "Id") ?? "")), compressionOptions);
 	if (document.package.relationships) {
 		document.package.relationships = new Map(document.package.relationships);
 		for (const id of removedIds) document.package.relationships.delete(id);
 	}
 	for (const path of candidates) {
-		zip.remove(path);
+		zip.delete(path);
 		const slash = path.lastIndexOf("/");
-		zip.remove(`${path.slice(0, slash + 1)}_rels/${path.slice(slash + 1)}.rels`);
+		zip.delete(`${path.slice(0, slash + 1)}_rels/${path.slice(slash + 1)}.rels`);
 	}
-	for (const file of Object.values(zip.files)) {
-		if (file.dir || !file.name.endsWith(".rels")) continue;
-		for (const relationship of parseRelationships(await file.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }))).values()) if (relationship.targetMode !== "External") retiredMedia.delete(resolveRelativePath(file.name, relationship.target));
+	for (const file of zip.entries()) {
+		if (!file.path.endsWith(".rels")) continue;
+		for (const relationship of parseRelationships(await file.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }))).values()) if (relationship.targetMode !== "External") retiredMedia.delete(resolveRelativePath(file.path, relationship.target));
 	}
 	for (const path of retiredMedia) {
-		zip.remove(path);
+		zip.delete(path);
 		candidates.add(path);
 	}
-	const contentTypes = zip.file("[Content_Types].xml");
+	const contentTypes = zip.entry("[Content_Types].xml");
 	if (!contentTypes) return panic("The package has no content types");
-	const contentTypesXml = await contentTypes.async("uint8array").then((bytes) => decodeText(bytes, { ignoreBOM: true }));
-	writeZipPart({
-		zip,
-		path: "[Content_Types].xml",
-		data: encodeUtf8(withoutChildren(contentTypesXml, (child) => getNamespaceUri(child) === OOXML_NS.ct && getLocalName(child.name) === "Override" && candidates.has((getAttribute(child, null, "PartName") ?? "").replace(/^\//u, "")))),
-		options: {
-			compression: "DEFLATE",
-			compressionOptions
-		}
-	});
+	const contentTypesXml = await contentTypes.bytes().then((bytes) => decodeText(bytes, { ignoreBOM: true }));
+	zip.set("[Content_Types].xml", withoutChildren(contentTypesXml, (child) => getNamespaceUri(child) === OOXML_NS.ct && getLocalName(child.name) === "Override" && candidates.has((getAttribute(child, null, "PartName") ?? "").replace(/^\//u, ""))), compressionOptions);
 };
 export { removeResolvedHeaderFooterParts };

package/dist/docx/rezip.d.ts

@@ -5,7 +5,7 @@ import { SaveDiagnosticOptions } from "./saveDiagnostics.js";
 import { DocumentBodyAuthorityOptions } from "./serializer/documentSerializer.js";
 import { RawDocxContent } from "./unzip.js";
 import { TaggedErrorClass } from "better-result";
-import JSZip from "jszip";
+import { ZipArchive } from "@stll/docx-core/zip";
 declare const DocxPackageFidelityErrorBase: TaggedErrorClass<"DocxPackageFidelityError">;
 export declare class DocxPackageFidelityError extends DocxPackageFidelityErrorBase<{
   message: string;
@@ -65,7 +65,7 @@ export declare class CanonicalImageRelationshipRefusalError extends CanonicalIma
 }> {}
 type PublishCanonicalImageResourcesOptions = {
   document: document_d_exports.Document;
-  zip: JSZip;
+  zip: ZipArchive;
   compressionLevel: number;
 };
 /** Publish allocated pictures into each owning story without rebinding canonical ids. */
@@ -75,7 +75,7 @@ export declare function collectHyperlinksWithoutRId(blocks: BlockContent[]): Hyp
 /** The selective save boundary must use the same resource census as full repack. */
 export declare const hasUnmaterializedInlineResources: (blocks: BlockContent[]) => boolean;
 /** Compare against the already loaded source ZIP, without mutating model or package. */
-export declare const hasUnmaterializedHyperlinkBindings: (document: document_d_exports.Document, zip: JSZip) => Promise<boolean>;
+export declare const hasUnmaterializedHyperlinkBindings: (document: document_d_exports.Document, zip: ZipArchive) => Promise<boolean>;
 /**
  * Options for repacking DOCX
  */
@@ -156,7 +156,7 @@ export declare function updateXmlFile(originalBuffer: ArrayBuffer, path: string,
  */
 export declare function updateMultipleFiles(originalBuffer: ArrayBuffer, updates: Map<string, string | ArrayBuffer>, options?: RepackOptions): Promise<ArrayBuffer>;
 /**
- * Apply file updates to an already-loaded JSZip instance and generate the output.
+ * Apply file updates to an already-loaded ZipArchive instance and generate the output.
  * Use this when the zip is already loaded to avoid a redundant decompression pass.
  *
  * This is the selective save's exit, so it owes the package the same passes
@@ -165,7 +165,7 @@ export declare function updateMultipleFiles(originalBuffer: ArrayBuffer, updates
  * revision ids are free and because an out-of-range paragraph id, or a
  * malformed application version, can sit in a part it never touched.
  */
-export declare function applyUpdatesToZip(zip: JSZip, updates: Map<string, string | ArrayBuffer>, options?: RepackOptions): Promise<ArrayBuffer>;
+export declare function applyUpdatesToZip(zip: ZipArchive, updates: Map<string, string | ArrayBuffer>, options?: RepackOptions): Promise<ArrayBuffer>;
 /**
  * Add a new relationship to document.xml.rels
  *
@@ -219,7 +219,7 @@ export declare function hasModelDrivenPictureWatermark(doc: document_d_exports.D
  * root can keep any prefix binding only the source document declared.
  */
 type CollectHeaderFooterUpdatesOptions = SaveDiagnosticOptions & {
-  sourceZip: JSZip;
+  sourceZip: ZipArchive;
 };
 export declare function collectHeaderFooterUpdates(doc: document_d_exports.Document, { sourceZip, onDiagnostic }: CollectHeaderFooterUpdatesOptions): Promise<Map<string, string>>;
 type AddedStylesPlan = {
@@ -233,7 +233,7 @@ type AddedStylesPlan = {
   xml: string;
 };
 /** One append-only style owner for full repack and selective overlays. */
-export declare function planAddedStyles(doc: document_d_exports.Document, originalZip: JSZip): Promise<AddedStylesPlan>;
+export declare function planAddedStyles(doc: document_d_exports.Document, originalZip: ZipArchive): Promise<AddedStylesPlan>;
 /** `word/Footnotes.xml` -> `word/_rels/Footnotes.xml.rels` (casing preserved). */
 export declare function notePartRelsPath(partPath: string): string;
 /** Update existing core-property values without synthesizing absent metadata. */