@sun-panel/micro-app 1.0.5 → 1.0.7

package/src/types/api.d.ts

@@ -1,267 +1,139 @@
-import { WidgetInfo } from './common.js';
+import type { AxiosResponse } from 'axios'
+import { WidgetInfo } from './common.js'
 
 /**
  * 微应用 API 类型定义
  */
 
-/**
- * 窗口配置
- */
-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 // 可选：窗口标题
+interface RequestOptions {
+  targetUrl: string
+  method?: string
+  headers?: Record<string, string>
+  body?: string
+  templateReplacements: TemplateReplacementRule[]
 }
-
-/**
- * 窗口初始化参数
- */
-export interface PageInitializedParam {
-  widgetInfo?: WidgetInfo;
-  customParam: any;
+export interface TemplateReplacementRule {
+  placeholder: string // 要替换的字符，用户自定义，如 "{{token}}"
+  fields: string[] // 替换参数，可选：targetUrl, method, headers, body
+  dataNode: string // 数据节点路径，如 "config.token"
 }
 
-/**
- * 高级代理请求参数
- */
-export interface AdvancedProxyRequest {
-  url: string;
-  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-  headers?: Record<string, string>;
-  body?: any;
-  timeout?: number;
-  [key: string]: any;
-}
-
-/**
- * 高级代理请求项
- */
-export interface AdvancedProxyItem {
-  url: string;
-  method?: string;
-  headers?: Record<string, string>;
-  body?: any;
-  [key: string]: any;
-}
+// ========== 微应用 API 接口 ==========
 
-/**
- * 批量代理请求参数
- */
-export interface AdvancedBatchProxyRequest {
-  requests: AdvancedProxyItem[];
-  parallel?: boolean;
-  [key: string]: any;
-}
-
-/**
- * 保存数据节点请求
- */
-export interface SaveDataNodeRequest {
-  node: string;
-  data: any;
-  [key: string]: any;
-}
-
-/**
- * 获取数据节点请求
- */
-export interface GetDataNodeRequest {
-  node: string;
-  [key: string]: any;
-}
-
-/**
- * 微应用 API 接口定义
- */
 export interface MicroAppAPI {
   // 窗口管理
   window: {
-    /**
-     * 打开窗口
-     * @param param 窗口参数
-     * @returns 窗口ID
-     */
-    open: (options: OpenWindowOptions) => string;
-
-    /**
-     * 关闭窗口
-     * @param windowId 窗口ID
-     * @returns 是否成功
-     */
-    close: (windowId: string) => boolean;
-
-    /**
-     * 切换窗口显示/隐藏
-     * @param windowId 窗口ID
-     * @returns 是否成功
-     */
-    toggle: (windowId: string) => boolean;
-  };
+    open: (options: OpenWindowOptions) => string
+    // close: (windowId: string) => boolean
+    // toggle: (windowId: string) => boolean
+  }
 
   // 缓存管理
   localCache: {
-    // 用户级缓存
+    // 用户缓存
     user: {
-      /**
-       * 获取缓存值
-       * @param key 缓存键
-       */
-      get: (key: string) => Promise<any>;
-
-      /**
-       * 设置缓存值
-       * @param key 缓存键
-       * @param value 缓存值
-       * @param expireTimestamp 过期时间戳（秒），0表示不过期
-       */
-      set: (key: string, value: any, expireTimestamp?: number) => Promise<void>;
-
-      /**
-       * 删除缓存
-       * @param key 缓存键
-       */
-      del: (key: string) => Promise<void>;
-
-      /**
-       * 清空所有用户缓存
-       */
-      clear: () => Promise<void>;
-
-      /**
-       * 获取所有缓存键
-       */
-      getKeys: () => Promise<string[]>;
-
-      /**
-       * 获取数据并缓存（如果缓存不存在则调用API）
-       * @param key 缓存键
-       * @param apiCall API调用函数
-       * @param expireTimestamp 过期时间（秒）
-       */
-      getWithCache: <T>(
-        key: string,
-        apiCall: () => Promise<T>,
-        expireTimestamp?: number,
-      ) => Promise<T>;
-    };
-
+      get: (key: string) => Promise<any>
+      set: (key: string, value: any, expireTimestamp?: number) => Promise<void>
+      del: (key: string) => Promise<void>
+      clear: () => Promise<void>
+      getKeys: () => Promise<string[]>
+      // getWithCache: <T>(
+      //   key: string,
+      //   apiCall: () => Promise<T>,
+      //   expireTimestamp?: number,
+      // ) => Promise<T>
+    }
     // 应用级缓存
     app: {
-      /**
-       * 获取缓存值
-       * @param key 缓存键
-       */
-      get: (key: string) => Promise<any>;
-
-      /**
-       * 设置缓存值
-       * @param key 缓存键
-       * @param value 缓存值
-       * @param expireTimestamp 过期时间戳（秒），0表示不过期
-       */
-      set: (key: string, value: any, expireTimestamp?: number) => Promise<void>;
-
-      /**
-       * 删除缓存
-       * @param key 缓存键
-       */
-      del: (key: string) => Promise<void>;
-
-      /**
-       * 清空所有应用缓存
-       */
-      clear: () => Promise<void>;
-
-      /**
-       * 获取所有缓存键
-       */
-      getKeys: () => Promise<string[]>;
-
-      /**
-       * 获取数据并缓存（如果缓存不存在则调用API）
-       * @param key 缓存键
-       * @param apiCall API调用函数
-       * @param expireTimestamp 过期时间（秒）
-       */
-      getWithCache: <T>(
-        key: string,
-        apiCall: () => Promise<T>,
-        expireTimestamp?: number,
-      ) => Promise<T>;
-    };
-  };
+      get: (key: string) => Promise<any>
+      set: (key: string, value: any, expireTimestamp?: number) => Promise<void>
+      del: (key: string) => Promise<void>
+      clear: () => Promise<void>
+      getKeys: () => Promise<string[]>
+      // getWithCache: <T>(
+      //   key: string,
+      //   apiCall: () => Promise<T>,
+      //   expireTimestamp?: number,
+      // ) => Promise<T>
+    }
+  }
 
   // 数据节点
   dataNode: {
     // 用户数据节点
     user: {
       getByKey: <T = any>(node: string, key: string) => Promise<T>
+      getByKeys: <T = any>(node: string, keys: string[]) => Promise<T>
       setByKey: <T = any>(node: string, key: string, value: Record<string, any>) => Promise<T>
       delByKey: <T = any>(node: string, key: string) => Promise<T>
     }
     // 应用级数据节点
     app: {
       getByKey: <T = any>(node: string, key: string) => Promise<T>
+      getByKeys: <T = any>(node: string, keys: string[]) => Promise<T>
       setByKey: <T = any>(node: string, key: string, value: Record<string, any>) => Promise<T>
       delByKey: <T = any>(node: string, key: string) => Promise<T>
     }
   }
 
