@pdfme/pdf-lib 1.18.4 → 5.4.0-dev.21

package/dist/cjs/__tests__/api/form/PDFOptionList.spec.js

@@ -0,0 +1,90 @@
+"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 index_1 = require("../../../src/index");
+const fancyFieldsPdfBytes = fs_1.default.readFileSync('assets/pdfs/fancy_fields.pdf');
+describe(`PDFOptionList`, () => {
+    it(`can read its options`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        expect(planets.getOptions()).toEqual(['Earth', 'Mars', 'Pluto', 'Neptune']);
+    });
+    it(`can read its selected value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        expect(planets.getSelected()).toEqual(['Mars']);
+    });
+    it(`can clear its value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        planets.clear();
+        expect(planets.getSelected()).toEqual([]);
+    });
+    it(`can select a single value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        planets.select('Neptune');
+        expect(planets.getSelected()).toEqual(['Neptune']);
+    });
+    it(`can select multiple values`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        planets.select(['Pluto', 'Neptune']);
+        expect(planets.getSelected()).toEqual(['Pluto', 'Neptune']);
+    });
+    it(`can't select a value not in the options list`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        expect(() => planets.select('One Punch Man')).toThrow();
+    });
+    it(`can merge options when selecting`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        planets.select(['Pluto'], true);
+        expect(planets.getSelected()).toEqual(['Mars', 'Pluto']);
+    });
+    it(`can read its flag states`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const planets = form.getOptionList('Which Are Planets? 🌎');
+        expect(planets.isExported()).toBe(true);
+        expect(planets.isReadOnly()).toBe(false);
+        expect(planets.isRequired()).toBe(false);
+        expect(planets.isMultiselect()).toBe(false);
+        expect(planets.isSelectOnClick()).toBe(false);
+        expect(planets.isSorted()).toBe(false);
+    });
+    it(`produces printable widgets when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const optionList = form.createOptionList('a.new.option.list');
+        const widgets = () => optionList.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        optionList.addToPage(page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].hasFlag(index_1.AnnotationFlags.Print)).toBe(true);
+    });
+    it(`sets page reference when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const optionList = form.createOptionList('a.new.option.list');
+        const widgets = () => optionList.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        optionList.addToPage(page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].P()).toBe(page.ref);
+    });
+});
+//# sourceMappingURL=PDFOptionList.spec.js.map

package/dist/cjs/__tests__/api/form/PDFOptionList.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFOptionList.spec.js","sourceRoot":"","sources":["../../../../../__tests__/api/form/PDFOptionList.spec.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,8CAAkE;AAElE,MAAM,mBAAmB,GAAG,YAAE,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC;AAE5E,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;QACrC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAC5D,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAE5D,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAe,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC3B,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/__tests__/api/form/PDFRadioGroup.spec.js

