@pixodesk/svg-animator-web 1.0.41 → 1.0.43

package/dist/index.cjs

@@ -69,7 +69,7 @@ __export(index_exports, {
 });
 module.exports = __toCommonJS(index_exports);
 
-// ../svg-animator-core/dist/chunk-L6GJ6Y2M.js
+// ../svg-animator-core/dist/chunk-BOTZI36B.js
 var __defProp2 = Object.defineProperty;
 var __defProps2 = Object.defineProperties;
 var __getOwnPropDescs2 = Object.getOwnPropertyDescriptors;
@@ -3986,32 +3986,34 @@ var PxDiagnosticKind = {
   /** The player failed where it did not expect to — report it to us. */
   internal: "internal"
 };
-function asError(error) {
-  return typeof error === "string" ? new Error(error) : error;
+var DOCS_URL = "https://github.com/pixodesk/pixodesk-svg-animator/blob/main/docs/diagnostics.md";
+function codeLine(code) {
+  return "PX" + code + " " + DOCS_URL + "#px" + code;
+}
+function errorIn(data) {
+  return data.find((d) => d instanceof Error);
 }
 function createDiagnostics(config, prefix) {
   const tag = prefix ? prefix + " " : "";
   return {
-    warn: (kind, message, detail) => {
+    warn: (kind, code, ...data) => {
+      const message = codeLine(code);
       if (config == null ? void 0 : config.onWarn) {
-        config.onWarn({ kind, message, detail });
+        config.onWarn({ code, kind, data, message });
         return;
       }
       if (config == null ? void 0 : config.muteWarn) return;
-      const line = tag + kind + ": " + message;
-      if (detail === void 0) console.warn(line);
-      else console.warn(line, detail);
+      console.warn(tag + kind + " " + message, ...data);
     },
-    error: (kind, error, detail) => {
-      const err = asError(error);
+    error: (kind, code, ...data) => {
+      const message = codeLine(code);
+      const error = errorIn(data);
       if (config == null ? void 0 : config.onError) {
-        config.onError({ kind, message: err.message, error: err, detail });
+        config.onError({ code, kind, data, message, error });
         return;
       }
       if (config == null ? void 0 : config.muteError) return;
-      const line = tag + kind + ": " + err.message;
-      if (detail === void 0) console.error(line);
-      else console.error(line, detail);
+      console.error(tag + kind + " " + message, ...data);
     }
   };
 }
@@ -6128,6 +6130,36 @@ function createAdapterAnimator(doc, adapter, callbacks) {
   };
   return api;
 }
+var PxDiagnosticCode = /* @__PURE__ */ ((PxDiagnosticCode2) => {
+  PxDiagnosticCode2[PxDiagnosticCode2["buildFailed"] = 1001] = "buildFailed";
+  PxDiagnosticCode2[PxDiagnosticCode2["invalidDocumentAtSrc"] = 1002] = "invalidDocumentAtSrc";
+  PxDiagnosticCode2[PxDiagnosticCode2["loadFailed"] = 1003] = "loadFailed";
+  PxDiagnosticCode2[PxDiagnosticCode2["animationBuildFailed"] = 1004] = "animationBuildFailed";
+  PxDiagnosticCode2[PxDiagnosticCode2["effectsShape"] = 1101] = "effectsShape";
+  PxDiagnosticCode2[PxDiagnosticCode2["timelineOverrideIgnored"] = 1102] = "timelineOverrideIgnored";
+  PxDiagnosticCode2[PxDiagnosticCode2["blockedTag"] = 1103] = "blockedTag";
+  PxDiagnosticCode2[PxDiagnosticCode2["unsupportedAnimatedAttrs"] = 1104] = "unsupportedAnimatedAttrs";
+  PxDiagnosticCode2[PxDiagnosticCode2["noBindings"] = 1105] = "noBindings";
+  PxDiagnosticCode2[PxDiagnosticCode2["unresolvedBinding"] = 1106] = "unresolvedBinding";
+  PxDiagnosticCode2[PxDiagnosticCode2["triggersNoRoot"] = 1201] = "triggersNoRoot";
+  PxDiagnosticCode2[PxDiagnosticCode2["noRootForSelector"] = 1202] = "noRootForSelector";
+  PxDiagnosticCode2[PxDiagnosticCode2["noRootElement"] = 1203] = "noRootElement";
+  PxDiagnosticCode2[PxDiagnosticCode2["noElementsForSelector"] = 1206] = "noElementsForSelector";
+  PxDiagnosticCode2[PxDiagnosticCode2["setAttributeNoElement"] = 1207] = "setAttributeNoElement";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollSmoothingNeedsOwnDriver"] = 1301] = "scrollSmoothingNeedsOwnDriver";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollNativeUnavailable"] = 1302] = "scrollNativeUnavailable";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollSubjectInvalid"] = 1303] = "scrollSubjectInvalid";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollSubjectNoMatch"] = 1304] = "scrollSubjectNoMatch";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollNoRootToObserve"] = 1305] = "scrollNoRootToObserve";
+  PxDiagnosticCode2[PxDiagnosticCode2["scrollTriggerIgnored"] = 1306] = "scrollTriggerIgnored";
+  PxDiagnosticCode2[PxDiagnosticCode2["rateRejected"] = 1401] = "rateRejected";
+  PxDiagnosticCode2[PxDiagnosticCode2["controlPropsConflict"] = 1501] = "controlPropsConflict";
+  PxDiagnosticCode2[PxDiagnosticCode2["rnCompileFailed"] = 1601] = "rnCompileFailed";
+  PxDiagnosticCode2[PxDiagnosticCode2["rnRenderFailed"] = 1602] = "rnRenderFailed";
+  PxDiagnosticCode2[PxDiagnosticCode2["rnBoundaryCaught"] = 1603] = "rnBoundaryCaught";
+  PxDiagnosticCode2[PxDiagnosticCode2["rnUnsupported"] = 1604] = "rnUnsupported";
+  return PxDiagnosticCode2;
+})(PxDiagnosticCode || {});
 var FLAT_ONLY_KEYS = [
   "timelineSource",
   "scroll",
@@ -6368,7 +6400,7 @@ function setupAnimationTriggers(api, trigger, diag) {
   const { startOn, outAction, scrollIntoViewThreshold } = resolveTrigger(trigger);
   const root = api.getRootElement();
   if (!root) {
-    report.warn(PxDiagnosticKind.host, "setupAnimationTriggers: No root element found for animation.");
+    report.warn(PxDiagnosticKind.host, PxDiagnosticCode.triggersNoRoot);
     return dispose;
   }
   let reversed = false;
@@ -6487,9 +6519,9 @@ function createFrameLoopAnimator(doc, adapter, callbacks, rootElement) {
     if (doc.id) {
       const rootSelector = getSelector(doc.id);
       rootElement = document.querySelector(rootSelector);
-      if (!rootElement) diag.warn(PxDiagnosticKind.host, "createFrameLoopAnimator: No root element found for selector: " + rootSelector);
+      if (!rootElement) diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.noRootForSelector, rootSelector);
     } else {
-      diag.warn(PxDiagnosticKind.host, "createFrameLoopAnimator: No root element provided");
+      diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.noRootElement);
     }
   }
   const basicApi = createAdapterAnimator(
@@ -6501,7 +6533,7 @@ function createFrameLoopAnimator(doc, adapter, callbacks, rootElement) {
     "getRootElement": () => rootElement || null
   });
   if (isScrollTimeline(config)) {
-    if (config.trigger) diag.warn(PxDiagnosticKind.usage, "scroll timeline: `animator.trigger` is ignored (triggers do not apply to scroll-driven playback)");
+    if (config.trigger) diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.scrollTriggerIgnored);
   } else {
     const detachTriggers = setupAnimationTriggers(api, (_a2 = config.trigger) != null ? _a2 : {}, diag);
     const destroyEngine = api.destroy.bind(api);
@@ -6526,7 +6558,7 @@ function createDomAdapter(rootElement, diag) {
       const elements = (rootElement == null ? void 0 : rootElement.querySelectorAll(selector)) || document.querySelectorAll(selector);
       if (elements.length === 0 && !warnedSelectors.has(selector)) {
         warnedSelectors.add(selector);
-        report.warn(PxDiagnosticKind.host, 'setAttribute: No elements found for selector "' + selector + '"');
+        report.warn(PxDiagnosticKind.host, PxDiagnosticCode.setAttributeNoElement, selector);
       }
       for (let i = 0; i < elements.length; i++) {
         const element = elements[i];
@@ -6645,9 +6677,9 @@ function createWebApiAnimator(doc, callbacks, rootElement, forceEvenIfHasUnsuppo
     if (doc.id) {
       const rootSelector = getSelector(doc.id);
       rootElement = document.querySelector(rootSelector);
-      if (!rootElement) diag.warn(PxDiagnosticKind.host, "createWebApiAnimator: No root element found for selector: " + rootSelector);
+      if (!rootElement) diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.noRootForSelector, rootSelector);
     } else {
-      diag.warn(PxDiagnosticKind.host, "createWebApiAnimator: No root element provided");
+      diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.noRootElement);
     }
   }
   const bindings = normalizeBindings(doc, PxTimelineEngine.native);
@@ -6660,18 +6692,18 @@ function createWebApiAnimator(doc, callbacks, rootElement, forceEvenIfHasUnsuppo
   let finishNotified = false;
   let removeCalled = false;
   if (!(bindings == null ? void 0 : bindings.length)) {
-    diag.warn(PxDiagnosticKind.document, "createWebApiAnimator: No animation bindings defined");
+    diag.warn(PxDiagnosticKind.document, PxDiagnosticCode.noBindings);
   }
   for (const binding of bindings || []) {
     const animDef = binding.animate;
     if (!animDef || typeof animDef !== "object" || Array.isArray(animDef)) {
-      diag.warn(PxDiagnosticKind.document, "createWebApiAnimator: Empty or unresolved binding", binding);
+      diag.warn(PxDiagnosticKind.document, PxDiagnosticCode.unresolvedBinding, binding);
       continue;
     }
     const selector = getSelector(binding.id);
     const elements = (rootElement == null ? void 0 : rootElement.querySelectorAll(selector)) || document.querySelectorAll(selector);
     if (elements.length === 0) {
-      diag.warn(PxDiagnosticKind.host, 'createWebApiAnimator: No elements found for selector "' + selector + '"');
+      diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.noElementsForSelector, selector);
     }
     const keyframesMap = convertToWebApiKeyframes(animDef, unsupportedSet, config);
     const positiveDelay = config.delay && config.delay > 0 ? config.delay : void 0;
@@ -6720,14 +6752,14 @@ function createWebApiAnimator(doc, callbacks, rootElement, forceEvenIfHasUnsuppo
             }
             animations.push(anim);
           } catch (e) {
-            diag.warn(PxDiagnosticKind.internal, "createWebApiAnimator: could not build the animation", e);
+            diag.warn(PxDiagnosticKind.internal, PxDiagnosticCode.animationBuildFailed, e);
           }
         }
       }
     }
   }
   if (!forceEvenIfHasUnsupportedAttrs && unsupportedSet.size) {
-    diag.warn(PxDiagnosticKind.platform, "Unsupported CSS attrs: " + [...unsupportedSet].join(", "));
+    diag.warn(PxDiagnosticKind.platform, PxDiagnosticCode.unsupportedAnimatedAttrs, [...unsupportedSet].join(", "));
     return null;
   }
   const api = {
@@ -6772,7 +6804,7 @@ function createWebApiAnimator(doc, callbacks, rootElement, forceEvenIfHasUnsuppo
     },
     "setPlaybackRate": (rate) => {
       if (!isValidPlaybackRate(rate)) {
-        diag.warn(PxDiagnosticKind.usage, PX_RATE_REJECTED);
+        diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.rateRejected);
         return api;
       }
       animations.forEach((a) => a.playbackRate = rate);
@@ -6812,7 +6844,7 @@ function createWebApiAnimator(doc, callbacks, rootElement, forceEvenIfHasUnsuppo
     }
   };
   if (config.timelineSource === "scroll") {
-    if (config.trigger) diag.warn(PxDiagnosticKind.usage, "scroll timeline: `animator.trigger` is ignored (triggers do not apply to scroll-driven playback)");
+    if (config.trigger) diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.scrollTriggerIgnored);
   } else {
     const detachTriggers = setupAnimationTriggers(api, (_b = config.trigger) != null ? _b : {}, diag);
     const destroyEngine = api.destroy.bind(api);
@@ -6842,7 +6874,7 @@ function createNativeScrollTimeline(subject, config, diag) {
   const scroll = config.scroll || {};
   const kind = (_a2 = scroll.kind) != null ? _a2 : "view";
   if (scroll.smoothing) {
-    report.warn(PxDiagnosticKind.platform, "scroll timeline: `smoothing` needs the built-in driver \u2014 using the built-in driver instead of the browser timeline");
+    report.warn(PxDiagnosticKind.platform, PxDiagnosticCode.scrollSmoothingNeedsOwnDriver);
     return null;
   }
   const g = globalThis;
@@ -6859,7 +6891,7 @@ function createNativeScrollTimeline(subject, config, diag) {
       timeline = new Ctor({ source, axis });
     }
   } catch (e) {
-    report.warn(PxDiagnosticKind.platform, "scroll timeline: native timeline construction failed \u2014 falling back to the player measuring progress itself", e);
+    report.warn(PxDiagnosticKind.platform, PxDiagnosticCode.scrollNativeUnavailable, e);
     return null;
   }
   return {
@@ -6906,11 +6938,11 @@ function resolveScrollSubject(svgRoot, subject, diag) {
   try {
     found = document.querySelector(spec);
   } catch (e) {
-    report.warn(PxDiagnosticKind.document, 'scroll timeline: subject "' + spec + '" is not a valid selector \u2014 measuring the SVG itself');
+    report.warn(PxDiagnosticKind.document, PxDiagnosticCode.scrollSubjectInvalid, spec);
     return svgRoot;
   }
   if (!found) {
-    report.warn(PxDiagnosticKind.host, 'scroll timeline: subject "' + spec + '" matched no element \u2014 measuring the SVG itself');
+    report.warn(PxDiagnosticKind.host, PxDiagnosticCode.scrollSubjectNoMatch, spec);
     return svgRoot;
   }
   return found;
@@ -7152,7 +7184,7 @@ function bindWithEngineChoice(doc, adapter, callbacks, rootElement) {
           };
         }
       } else {
-        diag.warn(PxDiagnosticKind.host, "scroll timeline: no root element to observe \u2014 animation will stay at frame 0");
+        diag.warn(PxDiagnosticKind.host, PxDiagnosticCode.scrollNoRootToObserve);
       }
       return api;
     });
