@office-kit/pptx-editor 0.0.0-stage → 0.1.1

package/dist/internal/animation-player.d.ts

@@ -0,0 +1,104 @@
+import { SlideAnimationStep } from "@office-kit/pptx";
+
+//#region src/core/animation-player.d.ts
+/** Why a step is not played. */
+type UnsupportedReason = "notInMainSeq" | "notModelled" | "unknownTiming" | "ambiguousTarget";
+interface UnsupportedAnimation {
+  readonly step: SlideAnimationStep;
+  readonly reason: UnsupportedReason;
+}
+/** What one step does to its target, and when, within its stop. */
+interface AnimationItem {
+  readonly step: SlideAnimationStep;
+  /**
+  * `'emphasis'` animates a shape that is already on the slide and leaves it
+  * there, so unlike the other two it never decides whether the shape is shown.
+  */
+  readonly kind: "entrance" | "exit" | "emphasis";
+  /** Milliseconds from the start of the stop. */
+  readonly begin: number;
+  /** Null when the tree states no length. */
+  readonly duration: number | null;
+}
+/** One click's worth of animation. */
+interface AnimationStop {
+  readonly items: AnimationItem[];
+  /** True when the slide starts it itself, with no click — its first step
+  * runs with or after a predecessor it does not have. */
+  readonly auto: boolean;
+}
+interface AnimationPlan {
+  readonly stops: AnimationStop[];
+  readonly unsupported: UnsupportedAnimation[];
+}
+interface AnimationProgress {
+  readonly cursor: number;
+  readonly stops: number;
+  /** How long the stop in hand has been running; null once it has settled. */
+  readonly elapsed: number | null;
+  /** Bumped by every call that sets where the slide stands. */
+  readonly generation: number;
+}
+interface AnimationPlayerOptions {
+  /**
+  * Where the slide was drawn (a shadow root is fine), or a function returning
+  * it. A function is asked again on every query, because a transition draws
+  * the slide into a layer of its own and the layer beside it holds a
+  * different slide whose shapes may carry the very same ids.
+  */
+  readonly root: ParentNode | (() => ParentNode);
+  readonly steps: readonly SlideAnimationStep[] | null | undefined;
+  /**
+  * Asked afresh on every advance, so a viewer who turns reduced motion on
+  * mid-show gets the rest of the deck without motion — in the same order.
+  */
+  readonly reducedMotion?: () => boolean;
+  /**
+  * Called whenever the cursor moves and whenever the slide changes by itself
+  * — a delayed effect arriving, an effect finishing — so a view mirroring the
+  * slide never lags behind what the audience can see.
+  */
+  readonly onChange?: (player: AnimationPlayer) => void;
+}
+interface AnimationPlayer {
+  readonly cursor: number;
+  readonly stopCount: number;
+  /** True while a click still has an effect to play on this slide. */
+  readonly pending: boolean;
+  /** True while an effect already started is still on its way. */
+  readonly running: boolean;
+  readonly progress: AnimationProgress;
+  /**
+  * The steps this player does not run, so a caller can say so rather than let
+  * a slide look as though it has no animation.
+  */
+  readonly unsupported: UnsupportedAnimation[];
+  reset(): void;
+  /** Plays the next stop. False when the slide has none left. */
+  advance(): boolean;
+  /** Takes one stop back, showing everything before it. False at the start. */
+  back(): boolean;
+  /** Moves straight to a point in the click order, without motion. */
+  jumpTo(next: number): void;
+  /**
+  * Shows the moment another view of the same slide is showing: the stops
+  * before `next` played out, and the one it is on started `elapsed` ago — so
+  * an effect waiting on a delay over there has not arrived here either, and
+  * one half-way through a fade is half-way through it here.
+  */
+  resume(next: number, elapsed: number | null): void;
+  /** Everything the slide ends with — what a still preview shows. */
+  finish(): void;
+  dispose(): void;
+}
+/**
+* Groups the steps into the stops the viewer clicks through, with each step's
+* start measured from the beginning of its stop, and lists the steps that are
+* left out with the reason why.
+*/
+declare const buildAnimationStops: (steps: readonly SlideAnimationStep[] | null | undefined) => AnimationPlan;
+/** Plays a slide's animations against a rendered SVG. */
+declare const createAnimationPlayer: (options: AnimationPlayerOptions) => AnimationPlayer;
+//#endregion
+export { buildAnimationStops, createAnimationPlayer };
+//# sourceMappingURL=animation-player.d.ts.map

package/dist/internal/animation-player.js

