@mentra/sdk 2.1.28 → 2.1.29-beta.2

package/dist/display-utils/wrapper/types.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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">>;
+//# sourceMappingURL=types.d.ts.map

package/dist/display-utils/wrapper/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/display-utils/wrapper/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,CAAA;IAErB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,mEAAmE;IACnE,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAE7B,gEAAgE;IAChE,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB,qEAAqE;IACrE,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,MAAM,GAAG,aAAa,CAAA;AAE5D;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,oBAAoB;IACpB,KAAK,EAAE,MAAM,EAAE,CAAA;IAEf,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAA;IAElB,uCAAuC;IACvC,cAAc,EAAE,MAAM,CAAA;IAEtB,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAA;IAElB,wBAAwB;IACxB,WAAW,EAAE,WAAW,EAAE,CAAA;IAE1B,0BAA0B;IAC1B,YAAY,EAAE,MAAM,CAAA;IAEpB,sBAAsB;IACtB,SAAS,EAAE,SAAS,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IAEZ,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;IAEf,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IAEb,0DAA0D;IAC1D,kBAAkB,EAAE,MAAM,CAAA;IAE1B,yDAAyD;IACzD,cAAc,EAAE,OAAO,CAAA;IAEvB,6DAA6D;IAC7D,mBAAmB,EAAE,OAAO,CAAA;CAC7B;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,GAAG,UAAU,GAAG,UAAU,CAAC,CAMpG,CAAA"}

package/dist/display-utils.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Display Utils
+ *
+ * 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()
+ * ```
+ */
+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

package/dist/display-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"display-utils.d.ts","sourceRoot":"","sources":["../src/display-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AAGH,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,UAAU,EACV,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EAGjB,YAAY,EACZ,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,YAAY,EACZ,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EAGb,WAAW,EACX,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,oBAAoB,EAGpB,cAAc,EACd,KAAK,cAAc,EACnB,KAAK,IAAI,EACT,KAAK,KAAK,EAGV,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,cAAc,EAGnB,oBAAoB,EACpB,eAAe,EACf,qBAAqB,GACtB,MAAM,uBAAuB,CAAA"}