@adnsistemas/pdf-lib 1.18.0

package/es/api/PDFFont.js

@@ -0,0 +1,141 @@
+import { __awaiter, __generator } from "tslib";
+import PDFDocument from "./PDFDocument";
+import { CustomFontEmbedder, PDFRef, StandardFontEmbedder, } from "../core";
+import { assertIs, assertOrUndefined } from "../utils";
+/**
+ * Represents a font that has been embedded in a [[PDFDocument]].
+ */
+var PDFFont = /** @class */ (function () {
+    function PDFFont(ref, doc, embedder) {
+        this.modified = true;
+        assertIs(ref, 'ref', [[PDFRef, 'PDFRef']]);
+        assertIs(doc, 'doc', [[PDFDocument, 'PDFDocument']]);
+        assertIs(embedder, 'embedder', [
+            [CustomFontEmbedder, 'CustomFontEmbedder'],
+            [StandardFontEmbedder, 'StandardFontEmbedder'],
+        ]);
+        this.ref = ref;
+        this.doc = doc;
+        this.name = embedder.fontName;
+        this.embedder = embedder;
+    }
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFPage.drawText]] method will automatically encode the text it is
+     * > given.
+     *
+     * Encodes a string of text in this font.
+     *
+     * @param text The text to be encoded.
+     * @returns The encoded text as a hex string.
+     */
+    PDFFont.prototype.encodeText = function (text) {
+        assertIs(text, 'text', ['string']);
+        this.modified = true;
+        return this.embedder.encodeText(text);
+    };
+    /**
+     * Measure the width of a string of text drawn in this font at a given size.
+     * For example:
+     * ```js
+     * const width = font.widthOfTextAtSize('Foo Bar Qux Baz', 36)
+     * ```
+     * @param text The string of text to be measured.
+     * @param size The font size to be used for this measurement.
+     * @returns The width of the string of text when drawn in this font at the
+     *          given size.
+     */
+    PDFFont.prototype.widthOfTextAtSize = function (text, size) {
+        assertIs(text, 'text', ['string']);
+        assertIs(size, 'size', ['number']);
+        return this.embedder.widthOfTextAtSize(text, size);
+    };
+    /**
+     * Measure the height of this font at a given size. For example:
+     * ```js
+     * const height = font.heightAtSize(24)
+     * ```
+     *
+     * The `options.descender` value controls whether or not the font's
+     * descender is included in the height calculation.
+     *
+     * @param size The font size to be used for this measurement.
+     * @param options The options to be used when computing this measurement.
+     * @returns The height of this font at the given size.
+     */
+    PDFFont.prototype.heightAtSize = function (size, options) {
+        var _a;
+        assertIs(size, 'size', ['number']);
+        assertOrUndefined(options === null || options === void 0 ? void 0 : options.descender, 'options.descender', ['boolean']);
+        return this.embedder.heightOfFontAtSize(size, {
+            descender: (_a = options === null || options === void 0 ? void 0 : options.descender) !== null && _a !== void 0 ? _a : true,
+        });
+    };
+    /**
+     * Compute the font size at which this font is a given height. For example:
+     * ```js
+     * const fontSize = font.sizeAtHeight(12)
+     * ```
+     * @param height The height to be used for this calculation.
+     * @returns The font size at which this font is the given height.
+     */
+    PDFFont.prototype.sizeAtHeight = function (height) {
+        assertIs(height, 'height', ['number']);
+        return this.embedder.sizeOfFontAtHeight(height);
+    };
+    /**
+     * Get the set of unicode code points that can be represented by this font.
+     * @returns The set of unicode code points supported by this font.
+     */
+    PDFFont.prototype.getCharacterSet = function () {
+        if (this.embedder instanceof StandardFontEmbedder) {
+            return this.embedder.encoding.supportedCodePoints;
+        }
+        else {
+            return this.embedder.font.characterSet;
+        }
+    };
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all fonts get embedded.
+     *
+     * Embed this font in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    PDFFont.prototype.embed = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.modified) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.embedder.embedIntoContext(this.doc.context, this.ref)];
+                    case 1:
+                        _a.sent();
+                        this.modified = false;
+                        _a.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedFont]] and
+     * > [[PDFDocument.embedStandardFont]] methods, which will create instances
+     * > of [[PDFFont]] for you.
+     *
+     * Create an instance of [[PDFFont]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this font.
+     * @param doc The document to which the font will belong.
+     * @param embedder The embedder that will be used to embed the font.
+     */
+    PDFFont.of = function (ref, doc, embedder) {
+        return new PDFFont(ref, doc, embedder);
+    };
+    return PDFFont;
+}());
+export default PDFFont;
+//# sourceMappingURL=PDFFont.js.map

