@casadi/casadi-viz 0.1.0-dev.0 → 3.8.1

package/README.md

@@ -100,22 +100,22 @@ repository. See `toolchain/README.md` for the tested source-build recipe.
 
 ## Native HTML export uses this same viewer
 
-```sh
-npm run build
-node scripts/vendor-casadi.mjs /path/to/casadi-worktree
-```
-
-This copies `dist/standalone.html` into CasADi's embedded resource and records its
-package version and SHA-256. Rebuild CasADi afterwards. The template has exactly
-two placeholders: `@@GRAPH_DATA@@` and `@@VIZ_CONFIG@@`; C++ fills these without
-executing JavaScript or contacting npm.
-
-The template is generated from the same component used by the npm entry point.
-It contains the viewer code and CSS. CasADi's `viz_js` option additionally embeds
-the Viz.js runtime; otherwise the existing pinned CDN configuration applies.
-No JavaScript toolchain is required for ordinary CasADi builds using the vendored
-asset. Maintain viewer source here, regenerate the artifact, and vendor an
-explicit version when updating CasADi.
+CasADi's `misc/casadi_viz.html` is a small HTML shell that loads this package
+from unpkg using the producing CasADi major/minor version. Graph data stays embedded in the exported
+HTML; opening it requires internet access to load the viewer and renderer.
+The `viz_js` option can embed a local renderer, but the viewer still loads from
+unpkg. No JavaScript toolchain or vendored viewer bundle is needed to build CasADi.
+CasADi `3.8.x` selects `@casadi/casadi-viz@3.8`, resolving to the latest stable
+`3.8.y` viewer. The two patch numbers are independent. Every viewer patch in
+that line must support graphs and traces from all CasADi `3.8.x` releases.
+Breaking format changes belong to a new compatibility line (for example `3.11`).
+Keep old lines published and backport compatible viewer fixes as needed.
+
+The `viewer_url` string option overrides the default module URL, for example
+for a locally served development build. The HTML imports the ESM viewer. Its renderer URL is relative to the resolved
+module URL, so both assets come from the same exact package release even if a
+new patch is published between requests. Explicit graph and trace schema
+versions remain independent of this package compatibility convention.
 
 C++ remains responsible for graph extraction, JSON serialization and standalone
 DOT generation. Interactive DOT assembly and rendering live in this repository.
@@ -125,6 +125,8 @@ DOT generation. Interactive DOT assembly and rendering live in this repository.
 The package accepts `format: "casadi_viz", version: 1`. The root Function is
 index 0; `functions[i]` is index `i+1`. Call nodes' `callee` fields index that
 registry. `include_functions: false` exports keep calls but omit their internals.
+`casadi_version` records the producing CasADi version (for example `"3.8.1"`),
+independently of the bundle schema version. Older exports may omit it.
 Sparsities are compressed-column arrays; constants are strings in nonzero order.
 Instruction IDs match CasADi `dump_trace` records. TypeScript declarations describe
 the fields. Full mathematical metadata remains available independently of the
@@ -163,7 +165,7 @@ fail before packaging.
 
 The release job uses npm trusted publishing (OIDC), with provenance. Before the
 first npm release, arrange package access and configure npm's trusted publisher
-for GitHub organization `casadi`, repository `casadi-viz`, workflow `test.yml`,
+for GitHub organization `casadi`, repository `casadi-viz`, workflow `publish.yml`,
 with direct publishing allowed and no environment restriction. This registry-side
 configuration has not been performed by the repository setup. See
 [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/).

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export interface FunctionGraph {
   edges:{from:number;output:number;to:number;input:number}[];
 }
 export interface GraphBundle extends FunctionGraph {
+  casadi_version?:string;
   format:'casadi_viz';view:'function'|'expression';functions:FunctionGraph[];
 }
 export interface Viewer {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casadi/casadi-viz",
-  "version": "0.1.0-dev.0",
+  "version": "3.8.1",
   "description": "Interactive CasADi expression and Function graphs, with optional evaluation trace replay",
   "type": "module",
   "license": "LGPL-3.0-or-later",