@unmade/text-renderer 1.1.0 → 1.2.0

package/dist/worker/loading/createLoadedFont.d.ts

@@ -0,0 +1,53 @@
+import { Face, Font } from 'harfbuzzjs';
+export interface SVGGlyphData {
+    svg: string;
+    viewbox: string;
+}
+export interface LoadedFont {
+    unitsPerEm: number;
+    names: {
+        fontFamily: string;
+    };
+    svgGlyphs?: Map<number, SVGGlyphData>;
+    charToGlyph(char: string): {
+        index: number;
+        advanceWidth: number;
+        name: string;
+        getBoundingBox(): {
+            x1: number;
+            y1: number;
+            x2: number;
+            y2: number;
+        };
+    };
+    getPath(text: string, x: number, y: number, fontSize: number, options?: {
+        drawSVG?: boolean;
+    }): {
+        getBoundingBox(): {
+            x1: number;
+            y1: number;
+            x2: number;
+            y2: number;
+        };
+        toPathData(decimals?: number): string;
+    };
+    getPaths(text: string, x: number, y: number, fontSize: number, options?: {
+        drawSVG?: boolean;
+    }): Array<{
+        getBoundingBox(): {
+            x1: number;
+            y1: number;
+            x2: number;
+            y2: number;
+        };
+        toPathData(decimals?: number): string;
+    }>;
+}
+export declare function boundsFromPath(pathData: string): {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+} | null;
+export declare function transformPath(pathData: string, scaleX: number, scaleY: number, dx: number): string;
+export declare function createLoadedFont(face: Face, font: Font, familyName: string, svgGlyphs?: Map<number, SVGGlyphData>): LoadedFont;

package/dist/worker/loading/index.d.ts

@@ -0,0 +1,4 @@
+import { createLoadedFont, LoadedFont } from './createLoadedFont';
+export { createLoadedFont, type LoadedFont };
+export declare const getFontCache: () => Map<string, LoadedFont>;
+export declare const loadFont: (fontUrl: string, fetchSVGGlyphs?: boolean) => Promise<LoadedFont>;

package/dist/worker/measuring/conversion.d.ts

@@ -0,0 +1,2 @@
+export declare function millimetersToInches(value: number): number;
+export declare function inchesToMillimeters(value: number): number;

package/dist/worker/measuring/index.d.ts

@@ -0,0 +1,28 @@
+import { LoadedFont } from '../loading';
+import { BoxDimensions, PhysicalSize, TextSpacing } from '../types';
+export interface GetFontSizeFromPhysicalSizeOptions {
+    font: LoadedFont;
+    boxDimensions: BoxDimensions;
+    physicalSize: PhysicalSize;
+    spacing?: TextSpacing;
+}
+export interface GetTextMetricsAtFontSizeOptions {
+    font: LoadedFont;
+    text: string;
+    fontSize: number;
+    spacing?: TextSpacing;
+}
+/**
+ * This is the character we use to calculate font sizes
+ * when fixed physical text height is set for a placement.
+ *
+ * The 'I' character is used because of its flat top and bottom.
+ * https://en.wikipedia.org/wiki/Cap_height
+ */
+export declare const getStandardCharacter: (font: LoadedFont) => string;
+export declare const getFontSizeFromPhysicalSize: ({ font, boxDimensions, physicalSize, spacing, }: GetFontSizeFromPhysicalSizeOptions) => number;
+export declare const getTextMetricsAtFontSize: ({ font, text, fontSize, spacing, }: GetTextMetricsAtFontSizeOptions) => {
+    width: number;
+    height: number;
+    baseline: number;
+};

package/dist/worker/renderText.d.ts

@@ -0,0 +1,5 @@
+import { RenderTextOptions } from './types';
+/**
+ * Synchronous text renderer. Requires a pre-loaded font.
+ */
+export declare const renderText: (options: RenderTextOptions) => string;

package/dist/worker/rendering/index.d.ts

@@ -0,0 +1,42 @@
+import { LoadedFont } from '../loading';
+import { ColourMap, GlyphFill, HorizontalTextAlignmentValues, PlatformMatrix, TextSpacing } from '../types';
+export interface SvgGlyphEntry {
+    content: string;
+    viewBox: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    glyphIndex: number;
+}
+export interface PathEntry {
+    attributes: {
+        d: string;
+        'data-character': string;
+        transform: string;
+    };
+    path: unknown;
+    matrix: PlatformMatrix;
+    glyphData: {
+        index: number;
+        bbox: {
+            x1: number;
+            y1: number;
+            x2: number;
+            y2: number;
+        };
+    };
+    svgGlyph?: SvgGlyphEntry;
+    fills?: GlyphFill[];
+}
+export declare const fontUnitsToPixels: (value: number, fontSize: number, unitsPerEm: number) => number;
+export interface GetTextAsPathDataOptions {
+    font: LoadedFont;
+    baselinePath: string;
+    text: string;
+    fontSize: number;
+    spacing?: TextSpacing;
+    horizontalAlignment?: HorizontalTextAlignmentValues;
+    colourMap?: ColourMap;
+}
+export declare const getTextAsPathData: ({ font, baselinePath, text, fontSize, spacing, horizontalAlignment, colourMap, }: GetTextAsPathDataOptions) => PathEntry[];

package/dist/worker/svg/index.d.ts

@@ -0,0 +1,11 @@
+import { PathEntry } from '../rendering';
+import { BoxDimensions, ColourInfo, TextSpacing } from '../types';
+export interface AssembleSvgOptions {
+    boxDimensions: BoxDimensions;
+    paths: PathEntry[];
+    spacing?: TextSpacing;
+    fontSize?: number;
+    fillColour?: ColourInfo;
+    strokeColour?: ColourInfo;
+}
+export declare const assembleSvg: ({ boxDimensions, paths, spacing, fontSize, fillColour, strokeColour, }: AssembleSvgOptions) => string;