package/es/api/PDFFont.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFFont.js","sourceRoot":"","sources":["../../src/api/PDFFont.ts"],"names":[],"mappings":";AACA,OAAO,WAAW,sBAA4B;AAC9C,OAAO,EACL,kBAAkB,EAElB,MAAM,EACN,oBAAoB,GACrB,gBAAiB;AAClB,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,iBAAkB;AAIxD;;GAEG;AACH;IA4BE,iBAAoB,GAAW,EAAE,GAAgB,EAAE,QAAsB;QAHjE,aAAQ,GAAG,IAAI,CAAC;QAItB,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3C,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QACrD,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE;YAC7B,CAAC,kBAAkB,EAAE,oBAAoB,CAAC;YAC1C,CAAC,oBAAoB,EAAE,sBAAsB,CAAC;SAC/C,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAE9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;;;OASG;IACH,4BAAU,GAAV,UAAW,IAAY;QACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACH,mCAAiB,GAAjB,UAAkB,IAAY,EAAE,IAAY;QAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,8BAAY,GAAZ,UAAa,IAAY,EAAE,OAAiC;;QAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnC,iBAAiB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,EAAE,mBAAmB,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,EAAE;YAC5C,SAAS,QAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,mCAAI,IAAI;SACtC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,8BAAY,GAAZ,UAAa,MAAc;QACzB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,iCAAe,GAAf;QACE,IAAI,IAAI,CAAC,QAAQ,YAAY,oBAAoB,EAAE;YACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC;SACnD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC;SACxC;IACH,CAAC;IAED;;;;;;;;OAQG;IACG,uBAAK,GAAX;;;;;6BAEM,IAAI,CAAC,QAAQ,EAAb,wBAAa;wBACf,qBAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,EAAA;;wBAAhE,SAAgE,CAAC;wBACjE,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;;;;;;KAEzB;IAxID;;;;;;;;;;;OAWG;IACI,UAAE,GAAG,UAAC,GAAW,EAAE,GAAgB,EAAE,QAAsB;QAChE,OAAA,IAAI,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC;IAA/B,CAA+B,CAAC;IA4HpC,cAAC;CAAA,AA1ID,IA0IC;eA1IoB,OAAO"}

package/es/api/PDFImage.d.ts

