Set tab order when document is tagged

[acrollet]

Changes

fixes #1260

relates to department-of-veterans-affairs/va.gov-team#58587

This PR sets tab order to "Structure" when a document is tagged.

• Unit Tests
• Documentation - N/A
• Update CHANGELOG.md
• Ready to be merged

[insightfuls]

@acrollet , firstly, let me say thanks for putting this together. Despite being simple, I hadn't managed to look at it, and having something concrete to look at is really helpful. This is certainly put together well, and it's good to see that it's tested. For a couple of reasons I'll explain inline, I think a slightly different approach would be preferable, though. I think it should be easy to adjust, if you can spare a little more time for this.

[insightfuls]

Thanks @acrollet , overall, this looks great. There's nothing wrong with it, so I'm happy to give an approving review. I've left a comment inline, however, suggesting simplifying a condition, which also makes it more consistent with nearby code.

[acrollet]

Adding suggestion

[insightfuls]

@blikblum , I'm happy for this to be merged if you are, or would you like @liborm85 or @devongovett to give it a review as well?

[acrollet]

acrollet@MacBook-Air pdfkit % npm run test                            

> [email protected] test
> jest -i

 PASS  tests/visual/pdfmake/qrcode.spec.js
 PASS  tests/visual/pdfmake/tables.spec.js
 PASS  tests/visual/pdfmake/columns_simple.spec.js
 PASS  tests/visual/pdfmake/lists.spec.js
 PASS  tests/visual/pdfmake/page_references.spec.js
 PASS  tests/visual/pdfmake/toc.spec.js
 PASS  tests/visual/pdfmake/background.spec.js
 PASS  tests/visual/pdfmake/text_decorations.spec.js
 PASS  tests/visual/pdfmake/watermark.spec.js
 PASS  tests/visual/pdfmake/absolute.spec.js
 PASS  tests/visual/pdfmake/images.spec.js
 PASS  tests/unit/png.spec.js
 PASS  tests/unit/acroform.spec.js
 PASS  tests/visual/pdfmake/basics.spec.js
 PASS  tests/visual/vector.spec.js
 PASS  tests/unit/vector.spec.js
 PASS  tests/unit/annotations.spec.js
 PASS  tests/unit/attachments.spec.js
 PASS  tests/unit/text.spec.js
 PASS  tests/unit/virtual-fs.spec.js
 PASS  tests/unit/pdfa3.spec.js
 PASS  tests/unit/pdfa2.spec.js
 PASS  tests/unit/pdfa1.spec.js
 PASS  tests/unit/pattern.spec.js
 PASS  tests/unit/saslprep.spec.js
 PASS  tests/unit/trailer.spec.js
 PASS  tests/unit/reference.spec.js
 PASS  tests/unit/document.spec.js
 PASS  tests/visual/fonts.spec.js
 PASS  tests/unit/font.spec.js
 PASS  tests/unit/gradient.spec.js
 PASS  tests/visual/text.spec.js
 PASS  tests/unit/color.spec.js
 PASS  tests/unit/metadata.spec.js
 PASS  tests/unit/object.spec.js
 PASS  tests/unit/markings.spec.js

Test Suites: 36 passed, 36 total
Tests:       2 skipped, 142 passed, 144 total
Snapshots:   52 passed, 52 total
Time:        40.663 s
Ran all test suites.

[acrollet]

Hi folks, just wondering if there's anything else needed on this PR. Thanks! 🙂

[acrollet]

@blikblum @insightfuls just wondering if there's anything else needed or if this could be merged? Thanks!

[CarlBohman]

I'm using PDFKit with TypeScript. For a single-page document (which is what I am working with right now), the suggested fix works for me as follows:

const doc = new PDFDocument(...);
// @ts-ignore
doc.page.dictionary.data.Tabs = 'S';

Adding Tabs to the type for the data property of the PDFKitReference class (defined in @types/pdfkit) removes the need for @ts-ignore.

Any idea when this pull request will be merged and made part of a general release?

[JAshique]

Hi @CarlBohman, thanks for your suggestion. It seems like your suggest approach works for single page PDFs. I was wondering if there is a way to do it for multiple pages. I'm thinking of the following approach.

let doc = new PDFDocument({
    tagged: true,
    lang: 'en-CA',
    pdfVersion: '1.7',
    info: {
    Title: 'Big Summary',
    Author: 'JAshique',
  },
  displayTitle: true,
});
    
doc.page.dictionary.data.Tabs = 'S';
let docStream = doc.pipe(blobStream());

docStream.on('pageAdded', () => { // Executes when a doc.addPage() is called 
    doc.page.dictionary.data.Tabs = 'S';
}); 

I have scenarios where I'll be generating multiple pages. Regardless, I will check it myself to see if this makes a difference. Ideally, I'd like this PR to be merged so this can be handled by the library itself.

Thanks :)

[JAshique]

UPDATE: The above mentioned snippet works for multiple pages.

if (document.y > 600) {
    document.addPage();
    document.page.dictionary.data.Tabs = 'S';
}