@grafana/viz-contract 1.5.1 → 1.7.0

package/README.md

@@ -50,6 +50,7 @@ flowchart TB
 | Viz spec | The JSON object that the App gives to the Renderer |
 | Icon cache | The `react-inlinesvg` cache of the copy of `@grafana/ui` in the App. `Icon` reads an SVG from it, and makes no request for that SVG |
 | Note | A text line that the Source gives to `render_grafana_app`, and that the model reads in the same turn (`tool.28`). Not a notice: the Renderer shows a notice in the chart (`state.7`) |
+| Legend overrides | The `fieldConfig` overrides that the user makes with the legend: hide, show and color an item. Only the Renderer keeps them (`renderer.37`) |
 
 The Renderer draws the panels of the package `@plugins/grafana-echarts`.
 
@@ -100,6 +101,29 @@ const pkg = createRequire(import.meta.url).resolve('@grafana/viz-contract/packag
 const fixturesDir = path.join(path.dirname(pkg), 'fixtures');
 ```
 
+## Use the Go module
+
+The Go module `github.com/grafana/viz-contract` holds the bundled schemas, the registries and the fixtures. It has
+the same tags as the npm package. A function gives each folder as its own `fs.FS`: `Registry()` (`registry/`),
+`Schemas()` (`schemas/bundled/`) and `Fixtures()` (`fixtures/`). A binary that calls only `Registry()` does not
+carry the fixtures. A path does not start with the folder name. It is the path after the folder in the npm package.
+
+```sh
+go get github.com/grafana/viz-contract@latest
+```
+
+```go
+import (
+	"io/fs"
+
+	vizcontract "github.com/grafana/viz-contract"
+)
+
+chartTypes, err := fs.ReadFile(vizcontract.Registry(), "chart-types.json")
+vizSpec, err := fs.ReadFile(vizcontract.Schemas(), "viz-spec.schema.json")
+args, err := fs.ReadFile(vizcontract.Fixtures(), "prometheus-line/args.json")
+```
+
 ## Promises
 
 The interfaces do not have the same promise of stability. [8-versioning.md](8-versioning.md) gives the three

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/viz-contract",
-  "version": "1.5.1",
+  "version": "1.7.0",
   "description": "Contract between a Grafana query source, the host that shows the chart, and the Renderer",
   "license": "Apache-2.0",
   "repository": {

package/renderer-api.d.ts

@@ -32,7 +32,7 @@ export interface RenderOptions {
 }
 
 export interface RenderHandle {
-  /** Draws a new viz spec in the same element. */
+  /** Draws a new viz spec in the same element. It keeps the legend overrides of the user (renderer.35). */
   update(spec: unknown): void;
   /**
    * Gives the result of the refresh with this id. id is the id of the RefreshRequest. With ok false, error is the