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

package/examples/cdn.html

@@ -61,11 +61,11 @@
 
 <!--
   ここが CDN からの読み込み。type="module" が要る。
-  バージョン（@0.3.0）は必ず固定する。外すと最新版が読み込まれ、更新のたびに挙動が変わりうる。
+  バージョン（@0.4.0）は必ず固定する。外すと最新版が読み込まれ、更新のたびに挙動が変わりうる。
 -->
 <script type="module">
   import * as ReceiptHtmlToPdf
-    from 'https://cdn.jsdelivr.net/npm/@hidemikimura/receipt-html-to-pdf@0.3.0/dist/receipt-html-to-pdf.min.js';
+    from 'https://cdn.jsdelivr.net/npm/@hidemikimura/receipt-html-to-pdf@0.4.0/dist/receipt-html-to-pdf.min.js';
 
   // type="module" でない普通のスクリプトからも使えるようにグローバルへ載せる
   window.ReceiptHtmlToPdf = ReceiptHtmlToPdf;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hidemikimura/receipt-html-to-pdf",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Receipt html to pdf — ブラウザ内で HTML/CSS をテキスト選択可能なベクター PDF に変換するライブラリ（日本の領収証・適格請求書向け）",
   "license": "MIT",
   "author": "Hidemi Kimura",

package/skills/receipt-html-to-pdf/SKILL.md

@@ -45,7 +45,7 @@ npm を使わない場合は CDN の URL をそのまま `import` できる（`d
 ```html
 <script type="module">
   import { registerFont, htmlToPdf, downloadPdf }
-    from 'https://cdn.jsdelivr.net/npm/@hidemikimura/receipt-html-to-pdf@0.3.0/dist/receipt-html-to-pdf.min.js';
+    from 'https://cdn.jsdelivr.net/npm/@hidemikimura/receipt-html-to-pdf@0.4.0/dist/receipt-html-to-pdf.min.js';
 </script>
 ```
 
@@ -92,6 +92,8 @@ npm を使わない場合は CDN の URL をそのまま `import` できる（`d
 | `baseUrl` | 現在の文書 | 相対 URL（フォント・画像）の基準 |
 | `output` | `'blob'` | `'uint8array'` `'dataurl'` |
 | `onWarning` | — | 未対応 CSS・欠落グリフ・画像失敗の通知。**必ず配線する** |
+| `links` | `true` | `<a href>` を PDF のリンク注釈にする（外部 URL・`mailto:`・文書内 `#id`） |
+| `outline` | `false` | `h1`〜`h6` からしおり（PDF の目次）を作る |
 | `onProgress` | — | `render` → `walk` → `layout`（`totalPages` 確定）→ `page`（1 ページずつ）→ `done`。長い文書の進捗表示に使う |
 
 ## 対応している CSS の要点
@@ -129,6 +131,12 @@ footer: '<div style="text-align:center;font-size:8pt">{{pageNumber}} / {{totalPa
 
 `orphans` / `widows` / `@page` は未対応。用紙サイズと余白は `options.page` で指定する。
 
+## リンクとしおり
+
+`<a href>` は既定で PDF のリンク注釈になる（外部 URL・`mailto:` / `tel:`・文書内 `#id`）。折り返した行やページを跨ぐリンクは分割して注釈を作り、ヘッダー／フッターの中のリンクも各ページに出る。`javascript:` と、飛び先の無い `#id` は注釈にしない。止めるなら `links: false`。
+
+`outline: true` を渡すと `h1`〜`h6` の入れ子からしおり（ビューアのサイドバーに出る目次）を作る。長い明細書で便利。既定では作らない。
+
 ## 長い文書
 
 変換は途中でイベントループへ戻すので、数百ページでも画面は固まらない（所要時間は 1 割ほど増える）。進捗表示を出すなら `onProgress` を配線する。

package/src/index.js

@@ -82,6 +82,8 @@ export { expandPrintMediaCss } from './renderer.js';
  * @property {'blob'|'uint8array'|'dataurl'} [output='blob']
  * @property {string} [baseUrl]                  相対 URL（フォント・画像）の基準。既定は現在の文書
  * @property {(warning: ConversionWarning) => void} [onWarning]