package/dist/worker/types.d.ts

@@ -0,0 +1,75 @@
+import { DOMMatrix } from '@unmade/platform';
+import { LoadedFont } from './loading';
+/** The platform's matrix, which is not the same shape as the DOM's DOMMatrix. */
+export type PlatformMatrix = InstanceType<typeof DOMMatrix>;
+export type MeasurementUnits = 'mm' | 'in';
+export type BoxDimensions = {
+    width: number;
+    height: number;
+    physicalWidth: number;
+    physicalHeight: number;
+    physicalUnits: MeasurementUnits;
+};
+export type VerticalTextAlignmentValues = 'centre' | 'top' | 'bottom';
+export type HorizontalTextAlignmentValues = 'left' | 'centre' | 'right' | 'distributed';
+export type PhysicalSize = [height: number, units: MeasurementUnits];
+export type BaselineType = 'flat' | 'curved';
+export type BaselineConfig = {
+    type: 'flat';
+} | {
+    type: 'curved';
+} | {
+    type: 'custom';
+    path: string;
+};
+export interface ColourInfo {
+    readonly hex: string;
+    readonly reference?: string;
+}
+export interface GlyphFill {
+    readonly pathData: string;
+    readonly colour: ColourInfo;
+}
+/** Maps original hex colour → replacement ColourInfo. */
+export type ColourMap = Readonly<Record<string, ColourInfo>>;
+export interface TextSpacing {
+    readonly outlineWidth: number;
+    readonly letterSpacing: number;
+    readonly letterSpacingOutline: number;
+}
+/** Options for synchronous renderText (font already loaded). */
+export interface RenderTextOptions {
+    text: string;
+    font: LoadedFont;
+    physicalSize: PhysicalSize;
+    /** When provided, bypasses the physicalSize → font size calculation. */
+    fontSize?: number;
+    boxDimensions: BoxDimensions;
+    spacing?: TextSpacing;
+    verticalAlignment?: VerticalTextAlignmentValues;
+    baseline?: BaselineType | BaselineConfig;
+    horizontalAlignment?: HorizontalTextAlignmentValues;
+    fillColour?: ColourInfo;
+    strokeColour?: ColourInfo;
+    colourMap?: ColourMap;
+}
+/** Options for async getRenderedText (loads font from URL). */
+export interface GetRenderedTextOptions {
+    text: string;
+    fontUrl: string;
+    physicalSize: PhysicalSize;
+    /**
+     * Fallback font size (in pixels) to use if the calculated size causes a
+     * TOO_WIDE error. Useful when the caller has an authoritative size (e.g.
+     * from the CE) that avoids floating-point rounding issues.
+     */
+    fontSizeFallback?: number;
+    boxDimensions: BoxDimensions;
+    spacing?: TextSpacing;
+    verticalAlignment?: VerticalTextAlignmentValues;
+    baseline?: BaselineType | BaselineConfig;
+    horizontalAlignment?: HorizontalTextAlignmentValues;
+    fillColour?: ColourInfo;
+    strokeColour?: ColourInfo;
+    colourMap?: ColourMap;
+}

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@unmade/text-renderer",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Pure function text renderer for SVG output",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unmadeworks/config-engine-packages.git",
+    "directory": "packages/text-renderer"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -63,30 +68,33 @@
     "build:ce-adapter": "vite build --config vite.config.ce-adapter.ts",
     "build:types": "cp dist/index.d.ts dist/node/index.d.ts && cp dist/index.d.ts dist/worker/index.d.ts",
     "test": "vitest run",
-    "test:unit": "vitest run --exclude '**/__tests__/regression.test.ts'",
+    "test:unit": "vitest run --exclude '**/__tests__/regression.test.ts' --exclude '**/__tests__/platform/**'",
     "test:regression": "vitest run __tests__/regression.test.ts",
+    "test:platform": "npm run build && vitest run --config vitest.config.platform.ts",
     "test:watch": "vitest",
     "benchmark": "vitest bench __tests__/benchmark.bench.ts",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@unmade/platform": "^0.1.2",
-    "@unmade/svg-helpers": "^0.1.1",
-    "harfbuzzjs": "^1.2.1"
+    "@unmade/platform": "^0.1.5",
+    "@unmade/svg-helpers": "^0.1.3",
+    "harfbuzzjs": "^1.6.0"
   },
   "peerDependencies": {
-    "svg-path-properties": "^1.3.0"
+    "svg-path-properties": "^2.0.2"
   },
   "devDependencies": {
     "@resvg/resvg-js": "^2.6.2",
     "@types/pngjs": "^6.0.5",
+    "@typescript/typescript6": "^6.0.2",
     "pixelmatch": "^7.2.0",
+    "playwright": "^1.62.1",
     "pngjs": "^7.0.0",
-    "svg-path-properties": "^1.3.0",
-    "typescript": "^5.9.3",
-    "vite": "^7.3.1",
-    "vite-plugin-dts": "^4.5.4",
-    "vitest": "^4.1.8"
+    "svg-path-properties": "^2.0.2",
+    "typescript": "^7.0.2",
+    "vite": "^8.2.1",
+    "vite-plugin-dts": "^5.0.3",
+    "vitest": "^4.1.10"
   },
   "keywords": [
     "text",

package/dist/__vite-browser-external-l0sNRNKZ.js

@@ -1 +0,0 @@
-