@walkrstudio/core 0.2.0

package/README.md

@@ -0,0 +1,169 @@
+# 🚶 Walkr Core
+
+**Code-first product demo tool**
+
+`@walkr/core` is the TypeScript API for describing cursor-driven walkthroughs.
+
+## Install
+
+```bash
+pnpm add @walkr/core
+```
+
+## Quick Start
+
+```ts
+import { walkr, moveTo, click, type, highlight, sequence } from "@walkr/core";
+
+export default walkr({
+  url: "https://example.com",
+  title: "Sign up flow",
+  steps: [
+    moveTo(640, 400, { duration: 800 }),
+    click(640, 400),
+    type("hello@example.com", { selector: "input[name=email]" }),
+    highlight(".submit-btn", { spotlight: true, color: "#22d3ee", duration: 1200 }),
+    sequence(
+      moveTo(800, 500),
+      click(800, 500),
+    ),
+  ],
+});
+```
+
+## Step API
+
+| Function | Signature | Description | Duration behavior |
+| --- | --- | --- | --- |
+| `moveTo` | `moveTo(x, y, options?)` | Move cursor to screen coordinates. | `options.duration ?? 0` |
+| `click` | `click(x, y, options?)` | Click at coordinates. Supports button/double-click. | `0` |
+| `type` | `type(text, options?)` | Type text, optionally into a selector. | `text.length * (options.delay ?? 0)` |
+| `scroll` | `scroll(x, y, options?)` | Scroll viewport to coordinates. | `0` |
+| `wait` | `wait(ms)` | Pause timeline. | `ms` |
+| `highlight` | `highlight(selector, options?)` | Highlight a target selector. | `options.duration ?? 0` |
+| `zoom` | `zoom(level, options?)` | Zoom viewport/camera. | `360` |
+| `pan` | `pan(x, y, options?)` | Pan viewport/camera. | `options.duration ?? 360` |
+| `sequence` | `sequence(...steps)` | Run child steps one after another. | Sum of child durations |
+| `parallel` | `parallel(...steps)` | Run child steps at same time. | Max child duration |
+
+## Options By Step
+
+### `moveTo(x, y, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `duration` | `number` | `0` | Movement duration in ms. |
+| `easing` | `string` | `undefined` | CSS easing string. |
+| `follow` | `boolean` | `undefined` | Keep following moving target if supported by runtime. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `click(x, y, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `button` | `"left" \| "right" \| "middle"` | `"left"` | Mouse button. |
+| `double` | `boolean` | `false` | Double-click if `true`. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `type(text, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `delay` | `number` | `undefined` | Per-character delay in ms. |
+| `selector` | `string` | `undefined` | Target selector for runtime typing. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `scroll(x, y, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `smooth` | `boolean` | `undefined` | Smooth scrolling hint for runtime. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `wait(ms)`
+
+`wait` only accepts the required `ms: number` value.
+
+### `highlight(selector, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `color` | `string` | `undefined` | Highlight color. |
+| `duration` | `number` | `undefined` | Highlight duration in ms. |
+| `spotlight` | `boolean` | `undefined` | Enable spotlight effect. |
+| `backdropOpacity` | `number` | `undefined` | Backdrop dim amount. |
+| `borderRadius` | `number` | `undefined` | Radius of highlight frame. |
+| `padding` | `number` | `undefined` | Padding around target. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `zoom(level, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `x` | `number` | `undefined` | Zoom anchor X. |
+| `y` | `number` | `undefined` | Zoom anchor Y. |
+| `easing` | `string` | `"cubic-bezier(0.42, 0, 0.58, 1)"` | Transition easing. |
+| `follow` | `boolean` | `undefined` | Follow target during zoom if runtime supports it. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `pan(x, y, options?)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `duration` | `number` | `360` | Pan duration in ms. |
+| `easing` | `string` | `"cubic-bezier(0.42, 0, 0.58, 1)"` | Transition easing. |
+| `cursor` | `Partial<CursorConfig>` | `undefined` | Per-step cursor override. |
+
+### `sequence(...steps)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `steps` | `Step[]` | required | Child steps run in order. |
+
+### `parallel(...steps)`
+
+| Option | Type | Default | Notes |
+| --- | --- | --- | --- |
+| `steps` | `Step[]` | required | Child steps run concurrently. |
+
+## `CursorConfig`
+
+```ts
+interface CursorConfig {
+  shape?: "circle" | "arrow" | "dot" | "svg";
+  color?: string;
+  size?: number;
+  shadow?: boolean;
+  clickColor?: string;
+  svgContent?: string;
+}
+```
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `shape` | `"circle" \| "arrow" \| "dot" \| "svg"` | Cursor style. |
+| `color` | `string` | Base cursor color. |
+| `size` | `number` | Cursor size in px. |
+| `shadow` | `boolean` | Enables drop shadow. |
+| `clickColor` | `string` | Click flash color. |
+| `svgContent` | `string` | Raw SVG markup when `shape: "svg"`. |
+
+## Walkthrough Options
+
+`walkr(options)` accepts:
+
+| Option | Type | Required | Description |
+| --- | --- | --- | --- |
+| `url` | `string` | yes | Target URL to load. |
+| `steps` | `Step[]` | yes | Timeline step list. |
+| `title` | `string` | no | Human-readable demo title. |
+| `description` | `string` | no | Optional demo description. |
+| `zoom` | `ZoomDefaults` | no | Global zoom defaults. |
+| `cursor` | `CursorConfig` | no | Global cursor config. |
+
+`ZoomDefaults`:
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `defaultLevel` | `number` | Default zoom level. |
+| `easing` | `string` | Default zoom easing. |

package/dist/composers.d.ts

@@ -0,0 +1,4 @@
+import type { ParallelStep, SequenceStep, Step } from "./types.js";
+export declare function sequence(...steps: Step[]): SequenceStep;
+export declare function parallel(...steps: Step[]): ParallelStep;
+//# sourceMappingURL=composers.d.ts.map

package/dist/composers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"composers.d.ts","sourceRoot":"","sources":["../src/composers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAEZ,YAAY,EAEZ,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,wBAAgB,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,YAAY,CAIvD;AAED,wBAAgB,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,YAAY,CAIvD"}

package/dist/composers.js

@@ -0,0 +1,12 @@
+import { createStep } from "./steps.js";
+export function sequence(...steps) {
+    const stepOptions = { steps: [...steps] };
+    const duration = steps.reduce((total, step) => total + step.duration, 0);
+    return createStep("sequence", stepOptions, duration);
+}
+export function parallel(...steps) {
+    const stepOptions = { steps: [...steps] };
+    const duration = steps.reduce((maxDuration, step) => Math.max(maxDuration, step.duration), 0);
+    return createStep("parallel", stepOptions, duration);
+}
+//# sourceMappingURL=composers.js.map

package/dist/composers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"composers.js","sourceRoot":"","sources":["../src/composers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AASxC,MAAM,UAAU,QAAQ,CAAC,GAAG,KAAa;IACvC,MAAM,WAAW,GAAwB,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC;IAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACzE,OAAO,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAG,KAAa;IACvC,MAAM,WAAW,GAAwB,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC;IAC/D,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9F,OAAO,UAAU,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import type { Walkthrough, WalkthroughOptions } from "./types.js";
+export declare const VERSION = "0.1.0";
+export declare function walkr(options: WalkthroughOptions): Walkthrough;
+export * from "./composers.js";
+export * from "./steps.js";
+export type { CursorConfig } from "./types.js";
+export * from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAElE,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,wBAAgB,KAAK,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAW9D;AAED,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+export const VERSION = "0.1.0";
+export function walkr(options) {
+    const { url, steps, title, description, zoom, cursor, viewport } = options;
+    return {
+        url,
+        steps: [...steps],
+        title,
+        description,
+        zoom,
+        cursor,
+        viewport,
+    };
+}
+export * from "./composers.js";
+export * from "./steps.js";
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC;AAE/B,MAAM,UAAU,KAAK,CAAC,OAA2B;IAC/C,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC3E,OAAO;QACL,GAAG;QACH,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC;QACjB,KAAK;QACL,WAAW;QACX,IAAI;QACJ,MAAM;QACN,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC"}

package/dist/steps.d.ts

@@ -0,0 +1,15 @@
+import type { ClearCacheStep, ClickCoordsStep, ClickOptions, ClickStep, HighlightOptions, HighlightStep, MoveToCoordsStep, MoveToOptions, MoveToStep, PanOptions, PanStep, PanStepOptions, ScrollOptions, ScrollStep, Step, StepType, TypeOptions, TypeStep, WaitStep, ZoomOptions, ZoomStep, ZoomStepOptions } from "./types.js";
+export declare function createStep<TType extends StepType, TOptions extends {}>(type: TType, options: TOptions, duration?: number): Step<TType, TOptions>;
+export declare function moveTo(selector: string, options?: MoveToOptions): MoveToStep;
+export declare function moveToCoords(x: number, y: number, options?: MoveToOptions): MoveToCoordsStep;
+export declare function click(selector: string, options?: ClickOptions): ClickStep;
+export declare function clickCoords(x: number, y: number, options?: ClickOptions): ClickCoordsStep;
+export declare function type(text: string, options?: TypeOptions): TypeStep;
+export declare function scroll(x: number, y: number, options?: ScrollOptions): ScrollStep;
+export declare function wait(ms: number): WaitStep;
+export declare function highlight(selector: string, options?: HighlightOptions): HighlightStep;
+export declare function zoom(level: number, options?: ZoomOptions): ZoomStep;
+export declare function pan(x: number, y: number, options?: PanOptions): PanStep;
+export declare function clearCache(): ClearCacheStep;
+export type { PanStepOptions, ZoomStepOptions };
+//# sourceMappingURL=steps.d.ts.map

package/dist/steps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"steps.d.ts","sourceRoot":"","sources":["../src/steps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EAEd,eAAe,EAEf,YAAY,EACZ,SAAS,EAET,gBAAgB,EAChB,aAAa,EAEb,gBAAgB,EAEhB,aAAa,EACb,UAAU,EAEV,UAAU,EACV,OAAO,EACP,cAAc,EACd,aAAa,EACb,UAAU,EAEV,IAAI,EACJ,QAAQ,EACR,WAAW,EACX,QAAQ,EAER,QAAQ,EAER,WAAW,EACX,QAAQ,EACR,eAAe,EAChB,MAAM,YAAY,CAAC;AASpB,wBAAgB,UAAU,CACxB,KAAK,SAAS,QAAQ,EAEtB,QAAQ,SAAS,EAAE,EACnB,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,SAAI,GAAG,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAQrE;AAED,wBAAgB,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,UAAU,CAGhF;AAED,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,gBAAgB,CAGhG;AAED,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,SAAS,CAO7E;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,eAAe,CAQ7F;AAED,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,QAAQ,CAItE;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,UAAU,CAGpF;AAED,wBAAgB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,QAAQ,CAGzC;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,aAAa,CAYzF;AAED,wBAAgB,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,WAAgB,GAAG,QAAQ,CAOvE;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAS3E;AAED,wBAAgB,UAAU,IAAI,cAAc,CAG3C;AAED,YAAY,EAAE,cAAc,EAAE,eAAe,EAAE,CAAC"}

package/dist/steps.js

@@ -0,0 +1,89 @@
+let stepCounter = 0;
+const DEFAULT_CLICK_DURATION = 50;
+const DEFAULT_ZOOM_DURATION = 360;
+const DEFAULT_PAN_DURATION = 360;
+const DEFAULT_CLEAR_CACHE_DURATION = 50;
+const DEFAULT_EASING = "cubic-bezier(0.42, 0, 0.58, 1)";
+export function createStep(type, options, duration = 0) {
+    stepCounter += 1;
+    return {
+        id: `${type}_${stepCounter}`,
+        type,
+        options,
+        duration,
+    };
+}
+export function moveTo(selector, options = {}) {
+    const stepOptions = { selector, ...options };
+    return createStep("moveTo", stepOptions, options.duration ?? 0);
+}
+export function moveToCoords(x, y, options = {}) {
+    const stepOptions = { x, y, ...options };
+    return createStep("moveToCoords", stepOptions, options.duration ?? 0);
+}
+export function click(selector, options = {}) {
+    const stepOptions = {
+        selector,
+        button: options.button ?? "left",
+        double: options.double ?? false,
+    };
+    return createStep("click", stepOptions, DEFAULT_CLICK_DURATION);
+}
+export function clickCoords(x, y, options = {}) {
+    const stepOptions = {
+        x,
+        y,
+        button: options.button ?? "left",
+        double: options.double ?? false,
+    };
+    return createStep("clickCoords", stepOptions, DEFAULT_CLICK_DURATION);
+}
+export function type(text, options = {}) {
+    const stepOptions = { text, ...options };
+    const duration = text.length * (options.delay ?? 0);
+    return createStep("type", stepOptions, duration);
+}
+export function scroll(x, y, options = {}) {
+    const stepOptions = { x, y, ...options };
+    return createStep("scroll", stepOptions, 0);
+}
+export function wait(ms) {
+    const stepOptions = { ms };
+    return createStep("wait", stepOptions, ms);
+}
+export function highlight(selector, options = {}) {
+    const stepOptions = {
+        selector,
+        color: options.color,
+        duration: options.duration,
+        spotlight: options.spotlight,
+        backdropOpacity: options.backdropOpacity,
+        borderRadius: options.borderRadius,
+        padding: options.padding,
+        cursor: options.cursor,
+    };
+    return createStep("highlight", stepOptions, options.duration ?? 0);
+}
+export function zoom(level, options = {}) {
+    const stepOptions = {
+        level,
+        easing: options.easing ?? DEFAULT_EASING,
+        ...options,
+    };
+    return createStep("zoom", stepOptions, DEFAULT_ZOOM_DURATION);
+}
+export function pan(x, y, options = {}) {
+    const stepOptions = {
+        x,
+        y,
+        duration: options.duration ?? DEFAULT_PAN_DURATION,
+        easing: options.easing ?? DEFAULT_EASING,
+        ...options,
+    };
+    return createStep("pan", stepOptions, stepOptions.duration ?? DEFAULT_PAN_DURATION);
+}
+export function clearCache() {
+    const stepOptions = {};
+    return createStep("clearCache", stepOptions, DEFAULT_CLEAR_CACHE_DURATION);
+}
+//# sourceMappingURL=steps.js.map

package/dist/steps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"steps.js","sourceRoot":"","sources":["../src/steps.ts"],"names":[],"mappings":"AAkCA,IAAI,WAAW,GAAG,CAAC,CAAC;AACpB,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAClC,MAAM,oBAAoB,GAAG,GAAG,CAAC;AACjC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,cAAc,GAAG,gCAAgC,CAAC;AAExD,MAAM,UAAU,UAAU,CAIxB,IAAW,EAAE,OAAiB,EAAE,QAAQ,GAAG,CAAC;IAC5C,WAAW,IAAI,CAAC,CAAC;IACjB,OAAO;QACL,EAAE,EAAE,GAAG,IAAI,IAAI,WAAW,EAAE;QAC5B,IAAI;QACJ,OAAO;QACP,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,QAAgB,EAAE,UAAyB,EAAE;IAClE,MAAM,WAAW,GAAsB,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IAChE,OAAO,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,CAAS,EAAE,CAAS,EAAE,UAAyB,EAAE;IAC5E,MAAM,WAAW,GAA4B,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;IAClE,OAAO,UAAU,CAAC,cAAc,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,QAAgB,EAAE,UAAwB,EAAE;IAChE,MAAM,WAAW,GAAqB;QACpC,QAAQ;QACR,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,MAAM;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;KAChC,CAAC;IACF,OAAO,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAS,EAAE,CAAS,EAAE,UAAwB,EAAE;IAC1E,MAAM,WAAW,GAA2B;QAC1C,CAAC;QACD,CAAC;QACD,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,MAAM;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;KAChC,CAAC;IACF,OAAO,UAAU,CAAC,aAAa,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,IAAY,EAAE,UAAuB,EAAE;IAC1D,MAAM,WAAW,GAAoB,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;IAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IACpD,OAAO,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,CAAS,EAAE,CAAS,EAAE,UAAyB,EAAE;IACtE,MAAM,WAAW,GAAsB,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC;IAC5D,OAAO,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,EAAU;IAC7B,MAAM,WAAW,GAAoB,EAAE,EAAE,EAAE,CAAC;IAC5C,OAAO,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,QAAgB,EAAE,UAA4B,EAAE;IACxE,MAAM,WAAW,GAAyB;QACxC,QAAQ;QACR,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;QACxC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC;IACF,OAAO,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,KAAa,EAAE,UAAuB,EAAE;IAC3D,MAAM,WAAW,GAAoB;QACnC,KAAK;QACL,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,cAAc;QACxC,GAAG,OAAO;KACX,CAAC;IACF,OAAO,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,qBAAqB,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,UAAsB,EAAE;IAChE,MAAM,WAAW,GAAmB;QAClC,CAAC;QACD,CAAC;QACD,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,oBAAoB;QAClD,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,cAAc;QACxC,GAAG,OAAO;KACX,CAAC;IACF,OAAO,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,QAAQ,IAAI,oBAAoB,CAAC,CAAC;AACtF,CAAC;AAED,MAAM,UAAU,UAAU;IACxB,MAAM,WAAW,GAA0B,EAAE,CAAC;IAC9C,OAAO,UAAU,CAAC,YAAY,EAAE,WAAW,EAAE,4BAA4B,CAAC,CAAC;AAC7E,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,139 @@
+export interface Viewport {
+    width: number;
+    height: number;
+}
+export type MouseButton = "left" | "right" | "middle";
+export type StepType = "moveTo" | "moveToCoords" | "click" | "clickCoords" | "type" | "scroll" | "wait" | "highlight" | "zoom" | "pan" | "sequence" | "parallel" | "clearCache";
+export interface CursorConfig {
+    shape?: "circle" | "arrow" | "dot" | "svg";
+    color?: string;
+    size?: number;
+    shadow?: boolean;
+    clickColor?: string;
+    svgContent?: string;
+    /** Hotspot offset as a fraction of cursor size (0–1). Default: center {x:0.5,y:0.5}. */
+    offset?: {
+        x: number;
+        y: number;
+    };
+}
+export interface ZoomDefaults {
+    defaultLevel?: number;
+    easing?: string;
+}
+export interface StepCursorOverride {
+    cursor?: Partial<CursorConfig>;
+}
+export interface MoveToOptions extends StepCursorOverride {
+    duration?: number;
+    easing?: string;
+    follow?: boolean;
+}
+export interface MoveToStepOptions extends MoveToOptions {
+    selector: string;
+}
+export interface MoveToCoordsStepOptions extends MoveToOptions {
+    x: number;
+    y: number;
+}
+export interface ClickOptions extends StepCursorOverride {
+    button?: MouseButton;
+    double?: boolean;
+}
+export interface ClickStepOptions extends ClickOptions {
+    selector: string;
+}
+export interface ClickCoordsStepOptions extends ClickOptions {
+    x: number;
+    y: number;
+}
+export interface TypeOptions extends StepCursorOverride {
+    delay?: number;
+    selector?: string;
+}
+export interface TypeStepOptions extends TypeOptions {
+    text: string;
+}
+export interface ScrollOptions extends StepCursorOverride {
+    smooth?: boolean;
+}
+export interface ScrollStepOptions extends ScrollOptions {
+    x: number;
+    y: number;
+}
+export interface WaitStepOptions extends StepCursorOverride {
+    ms: number;
+}
+export interface HighlightOptions extends StepCursorOverride {
+    color?: string;
+    duration?: number;
+    spotlight?: boolean;
+    backdropOpacity?: number;
+    borderRadius?: number;
+    padding?: number;
+}
+export interface HighlightStepOptions extends HighlightOptions {
+    selector: string;
+}
+export interface ZoomOptions extends StepCursorOverride {
+    x?: number;
+    y?: number;
+    easing?: string;
+    follow?: boolean;
+}
+export interface ZoomStepOptions extends ZoomOptions {
+    level: number;
+}
+export interface PanOptions extends StepCursorOverride {
+    duration?: number;
+    easing?: string;
+}
+export interface PanStepOptions extends PanOptions {
+    x: number;
+    y: number;
+}
+export interface SequenceStepOptions extends StepCursorOverride {
+    steps: Step[];
+}
+export interface ParallelStepOptions extends StepCursorOverride {
+    steps: Step[];
+}
+export type ClearCacheStepOptions = {};
+export interface Step<TType extends StepType = StepType, TOptions extends {} = {}> {
+    id: string;
+    type: TType;
+    options: TOptions;
+    duration: number;
+}
+export type MoveToStep = Step<"moveTo", MoveToStepOptions>;
+export type MoveToCoordsStep = Step<"moveToCoords", MoveToCoordsStepOptions>;
+export type ClickStep = Step<"click", ClickStepOptions>;
+export type ClickCoordsStep = Step<"clickCoords", ClickCoordsStepOptions>;
+export type TypeStep = Step<"type", TypeStepOptions>;
+export type ScrollStep = Step<"scroll", ScrollStepOptions>;
+export type WaitStep = Step<"wait", WaitStepOptions>;
+export type HighlightStep = Step<"highlight", HighlightStepOptions>;
+export type ZoomStep = Step<"zoom", ZoomStepOptions>;
+export type PanStep = Step<"pan", PanStepOptions>;
+export type SequenceStep = Step<"sequence", SequenceStepOptions>;
+export type ParallelStep = Step<"parallel", ParallelStepOptions>;
+export type ClearCacheStep = Step<"clearCache", ClearCacheStepOptions>;
+export interface Walkthrough {
+    url: string;
+    steps: Step[];
+    title?: string;
+    description?: string;
+    zoom?: ZoomDefaults;
+    cursor?: CursorConfig;
+    viewport?: Viewport;
+}
+export interface WalkthroughOptions {
+    url: string;
+    steps: Step[];
+    title?: string;
+    description?: string;
+    zoom?: ZoomDefaults;
+    cursor?: CursorConfig;
+    viewport?: Viewport;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEtD,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,cAAc,GACd,OAAO,GACP,aAAa,GACb,MAAM,GACN,QAAQ,GACR,MAAM,GACN,WAAW,GACX,MAAM,GACN,KAAK,GACL,UAAU,GACV,UAAU,GACV,YAAY,CAAC;AAEjB,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,CAAC;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wFAAwF;IACxF,MAAM,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;CACnC;AAED,MAAM,WAAW,YAAY;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY;IAC1D,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,eAAgB,SAAQ,kBAAkB;IACzD,EAAE,EAAE,MAAM,CAAC;CACZ;AAED,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAGD,MAAM,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAGvC,MAAM,WAAW,IAAI,CAAC,KAAK,SAAS,QAAQ,GAAG,QAAQ,EAAE,QAAQ,SAAS,EAAE,GAAG,EAAE;IAC/E,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;IACZ,OAAO,EAAE,QAAQ,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AAC3D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,cAAc,EAAE,uBAAuB,CAAC,CAAC;AAC7E,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AACxD,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,EAAE,sBAAsB,CAAC,CAAC;AAC1E,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;AAC3D,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,EAAE,oBAAoB,CAAC,CAAC;AACpE,MAAM,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACrD,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;AAClD,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;AACjE,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;AACjE,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC;AAEvE,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@walkrstudio/core",
+  "version": "0.2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "biome check src",
+    "type-check": "tsc -p tsconfig.json --noEmit",
+    "dev": "tsc -p tsconfig.json --watch"
+  }
+}