@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/text/TextRotation.d.ts

@@ -0,0 +1,106 @@
+import { Size, Bounds, Point } from '@sheetxl/utils';
+import { ITextFrame } from './ITextFrame';
+/**
+ * Rotated cell-text layout (the Excel model).
+ *
+ * Rotated text is NOT a rotated block. Each laid-out line is an independent strip drawn at the
+ * rotation angle:
+ *
+ * 1. The cell height is a hard constraint. A line breaks when its rotated extent reaches the
+ *    content-box top/bottom — the available text length per line is
+ *    `(height - lineHeight·|cos θ|) / |sin θ|` (see {@link getLineLength}).
+ * 2. Consecutive strips tile exactly: each is advanced horizontally by `-lineHeight / sin θ`
+ *    (see {@link getAdvance}) — up-slanted text (CSS 270..360) marches right, down-slanted
+ *    (CSS 0..90) marches left, in reading order.
+ * 3. The horizontal direction is free: the footprint grows/overflows sideways like ordinary
+ *    overflow text; alignment positions the whole set within the content box.
+ *
+ * All output is pure geometry (origins + one shared angle), renderer-agnostic: a DOM renderer maps
+ * each line to `transform: rotate(θ); transform-origin: 0 0` at `origin`; a canvas renderer uses
+ * `translate(origin) + rotate(θ)`. Angles are CSS degrees (clockwise, y-down) as returned by
+ * `ITextBoxAlignment.getRotation`.
+ */
+/**
+ * A single rotated line strip.
+ */
+export interface Line {
+    /**
+     * Where the strip's un-rotated top-left sits (content-box coordinate space). The strip is the
+     * line's box (`size`) rotated by the layout {@link Layout.angle angle} **about this point**.
+     */
+    origin: Point;
+    /** The un-rotated strip box: the line's text width × line height. */
+    size: Size;
+    /** The axis-aligned bounds of the rotated strip. */
+    bounds: Bounds;
+}
+/**
+ * The placed geometry for all lines — see {@link layoutLines}.
+ */
+export interface Layout {
+    /** The rotation, CSS degrees clockwise, normalized to [0, 360). Never 0 or 180 (callers skip). */
+    angle: number;
+    /**
+     * The available text length along a rotated line before it exhausts the content height. Wrapped
+     * text breaks at this length; fit tests (`####`, repeat fills) measure against it.
+     */
+    lineLength: number;
+    /**
+     * The signed horizontal advance between consecutive line origins (`-lineHeight / sin θ`).
+     * Positive marches right (up-slanted text), negative marches left (down-slanted).
+     */
+    advance: number;
+    /** One entry per laid-out text line, in reading order. */
+    lines: readonly Line[];
+    /** The axis-aligned union of all strips — the painted footprint (may exceed the content box). */
+    bounds: Bounds;
+}
+/**
+ * Normalizes CSS degrees to [0, 360).
+ */
+export declare function normalizeAngle(deg: number): number;
+/**
+ * Returns `true` if the angle participates in rotated layout (non-degenerate sine). Multiples of
+ * 180° render as ordinary horizontal text (a 180° flip is a renderer transform, not a layout).
+ */
+export declare function isRotatedLayout(deg: number): boolean;
+/**
+ * The available text length along one rotated line within `contentHeight`.
+ *
+ * A strip of thickness `lineHeight` at angle θ spans `w·|sin θ| + lineHeight·|cos θ|` vertically;
+ * solving for the length that exactly fills the height gives
+ * `(contentHeight - lineHeight·|cos θ|) / |sin θ|`. At ±90° this degenerates to `contentHeight`.
+ * Clamped to ≥ 1 so a too-short row still lays out (and wraps per-character like a too-narrow
+ * column does).
+ */
+export declare function getLineLength(contentHeight: number, lineHeight: number, deg: number): number;
+/**
+ * The signed horizontal advance between consecutive strips: `-lineHeight / sin θ`.
+ *
+ * Derived by translating a strip perpendicular by exactly `lineHeight` (adjacent, no overlap) and
+ * sliding it back along its own direction onto the shared anchor edge — the net move is purely
+ * horizontal. Positive = next line to the right (up-slanted text), negative = left (down-slanted).
+ */
+export declare function getAdvance(lineHeight: number, deg: number): number;
+/**
+ * Lays out rotated line strips within a content box.
+ *
+ * @param lineSizes The un-rotated line boxes (width = text width, height = line height), in
+ *  reading order. Only sizes are used; positions are derived here.
+ * @param deg The rotation in CSS degrees (must satisfy {@link isRotatedLayout}).
+ * @param content The content box (cell box minus insets), in the caller's coordinate space.
+ * @param horizontal The resolved horizontal alignment (`General` already resolved to left/right).
+ *  At diagonal angles it applies twice, matching Excel: along each line's chord (a short last line
+ *  slides toward the reading end) and to the whole footprint against the content box. At ±90° it
+ *  places the footprint only — the chord is vertical there, and sliding along it belongs to
+ *  `vertical`.
+ * @param vertical The vertical alignment. Diagonal angles: applied to the whole footprint against
+ *  the content box. ±90°: applied per line ALONG its chord with screen semantics (Top hugs every
+ *  line to the top edge, Center centers each line, Bottom hugs the bottom).
+ *
+ * @remarks
+ * The footprint may exceed the content box in either axis — rotated text overflows; clipping is a
+ * consumer decision.
+ */
+export declare function layoutLines(lineSizes: readonly Size[], deg: number, content: Bounds, horizontal: ITextFrame.HorizontalAlignment, vertical: ITextFrame.VerticalAlignment): Layout;
+//# sourceMappingURL=TextRotation.d.ts.map

