@dao42/d42paas-front 0.9.23 → 0.9.26

package/dist/DaoPaaS.d.ts

@@ -1,570 +1,170 @@
-import { ThemeType } from '~/theme';
-
-export interface DiffPatternInfo {
-  value: string;
-  type: string;
-}
+export { Messages } from '../constants/messages';
+export { ThemeType } from '../theme';
 
+/**
+ * SDK内部组件名
+ */
 export type ComponentType =
-  | 'Page'
   | 'Tree'
   | 'Editor'
-  | 'NewEditor'
-  | 'Console'
   | 'Browser'
+  | 'Console'
   | 'Shell';
 
-export type Components = Record<ComponentType, any>;
-
+/**
+ * Playground状态类型
+ */
 export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
-export type DockerStatus = 'RUNNING' | 'STOP';
-
-export interface TreeProps {
-  /**
-   * The tree Item height
-   */
-  treeItemHeight?: string;
-  /**
-   * The background color of the tree
-   */
-  bgColor?: string;
-
-  /**
-   * The text color of the tree
-   */
-  fontColor?: string;
-
-  /**
-   * The drop background color
-   */
-  dropBgColor?: string;
-
-  /**
-   * The drop Text color
-   */
-  dropTextColor?: string;
-
-  /**
-   * The hover background color
-   */
-  hoverBgColor?: string;
-
-  /**
-   * The hover Text color
-   */
-  hoverTextColor?: string;
-
-  /**
-   * The tree item will fire the event when you click on it
-   *
-   * @param The path of the item
-   * @param The uri of the item
-   * @event
-   */
-  onClick?: (arg: { path: string; uri: string }) => void;
-}
-
-export interface MenuTagProps {
-  /**
-   * The style of the menu tag block
-   */
-  menuStyle?: {
-    /**
-     * The background color
-     */
-    backgroundColor?: string;
-
-    /**
-     * The text color
-     */
-    textColor?: string;
-
-    /**
-     * The hover background color
-     */
-    hoverBgColor?: string;
-
-    /**
-     * The hover text color
-     */
-    hoverTextColor?: string;
-
-    /**
-     * The icon color
-     */
-    iconColor?: string;
-
-    /**
-     * The icon hover color
-     */
-    hoverIconColor?: string;
-
-    /**
-     * The menu tag height
-     */
-    height?: string;
-  };
-}
-
-interface EditorProps extends MenuTagProps {
-  /**
-   * The editor font size
-   */
-  fontSize: string;
-
-  /**
-   * The editor line height
-   */
-  lineHeight: string;
-
-  serviceWorkerOrigin?: string;
-
-  /**
-   *
-   */
-
-  /**
-   * The Theme of the editor block
-   */
-  theme?: {
-    /**
-     * The color of the margin view overlay
-     */
-    marginViewOverlaysBgColor?: string;
-
-    /**
-     * The width of the margin view overlay
-     */
-    marginViewOverlaysWidth?: string;
-
-    /**
-     * The left position of the margin view overlay
-     */
-    marginViewOverlaysLeft?: string;
-
-    /**
-     * The line number color
-     */
-    lineNumbersColor?: string;
-
-    /**
-     * The line number with
-     */
-    lineNumbersWidth?: string;
-
-    /**
-     * The line number left
-     */
-    lineNumbersLeft?: string;
-
-    /**
-     * The active line number color
-     */
-    activeLineNumberColor?: string;
-  };
-}
-
-export interface ConsoleOrShellProps {
-  /**
-   * The font size of the shell
-   */
-  fontSize?: number;
-
-  /**
-   * The font family of the shell
-   */
-  fontFamily?: string;
-
-  /**
-   * The line height of the shell
-   */
-  lineHeight?: number;
-
-  /**
-   * The cursor color of the shell
-   */
-  cursorBlink?: boolean;
-
-  /**
-   * The cursor width of the shell
-   */
-  cursorWidth?: number;
-
-  /**
-   * The cursor style of the shell
-   */
-  cursorStyle?: string;
-
-  /**
-   * if the shell can be right click to open the context menu
-   */
-  rightClickSelectsWord?: boolean;
-
-  /**
-   * The theme of the shell block
-   */
-  theme?: {
-    /**
-     * The background color
-     */
-    background?: string;
-  };
-}
-
-export interface BrowserProps {
-  /**
-   * The url of the browser
-   */
-  url?: string;
-
-  /**
-   * if the browser can show the url
-   */
-  showURL?: boolean;
-
-  /**
-   * The fresh icon color
-   */
-  freshIconColor?: string;
-
-  /**
-   * The input text color
-   */
-  inputColor?: string;
-
-  /**
-   * The open icon color
-   */
-  openIconColor?: string;
-
-  inputTextColor?: string;
-  inputBgColor?: string;
-  bgColor?: string;
-  navBgColor?: string;
-  navBorder?: string;
-}
-
 /**
- * The Component props type collection
+ * Docker运行状态
  */
