@adnsistemas/pdf-lib 1.18.0

package/cjs/api/form/PDFRadioGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFRadioGroup.js","sourceRoot":"","sources":["../../../src/api/form/PDFRadioGroup.ts"],"names":[],"mappings":";;;AACA,+DAAsC;AACtC,6DAG+B;AAC/B,6CAIkC;AAClC,oCAAqC;AACrC,0CAA4C;AAE5C,mCAQkB;AAClB,qCAAuE;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH;IAA2C,yCAAQ;IAuBjD,uBACE,eAAmC,EACnC,GAAW,EACX,GAAgB;QAHlB,YAKE,kBAAM,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,SAOjC;QALC,gBAAQ,CAAC,eAAe,EAAE,iBAAiB,EAAE;YAC3C,CAAC,yBAAkB,EAAE,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QAEH,KAAI,CAAC,SAAS,GAAG,eAAe,CAAC;;IACnC,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kCAAU,GAAV;QACE,IAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE;YAChB,IAAM,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;gBAC7D,aAAa,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;aACrD;YACD,OAAO,aAAa,CAAC;SACtB;QAED,IAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC9C,IAAM,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;YAC1D,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;SAC7C;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mCAAW,GAAX;QACE,IAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,KAAK,KAAK,cAAO,CAAC,EAAE,CAAC,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAClD,IAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE;YAChB,IAAM,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;gBACzD,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,KAAK;oBAAE,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;aACpE;SACF;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,8BAAM,GAAN,UAAO,MAAc;QACnB,gBAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEvC,IAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,qBAAa,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE9C,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;QAC9C,IAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;QACtD,IAAI,YAAY,EAAE;YAChB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,YAAY,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC7D,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,MAAM,EAAE;oBAC7C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;iBACxC;aACF;SACF;aAAM;YACL,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,EAAE;gBACzD,IAAM,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;aACnE;SACF;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,6BAAK,GAAL;QACE,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;;;OAUG;IACH,uCAAe,GAAf;QACE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,yCAAiB,GAAjB;QACE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;OASG;IACH,0CAAkB,GAAlB;QACE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,2CAAmB,GAAnB;QACE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,sBAAe,CAAC,cAAc,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,6CAAqB,GAArB;QACE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,8CAAsB,GAAtB;QACE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,sBAAe,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,uCAAe,GAAf,UACE,MAAc,EACd,IAAa,EACb,OAAgC;;QAEhC,gBAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,gBAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,iBAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;QAC/C,uCAA4B,CAAC,OAAO,CAAC,CAAC;QAEtC,wCAAwC;QACxC,IAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC;YAC/B,CAAC,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,CAAC,mCAAI,CAAC;YAClB,CAAC,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,CAAC,mCAAI,CAAC;YAClB,KAAK,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,mCAAI,EAAE;YAC3B,MAAM,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,EAAE;YAC7B,SAAS,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,YAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7C,eAAe,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,mCAAI,YAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACzD,WAAW,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,YAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,WAAW,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,mCAAI,CAAC;YACtC,MAAM,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,mBAAO,CAAC,CAAC,CAAC;YACrC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YACvB,IAAI,EAAE,IAAI,CAAC,GAAG;SACf,CAAC,CAAC;QACH,IAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEzD,2BAA2B;QAC3B,IAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAClD,SAAS,EACT,mBAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC7B,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAC5B,CAAC;QAEF,oCAAoC;QACpC,MAAM,CAAC,kBAAkB,CAAC,cAAO,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,8CAAsB,GAAtB;;QACE,IAAM,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;YACxD,IAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAM,KAAK,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC;YAC1C,IAAM,MAAM,SAAG,MAAM,CAAC,cAAc,EAAE,0CAAE,MAAM,CAAC;YAE/C,IAAI,CAAC,CAAC,MAAM,YAAY,cAAO,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC9C,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;SAC9C;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACH,gDAAwB,GAAxB;QACE,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED,sDAAsD;IACtD,0BAA0B;IAC1B,mDAAmD;IACnD,8EAA8E;IAC9E,MAAM;IAEN;;;;;;;;;;;;;;;;OAgBG;IACH,yCAAiB,GAAjB,UAAkB,QAA+C;QAC/D,yBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEpD,IAAM,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;YACxD,IAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAM,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;SACxD;IACH,CAAC;IAEO,8CAAsB,GAA9B,UACE,MAA2B,EAC3B,OAAgB,EAChB,QAA+C;QAE/C,IAAM,UAAU,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,iDAAmC,CAAC;QACnE,IAAM,WAAW,GAAG,iCAAmB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,2BAA2B,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IACjE,CAAC;IA1aD;;;;;;;;;;;;OAYG;IACI,gBAAE,GAAG,UACV,eAAmC,EACnC,GAAW,EACX,GAAgB,IACb,OAAA,IAAI,aAAa,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,EAA5C,CAA4C,CAAC;IA0ZpD,oBAAC;CAAA,AA5aD,CAA2C,kBAAQ,GA4alD;kBA5aoB,aAAa"}

