@devtable/dashboard 6.4.0 → 6.6.0

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

@@ -1,13 +1,16 @@
-interface IMigration {
+import { PanelModelInstance } from '~/model/views/view/panels';
+export interface IMigrationEnv {
+    panelModel: PanelModelInstance;
+}
+export interface IMigration {
     version: number;
-    handler: (data: $TSFixMe) => $TSFixMe;
+    handler: (data: $TSFixMe, env: IMigrationEnv) => $TSFixMe;
 }
 export declare class PluginDataMigrator {
     protected migrations: IMigration[];
-    version(version: number, handler: (data: $TSFixMe) => $TSFixMe): PluginDataMigrator;
+    version(version: number, handler: IMigration['handler']): PluginDataMigrator;
     run(migrationTarget: {
         from: number;
         to: number;
-    }, val: $TSFixMe): any;
+    }, val: $TSFixMe, env: IMigrationEnv): $TSFixMe;
 }
-export {};

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

@@ -1,5 +1,5 @@
-import { IConfigMigrator, IConfigMigrationContext } from '~/types/plugin';
-import { PluginDataMigrator } from './plugin-data-migrator';
+import { IConfigMigrationContext, IConfigMigrationExecContext, IPanelScopeConfigMigrator } from '~/types/plugin';
+import { IMigration, PluginDataMigrator } from './plugin-data-migrator';
 /**
  * Instance version is read from the `instanceData.version` field.
  * Current version is read from the `VERSION` field.
@@ -8,11 +8,11 @@ import { PluginDataMigrator } from './plugin-data-migrator';
  * You can implement the `configVersions` method to
  * specify how migrations are performed.
  */
