@pixerate/editor 0.191.0 → 0.193.0

package/dist/text/opentype.d.cts

@@ -2,9 +2,10 @@
  * A small OpenType reader: enough of a font file to set Latin, Cyrillic, Greek and CJK text as
  * outlines without a third-party library. It reads TrueType (`glyf`) and CFF (`CFF `, CID-keyed
  * included) outlines, `cmap` (formats 4 and 12), horizontal metrics, `kern` (format 0) and `GPOS`
- * pair kerning (lookup type 2, formats 1 and 2, the `kern` feature), and the family, PostScript
- * name, weight and style. It does not apply `GSUB` (ligatures, contextual forms) or complex-script
- * shaping, so Arabic, Indic and similar scripts set as isolated glyphs.
+ * pair kerning (lookup type 2, formats 1 and 2, the `kern` feature), vertical metrics (`vhea`,
+ * `vmtx`, `VORG`) and vertical alternates (`GSUB` single substitutions of the `vert` feature), and
+ * the family, PostScript name, weight and style. It applies no other `GSUB` (ligatures, contextual
+ * forms) or complex-script shaping, so Arabic, Indic and similar scripts set as isolated glyphs.
  *
  * The result has the shape of opentype.js's `Font` that `createOutlineTextShaper` takes, so hosts
  * can pass either. Written from the OpenType specification (TrueType glyph outlines, the CFF
@@ -31,6 +32,15 @@ export interface OpenTypeFont extends OutlineFontFace {
     kerning(left: number, right: number): number;
     /** A glyph's outline in font units, y up, origin on the baseline. */
     glyphPath(glyph: number): OutlinePathCommand[];
+    /** Whether the font has vertical metrics (`vhea` and `vmtx`). */
+    readonly hasVerticalMetrics: boolean;
+    /** A glyph's vertical alternate (the `vert` feature), or the glyph itself when it has none. */
+    verticalGlyph(glyph: number): number;
+    getVerticalMetrics(char: string): {
+        advance: number;
+        originY: number;
+        alternate: boolean;
+    };
 }
 /**
  * Reads a TrueType or OpenType font (`.ttf`, `.otf`, or face `index` of a `.ttc` collection).

package/dist/text/opentype.d.ts

@@ -2,9 +2,10 @@
  * A small OpenType reader: enough of a font file to set Latin, Cyrillic, Greek and CJK text as
  * outlines without a third-party library. It reads TrueType (`glyf`) and CFF (`CFF `, CID-keyed
  * included) outlines, `cmap` (formats 4 and 12), horizontal metrics, `kern` (format 0) and `GPOS`
- * pair kerning (lookup type 2, formats 1 and 2, the `kern` feature), and the family, PostScript
- * name, weight and style. It does not apply `GSUB` (ligatures, contextual forms) or complex-script
- * shaping, so Arabic, Indic and similar scripts set as isolated glyphs.
+ * pair kerning (lookup type 2, formats 1 and 2, the `kern` feature), vertical metrics (`vhea`,
+ * `vmtx`, `VORG`) and vertical alternates (`GSUB` single substitutions of the `vert` feature), and
+ * the family, PostScript name, weight and style. It applies no other `GSUB` (ligatures, contextual
+ * forms) or complex-script shaping, so Arabic, Indic and similar scripts set as isolated glyphs.
  *
  * The result has the shape of opentype.js's `Font` that `createOutlineTextShaper` takes, so hosts
  * can pass either. Written from the OpenType specification (TrueType glyph outlines, the CFF
@@ -31,6 +32,15 @@ export interface OpenTypeFont extends OutlineFontFace {
     kerning(left: number, right: number): number;
     /** A glyph's outline in font units, y up, origin on the baseline. */
     glyphPath(glyph: number): OutlinePathCommand[];
+    /** Whether the font has vertical metrics (`vhea` and `vmtx`). */
+    readonly hasVerticalMetrics: boolean;
+    /** A glyph's vertical alternate (the `vert` feature), or the glyph itself when it has none. */
+    verticalGlyph(glyph: number): number;
+    getVerticalMetrics(char: string): {
+        advance: number;
+        originY: number;
+        alternate: boolean;
+    };
 }
 /**
  * Reads a TrueType or OpenType font (`.ttf`, `.otf`, or face `index` of a `.ttc` collection).

package/dist/text/shapers.d.cts

@@ -42,11 +42,23 @@ export interface OutlineFontFace {
     getAdvanceWidth(text: string, fontSize: number, options?: {
         kerning?: boolean;
     }): number;
+    /** `vertical`: the font's vertical alternates (`vert`), where it has them (faces without `getVerticalMetrics` ignore it). */
     getPath(text: string, x: number, y: number, fontSize: number, options?: {
         kerning?: boolean;
+        vertical?: boolean;
     }): {
         commands: OutlinePathCommand[];
     };