package/types/src/text/TextRotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextRotation.d.ts","sourceRoot":"","sources":["../../../../src/text/TextRotation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEpE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC;IACd,qEAAqE;IACrE,IAAI,EAAE,IAAI,CAAC;IACX,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,kGAAkG;IAClG,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,KAAK,EAAE,SAAS,IAAI,EAAE,CAAC;IACvB,iGAAiG;IACjG,MAAM,EAAE,MAAM,CAAC;CAChB;AAMD;;GAEG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGlD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAK5F;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAIlE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CACzB,SAAS,EAAE,SAAS,IAAI,EAAE,EAC1B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,UAAU,CAAC,mBAAmB,EAC1C,QAAQ,EAAE,UAAU,CAAC,iBAAiB,GACrC,MAAM,CAgHR"}

package/types/src/text/TextRun.d.ts

@@ -0,0 +1,85 @@
+import { Bounds } from '@sheetxl/utils';
+import { IText } from './IText';
+import { TextVisitor } from './TextVisitor';
+/**
+ * Represents a contiguous span of characters within a text frame that share the same formatting.
+ */
+export interface ITextRun {
+    /**
+     * The actual text content of the run.
+     */
+    readonly text: string;
+    /**
+     * The font name applied to the text run.
+     * If not specified, it inherits the font name from its parent paragraph.
+     */
+    readonly fontName: string;
+    /**
+     * The font size applied to the text run.
+     * If not specified, it inherits the font size from its parent paragraph.
+     */
+    readonly fontSize: number;
+    /**
+     * Indicates whether the text is bold.
+     */
+    readonly bold: boolean;
+    /**
+     * Indicates whether the text is italicized.
+     */
+    readonly italic: boolean;
+    readonly superSub: boolean;
+    /**
+     * Specifies the additional spacing between characters (in ems).
+     */
+    readonly letterSpacing: number;
+    /**
+     * Specifies the minimum font size (in points) at which character kerning will be applied.
+     * If omitted, kerning will be applied for all font sizes down to 0 points.
+     */
+    readonly kerningMin: number;
+    /**
+     * Specifies the capitalization style to be applied to the text during layout and rendering.
+     * This does not affect the actual stored text content.
+     */
+    readonly smallCaps: IText.SmallCaps;
+    /**
+     * Vertical offset of the text (as a percentage of font height),
+     * shifting it up (positive values) or down (negative values).
+     * This does not affect the line height.
+     */
+    readonly offset: number;
+    /**
+     * Specifies the strikethrough style applied to the text.
+     */
+    readonly strikeStyle: IText.StrikeStyle;
+}
+export interface PlacedTextRun extends ITextRun {
+    /**
+     * Bounds is not copied during clone.
+     */
+    readonly bounds?: Bounds;
+}
+export interface CloneableTextRun extends ITextRun {
+    clone(visitor?: TextVisitor): ITextRun;
+    equals(other: TextVisitor): boolean;
+}
+export declare class DefaultTextRun implements ITextRun, PlacedTextRun, CloneableTextRun {
+    private _private;
+    private _bounds?;
+    constructor(overrides: Partial<ITextRun>, bounds?: Bounds | null);
+    clone(visitor?: TextVisitor): ITextRun;
+    equals(other: TextVisitor): boolean;
+    get bounds(): Bounds | undefined;
+    get text(): string;
+    get fontName(): string;
+    get bold(): boolean;
+    get italic(): boolean;
+    get fontSize(): number;
+    get superSub(): boolean;
+    get letterSpacing(): number;
+    get kerningMin(): number;
+    get smallCaps(): IText.SmallCaps;
+    get offset(): number;
+    get strikeStyle(): IText.StrikeStyle;
+}
+//# sourceMappingURL=TextRun.d.ts.map