@@ -0,0 +1,96 @@
+import Embeddable from "./Embeddable";
+import PDFDocument from "./PDFDocument";
+import { JpegEmbedder, PDFRef, PngEmbedder } from "../core";
+export declare type ImageEmbedder = JpegEmbedder | PngEmbedder;
+/**
+ * Represents an image that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFImage implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedPng]] and [[PDFDocument.embedJpg]]
+     * > methods, which will create instances of [[PDFImage]] for you.
+     *
+     * Create an instance of [[PDFImage]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this image.
+     * @param doc The document to which the image will belong.
+     * @param embedder The embedder that will be used to embed the image.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: ImageEmbedder) => PDFImage;
+    /** The unique reference assigned to this image within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this image belongs. */
+    readonly doc: PDFDocument;
+    /** The width of this image in pixels. */
+    readonly width: number;
+    /** The height of this image in pixels. */
+    readonly height: number;
+    private embedder;
+    private embedTask;
+    private constructor();
+    /**
+     * Compute the width and height of this image after being scaled by the
+     * given `factor`. For example:
+     * ```js
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scale(0.5)
+     * scaled.width  // => 250
+     * scaled.height // => 125
+     * ```
+     * This operation is often useful before drawing an image with
+     * [[PDFPage.drawImage]] to compute the `width` and `height` options.
+     * @param factor The factor by which this image should be scaled.
+     * @returns The width and height of the image after being scaled.
+     */
+    scale(factor: number): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Get the width and height of this image after scaling it as large as
+     * possible while maintaining its aspect ratio and not exceeding the
+     * specified `width` and `height`. For example:
+     * ```
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scaleToFit(750, 1000)
+     * scaled.width  // => 750
+     * scaled.height // => 375
+     * ```
+     * The `width` and `height` parameters can also be thought of as the width
+     * and height of a box that the scaled image must fit within.
+     * @param width The bounding box's width.
+     * @param height The bounding box's height.
+     * @returns The width and height of the image after being scaled.
+     */
+    scaleToFit(width: number, height: number): {
+        width: number;
+        height: number;
+    };
+    /**
+     * Get the width and height of this image. For example:
+     * ```js
+     * const { width, height } = image.size()
+     * ```
+     * @returns The width and height of the image.
+     */
+    size(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all images get embedded.
+     *
+     * Embed this image in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}
+//# sourceMappingURL=PDFImage.d.ts.map

package/es/api/PDFImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFImage.d.ts","sourceRoot":"","sources":["../../src/api/PDFImage.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,qBAA2B;AAC5C,OAAO,WAAW,sBAA4B;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAiB;AAG7D,oBAAY,aAAa,GAAG,YAAY,GAAG,WAAW,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,QAAS,YAAW,UAAU;IACjD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,QAAS,MAAM,OAAO,WAAW,YAAY,aAAa,cAChC;IAEnC,uEAAuE;IACvE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,gDAAgD;IAChD,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;IAE1B,yCAAyC;IACzC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,0CAA0C;IAC1C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,OAAO,CAAC,QAAQ,CAA4B;IAC5C,OAAO,CAAC,SAAS,CAA8B;IAE/C,OAAO;IAgBP;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM;;;;IAKpB;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;;;;IAWxC;;;;;;OAMG;IACH,IAAI;;;;IAIJ;;;;;;;;OAQG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAgB7B"}

package/es/api/PDFImage.js

