@pixodesk/svg-animator-rn 1.0.40 → 1.0.43

package/src/PixodeskSvgAnimator.tsx

@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See the LICENSE file in the project root for details.
  *---------------------------------------------------------------------------------------*/
 
-import { clampSeekMs, createRunClock, isValidPlaybackRate, progressSpanMs, progressToTimeMs, PX_RATE_REJECTED, PxDiagnosticKind, seekCeilingMs, timeToProgress, type PxAnimatorHandle, type PxAnimatorCallbacks, type PxControlProps, type PxPlaybackOverrideProps, type PxDiagnostics, generateNewIds, getAnimatorConfig, getDefs, materializeAllInTree, resolveTrigger, validateNodeEffects, PxTimelineEngine, PxControlMode, resolveControlMode, type PxFillMode, type PxOutAction, type PxPlaybackDirection, type PxAnimatedSvgDocument, type PxTimelinePatch, type PxNode, applyAnimatorConfig, foldTimelineOverride } from '@pixodesk/svg-animator-core';
+import { clampSeekMs, createRunClock, isValidPlaybackRate, progressSpanMs, progressToTimeMs, PxDiagnosticCode, PxDiagnosticKind, seekCeilingMs, timeToProgress, type PxAnimatorHandle, type PxAnimatorCallbacks, type PxControlProps, type PxPlaybackOverride, type PxDiagnostics, generateNewIds, getAnimatorConfig, getDefinitions, materializeAllInTree, resolveTrigger, validateNodeEffects, PxTimelineEngine, PxControlMode, resolveControlMode, type PxFillMode, type PxOutAction, type PxPlaybackDirection, type PxAnimatedSvgDocument, type PxTimelinePatch, type PxNode, applyAnimatorConfig, foldTimelineOverride } from '@pixodesk/svg-animator-core';
 import { createDiagnostics, reportDocumentDiagnostics } from '@pixodesk/svg-animator-core/internal';
 import React, { createElement, useEffect, useImperativeHandle, useMemo, useRef, useState, type ComponentType, type ReactElement, type ReactNode } from 'react';
 import { Dimensions, Platform, Pressable, View } from 'react-native';
@@ -37,13 +37,13 @@ export type RnAnimatorApi = PxAnimatorHandle;
 
 /**
  * The component's props. The playback override, the control props and the callbacks are core's
- * shared shapes (review §9) — `PxPlaybackOverrideProps`, `PxControlProps` and
+ * shared shapes (review §9) — `PxPlaybackOverride`, `PxControlProps` and
  * `PxAnimatorCallbacks` — so React, Vue and React Native cannot drift apart. Only what differs
  * on this platform is declared here: `fallback`, which has no web counterpart.
  * @public
  */
 export interface PixodeskSvgAnimatorProps
