@grafana/viz-contract 1.3.0 → 1.4.0

package/package.json

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

package/registry/states.json

@@ -68,12 +68,12 @@
   "refresh": [
     {
       "code": "refresh-failed",
-      "when": "The App calls setRefreshed(false, error) with an error text, or onRefresh throws",
+      "when": "The App calls setRefreshed(id, false, error) with an error text, or onRefresh throws",
       "message": "Refresh failed: <error>"
     },
     {
       "code": "refresh-failed-no-detail",
-      "when": "The App calls setRefreshed(false) with no error text",
+      "when": "The App calls setRefreshed(id, false) with no error text",
       "message": "Refresh failed."
     },
     {

package/renderer-api.d.ts

@@ -34,8 +34,11 @@ export interface RenderOptions {
 export interface RenderHandle {
   /** Draws a new viz spec in the same element. */
   update(spec: unknown): void;
-  /** Gives the result of the last refresh. With ok false, error is the text that the Renderer shows. */
-  setRefreshed(ok: boolean, error?: string): void;
+  /**
+   * Gives the result of the refresh with this id. id is the id of the RefreshRequest. With ok false, error is the
+   * text that the Renderer shows.
+   */
+  setRefreshed(id: string, ok: boolean, error?: string): void;
   /** Removes the chart and its listeners. */
   destroy(): void;
 }
@@ -64,7 +67,11 @@ export interface Notice {
 }
 
 /**
- * The cause of a refresh. For timeRange, from and to are the range that the user picked. A relative range, for
- * example now-6h to now, stays relative. An absolute range is in epoch milliseconds.
+ * A refresh. id is a new value for each call of onRefresh. The App gives it to setRefreshed. For timeRange, from
+ * and to are the range that the user picked. A relative range, for example now-6h to now, stays relative. An
+ * absolute range is in epoch milliseconds.
  */
-export type RefreshRequest = { cause: 'refresh' } | { cause: 'timeRange'; from: string; to: string };
+export type RefreshRequest = { id: string } & (
+  | { cause: 'refresh' }
+  | { cause: 'timeRange'; from: string; to: string }
+);