wff-web 0.1.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2024-2026 Patrick Auld
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+interface RenderOptions {
+    xml: string;
+    assets?: Map<string, ArrayBuffer>;
+    width?: number;
+    height?: number;
+    time?: Date;
+    ambient?: boolean;
+    configuration?: Record<string, string | number | boolean>;
+    /** If true, start a requestAnimationFrame loop and re-render each frame. */
+    animate?: boolean;
+}
+interface RenderResult {
+    metadata: Map<string, string>;
+    /** Stop the animation loop (only present when animate=true). */
+    stop?: () => void;
+}
+/**
+ * Render a WFF v4 watch face XML onto a canvas element.
+ *
+ * If options.animate is true, starts a requestAnimationFrame loop and
+ * re-renders each frame with updated time and elapsed milliseconds.
+ * Returns a stop() function in the result to cancel the loop.
+ *
+ * For static (snapshot) renders, elapsedMs = 0 so all animations are at
+ * their start state.
+ */
+declare function renderWatchFace(canvas: HTMLCanvasElement, options: RenderOptions): Promise<RenderResult>;
+
+export { type RenderOptions, type RenderResult, renderWatchFace };