@multitrack/core 0.1.0 → 0.1.1

package/dist/middleware-DQus4IrE.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Easing function: takes a progress value (0-1) and returns an eased value (0-1).
+ */
+type EasingFunction = (t: number) => number;
+/**
+ * Built-in easing preset names.
+ */
+type EasingPreset = "snap" | "linear" | "easeIn" | "easeOut" | "easeInOut";
+/**
+ * User-provided step configuration. Declarative — consumers define animations
+ * as data, not imperative code.
+ *
+ * Inspired by video editing: each step occupies a duration on a named track.
+ */
+interface StepConfig {
+    /** Unique identifier for this step. Use "buffer" for spacers (auto-renamed). */
+    name: string;
+    /** How many viewport-heights this step lasts. */
+    duration: number;
+    /** Which timeline track this step belongs to. */
+    track: string;
+    /** Easing for opacity transitions. Defaults to "snap" (binary 0 or 1). */
+    easing?: EasingPreset | EasingFunction;
+    /** Optional predicate — if provided, step is only included when this returns true. */
+    condition?: () => boolean;
+    /** Named breakpoint this step belongs to. Only included when that breakpoint matches. */
+    when?: string;
+}
+/**
+ * A step with computed absolute positions on the timeline.
+ * Produced by `resolveSteps()` from user-provided `StepConfig[]`.
+ */
+interface Step {
+    name: string;
+    start: number;
+    end: number;
+    track: string;
+    easing: EasingPreset | EasingFunction;
+}
+/**
+ * Maps step names to their current opacity (0-1).
+ * Generic so TypeScript can infer step names from user config.
+ */
+type Opacities<T extends string = string> = Record<T, number>;
+interface StepEventPayload {
+    name: string;
+    track: string;
+    start: number;
+    end: number;
+}
+interface ScrollEventPayload {
+    scrollPercentage: number;
+    currentStep: number;
+}
+interface ReconfigureEventPayload {
+    steps: Step[];
+    totalSteps: number;
+}
+interface TimelineEventMap {
+    "step:enter": StepEventPayload;
+    "step:exit": StepEventPayload;
+    scroll: ScrollEventPayload;
+    "timeline:reconfigure": ReconfigureEventPayload;
+}
+type TimelineEventType = keyof TimelineEventMap;
+type TimelineEventHandler<T extends TimelineEventType> = (payload: TimelineEventMap[T]) => void;
+interface ScrollDriverOptions {
+    /** Element to listen for scroll events on. Defaults to `window`. */
+    target?: HTMLElement | Window;
+}
+interface TimelineOptions<T extends string = string> {
+    config: StepConfig[];
+    /** Enable devtools integration (exposes state on window.__MULTITRACK_DEVTOOLS__) */
+    devtools?: boolean;
+    /** Named breakpoints mapping to CSS media queries for responsive step inclusion. */
+    breakpoints?: Record<string, string>;
+}
+interface DevtoolsState {
+    steps: Step[];
+    currentStep: number;
+    totalSteps: number;
+    opacities: Opacities;
+    scrollPercentage: number;
+}
+
+/**
+ * Event passed to middleware functions during step transitions.
+ */
+interface MiddlewareEvent {
+    type: "step:enter" | "step:exit";
+    payload: StepEventPayload;
+}
+/**
+ * Middleware function signature.
+ * Call `next()` to continue the chain; skip it to swallow the event.
+ */
+type MiddlewareFn = (event: MiddlewareEvent, next: () => void) => void;
+
+export type { DevtoolsState as D, EasingFunction as E, MiddlewareFn as M, Opacities as O, ReconfigureEventPayload as R, Step as S, TimelineOptions as T, TimelineEventType as a, TimelineEventHandler as b, ScrollDriverOptions as c, StepConfig as d, EasingPreset as e, TimelineEventMap as f, MiddlewareEvent as g, ScrollEventPayload as h, StepEventPayload as i };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multitrack/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A scroll-driven animation engine with multi-track timeline architecture",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -16,6 +16,16 @@
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
+    },
+    "./analytics": {
+      "import": {
+        "types": "./dist/analytics.d.ts",
+        "default": "./dist/analytics.js"
+      },
+      "require": {
+        "types": "./dist/analytics.d.cts",
+        "default": "./dist/analytics.cjs"
+      }
     }
   },
   "files": [
@@ -45,7 +55,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "scripts": {
     "build": "tsup",