postext 1.36.0 → 1.37.0

package/dist/migrate/textToMarkdown.d.ts

@@ -0,0 +1,124 @@
+/**
+ * «Move the text to the Markdown» (#874): rescue a book that keeps its
+ * content in heading styles — the pattern of the 1.33 ports, a hidden
+ * heading style per page whose running head holds dozens of text elements
+ * placed on the page — by turning each page design into a page template
+ * whose frames take the text elements' boxes, and each page of the chapter
+ * into a `::::page{template}` fence whose `:::frame{slot}` blocks hold the
+ * text. The design's boxes and pictures become the template's decoration;
+ * the text's face, size and colour a paragraph style (one the book has when
+ * it matches); highlight boxes under bold words become chips. Similar pages
+ * share a template and extend it.
+ *
+ * Pure: a configuration and the chapters' Markdown in, the new ones and a
+ * report out. The Sandbox runs it from its migration dialog; the CLI and the
+ * agent skill can call it as it is.
+ */
+import type { DocumentMetadata, PostextConfig } from '../types';
+import type { PageSide } from '../composed/types';
+export interface TextMigrationChapter {
+    id: string;
+    markdown: string;
+}
+export interface TextMigrationInput {
+    config: PostextConfig;
+    chapters: readonly TextMigrationChapter[];
+    /** The book's metadata: its title, author… are allowed in a design, as
+     *  the `contentInConfig` check allows them, and stay there. */
+    metadata?: DocumentMetadata;
+}
+export interface TextMigrationOptions {
+    /** Join text elements of one look set under one another at an even
+     *  spacing into one frame. Default `true`. */
+    merge?: boolean;
+    /** Pages whose frames stand in the same places share a template that
+     *  their own ones extend. Default `true`. */
+    shareTemplates?: boolean;
+    /** A filled box under the bold words of a moved text becomes a chip of
+     *  the book's chip style of that colour (else a new one). Default `true`. */
+    highlightsToChips?: boolean;
+    /** Heading styles that hold content and that no heading uses: `'keep'`
+     *  (default) leaves them, `'remove'` deletes them. */
+    unusedStyles?: 'keep' | 'remove';
+    /** The side of the page a run's page falls on, when the caller laid the
+     *  book out: the chapter and the offset of the page's first line in its
+     *  Markdown as it was. Without it the side comes from the opening
+     *  heading's `breakBefore.parity`, when it has one. */
+    sideOf?: (chapterId: string, offset: number) => PageSide | undefined;
+}
+export interface ContentInConfigCount {
+    /** `contentInConfig` warnings (one per owner). */
+    warnings: number;
+    /** Design texts at fault. */
+    elements: number;
+    /** Their letters and digits. */
+    chars: number;
+}
+/** One `::::page` fence the migration wrote. */
+export interface MigratedPage {
+    chapterId: string;
+    /** 0-based index among the chapter's fences. */
+    fence: number;
+    template: string;
+    /** The heading styles of the headings on the page, as they were. */
+    styles: string[];
+    side?: PageSide;
+    frames: number;
+    elements: number;
+    chars: number;
+    /** Where the page may look different, by code: `box`, `stroke`, `dropCap`,
+     *  `paragraphIndent`, `height` (the text's own box), `side` (the side of
+     *  the page is not known: the text of both sides' frames was written),
+     *  `flow` (the page has running text, now set in the template's flow
+     *  frame), `repeated` (a text the running head printed on each page of a
+     *  section is written on each page). */
+    differences: string[];
+}
+export interface TextMigrationReport {
+    pages: MigratedPage[];
+    templates: {
+        id: string;
+        extends?: string;
+        frames: number;
+        pages: number;
+    }[];
+    /** Text elements moved, and their letters and digits. */
+    movedElements: number;
+    movedChars: number;
+    /** Highlight boxes that became chips. */
+    chips: number;
+    frames: number;
+    paragraphStylesCreated: string[];
+    paragraphStylesReused: string[];
+    chipStylesCreated: string[];
+    /** Heading styles merged into one once their running heads moved out
+     *  (`into` keeps; `from` are gone), and those deleted unused. */
+    headingStylesMerged: {
+        into: string;
+        from: string[];
+    }[];
+    headingStylesRemoved: string[];
+    /** Heading styles holding content that no heading uses (kept). */
+    unusedStyles: string[];
+    /** Hidden headings that only switched the running head, dropped. */
+    headingsDropped: number;
+    /** Text left in the configuration, and why. */
+    left: {
+        path: string;
+        reason: 'placeholder' | 'anchor' | 'unused' | 'notPage';
+    }[];
+    configBytesBefore: number;
+    configBytesAfter: number;
+    contentInConfigBefore: ContentInConfigCount;
+    contentInConfigAfter: ContentInConfigCount;
+}
+export interface TextMigrationResult {
+    config: PostextConfig;
+    chapters: TextMigrationChapter[];
+    report: TextMigrationReport;
+    /** Nothing to move: the result is the input. */
+    unchanged: boolean;
+}
+/** Run the migration. */
+export declare function moveTextToMarkdown(input: TextMigrationInput, options?: TextMigrationOptions): TextMigrationResult;
+//# sourceMappingURL=textToMarkdown.d.ts.map

package/dist/migrate/textToMarkdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textToMarkdown.d.ts","sourceRoot":"","sources":["../../src/migrate/textToMarkdown.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAIV,gBAAgB,EAGhB,aAAa,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAe,QAAQ,EAAmC,MAAM,mBAAmB,CAAC;AAOhG,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAC;IAC1C;mEAC+D;IAC/D,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,MAAM,WAAW,oBAAoB;IACnC;kDAC8C;IAC9C,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;iDAC6C;IAC7C,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;iFAC6E;IAC7E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;0DACsD;IACtD,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IACjC;;;2DAGuD;IACvD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,QAAQ,GAAG,SAAS,CAAC;CACtE;AAED,MAAM,WAAW,oBAAoB;IACnC,kDAAkD;IAClD,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gDAAgD;AAChD,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,oEAAoE;IACpE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd;;;;;4CAKwC;IACxC,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,YAAY,EAAE,CAAC;IACtB,SAAS,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC7E,yDAAyD;IACzD,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB,EAAE,MAAM,EAAE,CAAC;IACjC,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B;qEACiE;IACjE,mBAAmB,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IACxD,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,kEAAkE;IAClE,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,oEAAoE;IACpE,eAAe,EAAE,MAAM,CAAC;IACxB,+CAA+C;IAC/C,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,aAAa,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAA;KAAE,EAAE,CAAC;IAClF,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,qBAAqB,EAAE,oBAAoB,CAAC;IAC5C,oBAAoB,EAAE,oBAAoB,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,gDAAgD;IAChD,SAAS,EAAE,OAAO,CAAC;CACpB;AAuFD,yBAAyB;AACzB,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA6RrH"}