@coding-script/script-engine 0.0.2 → 0.0.3

package/README.md

@@ -31,6 +31,7 @@ import type { ScriptMetadata } from '@coding-script/script-engine';
 
 const metadata: ScriptMetadata = {
   mainMethod: 'run',
+  description: '脚本主入口，接收请求参数并返回执行结果状态码',
   returnType: 'Integer',
   binds: [
     { dataType: 'GroovyBindObject', name: '$request' },
@@ -151,8 +152,10 @@ function App() {
 
 ```typescript
 interface ScriptMetadata {
-  /** 主函数名称 */
-  mainMethod: string;
+  /** 主函数名称（可选） */
+  mainMethod?: string;
+  /** 主函数描述信息（可选，提供后在属性面板主函数名旁显示悬浮提示） */
+  description?: string;
   /** 注入变量（如 $request，name 含 $ 前缀） */
   binds: ScriptBindInfo[];
   /** 主函数参数 */
@@ -241,4 +244,4 @@ pnpm run dev:app-pc
 
 ## License
 
-MIT
+Apache-2.0 license

package/dist/components/main-function-section.js

@@ -1,6 +1,51 @@
-import react from "react";
+import react, { useCallback, useEffect, useRef, useState } from "react";
 import { SectionHeader } from "./section-header.js";
-const MainFunctionSection = ({ metadata, colors })=>/*#__PURE__*/ react.createElement("div", null, /*#__PURE__*/ react.createElement(SectionHeader, {
+const TOOLTIP_MARGIN = 6;
+const TOOLTIP_MAX_WIDTH = 380;
+function calcTooltipPos(anchorRect, tooltipEl) {
+    const vw = window.innerWidth;
+    const vh = window.innerHeight;
+    const tooltipH = tooltipEl?.scrollHeight ?? 200;
+    const spaceBelow = vh - anchorRect.bottom - TOOLTIP_MARGIN;
+    const spaceAbove = anchorRect.top - TOOLTIP_MARGIN;
+    const placeBelow = spaceBelow >= Math.min(tooltipH, 260) || spaceBelow >= spaceAbove;
+    const top = placeBelow ? anchorRect.bottom + TOOLTIP_MARGIN : Math.max(TOOLTIP_MARGIN, anchorRect.top - tooltipH - TOOLTIP_MARGIN);
+    let left = anchorRect.left;
+    const maxRight = vw - TOOLTIP_MARGIN;
+    if (left + TOOLTIP_MAX_WIDTH > maxRight) left = Math.max(TOOLTIP_MARGIN, maxRight - TOOLTIP_MAX_WIDTH);
+    const maxWidth = Math.min(TOOLTIP_MAX_WIDTH, maxRight - left);
+    const maxHeight = placeBelow ? spaceBelow - TOOLTIP_MARGIN : spaceAbove - TOOLTIP_MARGIN;
+    return {
+        top,
+        left,
+        maxWidth,
+        maxHeight: Math.max(maxHeight, 80)
+    };
+}
+const MainFunctionSection = ({ metadata, colors })=>{
+    const [showTip, setShowTip] = useState(false);
+    const [pos, setPos] = useState(null);
+    const anchorRef = useRef(null);
+    const tooltipRef = useRef(null);
+    const updatePos = useCallback(()=>{
+        if (!anchorRef.current) return;
+        const rect = anchorRef.current.getBoundingClientRect();
+        setPos(calcTooltipPos(rect, tooltipRef.current));
+    }, []);
+    useEffect(()=>{
+        if (!showTip) return;
+        updatePos();
+        window.addEventListener('scroll', updatePos, true);
+        window.addEventListener('resize', updatePos);
+        return ()=>{
+            window.removeEventListener('scroll', updatePos, true);
+            window.removeEventListener('resize', updatePos);
+        };
+    }, [
+        showTip,
+        updatePos
+    ]);
+    return /*#__PURE__*/ react.createElement("div", null, /*#__PURE__*/ react.createElement(SectionHeader, {
         colors: colors,
         label: "主函数"
     }), /*#__PURE__*/ react.createElement("div", {
@@ -25,7 +70,30 @@ const MainFunctionSection = ({ metadata, colors })=>/*#__PURE__*/ react.createEl
             color: colors.text,
             fontWeight: 500
         }
-    }, metadata.mainMethod), /*#__PURE__*/ react.createElement("span", {
+    }, metadata.mainMethod), metadata.description && /*#__PURE__*/ react.createElement("span", {
+        ref: anchorRef,
+        style: {
+            display: 'inline-flex',
+            cursor: 'help',
+            flexShrink: 0
+        },
+        onMouseEnter: ()=>setShowTip(true),
+        onMouseLeave: ()=>setShowTip(false)
+    }, /*#__PURE__*/ react.createElement("span", {
+        style: {
+            display: 'inline-flex',
+            alignItems: 'center',
+            justifyContent: 'center',
+            width: 14,
+            height: 14,
+            borderRadius: '50%',
+            border: `1px solid ${colors.textSecondary}`,
+            color: colors.textSecondary,
+            fontSize: 10,
+            lineHeight: 1,
+            fontWeight: 600
+        }
+    }, "?")), /*#__PURE__*/ react.createElement("span", {
         style: {
             color: colors.textSecondary,
             fontSize: 11
@@ -36,5 +104,30 @@ const MainFunctionSection = ({ metadata, colors })=>/*#__PURE__*/ react.createEl
             fontSize: 11,
             marginLeft: 'auto'
         }
-    }, "→ ", metadata.returnType))));
+    }, "→ ", metadata.returnType))), showTip && pos && metadata.description && /*#__PURE__*/ react.createElement("div", {
+        ref: tooltipRef,
+        onMouseEnter: ()=>setShowTip(true),
+        onMouseLeave: ()=>setShowTip(false),
+        style: {
+            position: 'fixed',
+            top: pos.top,
+            left: pos.left,
+            maxWidth: pos.maxWidth,
+            maxHeight: pos.maxHeight,
+            overflowY: 'auto',
+            padding: '8px 12px',
+            background: colors.headerBg,
+            border: `1px solid ${colors.border}`,
+            borderRadius: 6,
+            color: colors.text,
+            fontSize: 12,
+            lineHeight: 1.65,
+            whiteSpace: 'pre-wrap',
+            wordBreak: 'break-word',
+            zIndex: 9999,
+            boxShadow: '0 4px 16px rgba(0,0,0,0.3)',
+            pointerEvents: 'auto'
+        }
+    }, metadata.description));
+};
 export { MainFunctionSection };

package/dist/types/index.d.ts

@@ -41,7 +41,8 @@ export interface ScriptRequestInfo {
 export interface ScriptMetadata {
     binds: ScriptBindInfo[];
     requests: ScriptRequestInfo[];
-    mainMethod: string;
+    description?: string;
+    mainMethod?: string;
     returnType?: string;
     types: Record<string, ScriptTypeInfo>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coding-script/script-engine",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "script-engine components",
   "keywords": [
     "coding-script",