@@ -0,0 +1,142 @@
+"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 index_1 = require("../../../src/index");
+const fancyFieldsPdfBytes = fs_1.default.readFileSync('assets/pdfs/fancy_fields.pdf');
+describe(`PDFRadioGroup`, () => {
+    it(`can read its options`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const historicalFigures = form.getRadioGroup('Historical Figures 🐺');
+        expect(historicalFigures.getOptions()).toEqual([
+            'Marcus Aurelius 🏛️',
+            'Ada Lovelace 💻',
+            'Marie Curie ☢️',
+            'Alexander Hamilton 🇺🇸',
+        ]);
+    });
+    it(`can read its selected value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const historicalFigures = form.getRadioGroup('Historical Figures 🐺');
+        expect(historicalFigures.getSelected()).toEqual('Marcus Aurelius 🏛️');
+    });
+    it(`can clear its value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const historicalFigures = form.getRadioGroup('Historical Figures 🐺');
+        historicalFigures.clear();
+        expect(historicalFigures.getSelected()).toBe(undefined);
+    });
+    it(`can select a value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const historicalFigures = form.getRadioGroup('Historical Figures 🐺');
+        historicalFigures.select('Marie Curie ☢️');
+        expect(historicalFigures.getSelected()).toBe('Marie Curie ☢️');
+    });
+    it(`can read its flag states`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const historicalFigures = form.getRadioGroup('Historical Figures 🐺');
+        expect(historicalFigures.isExported()).toBe(true);
+        expect(historicalFigures.isReadOnly()).toBe(false);
+        expect(historicalFigures.isRequired()).toBe(false);
+        expect(historicalFigures.isMutuallyExclusive()).toBe(true);
+        expect(historicalFigures.isOffToggleable()).toBe(false);
+    });
+    it(`supports mutualExclusion=true`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const radioGroup = form.createRadioGroup('test.group');
+        radioGroup.enableMutualExclusion();
+        radioGroup.addOptionToPage('foo', page);
+        radioGroup.addOptionToPage('bar', page);
+        radioGroup.addOptionToPage('foo', page);
+        radioGroup.addOptionToPage('qux', page);
+        const getOnWidgets = () => radioGroup.acroField
+            .getWidgets()
+            .filter((w) => w.getOnValue() === radioGroup.acroField.getValue());
+        expect(getOnWidgets().length).toBe(0);
+        radioGroup.select('foo');
+        expect(getOnWidgets().length).toBe(1);
+        expect(radioGroup.getOptions()).toEqual(['foo', 'bar', 'foo', 'qux']);
+        const onValues = radioGroup.acroField
+            .getWidgets()
+            .map((w) => w.getOnValue());
+        expect(onValues).toEqual([
+            index_1.PDFName.of('0'),
+            index_1.PDFName.of('1'),
+            index_1.PDFName.of('2'),
+            index_1.PDFName.of('3'),
+        ]);
+        const opt = radioGroup.acroField.Opt();
+        expect(opt).toBeInstanceOf(index_1.PDFArray);
+        expect(opt.size()).toBe(4);
+        expect(opt.get(0).decodeText()).toBe('foo');
+        expect(opt.get(1).decodeText()).toBe('bar');
+        expect(opt.get(2).decodeText()).toBe('foo');
+        expect(opt.get(3).decodeText()).toBe('qux');
+    });
+    it(`supports mutualExclusion=false`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const radioGroup = form.createRadioGroup('test.group');
+        radioGroup.disableMutualExclusion();
+        radioGroup.addOptionToPage('foo', page);
+        radioGroup.addOptionToPage('bar', page);
+        radioGroup.addOptionToPage('foo', page);
+        radioGroup.addOptionToPage('qux', page);
+        const getOnWidgets = () => radioGroup.acroField
+            .getWidgets()
+            .filter((w) => w.getOnValue() === radioGroup.acroField.getValue());
+        expect(getOnWidgets().length).toBe(0);
+        radioGroup.select('foo');
+        expect(getOnWidgets().length).toBe(2);
+        expect(radioGroup.getOptions()).toEqual(['foo', 'bar', 'foo', 'qux']);
+        const onValues = radioGroup.acroField
+            .getWidgets()
+            .map((w) => w.getOnValue());
+        expect(onValues).toEqual([
+            index_1.PDFName.of('0'),
+            index_1.PDFName.of('1'),
+            index_1.PDFName.of('0'),
+            index_1.PDFName.of('3'),
+        ]);
+        const opt = radioGroup.acroField.Opt();
+        expect(opt).toBeInstanceOf(index_1.PDFArray);
+        expect(opt.size()).toBe(4);
+        expect(opt.get(0).decodeText()).toBe('foo');
+        expect(opt.get(1).decodeText()).toBe('bar');
+        expect(opt.get(2).decodeText()).toBe('foo');
+        expect(opt.get(3).decodeText()).toBe('qux');
+    });
+    it(`produces printable widgets when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const radioGroup = form.createRadioGroup('a.new.radio.group');
+        const widgets = () => radioGroup.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        radioGroup.addOptionToPage('foo', page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].hasFlag(index_1.AnnotationFlags.Print)).toBe(true);
+    });
+    it(`sets page reference when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const radioGroup = form.createRadioGroup('a.new.radio.group');
+        const widgets = () => radioGroup.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        radioGroup.addOptionToPage('foo', page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].P()).toBe(page.ref);
+    });
+});
+//# sourceMappingURL=PDFRadioGroup.spec.js.map

package/dist/cjs/__tests__/api/form/PDFRadioGroup.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFRadioGroup.spec.js","sourceRoot":"","sources":["../../../../../__tests__/api/form/PDFRadioGroup.spec.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,8CAM4B;AAE5B,MAAM,mBAAmB,GAAG,YAAE,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC;AAE5E,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACtE,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC;YAC7C,qBAAqB;YACrB,iBAAiB;YACjB,gBAAgB;YAChB,yBAAyB;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACtE,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACnC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACtE,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC1B,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QACtE,iBAAiB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QAC3C,MAAM,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG,IAAI,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAEtE,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,MAAM,CAAC,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACvD,UAAU,CAAC,qBAAqB,EAAE,CAAC;QAEnC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAExC,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,UAAU,CAAC,SAAS;aACjB,UAAU,EAAE;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEzB,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS;aAClC,UAAU,EAAE;aACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;QAE9B,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;YACvB,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;SAChB,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,EAAc,CAAC;QACnD,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,gBAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC9C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QACvD,UAAU,CAAC,sBAAsB,EAAE,CAAC;QAEpC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAExC,MAAM,YAAY,GAAG,GAAG,EAAE,CACxB,UAAU,CAAC,SAAS;aACjB,UAAU,EAAE;aACZ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,KAAK,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEvE,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEzB,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAG,UAAU,CAAC,SAAS;aAClC,UAAU,EAAE;aACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC;QAE9B,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC;YACvB,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YACf,eAAO,CAAC,EAAE,CAAC,GAAG,CAAC;SAChB,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,UAAU,CAAC,SAAS,CAAC,GAAG,EAAc,CAAC;QACnD,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,CAAC,gBAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3B,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,MAAM,CAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAkB,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAe,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAE9D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACxD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/__tests__/api/form/PDFTextField.spec.js

@@ -0,0 +1,116 @@
+"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 index_1 = require("../../../src/index");
+const fancyFieldsPdfBytes = fs_1.default.readFileSync('assets/pdfs/fancy_fields.pdf');
+describe(`PDFTextField`, () => {
+    it(`can read its value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const prefix = form.getTextField('Prefix ⚽️');
+        const firstName = form.getTextField('First Name 🚀');
+        const middleInitial = form.getTextField('MiddleInitial 🎳');
+        const lastName = form.getTextField('LastName 🛩');
+        expect(prefix.getText()).toEqual('Ms.');
+        expect(firstName.getText()).toEqual('Cedar');
+        expect(middleInitial.getText()).toEqual('M');
+        expect(lastName.getText()).toEqual('Lightningtwirls');
+    });
+    it(`can read its alignment`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const prefix = form.getTextField('Prefix ⚽️');
+        const firstName = form.getTextField('First Name 🚀');
+        const middleInitial = form.getTextField('MiddleInitial 🎳');
+        const lastName = form.getTextField('LastName 🛩');
+        expect(prefix.getAlignment()).toEqual(index_1.TextAlignment.Center);
+        expect(firstName.getAlignment()).toEqual(index_1.TextAlignment.Left);
+        expect(middleInitial.getAlignment()).toEqual(index_1.TextAlignment.Center);
+        expect(lastName.getAlignment()).toEqual(index_1.TextAlignment.Right);
+    });
+    it(`can write a value`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const prefix = form.getTextField('Prefix ⚽️');
+        const firstName = form.getTextField('First Name 🚀');
+        const middleInitial = form.getTextField('MiddleInitial 🎳');
+        const lastName = form.getTextField('LastName 🛩');
+        prefix.setText('Some boats 🚤');
+        firstName.setText('Chili peppers 🌶');
+        middleInitial.setText('Pineapplez 🍍');
+        lastName.setText('And christmas trees! 🎄');
+        expect(prefix.getText()).toEqual('Some boats 🚤');
+        expect(firstName.getText()).toEqual('Chili peppers 🌶');
+        expect(middleInitial.getText()).toEqual('Pineapplez 🍍');
+        expect(lastName.getText()).toEqual('And christmas trees! 🎄');
+    });
+    it(`can read its flag states`, async () => {
+        const pdfDoc = await index_1.PDFDocument.load(fancyFieldsPdfBytes);
+        const form = pdfDoc.getForm();
+        const prefix = form.getTextField('Prefix ⚽️');
+        expect(prefix.isExported()).toBe(true);
+        expect(prefix.isReadOnly()).toBe(false);
+        expect(prefix.isRequired()).toBe(false);
+        expect(prefix.isFileSelector()).toBe(false);
+        expect(prefix.isMultiline()).toBe(false);
+        expect(prefix.isPassword()).toBe(false);
+        expect(prefix.isRichFormatted()).toBe(false);
+        expect(prefix.isScrollable()).toBe(true);
+        expect(prefix.isSpellChecked()).toBe(true);
+        expect(prefix.isCombed()).toBe(false);
+    });
+    it(`throws an error when setting text that exceeds the max length`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const form = pdfDoc.getForm();
+        const textField = form.createTextField('foo.bar');
+        textField.setMaxLength(5);
+        expect(() => textField.setText('abcde')).not.toThrow();
+        expect(() => textField.setText('abcdef')).toThrow();
+    });
+    it(`throws an error when setting a max length less than the text length`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const form = pdfDoc.getForm();
+        const textField = form.createTextField('foo.bar');
+        textField.setText('abcdef');
+        expect(() => textField.setMaxLength(undefined)).not.toThrow();
+        expect(() => textField.setMaxLength(6)).not.toThrow();
+        expect(() => textField.setMaxLength(7)).not.toThrow();
+        expect(() => textField.setMaxLength(5)).toThrow();
+    });
+    it(`produces printable widgets when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const textField = form.createTextField('a.new.text.field');
+        const widgets = () => textField.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        textField.addToPage(page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].hasFlag(index_1.AnnotationFlags.Print)).toBe(true);
+    });
+    it(`sets page reference when added to a page`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const textField = form.createTextField('a.new.text.field');
+        const widgets = () => textField.acroField.getWidgets();
+        expect(widgets().length).toBe(0);
+        textField.addToPage(page);
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].P()).toBe(page.ref);
+    });
+    it(`sets the 'hidden' flag when passed options.hidden`, async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const page = pdfDoc.addPage();
+        const form = pdfDoc.getForm();
+        const textField = form.createTextField('a.hidden.text.field');
+        const widgets = () => textField.acroField.getWidgets();
+        textField.addToPage(page, { hidden: true });
+        expect(widgets().length).toBe(1);
+        expect(widgets()[0].hasFlag(index_1.AnnotationFlags.Hidden)).toBe(true);
+    });
+});
+//# sourceMappingURL=PDFTextField.spec.js.map

package/dist/cjs/__tests__/api/form/PDFTextField.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFTextField.spec.js","sourceRoot":"","sources":["../../../../../__tests__/api/form/PDFTextField.spec.ts"],"names":[],"mappings":";;;;;AAAA,4CAAoB;AACpB,8CAI4B;AAE5B,MAAM,mBAAmB,GAAG,YAAE,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAC;AAE5E,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC7C,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAa,CAAC,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAa,CAAC,IAAI,CAAC,CAAC;QAC7D,MAAM,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAa,CAAC,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAa,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAE3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QAElD,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAChC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACtC,aAAa,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACvC,QAAQ,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAE5C,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxD,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACzD,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAE9C,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAElD,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC1B,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACvD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAElD,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5B,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC9D,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACvD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAe,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;QAE3D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QACvD,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEjC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAE9B,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAEvD,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAE5C,MAAM,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAe,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/__tests__/api/svgPath.spec.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const svgPath_1 = require("../../src/api/svgPath");
+// Test paths adapted from https://svgwg.org/svg2-draft/paths.html
+describe(`svgPathToOperators`, () => {
+    it(`can map triangle paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M 100 100 L 300 100 L 200 300 z');
+        expect(operators.length).toBe(4);
+        expect(operators.toString()).toBe('100 100 m,300 100 l,200 300 l,h');
+    });
+    it(`can map relative triangle paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('m 100 100 l 200 0 l -100 200 z');
+        expect(operators.length).toBe(4);
+        expect(operators.toString()).toBe('100 100 m,300 100 l,200 300 l,h');
+    });
+    it(`can map triangle decimal paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M 50.5 100 L 250.5 100 150.5 300 z');
+        expect(operators.length).toBe(4);
+        expect(operators.toString()).toBe('50.5 100 m,250.5 100 l,150.5 300 l,h');
+    });
+    it(`can map rectangle with lines paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M 50 50 V 100 H 100 v -100 h -50 Z');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('50 50 m,50 100 l,100 100 l,100 0 l,50 0 l,h');
+    });
+    it(`can map bezier curve paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M100,200 C100,100 250,100 250,200 S400,300 400,200');
+        expect(operators.length).toBe(3);
+        expect(operators.toString()).toBe('100 200 m,100 100 250 100 250 200 c,250 300 400 300 400 200 c');
+    });
+    it(`can map relative bezier curve paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M100,200 c0,-100 150,-100 150,0 s150,100 150,0');
+        expect(operators.length).toBe(3);
+        expect(operators.toString()).toBe('100 200 m,100 100 250 100 250 200 c,250 300 400 300 400 200 c');
+    });
+    it(`can map quadratic curve paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M200,300 Q400,50 600,300 T1000,300');
+        expect(operators.length).toBe(3);
+        expect(operators.toString()).toBe('200 300 m,400 50 600 300 v,800 550 1000 300 v');
+    });
+    it(`can map relative quadratic curve paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M200,300 q200,-250 400,0 t400,0');
+        expect(operators.length).toBe(3);
+        expect(operators.toString()).toBe('200 300 m,400 50 600 300 v,800 550 1000 300 v');
+    });
+    it(`can map arc paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M300,200 h-150 a150,150 0 1,0 150,-150 z');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('300 200 m,150 200 l,150 282.8427124746191 217.15728752538098 350 300 350 c,382.84271247461896 350 450 282.842712474619 450 200.00000000000003 c,450 117.15728752538101 382.84271247461896 50.00000000000003 300 50.00000000000002 c,h');
+    });
+    it(`can map relative arc paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M300,200 h-150 A150,150 0 1,0 300,50 z');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('300 200 m,150 200 l,150 282.8427124746191 217.15728752538098 350 300 350 c,382.84271247461896 350 450 282.842712474619 450 200.00000000000003 c,450 117.15728752538101 382.84271247461896 50.00000000000003 300 50.00000000000002 c,h');
+    });
+    it(`can map cubic bezier paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('m 100 100 S 200,100 200,200 200,200 100,200 T 0,250');
+        expect(operators.length).toBe(4);
+        expect(operators.toString()).toBe('100 100 m,100 100 200 100 200 200 c,200 300 200 200 100 200 c,0 200 0 250 v');
+    });
+    it(`can map dashed line paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M 0,25 5,25 M 10,25 15,25 M 20,25 25,25');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('0 25 m,5 25 l,10 25 m,15 25 l,20 25 m,25 25 l');
+    });
+    it(`can map relative dashed line paths to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('m 0,25 5,0 m 5,0 5,0 m 5,0 5,0');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('0 25 m,5 25 l,10 25 m,15 25 l,20 25 m,25 25 l');
+    });
+    it(`can map paths with odd inputs to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M 0,25 5,25 m 5-0 5..0 m 5,0 5,0');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('0 25 m,5 25 l,10 25 m,15 25 l,20 25 m,25 25 l');
+    });
+    it(`can map paths that reset cubic bezier control points to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M100 100 S200,100 200,200 M95 105 s100,0 100,100');
+        expect(operators.length).toBe(4);
+        expect(operators.toString()).toBe('100 100 m,100 100 200 100 200 200 c,95 105 m,95 105 195 105 195 205 c');
+    });
+    it(`can map paths that reset quadratic bezier control points to PDF operators`, () => {
+        const operators = (0, svgPath_1.svgPathToOperators)('M100 100 T100,200 200,200 M90,120 t0,100 100,0');
+        expect(operators.length).toBe(6);
+        expect(operators.toString()).toBe('100 100 m,100 100 100 200 v,100 300 200 200 v,90 120 m,90 120 90 220 v,90 320 190 220 v');
+    });
+    it(`correctly updates control points for T command`, () => {
+        // See https://github.com/Hopding/pdf-lib/issues/1443
+        const operators = (0, svgPath_1.svgPathToOperators)('M 10,25 Q 30,0 50,25 Q 70,50 90,25 T 130,25 T 170,25');
+        expect(operators.length).toBe(5);
+        expect(operators.toString()).toBe('10 25 m,30 0 50 25 v,70 50 90 25 v,110 0 130 25 v,150 50 170 25 v');
+    });
+});
+//# sourceMappingURL=svgPath.spec.js.map

