@unmade/text-renderer 0.1.4 → 0.1.5

package/dist/ce-adapter/ce-types.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Type declarations for @unmade/configuration-engine
+ *
+ * CE doesn't ship .d.ts files. These types cover the subset of the
+ * factory API and editor shape that the CE adapter needs.
+ */
+export interface EditorPaletteColour {
+    id: number;
+    hex: string;
+    name: string;
+    display_name?: string;
+    reference?: string | null;
+    extra?: object | null;
+    categories?: string[];
+    lab?: [number, number, number];
+}
+export interface EditorPalette {
+    id: number;
+    name: string;
+    slug: string;
+    colours: EditorPaletteColour[];
+    extended_palette_id?: number;
+    extendedPalette?: EditorPalette;
+    categories?: string[];
+}
+export interface EditorGarment {
+    slug: string;
+    size: string;
+    name?: string;
+    panels_svg?: string;
+    embellishment_positions?: EmbellishmentPosition[];
+}
+export interface EmbellishmentPosition {
+    placement: string;
+    width: number;
+    height: number;
+    physical_width: number;
+    physical_height: number;
+    physical_size_units: string;
+    baseline_path?: string;
+    rotation: number;
+    variant?: string;
+}
+export interface TextLibraryItemFont {
+    id: number;
+    font_url: string;
+    font_family: string;
+    letter_spacing?: number;
+    letter_spacing_outline?: number;
+    outline_width?: number;
+    fixed_colours?: Record<string, {
+        reference: string;
+        hex: string;
+        id: string;
+        text: string;
+    }>;
+}
+export interface TextLibraryItem {
+    id: string;
+    type: 'text';
+    fonts: TextLibraryItemFont[];
+    palette?: number;
+}
+export interface PlacementLibraryItem {
+    id: string;
+    type: string;
+    palette?: number;
+}
+export interface BasePlacementSettings {
+    manufacturing_methods?: {
+        name: string;
+    }[];
+    vertical_alignment?: string;
+    horizontal_alignment?: string;
+}
+export interface PlacementsSettings {
+    byId: Record<string, BasePlacementSettings>;
+    library: Record<string, PlacementLibraryItem | TextLibraryItem>;
+}
+export interface CombinedEditorSettings {
+    editor: string;
+    mixins: string[];
+    garments: EditorGarment[];
+    palettes: number[];
+    allPalettes: Record<number, EditorPalette>;
+    endpoints: {
+        palettes: string;
+        [key: string]: string | undefined;
+    };
+    placements?: PlacementsSettings;
+    embellishments?: PlacementsSettings;
+    [key: string]: unknown;
+}
+export interface BasePlacementState {
+    type: string;
+    libraryItemID: string;
+    meta?: Record<string, unknown>;
+}
+export interface EditorStateVals {
+    placements?: Record<string, BasePlacementState>;
+    embellishments?: Record<string, BasePlacementState>;
+    [key: string]: unknown;
+}
+export interface EditorState {
+    garment?: string;
+    vals?: EditorStateVals;
+    [key: string]: unknown;
+}
+export interface Palettes {
+    byId: Record<string, unknown>;
+    getColours(paletteId: number): EditorPaletteColour[];
+    getUsedColours(paletteId: number, ids: (number | null)[]): (EditorPaletteColour | null)[];
+    getExtendedColours(paletteId: number): EditorPaletteColour[];
+}
+export interface PlacementPositionResult {
+    placement: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    dimensionsForCanvas: {
+        width: number;
+        height: number;
+        x: number;
+        y: number;
+    };
+    variant: string;
+    panel: string;
+    rotation: boolean;
+    physical_width: number;
+    physical_height: number;
+    physical_width_decimal: string;
+    physical_height_decimal: string;
+    physical_size_units: string;
+}
+export interface EditorVariant {
+    name: string;
+    placements: string[];
+}
+/**
+ * Editor instance returned by CE's factory.
+ *
+ * The exact shape depends on which mixins are applied at runtime.
+ * We type the parts the CE adapter needs and treat the rest as opaque.
+ * Uses Element rather than SVGElement for cross-environment compatibility.
+ */
+export interface ConfigEditor {
+    getState(): EditorState & {
+        vals: NonNullable<EditorState['vals']>;
+    };
+    palettes: Palettes;
+    settings: CombinedEditorSettings;
+    placements?: {
+        initialise(): Promise<void>;
+        getAssetsAsSVGElements(state: EditorState, manufacturingMethod: string): Promise<Record<string, {
+            asset: Element;
+            position: PlacementPositionResult;
+        }>>;
+    };
+    embellishments?: {
+        initialise(): Promise<void>;
+        getAssetsAsSVGElements(state: EditorState, manufacturingMethod: string): Promise<Record<string, {
+            asset: Element;
+            position: PlacementPositionResult;
+        }>>;
+    };
+    getVariants?(): EditorVariant[];
+    getCurrentVariant?(): string;
+}

