@hidemikimura/receipt-html-to-pdf 0.1.0

package/types/pdf/writer.d.ts

@@ -0,0 +1,125 @@
+/**
+ * PDF テキスト文字列。ASCII のみならリテラル文字列、そうでなければ UTF-16BE (BOM 付き) の 16 進文字列。
+ * @param {string} s
+ * @returns {Raw}
+ */
+export function pdfString(s: string): Raw;
+/**
+ * PDF 日付文字列 (D:YYYYMMDDHHmmSS+HH'mm')
+ * @param {Date} d
+ * @returns {Raw}
+ */
+export function pdfDate(d: Date): Raw;
+/**
+ * @typedef {number|string|boolean|null|Ref|Name|Raw|PdfArray|PdfDict} PdfValue
+ */
+/** @typedef {PdfValue[]} PdfArray */
+/** @typedef {{[key: string]: PdfValue}} PdfDict */
+/**
+ * 値を PDF 構文にシリアライズする。
+ * - number → 数値、boolean → true/false、null → null
+ * - string → 名前 (/Foo)。テキスト文字列は pdfString() で Raw にして渡す
+ * - 配列 → [ ... ]、プレーンオブジェクト → << /Key value ... >>
+ * @param {PdfValue} v
+ * @returns {string}
+ */
+export function serialize(v: PdfValue): string;
+/**
+ * @param {Uint8Array[]} chunks
+ * @returns {Uint8Array}
+ */
+export function concat(chunks: Uint8Array[]): Uint8Array;
+/** 間接オブジェクト参照 */
+export class Ref {
+    /** @param {number} id */
+    constructor(id: number);
+    id: number;
+    toString(): string;
+}
+/** PDF 名前オブジェクト（/Name） */
+export class Name {
+    /** @param {string} name */
+    constructor(name: string);
+    name: string;
+    toString(): string;
+}
+/** バイト列そのまま（既にシリアライズ済みの断片） */
+export class Raw {
+    /** @param {string} text */
+    constructor(text: string);
+    text: string;
+    toString(): string;
+}
+/**
+ * @typedef {object} PdfObject
+ * @property {PdfValue} value
+ * @property {Uint8Array} [stream]
+ */
+export class PdfWriter {
+    /**
+     * @param {{compress?: boolean, version?: string}} [options]
+     */
+    constructor(options?: {
+        compress?: boolean;
+        version?: string;
+    });
+    /** @type {(PdfObject|null)[]} 0 番はフリーオブジェクト */
+    objects: (PdfObject | null)[];
+    compress: boolean;
+    version: string;
+    /**
+     * 間接オブジェクトを予約する（後で set で中身を入れる）。
+     * @returns {Ref}
+     */
+    reserve(): Ref;
+    /**
+     * @param {Ref} ref
+     * @param {PdfValue} value
+     * @param {Uint8Array} [stream]
+     */
+    set(ref: Ref, value: PdfValue, stream?: Uint8Array): void;
+    /**
+     * @param {PdfValue} value
+     * @returns {Ref}
+     */
+    add(value: PdfValue): Ref;
+    /**
+     * ストリームオブジェクトを追加する。compress が有効なら FlateDecode を試みる。
+     * @param {{[key: string]: PdfValue}} dict
+     * @param {Uint8Array} bytes
+     * @param {{compress?: boolean}} [opts]
+     * @returns {Promise<Ref>}
+     */
+    addStream(dict: {
+        [key: string]: PdfValue;
+    }, bytes: Uint8Array, opts?: {
+        compress?: boolean;
+    }): Promise<Ref>;
+    /**
+     * @param {Ref} ref
+     * @param {{[key: string]: PdfValue}} dict
+     * @param {Uint8Array} bytes
+     * @param {{compress?: boolean}} [opts]
+     */
+    setStream(ref: Ref, dict: {
+        [key: string]: PdfValue;
+    }, bytes: Uint8Array, opts?: {
+        compress?: boolean;
+    }): Promise<void>;
+    /**
+     * ドキュメント全体を組み立てる。
+     * @param {Ref} rootRef  /Catalog への参照
+     * @param {Ref} [infoRef] /Info への参照
+     * @returns {Uint8Array}
+     */
+    build(rootRef: Ref, infoRef?: Ref): Uint8Array;
+}
+export type PdfValue = number | string | boolean | null | Ref | Name | Raw | PdfArray | PdfDict;
+export type PdfArray = PdfValue[];
+export type PdfDict = {
+    [key: string]: PdfValue;
+};
+export type PdfObject = {
+    value: PdfValue;
+    stream?: Uint8Array<ArrayBufferLike> | undefined;
+};