package/dist/cjs/__tests__/api/svgPath.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"svgPath.spec.js","sourceRoot":"","sources":["../../../../__tests__/api/svgPath.spec.ts"],"names":[],"mappings":";;AAAA,mDAA2D;AAE3D,kEAAkE;AAClE,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,iCAAiC,CAAC,CAAC;QACxE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,gCAAgC,CAAC,CAAC;QACvE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,oCAAoC,CAAC,CAAC;QAC3E,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,oCAAoC,CAAC,CAAC;QAC3E,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,6CAA6C,CAC9C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,oDAAoD,CACrD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+DAA+D,CAChE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,gDAAgD,CACjD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+DAA+D,CAChE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,oCAAoC,CAAC,CAAC;QAC3E,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+CAA+C,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,iCAAiC,CAAC,CAAC;QACxE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+CAA+C,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,0CAA0C,CAC3C,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,uOAAuO,CACxO,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,wCAAwC,CACzC,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,uOAAuO,CACxO,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,qDAAqD,CACtD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,6EAA6E,CAC9E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,yCAAyC,CAC1C,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+CAA+C,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,gCAAgC,CAAC,CAAC;QACvE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+CAA+C,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAAC,kCAAkC,CAAC,CAAC;QACzE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,+CAA+C,CAChD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,kDAAkD,CACnD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,uEAAuE,CACxE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,gDAAgD,CACjD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,yFAAyF,CAC1F,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,qDAAqD;QACrD,MAAM,SAAS,GAAG,IAAA,4BAAkB,EAClC,sDAAsD,CACvD,CAAC;QACF,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAC/B,mEAAmE,CACpE,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/cjs/__tests__/api/text/layout.spec.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../../../src/index");
+const layout_1 = require("../../../src/api/text/layout");
+const MIN_FONT_SIZE = 4;
+const MAX_FONT_SIZE = 500;
+describe(`layoutMultilineText`, () => {
+    it('should layout the text on one line when it fits near-perfectly', async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const font = await pdfDoc.embedFont(index_1.StandardFonts.Helvetica);
+        const alignment = index_1.TextAlignment.Left;
+        const padding = 0;
+        const borderWidth = 0;
+        const text = 'Super Mario Bros.';
+        for (let fontSize = MIN_FONT_SIZE; fontSize <= MAX_FONT_SIZE; fontSize++) {
+            const height = font.heightAtSize(fontSize) - (borderWidth + padding) * 2;
+            const width = font.widthOfTextAtSize(text, fontSize) - (borderWidth + padding) * 2;
+            const bounds = {
+                x: borderWidth + padding,
+                y: borderWidth + padding,
+                width,
+                height,
+            };
+            const multilineTextLayout = (0, layout_1.layoutMultilineText)(text, {
+                alignment,
+                bounds,
+                font,
+            });
+            expect(multilineTextLayout.lines.length).toStrictEqual(1);
+        }
+    });
+    it('should layout the text on one line when it fits comfortably', async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const font = await pdfDoc.embedFont(index_1.StandardFonts.Helvetica);
+        const alignment = index_1.TextAlignment.Left;
+        const padding = 0;
+        const borderWidth = 0;
+        const text = 'Super Mario Bros.';
+        const fontSize = 12;
+        const height = font.heightAtSize(fontSize) - (borderWidth + padding) * 2;
+        // Bounds width twice that of the text
+        const width = (font.widthOfTextAtSize(text, fontSize) - (borderWidth + padding) * 2) *
+            2;
+        const bounds = {
+            x: borderWidth + padding,
+            y: borderWidth + padding,
+            width,
+            height,
+        };
+        const multilineTextLayout = (0, layout_1.layoutMultilineText)(text, {
+            alignment,
+            bounds,
+            font,
+        });
+        expect(multilineTextLayout.lines.length).toStrictEqual(1);
+    });
+    it('should layout the text on multiple lines when it does not fit horizontally but there is space vertically', async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const font = await pdfDoc.embedFont(index_1.StandardFonts.Helvetica);
+        const alignment = index_1.TextAlignment.Left;
+        const padding = 0;
+        const borderWidth = 0;
+        const text = 'Super Mario Bros.';
+        for (let fontSize = MIN_FONT_SIZE; fontSize <= MAX_FONT_SIZE; fontSize++) {
+            // Height twice that of the text
+            const height = (font.heightAtSize(fontSize) - (borderWidth + padding) * 2) * 2;
+            // Width half that of the text
+            const width = (font.widthOfTextAtSize(text, fontSize) - (borderWidth + padding) * 2) /
+                2;
+            const bounds = {
+                x: borderWidth + padding,
+                y: borderWidth + padding,
+                width,
+                height,
+            };
+            const multilineTextLayout = (0, layout_1.layoutMultilineText)(text, {
+                alignment,
+                bounds,
+                font,
+            });
+            expect(multilineTextLayout.lines.length).toStrictEqual(2);
+        }
+    });
+    it('should never exceed the maximum font size', async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const font = await pdfDoc.embedFont(index_1.StandardFonts.Helvetica);
+        const alignment = index_1.TextAlignment.Left;
+        const padding = 0;
+        const borderWidth = 0;
+        const text = 'Super Mario Bros.';
+        const height = Number.MAX_VALUE;
+        const width = Number.MAX_VALUE;
+        const bounds = {
+            x: borderWidth + padding,
+            y: borderWidth + padding,
+            width,
+            height,
+        };
+        const multilineTextLayout = (0, layout_1.layoutMultilineText)(text, {
+            alignment,
+            bounds,
+            font,
+        });
+        expect(multilineTextLayout.lines.length).toStrictEqual(1);
+        expect(multilineTextLayout.fontSize).toStrictEqual(MAX_FONT_SIZE);
+    });
+    it('should respect empty lines', async () => {
+        const pdfDoc = await index_1.PDFDocument.create();
+        const font = await pdfDoc.embedFont(index_1.StandardFonts.Helvetica);
+        const alignment = index_1.TextAlignment.Left;
+        const padding = 0;
+        const borderWidth = 0;
+        const lines = ['Super Mario Bros.', '', 'Boop'];
+        const text = lines.join('\n');
+        for (let fontSize = MIN_FONT_SIZE; fontSize <= MAX_FONT_SIZE; fontSize++) {
+            const height = font.heightAtSize(fontSize) - (borderWidth + padding) * 2;
+            const width = font.widthOfTextAtSize(lines[0], fontSize) -
+                (borderWidth + padding) * 2;
+            const bounds = {
+                x: borderWidth + padding,
+                y: borderWidth + padding,
+                width,
+                height,
+            };
+            const multilineTextLayout = (0, layout_1.layoutMultilineText)(text, {
+                alignment,
+                bounds,
+                font,
+            });
+            expect(multilineTextLayout.lines.length).toStrictEqual(3);
+        }
+    });
+});
+//# sourceMappingURL=layout.spec.js.map