package/dist/ce-adapter/extractTextPlacements.d.ts

@@ -0,0 +1,11 @@
+import { ConfigEditor } from './ce-types';
+import { LoadedTextPlacement } from './types';
+/**
+ * Extract text placements from a loaded config editor instance.
+ *
+ * Reads the editor state, resolves fonts and colours from settings and
+ * palettes, and returns a structured array of text placements ready for
+ * rendering or comparison. Processes both the placements and embellishments
+ * buckets.
+ */
+export declare function extractTextPlacements(editor: ConfigEditor): LoadedTextPlacement[];

package/dist/ce-adapter/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function z(t){return t.type==="text"}function C(t){const i=t.getState().garment;return t.settings.garments.find(o=>o.slug===i)}function P(t,n){if(t.embellishment_positions)return t.embellishment_positions.find(i=>i.placement===n)}function w(t,n){const i=t.fonts.find(o=>o.id===n);if(i)return{id:i.id,fontUrl:i.font_url,fontFamily:i.font_family,letterSpacing:i.letter_spacing??0,letterSpacingOutline:i.letter_spacing_outline??0,outlineWidth:i.outline_width??0,fixedColours:i.fixed_colours}}function v(t,n,i,o,r){const{library:u}=r,c=[];for(const[s,h]of Object.entries(o)){if(h.type!=="text")continue;const f=h,{meta:e}=f;if(!e?.text)continue;const{libraryItemID:d}=f,g=u[d];if(!g||!z(g))continue;const y=e.font;if(y===void 0)continue;const m=w(g,y);if(!m)continue;const a=P(n,s);if(!a)continue;let x=null,S=null;if(e.colours&&g.palette!=null)try{const l=t.palettes.getUsedColours(g.palette,e.colours);x=l[0]??null,S=l[1]??null}catch(l){console.warn(`[extractTextPlacements] Colour resolution failed for ${s}:`,l)}const b=r.byId?.[s],p={vertical:"top",horizontal:"left"};if(b){const l=b;l.vertical_alignment&&(p.vertical=l.vertical_alignment),l.horizontal_alignment&&(p.horizontal=l.horizontal_alignment)}c.push({placementId:s,displayName:s,source:i,text:e.text,font:m,isCurved:e.isCurved??!1,isDistributed:e.isDistributed??!1,verticalAlignment:e.verticalAlignment??p.vertical,horizontalAlignment:e.horizontalAlignment??p.horizontal,rotation:e.rotation??0,spacing:e.spacing??null,fillColour:x,outlineColour:S,position:{width:a.width,height:a.height,physicalWidth:a.physical_width,physicalHeight:a.physical_height,physicalUnits:a.physical_size_units,baselinePath:a.baseline_path,rotation:a.rotation},userSetPhysicalSize:e.retainedPhysicalSize??null,fontMetrics:e.fontMetrics??{size:0,height:0,baseline:0,width:0},manufacturingMethod:e.manufacturing_method??""})}return c}function A(t){const n=t.getState(),i=C(t);if(!i)return console.warn("[extractTextPlacements] No matching garment found"),[];const o=[],r=n.vals?.placements,u=t.settings.placements;r&&u&&o.push(...v(t,i,"placements",r,u));const c=n.vals?.embellishments,s=t.settings.embellishments;return c&&s&&o.push(...v(t,i,"embellishments",c,s)),o.length===0&&console.warn("[extractTextPlacements] No text entries found in either placements or embellishments"),o}function _(t){return t==="center"?"centre":t}function O(t){let n=_(t.horizontalAlignment);t.isDistributed&&(n="distributed");let i;t.position.baselinePath?i={type:"custom",path:t.position.baselinePath}:t.isCurved?i="curved":i="flat";const o=t.userSetPhysicalSize?[t.userSetPhysicalSize[0],t.userSetPhysicalSize[1]]:t.fontMetrics.physicalFontSize!=null?t.fontMetrics.physicalFontSize:[t.position.physicalHeight,t.position.physicalUnits],r=t.outlineColour!=null,u=t.spacing?{outlineWidth:r?t.font.outlineWidth:0,letterSpacing:t.spacing.letter_spacing,letterSpacingOutline:t.spacing.letter_spacing_outline}:{outlineWidth:r?t.font.outlineWidth:0,letterSpacing:t.font.letterSpacing,letterSpacingOutline:t.font.letterSpacingOutline},c=t.fillColour?{hex:t.fillColour.hex,reference:t.fillColour.reference??void 0}:void 0,s=t.outlineColour?{hex:t.outlineColour.hex,reference:t.outlineColour.reference??void 0}:void 0;let h;if(t.font.fixedColours){const f={};for(const[e,d]of Object.entries(t.font.fixedColours))f[e]={hex:d.hex,reference:d.reference};h=f}return{text:t.text,fontUrl:t.font.fontUrl,physicalSize:o,boxDimensions:{width:t.position.width,height:t.position.height,physicalWidth:t.position.physicalWidth,physicalHeight:t.position.physicalHeight,physicalUnits:t.position.physicalUnits},spacing:u,verticalAlignment:_(t.verticalAlignment),horizontalAlignment:n,baseline:i,fillColour:c,strokeColour:s,colourMap:h}}exports.extractTextPlacements=A;exports.mapStateToRendererOptions=O;

