@kensio/colophon 2.2.0 → 2.4.0

package/dist/text/fit.js

@@ -0,0 +1,29 @@
+import { wrapText } from "./wrap.js";
+/** How much of the size is given up each time the text does not fit. */
+const shrinkStep = 0.94;
+/**
+ * Wrap text into the space it has, shrinking it until it fits.
+ *
+ * The alternative, and what Colophon did before it could measure anything, is
+ * to wrap at one size and drop whatever is left over. That reads as a mistake
+ * rather than a design: a long title loses its last few words, and the image
+ * says something the post does not. Shrinking keeps the words.
+ *
+ * It only shrinks so far, because a title small enough to fit anything is a
+ * title nobody reads in a feed. Text that still does not fit at the floor is
+ * cut to `maxLines` as before.
+ */
+export function fitText(text, measure, options) {
+    const { maxWidth, maxLines, minFontSize } = options;
+    let fontSize = options.fontSize;
+    let lines = wrapText(text, maxWidth, (line) => measure(line, fontSize));
+    while (lines.length > maxLines && fontSize > minFontSize) {
+        // Both terms are here to guarantee progress: the proportional step is what
+        // makes the search short, and the whole pixel is what stops it stalling
+        // once the sizes are small enough for rounding to swallow the step.
+        fontSize = Math.max(minFontSize, Math.min(fontSize - 1, Math.floor(fontSize * shrinkStep)));
+        lines = wrapText(text, maxWidth, (line) => measure(line, fontSize));
+    }
+    return { lines: lines.slice(0, maxLines), fontSize };
+}
+//# sourceMappingURL=fit.js.map

package/dist/text/fit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fit.js","sourceRoot":"","sources":["../../src/text/fit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAqBrC,wEAAwE;AACxE,MAAM,UAAU,GAAG,IAAI,CAAC;AAExB;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CACrB,IAAY,EACZ,OAAkB,EAClB,OAAmB;IAEnB,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IACpD,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAChC,IAAI,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAExE,OAAO,KAAK,CAAC,MAAM,GAAG,QAAQ,IAAI,QAAQ,GAAG,WAAW,EAAE,CAAC;QACzD,2EAA2E;QAC3E,wEAAwE;QACxE,oEAAoE;QACpE,QAAQ,GAAG,IAAI,CAAC,GAAG,CACjB,WAAW,EACX,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,CAC1D,CAAC;QACF,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;AACvD,CAAC"}

package/dist/text/index.d.ts

@@ -0,0 +1,9 @@
+export { escapeXml } from "./escape.js";
+export { textElement } from "./element.js";
+export type { TextAttributes } from "./element.js";
+export { breakWord } from "./break.js";
+export { fitText } from "./fit.js";
+export type { FitOptions, FittedText, MeasureAt } from "./fit.js";
+export { wrapText } from "./wrap.js";
+export type { MeasureLine } from "./wrap.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/text/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/text/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC"}

package/dist/text/index.js

@@ -0,0 +1,6 @@
+export { escapeXml } from "./escape.js";
+export { textElement } from "./element.js";
+export { breakWord } from "./break.js";
+export { fitText } from "./fit.js";
+export { wrapText } from "./wrap.js";
+//# sourceMappingURL=index.js.map

package/dist/text/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/text/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC"}

package/dist/text/stack.d.ts

@@ -0,0 +1,24 @@
+/**
+ * A single line to place in a vertical stack.
+ */
+export interface StackLine {
+    readonly fontSize: number;
+    /** Multiplier applied to `fontSize` for this line's total advance. */
+    readonly lineHeight?: number;
+    /** Extra space, in pixels, inserted before this line. Defaults to `0`. */
+    readonly gapBefore?: number;
+}
+/**
+ * A stack line with its computed text baseline `y` coordinate.
+ */
+export interface PlacedLine {
+    readonly y: number;
+    readonly index: number;
+}
+/**
+ * Vertically centre a stack of lines within `[top, bottom]` and return the
+ * text baseline for each. The block is centred as a whole; if it is taller
+ * than the available area it simply starts at `top`.
+ */
+export declare function layoutStack(lines: readonly StackLine[], top: number, bottom: number): PlacedLine[];
+//# sourceMappingURL=stack.d.ts.map

package/dist/text/stack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack.d.ts","sourceRoot":"","sources":["../../src/text/stack.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,sEAAsE;IACtE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,SAAS,SAAS,EAAE,EAC3B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,GACb,UAAU,EAAE,CAed"}

package/dist/text/stack.js

