@hidemikimura/receipt-html-to-pdf 0.2.1 → 0.4.0

package/types/pdf/outline.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @typedef {{page: number, x: number, y: number}} DestPoint  飛び先（0 始まりのページ番号と、そのページの PDF 座標）
+ */
+/**
+ * リンク注釈を作る。
+ * @param {import('./writer.js').PdfWriter} writer
+ * @param {{x: number, y: number, w: number, h: number}} rect  PDF 座標（左下原点）
+ * @param {{uri: string}|{dest: import('./writer.js').PdfValue}} action
+ * @returns {import('./writer.js').Ref}
+ */
+export function buildLinkAnnot(writer: import("./writer.js").PdfWriter, rect: {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}, action: {
+    uri: string;
+} | {
+    dest: import("./writer.js").PdfValue;
+}): import("./writer.js").Ref;
+/**
+ * 見出しの並びから、レベルに応じた木構造のしおりを作り、カタログに入れる参照を返す。
+ * 飛び先が解決できない見出しは飛ばす。
+ *
+ * @param {import('./writer.js').PdfWriter} writer
+ * @param {{level: number, text: string, dest: import('./writer.js').PdfValue|null}[]} entries
+ * @returns {import('./writer.js').Ref|null}
+ */
+export function buildOutline(writer: import("./writer.js").PdfWriter, entries: {
+    level: number;
+    text: string;
+    dest: import("./writer.js").PdfValue | null;
+}[]): import("./writer.js").Ref | null;
+/**
+ * 飛び先（0 始まりのページ番号と、そのページの PDF 座標）
+ */
+export type DestPoint = {
+    page: number;
+    x: number;
+    y: number;
+};

package/types/pdf/shading.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 軸シェーディングの辞書を作る。座標は PDF 座標（pt）。
+ *
+ * @param {import('./writer.js').PdfWriter} writer
+ * @param {{x0: number, y0: number, x1: number, y1: number}} coords
+ * @param {GradientStop[]} stops
+ * @param {'rgb'|'gray'} space
+ * @returns {import('./writer.js').Ref}
+ */
+export function buildAxialShading(writer: import("./writer.js").PdfWriter, coords: {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+}, stops: GradientStop[], space: "rgb" | "gray"): import("./writer.js").Ref;
+/**
+ * 色止めのアルファが一定ならその値、そうでなければ null。
+ * @param {GradientStop[]} stops
+ * @returns {number|null}
+ */
+export function uniformAlpha(stops: GradientStop[]): number | null;
+/**
+ * アルファが変化するグラデーション用の輝度ソフトマスクを作る。
+ * グレースケールのシェーディングを描くフォーム XObject を /SMask に入れた ExtGState を返す。
+ *
+ * @param {import('./writer.js').PdfWriter} writer
+ * @param {{x0: number, y0: number, x1: number, y1: number}} coords  PDF 座標
+ * @param {GradientStop[]} stops
+ * @param {{x: number, y: number, w: number, h: number}} bbox  マスクを塗る範囲（PDF 座標）
+ * @param {number} groupAlpha  要素から継承した不透明度（グラデーション全体に掛かる）
+ * @returns {Promise<import('./writer.js').Ref>} ExtGState の参照
+ */
+export function buildAlphaMaskGState(writer: import("./writer.js").PdfWriter, coords: {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+}, stops: GradientStop[], bbox: {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}, groupAlpha: number): Promise<import("./writer.js").Ref>;
+export type GradientStop = import("../walker/gradient.js").GradientStop;

package/types/walker/gradient.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @typedef {{t: number, color: import('../units.js').Rgba}} GradientStop
+ * @typedef {{x0: number, y0: number, x1: number, y1: number, stops: GradientStop[]}} LinearGradient
+ */
+/**
+ * computed の background-image が単一の linear-gradient ならそれを解析する。
+ * 対応しない書式（repeating / radial / conic / 複数レイヤー）は null。
+ *
+ * @param {string} value  computed の background-image
+ * @param {number} width  箱の幅（px）
+ * @param {number} height 箱の高さ（px）
+ * @returns {LinearGradient|null}
+ */
+export function parseLinearGradient(value: string, width: number, height: number): LinearGradient | null;
+export type GradientStop = {
+    t: number;
+    color: import("../units.js").Rgba;
+};
+export type LinearGradient = {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+    stops: GradientStop[];
+};