package/dist/ce-adapter/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * CE Adapter for @unmade/text-renderer
+ *
+ * Utilities for extracting text placement state from a loaded
+ * @unmade/configuration-engine editor instance and mapping it to
+ * renderer options. Intended for use in server-side comparison pipelines
+ * and any environment that bridges CE state to the text-renderer.
+ */
+export { extractTextPlacements } from './extractTextPlacements';
+export { mapStateToRendererOptions } from './mapStateToRendererOptions';
+export type { BasePlacementSettings, BasePlacementState, CombinedEditorSettings, ConfigEditor, EditorGarment, EditorPalette, EditorPaletteColour, EditorState, EditorStateVals, EditorVariant, EmbellishmentPosition, Palettes, PlacementLibraryItem, PlacementPositionResult, PlacementsSettings, TextLibraryItem, TextLibraryItemFont, } from './ce-types';
+export type { LoadedTextPlacement, TextPlacementFont, TextPlacementPosition, TextPlacementSpacing, } from './types';

package/dist/ce-adapter/index.js

@@ -0,0 +1,157 @@
+function z(t) {
+  return t.type === "text";
+}
+function C(t) {
+  const i = t.getState().garment;
+  return t.settings.garments.find((o) => o.slug === i);
+}
+function P(t, n) {
+  if (t.embellishment_positions)
+    return t.embellishment_positions.find(
+      (i) => i.placement === n
+    );
+}
+function w(t, n) {
+  const i = t.fonts.find((o) => o.id === n);
+  if (i)
+    return {
+      id: i.id,
+      fontUrl: i.font_url,
+      fontFamily: i.font_family,
+      letterSpacing: i.letter_spacing ?? 0,
+      letterSpacingOutline: i.letter_spacing_outline ?? 0,
+      outlineWidth: i.outline_width ?? 0,
+      fixedColours: i.fixed_colours
+    };
+}
+function v(t, n, i, o, r) {
+  const { library: u } = r, c = [];
+  for (const [s, h] of Object.entries(o)) {
+    if (h.type !== "text") continue;
+    const f = h, { meta: e } = f;
+    if (!e?.text) continue;
+    const { libraryItemID: d } = f, g = u[d];
+    if (!g || !z(g)) continue;
+    const y = e.font;
+    if (y === void 0) continue;
+    const m = w(g, y);
+    if (!m) continue;
+    const a = P(n, s);
+    if (!a) continue;
+    let x = null, S = null;
+    if (e.colours && g.palette != null)
+      try {
+        const l = t.palettes.getUsedColours(
+          g.palette,
+          e.colours
+        );
+        x = l[0] ?? null, S = l[1] ?? null;
+      } catch (l) {
+        console.warn(`[extractTextPlacements] Colour resolution failed for ${s}:`, l);
+      }
+    const b = r.byId?.[s], p = {
+      vertical: "top",
+      horizontal: "left"
+    };
+    if (b) {
+      const l = b;
+      l.vertical_alignment && (p.vertical = l.vertical_alignment), l.horizontal_alignment && (p.horizontal = l.horizontal_alignment);
+    }
+    c.push({
+      placementId: s,
+      displayName: s,
+      source: i,
+      text: e.text,
+      font: m,
+      isCurved: e.isCurved ?? !1,
+      isDistributed: e.isDistributed ?? !1,
+      verticalAlignment: e.verticalAlignment ?? p.vertical,
+      horizontalAlignment: e.horizontalAlignment ?? p.horizontal,
+      rotation: e.rotation ?? 0,
+      spacing: e.spacing ?? null,
+      fillColour: x,
+      outlineColour: S,
+      position: {
+        width: a.width,
+        height: a.height,
+        physicalWidth: a.physical_width,
+        physicalHeight: a.physical_height,
+        physicalUnits: a.physical_size_units,
+        baselinePath: a.baseline_path,
+        rotation: a.rotation
+      },
+      userSetPhysicalSize: e.retainedPhysicalSize ?? null,
+      fontMetrics: e.fontMetrics ?? { size: 0, height: 0, baseline: 0, width: 0 },
+      manufacturingMethod: e.manufacturing_method ?? ""
+    });
+  }
+  return c;
+}
+function A(t) {
+  const n = t.getState(), i = C(t);
+  if (!i)
+    return console.warn("[extractTextPlacements] No matching garment found"), [];
+  const o = [], r = n.vals?.placements, u = t.settings.placements;
+  r && u && o.push(...v(t, i, "placements", r, u));
+  const c = n.vals?.embellishments, s = t.settings.embellishments;
+  return c && s && o.push(...v(t, i, "embellishments", c, s)), o.length === 0 && console.warn("[extractTextPlacements] No text entries found in either placements or embellishments"), o;
+}
+function _(t) {
+  return t === "center" ? "centre" : t;
+}
+function O(t) {
+  let n = _(t.horizontalAlignment);
+  t.isDistributed && (n = "distributed");
+  let i;
+  t.position.baselinePath ? i = { type: "custom", path: t.position.baselinePath } : t.isCurved ? i = "curved" : i = "flat";
+  const o = t.userSetPhysicalSize ? [
+    t.userSetPhysicalSize[0],
+    t.userSetPhysicalSize[1]
+  ] : t.fontMetrics.physicalFontSize != null ? t.fontMetrics.physicalFontSize : [t.position.physicalHeight, t.position.physicalUnits], r = t.outlineColour != null, u = t.spacing ? {
+    outlineWidth: r ? t.font.outlineWidth : 0,
+    letterSpacing: t.spacing.letter_spacing,
+    letterSpacingOutline: t.spacing.letter_spacing_outline
+  } : {
+    outlineWidth: r ? t.font.outlineWidth : 0,
+    letterSpacing: t.font.letterSpacing,
+    letterSpacingOutline: t.font.letterSpacingOutline
+  }, c = t.fillColour ? {
+    hex: t.fillColour.hex,
+    reference: t.fillColour.reference ?? void 0
+  } : void 0, s = t.outlineColour ? {
+    hex: t.outlineColour.hex,
+    reference: t.outlineColour.reference ?? void 0
+  } : void 0;
+  let h;
+  if (t.font.fixedColours) {
+    const f = {};
+    for (const [e, d] of Object.entries(t.font.fixedColours))
+      f[e] = { hex: d.hex, reference: d.reference };
+    h = f;
+  }
+  return {
+    text: t.text,
+    fontUrl: t.font.fontUrl,
+    physicalSize: o,
+    boxDimensions: {
+      width: t.position.width,
+      height: t.position.height,
+      physicalWidth: t.position.physicalWidth,
+      physicalHeight: t.position.physicalHeight,
+      physicalUnits: t.position.physicalUnits
+    },
+    spacing: u,
+    verticalAlignment: _(
+      t.verticalAlignment
+    ),
+    horizontalAlignment: n,
+    baseline: i,
+    fillColour: c,
+    strokeColour: s,
+    colourMap: h
+  };
+}
+export {
+  A as extractTextPlacements,
+  O as mapStateToRendererOptions
+};