@@ -0,0 +1,130 @@
+import { __awaiter, __generator } from "tslib";
+import PDFDocument from "./PDFDocument";
+import { JpegEmbedder, PDFRef, PngEmbedder } from "../core";
+import { assertIs } from "../utils";
+/**
+ * Represents an image that has been embedded in a [[PDFDocument]].
+ */
+var PDFImage = /** @class */ (function () {
+    function PDFImage(ref, doc, embedder) {
+        assertIs(ref, 'ref', [[PDFRef, 'PDFRef']]);
+        assertIs(doc, 'doc', [[PDFDocument, 'PDFDocument']]);
+        assertIs(embedder, 'embedder', [
+            [JpegEmbedder, 'JpegEmbedder'],
+            [PngEmbedder, 'PngEmbedder'],
+        ]);
+        this.ref = ref;
+        this.doc = doc;
+        this.width = embedder.width;
+        this.height = embedder.height;
+        this.embedder = embedder;
+    }
+    /**
+     * Compute the width and height of this image after being scaled by the
+     * given `factor`. For example:
+     * ```js
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scale(0.5)
+     * scaled.width  // => 250
+     * scaled.height // => 125
+     * ```
+     * This operation is often useful before drawing an image with
+     * [[PDFPage.drawImage]] to compute the `width` and `height` options.
+     * @param factor The factor by which this image should be scaled.
+     * @returns The width and height of the image after being scaled.
+     */
+    PDFImage.prototype.scale = function (factor) {
+        assertIs(factor, 'factor', ['number']);
+        return { width: this.width * factor, height: this.height * factor };
+    };
+    /**
+     * Get the width and height of this image after scaling it as large as
+     * possible while maintaining its aspect ratio and not exceeding the
+     * specified `width` and `height`. For example:
+     * ```
+     * image.width  // => 500
+     * image.height // => 250
+     *
+     * const scaled = image.scaleToFit(750, 1000)
+     * scaled.width  // => 750
+     * scaled.height // => 375
+     * ```
+     * The `width` and `height` parameters can also be thought of as the width
+     * and height of a box that the scaled image must fit within.
+     * @param width The bounding box's width.
+     * @param height The bounding box's height.
+     * @returns The width and height of the image after being scaled.
+     */
+    PDFImage.prototype.scaleToFit = function (width, height) {
+        assertIs(width, 'width', ['number']);
+        assertIs(height, 'height', ['number']);
+        var imgWidthScale = width / this.width;
+        var imgHeightScale = height / this.height;
+        var scale = Math.min(imgWidthScale, imgHeightScale);
+        return this.scale(scale);
+    };
+    /**
+     * Get the width and height of this image. For example:
+     * ```js
+     * const { width, height } = image.size()
+     * ```
+     * @returns The width and height of the image.
+     */
+    PDFImage.prototype.size = function () {
+        return this.scale(1);
+    };
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all images get embedded.
+     *
+     * Embed this image in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    PDFImage.prototype.embed = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, doc, ref;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!this.embedder)
+                            return [2 /*return*/];
+                        // The image should only be embedded once. If there's a pending embed
+                        // operation then wait on it. Otherwise we need to start the embed.
+                        if (!this.embedTask) {
+                            _a = this, doc = _a.doc, ref = _a.ref;
+                            this.embedTask = this.embedder.embedIntoContext(doc.context, ref);
+                        }
+                        return [4 /*yield*/, this.embedTask];
+                    case 1:
+                        _b.sent();
+                        // We clear `this.embedder` so that the indirectly referenced image data
+                        // can be garbage collected, thus avoiding a memory leak.
+                        // See https://github.com/Hopding/pdf-lib/pull/1032/files.
+                        this.embedder = undefined;
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.embedPng]] and [[PDFDocument.embedJpg]]
+     * > methods, which will create instances of [[PDFImage]] for you.
+     *
+     * Create an instance of [[PDFImage]] from an existing ref and embedder
+     *
+     * @param ref The unique reference for this image.
+     * @param doc The document to which the image will belong.
+     * @param embedder The embedder that will be used to embed the image.
+     */
+    PDFImage.of = function (ref, doc, embedder) {
+        return new PDFImage(ref, doc, embedder);
+    };
+    return PDFImage;
+}());
+export default PDFImage;
+//# sourceMappingURL=PDFImage.js.map

