@reportwright/viewer 0.12.0 → 0.13.0

package/dist/designer.d.ts

@@ -1,9 +1,13 @@
 /**
  * @typedef {{ label?: string, source: { name: string, type: string, [key: string]: unknown } }} DataSourceTemplate
  * @typedef {{ server?: string, fontsUrl?: string, report?: string, definition?: object, lang?: string, height?: string,
- *   onSave?: (definition: object) => unknown, onOpen?: () => object | null | undefined | Promise<object | null | undefined>, readOnly?: boolean,
- *   toolbox?: { hide?: string[] }, panels?: { data?: boolean, inspector?: boolean }, dataSourceTemplates?: DataSourceTemplate[], nonce?: string }} DesignerOptions
- * @typedef {{ unmount: () => void, getDefinition: () => object, save: () => Promise<void> }} DesignerHandle
+ *   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, 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
@@ -21,6 +25,11 @@ export type DataSourceTemplate = {
         [key: string]: unknown;
     };
 };
+/**
+ * (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;
     fontsUrl?: string;
@@ -28,7 +37,7 @@ export type DesignerOptions = {
     definition?: object;
     lang?: string;
     height?: string;
-    onSave?: (definition: object) => unknown;
+    onSave?: (definition: import('@reportwright/engine/report').Report) => unknown;
     onOpen?: () => object | null | undefined | Promise<object | null | undefined>;
     readOnly?: boolean;
     toolbox?: {
@@ -40,9 +49,15 @@ export type DesignerOptions = {
     };
     dataSourceTemplates?: DataSourceTemplate[];
     nonce?: string;
+    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;
 };