@pdfme/pdf-lib 6.0.3-dev.0 → 6.0.4-dev.1

package/src/core/annotation/AppearanceCharacteristics.ts

@@ -1,133 +0,0 @@
-import PDFDict from '../objects/PDFDict';
-import PDFName from '../objects/PDFName';
-import PDFNumber from '../objects/PDFNumber';
-import PDFArray from '../objects/PDFArray';
-import PDFHexString from '../objects/PDFHexString';
-import PDFString from '../objects/PDFString';
-
-class AppearanceCharacteristics {
-  readonly dict: PDFDict;
-
-  static fromDict = (dict: PDFDict): AppearanceCharacteristics =>
-    new AppearanceCharacteristics(dict);
-
-  protected constructor(dict: PDFDict) {
-    this.dict = dict;
-  }
-
-  R(): PDFNumber | undefined {
-    const R = this.dict.lookup(PDFName.of('R'));
-    if (R instanceof PDFNumber) return R;
-    return undefined;
-  }
-
-  BC(): PDFArray | undefined {
-    const BC = this.dict.lookup(PDFName.of('BC'));
-    if (BC instanceof PDFArray) return BC;
-    return undefined;
-  }
-
-  BG(): PDFArray | undefined {
-    const BG = this.dict.lookup(PDFName.of('BG'));
-    if (BG instanceof PDFArray) return BG;
-    return undefined;
-  }
-
-  CA(): PDFHexString | PDFString | undefined {
-    const CA = this.dict.lookup(PDFName.of('CA'));
-    if (CA instanceof PDFHexString || CA instanceof PDFString) return CA;
-    return undefined;
-  }
-
-  RC(): PDFHexString | PDFString | undefined {
-    const RC = this.dict.lookup(PDFName.of('RC'));
-    if (RC instanceof PDFHexString || RC instanceof PDFString) return RC;
-    return undefined;
-  }
-
-  AC(): PDFHexString | PDFString | undefined {
-    const AC = this.dict.lookup(PDFName.of('AC'));
-    if (AC instanceof PDFHexString || AC instanceof PDFString) return AC;
-    return undefined;
-  }
-
-  getRotation(): number | undefined {
-    return this.R()?.asNumber();
-  }
-
-  getBorderColor(): number[] | undefined {
-    const BC = this.BC();
-
-    if (!BC) return undefined;
-
-    const components: number[] = [];
-    for (let idx = 0, len = BC?.size(); idx < len; idx++) {
-      const component = BC.get(idx);
-      if (component instanceof PDFNumber) components.push(component.asNumber());
-    }
-
-    return components;
-  }
-
-  getBackgroundColor(): number[] | undefined {
-    const BG = this.BG();
-
-    if (!BG) return undefined;
-
-    const components: number[] = [];
-    for (let idx = 0, len = BG?.size(); idx < len; idx++) {
-      const component = BG.get(idx);
-      if (component instanceof PDFNumber) components.push(component.asNumber());
-    }
-
-    return components;
-  }
-
-  getCaptions(): { normal?: string; rollover?: string; down?: string } {
-    const CA = this.CA();
-    const RC = this.RC();
-    const AC = this.AC();
-
-    return {
-      normal: CA?.decodeText(),
-      rollover: RC?.decodeText(),
-      down: AC?.decodeText(),
-    };
-  }
-
-  setRotation(rotation: number) {
-    const R = this.dict.context.obj(rotation);
-    this.dict.set(PDFName.of('R'), R);
-  }
-
-  setBorderColor(color: number[]) {
-    const BC = this.dict.context.obj(color);
-    this.dict.set(PDFName.of('BC'), BC);
-  }
-
-  setBackgroundColor(color: number[]) {
-    const BG = this.dict.context.obj(color);
-    this.dict.set(PDFName.of('BG'), BG);
-  }
-
-  setCaptions(captions: { normal: string; rollover?: string; down?: string }) {
-    const CA = PDFHexString.fromText(captions.normal);
-    this.dict.set(PDFName.of('CA'), CA);
-
-    if (captions.rollover) {
-      const RC = PDFHexString.fromText(captions.rollover);
-      this.dict.set(PDFName.of('RC'), RC);
-    } else {
-      this.dict.delete(PDFName.of('RC'));
-    }
-
-    if (captions.down) {
-      const AC = PDFHexString.fromText(captions.down);
-      this.dict.set(PDFName.of('AC'), AC);
-    } else {
-      this.dict.delete(PDFName.of('AC'));
-    }
-  }
-}
-
-export default AppearanceCharacteristics;

