markdown-design-doc-viewer-embed 1.5.3 → 1.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-design-doc-viewer-embed",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "The viewer of Markdown Design Doc Viewer to embed in a web app (React or not): design documents in Markdown with their mermaid sequence diagrams, flowcharts, ER and state diagrams and wireframes linked to the steps after them.",
   "license": "MIT",
   "repository": {
@@ -36,6 +36,10 @@
       "types": "./types/embed/react.d.ts",
       "default": "./react.js"
     },
+    "./export": {
+      "types": "./types/embed/export.d.ts",
+      "default": "./export.js"
+    },
     "./viewer.css": "./viewer.css",
     "./package.json": "./package.json"
   },

package/types/embed/export.d.ts

@@ -0,0 +1,4 @@
+import { type ExportOptions } from './viewer.js';
+export type { DiagramLook, ExportOptions } from './viewer.js';
+/** The HTML file of the design document of `options`, as a string. */
+export declare function exportHtml(options: ExportOptions): Promise<string>;

package/types/embed/viewer.d.ts

@@ -1,4 +1,4 @@
-import type { DiagramLook } from '../src/shared/protocol.js';
+import { type DiagramLook } from '../src/shared/protocol.js';
 export type { DiagramLook };
 export interface ViewerOptions {
     /** The Markdown of the design document. */
@@ -42,7 +42,7 @@ export interface ViewerOptions {
     headingNumbers?: boolean;
     /**
      * Breaks the labels of the arrows of the sequence diagrams into lines at this many characters (a full-width one
-     * counts as 2). 0 does not break them. 30 by default.
+     * counts as 2). 0 does not break them. 40 by default.
      */
     messageWrapWidth?: number;
     /**
@@ -69,3 +69,17 @@ export interface Viewer {
 export declare function openLinkInNewTab(href: string): void;
 /** Shows the design document of `options` in `container`, which it fills. */
 export declare function createViewer(container: HTMLElement, options: ViewerOptions): Viewer;
+/** The options of `exportHtml` (`markdown-design-doc-viewer-embed/export`). */
+export interface ExportOptions extends Pick<ViewerOptions, 'markdown' | 'baseUrl' | 'readFile' | 'diagramLook' | 'splitMinWidth' | 'toc' | 'limitContentWidth' | 'stickyTableHeader' | 'tableTreeHighlight' | 'frontMatter' | 'headingNumbers' | 'messageWrapWidth'> {
+    /** The language of the texts of the exported file: `en`, or `ja`. That of the browser by default. */
+    lang?: 'en' | 'ja';
+    /** The title of the page when the document has none (neither `title` in its front matter nor a `#` heading). */
+    title?: string;
+    /**
+     * What an image of the document (a path, not a URL) becomes in the exported file: a data URI to embed it, or a URL to
+     * link it. It is given the `src` of the image without its query and fragment (`icons.svg` of `icons.svg#save`), which
+     * are added back to a URL. By default, resolved from `baseUrl` (or left as it is without it). When it fails, the
+     * `src` is kept.
+     */
+    resolveImage?: (path: string) => string | Promise<string>;
+}