framefields 2.14.0 → 2.16.0

package/dist/{index-Bv7gxGK1.d.mts → index-Cq8jgdNY.d.mts}

@@ -1,5 +1,92 @@
-import { f as HeadlessMediaRenderer } from "./index-C7-p9zwU.mjs";
+import { f as HeadlessMediaRenderer } from "./index-DhL7ckvs.mjs";
 
+//#region src/preview/embed-protocol.d.ts
+
+/**
+ * The preview page's message channel with an app that embeds it in a frame
+ * (protocol 1). The page talks only when embedded, with
+ * `window.parent.postMessage(message, "*")`, and takes commands only from
+ * `window.parent`. Every message has a `type` starting `framefields-preview:`.
+ *
+ * Page → parent: `ready` once the first frame shows; `state` on play, pause,
+ * each finished seek, and up to 4 times a second while playing; `build`
+ * around a rebuild (and `error` when a build or a frame fails); `reply` to
+ * each command. Parent → page: `command`, answered by a `reply` with its `id`.
+ *
+ * The page also seeks when its address fragment changes (`#t=12.5`,
+ * `#frame=375`), without a reload; `seekByHash` in `ready` says so.
+ */
+declare const PREVIEW_PROTOCOL = 1;
+/** The film the page shows. `frames` is its frame count, `duration` the last frame's time in seconds. */
+interface PreviewFilm {
+  title: string;
+  width: number;
+  height: number;
+  fps: number;
+  frames: number;
+  duration: number;
+}
+/** Where the page is. `time` is `frame / fps` in seconds. */
+interface PreviewPosition {
+  frame: number;
+  time: number;
+  playing: boolean;
+}
+interface PreviewReadyMessage {
+  type: "framefields-preview:ready";
+  protocol: typeof PREVIEW_PROTOCOL;
+  /** Setting the frame's `#t=` / `#frame=` seeks in place. */
+  seekByHash: true;
+  meta: PreviewFilm;
+}
+interface PreviewStateMessage extends PreviewPosition {
+  type: "framefields-preview:state";
+}
+interface PreviewBuildMessage {
+  type: "framefields-preview:build";
+  /**
+   * "building" before the page reloads into a rebuilt preview (its `ready`
+   * after the reload means it's done), "error" when a build or a frame
+   * failed, with the text.
+   */
+  status: "building" | "ready" | "error";
+  message?: string;
+}
+type PreviewCommand = /** `time` in seconds. */
+{
+  command: "seek";
+  time: number;
+} | {
+  command: "seekFrame";
+  frame: number;
+} | {
+  command: "play";
+} | {
+  command: "pause";
+} | {
+  command: "state";
+};
+type PreviewCommandMessage = {
+  type: "framefields-preview:command";
+  /** Echoed in the reply. */
+  id: string;
+} & PreviewCommand;
+/** The answer to a command, once it's done (a seek once the frame is drawn). */
+type PreviewReplyMessage = {
+  type: "framefields-preview:reply";
+  id: string;
+} & ({
+  ok: true;
+  state: PreviewPosition;
+} | {
+  ok: false;
+  error: string;
+});
+/** Everything the page posts to its parent. */
+type PreviewMessage = PreviewReadyMessage | PreviewStateMessage | PreviewBuildMessage | PreviewReplyMessage;
+/** The command in a message from the parent, or null when it isn't a well-formed one. */
+declare function readPreviewCommand(data: unknown): PreviewCommandMessage | null;
+//#endregion
 //#region src/preview/index.d.ts
 /** Where the composition comes from: the module that builds it. */
 interface PreviewSource {
@@ -85,5 +172,5 @@ interface PreviewSession {
  */
 declare function startPreview(source: PreviewSource, options?: PreviewOptions): Promise<PreviewSession>;
 //#endregion
-export { startPreview as a, PreviewSource as i, PreviewOptions as n, PreviewSession as r, PreviewCloseReason as t };
-//# sourceMappingURL=index-Bv7gxGK1.d.mts.map
+export { startPreview as a, PreviewCommand as c, PreviewMessage as d, PreviewPosition as f, readPreviewCommand as g, PreviewStateMessage as h, PreviewSource as i, PreviewCommandMessage as l, PreviewReplyMessage as m, PreviewOptions as n, PREVIEW_PROTOCOL as o, PreviewReadyMessage as p, PreviewSession as r, PreviewBuildMessage as s, PreviewCloseReason as t, PreviewFilm as u };
+//# sourceMappingURL=index-Cq8jgdNY.d.mts.map

package/dist/index-Cq8jgdNY.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-Cq8jgdNY.d.mts","names":[],"sources":["../src/preview/embed-protocol.ts","../src/preview/index.ts"],"sourcesContent":[],"mappings":";;;;;;;AAeA;AAGA;AAUA;AAMA;AAQA;AAIA;AAWA;AAQA;AAOA;AAMA;;AAEG,cAjEU,gBAAA,GAiEV,CAAA;;AAEA,UAhEc,WAAA,CAgEd;EAAmB,KAAA,EAAA,MAAA;EAKN,KAAA,EAAA,MAAA;;;;EC5CC,QAAA,EAAA,MAAa;AAsB9B;AAoDA;AAQiB,UDjGA,eAAA,CCiGc;EAErB,KAAA,EAAA,MAAA;EAEO,IAAA,EAAA,MAAA;EAAR,OAAA,EAAA,OAAA;;AAkBa,UDjHL,mBAAA,CCiHiB;EACzB,IAAA,EAAA,2BAAA;EACC,QAAA,EAAA,ODjHQ,gBCiHR;EACC;EAAR,UAAA,EAAA,IAAA;EAAO,IAAA,ED/GH,WC+GG;;UD5GO,mBAAA,SAA4B;;;UAI5B,mBAAA;;;;;;;;;;KAWL,cAAA;;;;;;;;;;;;;;KAQA,qBAAA;;;;IAIR;;KAGQ,mBAAA;;;;;SAGY;;;;;;KAGZ,cAAA,GACT,sBACA,sBACA,sBACA;;iBAKa,kBAAA,iBAEb;;;;AA1EU,UC4BI,aAAA,CD5BY;EAGZ;EAUA,KAAA,EAAA,MAAA,GCiBA,GDjBe;EAMf;AAQjB;AAIA;AAWA;EAQY,MAAA,CAAA,EAAA,MAAA;AAOZ;AAMY,UCbK,cAAA,CDaS;EACvB;;;;;EAQa,IAAA,CAAA,EAAA,MAAA;;;;AC5ChB;AAsBA;AAoDA;AAQA;EAEU,IAAA,CAAA,EAAA,OAAA;EAEO;EAAR,KAAA,CAAA,EAAA,MAAA;EAAO;EAkBM,KAAA,CAAA,EAAA,OAAY;EACzB;EACC,QAAA,CAAA,EAhEE,qBAgEF;EACC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAjCC,kBAAA;;;;UAQK,cAAA;;WAEP;;UAED,QAAQ;;;;;;;;;;;;;iBAkBK,YAAA,SACb,yBACC,iBACP,QAAQ"}