ppt-codec 1.5.0 → 1.7.0

package/dist/write.js

@@ -1,11 +1,14 @@
+import { base64ToBytes } from "./base64.js";
 import { PptUnsupportedContentError } from "./errors.js";
 import { RT_Document, RT_Slide } from "./record/types.js";
 import { collectFontFamilies } from "./content-write.js";
+import { NOOP_PPT_DIAGNOSTIC_SINK } from "./diagnostics.js";
 import { concatBytes, writeContainer } from "./record/write.js";
 import { writeDocumentAtom } from "./document/document-atom-write.js";
 import { writeEnvironment } from "./document/fonts-write.js";
-import { writeSlideDrawing } from "./drawing/shapes-write.js";
+import { isBlipFormat, writeDrawingGroupContainer } from "./drawing/blips.js";
 import { CURRENT_USER_STREAM, POWERPOINT_DOCUMENT_STREAM, SUMMARY_INFORMATION_STREAM } from "./read.js";
+import { writeSlideDrawing } from "./drawing/shapes-write.js";
 import { writeMainMaster, writeMasterListWithText, writeSlideAtomForSlide } from "./document/master-write.js";
 import { writeNotesListWithText } from "./document/notes-list-write.js";
 import { writeNotesContainer } from "./document/notes-write.js";
@@ -13,6 +16,7 @@ import { writeSlideListWithText } from "./document/slide-list-write.js";
 import { layoutMetadataToSummaryInformation as layoutMetadataToSummaryInformation$1 } from "./metadata.js";
 import { writeCurrentUserAtom } from "./stream/current-user-write.js";
 import { writePersistDirectoryAtom, writeUserEditAtom } from "./stream/persist-write.js";
+import { writeExObjListContainer, writeExOleObjStg, writeOleClientData } from "./ole/embedded-write.js";
 import { hasSummaryInformationFields, writeCompoundFile, writeSummaryInformationStream } from "archive-codec";
 import { flattenTree } from "document-schema.js";
 //#region src/write.ts
@@ -31,65 +35,160 @@ function requireOneSlideSize(slides) {
 	for (const slide of slides) if (slide.size.widthPt !== first.widthPt || slide.size.heightPt !== first.heightPt) throw new PptUnsupportedContentError(`ppt-codec's writer cannot express per-slide sizes: slide sizes ${JSON.stringify(first)} and ${JSON.stringify(slide.size)} both appear, but [MS-PPT]'s DocumentAtom states exactly one slide size for the whole presentation`);
 	return first;
 }
