@sdata-plugin-adapter/types 0.0.0-alpha.1

package/dist/index.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);

package/dist/index.d.cts

@@ -0,0 +1,73 @@
+import * as ReactDOMClientType from 'react-dom/client';
+
+interface CustomConfig {
+    componentId: string;
+    id: string;
+    appId?: string;
+    [key: string]: any;
+}
+type ConfigType = "default" | "data" | "style" | "interaction";
+type ActionsFunction = {
+    [key: string]: (...args: any[]) => any;
+};
+type ActionsPayload = {
+    key: string;
+    name: string;
+    params: {
+        key: string;
+        name: string;
+        dataType: string;
+    }[];
+    hasReturn: boolean;
+};
+type EventsPayload = {
+    key: string;
+    name: string;
+    payload: {
+        name: string;
+        key: string;
+        dataType: string;
+    }[];
+}[];
+interface EventActionDefinitions {
+    actions: ActionsPayload;
+    events: EventsPayload;
+}
+interface UseRegisterComponentParams {
+    actions?: ActionsFunction;
+    eventActionDefinitions?: EventActionDefinitions;
+}
+interface AppTriggerEventPayload {
+    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;
+    customConfig: CustomConfig;
+    configType?: ConfigType;
+    type?: string;
+    appTriggerEvent?: (payload: AppTriggerEventPayload) => void;
+    triggerEvent?: (eventName: string, payload?: Record<string, any>) => void;
+    useRegisterComponent?: (params: UseRegisterComponentParams) => void;
+    [key: string]: any;
+}
+type PluginProps = AdapterProps & Record<string, any>;
+interface createPluginOptions {
+    App: React.ComponentType;
+    setAttributes: (dom: Element, props: PluginProps) => Promise<any>;
+    adapter: (props: AdapterProps) => AdapterProps;
+    beforeBootstrap?: (callback: () => void) => void;
+}
+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;
+
+export type { ActionsFunction, ActionsPayload, AdapterProps, AppTriggerEventPayload, CustomConfig, EventActionDefinitions, EventBus, EventsPayload, PluginProps, PluginRun, UseRegisterComponentParams, createPluginOptions };

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import * as ReactDOMClientType from 'react-dom/client';
+
+interface CustomConfig {
+    componentId: string;
+    id: string;
+    appId?: string;
+    [key: string]: any;
+}
+type ConfigType = "default" | "data" | "style" | "interaction";
+type ActionsFunction = {
+    [key: string]: (...args: any[]) => any;
+};
+type ActionsPayload = {
+    key: string;
+    name: string;
+    params: {
+        key: string;
+        name: string;
+        dataType: string;
+    }[];
+    hasReturn: boolean;
+};
+type EventsPayload = {
+    key: string;
+    name: string;
+    payload: {
+        name: string;
+        key: string;
+        dataType: string;
+    }[];
+}[];
+interface EventActionDefinitions {
+    actions: ActionsPayload;
+    events: EventsPayload;
+}
+interface UseRegisterComponentParams {
+    actions?: ActionsFunction;
+    eventActionDefinitions?: EventActionDefinitions;
+}
+interface AppTriggerEventPayload {
+    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;
+    customConfig: CustomConfig;
+    configType?: ConfigType;
+    type?: string;
+    appTriggerEvent?: (payload: AppTriggerEventPayload) => void;
+    triggerEvent?: (eventName: string, payload?: Record<string, any>) => void;
+    useRegisterComponent?: (params: UseRegisterComponentParams) => void;
+    [key: string]: any;
+}
+type PluginProps = AdapterProps & Record<string, any>;
+interface createPluginOptions {
+    App: React.ComponentType;
+    setAttributes: (dom: Element, props: PluginProps) => Promise<any>;
+    adapter: (props: AdapterProps) => AdapterProps;
+    beforeBootstrap?: (callback: () => void) => void;
+}
+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;
+
+export type { ActionsFunction, ActionsPayload, AdapterProps, AppTriggerEventPayload, CustomConfig, EventActionDefinitions, EventBus, EventsPayload, PluginProps, PluginRun, UseRegisterComponentParams, createPluginOptions };

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@sdata-plugin-adapter/types",
+  "version": "0.0.0-alpha.1",
+  "description": "adapter types of smdata plugin",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsup"
+  }
+}