@devtable/dashboard 2.4.0 → 3.0.0

package/dist/model/index.d.ts

@@ -1,2 +1,5 @@
+export * from './filters';
+export * from './queries';
+export * from './sql-snippets';
+export * from './context';
 export * from './dashboard';
-export * from './filter';

package/dist/model/queries/index.d.ts

@@ -0,0 +1,116 @@
+import { QueryModelInstance } from './query';
+export declare const QueriesModel: import("mobx-state-tree").IModelType<{
+    original: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        id: import("mobx-state-tree").ISimpleType<string>;
+        type: import("mobx-state-tree").ISimpleType<import("./types").DataSourceType>;
+        key: import("mobx-state-tree").ISimpleType<string>;
+        sql: import("mobx-state-tree").ISimpleType<string>;
+    }, {
+        readonly valid: string;
+        readonly configurations: {
+            id: string;
+            type: import("./types").DataSourceType;
+            key: string;
+            sql: string;
+        };
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>, [undefined]>;
+    current: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        id: import("mobx-state-tree").ISimpleType<string>;
+        type: import("mobx-state-tree").ISimpleType<import("./types").DataSourceType>;
+        key: import("mobx-state-tree").ISimpleType<string>;
+        sql: import("mobx-state-tree").ISimpleType<string>;
+    } & {
+        state: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<"idle" | "loading" | "error">, [undefined]>;
+        data: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IType<Object, Object, Object>>, [undefined]>;
+        error: import("mobx-state-tree").IType<any, any, any>;
+    }, {
+        readonly valid: string;
+        readonly configurations: {
+            id: string;
+            type: import("./types").DataSourceType;
+            key: string;
+            sql: string;
+        };
+    } & {
+        readonly formattedSQL: any;
+    } & {
+        setID(id: string): void;
+        setKey(key: string): void;
+        setType(type: import("./types").DataSourceType): void;
+        setSQL(sql: string): void;
+        fetchData: () => Promise<void>;
+    } & {
+        afterCreate(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>, [undefined]>;
+}, {
+    readonly changed: boolean;
+    readonly firstID: string | undefined;
+    findByID(id: string): ({
+        id: string;
+        type: import("./types").DataSourceType;
+        key: string;
+        sql: string;
+        state: "idle" | "loading" | "error";
+        data: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IType<Object, Object, Object>> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IType<Object, Object, Object>>, [undefined]>>;
+        error: any;
+    } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+        readonly valid: string;
+        readonly configurations: {
+            id: string;
+            type: import("./types").DataSourceType;
+            key: string;
+            sql: string;
+        };
+    } & {
+        readonly formattedSQL: any;
+    } & {
+        setID(id: string): void;
+        setKey(key: string): void;
+        setType(type: import("./types").DataSourceType): void;
+        setSQL(sql: string): void;
+        fetchData: () => Promise<void>;
+    } & {
+        afterCreate(): void;
+    } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+        id: import("mobx-state-tree").ISimpleType<string>;
+        type: import("mobx-state-tree").ISimpleType<import("./types").DataSourceType>;
+        key: import("mobx-state-tree").ISimpleType<string>;
+        sql: import("mobx-state-tree").ISimpleType<string>;
+    } & {
+        state: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<"idle" | "loading" | "error">, [undefined]>;
+        data: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IType<Object, Object, Object>>, [undefined]>;
+        error: import("mobx-state-tree").IType<any, any, any>;
+    }, {
+        readonly valid: string;
+        readonly configurations: {
+            id: string;
+            type: import("./types").DataSourceType;
+            key: string;
+            sql: string;
+        };
+    } & {
+        readonly formattedSQL: any;
+    } & {
+        setID(id: string): void;
+        setKey(key: string): void;
+        setType(type: import("./types").DataSourceType): void;
+        setSQL(sql: string): void;
+        fetchData: () => Promise<void>;
+    } & {
+        afterCreate(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | undefined;
+    readonly options: {
+        value: string;
+        label: string;
+    }[];
+} & {
+    reset(): void;
+    replace(current: Array<QueryModelInstance>): void;
+    append(item: QueryModelInstance): void;
+    remove(index: number): void;
+    replaceByIndex(index: number, replacement: QueryModelInstance): void;
+    downloadAllData(): void;
+    downloadDataByQueryID(queryID: string): void;
+    refetchDataByQueryID(queryID: string): Promise<void> | undefined;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export * from './query';

package/dist/model/queries/mute-query.d.ts

@@ -0,0 +1,17 @@
+import { Instance } from 'mobx-state-tree';
+import { DataSourceType } from './types';
+export declare const MuteQueryModel: import("mobx-state-tree").IModelType<{
+    id: import("mobx-state-tree").ISimpleType<string>;
+    type: import("mobx-state-tree").ISimpleType<DataSourceType>;
+    key: import("mobx-state-tree").ISimpleType<string>;
+    sql: import("mobx-state-tree").ISimpleType<string>;
+}, {
+    readonly valid: string;
+    readonly configurations: {
+        id: string;
+        type: DataSourceType;
+        key: string;
+        sql: string;
+    };
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export declare type MuteQueryModelInstance = Instance<typeof MuteQueryModel>;

package/dist/model/queries/query.d.ts

@@ -0,0 +1,31 @@
+import { Instance } from 'mobx-state-tree';
+import { DataSourceType } from './types';
+export declare const QueryModel: import("mobx-state-tree").IModelType<{
+    id: import("mobx-state-tree").ISimpleType<string>;
+    type: import("mobx-state-tree").ISimpleType<DataSourceType>;
+    key: import("mobx-state-tree").ISimpleType<string>;
+    sql: import("mobx-state-tree").ISimpleType<string>;
+} & {
+    state: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").ISimpleType<"idle" | "loading" | "error">, [undefined]>;
+    data: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IType<Object, Object, Object>>, [undefined]>;
+    error: import("mobx-state-tree").IType<any, any, any>;
+}, {
+    readonly valid: string;
+    readonly configurations: {
+        id: string;
+        type: DataSourceType;
+        key: string;
+        sql: string;
+    };
+} & {
+    readonly formattedSQL: any;
+} & {
+    setID(id: string): void;
+    setKey(key: string): void;
+    setType(type: DataSourceType): void;
+    setSQL(sql: string): void;
+    fetchData: () => Promise<void>;
+} & {
+    afterCreate(): void;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export declare type QueryModelInstance = Instance<typeof QueryModel>;

package/dist/model/queries/types.d.ts

@@ -0,0 +1,5 @@
+export declare enum DataSourceType {
+    Postgresql = "postgresql",
+    MySQL = "mysql",
+    HTTP = "http"
+}

package/dist/model/sql-snippets/index.d.ts

@@ -0,0 +1,26 @@
+import { SQLSnippetModelInstance } from './sql-snippet';
+export declare const SQLSnippetsModel: import("mobx-state-tree").IModelType<{
+    original: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        key: import("mobx-state-tree").ISimpleType<string>;
+        value: import("mobx-state-tree").ISimpleType<string>;
+    }, {
+        setKey(key: string): void;
+        setValue(value: string): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>, [undefined]>;
+    current: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        key: import("mobx-state-tree").ISimpleType<string>;
+        value: import("mobx-state-tree").ISimpleType<string>;
+    }, {
+        setKey(key: string): void;
+        setValue(value: string): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>, [undefined]>;
+}, {
+    readonly changed: boolean;
+} & {
+    reset(): void;
+    replace(current: Array<SQLSnippetModelInstance>): void;
+    append(item: SQLSnippetModelInstance): void;
+    remove(index: number): void;
+    replaceByIndex(index: number, replacement: SQLSnippetModelInstance): void;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export * from './sql-snippet';

package/dist/model/sql-snippets/sql-snippet.d.ts

@@ -0,0 +1,9 @@
+import { Instance } from 'mobx-state-tree';
+export declare const SQLSnippetModel: import("mobx-state-tree").IModelType<{
+    key: import("mobx-state-tree").ISimpleType<string>;
+    value: import("mobx-state-tree").ISimpleType<string>;
+}, {
+    setKey(key: string): void;
+    setValue(value: string): void;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export declare type SQLSnippetModelInstance = Instance<typeof SQLSnippetModel>;

package/dist/panel/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from 'react';
 import { IDashboardPanel } from '../types/dashboard';
 interface IPanel extends IDashboardPanel {
     update?: (panel: IDashboardPanel) => void;
 }
-export declare function Panel({ viz: initialViz, queryID: initialQueryID, title: initialTitle, description: initialDesc, update, layout, id, }: IPanel): JSX.Element;
+export declare const Panel: React.FunctionComponent<IPanel>;
 export {};

package/dist/panel/plugin-adaptor.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { IConfigComponentProps, IViewComponentProps } from '../plugins/viz-manager/components';
+import { IVizConfig } from '../types';
+export declare function PluginVizConfigComponent({ setVizConf, ...props }: IConfigComponentProps & {
+    setVizConf: (val: React.SetStateAction<IVizConfig>) => void;
+}): JSX.Element;
+export declare function PluginVizViewComponent(props: IViewComponentProps): JSX.Element;

package/dist/panel/settings/index.d.ts

@@ -1,7 +1,7 @@
-/// <reference types="react" />
+import React from 'react';
 interface IPanelSettingsModal {
     opened: boolean;
     close: () => void;
 }
-export declare function PanelSettingsModal({ opened, close }: IPanelSettingsModal): JSX.Element;
+export declare const PanelSettingsModal: React.FunctionComponent<IPanelSettingsModal>;
 export {};

package/dist/panel/settings/pick-query/index.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
+import React from 'react';
 interface IPickQuery {
 }
-export declare function PickQuery({}: IPickQuery): JSX.Element;
+export declare const PickQuery: React.FunctionComponent<IPickQuery>;
 export {};

package/dist/panel/title-bar.d.ts

@@ -1,5 +1,5 @@
-/// <reference types="react" />
+import React from 'react';
 interface IPanelTitleBar {
 }
-export declare function PanelTitleBar({}: IPanelTitleBar): JSX.Element;
+export declare const PanelTitleBar: React.FunctionComponent<IPanelTitleBar>;
 export {};

package/dist/panel/viz/index.d.ts

@@ -1,9 +1,9 @@
-/// <reference types="react" />
-import { IVizConfig } from '../../types/dashboard';
+import React from 'react';
+import { IVizConfig } from '../../types';
 interface IViz {
     viz: IVizConfig;
     data: any;
     loading: boolean;
 }
-export declare function Viz({ viz, data, loading }: IViz): JSX.Element;
+export declare const Viz: React.FunctionComponent<IViz>;
 export {};

package/dist/plugins/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './use-channel-event';
+export * from './use-storage-data';

package/dist/plugins/hooks/use-channel-event.d.ts

@@ -0,0 +1,2 @@
+import { ListenerFn, EventEmitter2 } from 'eventemitter2';
+export declare function useChannelEvent(channel: EventEmitter2, event: string, listener: ListenerFn): void;

package/dist/plugins/hooks/use-storage-data.d.ts

@@ -0,0 +1,6 @@
+import { PluginStorage } from '../../types/plugin';
+export declare const useStorageData: <T>(storage: PluginStorage, dataKey: string) => {
+    loading: boolean;
+    value: T | undefined;
+    set: (val: T) => Promise<void>;
+};

package/dist/plugins/index.d.ts

@@ -0,0 +1,4 @@
+export * from './viz-manager';
+export * from './plugin-context';
+export * from './plugin-data-migrator';
+export * from './hooks';

package/dist/plugins/json-plugin-storage.d.ts

@@ -0,0 +1,12 @@
+import { PluginStorage } from '../types/plugin';
+export declare class JsonPluginStorage implements PluginStorage {
+    protected rootRef: {
+        current: Record<string, any>;
+    };
+    constructor(initValue: Record<string, any>);
+    deleteItem(key: string): Promise<void>;
+    getItem<T>(key: string | null): Promise<T>;
+    private getValueFromRoot;
+    setItem<T>(key: string | null, item: T): Promise<T>;
+    watchItem<T>(key: string | null, callback: (value: T, previous?: T) => void): () => void;
+}

package/dist/plugins/message-channels.d.ts

@@ -0,0 +1,7 @@
+import EventEmitter2 from 'eventemitter2';
+import { IMessageChannels } from '../types/plugin';
+export declare class MessageChannels implements IMessageChannels {
+    private channels;
+    globalChannel: EventEmitter2;
+    getChannel(name: string): EventEmitter2;
+}

package/dist/plugins/plugin-context.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { IPluginManager } from '../types/plugin';
+import { PluginManager } from './plugin-manager';
+import { VizManager } from './viz-manager';
+interface IPluginContextProps {
+    pluginManager: IPluginManager;
+    vizManager: VizManager;
+}
+export declare const pluginManager: PluginManager;
+export declare const createPluginContext: () => IPluginContextProps;
+export declare const PluginContext: import("react").Context<IPluginContextProps>;
+export {};

package/dist/plugins/plugin-data-migrator/index.d.ts

@@ -0,0 +1 @@
+export * from './plugin-data-migrator';

package/dist/plugins/plugin-data-migrator/plugin-data-migrator.d.ts

@@ -0,0 +1,13 @@
+interface IMigration {
+    version: number;
+    handler: (data: any) => any;
+}
+export declare class PluginDataMigrator {
+    protected migrations: IMigration[];
+    version(version: number, handler: (data: any) => any): PluginDataMigrator;
+    run(migrationTarget: {
+        from: number;
+        to: number;
+    }, val: any): any;
+}
+export {};

package/dist/plugins/plugin-manager.d.ts

@@ -0,0 +1,18 @@
+import { IDashboardPlugin, IPluginManager, VizComponent } from '../types/plugin';
+export declare class PluginManager implements IPluginManager {
+    /**
+     * Id to plugin map
+     * @private
+     */
+    private plugins;
+    /**
+     * Name to component map
+     */
+    private vizComponents;
+    constructor();
+    factory: {
+        viz: (name: string) => VizComponent;
+    };
+    install(plugin: IDashboardPlugin): void;
+    get installedPlugins(): IDashboardPlugin[];
+}

package/dist/plugins/viz-components/table/index.d.ts

@@ -0,0 +1,2 @@
+import { VizComponent } from '../../../types/plugin';
+export declare const TableVizComponent: VizComponent;

package/dist/{panel/viz → plugins/viz-components}/table/type.d.ts

@@ -19,3 +19,4 @@ export interface ITableConf {
     striped: boolean;
     highlightOnHover: boolean;
 }
+export declare const DEFAULT_CONFIG: ITableConf;

package/dist/plugins/viz-components/table/viz-table-panel.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { VizConfigProps } from '../../../types/plugin';
+export declare function VizTablePanel({ context }: VizConfigProps): JSX.Element;

package/dist/plugins/viz-components/table/viz-table.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { VizViewProps } from '../../../types/plugin';
+export declare function VizTable({ context }: VizViewProps): JSX.Element;

package/dist/plugins/viz-manager/components.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="react" />
+import { IPanelInfoEditor } from '../../types/plugin';
+import { IPanelInfo, IVizManager } from './types';
+export declare type IViewPanelInfo = IPanelInfo & {
+    layout: {
+        w: number;
+        h: number;
+    };
+};
+export declare type IViewComponentProps<TDebug = {}> = {
+    panel: IViewPanelInfo;
+    data: any;
+    vizManager: IVizManager;
+} & TDebug;
+export declare const VizViewComponent: <T>(props: IViewComponentProps<T>) => JSX.Element;
+export declare type IConfigComponentProps<TDebug = {}> = {
+    panel: IPanelInfo;
+    panelInfoEditor: IPanelInfoEditor;
+    vizManager: IVizManager;
+    data: any;
+} & TDebug;
+export declare const VizConfigComponent: <T>(props: IConfigComponentProps<T>) => JSX.Element;

package/dist/plugins/viz-manager/impl.d.ts

@@ -0,0 +1,10 @@
+import { IPluginManager, VizComponent } from '../../types/plugin';
+import { IPanelInfo, IVizManager, VizInstanceInfo } from './types';
+export declare class VizManager implements IVizManager {
+    private pluginManager;
+    private instances;
+    constructor(pluginManager: IPluginManager);
+    get availableVizList(): VizComponent[];
+    resolveComponent(name: string): VizComponent;
+    getOrCreateInstance(panel: IPanelInfo): VizInstanceInfo;
+}

package/dist/plugins/viz-manager/index.d.ts

@@ -0,0 +1,4 @@
+export { VizManager } from './impl';
+export type { IVizManager, IPanelInfo } from './types';
+export { VizConfigComponent, VizViewComponent } from './components';
+export type { IViewPanelInfo, IViewComponentProps } from './components';

package/dist/plugins/viz-manager/types.d.ts

@@ -0,0 +1,12 @@
+import { IDashboardPanel } from '../../types';
+import { IMessageChannels, PluginStorage, VizComponent, VizInstance } from '../../types/plugin';
+export declare type IPanelInfo = Omit<IDashboardPanel, 'layout'>;
+export interface IVizManager {
+    readonly availableVizList: VizComponent[];
+    resolveComponent(type: string): VizComponent;
+    getOrCreateInstance(panel: IPanelInfo): VizInstanceInfo;
+}
+export interface VizInstanceInfo extends VizInstance {
+    messageChannels: IMessageChannels;
+    instanceData: PluginStorage;
+}

package/dist/style.css

@@ -1 +1 @@
-.viz-root{width:100%;overflow:scroll;padding-top:5px;height:calc(100% - 25px);background-color:#fff}.panel-title-wrapper{text-align:center;transition:background-color .3s ease}.panel-title-wrapper:hover{cursor:pointer;background-color:#6464640d}.panel-root{padding:5px;height:100%;width:100%;max-width:100%;background:transparent;border-radius:5px;box-shadow:0 0 10px #0003}.mantine-Tabs-root{width:100%;height:calc(100% - 25px);overflow:hidden;display:flex;justify-content:flex-start;flex-direction:column;flex-wrap:nowrap}.mantine-Tabs-tabsListWrapper{flex:0}.mantine-Tabs-body{flex:1;overflow:scroll}.dashboard-layout{margin-left:-10px;margin-right:-10px}.react-grid-item{padding:0}.remove-panel{position:absolute;right:2px;top:0;cursor:pointer}.code-textarea textarea{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace}
+.viz-root{width:100%;overflow:scroll;padding-top:5px;height:calc(100% - 25px);background-color:#fff}.panel-title-wrapper{text-align:center;transition:background-color .3s ease}.panel-title-wrapper:hover{cursor:pointer;background-color:#6464640d}.panel-root{padding:5px;height:100%;width:100%;max-width:100%;background:transparent;border-radius:5px;box-shadow:0 0 10px #0003}.panel-settings-tabs{width:100%;height:100%}.panel-settings-tabs .mantine-Tabs-panel{height:calc(100% - 25px)}.panel-settings-tabs .mantine-Tabs-tabsListWrapper{flex:0}.panel-settings-tabs .mantine-Tabs-body{flex:1;overflow:scroll}.dashboard-layout{margin-left:-10px;margin-right:-10px}.react-grid-item{padding:0}.remove-panel{position:absolute;right:2px;top:0;cursor:pointer}.code-textarea textarea{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace}.filter-settings-tabs{width:100%;height:100%}.filter-settings-tabs .mantine-Tabs-panel{height:calc(100% - 25px)}.filter-settings-tabs .mantine-Tabs-tabsListWrapper{flex:0}.filter-settings-tabs .mantine-Tabs-body{flex:1;overflow:scroll}.dashboard-root{overflow:scroll;padding:0 10px 10px}.dashboard-sticky-area{z-index:100;background:white;margin:0 -10px;padding:0 10px 10px}

package/dist/types/dashboard.d.ts

@@ -1,14 +1,10 @@
 import { FilterModelInstance } from '../model';
+import { QueryModelInstance } from '../model/queries';
+import { SQLSnippetModelInstance } from '../model/sql-snippets';
 export interface IVizConfig {
     type: string;
     conf: Record<string, any>;
 }
-export interface IQuery {
-    type: 'postgresql';
-    key: string;
-    sql: string;
-    id: string;
-}
 export interface IDashboardPanel {
     id: string;
     title: string;
@@ -29,13 +25,9 @@ export declare enum DashboardMode {
     Layout = "layout",
     Edit = "edit"
 }
-export interface ISQLSnippet {
-    key: string;
-    value: string;
-}
 export interface IDashboardDefinition {
-    sqlSnippets: ISQLSnippet[];
-    queries: IQuery[];
+    sqlSnippets: SQLSnippetModelInstance[];
+    queries: QueryModelInstance[];
 }
 export interface IDashboard {
     id: string;

package/dist/types/plugin/index.d.ts

@@ -0,0 +1,101 @@
+import EventEmitter2 from 'eventemitter2';
+import React from 'react';
+/**
+ * Basic information of a viz component instance
+ */
+export interface VizInstance {
+    id: string;
+    name: string;
+    type: string;
+}
+/**
+ * Props to render the view of viz component
+ */
+export interface VizViewProps {
+    instance: VizInstance;
+    context: VizViewContext;
+}
+export interface PluginStorage {
+    getItem<T>(key: string | null): Promise<T>;
+    setItem<T>(key: string | null, item: T): Promise<T>;
+    deleteItem(key: string): Promise<void>;
+    watchItem<T>(key: string | null, callback: (value: T, previous?: T) => void): () => void;
+}
+export interface ColorPaletteItem {
+    name: string;
+    type: string;
+    category: string;
+}
+export interface SingleColor extends ColorPaletteItem {
+    type: 'single';
+    value: string;
+}
+export interface ColorInterpolation extends ColorPaletteItem {
+    type: 'interpolation';
+    interpolation: (value: number) => string;
+}
+export interface ColorPalette {
+    getColor(colorInfo: ColorPaletteItem): (value: unknown) => string;
+}
+export interface IMessageChannels {
+    globalChannel: EventEmitter2;
+    getChannel(name: string): EventEmitter2;
+}
+export interface VizContext {
+    pluginData: PluginStorage;
+    instanceData: PluginStorage;
+    colorPalette: ColorPalette;
+    locale: string;
+    msgChannels: IMessageChannels;
+    data: unknown;
+}
+declare type Setter<T> = (val: string) => void;
+export interface IPanelInfoEditor {
+    setTitle: Setter<string>;
+    setDescription: Setter<string>;
+    setQueryID: Setter<string>;
+}
+export interface VizConfigContext extends VizContext {
+    panelInfoEditor: IPanelInfoEditor;
+}
+export interface VizViewContext extends VizContext {
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+export interface VizConfigProps {
+    instance: VizInstance;
+    context: VizConfigContext;
+}
+export interface VizComponentMigrationContext {
+    instanceData: PluginStorage;
+}
+export interface VizComponent {
+    name: string;
+    displayName?: string;
+    viewRender: React.ComponentType<VizViewProps>;
+    configRender: React.ComponentType<VizConfigProps>;
+    migrator: IVizComponentMigrator;
+}
+export interface IVizComponentMigrator {
+    needMigration(ctx: VizComponentMigrationContext): Promise<boolean>;
+    migrate(ctx: VizComponentMigrationContext): Promise<void>;
+}
+export interface IPluginManifest {
+    viz: VizComponent[];
+    color: ColorPaletteItem[];
+}
+export interface IDashboardPlugin {
+    id: string;
+    version: string;
+    manifest: IPluginManifest;
+}
+export interface IPluginManager {
+    install(plugin: IDashboardPlugin): void;
+    installedPlugins: IDashboardPlugin[];
+    factory: {
+        viz: (name: string) => VizComponent;
+    };
+}
+export {};

package/dist/utils/download.d.ts

@@ -0,0 +1,6 @@
+export declare function downloadCSV(id: string, csv: string): void;
+export declare function downloadDataListAsZip(idDataList: Array<{
+    id: string;
+    data: any[];
+}>): void;
+export declare function makeCSV(data: any | any[]): string;

package/dist/utils/sql.d.ts

@@ -1,8 +1,9 @@
-import { ContextInfoContextType, FilterValuesContextType } from '../contexts';
-import { IDashboardDefinition } from '../types';
-export declare function explainSQLSnippet(snippet: string, context: ContextInfoContextType): any;
+import { FilterValuesType } from '../model';
+import { ContextInfoType } from '../model/context';
+import { SQLSnippetModelInstance } from '../model/sql-snippets';
+export declare function explainSQLSnippet(snippet: string, context: ContextInfoType): any;
 export declare function formatSQL(sql: string, params: Record<string, any>): any;
-export declare function getSQLParams(context: ContextInfoContextType, definitions: IDashboardDefinition, filterValues: FilterValuesContextType): Record<string, any> & ContextInfoContextType & {
-    filters: FilterValuesContextType;
+export declare function getSQLParams(context: ContextInfoType, sqlSnippets: SQLSnippetModelInstance[], filterValues: FilterValuesType): Record<string, any> & ContextInfoType & {
+    filters: FilterValuesType;
 };
-export declare function explainSQL(sql: string, context: ContextInfoContextType, definitions: IDashboardDefinition, filterValues: FilterValuesContextType): any;
+export declare function explainSQL(sql: string, context: ContextInfoType, sqlSnippets: SQLSnippetModelInstance[], filterValues: FilterValuesType): any;