@@ -7174,7 +7206,7 @@ function bindWithEngineChoice(doc, adapter, callbacks, rootElement) {
 var SVG_NS = "http://www.w3.org/2000/svg";
 function createElement(tagName, normalizedProps, style, children, textContent, diag) {
   if (PX_DISALLOWED_SVG_TAGS_LOWER.has(tagName.toLowerCase())) {
-    (diag != null ? diag : createDiagnostics(void 0, "[PxAnimator]")).warn(PxDiagnosticKind.document, "SVG tag blocked (dangerous): " + tagName);
+    (diag != null ? diag : createDiagnostics(void 0, "[PxAnimator]")).warn(PxDiagnosticKind.document, PxDiagnosticCode.blockedTag, tagName);
     return null;
   }
   const element = document.createElementNS(SVG_NS, tagName);
@@ -7237,11 +7269,11 @@ function createAnimatorFromConfig(doc, adapter, callbacks, rootElement) {
 function createAnimatorImpl(doc, adapter, callbacks, containerElement, patch, resetTimeline) {
   const diag = createDiagnostics(callbacks, "[PxAnimator]");
   const effectsWarnings = validateNodeEffects(doc);
-  for (const w of effectsWarnings) diag.warn(PxDiagnosticKind.document, "effects shape: " + w);
+  for (const w of effectsWarnings) diag.warn(PxDiagnosticKind.document, PxDiagnosticCode.effectsShape, w);
   reportDocumentDiagnostics(doc, "[PxAnimator] createAnimator");
   if (patch !== void 0 || resetTimeline) {
     const patched = applyAnimatorConfig(doc, patch != null ? patch : {}, { resetTimeline: !!resetTimeline });
-    for (const w of patched.warnings) diag.warn(PxDiagnosticKind.usage, "timeline override: " + w);
+    for (const w of patched.warnings) diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.timelineOverrideIgnored, w);
     doc = patched.doc;
   }
   const animatorConfig = getAnimatorConfig(doc) || {};
@@ -7304,16 +7336,16 @@ function createAnimator(options) {
     pending = null;
     queued == null ? void 0 : queued.forEach((call) => call(api));
   };
-  const failed = (kind, message, detail) => {
+  const failed = (kind, code, ...data) => {
     pending = null;
-    diag.error(kind, message, detail);
+    diag.error(kind, code, ...data);
   };
   const build = (document2) => {
     try {
       ready(createAnimatorImpl(document2, adapter, callbacks, container, patch, resetTimeline));
     } catch (e) {
       const err = asThrownError(e);
-      failed(PxDiagnosticKind.internal, "createAnimator: could not build the player \u2014 " + err.message, err);
+      failed(PxDiagnosticKind.internal, PxDiagnosticCode.buildFailed, err);
     }
   };
   if (doc !== void 0) {
@@ -7322,10 +7354,10 @@ function createAnimator(options) {
     fetch(src).then((res) => res.json()).then((json) => {
       if (destroyed) return;
       if (isPxDocument(json)) build(json);
-      else failed(PxDiagnosticKind.document, 'createAnimator: invalid animation document format at "' + src + '"');
+      else failed(PxDiagnosticKind.document, PxDiagnosticCode.invalidDocumentAtSrc, src);
     }).catch((err) => {
       var _a2;
-      failed(PxDiagnosticKind.host, 'createAnimator: failed to load "' + src + '" \u2014 ' + ((_a2 = err == null ? void 0 : err.message) != null ? _a2 : String(err)));
+      failed(PxDiagnosticKind.host, PxDiagnosticCode.loadFailed, src, (_a2 = err == null ? void 0 : err.message) != null ? _a2 : String(err));
     });
   }
   return {