tegaki 0.5.0 → 0.6.0

package/dist/index.d.mts

@@ -1,288 +1,3 @@
-import { ComponentProps, Ref } from "react";
-import * as _$react_jsx_runtime0 from "react/jsx-runtime";
-
-//#region src/types.d.ts
-type LineCap = 'round' | 'butt' | 'square';
-interface Point {
-  x: number;
-  y: number;
-}
-interface TimedPoint extends Point {
-  t: number;
-  width: number;
-}
-interface BBox {
-  x1: number;
-  y1: number;
-  x2: number;
-  y2: number;
-}
-interface Stroke {
-  points: TimedPoint[];
-  order: number;
-  length: number;
-  animationDuration: number;
-  delay: number;
-}
-interface GlyphData {
-  char: string;
-  unicode: number;
-  advanceWidth: number;
-  boundingBox: BBox;
-  path: string;
-  skeleton: Point[][];
-  strokes: Stroke[];
-  totalLength: number;
-  totalAnimationDuration: number;
-}
-interface FontOutput {
-  font: {
-    family: string;
-    style: string;
-    unitsPerEm: number;
-    ascender: number;
-    descender: number;
-    lineCap: LineCap;
-  };
-  glyphs: Record<string, GlyphData>;
-}
-interface PathCommand {
-  type: 'M' | 'L' | 'Q' | 'C' | 'Z';
-  x: number;
-  y: number;
-  x1?: number;
-  y1?: number;
-  x2?: number;
-  y2?: number;
-}
-/**
- * Compact glyph data for rendering.
- * - `w`: advance width
- * - `t`: total animation duration
- * - `s`: strokes, each with `p` (points as `[x, y, width]` tuples), `d` (delay), `a` (animation duration)
- */
-interface TegakiGlyphData {
-  w: number;
-  t: number;
-  s: {
-    p: ([x: number, y: number, width: number] | number[])[];
-    d: number;
-    a: number;
-  }[];
-}
-type BaseEffectConfig = {
-  enabled?: boolean;
-};
-/** A length value: plain number is pixels, string `"${number}em"` is relative to font size. */
-type CSSLength = number | `${number}em`;
-type TegakiEffectConfigs = {
-  glow: BaseEffectConfig & {
-    radius?: CSSLength;
-    color?: string;
-    offsetX?: number;
-    offsetY?: number;
-  };
-  wobble: BaseEffectConfig & {
-    amplitude?: number;
-    frequency?: number;
-    mode?: 'sine' | 'noise';
-  };
-  pressureWidth: BaseEffectConfig & {
-    strength?: number;
-  };
-  taper: BaseEffectConfig & {
-    startLength?: number;
-    endLength?: number;
-  };
-  gradient: BaseEffectConfig & {
-    colors?: string[] | 'rainbow';
-    saturation?: number;
-    lightness?: number;
-  };
-};
-type TegakiEffectName = keyof TegakiEffectConfigs;
-/** Effects that can only appear once (cannot be used with custom keys). */
-type TegakiSingletonEffectName = 'pressureWidth' | 'wobble' | 'taper' | 'gradient';
-/** Effects that can be duplicated with custom keys. */
-type TegakiMultiEffectName = Exclude<TegakiEffectName, TegakiSingletonEffectName>;
-type TegakiCustomEffect = { [K in TegakiMultiEffectName]: TegakiEffectConfigs[K] & {
-  effect: K;
-  order?: number;
-} }[TegakiMultiEffectName];
-/** Validates an effects object: known keys infer `effect`, unknown keys require it (singleton effects excluded). */
-type TegakiEffects<T> = { [K in keyof T]: K extends TegakiEffectName ? (TegakiEffectConfigs[K] & {
-  effect?: K;
-  order?: number;
-}) | boolean : TegakiCustomEffect | boolean };
-interface TegakiBundle {
-  family: string;
-  lineCap: LineCap;
-  fontUrl: string;
-  fontFaceCSS: string;
-  unitsPerEm: number;
-  ascender: number;
-  descender: number;
-  glyphData: Record<string, TegakiGlyphData>;
-}
-//#endregion
-//#region src/lib/effects.d.ts
-interface ResolvedEffect<K extends TegakiEffectName = TegakiEffectName> {
-  effect: K;
-  order: number;
-  config: TegakiEffectConfigs[K];
-}
-//#endregion
-//#region src/lib/drawGlyph.d.ts
-interface GlyphPosition {
-  /** X offset in CSS pixels */
-  x: number;
-  /** Y offset in CSS pixels (top of em square) */
-  y: number;
-  /** Font size in CSS pixels */
-  fontSize: number;
-  /** Units per em from the font */
-  unitsPerEm: number;
-  /** Font ascender in font units */
-  ascender: number;
-  /** Font descender in font units (negative) */
-  descender: number;
-}
-/**
- * Draw a single glyph's strokes onto a canvas context, animated up to `localTime`.
- * `localTime` is seconds relative to this glyph's start (0 = glyph begins).
- */
-declare function drawGlyph(ctx: CanvasRenderingContext2D, glyph: TegakiGlyphData, pos: GlyphPosition, localTime: number, lineCap: LineCap, color: string, effects?: ResolvedEffect[], seed?: number, segmentSize?: number): void;
-//#endregion
-//#region src/lib/timeline.d.ts
-interface TimelineConfig {
-  /** Pause between glyphs (seconds). Default: `0.1` */
-  glyphGap?: number;
-  /** Pause after a space character (seconds). Default: `0.15` */
-  wordGap?: number;
-  /** Pause after a newline / line break (seconds). Default: `0.3` */
-  lineGap?: number;
-  /** Duration for characters without glyph data (seconds). Default: `0.2` */
-  unknownDuration?: number;
-}
-interface TimelineEntry {
-  char: string;
-  offset: number;
-  duration: number;
-  hasGlyph: boolean;
-}
-interface Timeline {
-  entries: TimelineEntry[];
-  totalDuration: number;
-}
-declare function computeTimeline(text: string, font: TegakiBundle, config?: TimelineConfig): Timeline;
-//#endregion
-//#region src/lib/utils.d.ts
-type Coercible = string | number | boolean | null | undefined | readonly Coercible[];
-//#endregion
-//#region src/lib/TegakiRenderer.d.ts
-/**
- * Returns a promise that resolves when the font is ready for text measurement.
- * - Already loaded (by us or externally): resolves immediately.
- * - Currently loading externally: waits for `document.fonts.ready`.
- * - Not registered at all: loads it via the FontFace API.
- * Returns `null` if the font is already loaded synchronously.
- */
-/**
- * Ensures the bundle's font face is loaded and available for rendering.
- * Resolves immediately if the font is already loaded.
- */
-declare function ensureFontFace(bundle: TegakiBundle): Promise<void>;
-type TimeControlMode = {
-  controlled: {
-    mode: 'controlled'; /** Current time in seconds. */
-    value: number;
-  };
-  uncontrolled: {
-    mode: 'uncontrolled'; /** Initial time in seconds. Default: `0` */
-    initialTime?: number; /** Playback speed multiplier. Default: `1` */
-    speed?: number; /** Whether animation is playing. Default: `true` */
-    playing?: boolean; /** Loop animation when it reaches the end. Default: `false` */
-    loop?: boolean;
-    /**
-     * Catch-up strength. When positive, playback speeds up when there is a
-     * large amount of remaining animation and decays back to normal gradually.
-     * `0` disables catch-up (default). Higher values ramp up more aggressively.
-     * Typical range: `0.2` – `2`.
-     */
-    catchUp?: number; /** Called on every frame with the current time. */
-    onTimeChange?: (time: number) => void;
-  };
-  css: {
-    mode: 'css';
-  };
-};
-/**
- * A plain number is shorthand for `{ mode: 'controlled', value: number }`.
- * `'css'` is shorthand for `{ mode: 'css' }`.
- * Omit for uncontrolled mode with default settings.
- */
-type TimeControlProp = null | undefined | number | 'css' | TimeControlMode[keyof TimeControlMode];
-/** Imperative handle exposed via the `ref` prop. */
-interface TegakiRendererHandle {
-  /** The root DOM element. */
-  getElement(): HTMLDivElement | null;
-  /** Current animation time in seconds. */
-  getCurrentTime(): number;
-  /** Total timeline duration in seconds. */
-  getDuration(): number;
-  /** Whether the animation is currently playing (uncontrolled mode only). */
-  getIsPlaying(): boolean;
-  /** Whether the animation has reached the end. */
-  getIsComplete(): boolean;
-  /** Resume playback (uncontrolled mode only). No-op in controlled/css mode. */
-  play(): void;
-  /** Pause playback (uncontrolled mode only). No-op in controlled/css mode. */
-  pause(): void;
-  /** Jump to a specific time in seconds (uncontrolled mode only). No-op in controlled/css mode. */
-  seek(time: number): void;
-  /** Seek to 0 and play (uncontrolled mode only). No-op in controlled/css mode. */
-  restart(): void;
-}
-interface TegakiRendererProps<E extends TegakiEffects<E> = Record<string, never>> extends Omit<ComponentProps<'div'>, 'children' | 'ref'> {
-  /** Imperative handle ref for playback controls and DOM access. */
-  ref?: Ref<TegakiRendererHandle>;
-  /** TegakiBundle with font data and animated glyph SVGs. */
-  font?: TegakiBundle;
-  /** Text to animate. Takes precedence over children. */
-  text?: string;
-  /** Children coerced to string. Strings and numbers are kept; everything else is ignored. */
-  children?: Coercible;
-  /**
-   * Time control. Accepts a number (controlled shorthand), or an object
-   * specifying the mode (`'controlled'`, `'uncontrolled'`, or `'css'`).
-   * Omit for uncontrolled playback with default settings.
-   */
-  time?: TimeControlProp;
-  /** Called once when the animation reaches the end of the timeline. */
-  onComplete?: () => void;
-  /** Visual effects applied during canvas rendering. */
-  effects?: E;
-  /** Maximum segment size in pixels for effect subdivision. Lower values produce
-   * smoother effects but cost more to render. Default: `2` */
-  segmentSize?: number;
-  /** Timeline timing configuration (gap between glyphs, words, lines, etc.). */
-  timing?: TimelineConfig;
-  /** Show debug text overlay. */
-  showOverlay?: boolean;
-}
-declare function TegakiRenderer<const E extends TegakiEffects<E> = Record<string, never>>({
-  ref,
-  font,
-  text,
-  children,
-  time: timeProp,
-  onComplete,
-  effects,
-  segmentSize,
-  timing,
-  showOverlay,
-  ...props
-}: TegakiRendererProps<E>): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-export { BBox, CSSLength, FontOutput, GlyphData, LineCap, PathCommand, Point, Stroke, TegakiBundle, type TegakiEffectConfigs, TegakiEffectName, type TegakiEffects, TegakiGlyphData, TegakiMultiEffectName, TegakiRenderer, type TegakiRendererHandle, type TegakiRendererProps, TegakiSingletonEffectName, type TimeControlMode, type TimeControlProp, TimedPoint, type Timeline, type TimelineConfig, computeTimeline, drawGlyph, ensureFontFace };
-//# sourceMappingURL=index.d.mts.map
+import { A as TegakiSingletonEffectName, C as Stroke, D as TegakiEffects, E as TegakiEffectName, O as TegakiGlyphData, S as Point, T as TegakiEffectConfigs, _ as CSSLength, a as TimeControlProp, b as LineCap, c as TimelineEntry, d as computeTextLayout, f as ensureFontFace, g as BBox, h as resolveEffects, i as TimeControlMode, j as TimedPoint, k as TegakiMultiEffectName, l as computeTimeline, m as ResolvedEffect, n as TegakiEngine, o as Timeline, p as drawGlyph, r as TegakiEngineOptions, s as TimelineConfig, t as CreateElementFn, u as TextLayout, v as FontOutput, w as TegakiBundle, x as PathCommand, y as GlyphData } from "./index-Bzxy01Zq.mjs";
+import { n as TegakiRendererHandle, r as TegakiRendererProps, t as TegakiRenderer } from "./index-BUNd9bnS.mjs";
+export { BBox, CSSLength, CreateElementFn, FontOutput, GlyphData, LineCap, PathCommand, Point, ResolvedEffect, Stroke, TegakiBundle, TegakiEffectConfigs, TegakiEffectName, TegakiEffects, TegakiEngine, TegakiEngineOptions, TegakiGlyphData, TegakiMultiEffectName, TegakiRenderer, TegakiRendererHandle, TegakiRendererProps, TegakiSingletonEffectName, TextLayout, TimeControlMode, TimeControlProp, TimedPoint, Timeline, TimelineConfig, TimelineEntry, computeTextLayout, computeTimeline, drawGlyph, ensureFontFace, resolveEffects };