@pdfme/pdf-lib/dist/cjs/__tests__/api/form/PDFDropdown.spec.js

Create and modify PDF files with JavaScript

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const fs_1 = __importDefault(require("fs"));
const src_1 = require("../../../src");
const fancyFieldsPdfBytes = fs_1.default.readFileSync('assets/pdfs/fancy_fields.pdf');
describe(`PDFDropdown`, () => {
    it(`can read its options`, async () => {
        const pdfDoc = await src_1.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 src_1.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 src_1.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 src_1.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 src_1.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 src_1.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 src_1.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 src_1.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 src_1.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(src_1.AnnotationFlags.Print)).toBe(true);
    });
    it(`sets page reference when added to a page`, async () => {
        const pdfDoc = await src_1.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);
    });
});
//# sourceMappingURL=PDFDropdown.spec.js.map