Add ImageRun feature

This commit is contained in:
Dolan Miu
2023-03-03 23:47:50 +00:00
parent fe9b438a51
commit 66a1992da0
9 changed files with 141 additions and 11 deletions

View File

@ -3,10 +3,17 @@ import { Element, js2xml } from "xml-js";
import { ParagraphChild } from "@file/paragraph";
import { FileChild } from "@file/file-child";
import { IMediaData, Media } from "@file/media";
import { IViewWrapper } from "@file/document-wrapper";
import { File } from "@file/file";
import { IContext } from "@file/xml-components";
import { ImageReplacer } from "@export/packer/image-replacer";
import { replacer } from "./replacer";
import { findLocationOfText } from "./traverser";
import { toJson } from "./util";
import { appendRelationship, getNextRelationshipIndex } from "./relationship-manager";
import { appendContentType } from "./content-types-manager";
// eslint-disable-next-line functional/prefer-readonly-type
type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream;
@ -26,31 +33,94 @@ type FilePatch = {
readonly children: readonly FileChild[];
};
interface IRelationshipReplacement {
readonly key: string;
readonly mediaDatas: readonly IMediaData[];
}
export type IPatch = ParagraphPatch | FilePatch;
export interface PatchDocumentOptions {
readonly patches: { readonly [key: string]: IPatch };
}
const imageReplacer = new ImageReplacer();
export const patchDocument = async (data: InputDataType, options: PatchDocumentOptions): Promise<Buffer> => {
const zipContent = await JSZip.loadAsync(data);
const context: IContext = {
file: {
Media: new Media(),
} as unknown as File,
viewWrapper: {} as unknown as IViewWrapper,
stack: [],
};
const map = new Map<string, Element>();
// eslint-disable-next-line functional/prefer-readonly-type
const relationshipReplacement: IRelationshipReplacement[] = [];
let hasMedia = false;
for (const [key, value] of Object.entries(zipContent.files)) {
const json = toJson(await value.async("text"));
if (key.startsWith("word/")) {
if (key.startsWith("word/") && !key.endsWith(".xml.rels")) {
for (const [patchKey, patchValue] of Object.entries(options.patches)) {
const patchText = `{{${patchKey}}}`;
const renderedParagraphs = findLocationOfText(json, patchText);
// TODO: mutates json. Make it immutable
replacer(json, patchValue, patchText, renderedParagraphs);
replacer(json, patchValue, patchText, renderedParagraphs, context);
}
const mediaDatas = imageReplacer.getMediaData(JSON.stringify(json), context.file.Media);
if (mediaDatas.length > 0) {
hasMedia = true;
// eslint-disable-next-line functional/immutable-data
relationshipReplacement.push({
key,
mediaDatas,
});
}
}
map.set(key, json);
}
for (const { key, mediaDatas } of relationshipReplacement) {
// eslint-disable-next-line functional/immutable-data
const relationshipsJson = map.get(`word/_rels/${key.split("/").pop()}.rels`);
if (relationshipsJson) {
const index = getNextRelationshipIndex(relationshipsJson);
const newJson = imageReplacer.replace(JSON.stringify(map.get(key)), mediaDatas, index);
map.set(key, JSON.parse(newJson) as Element);
for (const { fileName } of mediaDatas) {
appendRelationship(
relationshipsJson,
index,
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
`media/${fileName}`,
);
}
}
}
if (hasMedia) {
const contentTypesJson = map.get("[Content_Types].xml");
if (!contentTypesJson) {
throw new Error("Could not find content types file");
}
appendContentType(contentTypesJson, "image/png", "png");
appendContentType(contentTypesJson, "image/jpeg", "jpeg");
appendContentType(contentTypesJson, "image/jpeg", "jpg");
appendContentType(contentTypesJson, "image/bmp", "bmp");
appendContentType(contentTypesJson, "image/gif", "gif");
}
const zip = new JSZip();
for (const [key, value] of map) {
@ -59,13 +129,15 @@ export const patchDocument = async (data: InputDataType, options: PatchDocumentO
zip.file(key, output);
}
const zipData = await zip.generateAsync({
for (const { stream, fileName } of context.file.Media.Array) {
zip.file(`word/media/${fileName}`, stream);
}
return zip.generateAsync({
type: "nodebuffer",
mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
compression: "DEFLATE",
});
return zipData;
};
const toXml = (jsonObj: Element): string => {