package/types/src/text/TextRun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextRun.d.ts","sourceRoot":"","sources":["../../../../src/text/TextRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC;IACpC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC;CAwBzC;AAED,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C;;OAEG;IACF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAEvC,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC;CACrC;AAID,qBAAa,cAAe,YAAW,QAAQ,EAAE,aAAa,EAAE,gBAAgB;IAC9E,OAAO,CAAC,QAAQ,CAYd;IAEF,OAAO,CAAC,OAAO,CAAC,CAAS;gBAEb,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAC,MAAM,GAAG,IAAS;IAQnE,KAAK,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,QAAQ;IAStC,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAInC,IAAI,MAAM,uBAET;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IACD,IAAI,QAAQ,IAAI,MAAM,CAErB;IACD,IAAI,IAAI,IAAI,OAAO,CAElB;IACD,IAAI,MAAM,IAAI,OAAO,CAEpB;IACD,IAAI,QAAQ,IAAI,MAAM,CAErB;IACD,IAAI,QAAQ,IAAI,OAAO,CAEtB;IACD,IAAI,aAAa,IAAI,MAAM,CAE1B;IACD,IAAI,UAAU,IAAI,MAAM,CAEvB;IACD,IAAI,SAAS,IAAI,KAAK,CAAC,SAAS,CAE/B;IACD,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD,IAAI,WAAW,IAAI,KAAK,CAAC,WAAW,CAEnC;CACF"}

package/types/src/text/TextUtils.d.ts

