ppt-codec 1.0.2 → 1.1.0

package/dist/write.cjs

@@ -0,0 +1,145 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors = require("./errors.cjs");
+const require_record_types = require("./record/types.cjs");
+const require_content_write = require("./content-write.cjs");
+const require_record_write = require("./record/write.cjs");
+const require_document_document_atom_write = require("./document/document-atom-write.cjs");
+const require_document_fonts_write = require("./document/fonts-write.cjs");
+const require_drawing_shapes_write = require("./drawing/shapes-write.cjs");
+const require_read = require("./read.cjs");
+const require_document_master_write = require("./document/master-write.cjs");
+const require_document_notes_list_write = require("./document/notes-list-write.cjs");
+const require_document_notes_write = require("./document/notes-write.cjs");
+const require_document_slide_list_write = require("./document/slide-list-write.cjs");
+const require_metadata = require("./metadata.cjs");
+const require_stream_current_user_write = require("./stream/current-user-write.cjs");
+const require_stream_persist_write = require("./stream/persist-write.cjs");
+let archive_codec = require("archive-codec");
+let document_schema_js = require("document-schema.js");
+//#region src/write.ts
+const DOCUMENT_PERSIST_ID = 1;
+const MASTER_PERSIST_ID = 2;
+const FIRST_SLIDE_PERSIST_ID = 3;
+const FIRST_SLIDE_ID = 256;
+const FIRST_NOTES_ID = 512;
+const NO_NOTES_ID_REF = 0;
+const DEFAULT_SLIDE_SIZE = {
+	widthPt: 720,
+	heightPt: 540
+};
+function requireOneSlideSize(slides) {
+	const first = slides[0]?.size ?? DEFAULT_SLIDE_SIZE;
+	for (const slide of slides) if (slide.size.widthPt !== first.widthPt || slide.size.heightPt !== first.heightPt) throw new require_errors.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 require_record_write.writeContainer(require_record_types.RT_Slide, [require_document_master_write.writeSlideAtomForSlide(notesIdRef), require_drawing_shapes_write.writeSlideDrawing(shapes, fontIndexOf)]);
+}
+function writePptStreams(document) {
+	const { slides } = document;
+	const size = requireOneSlideSize(slides);
+	const fontNames = require_content_write.collectFontFamilies(slides.map((slide) => slide.shapes.flatMap((shape) => shape.blocks)));
+	const fontIndexOf = (family) => {
+		const index = fontNames.indexOf(family);
+		if (index === -1) throw new require_errors.PptUnsupportedContentError(`font family '${family}' was not collected into the document's font table before writing`);
+		return index;
+	};
+	const slidePersistRefs = slides.map((_slide, index) => ({
+		persistIdRef: FIRST_SLIDE_PERSIST_ID + index,
+		slideId: FIRST_SLIDE_ID + index
+	}));
+	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;
+		notesPersists.push({
+			persistIdRef: FIRST_SLIDE_PERSIST_ID + slides.length + notesPersists.length,
+			notesId
+		});
+		notesContainers.push(require_document_notes_write.writeNotesContainer(FIRST_SLIDE_ID + index, slide.notes, size, fontIndexOf));
+		return notesId;
+	});
+	const environment = require_document_fonts_write.writeEnvironment(fontNames);
+	const documentChildren = [require_document_document_atom_write.writeDocumentAtom(size)];
+	if (environment !== void 0) documentChildren.push(environment);
+	documentChildren.push(require_document_master_write.writeMasterListWithText(MASTER_PERSIST_ID));
+	documentChildren.push(require_document_slide_list_write.writeSlideListWithText(slidePersistRefs));
+	if (notesPersists.length > 0) documentChildren.push(require_document_notes_list_write.writeNotesListWithText(notesPersists));
+	const documentContainer = require_record_write.writeContainer(require_record_types.RT_Document, documentChildren);
+	const persistObjects = [{
+		persistId: DOCUMENT_PERSIST_ID,
+		bytes: documentContainer
+	}, {
+		persistId: MASTER_PERSIST_ID,
+		bytes: require_document_master_write.writeMainMaster(size, fontIndexOf)
+	}];
+	slides.forEach((slide, index) => {
+		const ref = slidePersistRefs[index];
+		const notesIdRef = notesIdRefs[index];
+		if (ref === void 0 || notesIdRef === void 0) throw new require_errors.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 require_errors.PptUnsupportedContentError("internal error: notes container missing for a notes persist reference");
+		persistObjects.push({
+			persistId: persist.persistIdRef,
+			bytes
+		});
+	});
+	const persistEntries = [];
+	let offset = 0;
+	for (const object of persistObjects) {
+		persistEntries.push({
+			persistId: object.persistId,
+			offset
+		});
+		offset += object.bytes.length;
+	}
+	const persistDirectoryOffset = offset;
+	const persistDirectory = require_stream_persist_write.writePersistDirectoryAtom(persistEntries);
+	const userEditOffset = persistDirectoryOffset + persistDirectory.length;
+	const lastSlideId = slidePersistRefs.at(-1)?.slideId ?? 0;
+	const userEdit = require_stream_persist_write.writeUserEditAtom({
+		lastSlideIdRef: lastSlideId,
+		offsetLastEdit: 0,
+		offsetPersistDirectory: persistDirectoryOffset,
+		docPersistIdRef: DOCUMENT_PERSIST_ID,
+		persistIdSeed: Math.max(...persistEntries.map((entry) => entry.persistId)) + 1
+	});
+	return {
+		currentUserStream: require_stream_current_user_write.writeCurrentUserAtom(userEditOffset),
+		powerPointDocumentStream: require_record_write.concatBytes(...persistObjects.map((object) => object.bytes), persistDirectory, userEdit)
+	};
+}
+function writePptContent(document) {
+	const { currentUserStream, powerPointDocumentStream } = writePptStreams(document);
+	const streams = [{
+		path: require_read.CURRENT_USER_STREAM,
+		bytes: currentUserStream
+	}, {
+		path: require_read.POWERPOINT_DOCUMENT_STREAM,
+		bytes: powerPointDocumentStream
+	}];
+	if ((0, archive_codec.hasSummaryInformationFields)(document.metadata)) streams.push({
+		path: require_read.SUMMARY_INFORMATION_STREAM,
+		bytes: (0, archive_codec.writeSummaryInformationStream)(require_metadata.layoutMetadataToSummaryInformation(document.metadata))
+	});
+	return (0, archive_codec.writeCompoundFile)(streams);
+}
+function writePpt(tree) {
+	const content = (0, document_schema_js.flattenTree)(tree);
+	if (content.kind !== "presentation") throw new require_errors.PptUnsupportedContentError(`ppt-codec's writer only writes presentation documents; got a '${content.kind}' document`);
+	return writePptContent({
+		metadata: content.metadata,
+		slides: content.slides
+	});
+}
+//#endregion
+exports.writePpt = writePpt;
+exports.writePptContent = writePptContent;
+exports.writePptStreams = writePptStreams;

