@dao42/d42paas-front 0.7.39 → 0.7.43

package/dist/editor.d.ts

@@ -1,353 +1,593 @@
-/*!-----------------------------------------------------------
- * Copyright (c) dao42. All rights reserved.
- * Type definitions for @dao42/d42paas-front
- * Released under the MIT license
- *-----------------------------------------------------------*/
-
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-
-export type componentType = 'Tree' | 'Editor' | 'Console' | 'Browser' | 'Shell';
-
-export type Mode = 'tsdoc' | 'singleFile' | 'IDE';
-
-export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
-
-export type Replay = 'stop' | 'disabled' | 'pause';
-
-export type DockerStatus = 'RUNNING' | 'STOP';
-
-type MessageType = {
-  PlaygroundStatus?: PlaygroundStatus;
-  dockerStatus?: DockerStatus;
-  userList?: UserInfo[];
-  followingUser: UserInfo;
-};
-
-type ErrorType = {
-  message: {
-    content: string;
-    playgroundId: string;
-    timestamp: number;
-  };
-};
-
-/**
- * Userinfo type
- */
-interface UserInfo {
-  playgroundId?: string;
-  operation?: any;
-  uuid?: string;
-  color?: string;
-  name?: string;
-  username?: string;
-  userId?: string;
-  role?: string;
-  avatar?: string;
-  onlineCount?: number;
-}
-
-type ReplayType = {
-  userId?: UserInfo['userId'];
-  timestamp: number;
-};
-
-type TreeProps = {
-  dropBgColor?: string;
-  dropTextColor?: string;
-  hoverBgColor?: string;
-  hoverTextColor?: string;
-  bgColor?: string;
-  fontColor?: string;
-  onClick?: (arg: { path: string; uri: string }) => void;
-};
-
-export type MenuTagProps = {
-  menuStyle?: {
-    backgroundColor?: string;
-    textColor?: string;
-    hoverBgColor?: string;
-    hoverTextColor?: string;
-    iconColor?: string;
-    hoverIconColor?: string;
-  };
-};
-
-export type EditorTheme = {
-  theme?: {
-    marginViewOverlays?: string;
-    lineNumbers?: string;
-    activeLineNumber?: string;
-  };
-};
-
-export type ShellProps = {
-  fontSize?: number;
-  fontFamily?: string;
-  lineHeight?: number;
-  cursorBlink?: boolean;
-  cursorWidth?: number;
-  cursorStyle?: string;
-  rightClickSelectsWord?: boolean;
-  theme?: {
-    background?: string;
-  };
-};
-
-export type OutputBrowserProp = {
-  url?: string;
-  showURL?: boolean;
-  freshIconColor?: string;
-  inputColor?: string;
-  openIconColor?: string;
-};
-
-/**
- * Passing the values to init the playground.
- */
-export interface Options {
-  debug?: boolean;
-
-  /**
-   *
-   * Error listener to the aplication.
-   * @param error
-   */
-  onError?: (error: ErrorType) => void;
-
-  /**
-   *
-   * Message listener to the aplication.
-   * @param MessageType
-   */
-  onMessage?: (message: MessageType) => void;
-
-  serviceWorkerOrigin?: string;
-
-  /**
-   *
-   * init the playground with the mode.
-   *
-   */
-  mode?: Mode;
-
-  /**
-   *
-   * init the playground with the paasDomain.
-   *
-   */
-  paasDomain: string;
-
-  /**
-   *
-   * init the playground ticket needed.
-   *
-   */
-  ticket: string;
-
-  /**
-   *
-   * to init the playground with this id.
-   *
-   */
-  playgroundId: string;
-
-  /**
-   *
-   * userId for the playground.
-   *
-   */
-  userId: string;
-
-  /**
-   *
-   * tenantId for the playground.
-   *
-   */
-  tenantId: string;
-
-  /**
-   *
-   * username for the playground.
-   *
-   */
-  username?: string;
-
-  /**
-   *
-   * avatarUrl for the playground but not necessarily.
-   *
-   */
-  avatarUrl?: string;
-
-  /**
-   *
-   * this argument is to ingnore replaying patterns.
-   *
-   */
-  ignoreReplayers?: string[];
-
-  components?: UserComponent[];
-
-  /**
-   * @deprecated to fix the issue of the playground.
-   *
-   * render?: () => TComponentArgs[]; keyof D42_FrontType['CRDT'][]
-   */
-}
-
-export interface UserComponent extends ComponentArgs {
-  item: componentType;
-}
-
-/**
- *
- * @interface ComponentArgs
- * @desc
- *
- */
-export interface ComponentArgs {
-  /**
-   *
-   * the DOM for the component.
-   * @type {(string | HTMLElement | Element)}
-   *
-   */
-  container: string | HTMLElement | Element;
-
-  props?: any;
-}
-
-/**
- * This is the entry point for the application.
- */
-export class DaoPaaS {
-  constructor(options: Options);
-
-  get playgroundStatus(): PlaygroundStatus;
-
-  get dockerStatus(): DockerStatus;
-
-  get userList(): UserInfo[];
-
-  /**
-   *
-   * Replaying method for global calling.
-   * @param {unFollowUser} args
-   *
-   */
-
-  unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
-
-  /**
-   *
-   * Replaying method for global calling.
-   * @param {followUser} args
-   *
-   */
-  followUser(userId: string, callback: (userInfo: UserInfo) => void): void;
-
-  /**
-   *
-   * Replaying method for global calling.
-   * @param {ReplayType} args
-   *
-   */
-  replay(param: ReplayType): void;
-
-  /**
-   *
-   * Recording method for global calling.
-   * @param {boolean} arg
-   *
-   */
-  record(arg?: boolean): void;
-
-  /**
-   *
-   * async method to set Replayers.
-   * @param {keyof D42_FrontType['CRDT'][]} arg
-   *
-   */
-  setReplayers(arg: string[]): void;
-
-  /**
-   *
-   * Here you can switch language services by calling this method.
-   * @param {boolean} arg
-   *
-   */
-  switchLspServer(arg: boolean): void;
-
-  /**
-   *
-   * Active the playground handler.
-   *
-   */
-  activePlayground(): void;
-
-  /**
-   *
-   * Run the playground handler.
-   *
-   */
-  runPlayground(): void;
-
-  /**
-   *
-   * Stop the playground.
-   *
-   */
-  stopPlayground(): void;
-
-  /**
-   *
-   * Editor component.
-   * @param ComponentArgs
-   * CSS.Properties<string | number>
-   */
-  Editor(args: ComponentArgs & MenuTagProps & EditorTheme): void;
-
-  /**
-   *
-   * Page component.
-   * @param ComponentArgs
-   *
-   */
-  Page(args: ComponentArgs): void;
-
-  /**
-   *
-   * Tree component.
-   * @param ComponentArgs
-   *
-   */
-  Tree(args: ComponentArgs & TreeProps): void;
-
-  /**
-   *
-   * Shell component.
-   * @param ComponentArgs
-   *
-   */
-  Shell(args: ComponentArgs & ShellProps): void;
-
-  /**
-   *
-   * Browser component.
-   * @param ComponentArgs
-   *
-   */
-  Browser(args: ComponentArgs & OutputBrowserProp): void;
-
-  /**
-   *
-   * Console component.
-   * @param ComponentArgs
-   *
-   */
-  Console(args: ComponentArgs & ShellProps): void;
-}
+/*!-----------------------------------------------------------
+ * Copyright (c) dao42. All rights reserved.
+ * Type definitions for @dao42/d42paas-front
+ * Released under the MIT license
+ *-----------------------------------------------------------*/
+
+import { Extend } from 'schema-utils/declarations/validate';
+
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export type ComponentType = 'Tree' | 'Editor' | 'Console' | 'Browser' | 'Shell';
+
+export type Mode = 'tsdoc' | 'singleFile' | 'IDE';
+
+export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
+
+export type DockerStatus = 'RUNNING' | 'STOP';
+
+// export type Replay = 'stop' | 'disabled' | 'pause';
+interface MessageType {
+  playgroundStatus?: PlaygroundStatus;
+  dockerStatus?: DockerStatus;
+  userList?: UserInfo[];
+  followingUser?: UserInfo;
+}
+
+interface ErrorType {
+  /**
+   * The error message block
+   */
+  message: {
+    /**
+     * The error message content
+     */
+    content: string;
+
+    /**
+     * The error playground you started
+     */
+    playgroundId: string;
+
+    /**
+     * The error timestamp
+     */
+    timestamp: number;
+  };
+}
+
+/**
+ * Userinfo type
+ */
+interface UserInfo {
+  playgroundId?: string;
+  operation?: any;
+  uuid?: string;
+  color?: string;
+  name?: string;
+  username?: string;
+  userId?: string;
+  role?: string;
+  avatar?: string;
+  onlineCount?: number;
+}
+
+// interface ReplayType {
+//   /**
+//    * The userId of the user who started the replay
+//    */
+//   userId?: UserInfo['userId'];
+
+//   /**
+//    * The timestamp of the replay
+//    */
+//   timestamp: number;
+// }
+
+interface TreeProps {
+  /**
+   * 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;
+}
+
+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;
+  };
+}
+
+interface EditorProps extends MenuTagProps {
+  /**
+   * The Theme of the editor block
+   */
+  theme?: {
+    /**
+     * The color of the margin view overlay
+     */
+    marginViewOverlays?: string;
+
+    /**
+     * The line number color
+     */
+    lineNumbers?: string;
+
+    /**
+     * The active line number color
+     */
+    activeLineNumber?: string;
+  };
+}
+
+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 BrowserProp {
+  /**
+   * 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;
+}
+
+/**
+ * The Component props type collection
+ */
+export type ComponentPropsType =
+  | EditorProps
+  | TreeProps
+  | BrowserProp
+  | ConsoleOrShellProps;
+
+/**
+ * Passing the values to init the playground.
+ * @category PaaS Options [Required]
+ */
+export interface Options {
+  /**
+   * @ignore
+   *
+   */
+  debug?: boolean;
+
+  /**
+   *
+   * Error listener to the application.
+   * @param The error message block
+   * @event
+   */
+  onError?: (error: ErrorType) => void;
+
+  /**
+   *
+   * Message listener to the application.
+   * @param MessageType
+   * @event
+   */
+  onMessage?: (message: MessageType) => void;
+
+  /**
+   * The service worker origin
+   */
+  serviceWorkerOrigin: string;
+
+  /**
+   *
+   * init the playground with the mode.
+   *
+   */
+  mode?: Mode;
+
+  /**
+   *
+   * init the playground with the paasDomain.
+   *
+   */
+  paasDomain: string;
+
+  /**
+   *
+   * init the playground ticket needed.
+   *
+   */
+  ticket: string;
+
+  /**
+   *
+   * to init the playground with this id.
+   *
+   */
+  playgroundId: string;
+
+  /**
+   *
+   * userId for the playground.
+   *
+   */
+  userId: string;
+
+  /**
+   *
+   * tenantId for the playground.
+   *
+   */
+  tenantId: string;
+
+  /**
+   *
+   * username for the playground.
+   *
+   */
+  username?: string;
+
+  /**
+   *
+   * avatarUrl for the playground but not necessarily.
+   *
+   */
+  avatarUrl?: string;
+
+  /**
+   *
+   * this argument is to ingnore replaying patterns.
+   *
+   */
+  ignoreReplayers?: string[];
+
+  /**
+   *
+   * Here you can map the components to the playground.
+   *
+   * @category ComponentsMapper
+   *
+   */
+  components?: Component<ComponentPropsType>[];
+
+  /**
+   * @deprecated to fix the issue of the playground.
+   *
+   * render?: () => TComponent[]; keyof D42_FrontType['CRDT'][]
+   */
+}
+
+/**
+ *
+ * @interface Component
+ * @desc The props of the component.
+ *
+ */
+export interface Component<T> {
+  /**
+   *
+   * The DOM for the component.
+   * @type {(string | HTMLElement | Element)}
+   *
+   */
+  container: string | HTMLElement | Element;
+
+  item: ComponentType;
+  /**
+   * The component props
+   */
+  props?: T;
+}
+
+/**
+ * * This is the entry point for the application.
+ *
+ * * like:
+ *
+ *
+ * ```ts
+    let options = {...};
+    let Dao = new DaoPaaS(options);
+```
+ *
+ * See {@link Options} for more details.
+ */
+export class DaoPaaS {
+  constructor(options: Options);
+
+  get playgroundStatus(): PlaygroundStatus;
+
+  get dockerStatus(): DockerStatus;
+
+  get userList(): UserInfo[];
+
+  /**
+   *
+   * Replaying method for global calling.
+   * @param {unFollowUser} args
+   *
+   */
+
+  unFollowUser(user: UserInfo, callback: (userInfo: UserInfo) => void): void;
+
+  /**
+   *
+   * Replaying method for global calling.
+   * @param {followUser} args
+   *
+   */
+  followUser(userId: string, callback: (userInfo: UserInfo) => void): void;
+
+  /**
+   *
+   * Replaying method for global calling.
+   * @param {ReplayType} args
+   *
+   */
+  replay(userId: Pick<UserInfo, 'userId'>): void;
+
+  /**
+   *
+   * Recording method for global calling.
+   * @param {boolean} arg
+   *
+   */
+  record(arg?: boolean): void;
+
+  /**
+   *
+   * async method to set Replayers.
+   * @param {keyof D42_FrontType['CRDT'][]} arg
+   *
+   */
+  setReplayers(arg: string[]): void;
+
+  /**
+   *
+   * Here you can switch language services by calling this method.
+   * @param {boolean} arg
+   *
+   */
+  switchLspServer(arg: boolean): void;
+
+  /**
+   *
+   * Active the playground handler.
+   *
+   */
+  activePlayground(): void;
+
+  /**
+   *
+   * Run the playground handler.
+   *
+   */
+  runPlayground(): void;
+
+  /**
+   *
+   * Stop the playground.
+   *
+   */
+  stopPlayground(): void;
+
+  /**
+   * Editor component.
+   *
+   *
+   * ```ts
+   *   Dao.Editor({
+   *     container: '#editor',
+   *     item: 'editor',
+   *     props: {...EditorProps}
+   *   });
+  ```
+   *
+   * @category Components
+   *
+   *
+   */
+  Editor(args: Component<EditorProps>): void;
+
+  /**
+   *
+   * Page component.
+   * @ignore
+   * @category Components
+   * @param Component
+   *
+   */
+  Page(args: Component<TreeProps>): void;
+
+  /**
+   *
+   * Tree component.
+   *
+   * ```ts
+   *   Dao.Tree({
+   *     container: '#tree',
+   *     item: 'tree',
+   *     props: {...TreeProps}
+   *   });
+  ```
+   *
+   *
+   * @category Components
+   * @param Component
+   *
+   */
+  Tree(args: Component<TreeProps>): void;
+
+  /**
+   *
+   * Shell component.
+   *
+   *
+   * ```ts
+   *   Dao.Shell({
+   *     container: '#shell',
+   *     item: 'shell',
+   *     props: {...ConsoleOrShellProps}
+   *   });
+  ```
+   *
+   *
+   * @category Components
+   * @param Component
+   *
+   */
+  Shell(args: Component<ConsoleOrShellProps>): void;
+
+  /**
+   *
+   * Browser component.
+   *
+   * ```ts
+   *   Dao.Browser({
+   *     container: '#browser',
+   *     item: 'browser',
+   *     props: {...BrowserProp}
+   *   });
+  ```
+   *
+   *
+   * @category Components
+   * @param Component
+   *
+   */
+  Browser(args: Component<BrowserProp>): void;
+
+  /**
+   *
+   * Console component.
+   *
+   *
+   * ```ts
+   *   Dao.Console({
+   *     container: '#console',
+   *     item: 'console',
+   *     props: {...ConsoleOrShellProps}
+   *   });
+  ```
+   *
+   *
+   * @category Components
+   * @param Component
+   *
+   */
+  Console(args: Component<ConsoleOrShellProps>): void;
+}