-function writeSlideContainer(shapes, notesIdRef, fontIndexOf) {
-	return writeContainer(RT_Slide, [writeSlideAtomForSlide(notesIdRef), writeSlideDrawing(shapes, fontIndexOf)]);
+function writeSlideContainer(shapes, notesIdRef, context, clientDataFor) {
+	const drawing = writeSlideDrawing(shapes.map((shape) => ({
+		shape,
+		clientData: clientDataFor(shape)
+	})), context);
+	return {
+		bytes: writeContainer(RT_Slide, [writeSlideAtomForSlide(notesIdRef), drawing.bytes]),
+		shapeCount: drawing.shapeCount,
+		maxSpid: drawing.maxSpid
+	};
+}
+function planOleEmbeds(slides, serialise, firstPersistId) {
+	const embeds = [];
+	const persistObjects = [];
+	const clientDataByShape = /* @__PURE__ */ new Map();
+	if (serialise !== void 0) for (const slide of slides) for (const shape of slide.shapes) {
+		const embedBlock = shape.blocks.find((block) => block.kind === "embeddedObject");
+		if (embedBlock === void 0) continue;
+		const storageBytes = serialise(embedBlock.document);
+		if (storageBytes === void 0) continue;
+		const exObjId = embeds.length + 1;
+		const persistId = firstPersistId + persistObjects.length;
+		embeds.push({
+			exObjId,
+			persistIdRef: persistId,
+			objectKind: embedBlock.objectKind
+		});
+		persistObjects.push({
+			persistId,
+			bytes: writeExOleObjStg(storageBytes)
+		});
+		clientDataByShape.set(shape, writeOleClientData(exObjId));
+	}
+	return {
+		embeds,
+		persistObjects,
+		clientDataFor: (shape) => clientDataByShape.get(shape)
+	};
+}
+function planBlipStore(slides) {
+	const blips = [];
+	const pibByKey = /* @__PURE__ */ new Map();
+	for (const slide of slides) for (const shape of slide.shapes) for (const block of shape.blocks) {
+		if (block.kind !== "image" || !isBlipFormat(block.format)) continue;
+		const key = `${block.format}:${block.base64}`;
+		if (!pibByKey.has(key)) {
+			pibByKey.set(key, blips.length + 1);
+			blips.push({
+				format: block.format,
+				bytes: base64ToBytes(block.base64)
+			});
+		}
+	}
+	return {
+		blips,
+		pibOf: (image) => {
+			const pib = pibByKey.get(`${image.format}:${image.base64}`);
+			if (pib === void 0) throw new PptUnsupportedContentError("internal error: an image block reached the drawing writer without first being collected into the document's blip store");
+			return pib;
+		}
+	};
 }
-function writePptStreams(document) {
+function writePptStreams(document, options = {}) {
+	options.signal?.throwIfAborted();
 	const { slides } = document;
 	const size = requireOneSlideSize(slides);
+	const sink = options.sink ?? NOOP_PPT_DIAGNOSTIC_SINK;
 	const fontNames = collectFontFamilies(slides.map((slide) => slide.shapes.flatMap((shape) => shape.blocks)));
 	const fontIndexOf = (family) => {
 		const index = fontNames.indexOf(family);
 		if (index === -1) throw new PptUnsupportedContentError(`font family '${family}' was not collected into the document's font table before writing`);
 		return index;
 	};
+	const store = planBlipStore(slides);
+	const strict = options.onUnwritableBlock === "throw";
+	const contextFor = (location) => ({
+		fontIndexOf,
+		blipIndexOf: store.pibOf,
+		sink,
+		strict,
+		location
+	});
 	const slidePersistRefs = slides.map((_slide, index) => ({
 		persistIdRef: FIRST_SLIDE_PERSIST_ID + index,
 		slideId: FIRST_SLIDE_ID + index
 	}));
+	const notesIdRefs = slides.map((slide, index) => slide.notes.length === 0 ? NO_NOTES_ID_REF : FIRST_NOTES_ID + slides.slice(0, index).filter((earlier) => earlier.notes.length > 0).length);
+	const notesCount = notesIdRefs.filter((id) => id !== NO_NOTES_ID_REF).length;
+	const oleEmbeds = planOleEmbeds(slides, options.serialiseEmbeddedObject, FIRST_SLIDE_PERSIST_ID + slides.length + notesCount);
+	let shapeCount = 0;
+	let maxSpid = 0;
+	let drawingCount = 0;
+	const account = (drawing) => {
+		shapeCount += drawing.shapeCount;
+		maxSpid = Math.max(maxSpid, drawing.maxSpid);
+		drawingCount += 1;
+	};
+	const mainMaster = writeMainMaster(size, contextFor("the main master"));
+	account(mainMaster);
+	const slideContainers = slides.map((slide, index) => {
+		const ref = slidePersistRefs[index];
+		const notesIdRef = notesIdRefs[index];
+		if (ref === void 0 || notesIdRef === void 0) throw new PptUnsupportedContentError("internal error: slide persist reference missing for a slide being written");
+		const container = writeSlideContainer(slide.shapes, notesIdRef, contextFor(`slide ${index + 1}`), oleEmbeds.clientDataFor);
+		account(container);
+		return {
+			persistId: ref.persistIdRef,
+			bytes: container.bytes
+		};
+	});
 	const notesPersists = [];
 	const notesContainers = [];
-	const notesIdRefs = slides.map((slide, index) => {
-		if (slide.notes.length === 0) return NO_NOTES_ID_REF;
-		const notesId = FIRST_NOTES_ID + notesPersists.length;
+	slides.forEach((slide, index) => {
+		const notesId = notesIdRefs[index];
+		if (notesId === void 0 || notesId === NO_NOTES_ID_REF) return;
+		const persistIdRef = FIRST_SLIDE_PERSIST_ID + slides.length + notesPersists.length;
 		notesPersists.push({
-			persistIdRef: FIRST_SLIDE_PERSIST_ID + slides.length + notesPersists.length,
+			persistIdRef,
 			notesId
 		});
-		notesContainers.push(writeNotesContainer(FIRST_SLIDE_ID + index, slide.notes, size, fontIndexOf));
-		return notesId;
+		const container = writeNotesContainer(FIRST_SLIDE_ID + index, slide.notes, size, contextFor(`slide ${index + 1}'s speaker notes`));
+		account(container);
+		notesContainers.push({
+			persistId: persistIdRef,
+			bytes: container.bytes
+		});
 	});
 	const environment = writeEnvironment(fontNames);
 	const documentChildren = [writeDocumentAtom(size)];
+	const exObjList = writeExObjListContainer(oleEmbeds.embeds);
+	if (exObjList !== void 0) documentChildren.push(exObjList);
 	if (environment !== void 0) documentChildren.push(environment);
+	documentChildren.push(writeDrawingGroupContainer(store.blips, {
+		spidMax: maxSpid,
+		shapeCount,
+		drawingCount
+	}));
 	documentChildren.push(writeMasterListWithText(MASTER_PERSIST_ID));
 	documentChildren.push(writeSlideListWithText(slidePersistRefs));
 	if (notesPersists.length > 0) documentChildren.push(writeNotesListWithText(notesPersists));
 	const documentContainer = writeContainer(RT_Document, documentChildren);
-	const persistObjects = [{
-		persistId: DOCUMENT_PERSIST_ID,
-		bytes: documentContainer
-	}, {
-		persistId: MASTER_PERSIST_ID,
-		bytes: writeMainMaster(size, fontIndexOf)
-	}];
-	slides.forEach((slide, index) => {
-		const ref = slidePersistRefs[index];
-		const notesIdRef = notesIdRefs[index];
-		if (ref === void 0 || notesIdRef === void 0) throw new PptUnsupportedContentError("internal error: slide persist reference missing for a slide being written");
-		persistObjects.push({
-			persistId: ref.persistIdRef,
-			bytes: writeSlideContainer(slide.shapes, notesIdRef, fontIndexOf)
-		});
-	});
-	notesPersists.forEach((persist, index) => {
-		const bytes = notesContainers[index];
-		if (bytes === void 0) throw new PptUnsupportedContentError("internal error: notes container missing for a notes persist reference");
-		persistObjects.push({
-			persistId: persist.persistIdRef,
-			bytes
-		});
-	});
+	const persistObjects = [
+		{
+			persistId: DOCUMENT_PERSIST_ID,
+			bytes: documentContainer
+		},
+		{
+			persistId: MASTER_PERSIST_ID,
+			bytes: mainMaster.bytes
+		},
+		...slideContainers,
+		...notesContainers,
+		...oleEmbeds.persistObjects
+	];
 	const persistEntries = [];
 	let offset = 0;
 	for (const object of persistObjects) {
@@ -115,8 +214,8 @@ function writePptStreams(document) {
 		powerPointDocumentStream: concatBytes(...persistObjects.map((object) => object.bytes), persistDirectory, userEdit)
 	};
 }
-function writePptContent(document) {
-	const { currentUserStream, powerPointDocumentStream } = writePptStreams(document);
+function writePptContent(document, options = {}) {
+	const { currentUserStream, powerPointDocumentStream } = writePptStreams(document, options);
 	const streams = [{
 		path: CURRENT_USER_STREAM,
 		bytes: currentUserStream
@@ -130,13 +229,13 @@ function writePptContent(document) {
 	});
 	return writeCompoundFile(streams);
 }
-function writePpt(tree) {
+function writePpt(tree, options = {}) {
 	const content = flattenTree(tree);
 	if (content.kind !== "presentation") throw new PptUnsupportedContentError(`ppt-codec's writer only writes presentation documents; got a '${content.kind}' document`);
 	return writePptContent({
 		metadata: content.metadata,
 		slides: content.slides
-	});
+	}, options);
 }
 //#endregion
 export { writePpt, writePptContent, writePptStreams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ppt-codec",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Hand-written PowerPoint 97-2003 binary (.ppt, [MS-PPT]) reader and writer against the shared document-schema.js content pivot.",
   "type": "module",
   "repository": {
@@ -79,6 +79,7 @@
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
     "archive-codec": "1.11.0",
+    "byte-codec": "1.5.0",
     "document-schema.js": "7.11.0"
   },
   "devDependencies": {