@sun-panel/micro-app 1.0.6 → 1.0.7

package/src/types/api.d.ts

@@ -5,90 +5,26 @@ import { WidgetInfo } from './common.js'
  * 微应用 API 类型定义
  */
 
-/**
- * 微应用错误类型
- */
-export class MicroAppNetworkRequestError extends Error {
-  type: 'microApp' | 'targetUrl' | 'unknown'
-  response?: AxiosResponse
-
-  constructor(message: string, type: 'microApp' | 'targetUrl' | 'unknown' = 'unknown', response?: any) {
-    super(message)
-    this.name = 'MicroAppNetworkRequestError'
-    this.type = type
-    this.response = response
-  }
-}
-
-/**
- * 数据节点错误类型
- */
-export class MicroDataNodeError extends Error {
-  code: string | number
-  response?: AxiosResponse
-
-  constructor(message: string, code: string | number, response?: any) {
-    super(message)
-    this.name = 'MicroDataNodeError'
-    this.code = code
-    this.response = response
-  }
-}
+// ========== 请求类型 ==========
 
-
-/**
- * 高级代理请求参数
- */
-export interface AdvancedProxyRequest {
+interface RequestOptions {
   targetUrl: string
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'
+  method?: string
   headers?: Record<string, string>
-  body?: any
-  timeout?: number
-  [key: string]: any
-}
-
-/**
- * 窗口配置
- */
-export interface WindowConfig {
-  height?: number
-  width?: number
-  left?: number
-  top?: number
-  isFullScreen?: boolean
-  background?: string
+  body?: string
+  templateReplacements: TemplateReplacementRule[]
 }
-
-/**
- * 打开窗口参数
- */
-export interface OpenWindowOptions {
-  componentName: string // 必需：组件名
-  windowConfig?: WindowConfig // 可选：窗口配置
-  customParam?: any // 可选：自定义参数
-  title?: string // 可选：窗口标题
+export interface TemplateReplacementRule {
+  placeholder: string // 要替换的字符，用户自定义，如 "{{token}}"
+  fields: string[] // 替换参数，可选：targetUrl, method, headers, body
+  dataNode: string // 数据节点路径，如 "config.token"
 }
 
-/**
- * 窗口初始化参数
- */
-export interface PageInitializedParam {
-  widgetInfo?: WidgetInfo
-  customParam: any
-}
+// ========== 微应用 API 接口 ==========
 
-/**
- * 微应用 API 接口定义
- */
 export interface MicroAppAPI {
   // 窗口管理
   window: {
-    /**
-     * 打开窗口
-     * @param param 窗口参数
-     * @returns 窗口ID
-     */
     open: (options: OpenWindowOptions) => string
     // close: (windowId: string) => boolean
     // toggle: (windowId: string) => boolean
@@ -142,33 +78,62 @@ export interface MicroAppAPI {
     }
   }
 
-
   // 网络透传
   network: {
-    request: <T = any>(params: AdvancedProxyRequest) => Promise<T>
-    // batchRequest: <T = any>(params: AdvancedBatchProxyRequest) => Promise<T>
+    request: <T = any>(params: RequestOptions) => Promise<T>
+    // batchRequest: <T = any>(params: MicroApp.ApiRequest.AdvancedBatchProxyRequest) => Promise<T>
     // smartBatchRequest: <T = any>(
-    //   requests: AdvancedProxyItem[],
+    //   requests: MicroApp.ApiRequest.AdvancedProxyItem[],
     //   batchSize?: number,
     // ) => Promise<T[]>
   }
 
-
+  // 小部件
   widget: {
-    save: <T = any>(data: WidgetInfo, closeWindowAfterSuccess?: boolean) => Promise<T>
+    save: <T = any>(data: WidgetInfo) => Promise<T>
   },
+}
+
+// ========== 窗口相关类型 ==========
+
+export interface WindowConfig {
+  height?: number
+  width?: number
+  left?: number
+  top?: number
+  isFullScreen?: boolean
+  background?: string
+}
+
+export interface OpenWindowOptions {
+  componentName: string // 必需：组件名
+  windowConfig?: WindowConfig // 可选：窗口配置
+  customParam?: any // 可选：自定义参数
+  title?: string // 可选：窗口标题
+}
+
+// ========== 错误类型 ==========
+
+export class MicroAppNetworkRequestError extends Error {
+  type: 'microApp' | 'targetUrl' | 'unknown'
+  response?: AxiosResponse
 
-  // // 状态（只读）
-  // state: {
-  //   /**
-  //    * 当前窗口数量
-  //    */
-  //   windowCount: number;
-
-  //   /**
-  //    * 可见窗口数量
-  //    */
-  //   visibleWindows: number;
-  // };
+  constructor(message: string, type: 'microApp' | 'targetUrl' | 'unknown' = 'unknown', response?: any) {
+    super(message)
+    this.name = 'MicroAppNetworkRequestError'
+    this.type = type
+    this.response = response
+  }
 }
 
+export class MicroDataNodeError extends Error {
+  code: string | number
+  response?: AxiosResponse
+
+  constructor(message: string, code: string | number, response?: any) {
+    super(message)
+    this.name = 'MicroDataNodeError'
+    this.code = code
+    this.response = response
+  }
+}

package/src/types/common.d.ts

@@ -14,6 +14,11 @@ export interface SpContext {
     // [key: string]: any;
 }
 
+export interface PageInitializedParam {
+  widgetInfo?: WidgetInfo
+  customParam: any
+}
+
 export interface SpContextWidget extends SpContext {
     // itemInfo: ItemInfo;
     // background: string;