@@ -0,0 +1,165 @@
+/**
+ * Will try to find a valid text value from a template by incrementing a last number.
+ *
+ * @param template The string to use for a baseline for generating new text values.
+ * @param isValidName A callback for validating the current text.
+ * @returns A string for the first valid text.
+ */
+export declare function findValidTextValue(template: string, isValidName: (candidate: string) => boolean, maxIncrement?: number): string;
+/**
+ * Capitalizes the first character of a string and optionally lowercases the rest of the string.
+ *
+ * @param str The input string to be processed.
+ * @param lowerCaseRest A boolean flag indicating whether to convert the rest of the string to lowercase.
+ *                         If `true`, the remaining characters (after the first) will be converted to lowercase.
+ *                         If `false`, the remaining characters will remain unchanged.
+ *
+ * @returns A new string with the first character capitalized and the rest lowercased if the `lowerCaseRest` flag is `true`.
+ *          If the `lowerCaseRest` flag is `false`, only the first character is capitalized, and the rest of the string remains unchanged.
+ *
+ * @example
+ * ```
+ * capitalize("hello");           // Returns "Hello"
+ * capitalize("hello", true);     // Returns "Hello"
+ * capitalize("HELLO", true);     // Returns "Hello"
+ * capitalize("123abc", true);    // Returns "123abc"
+ * capitalize("", true);          // Returns ""
+ * ```
+ */
+export declare function capitalize(str: string, lowerCaseRest?: boolean): string;
+/**
+ * Extracts the file extension from a file path.
+ *
+ * @param path The file path from which to extract the file extension.
+ *
+ * @returns The file extension in lowercase. Returns an empty string if the path is invalid or has no extension.
+ *
+ * @example
+ * ```
+ * getFileNameExtension("example.txt");       // Returns "txt"
+ * getFileNameExtension("/path/to/file.jpg"); // Returns "jpg"
+ * getFileNameExtension("no_extension");      // Returns ""
+ * getFileNameExtension("");                  // Returns ""
+ * ```
+ */
+export declare function getFileNameExtension(path: string): string;
+/**
+ * Extracts the base name (file name without extension) from a file path.
+ *
+ * @param path The file path from which to extract the base name.
+ * @param shouldCapitalize A boolean flag indicating whether to capitalize the base name. Defaults to `false`.
+ *
+ * @returns The base name of the file. The base name will be capitalized if `shouldCapitalize` is `true`.
+ *
+ * @example
+ * ```
+ * getBaseName("example.txt");       // Returns "Example"
+ * getBaseName("/path/to/file.jpg"); // Returns "File"
+ * getBaseName("file_without_extension", false); // Returns "file_without_extension"
+ * getBaseName("", false);          // Returns ""
+ * ```
+ */
+export declare function getBaseName(path: string, shouldCapitalize?: boolean): string;
+/**
+ * Converts a snake_case or kebab-case string to camelCase.
+ *
+ * @param str The snake_case or kebab-case string to convert.
+ * @returns The string converted to camelCase.
+ *
+ * @example
+ * ```ts
+ * snakeToCamel('snake_case_string'); // Returns 'snakeCaseString'
+ * snakeToCamel('kebab-case-string'); // Returns 'kebabCaseString'
+ * ```
+ */
+export declare function snakeToCamel(str: string): string;
+/**
+ * Converts a camelCase string to snake_case.
+ *
+ * @param str The camelCase string to convert.
+ * @returns The string converted to snake_case.
+ *
+ * @example
+ * ```ts
+ * camelToSnake('camelCaseString'); // Returns 'camel_case_string'
+ * ```
+ */
+export declare function camelToSnake(str: string): string;
+/**
+ * Trims a string to a specified maximum length and adds an ellipsis (`…`) if the string exceeds the limit.
+ *
+ * @param str The string to trim.
+ * @param maxLength The maximum length of the string before truncation (default is 36).
+ * @returns The truncated string with an ellipsis if it exceeds the specified length.
+ *
+ * @example
+ * ```ts
+ * clampString('This is a long string', 10); // Returns 'This is a …'
+ * ```
+ */
+export declare function clampString(str: string, maxLength?: number): string;
+/**
+ * Counts the number of decimal places in a numeric string.
+ *
+ * @param input The string representation of a number.
+ * @returns The number of decimal places. Returns 0 if there are no decimal places.
+ *
+ * @example
+ * ```ts
+ * countDecimals('123.456'); // Returns 3
+ * countDecimals('123');     // Returns 0
+ * ```
+ */
+export declare function countDecimals(input: string): number;
+export declare const DefaultUnQuoteRegEx: RegExp;
+/**
+ * Checks if a string is enclosed in matching quotes.
+ *
+ * @param str The string to check.
+ * @returns `true` if the string is quoted with matching characters, `false` otherwise.
+ */
+export declare function isQuoted(str: string): boolean;
+/**
+ * Removes the enclosing quotes from a string.
+ *
+ * @param str The string to unquote.
+ * @returns The unquoted string.
+ */
+export declare function unquote(str: string): string;
+/**
+ * Encloses a string in the specified quote character.
+ *
+ * @param str The string to quote.
+ * @param char The quote character to use (default is a single quote `'`).
+ * @returns The quoted string.
+ */
+export declare function quote(str: string, char?: string): string;
+/**
+ * Splits a string by a delimiter, ignoring any quoted sections.
+ *
+ * @param str The string to split.
+ * @param delimiter The delimiter to split by (default is undefined).
+ * @param quote The quote character used to ignore splits inside quoted sections (default is undefined).
+ * @returns An array of strings split by the delimiter, ignoring quoted sections.
+ */
+export declare function splitUnquoted(str: string, delimiter?: string, quote?: string): string[];
+/**
+ * Validates if a string is a valid HTTP or HTTPS URL.
+ *
+ * @param value The string to check.
+ * @returns `true` if the string is a valid HTTP or HTTPS URL, `false` otherwise.
+ */
+export declare function isValidHttpUrl(value: string): boolean;
+/**
+ * Validates if a string is a valid email.
+ *
+ * @param text The string to check.
+ * @returns `true` if the string is a valid email, `false` otherwise.
+ */
+export declare function isValidEmail(text: string): boolean;
+/**
+ * Converts a number to alphabet.
+ * @param i The number to stringify
+ */
+export declare function numberToAlphabet(i: number): string;
+//# sourceMappingURL=TextUtils.d.ts.map

