@reportwright/viewer 0.0.0-stage → 0.11.0

package/dist/designer.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @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
+ */
+/**
+ * Mount the ReportWright designer in an element. With onSave the host app saves; without it, the server named
+ * (with neither, there is no Save button). Without `server`, fonts load from `fontsUrl` (a copy of @reportwright/fonts/public/fonts).
+ * @param {string|HTMLElement} target
+ * @param {DesignerOptions} opts
+ * @returns {DesignerHandle}
+ */
+export function mountDesigner(target: string | HTMLElement, opts?: DesignerOptions): DesignerHandle;
+export type DataSourceTemplate = {
+    label?: string;
+    source: {
+        name: string;
+        type: string;
+        [key: string]: unknown;
+    };
+};
+export type DesignerOptions = {
+    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;
+};
+export type DesignerHandle = {
+    unmount: () => void;
+    getDefinition: () => object;
+    save: () => Promise<void>;
+};