package/src/core/annotation/BorderStyle.ts

@@ -1,31 +0,0 @@
-import PDFDict from '../objects/PDFDict';
-import PDFName from '../objects/PDFName';
-import PDFNumber from '../objects/PDFNumber';
-
-// TODO: Also handle the `/S` and `/D` entries
-class BorderStyle {
-  readonly dict: PDFDict;
-
-  static fromDict = (dict: PDFDict): BorderStyle => new BorderStyle(dict);
-
-  protected constructor(dict: PDFDict) {
-    this.dict = dict;
-  }
-
-  W(): PDFNumber | undefined {
-    const W = this.dict.lookup(PDFName.of('W'));
-    if (W instanceof PDFNumber) return W;
-    return undefined;
-  }
-
-  getWidth(): number | undefined {
-    return this.W()?.asNumber() ?? 1;
-  }
-
-  setWidth(width: number) {
-    const W = this.dict.context.obj(width);
-    this.dict.set(PDFName.of('W'), W);
-  }
-}
-
-export default BorderStyle;

package/src/core/annotation/PDFAnnotation.ts

@@ -1,148 +0,0 @@
-import PDFDict from '../objects/PDFDict';
-import PDFName from '../objects/PDFName';
-import PDFStream from '../objects/PDFStream';
-import PDFArray from '../objects/PDFArray';
-import PDFRef from '../objects/PDFRef';
-import PDFNumber from '../objects/PDFNumber';
-
-class PDFAnnotation {
-  readonly dict: PDFDict;
-
-  static fromDict = (dict: PDFDict): PDFAnnotation => new PDFAnnotation(dict);
-
-  protected constructor(dict: PDFDict) {
-    this.dict = dict;
-  }
-
-  // This is technically required by the PDF spec
-  Rect(): PDFArray | undefined {
-    return this.dict.lookup(PDFName.of('Rect'), PDFArray);
-  }
-
-  AP(): PDFDict | undefined {
-    return this.dict.lookupMaybe(PDFName.of('AP'), PDFDict);
-  }
-
-  F(): PDFNumber | undefined {
-    const numberOrRef = this.dict.lookup(PDFName.of('F'));
-    return this.dict.context.lookupMaybe(numberOrRef, PDFNumber);
-  }
-
-  getRectangle(): { x: number; y: number; width: number; height: number } {
-    const Rect = this.Rect();
-    return Rect?.asRectangle() ?? { x: 0, y: 0, width: 0, height: 0 };
-  }
-
-  setRectangle(rect: { x: number; y: number; width: number; height: number }) {
-    const { x, y, width, height } = rect;
-    const Rect = this.dict.context.obj([x, y, x + width, y + height]);
-    this.dict.set(PDFName.of('Rect'), Rect);
-  }
-
-  getAppearanceState(): PDFName | undefined {
-    const AS = this.dict.lookup(PDFName.of('AS'));
-    if (AS instanceof PDFName) return AS;
-    return undefined;
-  }
-
-  setAppearanceState(state: PDFName) {
-    this.dict.set(PDFName.of('AS'), state);
-  }
-
-  setAppearances(appearances: PDFDict) {
-    this.dict.set(PDFName.of('AP'), appearances);
-  }
-
-  ensureAP(): PDFDict {
-    let AP = this.AP();
-    if (!AP) {
-      AP = this.dict.context.obj({});
-      this.dict.set(PDFName.of('AP'), AP);
-    }
-    return AP;
-  }
-
-  getNormalAppearance(): PDFRef | PDFDict {
-    const AP = this.ensureAP();
-    const N = AP.get(PDFName.of('N'));
-    if (N instanceof PDFRef || N instanceof PDFDict) return N;
-
-    throw new Error(`Unexpected N type: ${N?.constructor.name}`);
-  }
-
-  /** @param appearance A PDFDict or PDFStream (direct or ref) */
-  setNormalAppearance(appearance: PDFRef | PDFDict) {
-    const AP = this.ensureAP();
-    AP.set(PDFName.of('N'), appearance);
-  }
-
-  /** @param appearance A PDFDict or PDFStream (direct or ref) */
-  setRolloverAppearance(appearance: PDFRef | PDFDict) {
-    const AP = this.ensureAP();
-    AP.set(PDFName.of('R'), appearance);
-  }
-
-  /** @param appearance A PDFDict or PDFStream (direct or ref) */
-  setDownAppearance(appearance: PDFRef | PDFDict) {
-    const AP = this.ensureAP();
-    AP.set(PDFName.of('D'), appearance);
-  }
-
-  removeRolloverAppearance() {
-    const AP = this.AP();
-    AP?.delete(PDFName.of('R'));
-  }
-
-  removeDownAppearance() {
-    const AP = this.AP();
-    AP?.delete(PDFName.of('D'));
-  }
-
-  getAppearances():
-    | {
-        normal: PDFStream | PDFDict;
-        rollover?: PDFStream | PDFDict;
-        down?: PDFStream | PDFDict;
-      }
-    | undefined {
-    const AP = this.AP();
-
-    if (!AP) return undefined;
-
-    const N = AP.lookup(PDFName.of('N'), PDFDict, PDFStream);
-    const R = AP.lookupMaybe(PDFName.of('R'), PDFDict, PDFStream);
-    const D = AP.lookupMaybe(PDFName.of('D'), PDFDict, PDFStream);
-
-    return { normal: N, rollover: R, down: D };
-  }
-
-  getFlags(): number {
-    return this.F()?.asNumber() ?? 0;
-  }
-
-  setFlags(flags: number) {
-    this.dict.set(PDFName.of('F'), PDFNumber.of(flags));
-  }
-
-  hasFlag(flag: number): boolean {
-    const flags = this.getFlags();
-    return (flags & flag) !== 0;
-  }
-
-  setFlag(flag: number) {
-    const flags = this.getFlags();
-    this.setFlags(flags | flag);
-  }
-
-  clearFlag(flag: number) {
-    const flags = this.getFlags();
-    this.setFlags(flags & ~flag);
-  }
-
-  setFlagTo(flag: number, enable: boolean) {
-    if (enable) this.setFlag(flag);
-    else this.clearFlag(flag);
-  }
-}
-
-export default PDFAnnotation;