package/types/src/text/TextUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextUtils.d.ts","sourceRoot":"","sources":["../../../../src/text/TextUtils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,EAAE,YAAY,GAAE,MAAW,GAAG,MAAM,CA2BnI;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAE,OAAa,GAAG,MAAM,CAkB5E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,GAAE,OAAa,GAAG,MAAM,CAajF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAOhD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGhD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,MAAS,GAAG,MAAM,CAErE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAQnD;AAqBD,eAAO,MAAM,mBAAmB,QAAmB,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,SAAK,GAAG,MAAM,CAEpD;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAMvF;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAYrD;AAKD;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAOlD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAKlD"}

package/types/src/text/TextVisitor.d.ts

@@ -0,0 +1,11 @@
+import { ITextRun } from './TextRun';
+import { ITextParagraph } from './TextParagraph';
+import { ITextLine } from './TextLine';
+import { ITextFrame } from './ITextFrame';
+export interface TextVisitor {
+    visitTextRun?: (run: ITextRun, index: number, count: number) => Partial<ITextRun> | void;
+    visitTextParagraph?: (paragraph: ITextParagraph, index: number, count: number) => Partial<ITextParagraph> | void;
+    visitTextLine?: (line: ITextLine, index: number, count: number) => Partial<ITextLine> | void;
+    visitTextFrame?: (frame: ITextFrame) => Partial<ITextFrame> | void;
+}
+//# sourceMappingURL=TextVisitor.d.ts.map

package/types/src/text/TextVisitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextVisitor.d.ts","sourceRoot":"","sources":["../../../../src/text/TextVisitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,WAAW,WAAW;IAC1B,YAAY,CAAC,EAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;IAExF,kBAAkB,CAAC,EAAC,CAAC,SAAS,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IAEhH,aAAa,CAAC,EAAC,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAE5F,cAAc,CAAC,EAAC,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;CACnE"}

package/types/src/text/TextWrapper.d.ts

@@ -0,0 +1,78 @@
+import { IFont } from '../font';
+/**
+ * Simple Text Line Wrapper. Is not useful for Rich Text (yet). see TextLayout.
+ */
+export interface TextWrapperOptions {
+    fontName: string;
+    fontSize: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    /**
+     * defaults to 0
+     */
+    letterSpacing?: number;
+    bold?: boolean;
+    italic?: boolean;
+    /**
+     * If the text is a superscript or a subscript.
+     * This affects the width but not the height of the line.
+     */
+    superSub?: boolean;
+    indent?: number;
+}
+export interface TextWrapperResults {
+    bounds: {
+        x: number;
+        y: number;
+        width: number;
+        widthWhitespace: number;
+        height: number;
+    };
+    lines: Line[];
+}
+export interface Line {
+    text: string;
+    startPosition: number;
+    x: number;
+    y: number;
+    width: number;
+    widthWhitespace: number;
+    height: number;
+    baseline: number;
+}
+export interface onLine {
+    (line: Line): boolean | void;
+}
+export declare function linesToText(lines: Line[], trimTrailingSpace?: boolean): string;
+/**
+ * A simple text wrapper that uses a line breaker to break lines.
+ *
+ * *PERFORMANCE OPTIMIZATIONS*
+ * - Binary search for wordBreak
+ * - Reuse all of the objects. (this should support a reuse flag and it lines are not needed then they can also be internally reused)
+ * - Have text measure for collapsed text just calc the difference between the two (just trailing whitespace, is there kerning?)
+ */
+export declare class TextWrapper {
+    private _textMeasurer;
+    private _breaker;
+    private _lastBreak;
+    private _charactersRead;
+    private _linesRead;
+    private _maxXRead;
+    private _maxXWhitespaceRead;
+    private _maxYRead;
+    private _fontName;
+    private _fontSize;
+    private _metricOptions;
+    private _indent;
+    private _isSuperSub;
+    private _ellipsis;
+    private _maxWidth;
+    private _maxHeight;
+    constructor(textMeasurer: IFont.Measurer);
+    private _measureText;
+    private _breakWord;
+    private _breakWhiteSpace;
+    wrap(text: string, options?: TextWrapperOptions | null): TextWrapperResults;
+}
+//# sourceMappingURL=TextWrapper.d.ts.map