@@ -0,0 +1,2 @@
+import { n as createAnimationPlayer, t as buildAnimationStops } from "../animation-player-D2mt2MI8.js";
+export { buildAnimationStops, createAnimationPlayer };

package/dist/internal.d.ts

@@ -0,0 +1,33 @@
+import { i as EditorOptions, n as EditorHandle } from "./index-BFQN6sI6.js";
+
+//#region src/core/dev-host.d.ts
+/** What `@office-kit/pptx-editor/internal` adds to a mount for `@office-kit/pptx-dev`. */
+interface DevHostOptions {
+  /**
+  * The editor runs in the preview's frame, whose page presents slide shows
+  * and hosts the Agents pane over `postMessage`.
+  */
+  readonly previewFrame?: boolean;
+  /**
+  * Shows Help ▸ Feedback, opening `url` in a new tab. A host that embeds the
+  * editor owns its own support channel, so the public `mountEditor` shows no
+  * feedback entry point and the editor bundle carries no feedback URL.
+  */
+  readonly feedback?: {
+    readonly url: string;
+  };
+}
+//#endregion
+//#region src/internal.d.ts
+/**
+* `mountEditor` for `pptx-dev`'s editor page. Inside the preview's frame
+* (`previewFrame`), Slide Show, Reading View, Rehearse Timings and the Agents
+* pane button talk to that page over `postMessage`, and the editor reports the
+* slide being edited to it. `feedback` adds Help ▸ Feedback, which hosts of the
+* public `mountEditor` never get.
+* @internal
+*/
+declare function mountDevEditor(target: HTMLElement, options: EditorOptions, dev: DevHostOptions): EditorHandle;
+//#endregion
+export { type DevHostOptions, mountDevEditor };
+//# sourceMappingURL=internal.d.ts.map

package/dist/internal.js

@@ -0,0 +1,18 @@
+import { i as devHostOptions, t as mountEditor } from "./src-BrBOgen_.js";
+//#region src/internal.ts
+/**
+* `mountEditor` for `pptx-dev`'s editor page. Inside the preview's frame
+* (`previewFrame`), Slide Show, Reading View, Rehearse Timings and the Agents
+* pane button talk to that page over `postMessage`, and the editor reports the
+* slide being edited to it. `feedback` adds Help ▸ Feedback, which hosts of the
+* public `mountEditor` never get.
+* @internal
+*/
+function mountDevEditor(target, options, dev) {
+	devHostOptions.set(options, dev);
+	return mountEditor(target, options);
+}
+//#endregion
+export { mountDevEditor };
+
+//# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","names":[],"sources":["../src/internal.ts"],"sourcesContent":["// UNSTABLE, NOT PUBLIC API. `@office-kit/pptx-editor/internal` and\n// `@office-kit/pptx-editor/internal/animation-player` exist only for\n// `@office-kit/pptx-dev`. They change or disappear in any release, without\n// notice. Everything else the dev host needs goes through `mountEditor`.\n\nimport { mountEditor, type EditorHandle, type EditorOptions } from './index.ts';\nimport { devHostOptions, type DevHostOptions } from './core/dev-host.ts';\n\nexport type { DevHostOptions } from './core/dev-host.ts';\n\n/**\n * `mountEditor` for `pptx-dev`'s editor page. Inside the preview's frame\n * (`previewFrame`), Slide Show, Reading View, Rehearse Timings and the Agents\n * pane button talk to that page over `postMessage`, and the editor reports the\n * slide being edited to it. `feedback` adds Help ▸ Feedback, which hosts of the\n * public `mountEditor` never get.\n * @internal\n */\nexport function mountDevEditor(\n  target: HTMLElement,\n  options: EditorOptions,\n  dev: DevHostOptions,\n): EditorHandle {\n  devHostOptions.set(options, dev);\n  return mountEditor(target, options);\n}\n"],"mappings":";;;;;;;;;;AAkBA,SAAgB,eACd,QACA,SACA,KACc;CACd,eAAe,IAAI,SAAS,GAAG;CAC/B,OAAO,YAAY,QAAQ,OAAO;AACpC"}

package/dist/merge.d.ts

@@ -0,0 +1,2 @@
+import { a as mergeDecks, i as describeConflict, n as DeckMerge, r as comparablePart, t as DeckConflict } from "./deck-merge-r5VCQNH_.js";
+export { type DeckConflict, type DeckMerge, comparablePart, describeConflict, mergeDecks };

package/dist/merge.js

@@ -0,0 +1,2 @@
+import { n as describeConflict, r as mergeDecks, t as comparablePart } from "./deck-merge-B_Damj97.js";
+export { comparablePart, describeConflict, mergeDecks };