@sarmal/core 0.12.0 → 0.14.0

package/dist/{types-BzgdhxE0.d.ts → types-BQosOzlf.d.ts}

@@ -7,10 +7,8 @@ interface CurveDef {
     /**
      * The parametric function that defines the curve shape.
      * @param t Current position along the curve, in [0, period)
-     * @param time Elapsed wall-clock time in seconds — always increasing, never resets on period wrap
-     * @param params Named parameter overrides.
-     *   Always `{}` today — reserved for the upcoming parameterized-curves feature.
-     *   Do NOT remove this parameter; it is intentional forward-compatible plumbing.
+     * @param time Elapsed actual time in seconds. It is always increasing, and never resets on period wrap
+     * @param params Named parameter overrides. intentional forward-compatible parameter
      */
     fn: (t: number, time: number, params: Record<string, number>) => Point;
     /**
@@ -203,8 +201,10 @@ interface Engine extends AnimationControls {
     cancelSpeedTransition(): void;
 }
 interface SarmalInstance extends AnimationControls {
-    start(): void;
-    stop(): void;
+    /** Starts the animation loop (requestAnimationFrame). If already running, does nothing. */
+    play(): void;
+    /** Pauses the animation loop (cancelAnimationFrame) and cancels any speed transition. Preserves state. */
+    pause(): void;
     /** Stops the animation and cleans up resources */
     destroy(): void;
     /**
@@ -222,10 +222,21 @@ interface SarmalInstance extends AnimationControls {
  */
 type TrailStyle = "default" | "gradient-static" | "gradient-animated";
 type PalettePreset = "bard" | "sunset" | "ocean" | "ice" | "fire" | "forest";
-interface RendererOptions {
-    /** Target canvas element that will contain the Sarmal */
-    canvas: HTMLCanvasElement;
-    engine: Engine;
+/**
+ * Common renderer options shared between canvas and SVG renderers.
+ * Extracted to avoid duplication and ensure consistency.
+ */
+interface BaseRendererOptions {
+    /**
+     * Whether to start the animation loop automatically on creation.
+     * @default true
+     */
+    autoStart?: boolean;
+    /**
+     * Initial position along the curve (t value). If provided, seek(initialT) is called before the first frame.
+     * @default undefined (no seek performed, starts at t=0)
+     */
+    initialT?: number;
     /**
      * @default '#ffffff'
      */
@@ -246,15 +257,20 @@ interface RendererOptions {
      */
     trailStyle?: TrailStyle;
     /**
-     * Color palette for gradient trails
-     * Can be a preset name or custom array of hex colors.
-     * @default 'bard' for animated, 'ice' for static
+     * Color palette for gradient trails.
+     * Can be a preset name or a custom array of hex color strings.
+     * @default 'bard' for 'gradient-animated', 'ice' for 'gradient-static'
      */
     palette?: PalettePreset | string[];
 }
+interface RendererOptions extends BaseRendererOptions {
+    /** Target canvas element that will contain the Sarmal */
+    canvas: HTMLCanvasElement;
+    engine: Engine;
+}
 interface SarmalOptions extends Omit<RendererOptions, "canvas" | "engine"> {
     /** @default 120 */
     trailLength?: number;
 }
 
-export type { CurveDef as C, Engine as E, JumpOptions as J, PalettePreset as P, RendererOptions as R, SarmalInstance as S, TrailStyle as T, SarmalOptions as a, Point as b, SeekOptions as c };
+export type { BaseRendererOptions as B, CurveDef as C, Engine as E, JumpOptions as J, PalettePreset as P, RendererOptions as R, SarmalInstance as S, TrailStyle as T, SarmalOptions as a, Point as b, SeekOptions as c };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sarmal/core",
-  "version": "0.12.0",
+  "version": "0.14.0",
   "description": "Curve path based loading indicators and their renderer",
   "keywords": [
     "animation",