@pixodesk/svg-animator-web 1.0.43 → 1.0.44

package/dist/index.cjs

@@ -60,7 +60,9 @@ __export(index_exports, {
   createAdapterAnimator: () => createAdapterAnimator,
   createAnimator: () => createAnimator,
   generateNewIds: () => generateNewIds,
+  getAllAnimators: () => getAllAnimators,
   loadTagAnimators: () => loadTagAnimators,
+  onAnimatorsChange: () => onAnimatorsChange,
   px: () => px,
   renderNode: () => renderNode,
   setupAnimationTriggers: () => setupAnimationTriggers,
@@ -69,7 +71,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// ../svg-animator-core/dist/chunk-BOTZI36B.js
+// ../svg-animator-core/dist/chunk-EFQLDGFY.js
 var __defProp2 = Object.defineProperty;
 var __defProps2 = Object.defineProperties;
 var __getOwnPropDescs2 = Object.getOwnPropertyDescriptors;
@@ -603,7 +605,7 @@ var px = {
   /** Defers schema creation — required for recursive types. Must supply a default value. */
   lazy: (fn, defaultVal) => new Lazy(fn, defaultVal)
 };
-var PX_WIRE_SCHEMA_VERSION = "1.1";
+var PX_WIRE_SCHEMA_VERSION = "1.2";
 var VERSION_RE = /^(\d+)\.(\d+)(?:\.(\d+))?$/;
 function parseWireVersion(raw) {
   if (typeof raw !== "string") return void 0;
@@ -627,14 +629,18 @@ var PxPlaybackDirection = {
 };
 var PX_ANIM_SRC_ATTR_NAME = "data-px-animation-src";
 var PX_ANIM_ATTR_NAME = "_px_animator";
-var PxStartOn = {
+var PxTriggerStart = {
   load: "load",
   mouseOver: "mouseOver",
   click: "click",
-  scrollIntoView: "scrollIntoView",
-  programmatic: "programmatic"
+  none: "none"
+};
+var PxOffScreenAction = {
+  pause: "pause",
+  continue: "continue",
+  reset: "reset"
 };
-var PxOutAction = {
+var PxMouseOutAction = {
   continue: "continue",
   pause: "pause",
   reset: "reset",
@@ -702,16 +708,20 @@ function mayUseNativeScrollTimeline(engine) {
   return engine !== PxTimelineEngineSetting.js;
 }
 var PX_TRIGGER_DEFAULTS = {
-  startOn: "load",
-  outAction: "continue",
-  scrollIntoViewThreshold: 0
+  start: "load",
+  offScreen: "pause",
+  mouseOut: "continue",
+  visibilityThreshold: 0.5,
+  visibilityDebounce: 150
 };
 function resolveTrigger(trigger) {
-  var _a2, _b, _c;
+  var _a2, _b, _c, _d, _e;
   return {
-    startOn: (_a2 = trigger == null ? void 0 : trigger.startOn) != null ? _a2 : PX_TRIGGER_DEFAULTS.startOn,
-    outAction: (_b = trigger == null ? void 0 : trigger.outAction) != null ? _b : PX_TRIGGER_DEFAULTS.outAction,
-    scrollIntoViewThreshold: (_c = trigger == null ? void 0 : trigger.scrollIntoViewThreshold) != null ? _c : PX_TRIGGER_DEFAULTS.scrollIntoViewThreshold
+    start: (_a2 = trigger == null ? void 0 : trigger.start) != null ? _a2 : PX_TRIGGER_DEFAULTS.start,
+    offScreen: (_b = trigger == null ? void 0 : trigger.offScreen) != null ? _b : PX_TRIGGER_DEFAULTS.offScreen,
+    mouseOut: (_c = trigger == null ? void 0 : trigger.mouseOut) != null ? _c : PX_TRIGGER_DEFAULTS.mouseOut,
+    visibilityThreshold: (_d = trigger == null ? void 0 : trigger.visibilityThreshold) != null ? _d : PX_TRIGGER_DEFAULTS.visibilityThreshold,
+    visibilityDebounce: (_e = trigger == null ? void 0 : trigger.visibilityDebounce) != null ? _e : PX_TRIGGER_DEFAULTS.visibilityDebounce
   };
 }
 var PxLoopRepeatAt = {
@@ -847,9 +857,9 @@ function flattenAnimatorTimeline(cfg) {
   } else {
     if (timeline.duration !== void 0) flat.duration = timeline.duration;
     if (timeline.trigger !== void 0) {
-      const _b = timeline.trigger, { finishAction } = _b, restTrigger = __objRest2(_b, ["finishAction"]);
+      const _b = timeline.trigger, { finish } = _b, restTrigger = __objRest2(_b, ["finish"]);
       if (Object.keys(restTrigger).length) flat.trigger = restTrigger;
-      if (finishAction !== void 0) flat.resetOnFinish = finishAction === "reset";
+      if (finish !== void 0) flat.resetOnFinish = finish === "reset";
     }
     if (timeline.delay !== void 0) flat.delay = timeline.delay;
     if (timeline.iterations !== void 0) flat.iterations = timeline.iterations;
@@ -948,13 +958,15 @@ var PxElementAnimationSchema = implementsInterface()(px.union([
   PxAnimationDefinitionSchema
 ]));
 var PxTriggerSchema = implementsInterface()(px.object({
-  startOn: px.enum([PxStartOn.load, PxStartOn.mouseOver, PxStartOn.click, PxStartOn.scrollIntoView, PxStartOn.programmatic], PX_TRIGGER_DEFAULTS.startOn).optional(),
-  outAction: px.enum([PxOutAction.continue, PxOutAction.pause, PxOutAction.reset, PxOutAction.reverse], PX_TRIGGER_DEFAULTS.outAction).optional(),
+  start: px.enum([PxTriggerStart.load, PxTriggerStart.mouseOver, PxTriggerStart.click, PxTriggerStart.none], PX_TRIGGER_DEFAULTS.start).optional(),
+  offScreen: px.enum([PxOffScreenAction.pause, PxOffScreenAction.continue, PxOffScreenAction.reset], PX_TRIGGER_DEFAULTS.offScreen).optional(),
+  mouseOut: px.enum([PxMouseOutAction.continue, PxMouseOutAction.pause, PxMouseOutAction.reset, PxMouseOutAction.reverse], PX_TRIGGER_DEFAULTS.mouseOut).optional(),
   // What happens after a NATURAL finish — `'hold'` (default: keep the end state per
-  // `fill`) or `'reset'` (snap back to the start state). Pairs with `outAction` ("what
-  // happens when the trigger condition ends"); both end-of-life knobs now read alike.
-  finishAction: px.enum([PxFinishAction.hold, PxFinishAction.reset]).optional(),
-  scrollIntoViewThreshold: px.number().optional()
+  // `fill`) or `'reset'` (snap back to the start state). One of four occasion keys
+  // (`start`, `offScreen`, `mouseOut`, `finish`), all named the same way.
+  finish: px.enum([PxFinishAction.hold, PxFinishAction.reset]).optional(),
+  visibilityThreshold: px.number().optional(),
+  visibilityDebounce: px.number().optional()
 }));
 var PxGlyphSchema = implementsInterface()(px.object({
   width: px.number(),
@@ -6234,16 +6246,16 @@ function foldTimelineOverride(timeline, shortcuts) {
   } else {
     base = timeline != null ? timeline : void 0;
   }
-  const { duration, delay, iterations, startOn } = shortcuts;
-  if (duration === void 0 && delay === void 0 && iterations === void 0 && startOn === void 0) {
+  const { duration, delay, iterations, start } = shortcuts;
+  if (duration === void 0 && delay === void 0 && iterations === void 0 && start === void 0) {
     return base === void 0 ? void 0 : { timeline: base };
   }
   const out = isPlainObject(base) ? __spreadValues2({}, base) : {};
   if (duration !== void 0) out.duration = duration;
   if (delay !== void 0) out.delay = delay;
   if (iterations !== void 0) out.iterations = iterations;
-  if (startOn !== void 0) {
-    out.trigger = __spreadProps2(__spreadValues2({}, out.trigger), { startOn });
+  if (start !== void 0) {
+    out.trigger = __spreadProps2(__spreadValues2({}, out.trigger), { start });
   }
   return { timeline: out };
 }
@@ -6390,6 +6402,202 @@ function asThrownError(e) {
   return e instanceof Error ? e : new Error(String(e));
 }
 
+// src/registry/PxAnimatorRegistry.ts
+var STORE_KEY = /* @__PURE__ */ Symbol.for("@pixodesk/svg-animator-web:animators");
+var GLOBAL_NAME = "__pixodeskAnimators";
+function store() {
+  const g = globalThis;
+  let s = g[STORE_KEY];
+  if (!s) {
+    const animators = /* @__PURE__ */ new Set();
+    const listeners = /* @__PURE__ */ new Set();
+    s = {
+      animators,
+      listeners,
+      getAll: () => Array.from(animators),
+      subscribe: (listener) => {
+        listeners.add(listener);
+        return () => {
+          listeners.delete(listener);
+        };
+      }
+    };
+    g[STORE_KEY] = s;
+    if (g[GLOBAL_NAME] === void 0) g[GLOBAL_NAME] = s;
+  }
+  return s;
+}
+function getAllAnimators() {
+  return store().getAll();
+}
+function onAnimatorsChange(listener) {
+  return store().subscribe(listener);
+}
+function notify(event, animator) {
+  for (const listener of store().listeners) {
+    try {
+      listener(event, animator);
+    } catch (e) {
+      setTimeout(() => {
+        throw e;
+      }, 0);
+    }
+  }
+}
+function registerAnimator(animator) {
+  const s = store();
+  if (s.animators.has(animator)) return;
+  s.animators.add(animator);
+  notify("add", animator);
+  const destroy = animator.destroy.bind(animator);
+  animator.destroy = () => {
+    destroy();
+    if (s.animators.delete(animator)) notify("remove", animator);
+  };
+}
+function withRegistryEvents(callbacks, api) {
+  const fire = (event) => {
+    const a = api();
+    if (a) notify(event, a);
+  };
+  return __spreadProps(__spreadValues({}, callbacks), {
+    onPlay: () => {
+      var _a2;
+      (_a2 = callbacks == null ? void 0 : callbacks.onPlay) == null ? void 0 : _a2.call(callbacks);
+      fire("play");
+    },
+    onPause: () => {
+      var _a2;
+      (_a2 = callbacks == null ? void 0 : callbacks.onPause) == null ? void 0 : _a2.call(callbacks);
+      fire("pause");
+    },
+    onCancel: () => {
+      var _a2;
+      (_a2 = callbacks == null ? void 0 : callbacks.onCancel) == null ? void 0 : _a2.call(callbacks);
+      fire("cancel");
+    },
+    onFinish: () => {
+      var _a2;
+      (_a2 = callbacks == null ? void 0 : callbacks.onFinish) == null ? void 0 : _a2.call(callbacks);
+      fire("finish");
+    }
+  });
+}
+
+// src/triggers/PxVisibilityGate.ts
+var PLAY_WHEN_VISIBLE_DEFAULTS = {
+  offScreen: PX_TRIGGER_DEFAULTS.offScreen,
+  visibilityThreshold: PX_TRIGGER_DEFAULTS.visibilityThreshold,
+  visibilityDebounce: PX_TRIGGER_DEFAULTS.visibilityDebounce
+};
+var THRESHOLD_STEPS = Array.from({ length: 21 }, (_, i) => i / 20);
+function effectiveRatio(entry) {
+  var _a2, _b;
+  const target = entry.boundingClientRect;
+  const visible = entry.intersectionRect;
+  if (!(target == null ? void 0 : target.height) || !visible) return entry.intersectionRatio;
+  const live = typeof window !== "undefined" && window.innerHeight ? window.innerHeight : Infinity;
+  const declared = (_b = (_a2 = entry.rootBounds) == null ? void 0 : _a2.height) != null ? _b : Infinity;
+  const viewport = Math.min(live, declared);
+  const denom = Math.min(target.height, Number.isFinite(viewport) ? viewport : target.height);
+  return denom > 0 ? visible.height / denom : entry.intersectionRatio;
+}
+function openGate(host) {
+  return {
+    requestStart: () => host.play(),
+    dispose: () => {
+    }
+  };
+}
+function isGated(offScreen) {
+  return offScreen !== PxOffScreenAction.continue;
+}
+function createVisibilityGate(root, trigger, host) {
+  if (!isGated(trigger.offScreen)) return openGate(host);
+  if (typeof IntersectionObserver === "undefined") return openGate(host);
+  const threshold = trigger.visibilityThreshold;
+  const debounceMs = trigger.visibilityDebounce;
+  let isOpen = void 0;
+  let startPending = false;
+  let pausedByGate = false;
+  let lastRatio = 0;
+  let openTimer;
+  const cancelPendingOpen = () => {
+    if (openTimer !== void 0) {
+      clearTimeout(openTimer);
+      openTimer = void 0;
+    }
+  };
+  const open = () => {
+    openTimer = void 0;
+    if (isOpen === true) return;
+    isOpen = true;
+    if (startPending || pausedByGate) {
+      startPending = false;
+      pausedByGate = false;
+      host.play();
+    }
+  };
+  const close = () => {
+    cancelPendingOpen();
+    if (isOpen === false) return;
+    isOpen = false;
+    if (!host.isPlaying()) return;
+    if (trigger.offScreen === PxOffScreenAction.reset) {
+      host.cancel();
+    } else {
+      host.pause();
+    }
+    pausedByGate = true;
+  };
+  const apply2 = (ratio) => {
+    lastRatio = ratio;
+    if (typeof document !== "undefined" && document.visibilityState === "hidden") {
+      close();
+      return;
+    }
+    if (ratio >= threshold) {
+      if (isOpen === true || openTimer !== void 0) return;
+      if (debounceMs > 0) openTimer = setTimeout(open, debounceMs);
+      else open();
+      return;
+    }
+    if (ratio <= 0) {
+      close();
+      return;
+    }
+    if (isOpen !== true) cancelPendingOpen();
+  };
+  const observer = new IntersectionObserver((entries) => {
+    const last = entries[entries.length - 1];
+    if (last) apply2(last.isIntersecting ? effectiveRatio(last) : 0);
+  }, { threshold: THRESHOLD_STEPS });
+  observer.observe(root);
+  const onVisibilityChange = () => {
+    apply2(lastRatio);
+  };
+  const hasDocument = typeof document !== "undefined";
+  if (hasDocument) document.addEventListener("visibilitychange", onVisibilityChange);
+  return {
+    requestStart: (immediate) => {
+      if (immediate || isOpen === true) {
+        cancelPendingOpen();
+        isOpen = true;
+        startPending = false;
+        pausedByGate = false;
+        host.play();
+        return;
+      }
+      startPending = true;
+    },
+    dispose: () => {
+      cancelPendingOpen();
+      observer.disconnect();
+      if (hasDocument) document.removeEventListener("visibilitychange", onVisibilityChange);
+    }
+  };
+}
+
 // src/triggers/PxAnimatorTriggers.ts
 function setupAnimationTriggers(api, trigger, diag) {
   const report = diag != null ? diag : createDiagnostics(void 0, "[PxAnimator]");
@@ -6397,7 +6605,7 @@ function setupAnimationTriggers(api, trigger, diag) {
   const dispose = () => {
     for (const undo of cleanups.splice(0)) undo();
   };
-  const { startOn, outAction, scrollIntoViewThreshold } = resolveTrigger(trigger);
+  const resolved = resolveTrigger(trigger);
   const root = api.getRootElement();
   if (!root) {
     report.warn(PxDiagnosticKind.host, PxDiagnosticCode.triggersNoRoot);
@@ -6411,27 +6619,34 @@ function setupAnimationTriggers(api, trigger, diag) {
     }
     api.play();
   };
-  const handleEndAction = () => {
-    switch (outAction) {
-      case "pause":
+  const gate = createVisibilityGate(root, resolved, {
+    isPlaying: () => api.isPlaying(),
+    play: start,
+    pause: () => api.pause(),
+    cancel: () => api.cancel()
+  });
+  cleanups.push(() => gate.dispose());
+  const handleMouseOut = () => {
+    switch (resolved.mouseOut) {
+      case PxMouseOutAction.pause:
         api.pause();
         break;
-      case "reset":
+      case PxMouseOutAction.reset:
         api.cancel();
         break;
-      case "reverse":
+      case PxMouseOutAction.reverse:
         reversed = true;
         api.setPlaybackRate(-1);
         api.play();
         break;
-      case "continue":
+      case PxMouseOutAction.continue:
       default:
         break;
     }
   };
-  switch (startOn) {
-    case "load": {
-      const startHandler = () => start();
+  switch (resolved.start) {
+    case PxTriggerStart.load: {
+      const startHandler = () => gate.requestStart(false);
       if (document.readyState === "complete") {
         startHandler();
       } else {
@@ -6440,14 +6655,14 @@ function setupAnimationTriggers(api, trigger, diag) {
       }
       break;
     }
-    case "mouseOver": {
+    case PxTriggerStart.mouseOver: {
       let enteredOnce = false;
       const mouseOverHandler = () => {
         enteredOnce = true;
-        start();
+        gate.requestStart(true);
       };
       const mouseOutHandler = () => {
-        if (enteredOnce) handleEndAction();
+        if (enteredOnce) handleMouseOut();
       };
       root.addEventListener("mouseenter", mouseOverHandler);
       root.addEventListener("mouseleave", mouseOutHandler);
@@ -6457,51 +6672,16 @@ function setupAnimationTriggers(api, trigger, diag) {
       });
       break;
     }
-    case "click": {
+    case PxTriggerStart.click: {
       const clickHandler = () => {
-        if (api.isPlaying()) {
-          handleEndAction();
-        } else {
-          start();
-        }
+        if (api.isPlaying()) api.pause();
+        else gate.requestStart(true);
       };
       root.addEventListener("click", clickHandler);
       cleanups.push(() => root.removeEventListener("click", clickHandler));
       break;
     }
-    case "scrollIntoView": {
-      const effectiveRatio = (entry) => {
-        var _a2, _b;
-        const target = entry.boundingClientRect;
-        const visible = entry.intersectionRect;
-        if (!(target == null ? void 0 : target.height) || !visible) return entry.intersectionRatio;
-        const live = typeof window !== "undefined" && window.innerHeight ? window.innerHeight : Infinity;
-        const declared = (_b = (_a2 = entry.rootBounds) == null ? void 0 : _a2.height) != null ? _b : Infinity;
-        const viewport = Math.min(live, declared);
-        const denom = Math.min(target.height, Number.isFinite(viewport) ? viewport : target.height);
-        return denom > 0 ? visible.height / denom : entry.intersectionRatio;
-      };
-      const thresholdSteps = Array.from({ length: 21 }, (_, i) => i / 20);
-      let wasIntersecting = false;
-      const observer = new IntersectionObserver(
-        (entries) => {
-          entries.forEach((entry) => {
-            if (entry.isIntersecting && effectiveRatio(entry) >= scrollIntoViewThreshold) {
-              wasIntersecting = true;
-              start();
-            } else if (wasIntersecting) {
-              wasIntersecting = false;
-              handleEndAction();
-            }
-          });
-        },
-        { threshold: thresholdSteps }
-      );
-      observer.observe(root);
-      cleanups.push(() => observer.disconnect());
-      break;
-    }
-    case "programmatic":
+    case PxTriggerStart.none:
       break;
   }
   return dispose;
@@ -6509,7 +6689,12 @@ function setupAnimationTriggers(api, trigger, diag) {
 
 // src/engines/PxAnimatorFrameLoop.ts
 function getSelector(id) {
-  return "#" + id;
+  return "#" + escapeCssId(id);
+}
+function escapeCssId(id) {
+  const css = globalThis.CSS;
+  if (typeof (css == null ? void 0 : css.escape) === "function") return css.escape(id);
+  return id.replace(/^([0-9])/, (_all, digit) => "\\3" + digit + " ").replace(/([^\w\-\\ ])/g, "\\$1");
 }
 function createFrameLoopAnimator(doc, adapter, callbacks, rootElement) {
   var _a2;
@@ -7305,14 +7490,15 @@ function isInternalOptions(options) {
   return "adapter" in options;
 }
 function resolveTimelineOption(options) {
-  const { timeline, duration, delay, iterations, startOn } = options;
-  return foldTimelineOverride(timeline, { duration, delay, iterations, startOn });
+  const { timeline, duration, delay, iterations, start } = options;
+  return foldTimelineOverride(timeline, { duration, delay, iterations, start });
 }
 function createAnimator(options) {
   const { src, doc, container, resetTimeline } = options;
   const adapter = isInternalOptions(options) ? options.adapter : void 0;
   const patch = resolveTimelineOption(options);
-  const callbacks = toEngineCallbacks(options);
+  let proxy;
+  const callbacks = withRegistryEvents(toEngineCallbacks(options), () => proxy);
   if (doc !== void 0 && src !== void 0) {
     throw new Error("createAnimator: provide either `src` or `doc`, not both");
   }
@@ -7348,19 +7534,7 @@ function createAnimator(options) {
       failed(PxDiagnosticKind.internal, PxDiagnosticCode.buildFailed, err);
     }
   };
-  if (doc !== void 0) {
-    build(doc);
-  } else {
-    fetch(src).then((res) => res.json()).then((json) => {
-      if (destroyed) return;
-      if (isPxDocument(json)) build(json);
-      else failed(PxDiagnosticKind.document, PxDiagnosticCode.invalidDocumentAtSrc, src);
-    }).catch((err) => {
-      var _a2;
-      failed(PxDiagnosticKind.host, PxDiagnosticCode.loadFailed, src, (_a2 = err == null ? void 0 : err.message) != null ? _a2 : String(err));
-    });
-  }
-  return {
+  proxy = {
     "isReady": () => !!animator,
     "getRootElement": () => animator ? animator.getRootElement() : null,
     "isPlaying": () => (animator == null ? void 0 : animator.isPlaying()) || false,
@@ -7393,6 +7567,20 @@ function createAnimator(options) {
       animator == null ? void 0 : animator.destroy();
     }
   };
+  registerAnimator(proxy);
+  if (doc !== void 0) {
+    build(doc);
+  } else {
+    fetch(src).then((res) => res.json()).then((json) => {
+      if (destroyed) return;
+      if (isPxDocument(json)) build(json);
+      else failed(PxDiagnosticKind.document, PxDiagnosticCode.invalidDocumentAtSrc, src);
+    }).catch((err) => {
+      var _a2;
+      failed(PxDiagnosticKind.host, PxDiagnosticCode.loadFailed, src, (_a2 = err == null ? void 0 : err.message) != null ? _a2 : String(err));
+    });
+  }
+  return proxy;
 }
 function loadTagAnimators(options) {
   const elements = document.querySelectorAll("[" + PX_ANIM_SRC_ATTR_NAME + "]");
@@ -7419,7 +7607,9 @@ function loadTagAnimators(options) {
   createAdapterAnimator,
   createAnimator,
   generateNewIds,
+  getAllAnimators,
   loadTagAnimators,
+  onAnimatorsChange,
   px,
   renderNode,
   setupAnimationTriggers,