package/dist/write.d.cts

@@ -0,0 +1,11 @@
+import { PptDocument } from "./read.cjs";
+import { DocumentTree } from "document-schema.js";
+//#region src/write.d.ts
+declare function writePptStreams(document: PptDocument): {
+  readonly currentUserStream: Uint8Array<ArrayBuffer>;
+  readonly powerPointDocumentStream: Uint8Array<ArrayBuffer>;
+};
+declare function writePptContent(document: PptDocument): Uint8Array<ArrayBuffer>;
+declare function writePpt(tree: DocumentTree): Uint8Array<ArrayBuffer>;
+//#endregion
+export { writePpt, writePptContent, writePptStreams };

package/dist/write.d.ts

@@ -0,0 +1,11 @@
+import { PptDocument } from "./read.js";
+import { DocumentTree } from "document-schema.js";
+//#region src/write.d.ts
+declare function writePptStreams(document: PptDocument): {
+  readonly currentUserStream: Uint8Array<ArrayBuffer>;
+  readonly powerPointDocumentStream: Uint8Array<ArrayBuffer>;
+};
+declare function writePptContent(document: PptDocument): Uint8Array<ArrayBuffer>;
+declare function writePpt(tree: DocumentTree): Uint8Array<ArrayBuffer>;
+//#endregion
+export { writePpt, writePptContent, writePptStreams };

package/dist/write.js