package/es/api/PDFImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFImage.js","sourceRoot":"","sources":["../../src/api/PDFImage.ts"],"names":[],"mappings":";AACA,OAAO,WAAW,sBAA4B;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAiB;AAC7D,OAAO,EAAE,QAAQ,EAAE,iBAAkB;AAIrC;;GAEG;AACH;IA8BE,kBAAoB,GAAW,EAAE,GAAgB,EAAE,QAAuB;QACxE,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC3C,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;QACrD,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE;YAC7B,CAAC,YAAY,EAAE,cAAc,CAAC;YAC9B,CAAC,WAAW,EAAE,aAAa,CAAC;SAC7B,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAE9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,wBAAK,GAAL,UAAM,MAAc;QAClB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,6BAAU,GAAV,UAAW,KAAa,EAAE,MAAc;QACtC,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QACrC,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEvC,IAAM,aAAa,GAAG,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACzC,IAAM,cAAc,GAAG,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC5C,IAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,uBAAI,GAAJ;QACE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACG,wBAAK,GAAX;;;;;;wBACE,IAAI,CAAC,IAAI,CAAC,QAAQ;4BAAE,sBAAO;wBAE3B,qEAAqE;wBACrE,mEAAmE;wBACnE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;4BACb,KAAe,IAAI,EAAjB,GAAG,SAAA,EAAE,GAAG,SAAA,CAAU;4BAC1B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;yBACnE;wBACD,qBAAM,IAAI,CAAC,SAAS,EAAA;;wBAApB,SAAoB,CAAC;wBAErB,wEAAwE;wBACxE,yDAAyD;wBACzD,0DAA0D;wBAC1D,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;;;;;KAC3B;IAlID;;;;;;;;;;OAUG;IACI,WAAE,GAAG,UAAC,GAAW,EAAE,GAAgB,EAAE,QAAuB;QACjE,OAAA,IAAI,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC;IAAhC,CAAgC,CAAC;IAuHrC,eAAC;CAAA,AApID,IAoIC;eApIoB,QAAQ"}

package/es/api/PDFJavaScript.d.ts

@@ -0,0 +1,39 @@
+import Embeddable from "./Embeddable";
+import PDFDocument from "./PDFDocument";
+import JavaScriptEmbedder from "../core/embedders/JavaScriptEmbedder";
+import { PDFRef } from "../core";
+/**
+ * Represents JavaScript that has been embedded in a [[PDFDocument]].
+ */
+export default class PDFJavaScript implements Embeddable {
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.addJavaScript]] method, which will
+     * create instances of [[PDFJavaScript]] for you.
+     *
+     * Create an instance of [[PDFJavaScript]] from an existing ref and script
+     *
+     * @param ref The unique reference for this script.
+     * @param doc The document to which the script will belong.
+     * @param embedder The embedder that will be used to embed the script.
+     */
+    static of: (ref: PDFRef, doc: PDFDocument, embedder: JavaScriptEmbedder) => PDFJavaScript;
+    /** The unique reference assigned to this embedded script within the document. */
+    readonly ref: PDFRef;
+    /** The document to which this embedded script belongs. */
+    readonly doc: PDFDocument;
+    private alreadyEmbedded;
+    private readonly embedder;
+    private constructor();
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all JavaScripts get embedded.
+     *
+     * Embed this JavaScript in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    embed(): Promise<void>;
+}
+//# sourceMappingURL=PDFJavaScript.d.ts.map

package/es/api/PDFJavaScript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFJavaScript.d.ts","sourceRoot":"","sources":["../../src/api/PDFJavaScript.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,qBAA2B;AAC5C,OAAO,WAAW,sBAA4B;AAC9C,OAAO,kBAAkB,6CAA8C;AACvE,OAAO,EAA4C,MAAM,EAAE,gBAAiB;AAE5E;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,YAAW,UAAU;IACtD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,QAAS,MAAM,OAAO,WAAW,YAAY,kBAAkB,mBAChC;IAExC,iFAAiF;IACjF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB,0DAA0D;IAC1D,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;IAE1B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAE9C,OAAO;IAUP;;;;;;;;OAQG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CA8B7B"}

package/es/api/PDFJavaScript.js

