@mentra/sdk 2.1.29-beta.1 → 2.1.30-beta.1

package/dist/display-utils.d.ts

@@ -1,989 +1,30 @@
 /**
- * Type declarations for @mentra/display-utils
+ * Display Utils
  *
- * Auto-generated from display-utils source.
- * Do not edit manually - run 'bun run build' to regenerate.
+ * Glasses-agnostic, pixel-accurate text measurement and wrapping library
+ * for smart glasses displays.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   TextMeasurer,
+ *   TextWrapper,
+ *   DisplayHelpers,
+ *   ScrollView,
+ *   G1_PROFILE,
+ *   createG1Toolkit
+ * } from '@mentra/sdk/display-utils'
+ *
+ * // Quick start
+ * const { wrapper } = createG1Toolkit()
+ * const result = wrapper.wrap("Your text here")
+ *
+ * // Scrollable content
+ * const scrollView = new ScrollView(measurer, wrapper)
+ * scrollView.setContent("Very long text...")
+ * scrollView.scrollDown()
+ * const viewport = scrollView.getViewport()
+ * ```
  */
-
-declare module "@mentra/display-utils" {
-  // ============================================================================
-  // Profile Types
-  // ============================================================================
-
-  /**
-   * Display profile for a specific glasses model.
-   * All text measurement and wrapping derives from this configuration.
-   */
-    export interface DisplayProfile {
-      /** Unique identifier for this glasses model */
-      id: string;
-      /** Human-readable name */
-      name: string;
-      /** Display width in pixels */
-      displayWidthPx: number;
-      /** Display height in pixels (if applicable) */
-      displayHeightPx?: number;
-      /** Maximum number of lines that can be displayed */
-      maxLines: number;
-      /** Maximum safe payload size in bytes (for BLE transmission) */
-      maxPayloadBytes: number;
-      /** BLE chunk size for transmission */
-      bleChunkSize: number;
-      /** Font metrics for text measurement */
-      fontMetrics: FontMetrics;
-      /** Optional constraints */
-      constraints?: DisplayConstraints;
-  }
-  /**
-   * Font metrics for pixel-accurate text measurement.
-   */
-    export interface FontMetrics {
-      /**
-       * Map of character to glyph width in pixels.
-       * Keys are single characters.
-       */
-      glyphWidths: Map<string, number>;
-      /** Default glyph width for unmapped characters */
-      defaultGlyphWidth: number;
-      /**
-       * Formula to convert glyph width to rendered pixel width.
-       * G1 example: (glyphWidth + 1) * 2
-       */
-      renderFormula: (glyphWidth: number) => number;
-      /**
-       * Uniform-width scripts - verified to render all characters at same width.
-       * These are NOT averages - they are the actual uniform width in RENDERED pixels.
-       */
-      uniformScripts: UniformScriptWidths;
-      /**
-       * Fallback configuration for unmapped characters.
-       */
-      fallback: FallbackConfig;
-  }
-  /**
-   * Uniform width scripts - these scripts render all characters at the same width.
-   * Values are in RENDERED pixels (after applying renderFormula if applicable).
-   * Verified through hardware testing.
-   */
-    export interface UniformScriptWidths {
-      /** Chinese, Japanese Kanji - all chars same width */
-      cjk: number;
-      /** Japanese Hiragana - all chars same width */
-      hiragana: number;
-      /** Japanese Katakana - all chars same width */
-      katakana: number;
-      /** Korean Hangul - all chars same width */
-      korean: number;
-      /** Russian, etc. - all chars same width */
-      cyrillic: number;
-  }
-  /**
-   * Fallback strategy for unmapped characters.
-   */
-    export interface FallbackConfig {
-      /**
-       * Max known Latin width for safe fallback (in rendered pixels).
-       * Using max ensures we never overflow (worst case: slight under-utilization).
-       */
-      latinMaxWidth: number;
-      /** What to do with completely unknown characters */
-      unknownBehavior: "useLatinMax" | "throw" | "filter";
-  }
-  /**
-   * Optional display constraints.
-   */
-    export interface DisplayConstraints {
-      /** Minimum characters before allowing hyphen break */
-      minCharsBeforeHyphen?: number;
-      /** Characters that should not appear at start of line (kinsoku) */
-      noStartChars?: string[];
-      /** Characters that should not appear at end of line (kinsoku) */
-      noEndChars?: string[];
-  }
-  /**
-   * Script type for character classification.
-   */
-    export type ScriptType = "latin" | "cjk" | "hiragana" | "katakana" | "korean" | "cyrillic" | "numbers" | "punctuation" | "unsupported";
-
-  // ============================================================================
-  // G1 Profiles
-  // ============================================================================
-
-  /**
-   * Even Realities G1 Smart Glasses Display Profile
-   *
-   * Verified through empirical testing with actual hardware.
-   * See: line-width-debug-tool/line-width-spec.md
-   */
-    export declare const G1_PROFILE: DisplayProfile;
-  /**
-   * G1 Profile for LEGACY mobile clients that have their own wrapping logic.
-   *
-   * Old mobile clients re-wrap text received from the cloud, causing double-wrapping.
-   * This profile uses a reduced display width (~522px instead of 576px) so that
-   * when the mobile client re-wraps, the result still fits within 5 lines.
-   *
-   * Use this profile when:
-   * - Mobile client version < X.X.X (has old wrapping logic)
-   * - You see text getting cut off or exceeding 5 lines
-   *
-   * Once all clients are updated, this can be deprecated.
-   */
-    export declare const G1_PROFILE_LEGACY: DisplayProfile;
-  /**
-   * Get the hyphen width for G1 in rendered pixels.
-   * Hyphen glyph = 4px → rendered = (4+1)*2 = 10px
-   */
-    export declare const G1_HYPHEN_WIDTH_PX = 10;
-  /**
-   * Get the space width for G1 in rendered pixels.
-   * Space glyph = 2px → rendered = (2+1)*2 = 6px
-   */
-    export declare const G1_SPACE_WIDTH_PX = 6;
-
-  // ============================================================================
-  // Script Detection
-  // ============================================================================
-
-  /**
-   * Unicode ranges for script detection.
-   * Used to classify characters for proper width measurement.
-   */
-    export declare const SCRIPT_RANGES: {
-      readonly cjk: readonly [readonly [19968, 40959], readonly [13312, 19903], readonly [131072, 173791], readonly [173824, 177983], readonly [177984, 178207], readonly [63744, 64255]];
-      readonly hiragana: readonly [readonly [12352, 12447]];
-      readonly katakana: readonly [readonly [12448, 12543], readonly [12784, 12799]];
-      readonly korean: readonly [readonly [44032, 55215], readonly [4352, 4607], readonly [12592, 12687], readonly [43360, 43391], readonly [55216, 55295]];
-      readonly cyrillic: readonly [readonly [1024, 1279], readonly [1280, 1327]];
-      readonly numbers: readonly [readonly [48, 57]];
-      readonly punctuation: readonly [readonly [32, 47], readonly [58, 64], readonly [91, 96], readonly [123, 126]];
-      readonly arabic: readonly [readonly [1536, 1791]];
-      readonly hebrew: readonly [readonly [1424, 1535]];
-      readonly thai: readonly [readonly [3584, 3711]];
-      readonly emoji: readonly [readonly [128512, 128591], readonly [127744, 128511], readonly [128640, 128767], readonly [127456, 127487], readonly [9728, 9983], readonly [9984, 10175], readonly [65024, 65039], readonly [129280, 129535]];
-  };
-  /**
-   * Detect the script type of a single character.
-   *
-   * @param char - Single character to classify
-   * @returns The script type of the character
-   */
-    export declare function detectScript(char: string): ScriptType;
-  /**
-   * Check if a character is a CJK character (Chinese, Japanese Kanji).
-   * CJK characters can break anywhere without needing a hyphen.
-   */
-    export declare function isCJKCharacter(char: string): boolean;
-  /**
-   * Check if a character is Korean Hangul.
-   */
-    export declare function isKoreanCharacter(char: string): boolean;
-  /**
-   * Check if a character is from a uniform-width script.
-   * These scripts render all characters at the same width.
-   */
-    export declare function isUniformWidthScript(char: string): boolean;
-  /**
-   * Check if a character is from an unsupported script.
-   * These characters may not render correctly on the glasses.
-   */
-    export declare function isUnsupportedScript(char: string): boolean;
-  /**
-   * Check if breaking between two characters requires a hyphen.
-   * Returns false for:
-   * - Breaking after CJK characters (can break anywhere)
-   * - Breaking before or after spaces
-   * - Breaking after punctuation
-   */
-    export declare function needsHyphenForBreak(charBefore: string, charAfter: string): boolean;
-
-  // ============================================================================
-  // Text Measurer
-  // ============================================================================
-
-  /**
-   * Character measurement result with detailed breakdown.
-   */
-    export interface CharMeasurement {
-      /** The character measured */
-      char: string;
-      /** Width in rendered pixels */
-      widthPx: number;
-      /** The script type of the character */
-      script: ScriptType;
-      /** Whether width came from glyph map (true) or fallback (false) */
-      fromGlyphMap: boolean;
-  }
-  /**
-   * Text measurement result with detailed breakdown.
-   */
-    export interface TextMeasurement {
-      /** The text measured */
-      text: string;
-      /** Total width in rendered pixels */
-      totalWidthPx: number;
-      /** Number of characters */
-      charCount: number;
-      /** Per-character measurements (optional, for debugging) */
-      chars?: CharMeasurement[];
-  }
-  /**
-   * Measures text width in pixels based on a DisplayProfile.
-   * All measurements are in actual rendered pixels, not abstract units.
-   *
-   * Key features:
-   * - Pixel-perfect measurement for mapped characters
-   * - Uniform-width handling for CJK, Korean, Cyrillic
-   * - Safe fallback for unmapped Latin characters
-   * - Caching for performance
-   */
-    export declare class TextMeasurer {
-      private readonly profile;
-      private readonly charCache;
-      constructor(profile: DisplayProfile);
-      /**
-       * Pre-compute rendered widths for all known glyphs.
-       */
-      private buildCharCache;
-      /**
-       * Measure the total pixel width of a text string.
-       *
-       * @param text - The text to measure
-       * @returns Width in rendered pixels
-       */
-      measureText(text: string): number;
-      /**
-       * Measure text with detailed breakdown of each character.
-       *
-       * @param text - The text to measure
-       * @returns Detailed measurement result
-       */
-      measureTextDetailed(text: string): TextMeasurement;
-      /**
-       * Measure a single character's pixel width.
-       *
-       * IMPORTANT: This is PIXEL-PERFECT measurement, not averaging!
-       * - Mapped characters: exact width from glyph map
-       * - Uniform scripts (CJK, Korean, Cyrillic): verified uniform width
-       * - Unmapped Latin: MAX width fallback (safe, never overflow)
-       *
-       * @param char - Single character to measure
-       * @returns Width in rendered pixels
-       */
-      measureChar(char: string): number;
-      /**
-       * Calculate character width (called when not in cache).
-       */
-      private calculateCharWidth;
-      /**
-       * Get the raw glyph width (before render formula).
-       * Returns undefined for unmapped characters.
-       *
-       * @param char - Single character
-       * @returns Glyph width in pixels, or undefined if not in glyph map
-       */
-      getGlyphWidth(char: string): number | undefined;
-      /**
-       * Check if text fits within a pixel width.
-       *
-       * @param text - Text to check
-       * @param maxWidthPx - Maximum width in pixels
-       * @returns true if text fits
-       */
-      fitsInWidth(text: string, maxWidthPx: number): boolean;
-      /**
-       * Find how many characters fit within a pixel width.
-       *
-       * @param text - Text to measure
-       * @param maxWidthPx - Maximum width in pixels
-       * @param startIndex - Starting index (default: 0)
-       * @returns Number of characters that fit
-       */
-      charsThatFit(text: string, maxWidthPx: number, startIndex?: number): number;
-      /**
-       * Find the pixel position of a character index in text.
-       *
-       * @param text - Text to measure
-       * @param index - Character index
-       * @returns Pixel offset from start of text
-       */
-      getPixelOffset(text: string, index: number): number;
-      /**
-       * Detect the script type of a character.
-       *
-       * @param char - Single character
-       * @returns Script type
-       */
-      detectScript(char: string): ScriptType;
-      /**
-       * Check if a character is from a uniform-width script.
-       *
-       * @param char - Single character
-       * @returns true if character is from CJK, Korean, or Cyrillic
-       */
-      isUniformWidth(char: string): boolean;
-      /**
-       * Get the display profile.
-       */
-      getProfile(): DisplayProfile;
-      /**
-       * Get the display width in pixels.
-       */
-      getDisplayWidthPx(): number;
-      /**
-       * Get the maximum number of lines.
-       */
-      getMaxLines(): number;
-      /**
-       * Get the maximum payload size in bytes.
-       */
-      getMaxPayloadBytes(): number;
-      /**
-       * Calculate the UTF-8 byte size of text.
-       *
-       * @param text - Text to measure
-       * @returns Byte size
-       */
-      getByteSize(text: string): number;
-      /**
-       * Get the width of a hyphen character in rendered pixels.
-       */
-      getHyphenWidth(): number;
-      /**
-       * Get the width of a space character in rendered pixels.
-       */
-      getSpaceWidth(): number;
-      /**
-       * Clear the character cache.
-       * Useful if profile metrics change at runtime.
-       */
-      clearCache(): void;
-  }
-
-  // ============================================================================
-  // Wrapper Types
-  // ============================================================================
-
-  /**
-   * Options for text wrapping.
-   */
-    export interface WrapOptions {
-      /** Maximum width in pixels (defaults to profile's displayWidthPx) */
-      maxWidthPx?: number;
-      /** Maximum number of lines (defaults to profile's maxLines) */
-      maxLines?: number;
-      /** Maximum total bytes (defaults to profile's maxPayloadBytes) */
-      maxBytes?: number;
-      /**
-       * Break mode:
-       * - 'character': Break mid-word with hyphen for 100% utilization
-       * - 'word': Break at word boundaries, hyphenate only if word > line
-       * - 'strict-word': Break at word boundaries only, truncate long words
-       */
-      breakMode?: BreakMode;
-      /** Character to use for hyphenation (default: '-') */
-      hyphenChar?: string;
-      /** Minimum characters before allowing hyphen break (default: 3) */
-      minCharsBeforeHyphen?: number;
-      /** Whether to trim whitespace from line ends (default: true) */
-      trimLines?: boolean;
-      /** Whether to preserve explicit newlines in input (default: true) */
-      preserveNewlines?: boolean;
-  }
-  /**
-   * Break mode for text wrapping.
-   */
-    export type BreakMode = "character" | "word" | "strict-word";
-  /**
-   * Result of wrapping operation.
-   */
-    export interface WrapResult {
-      /** Wrapped lines */
-      lines: string[];
-      /** Whether content was truncated to fit constraints */
-      truncated: boolean;
-      /** Total pixel width of widest line */
-      maxLineWidthPx: number;
-      /** Total byte size of all lines */
-      totalBytes: number;
-      /** Per-line metadata */
-      lineMetrics: LineMetrics[];
-      /** Original input text */
-      originalText: string;
-      /** Break mode used */
-      breakMode: BreakMode;
-  }
-  /**
-   * Per-line metrics from wrapping.
-   */
-    export interface LineMetrics {
-      /** The line text */
-      text: string;
-      /** Width in pixels */
-      widthPx: number;
-      /** Byte size of this line */
-      bytes: number;
-      /** Utilization percentage (widthPx / maxWidthPx * 100) */
-      utilizationPercent: number;
-      /** Whether this line ends with a hyphen from breaking */
-      endsWithHyphen: boolean;
-      /** Whether this line was created from an explicit newline */
-      fromExplicitNewline: boolean;
-  }
-  /**
-   * Default wrap options.
-   */
-    export declare const DEFAULT_WRAP_OPTIONS: Required<Omit<WrapOptions, "maxWidthPx" | "maxLines" | "maxBytes">>;
-
-  // ============================================================================
-  // Text Wrapper
-  // ============================================================================
-
-  /**
-   * Wraps text to fit display constraints.
-   *
-   * Supports multiple break modes:
-   * - 'character': Break mid-word with hyphen for 100% line utilization
-   * - 'word': Break at word boundaries, hyphenate only if word > line width
-   * - 'strict-word': Break at word boundaries only, no hyphenation
-   *
-   * Key features:
-   * - Pixel-accurate wrapping (no abstract units)
-   * - Hyphen-aware breaking (accounts for hyphen width)
-   * - CJK support (breaks anywhere without hyphen)
-   * - Preserves explicit newlines
-   * - Respects byte limits for BLE transmission
-   */
-    export declare class TextWrapper {
-      private readonly measurer;
-      private readonly defaultOptions;
-      constructor(measurer: TextMeasurer, defaultOptions?: WrapOptions);
-      /**
-       * Wrap text to fit within constraints.
-       *
-       * @param text - Text to wrap (may contain \n for explicit breaks)
-       * @param options - Override default options
-       * @returns Wrap result with lines and metadata
-       */
-      wrap(text: string, options?: WrapOptions): WrapResult;
-      /**
-       * Simple wrap returning just lines (convenience method).
-       *
-       * @param text - Text to wrap
-       * @param options - Override default options
-       * @returns Array of wrapped lines
-       */
-      wrapToLines(text: string, options?: WrapOptions): string[];
-      /**
-       * Check if text needs wrapping.
-       *
-       * @param text - Text to check
-       * @param maxWidthPx - Optional width override
-       * @returns true if text exceeds single line
-       */
-      needsWrap(text: string, maxWidthPx?: number): boolean;
-      /**
-       * Get current default options.
-       */
-      getOptions(): Required<WrapOptions>;
-      /**
-       * Get the measurer instance.
-       */
-      getMeasurer(): TextMeasurer;
-      /**
-       * Wrap a single paragraph (no newlines) according to break mode.
-       */
-      private wrapParagraph;
-      /**
-       * Character break mode: Break mid-word with hyphen for 100% line utilization.
-       */
-      private wrapCharacterMode;
-      /**
-       * Word break mode: Break at word boundaries, hyphenate only if word > line width.
-       */
-      private wrapWordMode;
-      /**
-       * Strict word break mode: Break at word boundaries only, no hyphenation.
-       * Long words will overflow the line.
-       */
-      private wrapStrictWordMode;
-      /**
-       * Split text into words, handling CJK characters specially.
-       * CJK characters are treated as individual "words" since they can break anywhere.
-       */
-      private splitIntoWords;
-      /**
-       * Hyphenate a word that's too long to fit on a single line.
-       */
-      private hyphenateLongWord;
-      /**
-       * Back off characters from line end until hyphen fits.
-       * Returns null if we back off to a space (natural break point - no hyphen needed).
-       */
-      private backoffForHyphen;
-      /**
-       * Merge user options with defaults.
-       */
-      private mergeOptions;
-      /**
-       * Create an empty result for empty input.
-       */
-      private createEmptyResult;
-  }
-
-  // ============================================================================
-  // Display Helpers
-  // ============================================================================
-
-  /**
-   * Truncation result with metadata.
-   */
-    export interface TruncateResult {
-      /** The truncated text */
-      text: string;
-      /** Whether text was truncated */
-      wasTruncated: boolean;
-      /** Width in pixels of truncated text */
-      widthPx: number;
-      /** Original text length */
-      originalLength: number;
-      /** Truncated text length */
-      truncatedLength: number;
-  }
-  /**
-   * Page result for pagination.
-   */
-    export interface Page {
-      /** Lines on this page */
-      lines: string[];
-      /** Page number (1-indexed) */
-      pageNumber: number;
-      /** Total number of pages */
-      totalPages: number;
-      /** Whether this is the first page */
-      isFirst: boolean;
-      /** Whether this is the last page */
-      isLast: boolean;
-  }
-  /**
-   * Chunk result for BLE transmission.
-   */
-    export interface Chunk {
-      /** The chunk text */
-      text: string;
-      /** Chunk index (0-indexed) */
-      index: number;
-      /** Total number of chunks */
-      totalChunks: number;
-      /** Byte size of this chunk */
-      bytes: number;
-  }
-  /**
-   * Optional helper utilities for common display operations.
-   * Built on top of TextMeasurer and TextWrapper for convenience.
-   */
-    export declare class DisplayHelpers {
-      private readonly measurer;
-      private readonly wrapper;
-      private readonly profile;
-      constructor(measurer: TextMeasurer, wrapper: TextWrapper);
-      /**
-       * Truncate lines array to max count.
-       *
-       * @param lines - Array of lines
-       * @param maxLines - Maximum lines to keep
-       * @param fromEnd - If true, keep last N lines; if false, keep first N (default: false)
-       * @returns Truncated lines array
-       */
-      truncateToLines(lines: string[], maxLines: number, fromEnd?: boolean): string[];
-      /**
-       * Truncate text to fit within pixel width, adding ellipsis if needed.
-       *
-       * @param text - Text to truncate
-       * @param maxWidthPx - Maximum width in pixels
-       * @param ellipsis - Ellipsis string (default: '...')
-       * @returns Truncation result
-       */
-      truncateWithEllipsis(text: string, maxWidthPx?: number, ellipsis?: string): TruncateResult;
-      /**
-       * Estimate how many lines text will need without fully wrapping.
-       * This is a quick estimate based on average character width.
-       *
-       * @param text - Text to estimate
-       * @param maxWidthPx - Optional width override
-       * @returns Estimated line count
-       */
-      estimateLineCount(text: string, maxWidthPx?: number): number;
-      /**
-       * Wrap and truncate text to fit screen in one call.
-       *
-       * @param text - Text to fit
-       * @param options - Wrap options
-       * @returns Lines that fit on screen
-       */
-      fitToScreen(text: string, options?: WrapOptions): string[];
-      /**
-       * Wrap text and paginate into screen-sized pages.
-       *
-       * @param text - Text to paginate
-       * @param options - Wrap options (maxLines will be used as page size)
-       * @returns Array of pages
-       */
-      paginate(text: string, options?: WrapOptions): Page[];
-      /**
-       * Calculate UTF-8 byte size of text.
-       *
-       * @param text - Text to measure
-       * @returns Byte size
-       */
-      calculateByteSize(text: string): number;
-      /**
-       * Check if text exceeds byte limit.
-       *
-       * @param text - Text to check
-       * @param maxBytes - Optional override (defaults to profile)
-       * @returns true if exceeds limit
-       */
-      exceedsByteLimit(text: string, maxBytes?: number): boolean;
-      /**
-       * Split text into BLE-safe chunks.
-       * Tries to split at word/line boundaries when possible.
-       *
-       * @param text - Text to chunk
-       * @param chunkSize - Optional override (defaults to profile)
-       * @returns Array of chunks
-       */
-      splitIntoChunks(text: string, chunkSize?: number): Chunk[];
-      /**
-       * Calculate line utilization statistics.
-       *
-       * @param result - Wrap result to analyze
-       * @returns Utilization statistics
-       */
-      calculateUtilization(result: WrapResult): {
-          averageUtilization: number;
-          minUtilization: number;
-          maxUtilization: number;
-          totalWastedPx: number;
-      };
-      /**
-       * Pad lines array to exact count with empty strings.
-       *
-       * @param lines - Lines to pad
-       * @param targetCount - Target number of lines
-       * @param padAtEnd - If true, pad at end; if false, pad at start (default: true)
-       * @returns Padded lines array
-       */
-      padToLineCount(lines: string[], targetCount: number, padAtEnd?: boolean): string[];
-      /**
-       * Join lines with newlines for display.
-       *
-       * @param lines - Lines to join
-       * @returns Joined string
-       */
-      joinLines(lines: string[]): string;
-      /**
-       * Get the measurer instance.
-       */
-      getMeasurer(): TextMeasurer;
-      /**
-       * Get the wrapper instance.
-       */
-      getWrapper(): TextWrapper;
-      /**
-       * Get the display profile.
-       */
-      getProfile(): DisplayProfile;
-  }
-
-  // ============================================================================
-  // Scroll View
-  // ============================================================================
-
-  /**
-   * Scroll position information.
-   */
-    export interface ScrollPosition {
-      /** Current scroll offset (0 = top) */
-      offset: number;
-      /** Total number of lines in content */
-      totalLines: number;
-      /** Number of visible lines (viewport size) */
-      visibleLines: number;
-      /** Maximum scroll offset */
-      maxOffset: number;
-      /** Whether we're at the top */
-      atTop: boolean;
-      /** Whether we're at the bottom */
-      atBottom: boolean;
-      /** Scroll percentage (0-100) */
-      scrollPercent: number;
-  }
-  /**
-   * Visible content from the scroll view.
-   */
-    export interface ScrollViewport {
-      /** Lines currently visible */
-      lines: string[];
-      /** Scroll position info */
-      position: ScrollPosition;
-      /** Whether content was truncated during wrapping */
-      contentTruncated: boolean;
-  }
-  /**
-   * ScrollView provides a scrollable viewport into long wrapped text.
-   *
-   * Unlike pagination (discrete pages), scrolling allows continuous
-   * movement through content line by line.
-   *
-   * @example
-   * ```typescript
-   * const scrollView = new ScrollView(measurer, wrapper)
-   * scrollView.setContent("Very long text that wraps to many lines...")
-   *
-   * // Get initial view (top)
-   * let view = scrollView.getViewport()
-   * console.log(view.lines) // First 5 lines
-   *
-   * // Scroll down
-   * scrollView.scrollDown(2) // Move down 2 lines
-   * view = scrollView.getViewport()
-   *
-   * // Scroll to bottom
-   * scrollView.scrollToBottom()
-   *
-   * // Scroll to specific position
-   * scrollView.scrollTo(10) // Line 10 at top of viewport
-   * ```
-   */
-    export declare class ScrollView {
-      private readonly measurer;
-      private readonly wrapper;
-      private readonly profile;
-      private readonly viewportSize;
-      private allLines;
-      private wrapResult;
-      private scrollOffset;
-      constructor(measurer: TextMeasurer, wrapper: TextWrapper, viewportSize?: number);
-      /**
-       * Set the content to display in the scroll view.
-       * Wraps the text and resets scroll position to top.
-       *
-       * @param text - Text content to display
-       * @param options - Optional wrap options
-       */
-      setContent(text: string, options?: Omit<WrapOptions, "maxLines">): void;
-      /**
-       * Append content to the existing scroll view.
-       * Useful for streaming/live content like captions.
-       *
-       * @param text - Text to append
-       * @param options - Optional wrap options
-       * @param autoScroll - If true, scroll to show new content (default: true)
-       */
-      appendContent(text: string, options?: Omit<WrapOptions, "maxLines">, autoScroll?: boolean): void;
-      /**
-       * Get the current viewport (visible lines).
-       */
-      getViewport(): ScrollViewport;
-      /**
-       * Get current scroll position information.
-       */
-      getPosition(): ScrollPosition;
-      /**
-       * Scroll to a specific line offset.
-       *
-       * @param offset - Line offset (0 = top)
-       */
-      scrollTo(offset: number): void;
-      /**
-       * Scroll down by a number of lines.
-       *
-       * @param lines - Number of lines to scroll (default: 1)
-       */
-      scrollDown(lines?: number): void;
-      /**
-       * Scroll up by a number of lines.
-       *
-       * @param lines - Number of lines to scroll (default: 1)
-       */
-      scrollUp(lines?: number): void;
-      /**
-       * Scroll down by one viewport (page down).
-       */
-      pageDown(): void;
-      /**
-       * Scroll up by one viewport (page up).
-       */
-      pageUp(): void;
-      /**
-       * Scroll to the top.
-       */
-      scrollToTop(): void;
-      /**
-       * Scroll to the bottom.
-       */
-      scrollToBottom(): void;
-      /**
-       * Scroll to show a specific line in the viewport.
-       *
-       * @param lineIndex - The line index to show
-       * @param position - Where in viewport: 'top', 'center', 'bottom' (default: 'top')
-       */
-      scrollToLine(lineIndex: number, position?: "top" | "center" | "bottom"): void;
-      /**
-       * Scroll by a percentage of total content.
-       *
-       * @param percent - Percentage (0-100)
-       */
-      scrollToPercent(percent: number): void;
-      /**
-       * Check if currently at the top.
-       */
-      isAtTop(): boolean;
-      /**
-       * Check if currently at the bottom.
-       */
-      isAtBottom(): boolean;
-      /**
-       * Check if content is scrollable (more lines than viewport).
-       */
-      isScrollable(): boolean;
-      /**
-       * Get all lines (not just visible).
-       */
-      getAllLines(): string[];
-      /**
-       * Get total line count.
-       */
-      getTotalLines(): number;
-      /**
-       * Get the viewport size.
-       */
-      getViewportSize(): number;
-      /**
-       * Clear all content and reset scroll position.
-       */
-      clear(): void;
-      /**
-       * Get the measurer instance.
-       */
-      getMeasurer(): TextMeasurer;
-      /**
-       * Get the wrapper instance.
-       */
-      getWrapper(): TextWrapper;
-      /**
-       * Get the display profile.
-       */
-      getProfile(): DisplayProfile;
-  }
-
-  // ============================================================================
-  // Factory Functions
-  // ============================================================================
-
-  /**
-   * @mentra/display-utils
-   *
-   * Glasses-agnostic, pixel-accurate text measurement and wrapping library
-   * for smart glasses displays.
-   *
-   * Key features:
-   * - Pixel-perfect measurement (no abstract units or averages)
-   * - Multiple break modes (character, word, strict-word)
-   * - Full script support (Latin, CJK, Korean, Cyrillic)
-   * - Configurable display profiles for different glasses hardware
-   *
-   * @example
-   * ```typescript
-   * import {
-   *   TextMeasurer,
-   *   TextWrapper,
-   *   DisplayHelpers,
-   *   G1_PROFILE
-   * } from '@mentra/display-utils'
-   *
-   * // Create measurer and wrapper for G1 glasses
-   * const measurer = new TextMeasurer(G1_PROFILE)
-   * const wrapper = new TextWrapper(measurer, { breakMode: 'character' })
-   * const helpers = new DisplayHelpers(measurer, wrapper)
-   *
-   * // Wrap text for display
-   * const result = wrapper.wrap("Hello, world! This is a long text.")
-   * console.log(result.lines)
-   * // ["Hello, world! This is a long text th-", "at needs wrapping."]
-   * ```
-   */
-    export type { DisplayProfile, FontMetrics, UniformScriptWidths, FallbackConfig, DisplayConstraints, ScriptType, } from "./profiles";
-
-
-    export type { CharMeasurement, TextMeasurement } from "./measurer";
-
-
-    export type { WrapOptions, WrapResult, LineMetrics, BreakMode } from "./wrapper";
-
-
-    export type { TruncateResult, Page, Chunk, ScrollPosition, ScrollViewport } from "./helpers";
-
-  /**
-   * Create a complete display toolkit for a given profile.
-   *
-   * @param profile - Display profile (defaults to G1)
-   * @param wrapOptions - Default wrap options
-   * @returns Object with measurer, wrapper, and helpers
-   *
-   * @example
-   * ```typescript
-   * const { measurer, wrapper, helpers } = createDisplayToolkit()
-   * const lines = wrapper.wrapToLines("Hello, world!")
-   * ```
-   */
-    export declare function createDisplayToolkit(profile?: DisplayProfile, wrapOptions?: WrapOptions): {
-      measurer: TextMeasurer;
-      wrapper: TextWrapper;
-      helpers: DisplayHelpers;
-      profile: DisplayProfile;
-  };
-  /**
-   * Create a G1-configured display toolkit with character breaking.
-   * This is the recommended setup for captions and similar high-utilization use cases.
-   *
-   * @returns Object with measurer, wrapper, and helpers configured for G1
-   *
-   * @example
-   * ```typescript
-   * const { wrapper } = createG1Toolkit()
-   * const result = wrapper.wrap("Your text here")
-   * ```
-   */
-    export declare function createG1Toolkit(): {
-      measurer: TextMeasurer;
-      wrapper: TextWrapper;
-      helpers: DisplayHelpers;
-      profile: DisplayProfile;
-  };
-  /**
-   * Create a G1-configured display toolkit for LEGACY mobile clients.
-   *
-   * Use this when the mobile client has old wrapping logic that re-wraps
-   * text received from the cloud. This profile uses a reduced display width
-   * (~522px instead of 576px) to prevent double-wrapping overflow.
-   *
-   * @returns Object with measurer, wrapper, and helpers configured for legacy G1 clients
-   *
-   * @example
-   * ```typescript
-   * // For old mobile clients that double-wrap
-   * const { wrapper } = createG1LegacyToolkit()
-   * const result = wrapper.wrap("Your text here")
-   * // Lines will be shorter to account for mobile re-wrapping
-   * ```
-   */
-    export declare function createG1LegacyToolkit(): {
-      measurer: TextMeasurer;
-      wrapper: TextWrapper;
-      helpers: DisplayHelpers;
-      profile: DisplayProfile;
-  };
-}
+export { type DisplayProfile, type FontMetrics, type UniformScriptWidths, type FallbackConfig, type DisplayConstraints, type ScriptType, G1_PROFILE, G1_PROFILE_LEGACY, G1_HYPHEN_WIDTH_PX, G1_SPACE_WIDTH_PX, TextMeasurer, type CharMeasurement, type TextMeasurement, detectScript, isCJKCharacter, isKoreanCharacter, isUniformWidthScript, isUnsupportedScript, needsHyphenForBreak, SCRIPT_RANGES, TextWrapper, type WrapOptions, type WrapResult, type LineMetrics, type BreakMode, DEFAULT_WRAP_OPTIONS, DisplayHelpers, type TruncateResult, type Page, type Chunk, ScrollView, type ScrollPosition, type ScrollViewport, createDisplayToolkit, createG1Toolkit, createG1LegacyToolkit, } from "./display-utils/index";
+//# sourceMappingURL=display-utils.d.ts.map