package/types/renderer.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 非表示 iframe に HTML を描画し、レイアウト計測可能な Document を用意する。
+ */
+/**
+ * @typedef {object} RenderedDocument
+ * @property {HTMLIFrameElement} iframe
+ * @property {Document} doc
+ * @property {Window} win
+ * @property {HTMLElement} root   走査の起点（body）
+ * @property {() => void} destroy
+ */
+/**
+ * @param {import('./index.js').ConvertInput} input
+ * @param {{widthPx: number, stylesheets: 'inherit'|'none'|string[], mediaPrint: boolean, baseUrl?: string, warn?: (w: import('./index.js').ConversionWarning) => void}} opts
+ * @returns {Promise<RenderedDocument>}
+ */
+export function renderDocument(input: import("./index.js").ConvertInput, opts: {
+    widthPx: number;
+    stylesheets: "inherit" | "none" | string[];
+    mediaPrint: boolean;
+    baseUrl?: string;
+    warn?: (w: import("./index.js").ConversionWarning) => void;
+}): Promise<RenderedDocument>;
+/**
+ * `@media print { ... }` ブロックを通常ルールとして展開し、`@media screen { ... }` を除去する。
+ * 単純な括弧の対応で処理する（ネストした @media は想定しない）。
+ * @param {string} css
+ * @returns {string}
+ */
+export function expandPrintMediaCss(css: string): string;
+/**
+ * ::before / ::after を実体の <span> に置き換える。
+ * 擬似要素は DOM ノードを持たず Range で計測できないため、computed style をすべて写した span を
+ * 同じ位置に挿入し、元の擬似要素は content: none で消す。文字列 content のみ対応（counter / url は警告）。
+ * @param {Document} doc
+ * @param {(w: import('./index.js').ConversionWarning) => void} warn
+ */
+export function materializePseudoElements(doc: Document, warn: (w: import("./index.js").ConversionWarning) => void): void;
+/**
+ * computed content 値（'"※ "' / '"a" "b"' / 'counter(x)' …）から文字列を取り出す。
+ * 文字列以外のトークンが含まれる場合は null。
+ * @param {string} value
+ * @returns {string|null}
+ */
+export function parseContentString(value: string): string | null;
+export type RenderedDocument = {
+    iframe: HTMLIFrameElement;
+    doc: Document;
+    win: Window;
+    /**
+     * 走査の起点（body）
+     */
+    root: HTMLElement;
+    destroy: () => void;
+};

package/types/units.d.ts