package/dist/cjs/__tests__/api/text/layout.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout.spec.js","sourceRoot":"","sources":["../../../../../__tests__/api/text/layout.spec.ts"],"names":[],"mappings":";;AAAA,8CAA+E;AAE/E,yDAAmE;AAEnE,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,MAAM,aAAa,GAAG,GAAG,CAAC;AAE1B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,qBAAa,CAAC,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC;QAClB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,IAAI,GAAG,mBAAmB,CAAC;QAEjC,KAAK,IAAI,QAAQ,GAAG,aAAa,EAAE,QAAQ,IAAI,aAAa,EAAE,QAAQ,EAAE,EAAE,CAAC;YACzE,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAEzE,MAAM,KAAK,GACT,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAEvE,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,KAAK;gBACL,MAAM;aACP,CAAC;YAEF,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAAC,IAAI,EAAE;gBACpD,SAAS;gBACT,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YAEH,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,qBAAa,CAAC,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC;QAClB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,IAAI,GAAG,mBAAmB,CAAC;QACjC,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAEzE,sCAAsC;QACtC,MAAM,KAAK,GACT,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YACtE,CAAC,CAAC;QAEJ,MAAM,MAAM,GAAG;YACb,CAAC,EAAE,WAAW,GAAG,OAAO;YACxB,CAAC,EAAE,WAAW,GAAG,OAAO;YACxB,KAAK;YACL,MAAM;SACP,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAAC,IAAI,EAAE;YACpD,SAAS;YACT,MAAM;YACN,IAAI;SACL,CAAC,CAAC;QAEH,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;QACxH,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,qBAAa,CAAC,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC;QAClB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,IAAI,GAAG,mBAAmB,CAAC;QAEjC,KAAK,IAAI,QAAQ,GAAG,aAAa,EAAE,QAAQ,IAAI,aAAa,EAAE,QAAQ,EAAE,EAAE,CAAC;YACzE,gCAAgC;YAChC,MAAM,MAAM,GACV,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAElE,8BAA8B;YAC9B,MAAM,KAAK,GACT,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBACtE,CAAC,CAAC;YAEJ,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,KAAK;gBACL,MAAM;aACP,CAAC;YAEF,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAAC,IAAI,EAAE;gBACpD,SAAS;gBACT,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YAEH,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,qBAAa,CAAC,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC;QAClB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,IAAI,GAAG,mBAAmB,CAAC;QAEjC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC;QAE/B,MAAM,MAAM,GAAG;YACb,CAAC,EAAE,WAAW,GAAG,OAAO;YACxB,CAAC,EAAE,WAAW,GAAG,OAAO;YACxB,KAAK;YACL,MAAM;SACP,CAAC;QAEF,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAAC,IAAI,EAAE;YACpD,SAAS;YACT,MAAM;YACN,IAAI;SACL,CAAC,CAAC;QAEH,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC1D,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,MAAM,GAAG,MAAM,mBAAW,CAAC,MAAM,EAAE,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,qBAAa,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,qBAAa,CAAC,IAAI,CAAC;QACrC,MAAM,OAAO,GAAG,CAAC,CAAC;QAClB,MAAM,WAAW,GAAG,CAAC,CAAC;QACtB,MAAM,KAAK,GAAG,CAAC,mBAAmB,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE9B,KAAK,IAAI,QAAQ,GAAG,aAAa,EAAE,QAAQ,IAAI,aAAa,EAAE,QAAQ,EAAE,EAAE,CAAC;YACzE,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAEzE,MAAM,KAAK,GACT,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;gBAC1C,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAE9B,MAAM,MAAM,GAAG;gBACb,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,CAAC,EAAE,WAAW,GAAG,OAAO;gBACxB,KAAK;gBACL,MAAM;aACP,CAAC;YAEF,MAAM,mBAAmB,GAAG,IAAA,4BAAmB,EAAC,IAAI,EAAE;gBACpD,SAAS;gBACT,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YAEH,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}