@formfeed/engine 0.3.11 → 0.3.13

package/types/lib/preview.d.cts

@@ -29,6 +29,17 @@ export interface PreviewOptions {
      * `editable`) can be edited in place, and the frame talks to the editor about it by message.
      */
     editing?: boolean;
+    /**
+     * A name the editor gives this document, which the edit session's messages carry back
+     * (`formfeed:document` in the head). The editor has the next document ready a moment before the
+     * frame takes it; with the name it can tell a click that still came from the one before.
+     */
+    document?: string;
+    /**
+     * Run the accessibility audit on the laid-out document (plan 21 §6) and post what it finds:
+     * `{ type: 'formfeed:audit', findings }`. For templates that ask for `pdf.ua`.
+     */
+    audit?: boolean;
 }
 /** What the preview frame reports about content wider than the page, or `null` when nothing is. */
 export interface PreviewOverflow {

package/types/lib/preview.d.ts

@@ -29,6 +29,17 @@ export interface PreviewOptions {
      * `editable`) can be edited in place, and the frame talks to the editor about it by message.
      */
     editing?: boolean;
+    /**
+     * A name the editor gives this document, which the edit session's messages carry back
+     * (`formfeed:document` in the head). The editor has the next document ready a moment before the
+     * frame takes it; with the name it can tell a click that still came from the one before.
+     */
+    document?: string;
+    /**
+     * Run the accessibility audit on the laid-out document (plan 21 §6) and post what it finds:
+     * `{ type: 'formfeed:audit', findings }`. For templates that ask for `pdf.ua`.
+     */
+    audit?: boolean;
 }
 /** What the preview frame reports about content wider than the page, or `null` when nothing is. */
 export interface PreviewOverflow {

package/types/lib/source-edit.d.cts

@@ -80,6 +80,11 @@ export declare function editableRegionAt(source: string, engine: EngineId, at: n
  * preview was being edited): found by its unique original markup, or null.
  */
 export declare function findRegionAgain(source: string, engine: EngineId, outer: string): EditableRegion | null;
+/** Where a region's start tag is, as `data-ff-src` names it: line and column, both 1-based. */
+export declare function regionPosition(source: string, region: EditableRegion): {
+    line: number;
+    column: number;
+};
 /** The chips of a region in order, with what they stand for. */
 export declare function regionChips(source: string, region: EditableRegion): RegionChip[];
 /** What the preview shows while editing: decoded text (whitespace as written), chips and breaks. */

package/types/lib/source-edit.d.ts

@@ -80,6 +80,11 @@ export declare function editableRegionAt(source: string, engine: EngineId, at: n
  * preview was being edited): found by its unique original markup, or null.
  */
 export declare function findRegionAgain(source: string, engine: EngineId, outer: string): EditableRegion | null;
+/** Where a region's start tag is, as `data-ff-src` names it: line and column, both 1-based. */
+export declare function regionPosition(source: string, region: EditableRegion): {
+    line: number;
+    column: number;
+};
 /** The chips of a region in order, with what they stand for. */
 export declare function regionChips(source: string, region: EditableRegion): RegionChip[];
 /** What the preview shows while editing: decoded text (whitespace as written), chips and breaks. */