@pdfme/pdf-lib 6.0.3 → 6.0.5-dev.1

package/__tests__/api/PDFPage.spec.ts

@@ -1,151 +0,0 @@
-import fs from 'fs';
-import { PDFArray, PDFDocument, PDFName, StandardFonts } from '../../src/index';
-
-const birdPng = fs.readFileSync('assets/images/greyscale_bird.png');
-
-describe(`PDFDocument`, () => {
-  describe(`getSize() method`, () => {
-    it(`returns the width and height of the the page's MediaBox`, async () => {
-      const pdfDoc = await PDFDocument.create();
-      const page = pdfDoc.addPage();
-      page.node.set(PDFName.MediaBox, pdfDoc.context.obj([5, 5, 20, 50]));
-      expect(page.getSize()).toEqual({ width: 15, height: 45 });
-    });
-  });
-
-  describe(`setSize() method`, () => {
-    it(`sets the width and height of only the the page's MediaBox when the other boxes are not defined`, async () => {
-      const pdfDoc = await PDFDocument.create();
-      const page = pdfDoc.addPage();
-
-      page.setMediaBox(5, 5, 20, 50);
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.node.MediaBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.CropBox()).toBeUndefined();
-      expect(page.node.BleedBox()).toBeUndefined();
-      expect(page.node.TrimBox()).toBeUndefined();
-      expect(page.node.ArtBox()).toBeUndefined();
-
-      page.setSize(15, 45);
-      expect(page.getSize()).toEqual({ width: 15, height: 45 });
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.node.MediaBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.CropBox()).toBeUndefined();
-      expect(page.node.BleedBox()).toBeUndefined();
-      expect(page.node.TrimBox()).toBeUndefined();
-      expect(page.node.ArtBox()).toBeUndefined();
-    });
-
-    it(`sets the width and height of the the page's CropBox, BleedBox, TrimBox, and ArtBox when they equal the MediaBox`, async () => {
-      const pdfDoc = await PDFDocument.create();
-      const page = pdfDoc.addPage();
-
-      page.setMediaBox(5, 5, 20, 50);
-      page.setCropBox(5, 5, 20, 50);
-      page.setBleedBox(5, 5, 20, 50);
-      page.setTrimBox(5, 5, 20, 50);
-      page.setArtBox(5, 5, 20, 50);
-
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.getCropBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.getBleedBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.getTrimBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.getArtBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-
-      expect(page.node.MediaBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.CropBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.BleedBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.TrimBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.ArtBox()).toBeInstanceOf(PDFArray);
-
-      page.setSize(15, 45);
-      expect(page.getSize()).toEqual({ width: 15, height: 45 });
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.getCropBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.getBleedBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.getTrimBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.getArtBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-    });
-
-    it(`does not set the width and height of the the page's CropBox, BleedBox, TrimBox, or ArtBox when they do not equal the MediaBox`, async () => {
-      const pdfDoc = await PDFDocument.create();
-      const page = pdfDoc.addPage();
-
-      page.setMediaBox(5, 5, 20, 50);
-      page.setCropBox(0, 0, 20, 50);
-      page.setBleedBox(5, 5, 10, 25);
-      page.setTrimBox(5, 0, 10, 50);
-      page.setArtBox(0, 5, 20, 25);
-
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 20, height: 50 });
-      expect(page.getCropBox()).toEqual({ x: 0, y: 0, width: 20, height: 50 });
-      expect(page.getBleedBox()).toEqual({ x: 5, y: 5, width: 10, height: 25 });
-      expect(page.getTrimBox()).toEqual({ x: 5, y: 0, width: 10, height: 50 });
-      expect(page.getArtBox()).toEqual({ x: 0, y: 5, width: 20, height: 25 });
-
-      expect(page.node.MediaBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.CropBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.BleedBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.TrimBox()).toBeInstanceOf(PDFArray);
-      expect(page.node.ArtBox()).toBeInstanceOf(PDFArray);
-
-      page.setSize(15, 45);
-      expect(page.getSize()).toEqual({ width: 15, height: 45 });
-      expect(page.getMediaBox()).toEqual({ x: 5, y: 5, width: 15, height: 45 });
-      expect(page.getCropBox()).toEqual({ x: 0, y: 0, width: 20, height: 50 });
-      expect(page.getBleedBox()).toEqual({ x: 5, y: 5, width: 10, height: 25 });
-      expect(page.getTrimBox()).toEqual({ x: 5, y: 0, width: 10, height: 50 });
-      expect(page.getArtBox()).toEqual({ x: 0, y: 5, width: 20, height: 25 });
-    });
-  });
-
-  // https://github.com/Hopding/pdf-lib/issues/1075
-  it(`drawImage() does not reuse existing XObject keys`, async () => {
-    const pdfDoc1 = await PDFDocument.create();
-    const image1 = await pdfDoc1.embedPng(birdPng);
-    const page1 = pdfDoc1.addPage();
-
-    expect(page1.node.normalizedEntries().XObject.keys().length).toEqual(0);
-    page1.drawImage(image1);
-    expect(page1.node.normalizedEntries().XObject.keys().length).toEqual(1);
-
-    const key1 = page1.node.normalizedEntries().XObject.keys()[0];
-
-    const pdfDoc2 = await PDFDocument.load(await pdfDoc1.save());
-    const image2 = await pdfDoc2.embedPng(birdPng);
-    const page2 = pdfDoc2.getPage(0);
-
-    expect(page2.node.normalizedEntries().XObject.keys().length).toEqual(1);
-    page2.drawImage(image2);
-    expect(page2.node.normalizedEntries().XObject.keys().length).toEqual(2);
-
-    const key2 = page2.node.normalizedEntries().XObject.keys()[1];
-    expect(key1).not.toEqual(key2);
-    expect(page2.node.normalizedEntries().XObject.keys()).toEqual([key1, key2]);
-  });
-
-  // https://github.com/Hopding/pdf-lib/issues/1075
-  it(`setFont() does not reuse existing Font keys`, async () => {
-    const pdfDoc1 = await PDFDocument.create();
-    const font1 = await pdfDoc1.embedFont(StandardFonts.Helvetica);
-    const page1 = pdfDoc1.addPage();
-
-    expect(page1.node.normalizedEntries().Font.keys().length).toEqual(0);
-    page1.setFont(font1);
-    expect(page1.node.normalizedEntries().Font.keys().length).toEqual(1);
-
-    const key1 = page1.node.normalizedEntries().Font.keys()[0];
-
-    const pdfDoc2 = await PDFDocument.load(await pdfDoc1.save());
-    const font2 = await pdfDoc2.embedFont(StandardFonts.Helvetica);
-    const page2 = pdfDoc2.getPage(0);
-
-    expect(page2.node.normalizedEntries().Font.keys().length).toEqual(1);
-    page2.setFont(font2);
-    expect(page2.node.normalizedEntries().Font.keys().length).toEqual(2);
-
-    const key2 = page2.node.normalizedEntries().Font.keys()[1];
-    expect(key1).not.toEqual(key2);
-    expect(page2.node.normalizedEntries().Font.keys()).toEqual([key1, key2]);
-  });
-});