package/dist/ce-adapter/mapStateToRendererOptions.d.ts

@@ -0,0 +1,13 @@
+import { GetRenderedTextOptions } from '../types';
+import { LoadedTextPlacement } from './types';
+/**
+ * Map a LoadedTextPlacement to GetRenderedTextOptions for the text-renderer.
+ *
+ * Handles the key differences between config-engine and text-renderer:
+ * - American to British English ('center' -> 'centre')
+ * - isDistributed flag -> horizontalAlignment: 'distributed'
+ * - isCurved flag -> baseline: 'curved'
+ * - baselinePath -> baseline: { type: 'custom', path }
+ * - snake_case spacing -> camelCase spacing
+ */
+export declare function mapStateToRendererOptions(placement: LoadedTextPlacement): GetRenderedTextOptions;

package/dist/ce-adapter/types.d.ts

@@ -0,0 +1,56 @@
+import { EditorPaletteColour } from './ce-types';
+export interface TextPlacementPosition {
+    width: number;
+    height: number;
+    physicalWidth: number;
+    physicalHeight: number;
+    physicalUnits: string;
+    baselinePath?: string;
+    rotation: number;
+}
+export interface TextPlacementFont {
+    id: number;
+    fontUrl: string;
+    fontFamily: string;
+    letterSpacing: number;
+    letterSpacingOutline: number;
+    outlineWidth: number;
+    fixedColours?: Record<string, {
+        reference: string;
+        hex: string;
+        id: string;
+        text: string;
+    }>;
+}
+export interface TextPlacementSpacing {
+    letter_spacing: number;
+    letter_spacing_outline: number;
+    line_height?: number;
+}
+export interface LoadedTextPlacement {
+    placementId: string;
+    displayName: string;
+    source: 'placements' | 'embellishments';
+    text: string;
+    font: TextPlacementFont;
+    isCurved: boolean;
+    isDistributed: boolean;
+    verticalAlignment: string;
+    horizontalAlignment: string;
+    rotation: number;
+    spacing: TextPlacementSpacing | null;
+    fillColour: EditorPaletteColour | null;
+    outlineColour: EditorPaletteColour | null;
+    position: TextPlacementPosition;
+    userSetPhysicalSize: [number, string] | null;
+    fontMetrics: {
+        size: number;
+        height: number;
+        baseline: number;
+        width: number;
+        physicalHeight?: number;
+        physicalUnits?: string;
+        physicalFontSize?: [number, 'mm' | 'in'];
+    };
+    manufacturingMethod: string;
+}