@@ -0,0 +1,18 @@
+/**
+ * Vertically centre a stack of lines within `[top, bottom]` and return the
+ * text baseline for each. The block is centred as a whole; if it is taller
+ * than the available area it simply starts at `top`.
+ */
+export function layoutStack(lines, top, bottom) {
+    const advances = lines.map((line) => (line.gapBefore ?? 0) + line.fontSize * (line.lineHeight ?? 1.2));
+    const total = advances.reduce((sum, advance) => sum + advance, 0);
+    let cursor = top + Math.max(0, (bottom - top - total) / 2);
+    return lines.map((line, index) => {
+        // Approximate the ascent as 80% of the font size to sit the baseline
+        // sensibly within each line's advance box, after any leading gap.
+        const baseline = cursor + (line.gapBefore ?? 0) + line.fontSize * 0.8;
+        cursor += advances[index] ?? 0;
+        return { y: Math.round(baseline), index };
+    });
+}
+//# sourceMappingURL=stack.js.map

package/dist/text/stack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stack.js","sourceRoot":"","sources":["../../src/text/stack.ts"],"names":[],"mappings":"AAmBA;;;;GAIG;AACH,MAAM,UAAU,WAAW,CACzB,KAA2B,EAC3B,GAAW,EACX,MAAc;IAEd,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CACxB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC,CAC3E,CAAC;IACF,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC;IAElE,IAAI,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAE3D,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC/B,qEAAqE;QACrE,kEAAkE;QAClE,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QACtE,MAAM,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/text/wrap.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The width a run of text will be drawn at, in the same units as the space it
+ * has to fit. Bound to a font and a size by whoever is doing the wrapping.
+ */
+export type MeasureLine = (text: string) => number;
+/**
+ * Greedy word-wrap to a width rather than to a character count.
+ *
+ * Wrapping by characters means assuming every glyph is the same fraction of
+ * the font size, which is wrong by a little for Latin text and wrong by half
+ * for anything wider. Measuring the words is what puts the break where it
+ * belongs.
+ *
+ * A single word too wide for the line is broken, since the alternative is a
+ * line that runs off the image. Text written without spaces, which is most of
+ * how Japanese and Chinese are set, is one long word by this reckoning and so
+ * breaks at whatever character reaches the edge. That is a plain wrap rather
+ * than a correct one: it does not know that a line should not begin with
+ * closing punctuation.
+ */
+export declare function wrapText(text: string, maxWidth: number, measure: MeasureLine): string[];
+//# sourceMappingURL=wrap.d.ts.map

package/dist/text/wrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrap.d.ts","sourceRoot":"","sources":["../../src/text/wrap.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;AAEnD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,WAAW,GACnB,MAAM,EAAE,CA6BV"}

package/dist/text/wrap.js

@@ -0,0 +1,41 @@
+import { breakWord } from "./break.js";
+/**
+ * Greedy word-wrap to a width rather than to a character count.
+ *
+ * Wrapping by characters means assuming every glyph is the same fraction of
+ * the font size, which is wrong by a little for Latin text and wrong by half
+ * for anything wider. Measuring the words is what puts the break where it
+ * belongs.
+ *
+ * A single word too wide for the line is broken, since the alternative is a
+ * line that runs off the image. Text written without spaces, which is most of
+ * how Japanese and Chinese are set, is one long word by this reckoning and so
+ * breaks at whatever character reaches the edge. That is a plain wrap rather
+ * than a correct one: it does not know that a line should not begin with
+ * closing punctuation.
+ */
+export function wrapText(text, maxWidth, measure) {
+    const words = text.split(/\s+/).filter((word) => word !== "");
+    const lines = [];
+    let currentLine = "";
+    for (const word of words) {
+        const nextLine = currentLine === "" ? word : `${currentLine} ${word}`;
+        if (measure(nextLine) <= maxWidth) {
+            currentLine = nextLine;
+            continue;
+        }
+        if (currentLine !== "") {
+            lines.push(currentLine);
+        }
+        // The word starts a line of its own, and is only broken up if it cannot
+        // fit on one even there.
+        const pieces = breakWord(word, maxWidth, measure);
+        lines.push(...pieces.slice(0, -1));
+        currentLine = pieces.at(-1) ?? "";
+    }
+    if (currentLine !== "") {
+        lines.push(currentLine);
+    }
+    return lines;
+}
+//# sourceMappingURL=wrap.js.map

package/dist/text/wrap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrap.js","sourceRoot":"","sources":["../../src/text/wrap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAQvC;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CACtB,IAAY,EACZ,QAAgB,EAChB,OAAoB;IAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,WAAW,GAAG,EAAE,CAAC;IAErB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC;QAEtE,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,EAAE,CAAC;YAClC,WAAW,GAAG,QAAQ,CAAC;YACvB,SAAS;QACX,CAAC;QAED,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC1B,CAAC;QAED,wEAAwE;QACxE,yBAAyB;QACzB,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}