package/types/src/text/TextWrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextWrapper.d.ts","sourceRoot":"","sources":["../../../../src/text/TextWrapper.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AAKrC;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IAEjB,QAAQ,EAAE,MAAM,CAAC;IAGjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAGnB,MAAM,CAAC,EAAE,MAAM,CAAC;CAIjB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACzF,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IAEtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,MAAM;IACrB,CAAC,IAAI,EAAC,IAAI,GAAG,OAAO,GAAG,IAAI,CAAC;CAC7B;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,iBAAiB,GAAE,OAAa,GAAG,MAAM,CAUnF;AAwBD;;;;;;;GAOG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,aAAa,CAAiB;IAEtC,OAAO,CAAC,QAAQ,CAAM;IACtB,OAAO,CAAC,UAAU,CAAM;IAExB,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,UAAU,CAAU;IAE5B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,mBAAmB,CAAU;IACrC,OAAO,CAAC,SAAS,CAAU;IAE3B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,cAAc,CAAuB;IAE7C,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,SAAS,CAA2B;IAE5C,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,UAAU,CAAU;gBAEhB,YAAY,EAAE,KAAK,CAAC,QAAQ;IAIxC,OAAO,CAAC,YAAY;IAqCpB,OAAO,CAAC,UAAU;IAgElB,OAAO,CAAC,gBAAgB;IAoExB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAkB,GAAG,IAAS,GAAG,kBAAkB;CA2GhF"}

package/types/src/text/_TextUtils.d.ts

@@ -0,0 +1,90 @@
+import { Size } from '@sheetxl/utils';
+import { IFont } from '../font';
+import { ITextFrame } from './ITextFrame';
+import { ITextBoxAlignment } from './TextBoxAlignment';
+import { IStyledFont } from './richtext/IStyledFont';
+/**
+ * This 'places' text which means that using all of the formatting rules it assign's locations and bounds to
+ * all of the characters. It does not however actually render them. See @renderTextFrame for rendering.
+ *
+ * @param textFrame
+ * @param dimensions
+ * @param textMeasurer This defaults to a canvas context
+ */
+export declare function layoutTextFrame(textFrame: ITextFrame, defaultFont: IStyledFont, alignment: ITextBoxAlignment, dimensions?: Partial<Size> | null, textMeasurer?: IFont.Measurer): ITextFrame;
+/**
+ * Checks whether a string is entirely uppercase, lowercase, or mixed case.
+ *
+ * @param str The input string to be evaluated.
+ * @returns `1` if the string is all uppercase, `-1` if the string is all lowercase, and `0` if the string contains both uppercase and lowercase characters.
+ *
+ * @example
+ * ```
+ * checkCase("HELLO");  // Returns 1
+ * checkCase("hello");  // Returns -1
+ * checkCase("Hello");  // Returns 0
+ * ```
+ */
+export declare function detectCapitalize(str: string): number;
+/**
+ * Analyzes the casing of each character in the string and returns an array of numbers.
+ *
+ * @param str The input string to be evaluated.
+ * @returns An array of numbers where:
+ * - `1` indicates that the character is uppercase.
+ * - `-1` indicates that the character is lowercase.
+ * - `0` indicates that the character is non-alphabetic.
+ *
+ * @example
+ * ```
+ * analyzeCase("Hello123");  // Returns [1, -1, -1, -1, -1, 0, 0, 0]
+ * analyzeCase("ALL_CAPS");  // Returns [1, 1, 1, 0, 1, 1, 1, 1]
+ * analyzeCase("lowercase"); // Returns [-1, -1, -1, -1, -1, -1, -1, -1, -1]
+ * ```
+ */
+export declare function analyzeCase(str: string): readonly number[];
+/**
+ * Converts a given string to match the casing specified by an array of numbers.
+ *
+ * @param str The input string to be converted.
+ * @param caseArray An array of numbers representing the desired casing for each character.
+ * - `1` indicates that the character should be uppercase.
+ * - `-1` indicates that the character should be lowercase.
+ * - `0` indicates that the character should remain unchanged.
+ *
+ * @returns A new string with characters converted to match the specified casing.
+ *
+ * @example
+ * ```
+ * const original = "Hello123";
+ * const caseArray = analyzeCase(original); // [1, -1, -1, -1, -1, 0, 0, 0]
+ * convertCase("WORLD456", caseArray); // Returns "World456"
+ * ```
+ */
+/**
+ * Converts a given string to match the casing specified by an array of numbers.
+ *
+ * @param str The input string to be converted.
+ * @param caseArray An array of numbers representing the desired casing for each character.
+ * - `1` indicates that the character should be uppercase.
+ * - `-1` indicates that the character should be lowercase.
+ * - `0` indicates that the character should remain unchanged.
+ *
+ * @returns A new string with characters converted to match the specified casing.
+ *
+ * @example
+ * ```
+ * const original = "Hello123";
+ * const caseArray = analyzeCase(original); // [1, -1, -1, -1, -1, 0, 0, 0]
+ * convertCase("WORLD456", caseArray); // Returns "World456"
+ * ```
+ */
+export declare function convertCase(str: string, caseArray: readonly number[]): string;
+/**
+ * Create a simple text frame.
+ * TODO - Later we will make take frame take the style (and theme?) and have more operations on it.
+ * TODO - abstract CellStyle
+ * @internal
+ */
+export declare function createTextFrameFromText(text: string, defaultFont: IStyledFont, alignment: ITextBoxAlignment, allowWrap: boolean, disableCustomFormatting?: boolean): ITextFrame;
+//# sourceMappingURL=_TextUtils.d.ts.map