@@ -0,0 +1,71 @@
+import { __awaiter, __generator } from "tslib";
+import { PDFName, PDFArray, PDFDict, PDFHexString } from "../core";
+/**
+ * Represents JavaScript that has been embedded in a [[PDFDocument]].
+ */
+var PDFJavaScript = /** @class */ (function () {
+    function PDFJavaScript(ref, doc, embedder) {
+        this.alreadyEmbedded = false;
+        this.ref = ref;
+        this.doc = doc;
+        this.embedder = embedder;
+    }
+    /**
+     * > **NOTE:** You probably don't need to call this method directly. The
+     * > [[PDFDocument.save]] and [[PDFDocument.saveAsBase64]] methods will
+     * > automatically ensure all JavaScripts get embedded.
+     *
+     * Embed this JavaScript in its document.
+     *
+     * @returns Resolves when the embedding is complete.
+     */
+    PDFJavaScript.prototype.embed = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, catalog, context, ref, Names, Javascript, JSNames;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (!!this.alreadyEmbedded) return [3 /*break*/, 2];
+                        _a = this.doc, catalog = _a.catalog, context = _a.context;
+                        return [4 /*yield*/, this.embedder.embedIntoContext(this.doc.context, this.ref)];
+                    case 1:
+                        ref = _b.sent();
+                        if (!catalog.has(PDFName.of('Names'))) {
+                            catalog.set(PDFName.of('Names'), context.obj({}));
+                        }
+                        Names = catalog.lookup(PDFName.of('Names'), PDFDict);
+                        if (!Names.has(PDFName.of('JavaScript'))) {
+                            Names.set(PDFName.of('JavaScript'), context.obj({}));
+                        }
+                        Javascript = Names.lookup(PDFName.of('JavaScript'), PDFDict);
+                        if (!Javascript.has(PDFName.of('Names'))) {
+                            Javascript.set(PDFName.of('Names'), context.obj([]));
+                        }
+                        JSNames = Javascript.lookup(PDFName.of('Names'), PDFArray);
+                        JSNames.push(PDFHexString.fromText(this.embedder.scriptName));
+                        JSNames.push(ref);
+                        this.alreadyEmbedded = true;
+                        _b.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * > **NOTE:** You probably don't want to call this method directly. Instead,
+     * > consider using the [[PDFDocument.addJavaScript]] method, which will
+     * create instances of [[PDFJavaScript]] for you.
+     *
+     * Create an instance of [[PDFJavaScript]] from an existing ref and script
+     *
+     * @param ref The unique reference for this script.
+     * @param doc The document to which the script will belong.
+     * @param embedder The embedder that will be used to embed the script.
+     */
+    PDFJavaScript.of = function (ref, doc, embedder) {
+        return new PDFJavaScript(ref, doc, embedder);
+    };
+    return PDFJavaScript;
+}());
+export default PDFJavaScript;
+//# sourceMappingURL=PDFJavaScript.js.map

package/es/api/PDFJavaScript.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PDFJavaScript.js","sourceRoot":"","sources":["../../src/api/PDFJavaScript.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAU,gBAAiB;AAE5E;;GAEG;AACH;IAwBE,uBACE,GAAW,EACX,GAAgB,EAChB,QAA4B;QANtB,oBAAe,GAAG,KAAK,CAAC;QAQ9B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;;;OAQG;IACG,6BAAK,GAAX;;;;;;6BACM,CAAC,IAAI,CAAC,eAAe,EAArB,wBAAqB;wBACjB,KAAuB,IAAI,CAAC,GAAG,EAA7B,OAAO,aAAA,EAAE,OAAO,aAAA,CAAc;wBAE1B,qBAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAC9C,IAAI,CAAC,GAAG,CAAC,OAAO,EAChB,IAAI,CAAC,GAAG,CACT,EAAA;;wBAHK,GAAG,GAAG,SAGX;wBAED,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE;4BACrC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;yBACnD;wBACK,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;wBAE3D,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,EAAE;4BACxC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;yBACtD;wBACK,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,CAAC;wBAEnE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE;4BACxC,UAAU,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;yBACtD;wBACK,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;wBAEjE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;wBAC9D,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;wBAElB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;;;;;;KAE/B;IAvED;;;;;;;;;;OAUG;IACI,gBAAE,GAAG,UAAC,GAAW,EAAE,GAAgB,EAAE,QAA4B;QACtE,OAAA,IAAI,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC;IAArC,CAAqC,CAAC;IA4D1C,oBAAC;CAAA,AAzED,IAyEC;eAzEoB,aAAa"}