package/__tests__/api/form/PDFCheckBox.spec.ts

@@ -1,71 +0,0 @@
-import fs from 'fs';
-import { PDFDocument, AnnotationFlags } from '../../../src/index';
-
-const fancyFieldsPdfBytes = fs.readFileSync('assets/pdfs/fancy_fields.pdf');
-const pdfDocPromise = PDFDocument.load(fancyFieldsPdfBytes);
-
-describe(`PDFCheckBox`, () => {
-  it(`can read its value`, async () => {
-    const pdfDoc = await pdfDocPromise;
-
-    const form = pdfDoc.getForm();
-
-    const isAFairy = form.getCheckBox('Are You A Fairy? 🌿');
-    const isPowerLevelOver9000 = form.getCheckBox(
-      'Is Your Power Level Over 9000? 💪',
-    );
-    const onePunch = form.getCheckBox(
-      'Can You Defeat Enemies In One Punch? 👊',
-    );
-    const everLetMeDown = form.getCheckBox('Will You Ever Let Me Down? ☕️');
-
-    expect(isAFairy.isChecked()).toBe(true);
-    expect(isPowerLevelOver9000.isChecked()).toBe(false);
-    expect(onePunch.isChecked()).toBe(true);
-    expect(everLetMeDown.isChecked()).toBe(false);
-  });
-
-  it(`can read its flag states`, async () => {
-    const pdfDoc = await pdfDocPromise;
-
-    const form = pdfDoc.getForm();
-
-    const isAFairy = form.getCheckBox('Are You A Fairy? 🌿');
-
-    expect(isAFairy.isExported()).toBe(true);
-    expect(isAFairy.isReadOnly()).toBe(false);
-    expect(isAFairy.isRequired()).toBe(false);
-  });
-
-  it(`produces printable widgets when added to a page`, async () => {
-    const pdfDoc = await PDFDocument.create();
-    const page = pdfDoc.addPage();
-
-    const form = pdfDoc.getForm();
-
-    const checkBox = form.createCheckBox('a.new.check.box');
-
-    const widgets = () => checkBox.acroField.getWidgets();
-    expect(widgets().length).toBe(0);
-
-    checkBox.addToPage(page);
-    expect(widgets().length).toBe(1);
-    expect(widgets()[0].hasFlag(AnnotationFlags.Print)).toBe(true);
-  });
-
-  it(`sets page reference when added to a page`, async () => {
-    const pdfDoc = await PDFDocument.create();
-    const page = pdfDoc.addPage();
-
-    const form = pdfDoc.getForm();
-
-    const checkBox = form.createCheckBox('a.new.check.box');
-
-    const widgets = () => checkBox.acroField.getWidgets();
-    expect(widgets().length).toBe(0);
-
-    checkBox.addToPage(page);
-    expect(widgets().length).toBe(1);
-    expect(widgets()[0].P()).toBe(page.ref);
-  });
-});

