@devtable/dashboard 2.6.0 → 3.0.0

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/viz/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { IVizConfig } from '../../types/dashboard';
+import { IVizConfig } from '../../types';
 interface IViz {
     viz: IVizConfig;
     data: any;

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

@@ -1,8 +1,12 @@
 import { PluginStorage } from '../types/plugin';
 export declare class JsonPluginStorage implements PluginStorage {
-    private root;
-    constructor(root: Record<string, any>);
+    protected rootRef: {
+        current: Record<string, any>;
+    };
+    constructor(initValue: Record<string, any>);
     deleteItem(key: string): Promise<void>;
-    getItem<T>(key: string): Promise<T>;
-    setItem<T>(key: string, item: T): Promise<T>;
+    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

@@ -4,5 +4,4 @@ export declare class MessageChannels implements IMessageChannels {
     private channels;
     globalChannel: EventEmitter2;
     getChannel(name: string): EventEmitter2;
-    close(name: string): void;
 }

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/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

@@ -13,11 +13,10 @@ export declare type IViewComponentProps<TDebug = {}> = {
     vizManager: IVizManager;
 } & TDebug;
 export declare const VizViewComponent: <T>(props: IViewComponentProps<T>) => JSX.Element;
-declare type IConfigComponentProps<TDebug = {}> = {
+export declare type IConfigComponentProps<TDebug = {}> = {
     panel: IPanelInfo;
     panelInfoEditor: IPanelInfoEditor;
     vizManager: IVizManager;
     data: any;
 } & TDebug;
 export declare const VizConfigComponent: <T>(props: IConfigComponentProps<T>) => JSX.Element;
-export {};

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

@@ -1,3 +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/types/plugin/index.d.ts

@@ -6,6 +6,7 @@ import React from 'react';
 export interface VizInstance {
     id: string;
     name: string;
+    type: string;
 }
 /**
  * Props to render the view of viz component
@@ -15,9 +16,10 @@ export interface VizViewProps {
     context: VizViewContext;
 }
 export interface PluginStorage {
-    getItem<T>(key: string): Promise<T>;
-    setItem<T>(key: string, item: T): Promise<T>;
+    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;
@@ -38,7 +40,6 @@ export interface ColorPalette {
 export interface IMessageChannels {
     globalChannel: EventEmitter2;
     getChannel(name: string): EventEmitter2;
-    close(name: string): void;
 }
 export interface VizContext {
     pluginData: PluginStorage;
@@ -68,7 +69,6 @@ export interface VizConfigProps {
     context: VizConfigContext;
 }
 export interface VizComponentMigrationContext {
-    pluginData: PluginStorage;
     instanceData: PluginStorage;
 }
 export interface VizComponent {
@@ -76,7 +76,11 @@ export interface VizComponent {
     displayName?: string;
     viewRender: React.ComponentType<VizViewProps>;
     configRender: React.ComponentType<VizConfigProps>;
-    migration: (ctx: VizComponentMigrationContext) => Promise<void>;
+    migrator: IVizComponentMigrator;
+}
+export interface IVizComponentMigrator {
+    needMigration(ctx: VizComponentMigrationContext): Promise<boolean>;
+    migrate(ctx: VizComponentMigrationContext): Promise<void>;
 }
 export interface IPluginManifest {
     viz: VizComponent[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devtable/dashboard",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -32,9 +32,9 @@
   "dependencies": {
     "eventemitter2": "^6.4.6",
     "file-saver": "2.0.5",
-    "stickybits": "3.7.11",
     "jszip": "3.10.1",
-    "popmotion": "^11.0.3"
+    "popmotion": "^11.0.3",
+    "stickybits": "3.7.11"
   },
   "devDependencies": {
     "@mantine/core": "^5.0.2",
@@ -45,10 +45,12 @@
     "@mantine/notifications": "^5.0.2",
     "@mantine/prism": "^5.0.2",
     "@mantine/rte": "^5.0.2",
+    "@testing-library/cypress": "^8.0.3",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.3.0",
     "@testing-library/react-hooks": "^8.0.1",
     "@testing-library/user-event": "^14.3.0",
+    "@types/eventemitter2": "^4.1.0",
     "@types/file-saver": "2.0.5",
     "@types/lodash": "^4.14.182",
     "@types/react": "^18.0.0",
@@ -58,11 +60,13 @@
     "@vitest/ui": "^0.19.1",
     "ahooks": "^3.3.11",
     "axios": "^0.27.2",
+    "cypress": "^10.6.0",
     "echarts": "^5.3.2",
     "echarts-for-react": "^3.0.2",
     "echarts-gl": "^2.0.9",
     "echarts-stat": "1.2.0",
     "jsdom": "^20.0.0",
+    "jsdom-testing-mocks": "^1.5.0",
     "lodash": "^4.17.21",
     "numbro": "^2.3.6",
     "react-grid-layout": "^1.3.4",
@@ -72,7 +76,7 @@
     "typescript": "^4.6.3",
     "vite": "^3.0.3",
     "vite-plugin-dts": "^1.1.1",
-    "vitest": "^0.19.1"
+    "vitest": "^0.21.1"
   },
   "peerDependencies": {
     "@emotion/react": "11.10.0",

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

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-import { ITableConf } from './type';
-interface IVizTable {
-    conf: ITableConf;
-    data: any;
-    width: number;
-    height: number;
-}
-export declare function VizTable({ conf, data, width, height }: IVizTable): JSX.Element;
-export {};

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

@@ -1,3 +0,0 @@
-/// <reference types="react" />
-import { IVizPanelProps } from '../../../types/viz-panel';
-export declare function VizTablePanel({ conf: { columns, ...restConf }, setConf, data }: IVizPanelProps): JSX.Element;