@@ -0,0 +1,142 @@
+import { PptUnsupportedContentError } from "./errors.js";
+import { RT_Document, RT_Slide } from "./record/types.js";
+import { collectFontFamilies } from "./content-write.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 { CURRENT_USER_STREAM, POWERPOINT_DOCUMENT_STREAM, SUMMARY_INFORMATION_STREAM } from "./read.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";
+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 { hasSummaryInformationFields, writeCompoundFile, writeSummaryInformationStream } from "archive-codec";
+import { flattenTree } from "document-schema.js";
+//#region src/write.ts
+const DOCUMENT_PERSIST_ID = 1;
+const MASTER_PERSIST_ID = 2;
+const FIRST_SLIDE_PERSIST_ID = 3;
+const FIRST_SLIDE_ID = 256;
+const FIRST_NOTES_ID = 512;
+const NO_NOTES_ID_REF = 0;
+const DEFAULT_SLIDE_SIZE = {
+	widthPt: 720,
+	heightPt: 540
+};
+function requireOneSlideSize(slides) {
+	const first = slides[0]?.size ?? DEFAULT_SLIDE_SIZE;
+	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 writePptStreams(document) {
+	const { slides } = document;
+	const size = requireOneSlideSize(slides);
+	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 slidePersistRefs = slides.map((_slide, index) => ({
+		persistIdRef: FIRST_SLIDE_PERSIST_ID + index,
+		slideId: FIRST_SLIDE_ID + index
+	}));
+	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;
+		notesPersists.push({
+			persistIdRef: FIRST_SLIDE_PERSIST_ID + slides.length + notesPersists.length,
+			notesId
+		});
+		notesContainers.push(writeNotesContainer(FIRST_SLIDE_ID + index, slide.notes, size, fontIndexOf));
+		return notesId;
+	});
+	const environment = writeEnvironment(fontNames);
+	const documentChildren = [writeDocumentAtom(size)];
+	if (environment !== void 0) documentChildren.push(environment);
+	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 persistEntries = [];
+	let offset = 0;
+	for (const object of persistObjects) {
+		persistEntries.push({
+			persistId: object.persistId,
+			offset
+		});
+		offset += object.bytes.length;
+	}
+	const persistDirectoryOffset = offset;
+	const persistDirectory = writePersistDirectoryAtom(persistEntries);
+	const userEditOffset = persistDirectoryOffset + persistDirectory.length;
+	const lastSlideId = slidePersistRefs.at(-1)?.slideId ?? 0;
+	const userEdit = writeUserEditAtom({
+		lastSlideIdRef: lastSlideId,
+		offsetLastEdit: 0,
+		offsetPersistDirectory: persistDirectoryOffset,
+		docPersistIdRef: DOCUMENT_PERSIST_ID,
+		persistIdSeed: Math.max(...persistEntries.map((entry) => entry.persistId)) + 1
+	});
+	return {
+		currentUserStream: writeCurrentUserAtom(userEditOffset),
+		powerPointDocumentStream: concatBytes(...persistObjects.map((object) => object.bytes), persistDirectory, userEdit)
+	};
+}
+function writePptContent(document) {
+	const { currentUserStream, powerPointDocumentStream } = writePptStreams(document);
+	const streams = [{
+		path: CURRENT_USER_STREAM,
+		bytes: currentUserStream
+	}, {
+		path: POWERPOINT_DOCUMENT_STREAM,
+		bytes: powerPointDocumentStream
+	}];
+	if (hasSummaryInformationFields(document.metadata)) streams.push({
+		path: SUMMARY_INFORMATION_STREAM,
+		bytes: writeSummaryInformationStream(layoutMetadataToSummaryInformation$1(document.metadata))
+	});
+	return writeCompoundFile(streams);
+}
+function writePpt(tree) {
+	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
+	});
+}
+//#endregion
+export { writePpt, writePptContent, writePptStreams };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ppt-codec",
-  "version": "1.0.2",
-  "description": "Hand-written PowerPoint 97-2003 binary (.ppt, [MS-PPT]) reader against the shared document-schema.js content pivot.",
+  "version": "1.1.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": {
     "type": "git",
@@ -75,8 +75,8 @@
   "license": "MIT",
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
-    "archive-codec": "^1.3.0",
-    "document-schema.js": "^5.5.0"
+    "archive-codec": "^1.4.0",
+    "document-schema.js": "^5.5.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",