meshwriter-cudu 3.0.0 → 3.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "meshwriter-cudu",
-    "version": "3.0.0",
+    "version": "3.0.2",
     "description": "Modern 3D text rendering for Babylon.js with variable font weights and accessibility features",
     "type": "module",
     "main": "./dist/meshwriter.cjs.js",
@@ -40,7 +40,10 @@
         "typescript",
         "esm"
     ],
-    "authors": ["Brian T Button","Cullen Dudas"],
+    "authors": [
+        "Brian T Button",
+        "Cullen Dudas"
+    ],
     "license": "MIT",
     "peerDependencies": {
         "@babylonjs/core": ">=6.0.0",
@@ -56,7 +59,7 @@
     },
     "devDependencies": {
         "@babylonjs/core": "^8.0.0",
-        "@rollup/plugin-commonjs": "^28.0.0",
+        "@rollup/plugin-commonjs": "^29.0.0",
         "@rollup/plugin-node-resolve": "^16.0.0",
         "@rollup/plugin-terser": "^0.4.0",
         "earcut": "^3.0.2",

package/dist/index.d.ts

@@ -1,295 +0,0 @@
-/**
- * MeshWriter Type Declarations
- * Provides TypeScript types for MeshWriter library
- *
- * Requires: @babylonjs/core (peer dependency)
- */
-
-import type { Scene } from '@babylonjs/core/scene';
-import type { Mesh } from '@babylonjs/core/Meshes/mesh';
-import type { StandardMaterial } from '@babylonjs/core/Materials/standardMaterial';
-import type { SolidParticleSystem } from '@babylonjs/core/Particles/solidParticleSystem';
-import type { Vector2 } from '@babylonjs/core/Maths/math.vector';
-
-// ============ Options & Configuration Types ============
-
-/** Position configuration for text placement */
-export interface MeshWriterPosition {
-    x?: number;
-    y?: number;
-    z?: number;
-}
-
-/** Color configuration for material properties */
-export interface MeshWriterColors {
-    diffuse?: string;
-    specular?: string;
-    ambient?: string;
-    emissive?: string;
-}
-
-/** Options for creating text with MeshWriter */
-export interface MeshWriterOptions {
-    /** Position of the text in 3D space */
-    position?: MeshWriterPosition;
-    /** Material color properties */
-    colors?: MeshWriterColors;
-    /** Font family name (must be registered first) */
-    'font-family'?: string;
-    /** Text anchor point */
-    anchor?: 'left' | 'right' | 'center';
-    /** Height of letters in world units */
-    'letter-height'?: number;
-    /** Thickness (depth) of letters in world units */
-    'letter-thickness'?: number;
-    /** Emissive color as hex string (e.g., "#FF0000") */
-    color?: string;
-    /** Material alpha/transparency (0-1) */
-    alpha?: number;
-    /** If true, disables lighting (only emissive color shows) - gives self-lit appearance */
-    'emissive-only'?: boolean;
-    /** If true, the material is affected by scene fog (default: true) */
-    'fog-enabled'?: boolean;
-}
-
-/** Babylon namespace subset used for CSG injection */
-export interface BabylonCSGNamespace {
-    CSG?: unknown;
-    CSG2?: unknown;
-    InitializeCSG2Async?: () => void | Promise<void>;
-    IsCSG2Ready?: () => boolean;
-}
-
-/** Preferences for initializing MeshWriter */
-export interface MeshWriterPreferences {
-    /** Default font family name */
-    defaultFont?: string;
-    /** Scale factor for all text */
-    scale?: number;
-    /** Origin point for mesh positioning */
-    meshOrigin?: 'letterCenter' | 'fontOrigin';
-    /** Enable debug logging */
-    debug?: boolean;
-    /** Babylon namespace providing CSG helpers (used for ES module builds) */
-    babylon?: BabylonCSGNamespace;
-}
-
-// ============ Instance Types ============
-
-/** A text instance created by MeshWriter */
-export interface MeshWriterInstance {
-    /** Get the SolidParticleSystem containing letter meshes */
-    getSPS(): SolidParticleSystem | undefined;
-    /** Get the combined mesh containing all letters */
-    getMesh(): Mesh | undefined;
-    /** Get the material applied to the text */
-    getMaterial(): StandardMaterial;
-    /** Get the X offset for anchoring */
-    getOffsetX(): number;
-    /** Get bounding boxes for each letter */
-    getLettersBoxes(): number[][];
-    /** Get origin positions for each letter */
-    getLettersOrigins(): number[][];
-    /** Get or set the emissive color */
-    color(c?: string): string;
-    /** Get or set the alpha value */
-    alpha(a?: number): number;
-    /** Update the emissive color */
-    setColor(color: string): void;
-    /** Update the alpha value */
-    setAlpha(alpha: number): void;
-    /** Temporarily override alpha */
-    overrideAlpha(alpha: number): void;
-    /** Reset alpha to original value */
-    resetAlpha(): void;
-    /** Get the center position of a letter by index */
-    getLetterCenter(ix: number): Vector2;
-    /** Check if this instance has been disposed */
-    isDisposed(): boolean;
-    /** Dispose of all meshes and materials */
-    dispose(): void;
-}
-
-/** Constructor function returned by MeshWriter factory */
-export interface MeshWriterConstructor {
-    new (letters: string, options?: MeshWriterOptions): MeshWriterInstance;
-    (letters: string, options?: MeshWriterOptions): MeshWriterInstance;
-}
-
-// ============ Font Types ============
-
-/** Individual glyph specification */
-export interface GlyphSpec {
-    /** Compressed shape command strings (pre-decompression) */
-    sC?: string[];
-    /** Compressed hole command strings - array of holes, each hole is array of command strings */
-    hC?: string[][];
-    /** Decompressed shape commands (post-decompression, internal use) */
-    shapeCmds?: number[][][];
-    /** Decompressed hole commands (post-decompression, internal use) */
-    holeCmds?: number[][][][];
-    /** Minimum X coordinate of bounding box */
-    xMin: number;
-    /** Maximum X coordinate of bounding box */
-    xMax: number;
-    /** Minimum Y coordinate of bounding box */
-    yMin: number;
-    /** Maximum Y coordinate of bounding box */
-    yMax: number;
-    /** Character advance width */
-    wdth: number;
-    /** X coordinate scale factor (optional) */
-    xFactor?: number;
-    /** Y coordinate scale factor (optional) */
-    yFactor?: number;
-    /** X coordinate shift (optional) */
-    xShift?: number;
-    /** Y coordinate shift (optional) */
-    yShift?: number;
-    /** Per-glyph reverse shape override (optional) */
-    reverseShape?: boolean;
-    /** Per-glyph reverse hole override (optional) */
-    reverseHole?: boolean;
-}
-
-/** Font specification object containing glyph data */
-export interface FontSpec {
-    /** Whether to reverse hole winding (default for all glyphs) */
-    reverseHoles: boolean;
-    /** Whether to reverse shape winding (default for all glyphs) */
-    reverseShapes: boolean;
-    /** Character glyph data - indexed by character */
-    [character: string]: GlyphSpec | boolean;
-}
-
-/**
- * Function that creates font spec from codeList encoder
- * @deprecated Use FontSpec directly instead of FontFactory
- */
-export type FontFactory = (codeList: (list: number[][]) => string) => FontSpec;
-
-/** Font data - either a FontSpec object or a FontFactory function (legacy) */
-export type FontData = FontSpec | FontFactory;
-
-// ============ Main API Types ============
-
-/** CSG version used for boolean operations */
-export type CSGVersion = 'CSG' | 'CSG2' | null;
-
-/** MeshWriter static API */
-export interface MeshWriterStatic {
-    /**
-     * Create a MeshWriter constructor asynchronously (required for Babylon 8+)
-     * Initializes CSG2 before returning
-     */
-    createAsync(scene: Scene, preferences?: MeshWriterPreferences): Promise<MeshWriterConstructor>;
-
-    /**
-     * Create a MeshWriter constructor synchronously (legacy, Babylon < 7.31)
-     * @deprecated Use createAsync for Babylon 8+
-     */
-    create(scene: Scene, preferences?: MeshWriterPreferences): MeshWriterConstructor;
-
-    /** Check if CSG is initialized and ready */
-    isReady(): boolean;
-
-    /** Get the CSG version being used */
-    getCSGVersion(): CSGVersion;
-
-    /** Set a custom CSG2 initializer function */
-    setCSGInitializer(init: () => void | Promise<void>): void;
-
-    /** Set a custom CSG ready check function */
-    setCSGReadyCheck(check: () => boolean): void;
-
-    /** Register a callback to run when CSG is ready */
-    onCSGReady(callback: () => void): void;
-
-    /** Manually mark CSG as ready */
-    markCSGReady(): void;
-    /** Initialize the internal CSG module with Babylon helpers */
-    initCSGModule(babylon: BabylonCSGNamespace): void;
-
-    /** Register a font for use with MeshWriter */
-    registerFont(name: string, fontData: FontData): void;
-
-    /** Register multiple font aliases pointing to the same font */
-    registerFontAliases(targetName: string, ...aliases: string[]): void;
-
-    /** Get a registered font by name */
-    getFont(name: string): FontSpec | undefined;
-
-    /** Check if a font is registered */
-    isFontRegistered(name: string): boolean;
-
-    /** Encode font coordinates to compressed string */
-    codeList(list: number[][]): string;
-
-    /** Decode compressed string to font coordinates */
-    decodeList(encoded: string): number[][];
-}
-
-// ============ Exports ============
-
-/** Main MeshWriter object with all static methods */
-export const MeshWriter: MeshWriterStatic;
-
-/** Create a MeshWriter constructor asynchronously */
-export function createMeshWriterAsync(scene: Scene, preferences?: MeshWriterPreferences): Promise<MeshWriterConstructor>;
-
-/** Create a MeshWriter constructor synchronously (legacy) */
-export function createMeshWriter(scene: Scene, preferences?: MeshWriterPreferences): MeshWriterConstructor;
-
-/** Check if CSG is initialized and ready */
-export function isCSGReady(): boolean;
-
-/** Get the CSG version being used */
-export function getCSGVersion(): CSGVersion;
-
-/** Set a custom CSG2 initializer function */
-export function setCSGInitializer(init: () => void | Promise<void>): void;
-
-/** Set a custom CSG ready check function */
-export function setCSGReadyCheck(check: () => boolean): void;
-
-/** Register a callback to run when CSG is ready */
-export function onCSGReady(callback: () => void): void;
-
-/** Manually mark CSG as ready */
-export function markCSGReady(): void;
-
-/** Register a font for use with MeshWriter */
-export function registerFont(name: string, fontData: FontData): void;
-
-/** Register multiple font aliases */
-export function registerFontAliases(targetName: string, ...aliases: string[]): void;
-
-/** Get a registered font by name */
-export function getFont(name: string): FontSpec | undefined;
-
-/** Check if a font is registered */
-export function isFontRegistered(name: string): boolean;
-
-/** Encode font coordinates to compressed string */
-export function codeList(list: number[][]): string;
-
-/** Decode compressed string to font coordinates */
-export function decodeList(encoded: string): number[][];
-
-/** Get list of registered font names */
-export function getRegisteredFonts(): string[];
-
-/** Unregister a font (primarily for testing) */
-export function unregisterFont(name: string): void;
-
-/** Clear all registered fonts (primarily for testing) */
-export function clearFonts(): void;
-
-/** Encode font coordinates (alias of codeList) */
-export function encodeFontData(list: number[][]): string;
-
-/** Decode font coordinates (alias of decodeList) */
-export function decodeFontData(encoded: string): number[][];
-
-/** Initialize the internal CSG module with Babylon helpers */
-export function initCSGModule(babylon: BabylonCSGNamespace): void;

package/dist/src/variableFontCache.d.ts

@@ -1,56 +0,0 @@
-/**
- * Create a cache key for a glyph at a specific weight
- * @param {number} weight - Font weight value
- * @param {string} char - Character
- * @returns {string} - Cache key
- */
-export function createGlyphCacheKey(weight: number, char: string): string;
-/**
- * MeshWriter Variable Font Cache
- * LRU cache for variable font glyphs to prevent memory bloat
- */
-/**
- * LRU Cache for glyph specifications
- * Prevents memory bloat when using many weight variations
- */
-export class GlyphCache {
-    /**
-     * Create a new glyph cache
-     * @param {number} [maxSize=5000] - Maximum number of cached entries
-     */
-    constructor(maxSize?: number);
-    _maxSize: number;
-    _cache: Map<any, any>;
-    /**
-     * Get a cached value (moves it to most recently used)
-     * @param {string} key - Cache key
-     * @returns {*} - Cached value or undefined
-     */
-    get(key: string): any;
-    /**
-     * Set a cache value (evicts oldest if at capacity)
-     * @param {string} key - Cache key
-     * @param {*} value - Value to cache
-     */
-    set(key: string, value: any): void;
-    /**
-     * Check if key exists in cache
-     * @param {string} key - Cache key
-     * @returns {boolean}
-     */
-    has(key: string): boolean;
-    /**
-     * Clear all cached entries
-     */
-    clear(): void;
-    /**
-     * Get current cache size
-     * @returns {number}
-     */
-    get size(): number;
-    /**
-     * Get maximum cache size
-     * @returns {number}
-     */
-    get maxSize(): number;
-}

package/dist/src/variableFontConverter.d.ts

@@ -1,21 +0,0 @@
-/**
- * MeshWriter Variable Font Converter
- * Converts fontkit glyph paths to MeshWriter FontSpec format at runtime
- */
-/**
- * Convert fontkit glyph to MeshWriter GlyphSpec
- * @param {object} glyph - fontkit glyph object
- * @param {number} [scale=1] - Scale factor
- * @returns {object|null} - GlyphSpec with shapeCmds/holeCmds, or null if empty
- */
-export function convertFontkitGlyphToSpec(glyph: object, scale?: number): object | null;
-/**
- * Extract kerning pairs from fontkit font for given character set
- * @param {object} font - fontkit font object
- * @param {string} charset - Characters to extract kerning for
- * @param {number} [scale=1] - Scale factor
- * @returns {object} - Kerning table mapping "char1,char2" to adjustment value
- */
-export function extractFontkitKerningPairs(font: object, charset: string, scale?: number): object;
-export function convertGlyphToSpec(glyph: any, scale?: number): any;
-export function extractKerningPairs(font: any, charset: any, scale?: number): any;

package/dist/src/variableFontLoader.d.ts

@@ -1,99 +0,0 @@
-/**
- * Load and parse a variable font from URL
- * @param {string} url - URL to TTF or WOFF2 file
- * @param {object} [options] - Loading options
- * @param {number} [options.cacheSize=5000] - Maximum glyph cache size
- * @param {number} [options.maxVariations=10] - Maximum cached weight variations
- * @returns {Promise<VariableFontHandle>}
- */
-export function loadVariableFont(url: string, options?: {
-    cacheSize?: number;
-    maxVariations?: number;
-}): Promise<VariableFontHandle>;
-export const DEFAULT_CHARSET: string;
-/**
- * Handle for a loaded variable font
- * Provides methods to generate FontSpec at different weights
- */
-export class VariableFontHandle {
-    /**
-     * @param {object} font - fontkit font object
-     * @param {object} fontkit - fontkit module reference
-     * @param {string} url - Source URL
-     * @param {object} axisInfo - Axis information
-     * @param {boolean} isVariable - Whether font is actually variable
-     * @param {number} cacheSize - Maximum glyph cache size
-     * @param {number} maxVariations - Maximum cached weight variations
-     */
-    constructor(font: object, fontkit: object, url: string, axisInfo: object, isVariable: boolean, cacheSize: number, maxVariations: number);
-    _baseFont: any;
-    _fontkit: any;
-    _url: string;
-    _axisInfo: any;
-    _isVariable: boolean;
-    _glyphCache: GlyphCache;
-    _kerningCache: Map<any, any>;
-    _fontCache: Map<any, any>;
-    _maxVariations: number;
-    _reverseShapes: boolean;
-    _reverseHoles: boolean;
-    /**
-     * Get axis information for this font
-     * @returns {object} - Axis info with weight min/max/default
-     */
-    getAxisInfo(): object;
-    /**
-     * Get the source URL
-     * @returns {string}
-     */
-    getUrl(): string;
-    /**
-     * Check if this is actually a variable font
-     * @returns {boolean}
-     */
-    isVariable(): boolean;
-    /**
-     * Get or create a font instance at the specified weight
-     * @param {number} weight - Weight value
-     * @returns {object} - fontkit font instance
-     */
-    _getFontAtWeight(weight: number): object;
-    /**
-     * Generate FontSpec for a specific weight
-     * @param {number} weight - Weight value (100-900 for most fonts)
-     * @param {string} [charset] - Characters to include (default: Latin + symbols)
-     * @returns {object} - FontSpec compatible with MeshWriter
-     */
-    generateFontSpec(weight: number, charset?: string): object;
-    /**
-     * Get or create a cached glyph specification
-     * @param {object} font - fontkit font instance at specific weight
-     * @param {string} char - Character
-     * @param {number} weight - Weight value
-     * @returns {object|null} - GlyphSpec or null if glyph not found
-     */
-    _getOrCreateGlyph(font: object, char: string, weight: number): object | null;
-    /**
-     * Clear all cached glyphs and font instances
-     * Call this when changing weight frequently to free memory
-     */
-    clearCache(): void;
-    /**
-     * Get current cache statistics
-     * @returns {{ glyphCount: number, kerningCount: number, fontCount: number, maxSize: number, maxVariations: number }}
-     */
-    getCacheStats(): {
-        glyphCount: number;
-        kerningCount: number;
-        fontCount: number;
-        maxSize: number;
-        maxVariations: number;
-    };
-    /**
-     * Ensure a cache map respects the max variations limit (simple LRU)
-     * @param {Map} map
-     * @private
-     */
-    private _evictIfNeeded;
-}
-import { GlyphCache } from './variableFontCache.js';