+ * @property {boolean} [links=true]     `<a href>` を PDF のリンク注釈にする
+ * @property {boolean} [outline=false]  見出し（h1〜h6）からしおり（PDF の目次）を作る
  * @property {(progress: ConversionProgress) => void} [onProgress]  進捗通知。長い文書では途中でイベントループへ戻すので、UI を更新できる
  */
 
@@ -91,7 +93,7 @@ export { expandPrintMediaCss } from './renderer.js';
  */
 
 /** ライブラリのバージョン（package.json と同期） */
-export const version = '0.3.0';
+export const version = '0.4.0';
 
 /** モジュール共有のフォントレジストリ */
 const registry = new FontRegistry();
@@ -176,6 +178,8 @@ export async function htmlToPdf(input, options = {}) {
       metadata: options.metadata,
       header,
       footer,
+      links: options.links ?? true,
+      outline: options.outline ?? false,
       pacer,
       progress,
       warn,

package/src/page.js

@@ -11,6 +11,7 @@ import { PX_TO_PT, PAGE_SIZES, lengthToPt, num } from './units.js';
 import { paginate } from './paginate.js';
 import { releasePixels, loadImage } from './walker/image.js';
 import { buildAxialShading, uniformAlpha, buildAlphaMaskGState } from './pdf/shading.js';
+import { buildLinkAnnot, buildOutline } from './pdf/outline.js';
 
 /**
  * @typedef {object} PageGeometry
@@ -58,7 +59,7 @@ export function resolvePage(page = {}) {
 /**
  * @param {import('./walker/walk.js').WalkResult} body
  * @param {PageGeometry} geo
- * @param {{compress: boolean, metadata?: import('./index.js').PdfMetadata, header?: PageDecoration|null, footer?: PageDecoration|null, pacer?: import('./pacer.js').Pacer, progress?: (p: import('./index.js').ConversionProgress) => void, warn?: (w: import('./index.js').ConversionWarning) => void}} opts
+ * @param {{compress: boolean, metadata?: import('./index.js').PdfMetadata, header?: PageDecoration|null, footer?: PageDecoration|null, pacer?: import('./pacer.js').Pacer, progress?: (p: import('./index.js').ConversionProgress) => void, warn?: (w: import('./index.js').ConversionWarning) => void, links?: boolean, outline?: boolean}} opts
  * @returns {Promise<Uint8Array>}
  */
 export async function buildPdf(body, geo, opts) {
@@ -177,6 +178,26 @@ export async function buildPdf(body, geo, opts) {
   const pagesRef = writer.reserve();
   /** @type {import('./pdf/writer.js').Ref[]} */
   const pageRefs = [];
+  // リンクの飛び先は前後どちらのページにもなりうるので、ページ参照を先に確保しておく
+  const pageSlots = Array.from({ length: totalPages }, () => writer.reserve());
+  /** @param {number} i @returns {import('./pdf/writer.js').Ref} */
+  const slotOf = (i) => /** @type {import('./pdf/writer.js').Ref} */ (pageSlots[i]);
+
+  /**
+   * ドキュメント y が載るページと、そのページでの PDF 座標を求める。
+   * @param {number} docY
+   * @returns {{page: number, x: number, y: number}|null}
+   */
+  const locate = (docY) => {
+    for (let i = 0; i < totalPages; i++) {
+      const r = /** @type {import('./paginate.js').PageRange} */ (ranges[i]);
+      if (docY >= r.start - 0.01 && (docY < r.end - 0.01 || i === totalPages - 1)) {
+        const top = contentTop - r.headShift * PX_TO_PT;
+        return { page: i, x: geo.left, y: top - (docY - r.start) * PX_TO_PT };
+      }
+    }
+    return null;
+  };
 
   // 4. ページごとに描画
   opts.progress?.({ phase: 'layout', totalPages });
@@ -236,26 +257,85 @@ export async function buildPdf(body, geo, opts) {
       cs.restore();
     }
 
+    // リンク注釈。ページ範囲で切り取ってから用紙座標へ写す
+    /** @type {import('./pdf/writer.js').PdfValue[]} */
+    const annots = [];
+    if (opts.links !== false) {
+      /**
+       * @param {import('./walker/walk.js').LinkRect[]} list
+       * @param {number} pdfTop   この帯の上端（PDF 座標）
+       * @param {number} docTop   その位置に対応するドキュメント y
+       * @param {number} docEnd   この帯に出せるドキュメント y の終わり
+       */
+      const addLinks = (list, pdfTop, docTop, docEnd) => {
+        for (const link of list) {
+          const y0 = Math.max(link.y, docTop);
+          const y1 = Math.min(link.y + link.h, docEnd);
+          if (y1 - y0 <= 0.01) continue;
+          const rect = {
+            x: geo.left + link.x * PX_TO_PT,
+            y: pdfTop - (y1 - docTop) * PX_TO_PT,
+            w: link.w * PX_TO_PT,
+            h: (y1 - y0) * PX_TO_PT,
+          };
+          if (link.fragment === null) {
+            annots.push(buildLinkAnnot(writer, rect, { uri: link.href }));
+            continue;
+          }
+          const targetY = body.anchors?.get(link.fragment);
+          if (targetY === undefined) continue; // 飛び先が無いリンクは注釈にしない
+          const at = locate(targetY);
+          if (!at) continue;
+          annots.push(buildLinkAnnot(writer, rect, { dest: [slotOf(at.page), new Name('XYZ'), at.x, at.y, null] }));
+        }
+      };
+      addLinks(body.links ?? [], contentTop - bodyShiftPt, range.start, range.end);
+      if (header) addLinks(header.links ?? [], geo.height - geo.top, 0, headerPt / PX_TO_PT);
+      if (footer) addLinks(footer.links ?? [], geo.bottom + footerPt, 0, footerPt / PX_TO_PT);
+    }
+
     const contentRef = await writer.addStream({}, cs.toBytes());
-    pageRefs.push(
-      writer.add({
-        Type: 'Page',
-        Parent: pagesRef,
-        MediaBox: [0, 0, geo.width, geo.height],
-        Resources: {
-          Font: fontDict,
-          XObject: xobjDict,
-          ExtGState: gstateDict,
-          Shading: shadingDict,
-          ProcSet: [new Name('PDF'), new Name('Text'), new Name('ImageC')],
-        },
-        Contents: contentRef,
+    /** @type {{[key: string]: import('./pdf/writer.js').PdfValue}} */
+    const pageDict = {
+      Type: 'Page',
+      Parent: pagesRef,
+      MediaBox: [0, 0, geo.width, geo.height],
+      Resources: {
+        Font: fontDict,
+        XObject: xobjDict,
+        ExtGState: gstateDict,
+        Shading: shadingDict,
+        ProcSet: [new Name('PDF'), new Name('Text'), new Name('ImageC')],
+      },
+      Contents: contentRef,
+    };
+    if (annots.length) pageDict.Annots = annots;
+    const slot = slotOf(p);
+    writer.set(slot, pageDict);
+    pageRefs.push(slot);
+  }
+
+  writer.set(pagesRef, { Type: 'Pages', Kids: pageRefs, Count: pageRefs.length });
+
+  // しおり: 見出しから木を作る
+  let outlineRef = null;
+  if (opts.outline) {
+    outlineRef = buildOutline(
+      writer,
+      (body.headings ?? []).map((h) => {
+        const at = locate(h.y);
+        return { level: h.level, text: h.text, dest: at ? [slotOf(at.page), new Name('XYZ'), at.x, at.y, null] : null };
       }),
     );
   }
 
-  writer.set(pagesRef, { Type: 'Pages', Kids: pageRefs, Count: pageRefs.length });
-  const catalog = writer.add({ Type: 'Catalog', Pages: pagesRef });
+  /** @type {{[key: string]: import('./pdf/writer.js').PdfValue}} */
+  const catalogDict = { Type: 'Catalog', Pages: pagesRef };
+  if (outlineRef) {
+    catalogDict.Outlines = outlineRef;
+    catalogDict.PageMode = new Name('UseOutlines');
+  }
+  const catalog = writer.add(catalogDict);
 
   const md = opts.metadata ?? {};
   /** @type {{[key: string]: import('./pdf/writer.js').PdfValue}} */

package/src/pdf/outline.js

@@ -0,0 +1,103 @@
+// @ts-check
+/**
+ * しおり（/Outlines）とリンク注釈（/Annots）の組み立て。
+ */
+import { Name, pdfString } from './writer.js';
+
+/**
+ * @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, rect, action) {
+  /** @type {{[key: string]: import('./writer.js').PdfValue}} */
+  const annot = {
+    Type: new Name('Annot'),
+    Subtype: new Name('Link'),
+    Rect: [rect.x, rect.y, rect.x + rect.w, rect.y + rect.h],
+    // 既定の枠線を消す（多くのビューアは描かないが、仕様上は残る）
+    Border: [0, 0, 0],
+    F: 4, // Print
+  };
+  if ('uri' in action) annot.A = { S: new Name('URI'), URI: pdfString(action.uri) };
+  else annot.Dest = action.dest;
+  return writer.add(annot);
+}
+
+/**
+ * 見出しの並びから、レベルに応じた木構造のしおりを作り、カタログに入れる参照を返す。
+ * 飛び先が解決できない見出しは飛ばす。
+ *
+ * @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, entries) {
+  const usable = entries.filter((e) => e.dest !== null);
+  if (!usable.length) return null;
+
+  /**
+   * @typedef {{level: number, text: string, dest: import('./writer.js').PdfValue, children: Node[], ref: import('./writer.js').Ref}} Node
+   */
+  /** @type {Node[]} */
+  const roots = [];
+  /** @type {Node[]} 現在の祖先チェーン */
+  const stack = [];
+  for (const e of usable) {
+    /** @type {Node} */
+    const node = { level: e.level, text: e.text, dest: /** @type {import('./writer.js').PdfValue} */ (e.dest), children: [], ref: writer.reserve() };
+    while (stack.length && /** @type {Node} */ (stack[stack.length - 1]).level >= node.level) stack.pop();
+    const parent = stack[stack.length - 1];
+    if (parent) parent.children.push(node);
+    else roots.push(node);
+    stack.push(node);
+  }
+
+  const outlineRef = writer.reserve();
+
+  /**
+   * 兄弟の並びを書き出し、開いている項目数（Count 用）を返す。
+   * @param {Node[]} nodes
+   * @param {import('./writer.js').Ref} parentRef
+   * @returns {number}
+   */
+  const emit = (nodes, parentRef) => {
+    let total = 0;
+    nodes.forEach((node, i) => {
+      const childCount = emit(node.children, node.ref);
+      /** @type {{[key: string]: import('./writer.js').PdfValue}} */
+      const dict = {
+        Title: pdfString(node.text),
+        Parent: parentRef,
+        Dest: node.dest,
+      };
+      const prev = nodes[i - 1];
+      const next = nodes[i + 1];
+      if (prev) dict.Prev = prev.ref;
+      if (next) dict.Next = next.ref;
+      if (node.children.length) {
+        dict.First = /** @type {Node} */ (node.children[0]).ref;
+        dict.Last = /** @type {Node} */ (node.children[node.children.length - 1]).ref;
+        dict.Count = childCount; // 正の値 = 既定で開いた状態
+      }
+      writer.set(node.ref, dict);
+      total += 1 + childCount;
+    });
+    return total;
+  };
+
+  const count = emit(roots, outlineRef);
+  writer.set(outlineRef, {
+    Type: new Name('Outlines'),
+    First: /** @type {Node} */ (roots[0]).ref,
+    Last: /** @type {Node} */ (roots[roots.length - 1]).ref,
+    Count: count,
+  });
+  return outlineRef;
+}

package/src/walker/walk.js

@@ -32,7 +32,9 @@ import { shapeToPath } from './svg-path.js';
  * @typedef {{top: number, bottom: number}} Atom  ページ境界を跨いではいけない縦範囲（行・表の行・画像・break-inside: avoid）
  * @typedef {{top: number, bottom: number, headTop: number, headBottom: number, headItems: DisplayItem[], footTop: number, footBottom: number, footItems: DisplayItem[]}} TableInfo
  * @typedef {{start: number, end: number, pullTo: number}} Join  break-before/after: avoid — [start, end] に境界を置かず、置きそうなら pullTo まで戻す
- * @typedef {{items: DisplayItem[], atoms: Atom[], breaks: number[], joins: Join[], tables: TableInfo[], height: number}} WalkResult
+ * @typedef {{x: number, y: number, w: number, h: number, href: string, fragment: string|null}} LinkRect  <a href> の 1 行ぶんの当たり判定（ドキュメント px）
+ * @typedef {{level: number, text: string, y: number}} Heading  しおり用の見出し
+ * @typedef {{items: DisplayItem[], atoms: Atom[], breaks: number[], joins: Join[], tables: TableInfo[], links: LinkRect[], anchors: Map<string, number>, headings: Heading[], height: number}} WalkResult
  */
 
 /**
@@ -107,6 +109,12 @@ export async function walk(root, ctx) {
   const breaks = [];
   /** @type {Join[]} */
   const joins = [];
+  /** @type {LinkRect[]} */
+  const links = [];
+  /** @type {Map<string, number>} 文書内リンクの飛び先: id → ドキュメント y */
+  const anchors = new Map();
+  /** @type {Heading[]} */
+  const headings = [];
   /** @type {TableInfo[]} */
   const tables = [];
   /** @type {TableInfo|null} 走査中のテーブル（thead の描画命令を記録する先） */
@@ -223,6 +231,8 @@ export async function walk(root, ctx) {
         }
       }
     }
+    collectLinkAndOutline(el, style);
+
     /** @type {TableInfo|null} */
     let openedTable = null;
     if (style.display === 'table' || style.display === 'inline-table') {
@@ -758,6 +768,53 @@ export async function walk(root, ctx) {
     };
   }
 
+  /**
+   * リンク注釈としおりの材料を集める。
+   *
+   * 描画命令ではないので DisplayList には入れず、WalkResult に別で持つ。
+   * `getClientRects()` は transform 適用後の矩形を返すので、変形の中のリンクも
+   * そのまま外接矩形として扱える（PDF の注釈は軸並行の矩形しか持てない）。
+   *
+   * @param {Element} el
+   * @param {CSSStyleDeclaration} style
+   */
+  function collectLinkAndOutline(el, style) {
+    // 飛び先になりうる id を記録する（<a name> も含む）
+    const id = el.id || (el.tagName === 'A' ? el.getAttribute('name') : null);
+    if (id && !anchors.has(id)) {
+      const r = el.getBoundingClientRect();
+      anchors.set(id, r.top + sy);
+    }
+
+    if (/^H[1-6]$/.test(el.tagName)) {
+      const text = (el.textContent ?? '').trim().replace(/\s+/g, ' ');
+      if (text) headings.push({ level: Number(el.tagName[1]), text, y: el.getBoundingClientRect().top + sy });
+    }
+
+    if (el.tagName !== 'A') return;
+    const href = el.getAttribute('href');
+    if (!href) return;
+    if (style.visibility !== 'visible') return;
+    // 同じ文書内へのリンクは飛び先の id を覚えておき、ページが決まってから解決する
+    const fragment = href.startsWith('#') ? decodeURIComponent(href.slice(1)) : null;
+    /** @type {string} */
+    let uri = href;
+    if (!fragment) {
+      try {
+        uri = new URL(href, el.ownerDocument.baseURI).href;
+      } catch {
+        return; // 解決できない href は注釈にしない
+      }
+      // javascript: などは注釈にしない
+      if (!/^(https?|mailto|tel|ftp|file):/i.test(uri)) return;
+    }
+    // インラインで折り返していると行ごとに矩形が返る
+    for (const r of el.getClientRects()) {
+      if (r.width <= 0 || r.height <= 0) continue;
+      links.push({ x: r.left + sx, y: r.top + sy, w: r.width, h: r.height, href: uri, fragment });
+    }
+  }
+
   /**
    * overflow クリップを閉じる。範囲外の命令は捨てる（クリップで消えた文字が抽出テキストに残らないように）。
    * @param {Box} clipBox
@@ -834,7 +891,7 @@ export async function walk(root, ctx) {
     return null;
   }
 
-  return { items: rootItems, atoms, breaks, joins, tables, height };
+  return { items: rootItems, atoms, breaks, joins, tables, links, anchors, headings, height };
 }
 
 /** @param {DisplayItem[]} items */

package/types/index.d.ts

@@ -95,6 +95,8 @@ export { expandPrintMediaCss } from "./renderer.js";
  * @property {'blob'|'uint8array'|'dataurl'} [output='blob']
  * @property {string} [baseUrl]                  相対 URL（フォント・画像）の基準。既定は現在の文書
  * @property {(warning: ConversionWarning) => void} [onWarning]
+ * @property {boolean} [links=true]     `<a href>` を PDF のリンク注釈にする
+ * @property {boolean} [outline=false]  見出し（h1〜h6）からしおり（PDF の目次）を作る
  * @property {(progress: ConversionProgress) => void} [onProgress]  進捗通知。長い文書では途中でイベントループへ戻すので、UI を更新できる
  */
 /**
@@ -102,7 +104,7 @@ export { expandPrintMediaCss } from "./renderer.js";
  * @typedef {Element|string} ConvertInput
  */
 /** ライブラリのバージョン（package.json と同期） */
-export const version: "0.3.0";
+export const version: "0.4.0";
 /**
  * 登録するフォントの定義。
  * `src` は TrueType アウトライン（glyf）を持つ静的 TTF のみ対応。
@@ -214,6 +216,14 @@ export type ConvertOptions = {
      */
     baseUrl?: string | undefined;
     onWarning?: ((warning: ConversionWarning) => void) | undefined;
+    /**
+     * `<a href>` を PDF のリンク注釈にする
+     */
+    links?: boolean | undefined;
+    /**
+     * 見出し（h1〜h6）からしおり（PDF の目次）を作る
+     */
+    outline?: boolean | undefined;
     /**
      * 進捗通知。長い文書では途中でイベントループへ戻すので、UI を更新できる
      */

package/types/page.d.ts

@@ -20,7 +20,7 @@ export function resolvePage(page?: import("./index.js").PageOptions | undefined)
 /**
  * @param {import('./walker/walk.js').WalkResult} body
  * @param {PageGeometry} geo
- * @param {{compress: boolean, metadata?: import('./index.js').PdfMetadata, header?: PageDecoration|null, footer?: PageDecoration|null, pacer?: import('./pacer.js').Pacer, progress?: (p: import('./index.js').ConversionProgress) => void, warn?: (w: import('./index.js').ConversionWarning) => void}} opts
+ * @param {{compress: boolean, metadata?: import('./index.js').PdfMetadata, header?: PageDecoration|null, footer?: PageDecoration|null, pacer?: import('./pacer.js').Pacer, progress?: (p: import('./index.js').ConversionProgress) => void, warn?: (w: import('./index.js').ConversionWarning) => void, links?: boolean, outline?: boolean}} opts
  * @returns {Promise<Uint8Array>}
  */
 export function buildPdf(body: import("./walker/walk.js").WalkResult, geo: PageGeometry, opts: {
@@ -31,6 +31,8 @@ export function buildPdf(body: import("./walker/walk.js").WalkResult, geo: PageG
     pacer?: import("./pacer.js").Pacer;
     progress?: (p: import("./index.js").ConversionProgress) => void;
     warn?: (w: import("./index.js").ConversionWarning) => void;
+    links?: boolean;
+    outline?: boolean;
 }): Promise<Uint8Array>;
 export type PageGeometry = {
     /**

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/walker/walk.d.ts

@@ -179,12 +179,34 @@ export type Join = {
     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 = {