@pixodesk/svg-animator-web 1.0.40 → 1.0.41

package/README.md

@@ -107,9 +107,9 @@ const animator = createAnimator({
 animator.play();
 ```
 
-It returns a `PxAnimatorAPI`:
+It returns a `PxAnimatorApi`:
 
-<!-- px-check props PxAnimatorAPI pkg=web -->
+<!-- px-check props PxAnimatorApi pkg=web -->
 | Method                  | Description                                                       |
 | ----------------------- | ----------------------------------------------------------------- |
 | `play()`                | Start or resume playback                                          |
@@ -162,8 +162,16 @@ Elements may also carry a `node.effects` bucket (structural effects such as
 `strokeGradient`, `textPath`). This player materializes and removes them at
 runtime before any other normalization.
 
+When you want the markup without a player — a static first frame, a thumbnail, a snapshot —
+`renderNode` is that one step on its own: hand it a node and it returns the DOM element for it, or
+`null` when the node renders to nothing. Give it the document's `animator.definitions` as the
+second argument so named fonts resolve, and a diagnostics channel as the third to hear about
+anything it skips. It renders; it does not animate. `toDomProps(props)` is the attribute half of
+that step on its own: a node's attributes, resolved to what the DOM receives.
+
 See the [JSON format reference](../../docs/format/README.md#json-format-reference) and
 [Player effects](../../docs/format/README.md#player-effects) for the full schema and
-examples (compact printable schema: [SCHEMA.md](../../SCHEMA.md)). The wire
-types live in [`PxAnimatorTypes.ts`](../svg-animator-core/src/format/PxAnimatorTypes.ts).
+examples, and [Schema at a glance](../../docs/format/README.md#schema-at-a-glance) for the whole
+format as typings. The wire types live in
+[`PxAnimatorTypes.ts`](../svg-animator-core/src/format/PxAnimatorTypes.ts).
 

package/dist/{internal-BmFv1B6H.d.cts → PxAnimator-yjuSFhQw.d.cts}

@@ -1,4 +1,4 @@
-import { PxAnimatorAPI as PxAnimatorAPI$1, PxBasicAnimatorAPI as PxBasicAnimatorAPI$1, PxPlaybackOverrideProps, PxAnimatorCallbacks, PxAnimatedSvgDocument, PxPlatformAdapter } from '@pixodesk/svg-animator-core';
+import { PxAnimatorApi as PxAnimatorApi$1, PxPlaybackApi as PxPlaybackApi$1, PxPlaybackOverride, PxAnimatorCallbacks, PxAnimatedSvgDocument, PxPlatformAdapter } from '@pixodesk/svg-animator-core';
 
 /**
  * DOM specializations of the platform-neutral animator API types.
@@ -6,30 +6,9 @@ import { PxAnimatorAPI as PxAnimatorAPI$1, PxBasicAnimatorAPI as PxBasicAnimator
  * the historical (pre-core-extraction) signatures for web consumers.
  * @public
  */
-type PxBasicAnimatorAPI = PxBasicAnimatorAPI$1<Element>;
+type PxPlaybackApi = PxPlaybackApi$1<Element>;
 /** @public */
-type PxAnimatorAPI = PxAnimatorAPI$1<Element>;
-
-/**
- * Wire keys shared by every entry point.
- *
- * These live here rather than in `PxAnimator.ts` on purpose: that module used to end with a
- * top-level `if (typeof window !== 'undefined')` block publishing `createAnimator` /
- * `loadTagAnimators` as globals. A module-level side effect cannot be tree-shaken, so
- * importing ANY symbol from `PxAnimator.ts` pulled the entire full player in with it —
- * which silently made the pre-rendered builds the same size as the full one until this
- * constant was moved out. See PRERENDERED-PLAYER-BUILDS.md.
- *
- * That block is gone (API review §4) and the package now declares `"sideEffects": false`, but
- * keeping these here costs nothing and removes the trap for good.
- */
-/**
- * Key under which `createAnimator` options carry the inline animation document. The editor
- * writes it into every exported SVG+JS — `createAnimator({"doc": …})` — so it is part of the
- * export format, which is why it is a named constant and not a literal.
- * @internal
- */
-declare const PX_ANIMATOR_DOC_KEY = "doc";
+type PxAnimatorApi = PxAnimatorApi$1<Element>;
 
 /**
  * Everything `createAnimator` takes. The playback override (`timeline`, `resetTimeline` and the
@@ -38,10 +17,10 @@ declare const PX_ANIMATOR_DOC_KEY = "doc";
  * declared here.
  * @public
  */
-interface PxAnimatorOptions extends PxPlaybackOverrideProps, PxAnimatorCallbacks {
+interface PxAnimatorOptions extends PxPlaybackOverride, PxAnimatorCallbacks {
     /** URL to fetch the animation document from. Provide either this or `doc`, not both. */
     src?: string;
-    /** The animation document, inline (see SCHEMA.md). Provide either this or `src`, not both. */
+    /** The animation document, inline (see docs/format/README.md). Provide either this or `src`, not both. */
     doc?: PxAnimatedSvgDocument;
     /** CSS selector or element to render the SVG into. */
     container?: string | Element;
@@ -66,10 +45,10 @@ interface PxInternalAnimatorOptions extends PxAnimatorOptions {
  * @param options.src URL to fetch the animation document from.
  * @param options.doc The animation document, inline.
  * @param options.container CSS selector or element to render the SVG into.
- * @returns A PxAnimatorAPI instance to programmatically control the animation.
+ * @returns A PxAnimatorApi instance to programmatically control the animation.
  * @public
  */
-declare function createAnimator(options: PxAnimatorOptions): PxAnimatorAPI;
+declare function createAnimator(options: PxAnimatorOptions): PxAnimatorApi;
 /**
  * Scan and load for tags, e.g.
  *  <div data-px-animation-src="animation.json"></div>
@@ -91,4 +70,4 @@ type PxTagAnimatorOptions = Omit<PxAnimatorOptions, 'src' | 'doc' | 'container'>
  */
 declare function loadTagAnimators(options?: PxTagAnimatorOptions): void;
 
-export { type PxAnimatorAPI as P, PX_ANIMATOR_DOC_KEY as a, type PxAnimatorOptions as b, type PxBasicAnimatorAPI as c, type PxInternalAnimatorOptions as d, type PxTagAnimatorOptions as e, createAnimator as f, loadTagAnimators as l };
+export { type PxAnimatorApi as P, type PxAnimatorOptions as a, type PxPlaybackApi as b, type PxTagAnimatorOptions as c, createAnimator as d, type PxInternalAnimatorOptions as e, loadTagAnimators as l };

package/dist/{internal-BmFv1B6H.d.ts → PxAnimator-yjuSFhQw.d.ts}

@@ -1,4 +1,4 @@
-import { PxAnimatorAPI as PxAnimatorAPI$1, PxBasicAnimatorAPI as PxBasicAnimatorAPI$1, PxPlaybackOverrideProps, PxAnimatorCallbacks, PxAnimatedSvgDocument, PxPlatformAdapter } from '@pixodesk/svg-animator-core';
+import { PxAnimatorApi as PxAnimatorApi$1, PxPlaybackApi as PxPlaybackApi$1, PxPlaybackOverride, PxAnimatorCallbacks, PxAnimatedSvgDocument, PxPlatformAdapter } from '@pixodesk/svg-animator-core';
 
 /**
  * DOM specializations of the platform-neutral animator API types.
@@ -6,30 +6,9 @@ import { PxAnimatorAPI as PxAnimatorAPI$1, PxBasicAnimatorAPI as PxBasicAnimator
  * the historical (pre-core-extraction) signatures for web consumers.
  * @public
  */
-type PxBasicAnimatorAPI = PxBasicAnimatorAPI$1<Element>;
+type PxPlaybackApi = PxPlaybackApi$1<Element>;
 /** @public */
-type PxAnimatorAPI = PxAnimatorAPI$1<Element>;
-
-/**
- * Wire keys shared by every entry point.
- *
- * These live here rather than in `PxAnimator.ts` on purpose: that module used to end with a
- * top-level `if (typeof window !== 'undefined')` block publishing `createAnimator` /
- * `loadTagAnimators` as globals. A module-level side effect cannot be tree-shaken, so
- * importing ANY symbol from `PxAnimator.ts` pulled the entire full player in with it —
- * which silently made the pre-rendered builds the same size as the full one until this
- * constant was moved out. See PRERENDERED-PLAYER-BUILDS.md.
- *
- * That block is gone (API review §4) and the package now declares `"sideEffects": false`, but
- * keeping these here costs nothing and removes the trap for good.
- */
-/**
- * Key under which `createAnimator` options carry the inline animation document. The editor
- * writes it into every exported SVG+JS — `createAnimator({"doc": …})` — so it is part of the
- * export format, which is why it is a named constant and not a literal.
- * @internal
- */
-declare const PX_ANIMATOR_DOC_KEY = "doc";
+type PxAnimatorApi = PxAnimatorApi$1<Element>;
 
 /**
  * Everything `createAnimator` takes. The playback override (`timeline`, `resetTimeline` and the
@@ -38,10 +17,10 @@ declare const PX_ANIMATOR_DOC_KEY = "doc";
  * declared here.
  * @public
  */
-interface PxAnimatorOptions extends PxPlaybackOverrideProps, PxAnimatorCallbacks {
+interface PxAnimatorOptions extends PxPlaybackOverride, PxAnimatorCallbacks {
     /** URL to fetch the animation document from. Provide either this or `doc`, not both. */
     src?: string;
-    /** The animation document, inline (see SCHEMA.md). Provide either this or `src`, not both. */
+    /** The animation document, inline (see docs/format/README.md). Provide either this or `src`, not both. */
     doc?: PxAnimatedSvgDocument;
     /** CSS selector or element to render the SVG into. */
     container?: string | Element;
@@ -66,10 +45,10 @@ interface PxInternalAnimatorOptions extends PxAnimatorOptions {
  * @param options.src URL to fetch the animation document from.
  * @param options.doc The animation document, inline.
  * @param options.container CSS selector or element to render the SVG into.
- * @returns A PxAnimatorAPI instance to programmatically control the animation.
+ * @returns A PxAnimatorApi instance to programmatically control the animation.
  * @public
  */
-declare function createAnimator(options: PxAnimatorOptions): PxAnimatorAPI;
+declare function createAnimator(options: PxAnimatorOptions): PxAnimatorApi;
 /**
  * Scan and load for tags, e.g.
  *  <div data-px-animation-src="animation.json"></div>
@@ -91,4 +70,4 @@ type PxTagAnimatorOptions = Omit<PxAnimatorOptions, 'src' | 'doc' | 'container'>
  */
 declare function loadTagAnimators(options?: PxTagAnimatorOptions): void;
 
-export { type PxAnimatorAPI as P, PX_ANIMATOR_DOC_KEY as a, type PxAnimatorOptions as b, type PxBasicAnimatorAPI as c, type PxInternalAnimatorOptions as d, type PxTagAnimatorOptions as e, createAnimator as f, loadTagAnimators as l };
+export { type PxAnimatorApi as P, type PxAnimatorOptions as a, type PxPlaybackApi as b, type PxTagAnimatorOptions as c, createAnimator as d, type PxInternalAnimatorOptions as e, loadTagAnimators as l };

package/dist/{chunk-TNWZIIVG.js → chunk-BYDBNKO7.js}

@@ -39,4 +39,4 @@ export {
   __objRest,
   PX_ANIMATOR_DOC_KEY
 };
-//# sourceMappingURL=chunk-TNWZIIVG.js.map
+//# sourceMappingURL=chunk-BYDBNKO7.js.map

package/dist/chunk-BYDBNKO7.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/shared/PxAnimatorKeys.ts"],"sourcesContent":["/*---------------------------------------------------------------------------------------\n * Copyright (c) Pixodesk LTD.\n * Licensed under the MIT License. See the LICENSE file in the project root for details.\n *---------------------------------------------------------------------------------------*/\n\n/**\n * Wire keys shared by every entry point.\n *\n * These live here rather than in `PxAnimator.ts` on purpose: that module used to end with a\n * top-level `if (typeof window !== 'undefined')` block publishing `createAnimator` /\n * `loadTagAnimators` as globals. A module-level side effect cannot be tree-shaken, so\n * importing ANY symbol from `PxAnimator.ts` pulled the entire full player in with it —\n * which silently made the pre-rendered builds the same size as the full one until this\n * constant was moved out. See dev-docs/plans/prerendered-player-builds.md.\n *\n * That block is gone (API review §4) and the package now declares `\"sideEffects\": false`, but\n * keeping these here costs nothing and removes the trap for good.\n */\n\n/**\n * Key under which `createAnimator` options carry the inline animation document. The editor\n * writes it into every exported SVG+JS — `createAnimator({\"doc\": …})` — so it is part of the\n * export format, which is why it is a named constant and not a literal.\n * @internal\n */\nexport const PX_ANIMATOR_DOC_KEY = 'doc';\n\n/** Key under which `createAnimator` options carry the per-instance `timeline` override. */\nexport const PX_ANIMATOR_TIMELINE_KEY = 'timeline';\n\n/** Key that makes the override start from the player's default timeline instead of the document's. */\nexport const PX_ANIMATOR_RESET_KEY = 'resetTimeline';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBO,IAAM,sBAAsB;","names":[]}