@reportwright/viewer 0.12.1 → 0.13.1

package/dist/designer.d.ts

@@ -3,8 +3,11 @@
  * @typedef {{ server?: string, fontsUrl?: string, report?: string, definition?: object, lang?: string, height?: string,
  *   onSave?: (definition: import('@reportwright/engine/report').Report) => unknown, onOpen?: () => object | null | undefined | Promise<object | null | undefined>, readOnly?: boolean,
  *   toolbox?: { hide?: string[] }, panels?: { data?: boolean, inspector?: boolean }, dataSourceTemplates?: DataSourceTemplate[], nonce?: string,
- *   allowHosts?: string[], unsafeFetch?: boolean, fetch?: typeof fetch }} DesignerOptions (allowHosts, unsafeFetch, fetch: as mountViewer's)
- * @typedef {{ unmount: () => void, getDefinition: () => object, save: () => Promise<void> }} DesignerHandle
+ *   allowHosts?: string[], unsafeFetch?: boolean, fetch?: typeof fetch, warnOnLeave?: boolean, onDirtyChange?: (dirty: boolean) => void }} DesignerOptions
+ *   (allowHosts, unsafeFetch, fetch: as mountViewer's). warnOnLeave (default true): the browser asks before the page is
+ *   left or reloaded with unsaved changes; false leaves that to the host (isDirty, onDirtyChange). onDirtyChange: called
+ *   when the report gets unsaved changes (true) and when they are saved (false).
+ * @typedef {{ unmount: () => void, getDefinition: () => object, save: () => Promise<void>, isDirty: () => boolean }} DesignerHandle
  */
 /**
  * Mount the ReportWright designer in an element. With onSave the host app saves; without it, the server named
@@ -23,7 +26,9 @@ export type DataSourceTemplate = {
     };
 };
 /**
- * (allowHosts, unsafeFetch, fetch: as mountViewer's)
+ * (allowHosts, unsafeFetch, fetch: as mountViewer's). warnOnLeave (default true): the browser asks before the page is
+ * left or reloaded with unsaved changes; false leaves that to the host (isDirty, onDirtyChange). onDirtyChange: called
+ * when the report gets unsaved changes (true) and when they are saved (false).
  */
 export type DesignerOptions = {
     server?: string;
@@ -47,9 +52,12 @@ export type DesignerOptions = {
     allowHosts?: string[];
     unsafeFetch?: boolean;
     fetch?: typeof fetch;
+    warnOnLeave?: boolean;
+    onDirtyChange?: (dirty: boolean) => void;
 };
 export type DesignerHandle = {
     unmount: () => void;
     getDefinition: () => object;
     save: () => Promise<void>;
+    isDirty: () => boolean;
 };