package/src/core/annotation/PDFWidgetAnnotation.ts

@@ -1,111 +0,0 @@
-import PDFDict from '../objects/PDFDict';
-import PDFName from '../objects/PDFName';
-import PDFRef from '../objects/PDFRef';
-import PDFString from '../objects/PDFString';
-import PDFHexString from '../objects/PDFHexString';
-import PDFContext from '../PDFContext';
-import BorderStyle from './BorderStyle';
-import PDFAnnotation from './PDFAnnotation';
-import AppearanceCharacteristics from './AppearanceCharacteristics';
-
-class PDFWidgetAnnotation extends PDFAnnotation {
-  static fromDict = (dict: PDFDict): PDFWidgetAnnotation => new PDFWidgetAnnotation(dict);
-
-  static create = (context: PDFContext, parent: PDFRef) => {
-    const dict = context.obj({
-      Type: 'Annot',
-      Subtype: 'Widget',
-      Rect: [0, 0, 0, 0],
-      Parent: parent,
-    });
-    return new PDFWidgetAnnotation(dict);
-  };
-
-  MK(): PDFDict | undefined {
-    const MK = this.dict.lookup(PDFName.of('MK'));
-    if (MK instanceof PDFDict) return MK;
-    return undefined;
-  }
-
-  BS(): PDFDict | undefined {
-    const BS = this.dict.lookup(PDFName.of('BS'));
-    if (BS instanceof PDFDict) return BS;
-    return undefined;
-  }
-
-  DA(): PDFString | PDFHexString | undefined {
-    const da = this.dict.lookup(PDFName.of('DA'));
-    if (da instanceof PDFString || da instanceof PDFHexString) return da;
-    return undefined;
-  }
-
-  P(): PDFRef | undefined {
-    const P = this.dict.get(PDFName.of('P'));
-    if (P instanceof PDFRef) return P;
-    return undefined;
-  }
-
-  setP(page: PDFRef) {
-    this.dict.set(PDFName.of('P'), page);
-  }
-
-  setDefaultAppearance(appearance: string) {
-    this.dict.set(PDFName.of('DA'), PDFString.of(appearance));
-  }
-
-  getDefaultAppearance(): string | undefined {
-    const DA = this.DA();
-
-    if (DA instanceof PDFHexString) {
-      return DA.decodeText();
-    }
-
-    return DA?.asString();
-  }
-
-  getAppearanceCharacteristics(): AppearanceCharacteristics | undefined {
-    const MK = this.MK();
-    if (MK) return AppearanceCharacteristics.fromDict(MK);
-    return undefined;
-  }
-
-  getOrCreateAppearanceCharacteristics(): AppearanceCharacteristics {
-    const MK = this.MK();
-    if (MK) return AppearanceCharacteristics.fromDict(MK);
-
-    const ac = AppearanceCharacteristics.fromDict(this.dict.context.obj({}));
-    this.dict.set(PDFName.of('MK'), ac.dict);
-    return ac;
-  }
-
-  getBorderStyle(): BorderStyle | undefined {
-    const BS = this.BS();
-    if (BS) return BorderStyle.fromDict(BS);
-    return undefined;
-  }
-
-  getOrCreateBorderStyle(): BorderStyle {
-    const BS = this.BS();
-    if (BS) return BorderStyle.fromDict(BS);
-
-    const bs = BorderStyle.fromDict(this.dict.context.obj({}));
-    this.dict.set(PDFName.of('BS'), bs.dict);
-    return bs;
-  }
-
-  getOnValue(): PDFName | undefined {
-    const normal = this.getAppearances()?.normal;
-
-    if (normal instanceof PDFDict) {
-      const keys = normal.keys();
-      for (let idx = 0, len = keys.length; idx < len; idx++) {
-        const key = keys[idx];
-        if (key !== PDFName.of('Off')) return key;
-      }
-    }
-
-    return undefined;
-  }
-}
-
-export default PDFWidgetAnnotation;

