Extending zip output with more sub-files

[adamSherwoodGenieAI]

Hi @dolanmiu Thanks for this great library.

I'm just running into an issue with trying to add a commentsExtended.xml subfile to the exported zip file (for MS Word compatibility).

From what I can tell, the simplest way to make this possible would be to publicly expose the Compiler class, which is not currently part of the public api. Alternatively the compiler field on the Packer class could be made public.

In either case, it would enable user code to call Compiler.compile directly, get the returned JSZip, ad additional files to the JSZip, and finally generate the zip.

If you're open to the idea, I'm happy to open a PR to make the changes. Let me know what you think

[dolanmiu]

Hey

Prefer if it was added the same way as the rest of the other .xml files are added, so we aren't exposing any internals

[adamSherwoodGenieAI]

Understood. In that case how about adding an additional argument to the Packer methods that is typed as IXmlifyedFile[]? That array can then be passed to Compiler.compile as an additional argument.

public static async toBase64String(
    file: File,
    prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType],
    overrides?: IXmlifyedFile[],
): Promise<string> {
    const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
    /* ...  */
}

And after the statically defined subfiles, Compiler.compile can add them to the JSZip like so:

for (const subFile in overrides) {
    zip.file(subFile.path, subFile.data);
}

Would you be open to that or do you have another approach in mind?

[dolanmiu]

Yeah that could work. It adds some flexibility for certain use cases.

Go for it. If you can make a PR, that would be great

[kalda341]

@adamSherwoodGenieAI I've been interested in commentsExtended too in order to use the more modern style of comments in Word. What are you including in the file in order to achieve compatibility?

[adamSherwoodGenieAI]

@kalda341 Still figuring that out, but paraId, paraIdParent, and done attributes at least.