@@ -0,0 +1,53 @@
+/**
+ * CSS 長さ文字列（'15mm', '1in', '12pt', '100px', '2cm'）を pt に変換する。
+ * 単位なしの数値は px とみなす。
+ * @param {string|number} value
+ * @returns {number}
+ */
+export function lengthToPt(value: string | number): number;
+/** @param {number} pt @returns {number} */
+export function ptToPx(pt: number): number;
+/**
+ * getComputedStyle が返す px 文字列（'12px'）を数値にする。
+ * @param {string} value
+ * @returns {number}
+ */
+export function cssPx(value: string): number;
+/**
+ * @typedef {{r: number, g: number, b: number, a: number}} Rgba  各成分 0〜1
+ */
+/**
+ * getComputedStyle の色文字列（'rgb(34, 34, 34)' / 'rgba(0, 0, 0, 0.5)' / 'transparent'
+ * / 'color(srgb ...)'）をパースする。パースできない場合は null。
+ * @param {string} value
+ * @returns {Rgba|null}
+ */
+export function parseColor(value: string): Rgba | null;
+/**
+ * PDF 用に数値を丸めて文字列化する（小数第 3 位まで、末尾ゼロ除去）。
+ * @param {number} n
+ * @returns {string}
+ */
+export function num(n: number): string;
+/**
+ * 単位・色の変換ユーティリティ。
+ * 内部座標は CSS px（ブラウザ計測値）で持ち、PDF 出力時に pt へ変換する。
+ */
+/** 1 CSS px = 0.75 pt（96dpi 基準） */
+export const PX_TO_PT: 0.75;
+/** 1 mm = 72 / 25.4 pt */
+export const MM_TO_PT: number;
+/** @type {Record<string, {width: number, height: number}>} 用紙サイズ（pt） */
+export const PAGE_SIZES: Record<string, {
+    width: number;
+    height: number;
+}>;
+/**
+ * 各成分 0〜1
+ */
+export type Rgba = {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+};

package/types/walker/image.d.ts