package/src/core/annotation/flags.ts

@@ -1,90 +0,0 @@
-const flag = (bitIndex: number) => 1 << bitIndex;
-
-/** From PDF spec table 165 */
-export enum AnnotationFlags {
-  /**
-   * If set, do not display the annotation if it does not belong to one of the
-   * standard annotation types and no annotation handler is available. If clear,
-   * display such an unknown annotation using an appearance stream specified by
-   * its appearance dictionary, if any.
-   */
-  Invisible = flag(1 - 1),
-
-  /**
-   * If set, do not display or print the annotation or allow it to interact with
-   * the user, regardless of its annotation type or whether an annotation
-   * handler is available.
-   *
-   * In cases where screen space is limited, the ability to hide and show
-   * annotations selectively can be used in combination with appearance streams
-   * to display auxiliary pop-up information similar in function to online help
-   * systems.
-   */
-  Hidden = flag(2 - 1),
-
-  /**
-   * If set, print the annotation when the page is printed. If clear, never
-   * print the annotation, regardless of whether it is displayed on the screen.
-   *
-   * This can be useful for annotations representing interactive pushbuttons,
-   * which would serve no meaningful purpose on the printed page.
-   */
-  Print = flag(3 - 1),
-
-  /**
-   * If set, do not scale the annotation’s appearance to match the magnification
-   * of the page. The location of the annotation on the page (defined by the
-   * upper-left corner of its annotation rectangle) shall remain fixed,
-   * regardless of the page magnification.
-   */
-  NoZoom = flag(4 - 1),
-
-  /**
-   * If set, do not rotate the annotation’s appearance to match the rotation of
-   * the page. The upper-left corner of the annotation rectangle shall remain in
-   * a fixed location on the page, regardless of the page rotation.
-   */
-  NoRotate = flag(5 - 1),
-
-  /**
-   * If set, do not display the annotation on the screen or allow it to interact
-   * with the user. The annotation may be printed (depending on the setting of
-   * the Print flag) but should be considered hidden for purposes of on-screen
-   * display and user interaction.
-   */
-  NoView = flag(6 - 1),
-
-  /**
-   * If set, do not allow the annotation to interact with the user. The
-   * annotation may be displayed or printed (depending on the settings of the
-   * NoView and Print flags) but should not respond to mouse clicks or change
-   * its appearance in response to mouse motions.
-   *
-   * This flag shall be ignored for widget annotations; its function is
-   * subsumed by the ReadOnly flag of the associated form field.
-   */
-  ReadOnly = flag(7 - 1),
-
-  /**
-   * If set, do not allow the annotation to be deleted or its properties
-   * (including position and size) to be modified by the user. However, this
-   * flag does not restrict changes to the annotation’s contents, such as the
-   * value of a form field.
-   */
-  Locked = flag(8 - 1),
-
-  /**
-   * If set, invert the interpretation of the NoView flag for certain events.
-   *
-   * A typical use is to have an annotation that appears only when a mouse
-   * cursor is held over it.
-   */
-  ToggleNoView = flag(9 - 1),
-
-  /**
-   * If set, do not allow the contents of the annotation to be modified by the
-   * user. This flag does not restrict deletion of the annotation or changes to
-   * other annotation properties, such as position and size.
-   */
-  LockedContents = flag(10 - 1),
-}