-
   // 网络透传
   network: {
-    /**
-     * 发送单个请求
-     * @param params 请求参数
-     */
-    request: <T = any>(params: AdvancedProxyRequest) => Promise<T>;
-
-    /**
-     * 批量发送请求
-     * @param params 批量请求参数
-     */
-    batchRequest: <T = any>(params: AdvancedBatchProxyRequest) => Promise<T>;
-
-    /**
-     * 智能批量请求（自动分批）
-     * @param requests 请求列表
-     * @param batchSize 每批数量
-     */
-    smartBatchRequest: <T = any>(
-      requests: AdvancedProxyItem[],
-      batchSize?: number,
-    ) => Promise<T[]>;
-  };
-
+    request: <T = any>(params: RequestOptions) => Promise<T>
+    // batchRequest: <T = any>(params: MicroApp.ApiRequest.AdvancedBatchProxyRequest) => Promise<T>
+    // smartBatchRequest: <T = any>(
+    //   requests: MicroApp.ApiRequest.AdvancedProxyItem[],
+    //   batchSize?: number,
+    // ) => Promise<T[]>
+  }
 
+  // 小部件
   widget: {
     save: <T = any>(data: WidgetInfo) => Promise<T>
   },
+}
 
-  // 状态（只读）
-  state: {
-    /**
-     * 当前窗口数量
-     */
-    windowCount: number;
+// ========== 窗口相关类型 ==========
 
-    /**
-     * 可见窗口数量
-     */
-    visibleWindows: number;
-  };
+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
+
+  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

@@ -5,20 +5,25 @@ import { MicroAppAPI } from './api';
 
 export interface SpContext {
     api: MicroAppAPI;
-    isDark: boolean;
+    darkMode: boolean;
     language: string;
     networkMode: string;
     staticPath: string;
     role: number;
     // size: { width: number; height: number };
-    [key: string]: any;
+    // [key: string]: any;
+}
+
+export interface PageInitializedParam {
+  widgetInfo?: WidgetInfo
+  customParam: any
 }
 
 export interface SpContextWidget extends SpContext {
     // itemInfo: ItemInfo;
-    background: string;
+    // background: string;
     widgetInfo: WidgetInfo;
-    gridSizeType: GridSizeType;
+    // gridSizeType: GridSizeType;
 }
 
 export interface SpContextPage extends SpContext {
@@ -33,7 +38,8 @@ export interface WidgetInfo {
     widgetId: string // 小部件ID
     background?: string // 背景颜色
     config: Record<string, any> // 配置
-    privateConfig: Record<string, any> // 私有配置
+    gridSize: string
+    title: string
 }