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

package/dist/esm/src/api/form/PDFRadioGroup.js

@@ -0,0 +1,419 @@
+import PDFPage from '../PDFPage';
+import PDFField, { assertFieldAppearanceOptions, } from './PDFField';
+import { normalizeAppearance, defaultRadioGroupAppearanceProvider, } from './appearances';
+import { rgb } from '../colors';
+import { degrees } from '../rotations';
+import { PDFName, PDFHexString, PDFDict, PDFAcroRadioButton, AcroButtonFlags, } from '../../core';
+import { assertIs, assertOrUndefined, assertIsOneOf } from '../../utils';
+/**
+ * Represents a radio group field of a [[PDFForm]].
+ *
+ * [[PDFRadioGroup]] fields are collections of radio buttons. The purpose of a
+ * radio group is to enable users to select one option from a set of mutually
+ * exclusive choices. Each choice in a radio group is represented by a radio
+ * button. Radio buttons each have two states: `on` and `off`. At most one
+ * radio button in a group may be in the `on` state at any time. Users can
+ * click on a radio button to select it (and thereby automatically deselect any
+ * other radio button that might have already been selected). Some radio
+ * groups allow users to toggle a selected radio button `off` by clicking on
+ * it (see [[PDFRadioGroup.isOffToggleable]]).
+ *
+ * Note that some radio groups allow multiple radio buttons to be in the `on`
+ * state at the same type **if** they represent the same underlying value (see
+ * [[PDFRadioGroup.isMutuallyExclusive]]).
+ */
+class PDFRadioGroup extends PDFField {
+    constructor(acroRadioButton, ref, doc) {
+        super(acroRadioButton, ref, doc);
+        /** The low-level PDFAcroRadioButton wrapped by this radio group. */
+        Object.defineProperty(this, "acroField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        assertIs(acroRadioButton, 'acroRadioButton', [
+            [PDFAcroRadioButton, 'PDFAcroRadioButton'],
+        ]);
+        this.acroField = acroRadioButton;
+    }
+    /**
+     * Get the list of available options for this radio group. Each option is
+     * represented by a radio button. These radio buttons are displayed at
+     * various locations in the document, potentially on different pages (though
+     * typically they are stacked horizontally or vertically on the same page).
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * const options = radioGroup.getOptions()
+     * console.log('Radio Group options:', options)
+     * ```
+     * @returns The options for this radio group.
+     */
+    getOptions() {
+        const exportValues = this.acroField.getExportValues();
+        if (exportValues) {
+            const exportOptions = new Array(exportValues.length);
+            for (let idx = 0, len = exportValues.length; idx < len; idx++) {
+                exportOptions[idx] = exportValues[idx].decodeText();
+            }
+            return exportOptions;
+        }
+        const onValues = this.acroField.getOnValues();
+        const onOptions = new Array(onValues.length);
+        for (let idx = 0, len = onOptions.length; idx < len; idx++) {
+            onOptions[idx] = onValues[idx].decodeText();
+        }
+        return onOptions;
+    }
+    /**
+     * Get the selected option for this radio group. The selected option is
+     * represented by the radio button in this group that is turned on. At most
+     * one radio button in a group can be selected. If no buttons in this group
+     * are selected, `undefined` is returned.
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * const selected = radioGroup.getSelected()
+     * console.log('Selected radio button:', selected)
+     * ```
+     * @returns The selected option for this radio group.
+     */
+    getSelected() {
+        const value = this.acroField.getValue();
+        if (value === PDFName.of('Off'))
+            return undefined;
+        const exportValues = this.acroField.getExportValues();
+        if (exportValues) {
+            const onValues = this.acroField.getOnValues();
+            for (let idx = 0, len = onValues.length; idx < len; idx++) {
+                if (onValues[idx] === value)
+                    return exportValues[idx].decodeText();
+            }
+        }
+        return value.decodeText();
+    }
+    // // TODO: Figure out why this seems to crash Acrobat. Maybe it's because we
+    // //       aren't removing the widget reference from the page's Annots?
+    // removeOption(option: string) {
+    //   assertIs(option, 'option', ['string']);
+    //   // TODO: Assert is valid `option`!
+    //   const onValues = this.acroField.getOnValues();
+    //   const exportValues = this.acroField.getExportValues();
+    //   if (exportValues) {
+    //     for (let idx = 0, len = exportValues.length; idx < len; idx++) {
+    //       if (exportValues[idx].decodeText() === option) {
+    //         this.acroField.removeWidget(idx);
+    //         this.acroField.removeExportValue(idx);
+    //       }
+    //     }
+    //   } else {
+    //     for (let idx = 0, len = onValues.length; idx < len; idx++) {
+    //       const value = onValues[idx];
+    //       if (value.decodeText() === option) {
+    //         this.acroField.removeWidget(idx);
+    //         this.acroField.removeExportValue(idx);
+    //       }
+    //     }
+    //   }
+    // }
+    /**
+     * Select an option for this radio group. This operation is analogous to a
+     * human user clicking one of the radio buttons in this group via a PDF
+     * reader to toggle it on. This method will update the underlying state of
+     * the radio group to indicate which option has been selected. PDF libraries
+     * and readers will be able to extract this value from the saved document and
+     * determine which option was selected.
+     *
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('best.superhero.radioGroup')
+     * radioGroup.select('One Punch Man')
+     * ```
+     *
+     * This method will mark this radio group as dirty, causing its appearance
+     * streams to be updated when either [[PDFDocument.save]] or
+     * [[PDFForm.updateFieldAppearances]] is called. The updated appearance
+     * streams will display a dot inside the widget of this check box field
+     * that represents the selected option.
+     *
+     * @param option The option to be selected.
+     */
+    select(option) {
+        assertIs(option, 'option', ['string']);
+        const validOptions = this.getOptions();
+        assertIsOneOf(option, 'option', validOptions);
+        this.markAsDirty();
+        const onValues = this.acroField.getOnValues();
+        const exportValues = this.acroField.getExportValues();
+        if (exportValues) {
+            for (let idx = 0, len = exportValues.length; idx < len; idx++) {
+                if (exportValues[idx].decodeText() === option) {
+                    this.acroField.setValue(onValues[idx]);
+                }
+            }
+        }
+        else {
+            for (let idx = 0, len = onValues.length; idx < len; idx++) {
+                const value = onValues[idx];
+                if (value.decodeText() === option)
+                    this.acroField.setValue(value);
+            }
+        }
+    }
+    /**
+     * Clear any selected option for this dropdown. This will result in all
+     * radio buttons in this group being toggled off. This method will update
+     * the underlying state of the dropdown to indicate that no radio buttons
+     * have been selected.
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.clear()
+     * ```
+     * This method will mark this radio group as dirty. See
+     * [[PDFRadioGroup.select]] for more details about what this means.
+     */
+    clear() {
+        this.markAsDirty();
+        this.acroField.setValue(PDFName.of('Off'));
+    }
+    /**
+     * Returns `true` if users can click on radio buttons in this group to toggle
+     * them off. The alternative is that once a user clicks on a radio button
+     * to select it, the only way to deselect it is by selecting on another radio
+     * button in the group. See [[PDFRadioGroup.enableOffToggling]] and
+     * [[PDFRadioGroup.disableOffToggling]]. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.isOffToggleable()) console.log('Off toggling is enabled')
+     * ```
+     */
+    isOffToggleable() {
+        return !this.acroField.hasFlag(AcroButtonFlags.NoToggleToOff);
+    }
+    /**
+     * Allow users to click on selected radio buttons in this group to toggle
+     * them off. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.enableOffToggling()
+     * ```
+     * > **NOTE:** This feature is documented in the PDF specification
+     * > (Table 226). However, most PDF readers do not respect this option and
+     * > prevent users from toggling radio buttons off even when it is enabled.
+     * > At the time of this writing (9/6/2020) Mac's Preview software did
+     * > respect the option. Adobe Acrobat, Foxit Reader, and Google Chrome did
+     * > not.
+     */
+    enableOffToggling() {
+        this.acroField.setFlagTo(AcroButtonFlags.NoToggleToOff, false);
+    }
+    /**
+     * Prevent users from clicking on selected radio buttons in this group to
+     * toggle them off. Clicking on a selected radio button will have no effect.
+     * The only way to deselect a selected radio button is to click on a
+     * different radio button in the group. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.disableOffToggling()
+     * ```
+     */
+    disableOffToggling() {
+        this.acroField.setFlagTo(AcroButtonFlags.NoToggleToOff, true);
+    }
+    /**
+     * Returns `true` if the radio buttons in this group are mutually exclusive.
+     * This means that when the user selects a radio button, only that specific
+     * button will be turned on. Even if other radio buttons in the group
+     * represent the same value, they will not be enabled. The alternative to
+     * this is that clicking a radio button will select that button along with
+     * any other radio buttons in the group that share the same value. See
+     * [[PDFRadioGroup.enableMutualExclusion]] and
+     * [[PDFRadioGroup.disableMutualExclusion]].
+     * For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.isMutuallyExclusive()) console.log('Mutual exclusion is enabled')
+     * ```
+     */
+    isMutuallyExclusive() {
+        return !this.acroField.hasFlag(AcroButtonFlags.RadiosInUnison);
+    }
+    /**
+     * When the user clicks a radio button in this group it will be selected. In
+     * addition, any other radio buttons in this group that share the same
+     * underlying value will also be selected. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.enableMutualExclusion()
+     * ```
+     * Note that this option must be enabled prior to adding options to the
+     * radio group. It does not currently apply retroactively to existing
+     * radio buttons in the group.
+     */
+    enableMutualExclusion() {
+        this.acroField.setFlagTo(AcroButtonFlags.RadiosInUnison, false);
+    }
+    /**
+     * When the user clicks a radio button in this group only it will be selected.
+     * No other radio buttons in the group will be selected, even if they share
+     * the same underlying value. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.disableMutualExclusion()
+     * ```
+     * Note that this option must be disabled prior to adding options to the
+     * radio group. It does not currently apply retroactively to existing
+     * radio buttons in the group.
+     */
+    disableMutualExclusion() {
+        this.acroField.setFlagTo(AcroButtonFlags.RadiosInUnison, true);
+    }
+    /**
+     * Add a new radio button to this group on the specified page. For example:
+     * ```js
+     * const page = pdfDoc.addPage()
+     *
+     * const form = pdfDoc.getForm()
+     * const radioGroup = form.createRadioGroup('best.gundam')
+     *
+     * const options = {
+     *   x: 50,
+     *   width: 25,
+     *   height: 25,
+     *   textColor: rgb(1, 0, 0),
+     *   backgroundColor: rgb(0, 1, 0),
+     *   borderColor: rgb(0, 0, 1),
+     *   borderWidth: 2,
+     *   rotate: degrees(90),
+     * }
+     *
+     * radioGroup.addOptionToPage('Exia', page, { ...options, y: 50 })
+     * radioGroup.addOptionToPage('Dynames', page, { ...options, y: 110 })
+     * ```
+     * This will create a new radio button widget for this radio group field.
+     * @param option The option that the radio button widget represents.
+     * @param page The page to which the radio button widget should be added.
+     * @param options The options to be used when adding the radio button widget.
+     */
+    addOptionToPage(option, page, options) {
+        assertIs(option, 'option', ['string']);
+        assertIs(page, 'page', [[PDFPage, 'PDFPage']]);
+        assertFieldAppearanceOptions(options);
+        // Create a widget for this radio button
+        const widget = this.createWidget({
+            x: options?.x ?? 0,
+            y: options?.y ?? 0,
+            width: options?.width ?? 50,
+            height: options?.height ?? 50,
+            textColor: options?.textColor ?? rgb(0, 0, 0),
+            backgroundColor: options?.backgroundColor ?? rgb(1, 1, 1),
+            borderColor: options?.borderColor ?? rgb(0, 0, 0),
+            borderWidth: options?.borderWidth ?? 1,
+            rotate: options?.rotate ?? degrees(0),
+            hidden: options?.hidden,
+            page: page.ref,
+        });
+        const widgetRef = this.doc.context.register(widget.dict);
+        // Add widget to this field
+        const apStateValue = this.acroField.addWidgetWithOpt(widgetRef, PDFHexString.fromText(option), !this.isMutuallyExclusive());
+        // Set appearance streams for widget
+        widget.setAppearanceState(PDFName.of('Off'));
+        this.updateWidgetAppearance(widget, apStateValue);
+        // Add widget to the given page
+        page.node.addAnnot(widgetRef);
+    }
+    /**
+     * Returns `true` if any of this group's radio button widgets do not have an
+     * appearance stream for their current state. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * if (radioGroup.needsAppearancesUpdate()) console.log('Needs update')
+     * ```
+     * @returns Whether or not this radio group needs an appearance update.
+     */
+    needsAppearancesUpdate() {
+        const widgets = this.acroField.getWidgets();
+        for (let idx = 0, len = widgets.length; idx < len; idx++) {
+            const widget = widgets[idx];
+            const state = widget.getAppearanceState();
+            const normal = widget.getAppearances()?.normal;
+            if (!(normal instanceof PDFDict))
+                return true;
+            if (state && !normal.has(state))
+                return true;
+        }
+        return false;
+    }
+    /**
+     * Update the appearance streams for each of this group's radio button widgets
+     * using the default appearance provider for radio groups. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.defaultUpdateAppearances()
+     * ```
+     */
+    defaultUpdateAppearances() {
+        this.updateAppearances();
+    }
+    // rg.updateAppearances((field: any, widget: any) => {
+    //   assert(field === rg);
+    //   assert(widget instanceof PDFWidgetAnnotation);
+    //   return { on: [...rectangle, ...circle], off: [...rectangle, ...circle] };
+    // });
+    /**
+     * Update the appearance streams for each of this group's radio button widgets
+     * using the given appearance provider. If no `provider` is passed, the
+     * default appearance provider for radio groups will be used. For example:
+     * ```js
+     * const radioGroup = form.getRadioGroup('some.radioGroup.field')
+     * radioGroup.updateAppearances((field, widget) => {
+     *   ...
+     *   return {
+     *     normal: { on: drawRadioButton(...), off: drawRadioButton(...) },
+     *     down: { on: drawRadioButton(...), off: drawRadioButton(...) },
+     *   }
+     * })
+     * ```
+     * @param provider Optionally, the appearance provider to be used for
+     *                 generating the contents of the appearance streams.
+     */
+    updateAppearances(provider) {
+        assertOrUndefined(provider, 'provider', [Function]);
+        const widgets = this.acroField.getWidgets();
+        for (let idx = 0, len = widgets.length; idx < len; idx++) {
+            const widget = widgets[idx];
+            const onValue = widget.getOnValue();
+            if (!onValue)
+                continue;
+            this.updateWidgetAppearance(widget, onValue, provider);
+        }
+    }
+    updateWidgetAppearance(widget, onValue, provider) {
+        const apProvider = provider ?? defaultRadioGroupAppearanceProvider;
+        const appearances = normalizeAppearance(apProvider(this, widget));
+        this.updateOnOffWidgetAppearance(widget, onValue, appearances);
+    }
+}
+/**
+ * > **NOTE:** You probably don't want to call this method directly. Instead,
+ * > consider using the [[PDFForm.getOptionList]] method, which will create an
+ * > instance of [[PDFOptionList]] for you.
+ *
+ * Create an instance of [[PDFOptionList]] from an existing acroRadioButton
+ * and ref
+ *
+ * @param acroRadioButton The underlying `PDFAcroRadioButton` for this
+ *                        radio group.
+ * @param ref The unique reference for this radio group.
+ * @param doc The document to which this radio group will belong.
+ */
+Object.defineProperty(PDFRadioGroup, "of", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: (acroRadioButton, ref, doc) => new PDFRadioGroup(acroRadioButton, ref, doc)
+});
+export default PDFRadioGroup;
+//# sourceMappingURL=PDFRadioGroup.js.map