package/types/walker/image.d.ts

@@ -47,6 +47,42 @@ export function fitImage(box: {
  * @returns {string}
  */
 export function objectFitToSize(fit: string): string;
+/**
+ * `background-repeat` の computed 値を軸ごとに分ける。
+ * `repeat-x` / `repeat-y` は 2 値表記に展開する。
+ * @param {string} value
+ * @returns {['repeat'|'no-repeat'|'space'|'round', 'repeat'|'no-repeat'|'space'|'round']}
+ */
+export function splitRepeat(value: string): ["repeat" | "no-repeat" | "space" | "round", "repeat" | "no-repeat" | "space" | "round"];
+/**
+ * 1 軸ぶんのタイル位置を求める。
+ *
+ * - `repeat`: 指定位置を基準に、描画領域を覆うまで両方向へ並べる
+ * - `no-repeat`: 指定位置に 1 枚
+ * - `round`: 描画領域に整数個収まるようタイルの大きさを調整して並べる（大きさが変わる）
+ * - `space`: 整数個を等間隔に置き、余りを隙間に配る。1 枚しか入らないなら先頭に 1 枚
+ *
+ * @param {'repeat'|'no-repeat'|'space'|'round'} mode
+ * @param {number} start      指定位置（background-position の結果）
+ * @param {number} size       タイルの大きさ
+ * @param {number} areaStart  描画領域の開始
+ * @param {number} areaEnd    描画領域の終わり
+ * @returns {{positions: number[], size: number}}
+ */
+export function tileAxis(mode: "repeat" | "no-repeat" | "space" | "round", start: number, size: number, areaStart: number, areaEnd: number): {
+    positions: number[];
+    size: number;
+};
+/**
+ * 埋め込みが済んだ画像のピクセルデータを手放す。
+ * デコード結果（RGB・アルファ・JPEG のバイト列）は元画像より桁違いに大きいので、
+ * PDF に書き出したあとも抱えていると大きな文書でピーク使用量が跳ね上がる。
+ *
+ * キャッシュからも外すので、次の変換では読み直しになる（速度よりメモリを優先する）。
+ *
+ * @param {DecodedImage} img
+ */
+export function releasePixels(img: DecodedImage): void;
 export type DecodedImage = {
     /**
      * 重複排除キー（URL）

package/types/walker/svg-path.d.ts

@@ -0,0 +1,31 @@
+/**
+ * SVG のパスデータと基本図形を、PDF に出せる形（絶対座標の M / L / C / Z）へ正規化する。
+ *
+ * 円弧（A）は 3 次ベジェへ、二次ベジェ（Q / T）も 3 次へ変換する。
+ * 座標は要素のユーザー単位のまま（変換行列は描画時に cm で適用する）。
+ */
+/**
+ * @typedef {['M', number, number]|['L', number, number]|['C', number, number, number, number, number, number]|['Z']} PathSeg
+ */
+/**
+ * `d` 属性を絶対座標の M / L / C / Z 列にする。
+ * @param {string} d
+ * @returns {PathSeg[]}
+ */
+export function parsePathData(d: string): PathSeg[];
+/**
+ * 楕円円弧を 3 次ベジェ列にする（SVG 仕様 F.6 の実装）。
+ * @param {number} x1 @param {number} y1 @param {number} x2 @param {number} y2
+ * @param {number} rx @param {number} ry @param {number} rotDeg
+ * @param {boolean} large @param {boolean} sweep
+ * @returns {PathSeg[]}
+ */
+export function arcToCurves(x1: number, y1: number, x2: number, y2: number, rx: number, ry: number, rotDeg: number, large: boolean, sweep: boolean): PathSeg[];
+/**
+ * 基本図形をパスにする。対応しない要素は null。
+ * @param {Element} el
+ * @param {(name: string) => string} attr  属性値（プレゼンテーション属性は computed style を優先しない純粋な幾何属性）
+ * @returns {PathSeg[]|null}
+ */
+export function shapeToPath(el: Element, attr: (name: string) => string): PathSeg[] | null;
+export type PathSeg = ["M", number, number] | ["L", number, number] | ["C", number, number, number, number, number, number] | ["Z"];

package/types/walker/text.d.ts

@@ -33,6 +33,10 @@ export type MeasureOptions = {
      */
     size: number;
     textMeasure: "font" | "measure" | "auto";
+    /**
+     * ブラウザが有効にしている OpenType 機能タグ（GSUB の単一置換を再現する）
+     */
+    features: string[];
     warn: (w: import("../index.js").ConversionWarning) => void;
     element: Element;
 };

package/types/walker/walk.d.ts

@@ -117,7 +117,43 @@ export type ClipItem = {
     z: number;
     seq: number;
 };
-export type DisplayItem = RectItem | LineItem | StrokeRRectItem | ImageItem | TextItem | GroupItem | ClipItem;
+/**
+ * linear-gradient（box はグラデーションの基準領域、clip は描画範囲）
+ */
+export type GradientItem = {
+    type: "gradient";
+    box: Box;
+    clip: Box;
+    gradient: import("./gradient.js").LinearGradient;
+    alpha: number;
+    z: number;
+    seq: number;
+};
+export type PathStroke = {
+    color: Rgba;
+    width: number;
+    cap: 0 | 1 | 2;
+    join: 0 | 1 | 2;
+    miter: number;
+    dash: number[] | null;
+    dashOffset: number;
+};
+/**
+ * インライン SVG の図形（matrix はユーザー単位 → ドキュメント px）
+ */
+export type PathItem = {
+    type: "path";
+    segs: import("./svg-path.js").PathSeg[];
+    matrix: [number, number, number, number, number, number];
+    fill: Rgba | null;
+    evenOdd: boolean;
+    stroke: PathStroke | null;
+    top: number;
+    bottom: number;
+    z: number;
+    seq: number;
+};
+export type DisplayItem = RectItem | LineItem | StrokeRRectItem | ImageItem | TextItem | GroupItem | ClipItem | GradientItem | PathItem;
 /**
  * ページ境界を跨いではいけない縦範囲（行・表の行・画像・break-inside: avoid）
  */
@@ -135,11 +171,42 @@ export type TableInfo = {
     footBottom: number;
     footItems: DisplayItem[];
 };
+/**
+ * break-before/after: avoid — [start, end] に境界を置かず、置きそうなら pullTo まで戻す
+ */
+export type Join = {
+    start: number;
+    end: number;
+    pullTo: number;
+};
+/**
+ * <a href> の 1 行ぶんの当たり判定（ドキュメント px）
+ */
+export type LinkRect = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+    href: string;
+    fragment: string | null;
+};
+/**
+ * しおり用の見出し
+ */
+export type Heading = {
+    level: number;
+    text: string;
+    y: number;
+};
 export type WalkResult = {
     items: DisplayItem[];
     atoms: Atom[];
     breaks: number[];
+    joins: Join[];
     tables: TableInfo[];
+    links: LinkRect[];
+    anchors: Map<string, number>;
+    headings: Heading[];
     height: number;
 };
 export type WalkContext = {
@@ -147,4 +214,8 @@ export type WalkContext = {
     fontFallback: string[];
     warn: (w: import("../index.js").ConversionWarning) => void;
     textMeasure: "font" | "measure" | "auto";
+    /**
+     * 長い走査で途中イベントループへ戻すための譲渡
+     */
+    pacer?: import("../pacer.js").Pacer | undefined;
 };