package/__tests__/api/form/PDFDropdown.spec.ts

@@ -1,118 +0,0 @@
-import fs from 'fs';
-import { PDFDocument, AnnotationFlags } from '../../../src';
-
-const fancyFieldsPdfBytes = fs.readFileSync('assets/pdfs/fancy_fields.pdf');
-
-describe(`PDFDropdown`, () => {
-  it(`can read its options`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    expect(gundams.getOptions()).toEqual([
-      'Exia',
-      'Kyrios',
-      'Virtue',
-      'Dynames',
-    ]);
-  });
-
-  it(`can read its selected value`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    expect(gundams.getSelected()).toEqual(['Dynames']);
-  });
-
-  it(`can clear its value`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    gundams.clear();
-    expect(gundams.getSelected()).toEqual([]);
-  });
-
-  it(`can select a single value`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    gundams.select('Kyrios');
-    expect(gundams.getSelected()).toEqual(['Kyrios']);
-  });
-
-  it(`can select multiple values`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    gundams.select(['Exia', 'Virtue']);
-    expect(gundams.getSelected()).toEqual(['Exia', 'Virtue']);
-  });
-
-  it(`can select a value not in the options list`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-
-    expect(gundams.isEditable()).toBe(false);
-    expect(gundams.getOptions()).not.toContain('One Punch Man');
-
-    gundams.select('One Punch Man');
-
-    expect(gundams.isEditable()).toBe(true);
-    expect(gundams.getSelected()).toEqual(['One Punch Man']);
-  });
-
-  it(`can merge options when selecting`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-    gundams.select(['Exia'], true);
-    expect(gundams.getSelected()).toEqual(['Dynames', 'Exia']);
-  });
-
-  it(`can read its flag states`, async () => {
-    const pdfDoc = await PDFDocument.load(fancyFieldsPdfBytes);
-    const form = pdfDoc.getForm();
-    const gundams = form.getDropdown('Choose A Gundam 🤖');
-
-    expect(gundams.isExported()).toBe(true);
-    expect(gundams.isReadOnly()).toBe(false);
-    expect(gundams.isRequired()).toBe(false);
-    expect(gundams.isEditable()).toBe(false);
-    expect(gundams.isMultiselect()).toBe(false);
-    expect(gundams.isSelectOnClick()).toBe(false);
-    expect(gundams.isSorted()).toBe(false);
-    expect(gundams.isSpellChecked()).toBe(true);
-  });
-
-  it(`produces printable widgets when added to a page`, async () => {
-    const pdfDoc = await PDFDocument.create();
-    const page = pdfDoc.addPage();
-
-    const form = pdfDoc.getForm();
-
-    const dropdown = form.createDropdown('a.new.dropdown');
-
-    const widgets = () => dropdown.acroField.getWidgets();
-    expect(widgets().length).toBe(0);
-
-    dropdown.addToPage(page);
-    expect(widgets().length).toBe(1);
-    expect(widgets()[0].hasFlag(AnnotationFlags.Print)).toBe(true);
-  });
-
-  it(`sets page reference when added to a page`, async () => {
-    const pdfDoc = await PDFDocument.create();
-    const page = pdfDoc.addPage();
-
-    const form = pdfDoc.getForm();
-
-    const dropdown = form.createDropdown('a.new.dropdown');
-
-    const widgets = () => dropdown.acroField.getWidgets();
-    expect(widgets().length).toBe(0);
-
-    dropdown.addToPage(page);
-    expect(widgets().length).toBe(1);
-    expect(widgets()[0].P()).toBe(page.ref);
-  });
-});