package/cjs/api/form/PDFSignature.d.ts

@@ -0,0 +1,30 @@
+import PDFDocument from "../PDFDocument";
+import PDFField from "./PDFField";
+import { PDFRef, PDFAcroSignature } from "../../core";
+/**
+ * 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.
+ */
+export default class PDFSignature extends PDFField {
+    /**
+     * > **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.
+     */
+    static of: (acroSignature: PDFAcroSignature, ref: PDFRef, doc: PDFDocument) => PDFSignature;
+    /** The low-level PDFAcroSignature wrapped by this signature. */
+    readonly acroField: PDFAcroSignature;
+    private constructor();
+    needsAppearancesUpdate(): boolean;
+}
+//# sourceMappingURL=PDFSignature.d.ts.map

package/cjs/api/form/PDFSignature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFSignature.d.ts","sourceRoot":"","sources":["../../../src/api/form/PDFSignature.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,uBAA4B;AAC9C,OAAO,QAAQ,mBAA8B;AAE7C,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,mBAAiB;AAGpD;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,QAAQ;IAChD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,kBACQ,gBAAgB,OAC1B,MAAM,OACN,WAAW,kBAC6B;IAE/C,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;IAErC,OAAO;IAcP,sBAAsB;CAGvB"}

package/cjs/api/form/PDFSignature.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var PDFField_1 = tslib_1.__importDefault(require("./PDFField"));
+var core_1 = require("../../core");
+var utils_1 = require("../../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.
+ */
+var PDFSignature = /** @class */ (function (_super) {
+    tslib_1.__extends(PDFSignature, _super);
+    function PDFSignature(acroSignature, ref, doc) {
+        var _this = _super.call(this, acroSignature, ref, doc) || this;
+        utils_1.assertIs(acroSignature, 'acroSignature', [
+            [core_1.PDFAcroSignature, 'PDFAcroSignature'],
+        ]);
+        _this.acroField = acroSignature;
+        return _this;
+    }
+    PDFSignature.prototype.needsAppearancesUpdate = function () {
+        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.
+     */
+    PDFSignature.of = function (acroSignature, ref, doc) { return new PDFSignature(acroSignature, ref, doc); };
+    return PDFSignature;
+}(PDFField_1.default));
+exports.default = PDFSignature;
+//# sourceMappingURL=PDFSignature.js.map

package/cjs/api/form/PDFSignature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFSignature.js","sourceRoot":"","sources":["../../../src/api/form/PDFSignature.ts"],"names":[],"mappings":";;;AACA,gEAA6C;AAE7C,mCAAoD;AACpD,qCAAqC;AAErC;;;;;;GAMG;AACH;IAA0C,wCAAQ;IAsBhD,sBACE,aAA+B,EAC/B,GAAW,EACX,GAAgB;QAHlB,YAKE,kBAAM,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,SAO/B;QALC,gBAAQ,CAAC,aAAa,EAAE,eAAe,EAAE;YACvC,CAAC,uBAAgB,EAAE,kBAAkB,CAAC;SACvC,CAAC,CAAC;QAEH,KAAI,CAAC,SAAS,GAAG,aAAa,CAAC;;IACjC,CAAC;IAED,6CAAsB,GAAtB;QACE,OAAO,KAAK,CAAC;IACf,CAAC;IArCD;;;;;;;;;;;OAWG;IACI,eAAE,GAAG,UACV,aAA+B,EAC/B,GAAW,EACX,GAAgB,IACb,OAAA,IAAI,YAAY,CAAC,aAAa,EAAE,GAAG,EAAE,GAAG,CAAC,EAAzC,CAAyC,CAAC;IAsBjD,mBAAC;CAAA,AAvCD,CAA0C,kBAAQ,GAuCjD;kBAvCoB,YAAY"}

package/cjs/api/form/PDFTextField.d.ts

@@ -0,0 +1,538 @@
+import PDFDocument from "../PDFDocument";
+import PDFPage from "../PDFPage";
+import PDFFont from "../PDFFont";
+import PDFImage from "../PDFImage";
+import PDFField, { FieldAppearanceOptions } from "./PDFField";
+import { AppearanceProviderFor } from "./appearances";
+import { TextAlignment } from "../text/alignment";
+import { PDFRef, PDFAcroText } from "../../core";
+/**
+ * Represents a text field of a [[PDFForm]].
+ *
+ * [[PDFTextField]] fields are boxes that display text entered by the user. The
+ * purpose of a text field is to enable users to enter text or view text values
+ * in the document prefilled by software. Users can click on a text field and
+ * input text via their keyboard. Some text fields allow multiple lines of text
+ * to be entered (see [[PDFTextField.isMultiline]]).
+ */
+export default class PDFTextField extends PDFField {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFForm.getTextField]] method, which will create an
+     * > instance of [[PDFTextField]] for you.
+     *
+     * Create an instance of [[PDFTextField]] from an existing acroText and ref
+     *
+     * @param acroText The underlying `PDFAcroText` for this text field.
+     * @param ref The unique reference for this text field.
+     * @param doc The document to which this text field will belong.
+     */
+    static of: (acroText: PDFAcroText, ref: PDFRef, doc: PDFDocument) => PDFTextField;
+    /** The low-level PDFAcroText wrapped by this text field. */
+    readonly acroField: PDFAcroText;
+    private constructor();
+    /**
+     * Get the text that this field contains. This text is visible to users who
+     * view this field in a PDF reader.
+     *
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * const text = textField.getText()
+     * console.log('Text field contents:', text)
+     * ```
+     *
+     * Note that if this text field contains no underlying value, `undefined`
+     * will be returned. Text fields may also contain an underlying value that
+     * is simply an empty string (`''`). This detail is largely irrelevant for
+     * most applications. In general, you'll want to treat both cases the same
+     * way and simply consider the text field to be empty. In either case, the
+     * text field will appear empty to users when viewed in a PDF reader.
+     *
+     * An error will be thrown if this is a rich text field. `pdf-lib` does not
+     * support reading rich text fields. Nor do most PDF readers and writers.
+     * Rich text fields are based on XFA (XML Forms Architecture). Relatively few
+     * PDFs use rich text fields or XFA. Unlike PDF itself, XFA is not an ISO
+     * standard. XFA has been deprecated in PDF 2.0:
+     * * https://en.wikipedia.org/wiki/XFA
+     * * http://blog.pdfshareforms.com/pdf-2-0-release-bid-farewell-xfa-forms/
+     *
+     * @returns The text contained in this text field.
+     */
+    getText(): string | undefined;
+    /**
+     * Set the text for this field. This operation is analogous to a human user
+     * clicking on the text field in a PDF reader and typing in text via their
+     * keyboard. This method will update the underlying state of the text field
+     * to indicate what text has been set. PDF libraries and readers will be able
+     * to extract these values from the saved document and determine what text
+     * was set.
+     *
+     * For example:
+     * ```js
+     * const textField = form.getTextField('best.superhero.text.field')
+     * textField.setText('One Punch Man')
+     * ```
+     *
+     * This method will mark this text field as dirty, causing its appearance
+     * streams to be updated when either [[PDFDocument.save]] or
+     * [[PDFForm.updateFieldAppearances]] is called. The updated streams will
+     * display the text this field contains inside the widgets of this text
+     * field.
+     *
+     * **IMPORTANT:** The default font used to update appearance streams is
+     * [[StandardFonts.Helvetica]]. Note that this is a WinAnsi font. This means
+     * that encoding errors will be thrown if this field contains text outside
+     * the WinAnsi character set (the latin alphabet).
+     *
+     * Embedding a custom font and passing it to
+     * [[PDFForm.updateFieldAppearances]] or [[PDFTextField.updateAppearances]]
+     * allows you to generate appearance streams with characters outside the
+     * latin alphabet (assuming the custom font supports them).
+     *
+     * If this is a rich text field, it will be converted to a standard text
+     * field in order to set the text. `pdf-lib` does not support writing rich
+     * text strings. Nor do most PDF readers and writers. See
+     * [[PDFTextField.getText]] for more information about rich text fields and
+     * their deprecation in PDF 2.0.
+     *
+     * @param text The text this field should contain.
+     */
+    setText(text: string | undefined): void;
+    /**
+     * Get the alignment for this text field. This value represents the
+     * justification of the text when it is displayed to the user in PDF readers.
+     * There are three possible alignments: left, center, and right. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * const alignment = textField.getAlignment()
+     * if (alignment === TextAlignment.Left) console.log('Text is left justified')
+     * if (alignment === TextAlignment.Center) console.log('Text is centered')
+     * if (alignment === TextAlignment.Right) console.log('Text is right justified')
+     * ```
+     * @returns The alignment of this text field.
+     */
+    getAlignment(): TextAlignment;
+    /**
+     * Set the alignment for this text field. This will determine the
+     * justification of the text when it is displayed to the user in PDF readers.
+     * There are three possible alignments: left, center, and right. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     *
+     * // Text will be left justified when displayed
+     * textField.setAlignment(TextAlignment.Left)
+     *
+     * // Text will be centered when displayed
+     * textField.setAlignment(TextAlignment.Center)
+     *
+     * // Text will be right justified when displayed
+     * textField.setAlignment(TextAlignment.Right)
+     * ```
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     * @param alignment The alignment for this text field.
+     */
+    setAlignment(alignment: TextAlignment): void;
+    /**
+     * Get the maximum length of this field. This value represents the maximum
+     * number of characters that can be typed into this field by the user. If
+     * this field does not have a maximum length, `undefined` is returned.
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * const maxLength = textField.getMaxLength()
+     * if (maxLength === undefined) console.log('No max length')
+     * else console.log(`Max length is ${maxLength}`)
+     * ```
+     * @returns The maximum number of characters allowed in this field, or
+     *          `undefined` if no limit exists.
+     */
+    getMaxLength(): number | undefined;
+    /**
+     * Set the maximum length of this field. This limits the number of characters
+     * that can be typed into this field by the user. This also limits the length
+     * of the string that can be passed to [[PDFTextField.setText]]. This limit
+     * can be removed by passing `undefined` as `maxLength`. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     *
+     * // Allow between 0 and 5 characters to be entered
+     * textField.setMaxLength(5)
+     *
+     * // Allow any number of characters to be entered
+     * textField.setMaxLength(undefined)
+     * ```
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     * @param maxLength The maximum number of characters allowed in this field, or
+     *                  `undefined` to remove the limit.
+     */
+    setMaxLength(maxLength?: number): void;
+    /**
+     * Remove the maximum length for this text field. This allows any number of
+     * characters to be typed into this field by the user. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.removeMaxLength()
+     * ```
+     * Calling this method is equivalent to passing `undefined` to
+     * [[PDFTextField.setMaxLength]].
+     */
+    removeMaxLength(): void;
+    /**
+     * Display an image inside the bounds of this text field's widgets. For example:
+     * ```js
+     * const pngImage = await pdfDoc.embedPng(...)
+     * const textField = form.getTextField('some.text.field')
+     * textField.setImage(pngImage)
+     * ```
+     * This will update the appearances streams for each of this text field's widgets.
+     * @param image The image that should be displayed.
+     */
+    setImage(image: PDFImage): void;
+    /**
+     * Set the font size for this field. Larger font sizes will result in larger
+     * text being displayed when PDF readers render this text field. Font sizes
+     * may be integer or floating point numbers. Supplying a negative font size
+     * will cause this method to throw an error.
+     *
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.setFontSize(4)
+     * textField.setFontSize(15.7)
+     * ```
+     *
+     * > This method depends upon the existence of a default appearance
+     * > (`/DA`) string. If this field does not have a default appearance string,
+     * > or that string does not contain a font size (via the `Tf` operator),
+     * > then this method will throw an error.
+     *
+     * @param fontSize The font size to be used when rendering text in this field.
+     */
+    setFontSize(fontSize: number): void;
+    /**
+     * Returns `true` if each line of text is shown on a new line when this
+     * field is displayed in a PDF reader. The alternative is that all lines of
+     * text are merged onto a single line when displayed. See
+     * [[PDFTextField.enableMultiline]] and [[PDFTextField.disableMultiline]].
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isMultiline()) console.log('Multiline is enabled')
+     * ```
+     * @returns Whether or not this is a multiline text field.
+     */
+    isMultiline(): boolean;
+    /**
+     * Display each line of text on a new line when this field is displayed in a
+     * PDF reader. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableMultiline()
+     * ```
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     */
+    enableMultiline(): void;
+    /**
+     * Display each line of text on the same line when this field is displayed
+     * in a PDF reader. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableMultiline()
+     * ```
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     */
+    disableMultiline(): void;
+    /**
+     * Returns `true` if this is a password text field. This means that the field
+     * is intended for storing a secure password. See
+     * [[PDFTextField.enablePassword]] and [[PDFTextField.disablePassword]].
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isPassword()) console.log('Password is enabled')
+     * ```
+     * @returns Whether or not this is a password text field.
+     */
+    isPassword(): boolean;
+    /**
+     * Indicate that this text field is intended for storing a secure password.
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enablePassword()
+     * ```
+     * Values entered into password text fields should not be displayed on the
+     * screen by PDF readers. Most PDF readers will display the value as
+     * asterisks or bullets. PDF readers should never store values entered by the
+     * user into password text fields. Similarly, applications should not
+     * write data to a password text field.
+     *
+     * **Please note that this method does not cause entered values to be
+     * encrypted or secured in any way! It simply sets a flag that PDF software
+     * and readers can access to determine the _purpose_ of this field.**
+     */
+    enablePassword(): void;
+    /**
+     * Indicate that this text field is **not** intended for storing a secure
+     * password. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disablePassword()
+     * ```
+     */
+    disablePassword(): void;
+    /**
+     * Returns `true` if the contents of this text field represent a file path.
+     * See [[PDFTextField.enableFileSelection]] and
+     * [[PDFTextField.disableFileSelection]]. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isFileSelector()) console.log('Is a file selector')
+     * ```
+     * @returns Whether or not this field should contain file paths.
+     */
+    isFileSelector(): boolean;
+    /**
+     * Indicate that this text field is intended to store a file path. The
+     * contents of the file stored at that path should be submitted as the value
+     * of the field. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableFileSelection()
+     * ```
+     */
+    enableFileSelection(): void;
+    /**
+     * Indicate that this text field is **not** intended to store a file path.
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableFileSelection()
+     * ```
+     */
+    disableFileSelection(): void;
+    /**
+     * Returns `true` if the text entered in this field should be spell checked
+     * by PDF readers. See [[PDFTextField.enableSpellChecking]] and
+     * [[PDFTextField.disableSpellChecking]]. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isSpellChecked()) console.log('Spell checking is enabled')
+     * ```
+     * @returns Whether or not this field should be spell checked.
+     */
+    isSpellChecked(): boolean;
+    /**
+     * Allow PDF readers to spell check the text entered in this field.
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableSpellChecking()
+     * ```
+     */
+    enableSpellChecking(): void;
+    /**
+     * Do not allow PDF readers to spell check the text entered in this field.
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableSpellChecking()
+     * ```
+     */
+    disableSpellChecking(): void;
+    /**
+     * Returns `true` if PDF readers should allow the user to scroll the text
+     * field when its contents do not fit within the field's view bounds. See
+     * [[PDFTextField.enableScrolling]] and [[PDFTextField.disableScrolling]].
+     * For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isScrollable()) console.log('Scrolling is enabled')
+     * ```
+     * @returns Whether or not the field is scrollable in PDF readers.
+     */
+    isScrollable(): boolean;
+    /**
+     * Allow PDF readers to present a scroll bar to the user when the contents
+     * of this text field do not fit within its view bounds. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableScrolling()
+     * ```
+     * A horizontal scroll bar should be shown for singleline fields. A vertical
+     * scroll bar should be shown for multiline fields.
+     */
+    enableScrolling(): void;
+    /**
+     * Do not allow PDF readers to present a scroll bar to the user when the
+     * contents of this text field do not fit within its view bounds. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableScrolling()
+     * ```
+     */
+    disableScrolling(): void;
+    /**
+     * Returns `true` if this is a combed text field. This means that the field
+     * is split into `n` equal size cells with one character in each (where `n`
+     * is equal to the max length of the text field). The result is that all
+     * characters in this field are displayed an equal distance apart from one
+     * another. See [[PDFTextField.enableCombing]] and
+     * [[PDFTextField.disableCombing]]. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isCombed()) console.log('Combing is enabled')
+     * ```
+     * Note that in order for a text field to be combed, the following must be
+     * true (in addition to enabling combing):
+     * * It must not be a multiline field (see [[PDFTextField.isMultiline]])
+     * * It must not be a password field (see [[PDFTextField.isPassword]])
+     * * It must not be a file selector field (see [[PDFTextField.isFileSelector]])
+     * * It must have a max length defined (see [[PDFTextField.setMaxLength]])
+     * @returns Whether or not this field is combed.
+     */
+    isCombed(): boolean;
+    /**
+     * Split this field into `n` equal size cells with one character in each
+     * (where `n` is equal to the max length of the text field). This will cause
+     * all characters in the field to be displayed an equal distance apart from
+     * one another. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableCombing()
+     * ```
+     *
+     * In addition to calling this method, text fields must have a max length
+     * defined in order to be combed (see [[PDFTextField.setMaxLength]]).
+     *
+     * This method will also call the following three methods internally:
+     * * [[PDFTextField.disableMultiline]]
+     * * [[PDFTextField.disablePassword]]
+     * * [[PDFTextField.disableFileSelection]]
+     *
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     */
+    enableCombing(): void;
+    /**
+     * Turn off combing for this text field. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableCombing()
+     * ```
+     * See [[PDFTextField.isCombed]] and [[PDFTextField.enableCombing]] for more
+     * information about what combing is.
+     *
+     * This method will mark this text field as dirty. See
+     * [[PDFTextField.setText]] for more details about what this means.
+     */
+    disableCombing(): void;
+    /**
+     * Returns `true` if this text field contains rich text. See
+     * [[PDFTextField.enableRichFormatting]] and
+     * [[PDFTextField.disableRichFormatting]]. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.isRichFormatted()) console.log('Rich formatting enabled')
+     * ```
+     * @returns Whether or not this field contains rich text.
+     */
+    isRichFormatted(): boolean;
+    /**
+     * Indicate that this field contains XFA data - or rich text. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.enableRichFormatting()
+     * ```
+     * Note that `pdf-lib` does not support reading or writing rich text fields.
+     * Nor do most PDF readers and writers. Rich text fields are based on XFA
+     * (XML Forms Architecture). Relatively few PDFs use rich text fields or XFA.
+     * Unlike PDF itself, XFA is not an ISO standard. XFA has been deprecated in
+     * PDF 2.0:
+     * * https://en.wikipedia.org/wiki/XFA
+     * * http://blog.pdfshareforms.com/pdf-2-0-release-bid-farewell-xfa-forms/
+     */
+    enableRichFormatting(): void;
+    /**
+     * Indicate that this is a standard text field that does not XFA data (rich
+     * text). For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * textField.disableRichFormatting()
+     * ```
+     */
+    disableRichFormatting(): void;
+    /**
+     * Show this text field on the specified page. For example:
+     * ```js
+     * const ubuntuFont = await pdfDoc.embedFont(ubuntuFontBytes)
+     * const page = pdfDoc.addPage()
+     *
+     * const form = pdfDoc.getForm()
+     * const textField = form.createTextField('best.gundam')
+     * textField.setText('Exia')
+     *
+     * textField.addToPage(page, {
+     *   x: 50,
+     *   y: 75,
+     *   width: 200,
+     *   height: 100,
+     *   textColor: rgb(1, 0, 0),
+     *   backgroundColor: rgb(0, 1, 0),
+     *   borderColor: rgb(0, 0, 1),
+     *   borderWidth: 2,
+     *   rotate: degrees(90),
+     *   font: ubuntuFont,
+     * })
+     * ```
+     * This will create a new widget for this text field.
+     * @param page The page to which this text field widget should be added.
+     * @param options The options to be used when adding this text field widget.
+     */
+    addToPage(page: PDFPage, options?: FieldAppearanceOptions): void;
+    /**
+     * Returns `true` if this text field has been marked as dirty, or if any of
+     * this text field's widgets do not have an appearance stream. For example:
+     * ```js
+     * const textField = form.getTextField('some.text.field')
+     * if (textField.needsAppearancesUpdate()) console.log('Needs update')
+     * ```
+     * @returns Whether or not this text field needs an appearance update.
+     */
+    needsAppearancesUpdate(): boolean;
+    /**
+     * Update the appearance streams for each of this text field's widgets using
+     * the default appearance provider for text fields. For example:
+     * ```js
+     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
+     * const textField = form.getTextField('some.text.field')
+     * textField.defaultUpdateAppearances(helvetica)
+     * ```
+     * @param font The font to be used for creating the appearance streams.
+     */
+    defaultUpdateAppearances(font: PDFFont): void;
+    /**
+     * Update the appearance streams for each of this text field's widgets using
+     * the given appearance provider. If no `provider` is passed, the default
+     * appearance provider for text fields will be used. For example:
+     * ```js
+     * const helvetica = await pdfDoc.embedFont(StandardFonts.Helvetica)
+     * const textField = form.getTextField('some.text.field')
+     * textField.updateAppearances(helvetica, (field, widget, font) => {
+     *   ...
+     *   return drawTextField(...)
+     * })
+     * ```
+     * @param font The font to be used for creating the appearance streams.
+     * @param provider Optionally, the appearance provider to be used for
+     *                 generating the contents of the appearance streams.
+     */
+    updateAppearances(font: PDFFont, provider?: AppearanceProviderFor<PDFTextField>): void;
+    private updateWidgetAppearance;
+}
+//# sourceMappingURL=PDFTextField.d.ts.map

