@sarmal/core 0.14.0 → 0.15.0

package/dist/index.d.cts

@@ -1,27 +1,41 @@
-import { B as BaseRendererOptions, E as Engine, S as SarmalInstance, C as CurveDef, R as RendererOptions, a as SarmalOptions } from './types-BQosOzlf.cjs';
-export { J as JumpOptions, P as PalettePreset, b as Point, c as SeekOptions, T as TrailStyle } from './types-BQosOzlf.cjs';
-export { CurveName, curves } from './curves/index.cjs';
-export { artemis2 } from './curves/artemis2.cjs';
-export { astroid } from './curves/astroid.cjs';
-export { deltoid } from './curves/deltoid.cjs';
-export { epicycloid3 } from './curves/epicycloid3.cjs';
-export { epitrochoid7 } from './curves/epitrochoid7.cjs';
-export { lame } from './curves/lame.cjs';
-export { lissajous32 } from './curves/lissajous32.cjs';
-export { lissajous43 } from './curves/lissajous43.cjs';
-export { rose3 } from './curves/rose3.cjs';
-export { rose5 } from './curves/rose5.cjs';
+import {
+  B as BaseRendererOptions,
+  E as Engine,
+  S as SarmalInstance,
+  C as CurveDef,
+  R as RendererOptions,
+  a as SarmalOptions,
+} from "./types-BL9HhEmk.cjs";
+export {
+  J as JumpOptions,
+  P as Point,
+  b as RuntimeRenderOptions,
+  c as SeekOptions,
+  T as TrailColor,
+  d as TrailStyle,
+} from "./types-BL9HhEmk.cjs";
+export { CurveName, curves } from "./curves/index.cjs";
+export { artemis2 } from "./curves/artemis2.cjs";
+export { astroid } from "./curves/astroid.cjs";
+export { deltoid } from "./curves/deltoid.cjs";
+export { epicycloid3 } from "./curves/epicycloid3.cjs";
+export { epitrochoid7 } from "./curves/epitrochoid7.cjs";
+export { lame } from "./curves/lame.cjs";
+export { lissajous32 } from "./curves/lissajous32.cjs";
+export { lissajous43 } from "./curves/lissajous43.cjs";
+export { rose3 } from "./curves/rose3.cjs";
+export { rose5 } from "./curves/rose5.cjs";
 
 interface SVGRendererOptions extends BaseRendererOptions {
-    /** Container element that will contain the SVG */
-    container: Element;
-    engine: Engine;
-    /** @default 'Loading' */
-    ariaLabel?: string;
+  /** Container element that will contain the SVG */
+  container: Element;
+  engine: Engine;
+  /** @default 'Loading' */
+  ariaLabel?: string;
 }
 interface SVGSarmalOptions extends Omit<SVGRendererOptions, "container" | "engine"> {
-    /** @default 120 */
-    trailLength?: number;
+  /** @default 120 */
+  trailLength?: number;
 }
 /**
  * Creates a live SVG renderer for sarmal animations
@@ -43,10 +57,27 @@ declare function createSVGRenderer(options: SVGRendererOptions): SarmalInstance;
  * controlled.pause() // Pause later
  * ```
  */
-declare function createSarmalSVG(container: Element, curveDef: CurveDef, options?: SVGSarmalOptions): SarmalInstance;
+declare function createSarmalSVG(
+  container: Element,
+  curveDef: CurveDef,
+  options?: SVGSarmalOptions,
+): SarmalInstance;
 
 declare function createEngine(curveDef: CurveDef, trailLength?: number): Engine;
 
+/**
+ * Can be passed directly to `trailColor`,
+ *  or can be mixed/sliced before passing as a prop.
+ */
+declare const palettes: {
+  readonly bard: ["#a855f7", "#3b82f6", "#14b8a6", "#ec4899"];
+  readonly sunset: ["#f97316", "#dc2626", "#9333ea", "#f472b6"];
+  readonly ocean: ["#1e3a8a", "#06b6d4", "#22d3ee", "#e0f2fe"];
+  readonly ice: ["#1e3a8a", "#67e8f9"];
+  readonly fire: ["#7f1d1d", "#fbbf24"];
+  readonly forest: ["#14532d", "#86efac"];
+};
+
 /**
  * Creates a Canvas 2D renderer for sarmal animations
  * Renders the skeleton and the trail
@@ -67,6 +98,25 @@ declare function createRenderer(options: RendererOptions): SarmalInstance;
  * controlled.pause() // Pause later
  * ```
  */
-declare function createSarmal(canvas: HTMLCanvasElement, curveDef: CurveDef, options?: SarmalOptions): SarmalInstance;
+declare function createSarmal(
+  canvas: HTMLCanvasElement,
+  curveDef: CurveDef,
+  options?: SarmalOptions,
+): SarmalInstance;
 
-export { BaseRendererOptions, CurveDef, Engine, RendererOptions, type SVGRendererOptions, type SVGSarmalOptions, SarmalInstance, SarmalOptions, createEngine, createRenderer, createSVGRenderer, createSarmal, createSarmalSVG };
+export {
+  BaseRendererOptions,
+  CurveDef,
+  Engine,
+  RendererOptions,
+  type SVGRendererOptions,
+  type SVGSarmalOptions,
+  SarmalInstance,
+  SarmalOptions,
+  createEngine,
+  createRenderer,
+  createSVGRenderer,
+  createSarmal,
+  createSarmalSVG,
+  palettes,
+};

