samcan 0.0.1 → 0.0.2

package/dist/wrapper/react/use-samcan-player.d.ts

@@ -0,0 +1,33 @@
+import type { RefObject } from "react";
+import { type AnimationPlayer, type LoadOptions, type PlayerConfig } from "../../core/api";
+export interface UseSamcanPlayerOptions {
+    /**
+     * URL of the animation to load. If omitted, the
+     * hook only creates the player and leaves loading
+     * to the caller via the returned instance.
+     */
+    src?: string;
+    /**
+     * Whether to start playing immediately after load.
+     * Overrides `config.autoplay` if provided.
+     */
+    autoplay?: boolean;
+    /**
+     * Options forwarded to `AnimationPlayer.load`.
+     */
+    loadOptions?: LoadOptions;
+    /**
+     * Additional player configuration. The `canvas`
+     * property is managed by the hook and ignored.
+     */
+    config?: Omit<PlayerConfig, "canvas">;
+}
+interface UseSamcanPlayerResult {
+    canvasRef: RefObject<HTMLCanvasElement>;
+    player: AnimationPlayer | null;
+    isLoading: boolean;
+    error: Error | null;
+}
+export declare function useSamcanPlayer(options?: UseSamcanPlayerOptions): UseSamcanPlayerResult;
+export {};
+//# sourceMappingURL=use-samcan-player.d.ts.map

package/dist/wrapper/react/use-samcan-player.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-samcan-player.d.ts","sourceRoot":"","sources":["../../../wrapper/react/use-samcan-player.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEtC,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,YAAY,EAEpB,MAAM,gBAAgB,CAAA;AAEvB,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAA;CACxC;AAED,UAAU,qBAAqB;IAC3B,SAAS,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAA;IACvC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAC9B,SAAS,EAAE,OAAO,CAAA;IAClB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACtB;AAED,wBAAgB,eAAe,CAC3B,OAAO,GAAE,sBAA2B,GACrC,qBAAqB,CAwEvB"}

package/dist/wrapper/react/use-samcan-player.js

@@ -0,0 +1,65 @@
+import { useEffect, useRef, useState } from "react";
+import { createPlayer, } from "../../core/api";
+export function useSamcanPlayer(options = {}) {
+    const { src, autoplay, loadOptions, config } = options;
+    const canvasRef = useRef(null);
+    const [player, setPlayer] = useState(null);
+    const [isLoading, setIsLoading] = useState(false);
+    const [error, setError] = useState(null);
+    // Keep latest options in refs to avoid re-creating
+    // the player unnecessarily.
+    const latestOptionsRef = useRef(options);
+    latestOptionsRef.current = options;
+    useEffect(() => {
+        const canvas = canvasRef.current;
+        if (!canvas) {
+            return;
+        }
+        let cancelled = false;
+        let currentPlayer = null;
+        async function setup() {
+            setIsLoading(true);
+            setError(null);
+            try {
+                const baseConfig = {
+                    canvas: canvas,
+                    ...(config ?? {}),
+                };
+                const createdPlayer = await createPlayer(baseConfig);
+                if (cancelled) {
+                    createdPlayer.destroy();
+                    return;
+                }
+                currentPlayer = createdPlayer;
+                setPlayer(createdPlayer);
+                const effectiveAutoplay = autoplay ?? config?.autoplay ?? false;
+                if (src) {
+                    await createdPlayer.load(src, loadOptions);
+                    if (effectiveAutoplay) {
+                        createdPlayer.play();
+                    }
+                }
+            }
+            catch (err) {
+                if (cancelled) {
+                    return;
+                }
+                setError(err instanceof Error ? err : new Error(String(err)));
+            }
+            finally {
+                if (!cancelled) {
+                    setIsLoading(false);
+                }
+            }
+        }
+        void setup();
+        return () => {
+            cancelled = true;
+            if (currentPlayer) {
+                currentPlayer.destroy();
+            }
+        };
+    }, [src, autoplay, loadOptions, config]);
+    return { canvasRef, player, isLoading, error };
+}
+//# sourceMappingURL=use-samcan-player.js.map

