@tuya-sat/micro-script 3.3.17 → 3.3.18

package/dist/template/micro-app/interfaces.ts

@@ -1,21 +1,75 @@
+import { ConfigProviderProps } from 'antd';
 import { CaptureContext, Event, Severity } from '@sentry/types';
 
-type IState = { [k in string]: string | number | null };
-interface mainHistory {
-  push: (path: string, state?: IState) => void;
-  replace: (path: string, state?: IState) => void;
-  go: (n: number) => void;
-  goBack: () => void;
-  goForward: () => void;
+type ThemeMode = 'light' | 'dark';
+
+interface UserInfo {
+  user_nick_name: string;
+  user_name: string;
+  roles: Array<{
+    role_code: string;
+    role_name: string;
+  }>;
+  mobile?: string;
+  email?: string;
+  country_code?: string;
+  user_id?: string;
+  root_namespace?: string;
+  current_namespace?: string;
+  current_namespace_name?: string;
+  head_pic?: string
+  username?: string;
+  nickname?: string;
+  timezone_display_name?: string;
 }
+interface MainHistoryState {
+  /**
+   * 微应用唯一id(优先级最高)
+   */
+  universal_id?: string;
+  /**
+   * 微应用代码
+   */
+  app_code?: string;
+
+  /**
+   * 是否在新的标签页中打开
+   */
+  blank?: boolean;
 
-interface DynamicProps {
-  setBreadcrumb: SetBreadcrumb;
+  /**
+   * 其他状态
+   */
   [key: string]: any;
-}
+};
+interface MainHistory {
+  /**
+   * 跳转到一个新的路径
+   * @param path 路径
+   * @param state 状态
+   */
+  push: (path: string, state?: MainHistoryState) => void;
+  /**
+   * 替换当前路径
+   * @param path 路径
+   * @param state 状态
+   */
+  replace: (path: string, state?: MainHistoryState) => void;
 
-interface SetBreadcrumb {
-  (breadcrumbInfos?: BreadcrumbInfoInput[]): void;
+  /**
+   * 导航到历史记录中的上一个路径
+   */
+  go: (n: number) => void;
+
+  /**
+   * 导航到历史记录中的上一个路径
+   */
+  goBack: () => void;
+
+  /**
+   * 导航到历史记录中的下一个路径
+   */
+  goForward: () => void;
 }
 
 type BreadcrumbInfoInput =
@@ -23,40 +77,422 @@ type BreadcrumbInfoInput =
       type: 'auto' | 'root';
       name?: never;
       path?: never;
+      goBack?(): void;
     }
   | {
       type: 'menu';
       name?: never;
       path: string;
+      goBack?(): void;
     }
   | {
       type: 'c';
       name: string;
       path: string;
+      render?(eleTitle: HTMLDivElement): void;
+      goBack?(): void;
     };
 
+interface SetBreadcrumb {
+  (
+    breadcrumbInfos?: BreadcrumbInfoInput[],
+    /**
+     * 针对 v5/v6 版微应用的额外操作
+     */
+    actions?: {
+      activeKey?: string;
+      hideFullScreen?: boolean;
+      options?: Array<{
+        label: string;
+        value: string;
+        tooltip: string;
+      }>;
+      onClick?(key: string): void;
+      renderExtra?(eleExtra: HTMLDivElement): void;
+    }
+  ): void;
+}
+
+type ThemeSubscribeGetValue =
+  | (
+    /**
+     * 获取当前主题（v4 版微应用）
+     * @example 'light' | 'dark'
+     */
+    () => ThemeMode
+  )
+  | (
+    /**
+     * 获取当前主题（v5/v6 版微应用）
+     * @example { theme: { themeMode: 'light' | 'dark' }, ... }
+     */
+    () => ConfigProviderProps & {
+      theme: ConfigProviderProps['theme'] & { themeMode: ThemeMode };
+    }
+  );
+
+
+type MqttStatus = 'connected' | 'reconnecting' | 'reconnect_failed' | 'offline' | 'close' | 'error';
+interface MqttStatusEvent {
+  status: MqttStatus;
+  remainingRetries?: number;
+  maxRetries?: number;
+  error?: any;
+}
+type MqttStatusListener = (event: MqttStatusEvent) => void;
+export interface SubscribeTopicOption {
+  /** 为 true 时不记入 micTopics，卸载微应用时不会随 unsubscribeMicTopics 一起取消 */
+  isGlobal?: boolean;
+  /** 与 topic 一一对应；不传则仅按 topic 匹配，不校验 protocol */
+  protocol?: number;
+}
+
+type MqttTopic = string | ((uid: string) => string);
+
+interface PublishTopicOption {
+  protocol?: number;      // 下发协议号
+  type?: string;          // 消息类型，默认 ''
+  v?: number;             // 协议版本，默认 1
+  qos?: 0 | 1 | 2;       // MQTT QoS 等级，默认 0
+  retain?: boolean;       // 是否保留消息
+  isRaw?: boolean;        // true：跳过标准封装，直接发送 data
+}
+
+/**
+ * 数据模型类型
+ * basic: 基础数据模型。对应 v4 版微应用
+ * smart_space: 空间智能行业。对应 v5 版微应用
+ * smart_home: 空间智能。对应 v6 版微应用
+ */
+type DATA_MODEL = 'basic' | 'smart_space' | 'smart_home';
+
 export interface IQiankunProps {
+  /**
+   * 微应用基础路径
+   * @example '/apps/2004417307740209166'
+   */
   base: string;
-  container: HTMLElement; // 子应用所在容器
-  dynamicProps: DynamicProps; // 面包屑
-  getOwnMenu: () => { entry_name: string }; // 获取当前选中菜单
+
+  /**
+   * 子应用所在容器
+   * @example document.querySelector('#root')
+   */
+  container: HTMLElement;
+
+  /**
+   * 微应用自定义配置
+   * @example '{"hello": "just for test"}'
+   */
+  customConfig: string | null;
+
+  /**
+   * 主应用 window 对象。
+   * 由于 qiankun 的沙箱机制，在使用三方包时，某些功能（比如 jsonp）无法将属性挂载到全局对象上
+   * 此时可以通过此属性获取主应用 window 对象，从而调用主应用的某些功能
+   */
+  mWindow: Window;
+
+  /**
+   * 用于微应用间跳转
+   */
+  mainHistory: MainHistory;
+
+  /**
+   * 当前家庭/项目ID（v5/v6 版微应用）
+   * @example '34808062'
+   */
+  projectId: string;
+
+  /**
+   * 当前业务隔离类型（v5/v6 版微应用）
+   * @example 'homeId'
+   */
+  isolationType: 'projectId' | 'homeId' | null;
+
+  /**
+   * SaaS 所属行业类型
+   * @example 'smart_home'
+   */
+  industryType:
+  | 'smart_space' // 空间智能行业
+  | 'smart_home' // 空间智能
+  | 'smart_operation' // 智能运营
+  | 'ems_energy' // 能源管理
+  | 'appliance' // 家电
+  | 'light' // 照明
+  | 'content_manage' // 内容管理
+  | string;
+
+  /**
+   * 是否支持移动端
+   * @example true
+   */
+  isSupportMobile: boolean;
+
+  /**
+   * 当前区域
+   * - tx: 中国大陆
+   * - us: 美国
+   * - eu: 欧洲
+   * - in: 印度
+   * - ueaz: 美东
+   * - we: 西欧
+   * - sg: 新加坡
+   * @example 'tx'
+   */
+  region: 'tx' | 'us' | 'eu' | 'in' | 'ueaz' | 'we' | 'sg';
+
+  /**
+   * 微应用静态资源入口地址前缀
+   * @example 'https://static1.tuyacn.com/static/xxxxx/0.0.1'
+   */
+  resourcePrefix: string;
+
+  /**
+   * 获取当前菜单信息
+   * @example { entry_name: '首页', entry_name_en: 'Home' }
+   */
+  getOwnMenu: () => {
+    entry_name: string;
+    entry_name_en: string;
+  };
+
+  /**
+   * 判断是否存在指定微应用
+   * @param appCodeOrUuid 微应用代码或 UUID
+   * @example (appCodeOrUuid: string) => true
+   */
+  hasMicroApp?: (appCodeOrUuid: string) => boolean;
+
+  /**
+   * 是否拥有当前微应用的某个权限点
+   * @param permissionCode 权限点代码
+   * @example (permissionCode: string) => true
+   */
   hasPermission: (permissionCode: string) => boolean;
-  isSupportMobile: boolean; // 是否支持移动端
-  mainHistory: mainHistory; // 用于微应用间跳转
-  modifySelectedMenu: () => void; //
-  region: 'tx' | 'us' | 'eu' | 'in' | 'ueaz' | 'we' | 'sea';
-  resourcePrefix: string; // 静态资源地址
+
+  /**
+   * 是否拥有指定微应用的某个权限点
+   * @param appCodeOrUuid 微应用代码或 UUID
+   * @param permissionCode 权限点代码
+   * @example (appCodeOrUuid: string, permissionCode: string) => true
+   */
+  hasGPermission: (appCodeOrUuid: string, permissionCode: string) => boolean;
+
+  /**
+   * 动态属性
+   */
+  dynamicProps: {
+    /**
+     * 自定义面包屑
+     */
+    setBreadcrumb: SetBreadcrumb;
+    [key: string]: any;
+  };
+
+  /**
+   * 修改当前选中菜单（v4 版微应用）
+   */
+  modifySelectedMenu: () => void;
+
+  /**
+   * v5/v6 版微应用 MQTT 相关接口
+   */
+  mqtt: {
+    /**
+     * 订阅指定 topic，收到消息时调用 cbFn
+     * @param topic 主题
+     * @param cbFn 回调函数
+     * @param option 选项
+     * @example subscribeTopic((uid: string) => `topic/${uid}/test`, (msg) => { console.log(msg); })
+     */
+    subscribeTopic: (
+      topic: MqttTopic,
+      cbFn?: (msg: any) => void,
+      option?: SubscribeTopicOption
+    ) => void;
+
+    /**
+     * 向指定 topic 发布消息
+     * @param topic 主题
+     * @param data 消息
+     * @param option 选项
+     * @example publishTopic((uid: string) => `topic/${uid}/test`, { message: 'hello' }, { protocol: 201 })
+     */
+    publishTopic: (
+      topic: MqttTopic,
+      data: any,
+      option?: PublishTopicOption
+    ) => Promise<void>;
+
+    /**
+     * 取消订阅指定 topic
+     * @param topic 主题
+     * @example unsubscribeTopic((uid: string) => `topic/${uid}/test`)
+     */
+    unsubscribeTopic: (topic?: MqttTopic) => void;
+
+    /**
+     * 监听 MQTT 连接状态变化
+     * @param listener 监听函数
+     * @example onStatusChange((evt) => { console.log(evt); })
+     */
+    onStatusChange(listener: MqttStatusListener): () => void
+  }
+
+  /**
+   * v5/v6 版微应用使用旧版 mqtt 相关接口替代
+   * @deprecated 慎用，以后会移除
+   */
+  mqttV4: {
+    /**
+     * 订阅指定 topic，收到消息时调用 cbFn
+     * @param bizType 业务类型
+     * @param cbFn 回调函数
+     * @param option 选项
+     * @example subscribeTopic('somebiztype', (msg) => { console.log(msg); })
+     */
+    subscribeTopic(
+      bizType: string,
+      cbFn?: (msg: any) => void,
+      option?: {
+        isGlobal: boolean;
+      }
+    ): void;
+
+    /**
+     * 取消订阅指定 topic
+     * @param bizType 业务类型
+     * @example unsubscribeTopic('somebiztype')
+     */
+    unsubscribeTopic(bizType: string): void;
+  }
+
+  /**
+   * sentry 错误上报
+   */
   sentry: {
     captureEvent: (event: Event) => string;
-    captureMessage: (
-      message: string,
-      captureContext?: CaptureContext | Severity
-    ) => string;
-    captureException: (
-      exception: any,
-      captureContext?: CaptureContext
-    ) => string;
+    captureMessage: (message: string, captureContext?: CaptureContext | Severity) => string;
+    captureException: (exception: any, captureContext?: CaptureContext) => string;
   };
-  tyLang: 'zh' | 'en'; // 当前语言
-  langResource: any;
+
+  /**
+   * 设置微应用加载状态
+   * @param loading 是否加载中
+   */
+  setLoading: (loading: boolean) => void;
+
+  /**
+   * 当前语言
+   * @example 'zh'
+   */
+  tyLang: 'zh' | 'en' | string;
+
+  /**
+   * 微应用国际化语言资源
+   * @example { zh: { 'hello': '你好' }, en: { 'hello': 'Hello' } }
+   */
+  langResource: {
+    zh: Record<string, string>;
+    en: Record<string, string>;
+    [key: string]: Record<string, string>;
+  };
+
+  /**
+   * 获取当前登录用户信息（v5/v6 版微应用）
+   * @example { user_nick_name: '张三', user_name: 'zhangsan', roles: [{ role_code: 'admin', role_name: '管理员' }], mobile: '13888888888', email: 'zhangsan@tuyacn.com', country_code: '86', user_id: '1234567890', root_namespace: 'root', current_namespace: 'current', current_namespace_name: '当前空间', head_pic: 'https://static1.tuyacn.com/static/xxxxx/0.0.1', username: 'zhangsan', nickname: '张三', timezone_display_name: 'Asia/Shanghai' }
+   */
+  getCurrentUser: () => UserInfo | null;
+
+  /**
+   * 获取当前登录用户信息（v4 版微应用）
+   * @deprecated v5/v6 版使用 `getCurrentUser()` 替代
+   * @example { user_nick_name: '张三', user_name: 'zhangsan', roles: [{ role_code: 'admin', role_name: '管理员' }], mobile: '13888888888', email: 'zhangsan@tuyacn.com', country_code: '86', user_id: '1234567890', root_namespace: 'root', current_namespace: 'current', current_namespace_name: '当前空间', head_pic: 'https://static1.tuyacn.com/static/xxxxx/0.0.1', username: 'zhangsan', nickname: '张三', timezone_display_name: 'Asia/Shanghai' }
+   */
+  user(): UserInfo | null;
+
+  /**
+   * 获取当前主题
+   * @example 'light' | 'dark'
+   */
+  gTheme(): ThemeMode;
+
+  /**
+   * 订阅主题
+   */
+  themeSubscribe: {
+    getValue: ThemeSubscribeGetValue;
+    subscribe: (cb: (type: ThemeMode, data: any) => void) => () => void;
+  };
+
+  /**
+   * 设置头部是否显示（v5/v6 版微应用）
+   * @param visible 是否显示头部
+   * @returns
+   */
+  setHeaderVisible: (visible: boolean) => void;
+
+  /**
+   * 设置侧边栏是否显示（v5/v6 版微应用）
+   * @param visible 是否显示侧边栏
+   * @returns
+   */
+  setSiderVisible: (visible: boolean) => void;
+
+  /**
+   * 设置侧边栏折叠状态（v5/v6 版微应用）
+   * @param collapsed 是否折叠侧边栏
+   * @returns
+   */
+  setSiderCollapsed: (collapsed: boolean) => void;
+
+  /**
+   * 隐藏菜单
+   * @deprecated 使用 `setSiderVisible()` 替代
+   * @param hidden 是否隐藏菜单
+   * @returns
+   */
+  hideMenus: (hidden?: boolean) => void;
+
+  /**
+   * 隐藏导航
+   * @deprecated 使用 `setHeaderVisible()`
+   * @param hidden 是否隐藏导航
+   * @returns
+   */
+  hideNav: (hidden?: boolean) => void;
+
+  /**
+   * 切换语言（v6 版微应用）
+   * @param lang 语言代码
+   * @param reload 是否刷新页面，默认为 true
+   * @example switchLang('en')
+   */
+  switchLang(lang: 'zh' | 'en' | string, reload?: boolean): void;
+
+  /**
+   * 切换家庭（v5/v6 版微应用）
+   * @param homeId 家庭ID
+   * @param autoRefresh 是否自动刷新，默认为 true
+   * @returns
+   */
+  switchHome: (homeId: string) => void;
+
+  /**
+   * 上报 tpm 事件
+   * @param key 事件key
+   * @param params 事件参数
+   */
+  tpmTrack: (key: string, params?: Record<string, any>) => void;
+
+  /**
+   * 由 qiankun 注入
+   */
+  setGlobalState: (state: any) => void;
+
+  /**
+   * 由 qiankun 注入
+   */
+  onGlobalStateChange: (func: (state: any, prev?: any) => void, watch?: boolean) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tuya-sat/micro-script",
-  "version": "3.3.17",
+  "version": "3.3.18",
   "bin": "./dist/bin/cli.js",
   "type": "commonjs",
   "license": "MIT",
@@ -23,9 +23,9 @@
     "@babel/preset-typescript": "7.16.7",
     "@babel/traverse": "^7.20.13",
     "@pmmmwh/react-refresh-webpack-plugin": "0.5.4",
-    "@tuya-sat/micro-dev-loader": "3.3.17",
-    "@tuya-sat/micro-dev-proxy": "3.3.17",
-    "@tuya-sat/micro-utils": "3.3.17",
+    "@tuya-sat/micro-dev-loader": "3.3.18",
+    "@tuya-sat/micro-dev-proxy": "3.3.18",
+    "@tuya-sat/micro-utils": "3.3.18",
     "@types/kill-port": "^2.0.0",
     "babel-loader": "8.2.4",
     "babel-plugin-import": "1.13.3",