@dao42/d42paas-front 0.9.87 → 0.9.89

package/dist/DaoPaaS.d.ts

@@ -1,291 +0,0 @@
-export { Messages } from '../constants/messages';
-export { ThemeType } from '../theme';
-import { ITheme } from 'xterm';
-
-export type InsertCodeLineCode = number | 'TOP' | 'BOTTOM';
-export interface IExtralAction {
-  replaceSelection?: Array<any> | string;
-}
-export type ContextMenuTypeItem = {
-  id?: number;
-  action: string;
-  text: string;
-  icon: string;
-  iconLabel: string;
-  commentStartLabel: string;
-  // commentEndLabel: string;
-  commentTips?: string;
-  hideCodeBlock: boolean;
-};
-export type CodeSnippetOption = {
-  template: string;
-  option: {
-    label: string;
-    detail?: string;
-  };
-};
-export type TranslateTypeOption = {
-  [typeof I18nLanguageType]: string;
-};
-export type TranslateType = Record<string, Record<TranslateTypeOption>>;
-export type CodeSnippetType = Record<string, Array<CodeSnippetOption>>;
-export type ContextMenuType = {
-  handleSelect: (
-    e: any,
-    callback?: (data: any, extralAction: IExtralAction) => void,
-  ) => void;
-  items: Array<ContextMenuTypeItem>;
-};
-export type ResultType = {
-  status: boolean;
-  message: string;
-};
-/**
- * SDK内部组件名
- */
-export type ComponentType =
-  | 'Tree'
-  | 'Editor'
-  | 'Browser'
-  | 'Console'
-  | 'Shell'
-  | 'MarkdownPreview';
-
-/**
- * Playground状态类型
- */
-export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
-/**
- * Docker运行状态
- */
-export type DockerStatus = 'RUNNING' | 'STOP' | 'DEBUG_RUNNING';
-/**
- * 用于挂载组件的的配置接口
- */
-export interface Component {
-  /** SDK内部组件挂载的dom元素选择器，如“.dom-classname”,"#dom-id","div span" */
-  container: string | HTMLElement | Element;
-  /** SDK内部组件名 */
-  item: ComponentType;
-  /** 传给SDK内部组件的props */
-  // props?: any;
-}
-
-/**
- * SDK消息监听数据类型
- */
-export type Message = {
-  /** 消息类型 */
-  name: Messages;
-  /** 消息内容 */
-  payload?: any;
-  /** 错误信息 */
-  error?: string;
-};
-
-/**
- * xterm样式设置
- */
-export interface XtermStyleType {
-  console?: ITheme;
-  terminal?: ITheme;
-}
-
-/**
- * SDK构造函数参数
- * @category PaaSOptions [Required]
- */
-export interface PaaSOptions {
-  /** 票 */
-  ticket: string;
-  /** 租户id */
-  tenantId: string;
-  /** 用户信息 */
-  userInfo: UserInfo;
-  /** 可选, 默认连接到 www.1024paas.com */
-  paasDomain?: string;
-  /** SDK主题，默认dark */
-  themeType?: ThemeType;
-  /** SDK国际化语言，默认ZH */
-  i18nLanguage?: I18nLanguageType;
-  /** 是否插入CRDT数据 - 1.是否开启回放功能 */
-  isInsertCrdt?: boolean;
-  /** 是否兼容遗留的markdown数学公式解析 - false不兼容(标准语法)  true(标准语法 + `$ $`)*/
-  isLegacyMarkdownMath?: boolean;
-  /** 回放模式：两针间隔最大时长触发事件参数 */
-  triggerEventForMaxTimespan?: number;
-  /** websocket最大尝试重连次数：5 */
-  reconnectMaxTimes?: number;
-  /** xterm样式配置 */
-  xtermStyle?: XtermStyleType;
-  /** 是否开启debug模式 */
-  isOpenDebugMode?: boolean;
-}
-
-export type EditorMode = 'default' | 'vim' | 'emacs';
-
-export type EditorIndentMode = 'space' | 'tab';
-
-export type GlobalConfig = {
-  editorMode?: EditorMode;
-  editorTabSize?: number;
-  editorWordWrap?: boolean;
-  fontSize?: string;
-  editorIndentMode?: EditorIndentMode;
-};
-
-export type Config = {
-  disableEditable?: boolean;
-  disableFileTreeAction?: boolean;
-};
-
-/**
- * 这是应用程序入口
- *
- * 使用如下:
- * ```ts
- *    let options = {...};
- *    let dao = new DaoPaaS(options);
- * ```
- */
-export interface IDaoPaaS {
-  /** 主题类型 */
-  themeType: ThemeType;
-  /** 国际化语言 */
-  i18nLanguage: I18nLanguageType;
-  /** sdk版本 */
-  sdkVersion: string;
-  /**
-   * 错误消息侦听器.
-   * @param {(error: Message) => void} callback 回调函数
-   * @event
-   */
-  onError?: (callback: (error: Message) => void) => void;
-  /**
-   * 消息侦听器.
-   * @param {(message: Message) => void} callback 回调函数
-   * @event
-   */
-  onMessage?: (callback: (message: Message) => void) => void;
-  /**
-   * 页面卸载的时候需要销毁实例和相关的缓存数据
-   */
-  dispose(): void;
-  /**
-   * 取消用户跟随
-   * @param { UserInfo } user 用户信息
-   * @param { (userInfo: UserInfo) => void } callback 回调函数
-   */
-  unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
-  /**
-   * 用户跟随
-   * @param { string } agentUserId 用户id
-   * @param { (userInfo: UserInfo) => void } callback 回调函数
-   */
-  followUser(agentUserId: string, callback: (userInfo: UserInfo) => void): void;
-
-  /**
-   * 准备回放数据,回放摘要信息到达后,会触发PlaybackInfo
-   */
-  preparePlayback();
-  /**
-   * 启动播放,可以指定相对开始时间和速率
-   * @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);
-  /**
-   * 启动播放,可以指定相对开始时间和速率
-   * @param { number } rate The multiplier relative to the original rate
-   */
-  restartPlayback(rate?: number);
-  /**
-   * 改变相对开始时间,一般发生在用户托动进度条
-   * @param start The difference relative to the absolute start time
-   */
-  goToPlayback(start: number): void;
-  /**
-   * 暂停回放
-   */
-  pausePlayback(): void;
-  /**
-   * 设置播放速率
-   * @param {number} rate 播放速率
-   */
-  setRate(rate: number);
-  /**
-   * 激活playground
-   */
-  activePlayground(): void;
-  /**
-   * 运行 playground 方法
-   */
-  runPlayground(): void;
-  /**
-   * 停止 playground 方法
-   */
-  stopPlayground(): void;
-  /**
-   * 挂载SDK内部组件
-   * @param {Component[]} components 组件配置信息
-   */
-  mapRender(components: Component[]): void;
-  /**
-   * 设置本地logger打印是否开启的方法
-   * @param {any} data 设置的值，当这个值存在就会打印logger
-   */
-  loggerEnable(data: any): void;
-  /**
-   * 切换主题
-   * @param {ThemeType} type 主题类型
-   */
-  loadTheme(type: ThemeType): void;
-  /**
-   * 打开内部指定文件
-   * @param filePath
-   */
-  openFile(filePath: string): Promise<ResultType>;
-  /**
-   * 更新全局配置
-   * @param globalConfig 全局配置
-   */
-  updateGlobalConfig(globalConfig: GlobalConfig);
-  /**
-   * 更新配置
-   * @param config 配置
-   */
-  updateConfig(config: Config);
-  /**
-   * 重新加载
-   *
-   * 默认参数 ['Editor', 'Tree']
-   * @param {ModuleType[]} components 需要刷新的组件
-   * @memberof IDaoPaaS
-   */
-  reload(components: ModuleType[] = ['Editor', 'Tree']): void;
-  /**
-   * 切换国际化语言
-   * @param {I18nLanguageType} language 语言
-   */
-  switchI18nLanguage(language: I18nLanguageType): void;
-  /**
-   * 切换国际化语言
-   * @param {Array<I18nResourcesType> | I18nLanguageType} lngOrSource -语言类型或者整体资源数组文件
-   * @param {any} resource 国际化文本资源（只有lngOrSource为语言类型需要传入）  兼容旧写法
-   *
-   * 用法:
-   * https://snyk.io/advisor/npm-package/i18next/functions/i18next.addResources
-   */
-  reloadI18nResources(
-    lngOrSource: Array<I18nResourcesType> | I18nLanguageType,
-    resource?: any,
-  ): void;
-  /**
-   * 设置文件样式
-   * @param {FileStyleType} params 参数 - paths文件路径/styles为对应class
-   *
-   * PS:
-   * paths文件路径支持minimatch所支持的模糊路径
-   */
-  setFileStyle(params: FileStyleType): void;
-}