package/dist/esm/src/api/form/PDFRadioGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFRadioGroup.js","sourceRoot":"","sources":["../../../../../src/api/form/PDFRadioGroup.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,YAAY,CAAC;AACjC,OAAO,QAAQ,EAAE,EAEf,4BAA4B,GAC7B,MAAM,YAAY,CAAC;AACpB,OAAO,EAEL,mBAAmB,EACnB,mCAAmC,GACpC,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EACL,OAAO,EAEP,YAAY,EACZ,OAAO,EAEP,kBAAkB,EAClB,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEzE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAqB,aAAc,SAAQ,QAAQ;IAuBjD,YACE,eAAmC,EACnC,GAAW,EACX,GAAgB;QAEhB,KAAK,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QARnC,oEAAoE;QAC3D;;;;;WAA8B;QASrC,QAAQ,CAAC,eAAe,EAAE,iBAAiB,EAAE;YAC3C,CAAC,kBAAkB,EAAE,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU;QACR,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,aAAa,GAAG,IAAI,KAAK,CAAS,YAAY,CAAC,MAAM,CAAC,CAAC;YAC7D,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;gBAC9D,aAAa,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;YACtD,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,KAAK,CAAS,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YAC3D,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,WAAW;QACT,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,KAAK,KAAK,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAClD,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC9C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;gBAC1D,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,KAAK;oBAAE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;YACrE,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAED,6EAA6E;IAC7E,wEAAwE;IACxE,iCAAiC;IACjC,4CAA4C;IAC5C,uCAAuC;IAEvC,mDAAmD;IACnD,2DAA2D;IAC3D,wBAAwB;IACxB,uEAAuE;IACvE,yDAAyD;IACzD,4CAA4C;IAC5C,iDAAiD;IACjD,UAAU;IACV,QAAQ;IACR,aAAa;IACb,mEAAmE;IACnE,qCAAqC;IACrC,6CAA6C;IAC7C,4CAA4C;IAC5C,iDAAiD;IACjD,UAAU;IACV,QAAQ;IACR,MAAM;IACN,IAAI;IAEJ;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,MAAc;QACnB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEvC,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,aAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE9C,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;gBAC9D,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,MAAM,EAAE,CAAC;oBAC9C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;gBAC1D,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC5B,IAAI,KAAK,CAAC,UAAU,EAAE,KAAK,MAAM;oBAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe;QACb,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,iBAAiB;QACf,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB;QAChB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mBAAmB;QACjB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB;QACnB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,sBAAsB;QACpB,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,eAAe,CACb,MAAc,EACd,IAAa,EACb,OAAgC;QAEhC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,4BAA4B,CAAC,OAAO,CAAC,CAAC;QAEtC,wCAAwC;QACxC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;YAC/B,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;YAClB,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;YAClB,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE;YAC7B,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7C,eAAe,EAAE,OAAO,EAAE,eAAe,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACzD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,CAAC;YACtC,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC;YACrC,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzD,2BAA2B;QAC3B,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAClD,SAAS,EACT,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC7B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAC5B,CAAC;QAEF,oCAAoC;QACpC,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAElD,+BAA+B;QAC/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;OAQG;IACH,sBAAsB;QACpB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,KAAK,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,CAAC;YAE/C,IAAI,CAAC,CAAC,MAAM,YAAY,OAAO,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC9C,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;QAC/C,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,wBAAwB;QACtB,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED,sDAAsD;IACtD,0BAA0B;IAC1B,mDAAmD;IACnD,8EAA8E;IAC9E,MAAM;IAEN;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,QAA+C;QAC/D,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEpD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5C,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;YACpC,IAAI,CAAC,OAAO;gBAAE,SAAS;YACvB,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAEO,sBAAsB,CAC5B,MAA2B,EAC3B,OAAgB,EAChB,QAA+C;QAE/C,MAAM,UAAU,GAAG,QAAQ,IAAI,mCAAmC,CAAC;QACnE,MAAM,WAAW,GAAG,mBAAmB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;;AA1aD;;;;;;;;;;;;GAYG;AACI;;;;WAAK,CACV,eAAmC,EACnC,GAAW,EACX,GAAgB,EAChB,EAAE,CAAC,IAAI,aAAa,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC;EAJxC,CAIyC;eAlB/B,aAAa"}