+    /**
+     * Vertical metrics of one character set upright, in font units: its advance down the column, the
+     * distance from the top of its cell to its baseline, and whether it has a vertical alternate.
+     * Optional (opentype.js lacks it): vertical text then uses the ascender and descender.
+     */
+    getVerticalMetrics?(char: string): {
+        advance: number;
+        originY: number;
+        alternate: boolean;
+    };
     names?: {
         fontFamily?: Record<string, string>;
         postScriptName?: Record<string, string>;

package/dist/text/shapers.d.ts

@@ -42,11 +42,23 @@ export interface OutlineFontFace {
     getAdvanceWidth(text: string, fontSize: number, options?: {
         kerning?: boolean;
     }): number;
+    /** `vertical`: the font's vertical alternates (`vert`), where it has them (faces without `getVerticalMetrics` ignore it). */
     getPath(text: string, x: number, y: number, fontSize: number, options?: {
         kerning?: boolean;
+        vertical?: boolean;
     }): {
         commands: OutlinePathCommand[];
     };
+    /**
+     * Vertical metrics of one character set upright, in font units: its advance down the column, the
+     * distance from the top of its cell to its baseline, and whether it has a vertical alternate.
+     * Optional (opentype.js lacks it): vertical text then uses the ascender and descender.
+     */
+    getVerticalMetrics?(char: string): {
+        advance: number;
+        originY: number;
+        alternate: boolean;
+    };
     names?: {
         fontFamily?: Record<string, string>;
         postScriptName?: Record<string, string>;

package/dist/text/types.d.cts

@@ -38,7 +38,20 @@ export interface TextStyle {
     strikethrough?: boolean;
     /** PostScript name from a PSD (`ArialMT`), kept so the exact face can be found and written back. */
     postScriptName?: string;
+    /**
+     * Vertical text only: set Latin and other horizontal-script characters upright, one under the
+     * other, instead of turned sideways (Photoshop's Standard Vertical Roman Alignment off). Default
+     * false. No effect on horizontal text.
+     */
+    upright?: boolean;
 }
+/**
+ * Which way text runs. `horizontal`: lines left to right, stacked downwards. `vertical`: columns
+ * top to bottom, stacked right to left; CJK characters stand upright and other scripts are turned
+ * 90° clockwise (unless their style is `upright`).
+ */
+export type TextOrientation = 'horizontal' | 'vertical';
+export declare const TEXT_ORIENTATIONS: readonly TextOrientation[];
 /** A character style over `length` UTF-16 code units of the text, in order. */
 export interface TextRun {
     length: number;
@@ -71,6 +84,20 @@ export interface TextFont {
     size: number;
     postScriptName?: string;
 }
+/** How a shaper sets a character upright in a vertical column (pixels). */
+export interface TextVerticalMetrics {
+    /** Advance down the column. */
+    advance: number;
+    /** Distance from the top of the character's cell to its horizontal baseline. */
+    originY: number;
+    /** Whether the font has a vertical alternate (OpenType `vert`) the shaper draws with `{ vertical: true }`. */
+    alternate: boolean;
+}
+/** Options for drawing or outlining text. */
+export interface TextGlyphOptions {
+    /** Use the font's vertical alternates (`vert`), for upright characters in vertical text. */
+    vertical?: boolean;
+}
 /**
  * What layout and rendering need from fonts. Implement `outline` (glyph outlines, pure) or `draw`
  * (onto a 2D canvas), or both.
@@ -94,9 +121,16 @@ export interface TextShaper {
      */
     measure(text: string, font: TextFont): ArrayLike<number>;
     /** Glyph outlines of `text` with its start on the baseline at (`x`, `y`), pixels, y down. */
-    outline?(text: string, font: TextFont, x: number, y: number): BezierPath;
+    outline?(text: string, font: TextFont, x: number, y: number, options?: TextGlyphOptions): BezierPath;
     /** Draws `text` with its start on the baseline at (`x`, `y`) in the context's current transform, fill style and alpha. */
-    draw?(ctx: CanvasRenderingContext2D, text: string, font: TextFont, x: number, y: number): void;
+    draw?(ctx: CanvasRenderingContext2D, text: string, font: TextFont, x: number, y: number, options?: TextGlyphOptions): void;
+    /**
+     * Vertical metrics of one character (a code point) set upright, from the font's `vhea` / `vmtx`.
+     * Optional: without it, vertical layout uses the font's ascent + descent as the advance and its
+     * ascent as the origin, and has no vertical alternates (brackets and dashes are then turned
+     * sideways, and 、。 moved to the upper right of their cell).
+     */
+    vertical?(char: string, font: TextFont): TextVerticalMetrics;
     /** Families this shaper can draw (for font pickers and agents), when it can tell. */
     families?(): string[];
 }

package/dist/text/types.d.ts

@@ -38,7 +38,20 @@ export interface TextStyle {
     strikethrough?: boolean;
     /** PostScript name from a PSD (`ArialMT`), kept so the exact face can be found and written back. */
     postScriptName?: string;
+    /**
+     * Vertical text only: set Latin and other horizontal-script characters upright, one under the
+     * other, instead of turned sideways (Photoshop's Standard Vertical Roman Alignment off). Default
+     * false. No effect on horizontal text.
+     */
+    upright?: boolean;
 }
+/**
+ * Which way text runs. `horizontal`: lines left to right, stacked downwards. `vertical`: columns
+ * top to bottom, stacked right to left; CJK characters stand upright and other scripts are turned
+ * 90° clockwise (unless their style is `upright`).
+ */
+export type TextOrientation = 'horizontal' | 'vertical';
+export declare const TEXT_ORIENTATIONS: readonly TextOrientation[];
 /** A character style over `length` UTF-16 code units of the text, in order. */
 export interface TextRun {
     length: number;
@@ -71,6 +84,20 @@ export interface TextFont {
     size: number;
     postScriptName?: string;
 }
+/** How a shaper sets a character upright in a vertical column (pixels). */
+export interface TextVerticalMetrics {
+    /** Advance down the column. */
+    advance: number;
+    /** Distance from the top of the character's cell to its horizontal baseline. */
+    originY: number;
+    /** Whether the font has a vertical alternate (OpenType `vert`) the shaper draws with `{ vertical: true }`. */
+    alternate: boolean;
+}
+/** Options for drawing or outlining text. */
+export interface TextGlyphOptions {
+    /** Use the font's vertical alternates (`vert`), for upright characters in vertical text. */
+    vertical?: boolean;
+}
 /**
  * What layout and rendering need from fonts. Implement `outline` (glyph outlines, pure) or `draw`
  * (onto a 2D canvas), or both.
@@ -94,9 +121,16 @@ export interface TextShaper {
      */
     measure(text: string, font: TextFont): ArrayLike<number>;
     /** Glyph outlines of `text` with its start on the baseline at (`x`, `y`), pixels, y down. */
-    outline?(text: string, font: TextFont, x: number, y: number): BezierPath;
+    outline?(text: string, font: TextFont, x: number, y: number, options?: TextGlyphOptions): BezierPath;
     /** Draws `text` with its start on the baseline at (`x`, `y`) in the context's current transform, fill style and alpha. */
-    draw?(ctx: CanvasRenderingContext2D, text: string, font: TextFont, x: number, y: number): void;
+    draw?(ctx: CanvasRenderingContext2D, text: string, font: TextFont, x: number, y: number, options?: TextGlyphOptions): void;
+    /**
+     * Vertical metrics of one character (a code point) set upright, from the font's `vhea` / `vmtx`.
+     * Optional: without it, vertical layout uses the font's ascent + descent as the advance and its
+     * ascent as the origin, and has no vertical alternates (brackets and dashes are then turned
+     * sideways, and 、。 moved to the upper right of their cell).
+     */
+    vertical?(char: string, font: TextFont): TextVerticalMetrics;
     /** Families this shaper can draw (for font pickers and agents), when it can tell. */
     families?(): string[];
 }

package/dist/vector/controller.d.cts

@@ -143,6 +143,8 @@ export interface VectorTextInput extends VectorStyle {
     }>, 'kind' | 'path'>;
     font?: Partial<VectorCharacterStyle>;
     paragraph?: VectorParagraphStyle;
+    /** Point and area text: `vertical` sets columns running down, right to left (default horizontal). */
+    orientation?: 'horizontal' | 'vertical';
     name?: string;
 }
 /** A constraint reference from loose input: an anchor by `subpath` / `index` (or its `id` as `anchor`), its handle, its segment, or a path as a circle. */
@@ -2249,6 +2251,7 @@ export declare class VectorEditorController {
     styleTexts(patch: {
         style?: Record<string, unknown>;
         paragraph?: Record<string, unknown>;
+        orientation?: 'horizontal' | 'vertical';
     }, options?: {
         ids?: readonly string[];
         merge?: string;
@@ -2264,6 +2267,11 @@ export declare class VectorEditorController {
      * the node's own space). One undo step.
      */
     setTextFrame(id: string, patch: Record<string, unknown>): VectorActionResult;
+    /**
+     * Horizontal ↔ vertical text (Type › Type Orientation) for point and area text: the text, styles
+     * and frame stay; lines become columns running down, right to left, or back. One undo step.
+     */
+    setTextOrientation(id: string, orientation: 'horizontal' | 'vertical'): VectorActionResult;
     /**
      * Turns path `pathId` into text set along it (Type on a Path): a text node in its place, its
      * anchors the text's path, its paint dropped for the text defaults (or `input`'s). Returns the

package/dist/vector/controller.d.ts

@@ -143,6 +143,8 @@ export interface VectorTextInput extends VectorStyle {
     }>, 'kind' | 'path'>;
     font?: Partial<VectorCharacterStyle>;
     paragraph?: VectorParagraphStyle;
+    /** Point and area text: `vertical` sets columns running down, right to left (default horizontal). */
+    orientation?: 'horizontal' | 'vertical';
     name?: string;
 }
 /** A constraint reference from loose input: an anchor by `subpath` / `index` (or its `id` as `anchor`), its handle, its segment, or a path as a circle. */
@@ -2249,6 +2251,7 @@ export declare class VectorEditorController {
     styleTexts(patch: {
         style?: Record<string, unknown>;
         paragraph?: Record<string, unknown>;
+        orientation?: 'horizontal' | 'vertical';
     }, options?: {
         ids?: readonly string[];
         merge?: string;
@@ -2264,6 +2267,11 @@ export declare class VectorEditorController {
      * the node's own space). One undo step.
      */
     setTextFrame(id: string, patch: Record<string, unknown>): VectorActionResult;
+    /**
+     * Horizontal ↔ vertical text (Type › Type Orientation) for point and area text: the text, styles
+     * and frame stay; lines become columns running down, right to left, or back. One undo step.
+     */
+    setTextOrientation(id: string, orientation: 'horizontal' | 'vertical'): VectorActionResult;
     /**
      * Turns path `pathId` into text set along it (Type on a Path): a text node in its place, its
      * anchors the text's path, its paint dropped for the text defaults (or `input`'s). Returns the