package/dist/wrapper/react/use-samcan-player.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-samcan-player.js","sourceRoot":"","sources":["../../../wrapper/react/use-samcan-player.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AACnD,OAAO,EAIH,YAAY,GACf,MAAM,gBAAgB,CAAA;AAmCvB,MAAM,UAAU,eAAe,CAC3B,UAAkC,EAAE;IAEpC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IAEtD,MAAM,SAAS,GAAG,MAAM,CAAoB,IAAI,CAAC,CAAA;IACjD,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAyB,IAAI,CAAC,CAAA;IAClE,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IACjD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAe,IAAI,CAAC,CAAA;IAEtD,mDAAmD;IACnD,4BAA4B;IAC5B,MAAM,gBAAgB,GAAG,MAAM,CAAyB,OAAO,CAAC,CAAA;IAChE,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAA;IAElC,SAAS,CAAC,GAAG,EAAE;QACX,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAA;QAChC,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAM;QACV,CAAC;QAED,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,aAAa,GAA2B,IAAI,CAAA;QAEhD,KAAK,UAAU,KAAK;YAChB,YAAY,CAAC,IAAI,CAAC,CAAA;YAClB,QAAQ,CAAC,IAAI,CAAC,CAAA;YAEd,IAAI,CAAC;gBACD,MAAM,UAAU,GAAiB;oBAC7B,MAAM,EAAE,MAA2B;oBACnC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;iBACpB,CAAA;gBAED,MAAM,aAAa,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,CAAA;gBACpD,IAAI,SAAS,EAAE,CAAC;oBACZ,aAAa,CAAC,OAAO,EAAE,CAAA;oBACvB,OAAM;gBACV,CAAC;gBAED,aAAa,GAAG,aAAa,CAAA;gBAC7B,SAAS,CAAC,aAAa,CAAC,CAAA;gBAExB,MAAM,iBAAiB,GAAG,QAAQ,IAAI,MAAM,EAAE,QAAQ,IAAI,KAAK,CAAA;gBAE/D,IAAI,GAAG,EAAE,CAAC;oBACN,MAAM,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;oBAC1C,IAAI,iBAAiB,EAAE,CAAC;wBACpB,aAAa,CAAC,IAAI,EAAE,CAAA;oBACxB,CAAC;gBACL,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,IAAI,SAAS,EAAE,CAAC;oBACZ,OAAM;gBACV,CAAC;gBACD,QAAQ,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;YACjE,CAAC;oBAAS,CAAC;gBACP,IAAI,CAAC,SAAS,EAAE,CAAC;oBACb,YAAY,CAAC,KAAK,CAAC,CAAA;gBACvB,CAAC;YACL,CAAC;QACL,CAAC;QAED,KAAK,KAAK,EAAE,CAAA;QAEZ,OAAO,GAAG,EAAE;YACR,SAAS,GAAG,IAAI,CAAA;YAChB,IAAI,aAAa,EAAE,CAAC;gBAChB,aAAa,CAAC,OAAO,EAAE,CAAA;YAC3B,CAAC;QACL,CAAC,CAAA;IACL,CAAC,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;AAClD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "samcan",
-    "version": "0.0.1",
+    "version": "0.0.2",
     "description": "canvas",
     "license": "MIT",
     "author": "aquaticcalf",
@@ -17,6 +17,11 @@
             "types": "./dist/index.d.ts",
             "import": "./dist/index.js",
             "default": "./dist/index.js"
+        },
+        "./react": {
+            "types": "./dist/wrapper/react/index.d.ts",
+            "import": "./dist/wrapper/react/index.js",
+            "default": "./dist/wrapper/react/index.js"
         }
     },
     "files": [
@@ -25,27 +30,36 @@
     "scripts": {
         "dev": "bun index.ts",
         "build": "bun x tsc -p tsconfig.build.json",
+        "bundle": "bun build ./index.ts --outfile ./dist/bundle.js --target browser --format esm",
         "tsc": "tsc --noEmit",
         "fix": "biome format --write",
         "loc": "bun .scripts/cloc.ts",
-        "prepare": "husky"
+        "bench": "bun .scripts/benchmark.ts",
+        "prepare": "husky",
+        "demo": "bun run build && bun run bundle && bun demo-server.ts",
+        "test": "bun test"
     },
     "devDependencies": {
-        "@biomejs/biome": "^2.3.5",
-        "@playwright/test": "^1.56.1",
+        "@biomejs/biome": "^2.3.6",
         "@types/bun": "^1.3.2",
         "@types/earcut": "^3.0.0",
         "@types/jsdom": "^27.0.0",
+        "@types/react": "18.3.1",
+        "@types/react-dom": "18.3.1",
         "canvas": "^3.2.0",
         "cloc": "^2.6.0-cloc",
         "husky": "^9.1.7",
         "jsdom": "^27.2.0",
         "mcp-fetch-server": "^1.0.2",
-        "playwright": "^1.56.1",
         "typescript": "^5.9.3"
     },
+    "peerDependencies": {
+        "react": "^18.3.1",
+        "react-dom": "^18.3.1"
+    },
     "dependencies": {
         "earcut": "^3.0.2",
-        "paper": "^0.12.18"
+        "paper": "^0.12.18",
+        "tinybench": "^5.1.0"
     }
 }