package/dist/index.d.ts

@@ -1,27 +1,41 @@
-import { B as BaseRendererOptions, E as Engine, S as SarmalInstance, C as CurveDef, R as RendererOptions, a as SarmalOptions } from './types-BQosOzlf.js';
-export { J as JumpOptions, P as PalettePreset, b as Point, c as SeekOptions, T as TrailStyle } from './types-BQosOzlf.js';
-export { CurveName, curves } from './curves/index.js';
-export { artemis2 } from './curves/artemis2.js';
-export { astroid } from './curves/astroid.js';
-export { deltoid } from './curves/deltoid.js';
-export { epicycloid3 } from './curves/epicycloid3.js';
-export { epitrochoid7 } from './curves/epitrochoid7.js';
-export { lame } from './curves/lame.js';
-export { lissajous32 } from './curves/lissajous32.js';
-export { lissajous43 } from './curves/lissajous43.js';
-export { rose3 } from './curves/rose3.js';
-export { rose5 } from './curves/rose5.js';
+import {
+  B as BaseRendererOptions,
+  E as Engine,
+  S as SarmalInstance,
+  C as CurveDef,
+  R as RendererOptions,
+  a as SarmalOptions,
+} from "./types-BL9HhEmk.js";
+export {
+  J as JumpOptions,
+  P as Point,
+  b as RuntimeRenderOptions,
+  c as SeekOptions,
+  T as TrailColor,
+  d as TrailStyle,
+} from "./types-BL9HhEmk.js";
+export { CurveName, curves } from "./curves/index.js";
+export { artemis2 } from "./curves/artemis2.js";
+export { astroid } from "./curves/astroid.js";
+export { deltoid } from "./curves/deltoid.js";
+export { epicycloid3 } from "./curves/epicycloid3.js";
+export { epitrochoid7 } from "./curves/epitrochoid7.js";
+export { lame } from "./curves/lame.js";
+export { lissajous32 } from "./curves/lissajous32.js";
+export { lissajous43 } from "./curves/lissajous43.js";
+export { rose3 } from "./curves/rose3.js";
+export { rose5 } from "./curves/rose5.js";
 
 interface SVGRendererOptions extends BaseRendererOptions {
-    /** Container element that will contain the SVG */
-    container: Element;
-    engine: Engine;
-    /** @default 'Loading' */
-    ariaLabel?: string;
+  /** Container element that will contain the SVG */
+  container: Element;
+  engine: Engine;
+  /** @default 'Loading' */
+  ariaLabel?: string;
 }
 interface SVGSarmalOptions extends Omit<SVGRendererOptions, "container" | "engine"> {
-    /** @default 120 */
-    trailLength?: number;
+  /** @default 120 */
+  trailLength?: number;
 }
 /**
  * Creates a live SVG renderer for sarmal animations
@@ -43,10 +57,27 @@ declare function createSVGRenderer(options: SVGRendererOptions): SarmalInstance;
  * controlled.pause() // Pause later
  * ```
  */
-declare function createSarmalSVG(container: Element, curveDef: CurveDef, options?: SVGSarmalOptions): SarmalInstance;
+declare function createSarmalSVG(
+  container: Element,
+  curveDef: CurveDef,
+  options?: SVGSarmalOptions,
+): SarmalInstance;
 
 declare function createEngine(curveDef: CurveDef, trailLength?: number): Engine;
 
+/**
+ * Can be passed directly to `trailColor`,
+ *  or can be mixed/sliced before passing as a prop.
+ */
+declare const palettes: {
+  readonly bard: ["#a855f7", "#3b82f6", "#14b8a6", "#ec4899"];
+  readonly sunset: ["#f97316", "#dc2626", "#9333ea", "#f472b6"];
+  readonly ocean: ["#1e3a8a", "#06b6d4", "#22d3ee", "#e0f2fe"];
+  readonly ice: ["#1e3a8a", "#67e8f9"];
+  readonly fire: ["#7f1d1d", "#fbbf24"];
+  readonly forest: ["#14532d", "#86efac"];
+};
+
 /**
  * Creates a Canvas 2D renderer for sarmal animations
  * Renders the skeleton and the trail
@@ -67,6 +98,25 @@ declare function createRenderer(options: RendererOptions): SarmalInstance;
  * controlled.pause() // Pause later
  * ```
  */
-declare function createSarmal(canvas: HTMLCanvasElement, curveDef: CurveDef, options?: SarmalOptions): SarmalInstance;
+declare function createSarmal(
+  canvas: HTMLCanvasElement,
+  curveDef: CurveDef,
+  options?: SarmalOptions,
+): SarmalInstance;
 
-export { BaseRendererOptions, CurveDef, Engine, RendererOptions, type SVGRendererOptions, type SVGSarmalOptions, SarmalInstance, SarmalOptions, createEngine, createRenderer, createSVGRenderer, createSarmal, createSarmalSVG };
+export {
+  BaseRendererOptions,
+  CurveDef,
+  Engine,
+  RendererOptions,
+  type SVGRendererOptions,
+  type SVGSarmalOptions,
+  SarmalInstance,
+  SarmalOptions,
+  createEngine,
+  createRenderer,
+  createSVGRenderer,
+  createSarmal,
+  createSarmalSVG,
+  palettes,
+};