-    extends PxPlaybackOverrideProps, PxControlProps, PxAnimatorCallbacks {
+    extends PxPlaybackOverride, PxControlProps, PxAnimatorCallbacks {
 
     // -- Source ---------------------------------------------------------------
 
@@ -51,7 +51,7 @@ export interface PixodeskSvgAnimatorProps
     doc: PxAnimatedSvgDocument;
 
     /**
-     * Per-instance override of the document's `timeline` — see `PxPlaybackOverrideProps`.
+     * Per-instance override of the document's `timeline` — see `PxPlaybackOverride`.
      *
      * `engine` is accepted but ignored here: React Native always uses the `native` (fully
      * flattened) materialization, because react-native-svg has no `<use>` shadow-tree
@@ -70,7 +70,7 @@ export interface PixodeskSvgAnimatorProps
     // -- Failure handling -----------------------------------------------------
     // A document that cannot be compiled or rendered is reported through `onError` — the same
     // `(diagnostic) => void` as every other player (review §25.1), with `diagnostic.error` the
-    // thrown Error and, when the error boundary caught it, `diagnostic.detail.componentStack`.
+    // thrown Error and, when the error boundary caught it, the component stack in `diagnostic.data`.
     // The component renders `fallback` instead of throwing, so one broken animation never
     // takes down the screen around it. Only JavaScript failures reach this — a crash inside
     // react-native-svg's native renderer bypasses JavaScript entirely.
@@ -217,7 +217,7 @@ function SampledSubtree({
 
 /** Overrides that shadow the document's own `animator` config. */
 /** The override subset of the props — core's shared shape, not a local copy (review §9). */
-type ConfigOverrides = PxPlaybackOverrideProps;
+type ConfigOverrides = PxPlaybackOverride;
 
 interface Compiled {
     /** Materialized document, or null when compilation failed. */
@@ -240,7 +240,7 @@ const EMPTY_TRACKS: PxCompiledTracks = {
 function compileDocument(doc: PxAnimatedSvgDocument, overrides: ConfigOverrides, diag: PxDiagnostics): Compiled {
     const { timeline, resetTimeline, duration, delay, iterations, startOn } = overrides;
     const warnings = validateNodeEffects(doc as PxNode);
-    for (const w of warnings) diag.warn(PxDiagnosticKind.document, 'effects shape: ' + w);
+    for (const w of warnings) diag.warn(PxDiagnosticKind.document, PxDiagnosticCode.effectsShape, w);
     // The whole-document boundary diagnostic — see the note in the web player's entry.
     reportDocumentDiagnostics(doc, '[PixodeskSvgAnimator]');
 
@@ -249,8 +249,8 @@ function compileDocument(doc: PxAnimatedSvgDocument, overrides: ConfigOverrides,
     // patch would be read by none of the pipeline. Same call, same rules, on every surface.
     const patch = foldTimelineOverride(timeline, { duration, delay, iterations, startOn });
     if (patch !== undefined || resetTimeline) {
-        const applied = applyAnimatorConfig(doc, patch ?? {}, { resetDefaults: !!resetTimeline });
-        for (const w of applied.warnings) diag.warn(PxDiagnosticKind.usage, 'timeline override: ' + w);
+        const applied = applyAnimatorConfig(doc, patch ?? {}, { resetTimeline: !!resetTimeline });
+        for (const w of applied.warnings) diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.timelineOverrideIgnored, w);
         doc = applied.doc;
     }
 
@@ -325,7 +325,7 @@ export function PixodeskSvgAnimator({
             // A malformed document must not take the host screen down with it. This instance
             // will not play — an ERROR, reported once, here (review §25.1).
             const error = e instanceof Error ? e : new Error(String(e));
-            makeDiag().error(PxDiagnosticKind.internal, error, { phase: 'compile' });
+            makeDiag().error(PxDiagnosticKind.internal, PxDiagnosticCode.rnCompileFailed, error);
             return { doc: null, tracks: EMPTY_TRACKS, error };
         }
         // `timeline` is an object prop, so a fresh literal each render would recompile the whole
@@ -450,7 +450,7 @@ export function PixodeskSvgAnimator({
         },
         setPlaybackRate: (rate: number) => {
             if (!isValidPlaybackRate(rate)) {
-                makeDiag().warn(PxDiagnosticKind.usage, PX_RATE_REJECTED);
+                makeDiag().warn(PxDiagnosticKind.usage, PxDiagnosticCode.rateRejected);
                 return;
             }
             rateRef.current = rate;
@@ -510,7 +510,7 @@ export function PixodeskSvgAnimator({
 
     useEffect(() => {
         const diag = makeDiag();
-        for (const w of modeWarnings) diag.warn(PxDiagnosticKind.usage, w);
+        for (const w of modeWarnings) diag.warn(PxDiagnosticKind.usage, PxDiagnosticCode.controlPropsConflict, w);
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [modeWarnings.join('|')]);
 
@@ -602,7 +602,7 @@ export function PixodeskSvgAnimator({
 
         const renderOpts: RenderRnNodeOptions = {
             warnings: warningsRef.current,
-            defs: getDefs(compiled.doc),
+            defs: getDefinitions(compiled.doc),
         };
         try {
             return renderRnNode(compiled.doc as PxNode, {
@@ -648,7 +648,7 @@ export function PixodeskSvgAnimator({
             // (an ERROR, review §25.1) and render nothing rather than unmount the host screen.
             const error = e instanceof Error ? e : new Error(String(e));
             renderErrorRef.current = error;
-            makeDiag().error(PxDiagnosticKind.internal, error, { phase: 'render' });
+            makeDiag().error(PxDiagnosticKind.internal, PxDiagnosticCode.rnRenderFailed, error);
             return null;
         }
         // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -658,7 +658,7 @@ export function PixodeskSvgAnimator({
         const diag = makeDiag();
         // `platform`: these come from the react-native-svg prop mapper — shapes this renderer
         // cannot express, rather than anything wrong with the file.
-        for (const w of warningsRef.current) diag.warn(PxDiagnosticKind.platform, w);
+        for (const w of warningsRef.current) diag.warn(PxDiagnosticKind.platform, PxDiagnosticCode.rnUnsupported, w);
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [root]);
 

package/src/PxRnErrorBoundary.tsx

@@ -4,7 +4,7 @@
  *---------------------------------------------------------------------------------------*/
 
 import { Component, type ErrorInfo, type ReactNode } from 'react';
-import { PxDiagnosticKind, type PxDiagnostics } from '@pixodesk/svg-animator-core';
+import { PxDiagnosticCode, PxDiagnosticKind, type PxDiagnostics } from '@pixodesk/svg-animator-core';
 import { createDiagnostics } from '@pixodesk/svg-animator-core/internal';
 
 /** @public @advanced */
@@ -14,7 +14,7 @@ export interface PxRnErrorBoundaryProps {
     fallback?: (error: Error) => ReactNode;
     /**
      * Where the failure is reported (API review §5, §25.1): `error(internal, …)` with
-     * `{ componentStack }` as the detail — so it reaches `onError` like every other failure.
+     * the component stack passed as data — so it reaches `onError` like every other failure.
      * Defaults to the console.
      */
     diag?: PxDiagnostics;
@@ -47,7 +47,7 @@ export class PxRnErrorBoundary extends Component<PxRnErrorBoundaryProps, State>
 
     override componentDidCatch(error: Error, info: ErrorInfo): void {
         (this.props.diag ?? createDiagnostics(undefined, '[PixodeskSvgAnimator]'))
-            .error(PxDiagnosticKind.internal, error, { componentStack: info?.componentStack ?? undefined });
+            .error(PxDiagnosticKind.internal, PxDiagnosticCode.rnBoundaryCaught, error, info?.componentStack ?? undefined);
     }
 
     override componentDidUpdate(prev: PxRnErrorBoundaryProps): void {

package/src/PxRnPropNames.ts

@@ -17,7 +17,7 @@ const DROPPED_ATTRS = new Set(['class', 'className', 'style', 'xmlns', 'xmlns:xl
 
 /**
  * Converts one normalized wire attribute name (camelCase after core's
- * `getNormalizedProps`, or kebab-case raw) to a react-native-svg prop name.
+ * `toDomProps`, or kebab-case raw) to a react-native-svg prop name.
  * Returns undefined for props that must be dropped.
  *
  * Pure (no react-native-svg import) so the track compiler and its tests

package/src/PxRnRender.tsx

@@ -3,8 +3,8 @@
  * Licensed under the MIT License. See the LICENSE file in the project root for details.
  *---------------------------------------------------------------------------------------*/
 
-import { getNormalizedProps, type PxDefs, type PxNode } from '@pixodesk/svg-animator-core';
-import { sanitizeAttributeValue, DISALLOWED_SVG_TAGS_LOWER, TEXT_CONTENT_ATTR } from '@pixodesk/svg-animator-core/internal';
+import { toDomProps, type PxDefinitions, type PxNode } from '@pixodesk/svg-animator-core';
+import { sanitizeAttributeValue, PX_DISALLOWED_SVG_TAGS_LOWER, PX_TEXT_CONTENT_ATTR } from '@pixodesk/svg-animator-core/internal';
 import { createElement, type ComponentType, type ReactElement, type ReactNode } from 'react';
 import { RN_SVG_COMPONENTS } from './PxRnTypeMap';
 import { toRnPropName, toRnPropValue } from './PxRnPropNames';
@@ -14,7 +14,7 @@ export interface RenderRnNodeOptions {
     /** Collects non-fatal issues (unsupported tags, dropped attrs). */
     warnings?: Array<string>;
     /** `definitions` from the document, used to resolve named `style` presets. */
-    defs?: PxDefs;
+    defs?: PxDefinitions;
     /**
      * Wraps the created element for animated nodes: receives the resolved
      * component + static props and returns the element to mount (the animator
@@ -41,7 +41,7 @@ export interface RenderRnNodeOptions {
  * @internal
  */
 export function toRnProps(props: Record<string, any>, warnings?: Array<string>, tag?: string): Record<string, any> {
-    const normalized = getNormalizedProps(props);
+    const normalized = toDomProps(props);
     const out: Record<string, any> = {};
     for (const key of Object.keys(normalized)) {
         const sanitized = sanitizeAttributeValue(key, normalized[key]);
@@ -72,7 +72,7 @@ export function renderRnNode(node: PxNode, opts: RenderRnNodeOptions = {}, key?:
     const domType: string | undefined = props.domType;
     if (domType !== undefined) delete props.domType;
 
-    if (DISALLOWED_SVG_TAGS_LOWER.has(tag.toLowerCase())) {
+    if (PX_DISALLOWED_SVG_TAGS_LOWER.has(tag.toLowerCase())) {
         opts.warnings?.push('tag blocked (dangerous): ' + tag);
         return null;
     }
@@ -102,7 +102,7 @@ export function renderRnNode(node: PxNode, opts: RenderRnNodeOptions = {}, key?:
     }
 
     // Text content: wire nodes carry it in `textContent` — the one key.
-    const textContent: string | undefined = props[TEXT_CONTENT_ATTR];
+    const textContent: string | undefined = props[PX_TEXT_CONTENT_ATTR];
 
     let childElements: ReactNode = undefined;
     if (Array.isArray(children) && children.length > 0) {

package/src/PxRnTracks.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License. See the LICENSE file in the project root for details.
  *---------------------------------------------------------------------------------------*/
 
-import { calcAnimationValues, getAnimatorConfig, getNormalizedBindings, PxTimelineEngine, type PxAnimatedSvgDocument, type PxAnimationDefinition } from '@pixodesk/svg-animator-core';
-import { DEFAULT_DURATION_MS } from '@pixodesk/svg-animator-core/internal';
+import { calcAnimationValues, getAnimatorConfig, normalizeBindings, PxTimelineEngine, type PxAnimatedSvgDocument, type PxAnimationDefinition } from '@pixodesk/svg-animator-core';
+import { PX_DEFAULT_DURATION_MS } from '@pixodesk/svg-animator-core/internal';
 import { toRnPropName, toRnPropValue } from './PxRnPropNames';
 
 /**
@@ -73,7 +73,7 @@ export interface CompileTracksOptions {
 export function compileTracks(doc: PxAnimatedSvgDocument, opts?: CompileTracksOptions): PxCompiledTracks {
     const config = getAnimatorConfig(doc) || {};
 
-    const duration = +(config.duration || DEFAULT_DURATION_MS);
+    const duration = +(config.duration || PX_DEFAULT_DURATION_MS);
     const _iterations = config.iterations;
     let iterations = 1;
     if (typeof _iterations === 'number') iterations = _iterations || 1;
@@ -96,7 +96,7 @@ export function compileTracks(doc: PxAnimatedSvgDocument, opts?: CompileTracksOp
     };
     indexTags(doc);
 
-    const bindings = getNormalizedBindings(doc, PxTimelineEngine.js) || [];
+    const bindings = normalizeBindings(doc, PxTimelineEngine.js) || [];
 
     const elements: Array<PxElementTracks> = [];
     for (const binding of bindings) {