package/readme.md

@@ -1,13 +1,96 @@
 ## samcan
 
+### what?
+
+samcan is an animation runtime for the web, my attempt at resurrecting [Flash](https://en.wikipedia.org/wiki/Adobe_Flash)
+
+### install
+
+<details open>
+<summary>npm</summary>
+
+```bash
+npm install samcan
+```
+</details>
+
+<details>
+<summary>bun</summary>
+
+```bash
+bun add samcan
+```
+ </details>
+
+<details>
+<summary>yarn</summary>
+
+```bash
+yarn add samcan
+```
+</details>
+
+<details>
+<summary>pnpm</summary>
+
+```bash
+pnpm add samcan
+```
+</details>
+
+### import
+
+```ts
+import { AnimationRuntime } from "samcan"
+```
 
 ### lines of code
 
-|folder       |code         |empty        |comments     |total        |
+|x            |code         |comments     |empty        |total        |
 |-------------|-------------|-------------|-------------|-------------|
-|core         |8178         |1601         |3328         |13107        |
-|editor       |0            |0            |0            |0            |
-|test         |6204         |1594         |130          |7928         |
-|**total**    |**14382**    |**3195**     |**3458**     |**21035**    |
+|core         |8187         |3333         |1604         |13124        |
+|test         |6383         |143          |1634         |8160         |
+|**total**    |**14570**    |**3476**     |**3238**     |**21284**    |
+
+### benchmarks
+
+<details>
+<summary>timeline</summary>
+
+|name                            |ops/s                           |latency avg (ns)                |samples                         |
+|--------------------------------|--------------------------------|--------------------------------|--------------------------------|
+|timeline-eval-10-tracks         |1402671 ± 0.02%                 |728.05 ± 0.46%                  |686770                          |
+|timeline-eval-100-tracks        |152697 ± 0.07%                  |6664.4 ± 0.34%                  |75026                           |
+|timeline-eval-500-tracks        |33008 ± 0.13%                   |30691 ± 0.40%                   |16292                           |
+
+</details>
+
+<details>
+<summary>scene graph</summary>
+
+|name                            |ops/s                           |latency avg (ns)                |samples                         |
+|--------------------------------|--------------------------------|--------------------------------|--------------------------------|
+|scene-world-transform-1k-nodes  |673175 ± 0.06%                  |1574.9 ± 0.70%                  |317474                          |
+|scene-world-transform-5k-nodes  |821988 ± 0.05%                  |1284.5 ± 0.57%                  |389245                          |
+
+</details>
+
+### star history
+
+<a href="https://www.star-history.com/#aquaticcalf/samcan&legend=bottom-right">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=aquaticcalf/samcan&theme=dark&legend=bottom-right" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=aquaticcalf/samcan&legend=bottom-right" />
+   <img alt="star history chart" src="https://api.star-history.com/svg?repos=aquaticcalf/samcan&legend=bottom-right" />
+ </picture>
+</a>
+
+### badges
+
+[![npm](https://img.shields.io/npm/v/samcan?style=for-the-badge&color=000000&labelColor=000000)](https://www.npmjs.com/package/samcan/)
+[![license](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge&color=000000&labelColor=000000)](https://github.com/aquaticcalf/samcan/tree/dev?tab=MIT-1-ov-file)
+[![typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&color=000000)](https://www.npmjs.com/package/samcan/)
+
+<br/>
 
-### another heading
+<p align="center">built with &nbsp;<img src="https://raw.githubusercontent.com/kirodotdev/Kiro/c18e8771341281fb8c4ca46bbc41e0b2a29b5313/assets/kiro-icon.png" alt="kiro" width="20" height="20" style="vertical-align: middle;"></p>