@sdata-plugin-adapter/types 0.0.0-alpha.2 → 0.0.0-alpha.4

package/dist/index.d.mts

@@ -3,12 +3,11 @@ import * as ReactDOMClientType from "react-dom/client";
 
 //#region index.d.ts
 interface CustomConfig {
-  componentId: string;
+  componentId?: string;
   id: string;
-  appId?: string;
   [key: string]: any;
 }
-type ConfigType = "default" | "data" | "style" | "interaction";
+type ConfigType = 'default' | 'data' | 'style' | 'interaction';
 type ActionsFunction = {
   [key: string]: (...args: any[]) => any;
 };
@@ -30,55 +29,213 @@ type EventsPayload = {
     key: string;
     dataType: string;
   }[];
-}[];
+};
 interface EventActionDefinitions {
-  actions: ActionsPayload;
-  events: EventsPayload;
+  actions: ActionsPayload[];
+  events: EventsPayload[];
 }
 interface UseRegisterComponentParams {
-  actions?: ActionsFunction;
-  eventActionDefinitions?: EventActionDefinitions;
+  actions: ActionsFunction;
+  eventActionDefinitions: EventActionDefinitions;
 }
-interface AppTriggerEventPayload {
+interface TriggerEventPayload {
   componentId?: string;
   event: string;
   payload?: Record<string, any>;
   [key: string]: any;
 }
-interface AdapterProps {
-  isConfig?: boolean;
-  changeCustomConfig?: (customConfigStr: string) => void;
-  onConfigChange: (config: any) => void;
-  componentId?: string;
+interface BaseAppProps {
+  isConfig: boolean;
+  configType: ConfigType;
+  customConfig: CustomConfig;
+  onConfigChange: (parasm: Record<string, any>) => void;
+  appTriggerEvent: (payload: TriggerEventPayload) => void;
+}
+interface AppAdapterProps extends BaseAppProps {
+  changeCustomConfig: (customConfig: string | CustomConfig) => void;
+  componentId: string;
+  type: string;
+  triggerEvent: (eventName: string, payload?: Record<string, any>) => void;
+  useRegisterComponent: (params: UseRegisterComponentParams) => void;
+  [key: string]: any;
+}
+interface FormConfig {
+  id: string;
+  form_name: string;
+  [key: string]: any;
+}
+interface QueryProps {
+  data: Record<string, any>;
+  queryConfig: Record<string, any>;
+  onSearch: (...args: unknown[]) => void;
+  onChange: (params: Record<string, any>) => void;
+}
+interface BaseReportProps {
+  type: string;
+  data: string;
+  onChange: (data: string) => void;
+  formConfig: FormConfig;
+  queryProps: QueryProps;
+  queryData: Record<string, any>;
+  component: CustomConfig;
+  control$: Record<string, any>;
+  parent: CustomConfig;
+  configuration: string;
+  changeConfiguration: (param: any) => void;
+  instance: Record<string, any>;
+  isDesign: boolean;
+  index: string | number;
+  child_id: string | number;
+  setCustomRuleFunc?: (func: (value: any) => boolean) => void;
+}
+interface ReportAdapterProps extends BaseReportProps {
+  formId: string;
+  formName: string;
+  isInChildTable: boolean;
+  componentId: string;
+  componentName: string;
+  customConfig: CustomConfig;
+  type: string;
+  changeCustomConfig?: (customConfig: string | Record<string, any>) => void;
+  onSearch: (...args: unknown[]) => void;
+  onSearchChange: (value: unknown, type: number) => void;
+  triggerEvent: (eventName: string, payload?: Record<string, any>) => void;
+  useRegisterComponent: (params: UseRegisterComponentParams) => void;
+  [key: string]: any;
+}
+type baseCol = {
+  id: string | number;
+  showType: string;
+  componentConfig: Record<string, any>;
+  [key: string]: any;
+};
+type columnListItem = {
+  showType: string;
+  value: string | number | unknown;
+  label: string;
+  [key: string]: any;
+};
+type columnsItem = {
+  title: string;
+  [key: string]: any;
+};
+type dataItem = {
+  label: string;
+  value: string | number | unknown;
+  [key: string]: any;
+};
+interface BaseDFListProps {
+  data: dataItem[];
+  viewId: string;
+  pluginId: string;
+  type: string;
+  configuration: string;
+  columns: columnsItem[];
+  pluginConfig: CustomConfig;
+  allComponentList: baseCol[];
+  changeConfiguration: (param: any) => void;
+}
+interface DFListAdapterProps extends BaseDFListProps {
+  componentId: string;
+  type: 'designConfiguration' | 'main';
   customConfig: CustomConfig;
-  configType?: ConfigType;
-  type?: string;
-  appTriggerEvent?: (payload: AppTriggerEventPayload) => void;
-  triggerEvent?: (eventName: string, payload?: Record<string, any>) => void;
-  useRegisterComponent?: (params: UseRegisterComponentParams) => void;
+  columnList: columnListItem[];
+  changeCustomConfig?: (customConfig: string | Record<string, any>) => void;
+  triggerEvent: (eventName: string, payload?: Record<string, any>) => void;
+  useRegisterComponent: (params: UseRegisterComponentParams) => void;
   [key: string]: any;
 }
-type PluginProps = AdapterProps & Record<string, any>;
-interface startOptions {
-  App: React.ComponentType;
-  beforeBootstrap?: (callback: () => void) => void;
+type BScreenBlock = {
+  baseConfig: {
+    id: string | number;
+  } & Record<string, any>;
+  dataConfig: {
+    pluginOptions: Record<string, any>;
+    columns: unknown;
+  };
+};
+type bigScreenType = {
+  updateBlockById: (id: string | number, data: Record<string, any>) => void;
+  pluginDetailMap: Record<string, any>;
+  variableList: unknown;
+  rootStore: {
+    bigscreen: bigScreenType;
+  };
+};
+type bigScreenOptions = {
+  externalVariables: any;
+} & Record<string, any>;
+type bigScreenPubSub = {
+  subscribe: (id: string, call: (...args: unknown[]) => void) => void;
+};
+interface BaseBScreenProps {
+  componentId: string;
+  type: 'main' | string;
+  block: BScreenBlock;
+  bigscreen: bigScreenType;
+  options: bigScreenOptions;
+  pubSub: bigScreenPubSub;
+}
+interface BScreenAdapterProps extends BaseBScreenProps {
+  customConfig: Record<string, any>;
+  customOptions: bigScreenOptions;
+  variableList: unknown;
+  afterUpdateComponent: (callback: (data: unknown) => unknown) => void;
+  setComponentVisible: (visible: boolean) => void;
+  changeCustomConfig: (pluginOptions: string) => void;
+  triggerEvent: (eventName: string, payload?: Record<string, any>) => void;
+  useRegisterComponent: (params: UseRegisterComponentParams) => void;
+  [key: string]: any;
+}
+type AnalyzerOptions = {
+  analyzer_secondary_configuration: string;
+  externalVariables: Record<string, any>;
+};
+interface BaseAnalyzerProps {
+  componentId: string;
+  type: 'main' | string;
+  configuration: CustomConfig;
+  options: AnalyzerOptions;
+  dataSource: unknown;
+  data: unknown;
+  changeConfiguration: (configuration: unknown) => void;
+}
+interface AnalyzerAdapterProps extends BaseAnalyzerProps {
+  data: unknown;
+  customConfig: CustomConfig;
+  customOptions: Record<string, any>;
+  changeCustomConfig: (configuration: string) => void;
+  triggerEvent: (eventName: string, payload?: Record<string, any>) => void;
+  useRegisterComponent: (params: UseRegisterComponentParams) => void;
+  [key: string]: any;
+}
+interface CommonProps {
+  type: string;
+}
+type BaseProps = BaseAppProps | BaseReportProps | BaseDFListProps | BaseBScreenProps | BaseAnalyzerProps | CommonProps;
+type AdapterFn<T extends BaseProps, R extends T> = (props: T) => R;
+type BeforeBootstrap = <T extends Record<string, any> = {}>(callback: () => void, payload?: T) => void;
+interface StartOptions<P extends BaseProps> {
+  App: React.ComponentType<P>;
+  beforeBootstrap?: BeforeBootstrap;
 }
-interface createPluginOptions extends startOptions {
-  setAttributes: (dom: Element, props: PluginProps) => Promise<any>;
-  adapter: (props: AdapterProps) => AdapterProps;
+type SetAttributes<T extends BaseProps> = (dom: Element, props: T) => Promise<void>;
+interface CreatePluginOptions<P extends BaseProps, R extends P> extends StartOptions<R> {
+  setAttributes: SetAttributes<P>;
+  adapter: AdapterFn<P, R>;
 }
 interface EventBus {
   emit: (props: Record<string, any>) => void;
   on: (callback: (payload?: any) => void) => void;
   remove: () => void;
 }
-type PluginRun = (dom: Element, props: PluginProps, context?: Record<string, any>, eventBus?: EventBus, setCompRoot?: (root: ReactDOMClientType.Root) => void) => void;
+type PluginRun<T extends BaseProps> = (dom: Element, props: T, context: Record<string, any>, eventBus: EventBus, setCompRoot?: (root: ReactDOMClientType.Root) => void) => void;
 declare global {
   interface Window {
     React: typeof ReactType;
     ReactDOM: typeof ReactDOMClientType;
     online_development_islocal: boolean;
-    CUSTOM_PLUGIN: Map<string, PluginRun>;
+    CUSTOM_PLUGIN: Map<string, PluginRun<keyof BaseProps>>;
     eventCenter: {
       triggerEventNew: (payload: Record<string, any>) => void;
       [key: string]: any;
@@ -92,4 +249,4 @@ declare global {
   }
 }
 //#endregion
-export { type ActionsFunction, type ActionsPayload, type AdapterProps, type AppTriggerEventPayload, type CustomConfig, type EventActionDefinitions, type EventBus, type EventsPayload, type PluginProps, type PluginRun, type UseRegisterComponentParams, type createPluginOptions, type startOptions };
+export { type ActionsFunction, type ActionsPayload, type AdapterFn, type AnalyzerAdapterProps, type AppAdapterProps, type BScreenAdapterProps, type BaseAnalyzerProps, type BaseAppProps, type BaseBScreenProps, type BaseDFListProps, type BaseProps, type BaseReportProps, type CommonProps, type CreatePluginOptions, type CustomConfig, type DFListAdapterProps, type EventActionDefinitions, type EventBus, type EventsPayload, type PluginRun, type ReportAdapterProps, type SetAttributes, type StartOptions, type TriggerEventPayload, type UseRegisterComponentParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdata-plugin-adapter/types",
-  "version": "0.0.0-alpha.2",
+  "version": "0.0.0-alpha.4",
   "description": "adapter types of smdata plugin",
   "type": "module",
   "types": "./dist/index.d.mts",