package/types/src/text/_TextUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_TextUtils.d.ts","sourceRoot":"","sources":["../../../../src/text/_TextUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,IAAI,EAAe,MAAM,gBAAgB,CAAC;AAEpE,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAM1C,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAqB1D;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,UAAU,EACrB,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,iBAAiB,EAC5B,UAAU,GAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAS,EACrC,YAAY,GAAE,KAAK,CAAC,QAAkC,GACrD,UAAU,CAsGZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAyBpD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAe1D;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAuB7E;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,WAAW,EACxB,SAAS,EAAE,iBAAiB,EAC5B,SAAS,EAAE,OAAO,EAClB,uBAAuB,GAAE,OAAa,GACrC,UAAU,CA0CZ"}

package/types/src/text/impl/Phrase.d.ts

@@ -0,0 +1,3 @@
+export declare class Phrase {
+}
+//# sourceMappingURL=Phrase.d.ts.map

package/types/src/text/impl/Phrase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Phrase.d.ts","sourceRoot":"","sources":["../../../../../src/text/impl/Phrase.ts"],"names":[],"mappings":"AACA,qBAAa,MAAM;CAElB"}

package/types/src/text/impl/TabStrategy.d.ts

@@ -0,0 +1,9 @@
+import { ITextFrame } from '../ITextFrame';
+import { Phrase } from './Phrase';
+import { IFont } from '../../font';
+export interface TabStrategy {
+    width(x: number, xOffset: number, maxX: number, tabStop: ITextFrame.TabStop, phrase: Phrase, textMeasurer: IFont.Measurer): number;
+    yanks(): boolean;
+    shrinksToZero(): boolean;
+}
+//# sourceMappingURL=TabStrategy.d.ts.map

package/types/src/text/impl/TabStrategy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TabStrategy.d.ts","sourceRoot":"","sources":["../../../../../src/text/impl/TabStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC;IAEnI,KAAK,IAAI,OAAO,CAAC;IAEjB,aAAa,IAAI,OAAO,CAAC;CAC1B"}

package/types/src/text/impl/WordWrapUtils.d.ts

@@ -0,0 +1,6 @@
+export declare class WordWrapUtils {
+    static NL: string;
+    static DefaultLineSpacing: number;
+    static DefaultTabWidth: number;
+}
+//# sourceMappingURL=WordWrapUtils.d.ts.map

package/types/src/text/impl/WordWrapUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WordWrapUtils.d.ts","sourceRoot":"","sources":["../../../../../src/text/impl/WordWrapUtils.ts"],"names":[],"mappings":"AACA,qBAAa,aAAa;IAExB,MAAM,CAAC,EAAE,EAAE,MAAM,CAAQ;IAGzB,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAS;IAC1C,MAAM,CAAC,eAAe,EAAE,MAAM,CAAM;CAErC"}

package/types/src/text/index.d.ts

@@ -0,0 +1,7 @@
+export * from './IText';
+export * from './ITextFrame';
+export * from './richtext';
+export * from './TextBoxAlignment';
+export * as TextUtils from './TextUtils';
+export * as TextRotation from './TextRotation';
+//# sourceMappingURL=index.d.ts.map

package/types/src/text/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/text/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAE7B,cAAc,YAAY,CAAC;AAE3B,cAAc,oBAAoB,CAAC;AACnC,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,YAAY,MAAM,gBAAgB,CAAC"}