@sun-panel/micro-app 1.0.5

package/src/types/api.d.ts

@@ -0,0 +1,267 @@
+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 // 可选：窗口标题
+}
+
+/**
+ * 窗口初始化参数
+ */
+export interface PageInitializedParam {
+  widgetInfo?: WidgetInfo;
+  customParam: any;
+}
+
+/**
+ * 高级代理请求参数
+ */
+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;
+}
+
+/**
+ * 批量代理请求参数
+ */
+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;
+  };
+
+  // 缓存管理
+  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>;
+    };
+
+    // 应用级缓存
+    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>;
+    };
+  };
+
+  // 数据节点
+  dataNode: {
+    // 用户数据节点
+    user: {
+      getByKey: <T = any>(node: string, key: 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>
+      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[]>;
+  };
+
+
+  widget: {
+    save: <T = any>(data: WidgetInfo) => Promise<T>
+  },
+
+  // 状态（只读）
+  state: {
+    /**
+     * 当前窗口数量
+     */
+    windowCount: number;
+
+    /**
+     * 可见窗口数量
+     */
+    visibleWindows: number;
+  };
+}
+

package/src/types/common.d.ts

@@ -0,0 +1,67 @@
+import { MicroAppAPI } from './api';
+/**
+ * 通用类型定义
+ */
+
+export interface SpContext {
+    api: MicroAppAPI;
+    isDark: boolean;
+    language: string;
+    networkMode: string;
+    staticPath: string;
+    role: number;
+    // size: { width: number; height: number };
+    [key: string]: any;
+}
+
+export interface SpContextWidget extends SpContext {
+    // itemInfo: ItemInfo;
+    background: string;
+    widgetInfo: WidgetInfo;
+    gridSizeType: GridSizeType;
+}
+
+export interface SpContextPage extends SpContext {
+    background: string;
+    widgetInfo: WidgetInfo;
+    customParam: any;
+}
+
+
+// 小部件配置
+export interface WidgetInfo {
+    widgetId: string // 小部件ID
+    background?: string // 背景颜色
+    config: Record<string, any> // 配置
+    privateConfig: Record<string, any> // 私有配置
+}
+
+
+// export interface ItemInfo {
+//     id: number
+//     onlyName: string
+//     title: string
+//     description: string
+//     // microAppId: string
+//     // microAppCardSrc: string
+//     // microAppSrc: string
+//     cardSize: number
+//     background: string
+//     itemCardGroupId: number
+//     sort: number
+//     cardData: any
+//     cardDataPrivate?: any
+//     // blur: number
+//     showTitle?: boolean
+// }
+
+// LitElement 使用的属性变更类型
+export type ChangedProperties = Map<string, any>;
+
+export type GridSizeType = number;
+
+export type BackgroundType = string;
+
+export type NetworkMode = 'wan' | 'lan' | 'auto';
+
+export type RoleType = 0 | 1 | 2; // 0:公开模式 1:私有模式 2:管理员模式