package/cjs/api/form/PDFTextField.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFTextField.d.ts","sourceRoot":"","sources":["../../../src/api/form/PDFTextField.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,uBAA4B;AAC9C,OAAO,OAAO,mBAAwB;AACtC,OAAO,OAAO,mBAAwB;AACtC,OAAO,QAAQ,oBAAyB;AACxC,OAAO,QAAQ,EAAE,EACf,sBAAsB,EAEvB,mBAA8B;AAC/B,OAAO,EACL,qBAAqB,EAGtB,sBAAiC;AASlC,OAAO,EAAE,aAAa,EAAE,0BAA+B;AAEvD,OAAO,EAEL,MAAM,EAEN,WAAW,EAGZ,mBAAiB;AASlB;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,QAAQ;IAChD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,aAAc,WAAW,OAAO,MAAM,OAAO,WAAW,kBAC1B;IAEvC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,WAAW,CAAC;IAEhC,OAAO;IAQP;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,IAAI,MAAM,GAAG,SAAS;IAQ7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAkBhC;;;;;;;;;;;;OAYG;IACH,YAAY,IAAI,aAAa;IAY7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CAAC,SAAS,EAAE,aAAa;IAMrC;;;;;;;;;;;;;OAaG;IACH,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM;IAgB/B;;;;;;;;;OASG;IACH,eAAe;IAKf;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ;IAuBxB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM;IAM5B;;;;;;;;;;;OAWG;IACH,WAAW,IAAI,OAAO;IAItB;;;;;;;;;OASG;IACH,eAAe;IAKf;;;;;;;;;OASG;IACH,gBAAgB;IAKhB;;;;;;;;;;OAUG;IACH,UAAU,IAAI,OAAO;IAIrB;;;;;;;;;;;;;;;;OAgBG;IACH,cAAc;IAId;;;;;;;OAOG;IACH,eAAe;IAIf;;;;;;;;;OASG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;;;;;OAQG;IACH,mBAAmB;IAInB;;;;;;;OAOG;IACH,oBAAoB;IAIpB;;;;;;;;;OASG;IACH,cAAc,IAAI,OAAO;IAIzB;;;;;;;OAOG;IACH,mBAAmB;IAInB;;;;;;;OAOG;IACH,oBAAoB;IAIpB;;;;;;;;;;OAUG;IACH,YAAY,IAAI,OAAO;IAIvB;;;;;;;;;OASG;IACH,eAAe;IAIf;;;;;;;OAOG;IACH,gBAAgB;IAIhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,IAAI,OAAO;IAUnB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa;IAeb;;;;;;;;;;;OAWG;IACH,cAAc;IAKd;;;;;;;;;OASG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;;;;;;;;;;OAaG;IACH,oBAAoB;IAIpB;;;;;;;OAOG;IACH,qBAAqB;IAIrB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,sBAAsB;IAsCzD;;;;;;;;OAQG;IACH,sBAAsB,IAAI,OAAO;IAcjC;;;;;;;;;OASG;IACH,wBAAwB,CAAC,IAAI,EAAE,OAAO;IAKtC;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,IAAI,EAAE,OAAO,EACb,QAAQ,CAAC,EAAE,qBAAqB,CAAC,YAAY,CAAC;IAahD,OAAO,CAAC,sBAAsB;CAS/B"}