-export declare abstract class VersionBasedMigrator extends PluginDataMigrator implements IConfigMigrator {
+export declare abstract class VersionBasedMigrator extends PluginDataMigrator implements IPanelScopeConfigMigrator {
     abstract readonly VERSION: number;
     abstract configVersions(): void;
     constructor();
-    version(version: number, handler: (data: $TSFixMe) => $TSFixMe): PluginDataMigrator;
-    migrate({ configData }: IConfigMigrationContext): Promise<void>;
+    version(version: number, handler: IMigration['handler']): PluginDataMigrator;
+    migrate({ configData, panelModel }: IConfigMigrationExecContext): Promise<void>;
     needMigration({ configData }: IConfigMigrationContext): Promise<boolean>;
 }

package/dist/plugins/viz-components/boxplot-chart/index.d.ts

@@ -1,2 +1,7 @@
 import { VizComponent } from '~/types/plugin';
+import { VersionBasedMigrator } from '~/plugins/plugin-data-migrator';
+export declare class VizBoxplotChartMigrator extends VersionBasedMigrator {
+    readonly VERSION = 2;
+    configVersions(): void;
+}
 export declare const BoxplotChartVizComponent: VizComponent;

package/dist/plugins/viz-components/boxplot-chart/reference-lines/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="react" />
 import { Control, UseFormWatch } from 'react-hook-form';
 import { IBoxplotChartConf } from '../type';
+import { ITemplateVariable } from '~/utils/template';
 interface IReferenceLinesField {
     control: Control<IBoxplotChartConf, $TSFixMe>;
     watch: UseFormWatch<IBoxplotChartConf>;
+    variables: ITemplateVariable[];
 }
-export declare function ReferenceLinesField({ control, watch }: IReferenceLinesField): JSX.Element;
+export declare function ReferenceLinesField({ control, watch, variables }: IReferenceLinesField): JSX.Element;
 export {};

package/dist/plugins/viz-components/boxplot-chart/type.d.ts

@@ -1,4 +1,3 @@
-import { ITemplateVariable } from '~/utils/template';
 export interface IBoxplotReferenceLine {
     name: string;
     template: string;
@@ -14,7 +13,6 @@ export interface IBoxplotChartConf {
         data_key: string;
     };
     color: string;
-    variables: ITemplateVariable[];
     reference_lines: IBoxplotReferenceLine[];
 }
 export declare const DEFAULT_CONFIG: IBoxplotChartConf;

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

@@ -1,2 +1,7 @@
 import { VizComponent } from '~/types/plugin';
+import { VersionBasedMigrator } from '~/plugins/plugin-data-migrator';
+export declare class VizCartesianMigrator extends VersionBasedMigrator {
+    readonly VERSION = 2;
+    configVersions(): void;
+}
 export declare const CartesianVizComponent: VizComponent;

package/dist/plugins/viz-components/cartesian/option/index.d.ts

@@ -1,2 +1,3 @@
 import { ICartesianChartConf } from '../type';
-export declare function getOption(conf: ICartesianChartConf, data: $TSFixMe[]): any;
+import { ITemplateVariable } from '~/utils/template';
+export declare function getOption(conf: ICartesianChartConf, data: $TSFixMe[], variables: ITemplateVariable[]): any;

package/dist/plugins/viz-components/cartesian/option/series.d.ts

@@ -1,2 +1,3 @@
+import { ITemplateVariable } from '~/utils/template';
 import { ICartesianChartConf } from '../type';
-export declare function getSeries(conf: ICartesianChartConf, xAxisData: $TSFixMe[], data: $TSFixMe[], labelFormatters: Record<string, $TSFixMe>): any[];
+export declare function getSeries(conf: ICartesianChartConf, xAxisData: $TSFixMe[], data: $TSFixMe[], labelFormatters: Record<string, $TSFixMe>, variables: ITemplateVariable[]): any[];

package/dist/plugins/viz-components/cartesian/panel/reference-areas/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="react" />
 import { Control, UseFormWatch } from 'react-hook-form';
 import { ICartesianChartConf } from '../../type';
+import { ITemplateVariable } from '~/utils/template';
 interface IReferenceAreasField {
     control: Control<ICartesianChartConf, $TSFixMe>;
     watch: UseFormWatch<ICartesianChartConf>;
+    variables: ITemplateVariable[];
 }
-export declare function ReferenceAreasField({ control, watch }: IReferenceAreasField): JSX.Element;
+export declare function ReferenceAreasField({ control, watch, variables }: IReferenceAreasField): JSX.Element;
 export {};

package/dist/plugins/viz-components/cartesian/panel/reference-lines/index.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="react" />
 import { Control, UseFormWatch } from 'react-hook-form';
 import { ICartesianChartConf } from '../../type';
+import { ITemplateVariable } from '~/utils/template';
 interface IReferenceLinesField {
     control: Control<ICartesianChartConf, $TSFixMe>;
     watch: UseFormWatch<ICartesianChartConf>;
+    variables: ITemplateVariable[];
 }
-export declare function ReferenceLinesField({ control, watch }: IReferenceLinesField): JSX.Element;
+export declare function ReferenceLinesField({ control, watch, variables }: IReferenceLinesField): JSX.Element;
 export {};

package/dist/plugins/viz-components/cartesian/panel/stats/index.d.ts

@@ -6,5 +6,5 @@ interface IVariablesField {
     watch: UseFormWatch<ICartesianChartConf>;
     data: $TSFixMe[];
 }
-export declare function StatsField({ control, watch, data }: IVariablesField): JSX.Element;
+export declare function StatsField({ control }: IVariablesField): JSX.Element;
 export {};

package/dist/plugins/viz-components/cartesian/type.d.ts

@@ -1,5 +1,4 @@
 import { TNumbroFormat } from '~/panel/settings/common/numbro-format-selector';
-import { ITemplateVariable } from '~/utils/template';
 export interface ICartesianChartSeriesItem {
     type: 'line' | 'bar' | 'scatter';
     name: string;
@@ -81,9 +80,7 @@ export interface ICartesianChartConf {
             top: string;
             bottom: string;
         };
-        variables: ITemplateVariable[];
     };
-    variables: ITemplateVariable[];
     reference_lines: ICartesianReferenceLine[];
     reference_areas: ICartesianReferenceArea[];
 }

package/dist/plugins/viz-components/stats/type.d.ts

@@ -1,7 +1,5 @@
-import { ITemplateVariable } from '~/utils/template';
 export declare const DEFAULT_CONFIG: IVizStatsConf;
 export interface IVizStatsConf {
     align: 'center';
     template: string;
-    variables: ITemplateVariable[];
 }

package/dist/plugins/viz-components/stats/update/index.d.ts

@@ -1,5 +1,5 @@
 import { VersionBasedMigrator } from '~/plugins/plugin-data-migrator';
 export declare class VizStatsMigrator extends VersionBasedMigrator {
-    readonly VERSION = 1;
+    readonly VERSION = 2;
     configVersions(): void;
 }

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

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { IPanelInfoEditor } from '~/types/plugin';
 import { IPanelInfo, IVizManager } from './types';
