feat: enhance type definitions and documentation for Arrow and Summary interfaces

Author: SSShooter

pnpm-lock.yaml

@@ -5,27 +5,37 @@ import { createSvgGroup, editSvgText } from './utils/svg'
 import type { CustomSvg, Topic } from './types/dom'
 import type { MindElixirInstance, Uid } from './index'
 
-/**
- * FYI
- * p1: starting point
- * p2: control point of starting point
- * p3: control point of ending point
- * p4: ending point
- */
-
-export type Arrow = {
+export interface Arrow {
   id: string
+  /**
+   * label of arrow
+   */
   label: string
+  /**
+   * id of start node
+   */
   from: Uid
+  /**
+   * id of end node
+   */
   to: Uid
+  /**
+   *  offset of control point from start point
+   */
   delta1: {
     x: number
     y: number
   }
+  /**
+   * offset of control point from end point
+   */
   delta2: {
     x: number
     y: number
   }
+  /**
+   * whether the arrow is bidirectional
+   */
   bidirectional?: boolean
 }
 export type DivData = {
@@ -62,7 +72,7 @@ function calcCtrlP(mei: MindElixirInstance, tpc: Topic, delta: { x: number; y: n
 }
 
 /**
- * calc starting and ending point using control point and div status
+ * calc start and end point using control point and div status
  */
 function calcP(data: DivData) {
   let x, y
@@ -103,6 +113,13 @@ const createText = function (string: string, x: number, y: number, color?: strin
   return text
 }
 
+/**
+ * FYI
+ * p1: start point
+ * p2: control point of start point
+ * p3: control point of end point
+ * p4: end point
+ */
 const drawArrow = function (mei: MindElixirInstance, from: Topic, to: Topic, obj: Arrow, isInitPaint?: boolean) {
   if (!from || !to) {
     return // not expand

src/arrow.ts

@@ -11,6 +11,10 @@ type LangPack = {
   clickTips: string
   summary: string
 }
+
+/**
+ * @public
+ */
 export type Locale = 'cn' | 'zh_CN' | 'zh_TW' | 'en' | 'ru' | 'ja' | 'pt' | 'it' | 'es' | 'fr' | 'ko'
 const cn = {
   addChild: '插入子节点',

src/i18n.ts

@@ -4,11 +4,23 @@ import { generateUUID, getOffsetLT, setAttributes } from './utils'
 import { findEle } from './utils/dom'
 import { editSvgText } from './utils/svg'
 
-export type Summary = {
+/**
+ * @public
+ */
+export interface Summary {
   id: string
   text: string
+  /**
+   * parent node id of the summary
+   */
   parent: string
+  /**
+   * start index of the summary
+   */
   start: number
+  /**
+   * end index of the summary
+   */
   end: number
 }