@sarmal/core 0.7.1 → 0.9.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2026 Sarmal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,93 @@
-# Sarmal Core
+# @sarmal/core
 
-## Publishing
+<p align="center">
+  <strong>Parametric curve animations for loading/thinking indicators</strong>
+</p>
+
+<p align="center">
+  <a href="https://sarmal.art" target="_blank">Live Demo at sarmal.art</a>
+</p>
+
+---
+
+**@sarmal/core** is a lightweight library for rendering elegant parametric curve animations.
+
+The animations can be used anywhere you want. Use it for loading spinners, progress indicators, or to indicate that your very special AI model is _thinking_, up to you.
+
+In web applications and perhaps also in the terminal maybe if possible!
+
+- **Canvas & SVG renderers**: choose one or the other, but why not both?
+- **standard curves**: default cliche curves any LLM can generate in seconds, from classic spirals to custom parametric paths
+- **TIME CONTROL**: programmatic time stepping, seeking, and trail effects
+- **Zero dependencies**: tiny bundle, quick to get started
+- **TypeScript-first**: because who would build anyhing complex in pure JS?!
+  - full type safety, but no assurance it will work in runtime!
+
+## Install
 
 ```bash
-npm publish --access public
+npm install @sarmal/core
+```
+
+Or use directly from CDN:
+
+```html
+<script type="module">
+  import { createSarmal, curves } from "https://cdn.jsdelivr.net/npm/@sarmal/core/+esm";
+  // your code here
+</script>
+```
+
+## Quick Start
+
+```javascript
+import { createSarmal, curves } from "@sarmal/core";
+
+const canvas = document.getElementById("my-canvas");
+const sarmal = createSarmal(canvas, curves.artemis2, {
+  trailLength: 30,
+  strokeStyle: "#00ffaa",
+  lineWidth: 2,
+});
+
+sarmal.start();
+```
+
+Or with **auto-init** without having to write any JS:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@sarmal/core/dist/auto-init.js"></script>
+<canvas data-sarmal="artemis2" width="200" height="200"></canvas>
 ```
+
+## Standard Curves
+
+| Name           | Description                                |
+| -------------- | ------------------------------------------ |
+| `artemis2`     | Artemis II free-return lunar trajectory    |
+| `epitrochoid7` | 7-lobed epitrochoid with dynamic variation |
+| `astroid`      | 4-cusped astroid                           |
+| `deltoid`      | 3-cusped deltoid                           |
+| `rose5`        | 5-petal rose curve                         |
+| `rose3`        | 3-petal rose curve                         |
+| `lissajous32`  | Lissajous 3:2 with live skeleton           |
+| `lissajous43`  | Lissajous 4:3 with live skeleton           |
+| `epicycloid3`  | 3-cusped epicycloid                        |
+| `lame`         | Lamé curve with live skeleton              |
+
+## Documentation
+
+Full API reference, examples, SVG renderer usage, engine time control (`seek`, `seekWithTrail`), custom curve definitions, and framework guides are available at [sarmal.art/docs](https://sarmal.art/docs)
+
+## Inspiration
+
+Inspired by [@bbssppllvv's tweet](https://x.com/bbssppllvv/status/2038718410318659763)
+
+## License
+
+MIT © [Alper Halil](https://aktasalper.com)
+
+## Links
+
+- [Homepage](https://sarmal.art): See all curves in action
+- [npm](https://www.npmjs.com/package/@sarmal/core): Package registry

package/dist/auto-init.cjs

@@ -188,21 +188,90 @@ function createEngine(curveDef, trailLength = 120) {
 // src/renderer.ts
 var DEFAULT_MORPH_DURATION_MS = 300;
 var DEFAULT_HEAD_RADIUS = 4;
-var DEFAULT_GLOW_SIZE = 20;
 var DEFAULT_SKELETON_COLOR = "#ffffff";
 var DEFAULT_SKELETON_OPACITY = 0.15;
 var FIT_PADDING = 0.1;
-var TRAIL_BATCH_SIZE = 20;
 var TRAIL_FADE_CURVE = 1.5;
 var TRAIL_MAX_OPACITY = 0.88;
 var TRAIL_MIN_WIDTH = 0.5;
 var TRAIL_MAX_WIDTH = 2.5;
-var GLOW_INNER_EDGE = 0.4;
-var GLOW_FALLOFF_OPACITY = 0.53;
+var GRADIENT = {
+  bard: ["#a855f7", "#3b82f6", "#14b8a6", "#ec4899"],
+  sunset: ["#f97316", "#dc2626", "#9333ea", "#f472b6"],
+  ocean: ["#1e3a8a", "#06b6d4", "#22d3ee", "#e0f2fe"],
+  ice: ["#1e3a8a", "#67e8f9"],
+  fire: ["#7f1d1d", "#fbbf24"],
+  forest: ["#14532d", "#86efac"]
+};
+var PRESETS = {
+  bard: GRADIENT.bard,
+  sunset: GRADIENT.sunset,
+  ocean: GRADIENT.ocean,
+  ice: GRADIENT.ice,
+  fire: GRADIENT.fire,
+  forest: GRADIENT.forest
+};
+function hexToRgb(hex) {
+  const n = parseInt(hex.slice(1), 16);
+  return { r: n >> 16, g: n >> 8 & 255, b: n & 255 };
+}
+var lerpRgb = (a, b, t) => ({
+  r: Math.round(a.r + (b.r - a.r) * t),
+  g: Math.round(a.g + (b.g - a.g) * t),
+  b: Math.round(a.b + (b.b - a.b) * t)
+});
+function getPaletteColor(palette, position, timeOffset = 0) {
+  if (palette.length === 0) return { r: 255, g: 255, b: 255 };
+  if (palette.length === 1) return hexToRgb(palette[0]);
+  const cyclePos = (position + timeOffset) % 1;
+  const scaled = cyclePos * palette.length;
+  const idx = Math.floor(scaled);
+  const t = scaled - idx;
+  const c1 = hexToRgb(palette[idx % palette.length]);
+  const c2 = hexToRgb(palette[(idx + 1) % palette.length]);
+  return lerpRgb(c1, c2, t);
+}
+function resolvePalette(palette, trailStyle) {
+  if (Array.isArray(palette)) return palette;
+  if (palette && palette in PRESETS) return PRESETS[palette];
+  return trailStyle === "gradient-animated" ? GRADIENT.bard : GRADIENT.ice;
+}
 function hexToRgbComponents(hex) {
   const n = parseInt(hex.slice(1), 16);
   return `${n >> 16},${n >> 8 & 255},${n & 255}`;
 }
+function computeTangent(trail, i) {
+  const count = trail.length;
+  if (count < 2) {
+    return { x: 1, y: 0 };
+  }
+  if (i === 0) {
+    const dx2 = trail[1].x - trail[0].x;
+    const dy2 = trail[1].y - trail[0].y;
+    const len2 = Math.sqrt(dx2 * dx2 + dy2 * dy2) || 1;
+    return { x: dx2 / len2, y: dy2 / len2 };
+  }
+  if (i === count - 1) {
+    const dx2 = trail[count - 1].x - trail[count - 2].x;
+    const dy2 = trail[count - 1].y - trail[count - 2].y;
+    const len2 = Math.sqrt(dx2 * dx2 + dy2 * dy2) || 1;
+    return { x: dx2 / len2, y: dy2 / len2 };
+  }
+  const dx = trail[i + 1].x - trail[i - 1].x;
+  const dy = trail[i + 1].y - trail[i - 1].y;
+  const len = Math.sqrt(dx * dx + dy * dy) || 1;
+  return { x: dx / len, y: dy / len };
+}
+function computeNormal(trail, i) {
+  const tangent = computeTangent(trail, i);
+  return { x: -tangent.y, y: tangent.x };
+}
+function applyDprSizing(target, logicalWidth, logicalHeight, dpr) {
+  target.style.width = `${logicalWidth}px`;
+  target.style.height = `${logicalHeight}px`;
+  target.width = logicalWidth * dpr;
+  target.height = logicalHeight * dpr;
+}
 function createRenderer(options) {
   const canvas = options.canvas;
   if (!canvas.getContext("2d")) {
@@ -214,11 +283,22 @@ function createRenderer(options) {
     skeletonColor: options.skeletonColor ?? DEFAULT_SKELETON_COLOR,
     trailColor: options.trailColor ?? "#ffffff",
     headColor: options.headColor ?? "#ffffff",
-    headRadius: options.headRadius ?? DEFAULT_HEAD_RADIUS,
-    glowSize: options.glowSize ?? DEFAULT_GLOW_SIZE
+    headRadius: options.headRadius ?? DEFAULT_HEAD_RADIUS
   };
+  const trailStyle = options.trailStyle ?? "default";
+  const palette = resolvePalette(options.palette, trailStyle);
   const trailRgb = hexToRgbComponents(opts.trailColor);
-  const headRgbFalloff = `rgba(${hexToRgbComponents(opts.headColor)},${GLOW_FALLOFF_OPACITY})`;
+  const dpr = typeof window !== "undefined" ? window.devicePixelRatio || 1 : 1;
+  function setupCanvas() {
+    const rect = canvas.getBoundingClientRect();
+    const lw = rect.width || 200;
+    const lh = rect.height || 200;
+    applyDprSizing(canvas, lw, lh, dpr);
+    ctx.setTransform(dpr, 0, 0, dpr, 0, 0);
+  }
+  setupCanvas();
+  let logicalWidth = canvas.width / dpr;
+  let logicalHeight = canvas.height / dpr;
   let skeleton = [];
   let skeletonCanvas = null;
   let trail = [];
@@ -232,6 +312,7 @@ function createRenderer(options) {
   let morphResolve = null;
   let morphDurationMs = DEFAULT_MORPH_DURATION_MS;
   let morphAlpha = 0;
+  let gradientAnimTime = 0;
   function computeBoundaries(pts) {
     if (pts.length === 0) return null;
     const first = pts[0];
@@ -244,17 +325,15 @@ function createRenderer(options) {
     }
     const width = maxX - minX;
     const height = maxY - minY;
-    const canvasWidth = canvas.width;
-    const canvasHeight = canvas.height;
-    const scaleX = canvasWidth / (width * (1 + FIT_PADDING * 2));
-    const scaleY = canvasHeight / (height * (1 + FIT_PADDING * 2));
+    const scaleX = logicalWidth / (width * (1 + FIT_PADDING * 2));
+    const scaleY = logicalHeight / (height * (1 + FIT_PADDING * 2));
     const s = Math.min(scaleX, scaleY);
     const boundsWidth = width * s;
     const boundsHeight = height * s;
     return {
       scale: s,
-      offsetX: (canvasWidth - boundsWidth) / 2 - minX * s,
-      offsetY: (canvasHeight - boundsHeight) / 2 - minY * s
+      offsetX: (logicalWidth - boundsWidth) / 2 - minX * s,
+      offsetY: (logicalHeight - boundsHeight) / 2 - minY * s
     };
   }
   function calculateBoundaries() {
@@ -269,6 +348,7 @@ function createRenderer(options) {
     if (skeleton.length < 2) return;
     skeletonCanvas = new OffscreenCanvas(canvas.width, canvas.height);
     const skeletonCtx = skeletonCanvas.getContext("2d");
+    skeletonCtx.setTransform(dpr, 0, 0, dpr, 0, 0);
     skeletonCtx.strokeStyle = `rgba(${hexToRgbComponents(opts.skeletonColor)},${DEFAULT_SKELETON_OPACITY})`;
     skeletonCtx.lineWidth = 1.5;
     skeletonCtx.beginPath();
@@ -314,32 +394,47 @@ function createRenderer(options) {
       }
       ctx.stroke();
     } else if (skeletonCanvas) {
-      ctx.drawImage(skeletonCanvas, 0, 0);
+      ctx.drawImage(skeletonCanvas, 0, 0, logicalWidth, logicalHeight);
     }
   }
   function drawTrail() {
     if (trailCount < 2) {
       return;
     }
-    ctx.lineJoin = "round";
-    ctx.lineCap = "round";
-    for (let batchIndex = 0; batchIndex < trailCount - 1; batchIndex += TRAIL_BATCH_SIZE) {
-      const bEnd = Math.min(batchIndex + TRAIL_BATCH_SIZE, trailCount - 1);
-      const progress = (batchIndex + bEnd) / 2 / (trailCount - 1);
+    for (let i = 0; i < trailCount - 1; i++) {
+      const progress = i / (trailCount - 1);
+      const nextProgress = (i + 1) / (trailCount - 1);
       const alpha = Math.pow(progress, TRAIL_FADE_CURVE) * TRAIL_MAX_OPACITY;
-      const lineWidth = TRAIL_MIN_WIDTH + progress * (TRAIL_MAX_WIDTH - TRAIL_MIN_WIDTH);
-      ctx.beginPath();
-      for (let i = batchIndex; i <= bEnd; i++) {
-        const point = trail[i];
-        if (i === batchIndex) {
-          ctx.moveTo(point.x * scale + offsetX, point.y * scale + offsetY);
-        } else {
-          ctx.lineTo(point.x * scale + offsetX, point.y * scale + offsetY);
-        }
+      const width = TRAIL_MIN_WIDTH + progress * (TRAIL_MAX_WIDTH - TRAIL_MIN_WIDTH);
+      const nextWidth = TRAIL_MIN_WIDTH + nextProgress * (TRAIL_MAX_WIDTH - TRAIL_MIN_WIDTH);
+      const curr = trail[i];
+      const next = trail[i + 1];
+      const n0 = computeNormal(trail, i);
+      const n1 = computeNormal(trail, i + 1);
+      const halfW0 = width / 2;
+      const halfW1 = nextWidth / 2;
+      const l0x = curr.x * scale + offsetX + n0.x * halfW0;
+      const l0y = curr.y * scale + offsetY + n0.y * halfW0;
+      const r0x = curr.x * scale + offsetX - n0.x * halfW0;
+      const r0y = curr.y * scale + offsetY - n0.y * halfW0;
+      const l1x = next.x * scale + offsetX + n1.x * halfW1;
+      const l1y = next.y * scale + offsetY + n1.y * halfW1;
+      const r1x = next.x * scale + offsetX - n1.x * halfW1;
+      const r1y = next.y * scale + offsetY - n1.y * halfW1;
+      if (trailStyle === "default") {
+        ctx.fillStyle = `rgba(${trailRgb},${alpha})`;
+      } else {
+        const timeOffset = trailStyle === "gradient-animated" ? gradientAnimTime * 5e-4 : 0;
+        const color = getPaletteColor(palette, progress, timeOffset);
+        ctx.fillStyle = `rgba(${color.r},${color.g},${color.b},${alpha})`;
       }
-      ctx.strokeStyle = `rgba(${trailRgb},${alpha})`;
-      ctx.lineWidth = lineWidth;
-      ctx.stroke();
+      ctx.beginPath();
+      ctx.moveTo(l0x, l0y);
+      ctx.lineTo(l1x, l1y);
+      ctx.lineTo(r1x, r1y);
+      ctx.lineTo(r0x, r0y);
+      ctx.closePath();
+      ctx.fill();
     }
   }
   function drawHead() {
@@ -348,14 +443,6 @@ function createRenderer(options) {
     }
     const x = head.x * scale + offsetX;
     const y = head.y * scale + offsetY;
-    const gradient = ctx.createRadialGradient(x, y, 0, x, y, opts.glowSize);
-    gradient.addColorStop(0, opts.headColor);
-    gradient.addColorStop(GLOW_INNER_EDGE, headRgbFalloff);
-    gradient.addColorStop(1, "transparent");
-    ctx.fillStyle = gradient;
-    ctx.beginPath();
-    ctx.arc(x, y, opts.glowSize, 0, Math.PI * 2);
-    ctx.fill();
     ctx.fillStyle = opts.headColor;
     ctx.beginPath();
     ctx.arc(x, y, opts.headRadius, 0, Math.PI * 2);
@@ -365,6 +452,9 @@ function createRenderer(options) {
     const now = performance.now();
     const deltaTime = Math.min((now - lastTime) / 1e3, 1 / 30);
     lastTime = now;
+    if (trailStyle === "gradient-animated") {
+      gradientAnimTime += deltaTime * 1e3;
+    }
     if (engine.morphAlpha !== null) {
       morphAlpha = Math.min(1, morphAlpha + deltaTime / (morphDurationMs / 1e3));
       engine.setMorphAlpha(morphAlpha);
@@ -389,7 +479,7 @@ function createRenderer(options) {
     trail = engine.tick(deltaTime);
     trailCount = engine.trailCount;
     head = trailCount > 0 ? trail[trailCount - 1] : null;
-    ctx.clearRect(0, 0, canvas.width, canvas.height);
+    ctx.clearRect(0, 0, logicalWidth, logicalHeight);
     if (engine.isLiveSkeleton && engine.morphAlpha === null) {
       skeleton = engine.getSarmalSkeleton();
       calculateBoundaries();
@@ -625,7 +715,6 @@ function init() {
       ...canvas.dataset.skeletonColor && { skeletonColor: canvas.dataset.skeletonColor },
       ...canvas.dataset.headColor && { headColor: canvas.dataset.headColor },
       ...canvas.dataset.headRadius && { headRadius: parseFloat(canvas.dataset.headRadius) },
-      ...canvas.dataset.glowSize && { glowSize: parseInt(canvas.dataset.glowSize, 10) },
       ...canvas.dataset.trailLength && { trailLength: parseInt(canvas.dataset.trailLength, 10) }
     });
     sarmal.start();