@@ -0,0 +1,72 @@
+/**
+ * @param {string} url  絶対 URL（img.currentSrc または background-image の url()）
+ * @param {(w: import('../index.js').ConversionWarning) => void} warn
+ * @param {Element} [element]
+ * @returns {Promise<DecodedImage|null>}
+ */
+export function loadImage(url: string, warn: (w: import("../index.js").ConversionWarning) => void, element?: Element): Promise<DecodedImage | null>;
+/**
+ * JPEG の SOF マーカーから寸法と成分数を読む。
+ * @param {Uint8Array} b
+ * @returns {{width: number, height: number, components: number}|null}
+ */
+export function jpegDimensions(b: Uint8Array): {
+    width: number;
+    height: number;
+    components: number;
+} | null;
+/**
+ * computed background-image の `url("...")` を取り出す。複数指定・グラデーションは null。
+ * @param {string} value
+ * @returns {string|null}
+ */
+export function parseBackgroundUrl(value: string): string | null;
+/**
+ * background-size / background-position / object-fit / object-position から描画矩形を計算する。
+ * @param {{x: number, y: number, w: number, h: number}} box  描画領域（px）
+ * @param {number} iw  画像の固有幅
+ * @param {number} ih
+ * @param {string} size      'auto' | 'cover' | 'contain' | '<w> <h>'（computed 値、px または %）
+ * @param {string} position  '0% 0%' | '50% 50%' | '10px 20px' …（computed 値、2 値）
+ * @returns {{x: number, y: number, w: number, h: number}}
+ */
+export function fitImage(box: {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}, iw: number, ih: number, size: string, position: string): {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
+/**
+ * object-fit を background-size 相当の値に変換する。
+ * @param {string} fit
+ * @returns {string}
+ */
+export function objectFitToSize(fit: string): string;
+export type DecodedImage = {
+    /**
+     * 重複排除キー（URL）
+     */
+    key: string;
+    /**
+     * ピクセル
+     */
+    width: number;
+    height: number;
+    /**
+     * JPEG の生バイト列（DCTDecode）
+     */
+    jpeg: Uint8Array | null;
+    /**
+     * 幅×高さ×3
+     */
+    rgb: Uint8Array | null;
+    /**
+     * 幅×高さ（完全不透明なら null）
+     */
+    alpha: Uint8Array | null;
+};

package/types/walker/text.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @param {Text} node
+ * @param {CSSStyleDeclaration} style
+ * @param {MeasureOptions} o
+ * @returns {MeasuredLine[]}
+ */
+export function measureText(node: Text, style: CSSStyleDeclaration, o: MeasureOptions): MeasuredLine[];
+export type MeasuredLine = {
+    font: import("../font/registry.js").RegisteredFont;
+    /**
+     * ベースライン y（ビューポート座標 px）
+     */
+    baseline: number;
+    /**
+     * 行内グリフ矩形の上端
+     */
+    top: number;
+    /**
+     * 行内グリフ矩形の下端
+     */
+    bottom: number;
+    glyphs: import("./walk.js").Glyph[];
+};
+export type MeasureOptions = {
+    registry: import("../font/registry.js").FontRegistry;
+    families: string[];
+    fallback: string[];
+    primary: import("../font/registry.js").RegisteredFont;
+    weight: number;
+    fstyle: "normal" | "italic";
+    /**
+     * px
+     */
+    size: number;
+    textMeasure: "font" | "measure" | "auto";
+    warn: (w: import("../index.js").ConversionWarning) => void;
+    element: Element;
+};

package/types/walker/walk.d.ts

@@ -0,0 +1,150 @@
+/**
+ * @param {HTMLElement} root
+ * @param {WalkContext} ctx
+ * @returns {Promise<WalkResult>}
+ */
+export function walk(root: HTMLElement, ctx: WalkContext): Promise<WalkResult>;
+/**
+ * computed transform（'matrix(a, b, c, d, e, f)'）を解析する。none / 3D は null。
+ * @param {string} value
+ * @returns {[number, number, number, number, number, number]|null}
+ */
+export function parseTransform(value: string): [number, number, number, number, number, number] | null;
+export type Rgba = import("../units.js").Rgba;
+/**
+ * [左上, 右上, 右下, 左下] px
+ */
+export type Radius = [number, number, number, number];
+export type Box = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    radius?: Radius;
+};
+export type RectItem = {
+    type: "rect";
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    color: Rgba;
+    radius?: Radius;
+    z: number;
+    seq: number;
+};
+export type LineItem = {
+    type: "line";
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+    width: number;
+    color: Rgba;
+    dash: number[] | null;
+    z: number;
+    seq: number;
+};
+export type StrokeRRectItem = {
+    type: "stroke-rrect";
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    radius: Radius;
+    width: number;
+    color: Rgba;
+    dash: number[] | null;
+    z: number;
+    seq: number;
+};
+export type ImageItem = {
+    type: "image";
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    image: import("./image.js").DecodedImage;
+    clip: Box | null;
+    alpha: number;
+    z: number;
+    seq: number;
+};
+/**
+ * advance は px
+ */
+export type Glyph = {
+    gid: number;
+    cp: number;
+    x: number;
+    advance: number;
+};
+export type TextItem = {
+    type: "text";
+    x: number;
+    y: number;
+    top: number;
+    bottom: number;
+    size: number;
+    color: Rgba;
+    font: import("../font/registry.js").RegisteredFont;
+    glyphs: Glyph[];
+    z: number;
+    seq: number;
+};
+export type GroupItem = {
+    type: "group";
+    matrix: [number, number, number, number, number, number];
+    origin: {
+        x: number;
+        y: number;
+    };
+    items: DisplayItem[];
+    top: number;
+    bottom: number;
+    z: number;
+    seq: number;
+};
+/**
+ * overflow: hidden
+ */
+export type ClipItem = {
+    type: "clip";
+    box: Box;
+    items: DisplayItem[];
+    top: number;
+    bottom: number;
+    z: number;
+    seq: number;
+};
+export type DisplayItem = RectItem | LineItem | StrokeRRectItem | ImageItem | TextItem | GroupItem | ClipItem;
+/**
+ * ページ境界を跨いではいけない縦範囲（行・表の行・画像・break-inside: avoid）
+ */
+export type Atom = {
+    top: number;
+    bottom: number;
+};
+export type TableInfo = {
+    top: number;
+    bottom: number;
+    headTop: number;
+    headBottom: number;
+    headItems: DisplayItem[];
+    footTop: number;
+    footBottom: number;
+    footItems: DisplayItem[];
+};
+export type WalkResult = {
+    items: DisplayItem[];
+    atoms: Atom[];
+    breaks: number[];
+    tables: TableInfo[];
+    height: number;
+};
+export type WalkContext = {
+    registry: import("../font/registry.js").FontRegistry;
+    fontFallback: string[];
+    warn: (w: import("../index.js").ConversionWarning) => void;
+    textMeasure: "font" | "measure" | "auto";
+};