package/dist/esm/src/api/form/PDFSignature.js

@@ -0,0 +1,49 @@
+import PDFField from './PDFField';
+import { PDFAcroSignature } from '../../core';
+import { assertIs } from '../../utils';
+/**
+ * Represents a signature field of a [[PDFForm]].
+ *
+ * [[PDFSignature]] fields are digital signatures. `pdf-lib` does not
+ * currently provide any specialized APIs for creating digital signatures or
+ * reading the contents of existing digital signatures.
+ */
+class PDFSignature extends PDFField {
+    constructor(acroSignature, ref, doc) {
+        super(acroSignature, ref, doc);
+        /** The low-level PDFAcroSignature wrapped by this signature. */
+        Object.defineProperty(this, "acroField", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        assertIs(acroSignature, 'acroSignature', [
+            [PDFAcroSignature, 'PDFAcroSignature'],
+        ]);
+        this.acroField = acroSignature;
+    }
+    needsAppearancesUpdate() {
+        return false;
+    }
+}
+/**
+ * > **NOTE:** You probably don't want to call this method directly. Instead,
+ * > consider using the [[PDFForm.getSignature]] method, which will create an
+ * > instance of [[PDFSignature]] for you.
+ *
+ * Create an instance of [[PDFSignature]] from an existing acroSignature and
+ * ref
+ *
+ * @param acroSignature The underlying `PDFAcroSignature` for this signature.
+ * @param ref The unique reference for this signature.
+ * @param doc The document to which this signature will belong.
+ */
+Object.defineProperty(PDFSignature, "of", {
+    enumerable: true,
+    configurable: true,
+    writable: true,
+    value: (acroSignature, ref, doc) => new PDFSignature(acroSignature, ref, doc)
+});
+export default PDFSignature;
+//# sourceMappingURL=PDFSignature.js.map

package/dist/esm/src/api/form/PDFSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFSignature.js","sourceRoot":"","sources":["../../../../../src/api/form/PDFSignature.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAElC,OAAO,EAAU,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;;;;GAMG;AACH,MAAqB,YAAa,SAAQ,QAAQ;IAsBhD,YACE,aAA+B,EAC/B,GAAW,EACX,GAAgB;QAEhB,KAAK,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QARjC,gEAAgE;QACvD;;;;;WAA4B;QASnC,QAAQ,CAAC,aAAa,EAAE,eAAe,EAAE;YACvC,CAAC,gBAAgB,EAAE,kBAAkB,CAAC;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,aAAa,CAAC;IACjC,CAAC;IAED,sBAAsB;QACpB,OAAO,KAAK,CAAC;IACf,CAAC;;AArCD;;;;;;;;;;;GAWG;AACI;;;;WAAK,CACV,aAA+B,EAC/B,GAAW,EACX,GAAgB,EAChB,EAAE,CAAC,IAAI,YAAY,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC;EAJrC,CAIsC;eAjB5B,YAAY"}