-export type ComponentPropsType =
-  | EditorProps
-  | TreeProps
-  | BrowserProps
-  | ConsoleOrShellProps;
-
+export type DockerStatus = 'RUNNING' | 'STOP';
 /**
- *
- * @interface Component
- * @desc The props of the component.
- *
+ * 用于挂载组件的的配置接口
  */
-export interface Component<T> {
-  /**
-   *
-   * The DOM for the component.
-   * @type {(string | HTMLElement | Element)}
-   *
-   */
+export interface Component {
+  /** SDK内部组件挂载的dom元素选择器，如“.dom-classname”,"#dom-id","div span" */
   container: string | HTMLElement | Element;
-
+  /** SDK内部组件名 */
   item: ComponentType;
-  /**
-   * The component props
-   * todo: fix the type of any
-   */
-  props?: any;
+  /** 传给SDK内部组件的props */
+  // props?: any;
 }
 
 /**
- * Passing the values to init the playground.
- * @category PaaS Options [Required]
+ * SDK消息监听数据类型
+ */
+export type Message = { 
+  /** 消息类型 */
+  name: Messages; 
+  /** 消息内容 */
+  payload?: any; 
+  /** 错误信息 */
+  error?: string 
+};
+
+/**
+ * SDK构造函数参数
+ * @category PaaSOptions [Required]
  */
 export interface PaaSOptions {
+  /** 票 */
   ticket: string;
+  /** 租户id */
   tenantId: string;
+  /** 用户信息 */
   userInfo: UserInfo;
-  // 可选, 默认连接到 www.1024paas.com
+  /** 可选, 默认连接到 www.1024paas.com */
   paasDomain?: string;
-
-  /**
-   *
-   * Here you can map the components to the playground.
-   *
-   * @category ComponentsMapper
-   *
-   */
-  components?: Component<ComponentPropsType>[];
-  // css theme
+  /** SDK主题，默认dark */
   themeType?: ThemeType;
-
-  /**
-   *
-   * Message listener to the application.
-   * @param Message
-   * @event
-   */
-  onMessage?: (message: Message) => void;
-
-  /**
-   *
-   * Error listener to the application.
-   * @param The error message block
-   * @event
-   */
-  onError?: (error: Message) => void;
 }
 
 /**
- * * This is the entry point for the application.
- *
- * * like:
- *
+ * 这是应用程序入口
  *
+ * 使用如下:
  * ```ts
-    let options = {...};
-    let Dao = new DaoPaaS(options);
-```
- *
- * See {@link Options} for more details.
+ *    let options = {...};
+ *    let dao = new DaoPaaS(options);
+ * ```
  */
 export interface IDaoPaaS {
+  /** 主题类型 */
+  themeType: ThemeType
+  /** sdk版本 */
+  sdkVersion: string
   /**
-   *
-   * Error listener to the application.
-   * @param The error message block
+   * 错误消息侦听器.
+   * @param {(error: Message) => void} callback 回调函数
    * @event
    */
-  onError?: (error: ErrorType) => void;
-
+  onError?: (callback: (error: Message) => void) => void;
   /**
-   *
-   * Message listener to the application.
-   * @param MessageType
+   * 消息侦听器.
+   * @param {(message: Message) => void} callback 回调函数
    * @event
    */
-  onMessage?: (message: MessageType) => void;
-
+  onMessage?: (callback: (message: Message) => void) => void;
   /**
-   *
-   * Replaying method for global calling.
-   * @param {unFollowUser} args
-   *
+   * 页面卸载的时候需要销毁实例和相关的缓存数据
    */
   dispose(): void;
-
   /**
-   *
-   * Replaying method for global calling.
-   * @param {unFollowUser} args
-   *
+   * 取消用户跟随
+   * @param { UserInfo } user 用户信息
+   * @param { (userInfo: UserInfo) => void } callback 回调函数
    */
   unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
-
   /**
-   *
-   * Replaying method for global calling.
-   * @param {followUser} args
-   *
+   * 用户跟随
+   * @param { string } agentUserId 用户id
+   * @param { (userInfo: UserInfo) => void } callback 回调函数
    */
   followUser(agentUserId: string, callback: (userInfo: UserInfo) => void): void;
 
   /**
-   *
-   * Replaying method for global calling.
-   * @param {DiffPatternInfo} args
-   * @param {DiffPatternInfo} args
-   *
-   */
-  // setDiff(current: DiffPatternInfo, next: DiffPatternInfo): void;
-
-  /**
-   *
-   * Prepare for playback. A playbackInfo message will be triggered
-   *
+   * 准备回放数据,回放摘要信息到达后,会触发PlaybackInfo
    */
   preparePlayback();
-
   /**
-   *
-   * Start playback with start time and rate.
-   * @param {number} start The difference relative to the absolute start time
-   * @param {number} rate The multiplier relative to the original rate
-   *
+   * 启动播放,可以指定相对开始时间和速率
+   * @param { number } start The difference relative to the absolute start time
+   * @param { number } rate The multiplier relative to the original rate
    */
   startPlayback(start: number, rate: number);
   /**
-   * Restart playback
-   * @param rate The multiplier relative to the original rate
+   * 启动播放,可以指定相对开始时间和速率
+   * @param { number } rate The multiplier relative to the original rate
    */
   restartPlayback(rate?: number);
-
   /**
-   * Change the progress directly
+   * 改变相对开始时间,一般发生在用户托动进度条
    * @param start The difference relative to the absolute start time
    */
-  goToPlayback(start: number);
-
+  goToPlayback(start: number): void;
   /**
-   * Pause playback
+   * 暂停回放
    */
-  pausePlayback();
-
+  pausePlayback(): void;
   /**
-   * Resume playback
+   * 恢复(继续)播放
    */
-  resumePlayback();
-
+  resumePlayback(): void;
   /**
-   * Set the rate for playback
-   * @param rate The multiplier relative to the original rate
+   * 设置播放速率
+   * @param {number} rate 播放速率
    */
   setRate(rate: number);
-
   /**
-   * Stop playback
+   * 停止播放,用于清理资源释放内存
    */
   stopPlayback();
-
-  /**
-   *
-   * Recording method for global calling.
-   * @param {boolean} arg
-   *
-   */
-  // record(arg?: boolean): void;
-
   /**
-   *
-   * Active the playground handler.
-   *
+   * 激活playground
    */
   activePlayground(): void;
-
   /**
-   *
-   * Run the playground handler.
-   *
+   * 运行 playground 方法
    */
   runPlayground(): void;
-
   /**
-   *
-   * Stop the playground.
-   *
+   * 停止 playground 方法
    */
   stopPlayground(): void;
-
   /**
-   * Editor component.
-   *
-   *
-   * ```ts
-   *   Dao.Editor({
-   *     container: '#editor',
-   *     props: {...EditorProps}
-   *   });
-  ```
-   *
-   * @category Components
-   *
-   *
+   * 挂载SDK内部组件
+   * @param {Component[]} components 组件配置信息
    */
-  // Editor(args: Omit<Component<EditorProps>, 'item'>): void;
-
-  /**
-   *
-   * Page component.
-   * @ignore
-   * @category Components
-   * @param Component
-   *
-   */
-  // Page(args: Omit<Component<TreeProps>, 'item'>): void;
-
-  /**
-   *
-   * Tree component.
-   *
-   * ```ts
-   *   Dao.Tree({
-   *     container: '#tree',
-   *     item: 'tree',
-   *     props: {...TreeProps}
-   *   });
-  ```
-   *
-   *
-   * @category Components
-   * @param Component
-   *
-   */
-  // Tree(args: Omit<Component<TreeProps>, 'item'>): void;
-
+  mapRender(components: Component[]): void;
   /**
-   *
-   * Shell component.
-   *
-   *
-   * ```ts
-   *   Dao.Shell({
-   *     container: '#shell',
-   *     item: 'shell',
-   *     props: {...ConsoleOrShellProps}
-   *   });
-  ```
-   *
-   *
-   * @category Components
-   * @param Component
-   *
-   */
-  // Shell(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
-
-  /**
-   *
-   * Browser component.
-   *
-   * ```ts
-   *   Dao.Browser({
-   *     container: '#browser',
-   *     item: 'browser',
-   *     props: {...BrowserProps}
-   *   });
-  ```
-   *
-   *
-   * @category Components
-   * @param Component
-   *
-   */
-  // Browser(args: Omit<Component<BrowserProps>, 'item'>): void;
-
-  /**
-   *
-   * Console component.
-   *
-   *
-   * ```ts
-   *   Dao.Console({
-   *     container: '#console',
-   *     item: 'console',
-   *     props: {...ConsoleOrShellProps}
-   *   });
-  ```
-   *
-   *
-   * @category Components
-   * @param Component
-   *
+   * 设置本地logger打印是否开启的方法
+   * @param {any} data 设置的值，当这个值存在就会打印logger
    */
-  // Console(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
-
-  mapRender(components: Component<ComponentType>[]): void;
-
+  loggerEnable(data: any): void;
   /**
-   * 设置本地logger打印是否开启的方法
-   * @param data 设置的值，当这个值存在就会打印logger
+   * 切换主题
+   * @param {ThemeType} type 主题类型
    */
-  public loggerEnable(): void;
+  loadTheme(type: ThemeType): void;
 }