Add getAttachments to PDFDocument #80
Conversation
This adds the getAttachments method to get all the attachments from a pdf document. This is basically implementing the suggestion in Hopding#534 (comment) There's some interesting behavior here, as the attachments don't show up until after save is called. That's tested in the test and described in the README, just so it's clear that's the behavior. I don't know how to do all that great jsfiddle setup, so for the README Ijust copied the basic example from that issue for now.
|
🥳 |
|
Thanks. We'll study this and try to merge it. |
| fs.writeFileSync(csv.name, csv.data) | ||
| ``` | ||
|
|
||
| > NOTE: If you are building a pdf file with this library, any attachments you've |
There was a problem hiding this comment.
I see no reason why not? This might be confusing for users...
There was a problem hiding this comment.
Where are the attachments being stored before they are serialized? We can probably include that location when returning the attachments, no?
There was a problem hiding this comment.
I agree that would be better. It's been a while since I've looked at this code, but I vaguely remember that being difficult. I see a comment on PDFEmbeddedFile.embed that says something to the effect of it not being embedded until save is called. I also don't see how to get this information out of PDFEmbeddedFile.
I won't be able to spend a lot of time on this soon, but I'm planning to come back at some point and give it another shot to see if what you're saying is possible.
| const rawAttachments = this.getRawAttachments(); | ||
| return rawAttachments.map(({ fileName, fileSpec }) => { | ||
| const stream = fileSpec | ||
| .lookup(PDFName.of('EF'), PDFDict) |
There was a problem hiding this comment.
Shouldn't we make sure "EF" and "F" key exist?
There was a problem hiding this comment.
That's a good question. These lookup and of functions don't ever return undefined in their signatures, and I'm not sure what the default value is if they don't find anything.
What?
I got some requests to move this PR from Hopding#1242, since that one isn't being maintained currently.
This adds the getAttachments method to get all the attachments from a pdf document.
Why?
This is basically implementing the suggestion in Hopding#534 (comment), to allow for getting attachments.
How?
It's been a while since I wrote this, but I remember pretty much "following the rails" and filling out the implementation based on what was in the PDF and what the code around it did/expected.
Testing?
There's some interesting behavior here, as the attachments don't show up until after save is called. That's tested in the test and described in the README, just so it's clear that's the behavior.
I don't know how to do all that great jsfiddle setup, so for the README I just copied the basic example from that issue for now.
New Dependencies?
Screenshots
Suggested Reading?
It appears that the link is broken now unfortunately...
Anything Else?
Checklist