+import { ITemplateVariable } from '~/utils/template';
 export declare type IViewPanelInfo = IPanelInfo & {
     layout: {
         w: number;
@@ -11,12 +12,14 @@ export declare type IViewComponentProps<TDebug = Record<string, unknown>> = {
     panel: IViewPanelInfo;
     data: $TSFixMe;
     vizManager: IVizManager;
+    variables: ITemplateVariable[];
 } & TDebug;
 export declare const VizViewComponent: <T>(props: IViewComponentProps<T>) => JSX.Element;
 export declare type IConfigComponentProps<TDebug = Record<string, unknown>> = {
     panel: IPanelInfo;
     panelInfoEditor: IPanelInfoEditor;
     vizManager: IVizManager;
+    variables: ITemplateVariable[];
     data: $TSFixMe;
 } & TDebug;
 export declare const VizConfigComponent: <T>(props: IConfigComponentProps<T>) => JSX.Element;

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

@@ -1,6 +1,6 @@
 import { IDashboardPanel } from '~/types';
 import { VizComponent, VizInstance } from '~/types/plugin';
-export declare type IPanelInfo = Omit<IDashboardPanel, 'layout'>;
+export declare type IPanelInfo = Omit<IDashboardPanel, 'layout' | 'variables' | 'style'>;
 export interface IVizManager {
     readonly availableVizList: VizComponent[];
     resolveComponent(type: string): VizComponent;

package/dist/types/dashboard.d.ts

@@ -1,4 +1,5 @@
 import { AnyObject } from '~/types/utils';
+import { ITemplateVariable } from '~/utils/template';
 import { FilterModelInstance } from '../model';
 import { QueryModelInstance } from '../model/queries';
 import { SQLSnippetModelInstance } from '../model/sql-snippets';
@@ -26,6 +27,7 @@ export interface IDashboardPanel {
     queryID: string;
     viz: IVizConfig;
     style: IDashboardPanelStyle;
+    variables: ITemplateVariable[];
 }
 export declare enum DashboardMode {
     Use = "use",
@@ -44,7 +46,7 @@ export interface IDashboardView {
     id: string;
     name: string;
     type: EViewComponentType;
-    config: Record<string, any>;
+    config: Record<string, AnyObject>;
     panels: IDashboardPanel[];
 }
 export interface IDashboard {
@@ -53,6 +55,7 @@ export interface IDashboard {
     definition: IDashboardDefinition;
     views: IDashboardView[];
     filters: FilterModelInstance[];
+    variables: ITemplateVariable[];
     version: string;
 }
 export {};

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

@@ -2,6 +2,8 @@ import { EventEmitter2 } from 'eventemitter2';
 import React from 'react';
 import { IVizManager } from '~/plugins';
 import { AnyObject } from '~/types';
+import { ITemplateVariable } from '~/utils/template';
+import { PanelModelInstance } from '~/model/views/view/panels';
 /**
  * Basic information of a viz component instance
  */
@@ -57,6 +59,7 @@ export interface VizContext {
     pluginData: PluginStorage;
     instanceData: PluginStorage;
     colorPalette: ColorPalette;
+    variables: ITemplateVariable[];
     locale: string;
     msgChannels: IMessageChannels;
     data: unknown;
@@ -84,17 +87,23 @@ export interface VizConfigProps {
 export interface IConfigMigrationContext {
     configData: PluginStorage;
 }
+export interface IConfigMigrationExecContext extends IConfigMigrationContext {
+    panelModel: PanelModelInstance;
+}
 export interface VizComponent {
     name: string;
     displayName?: string;
     viewRender: React.ComponentType<VizViewProps>;
     configRender: React.ComponentType<VizConfigProps>;
-    migrator: IConfigMigrator;
+    migrator: IPanelScopeConfigMigrator;
     createConfig: () => AnyObject;
     triggers?: ITriggerSchema[];
 }
-export interface IConfigMigrator {
+export interface IPanelScopeConfigMigrator {
     needMigration(ctx: IConfigMigrationContext): Promise<boolean>;
+    migrate(ctx: IConfigMigrationExecContext): Promise<void>;
+}
+export interface IConfigMigrator extends IPanelScopeConfigMigrator {
     migrate(ctx: IConfigMigrationContext): Promise<void>;
 }
 export interface IPluginManifest {

package/dist/utils/template/render/render-jsx.d.ts

@@ -1,3 +1,4 @@
 import React from 'react';
 import { ITemplateVariable } from '../types';
+export declare function variable2Jsx(variable: ITemplateVariable, data: Record<string, number>[]): JSX.Element;
 export declare function templateToJSX(template: string, variables: ITemplateVariable[], data: Record<string, number>[]): (JSX.Element | React.ReactNode[])[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devtable/dashboard",
-  "version": "6.4.0",
+  "version": "6.6.0",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",