@dao42/d42paas-front 0.9.4 → 0.9.8

package/dist/DaoPaaS.d.ts

@@ -1,14 +1,3 @@
-/*!-----------------------------------------------------------
- * 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 interface DiffPatternInfo {
   value: string;
   type: string;
@@ -27,91 +16,8 @@ export type Components = Record<ComponentType, any>;
 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 {
-  /**
-   * The message type is use to show up the playground status.
-   */
-  playgroundStatus?: PlaygroundStatus;
-
-  /**
-   * The message type is used to show up the docker status.
-   */
-  dockerStatus?: DockerStatus;
-
-  /**
-   * The message type is used to list the users in the room
-   */
-  userList?: UserInfo[];
-
-  /**
-   * The message type is used to identify the user you following.
-   */
-  followingUser?: UserInfo;
-
-  /**
-   * The message type is used to indicate the users who following you.
-   */
-  usersFollowYou?: 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 {
-  /**
-   * The playground id show up in the user info
-   */
-  playgroundId?: string;
-
-  operation?: any;
-  uuid?: string;
-  color?: string;
-  name?: string;
-  username?: string;
-  agentUserId?: string;
-  role?: string;
-  avatar?: string;
-  onlineCount?: number;
-}
-
-// interface ReplayType {
-//   /**
-//    * The agentUserId of the user who started the replay
-//    */
-//   agentUserId?: UserInfo['agentUserId'];
-
-//   /**
-//    * The timestamp of the replay
-//    */
-//   timestamp: number;
-// }
-
 export interface TreeProps {
   /**
    * The tree Item height
@@ -347,87 +253,38 @@ export type ComponentPropsType =
   | ConsoleOrShellProps;
 
 /**
- * Passing the values to init the playground.
- * @category PaaS Options [Required]
+ *
+ * @interface Component
+ * @desc The props of the component.
+ *
  */
-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;
-
+export interface Component<T> {
   /**
    *
-   * init the playground with the mode.
+   * The DOM for the component.
+   * @type {(string | HTMLElement | Element)}
    *
    */
-  // mode?: Mode;
+  container: string | HTMLElement | Element;
 
+  item: ComponentType;
   /**
-   *
-   * init the playground with the paasDomain.
-   * @param The paas domain
-   * @optional
+   * The component props
+   * todo: fix the type of any
    */
-  paasDomain?: string;
+  props?: any;
+}
 
-  /**
-   *
-   * init the playground ticket needed.
-   *
-   */
+/**
+ * Passing the values to init the playground.
+ * @category PaaS Options [Required]
+ */
+export interface PaaSOptions {
   ticket: string;
-
-  /**
-   *
-   * agentUserId for the playground.
-   *
-   */
-  // agentUserId: string;
-
-  /**
-   *
-   * tenantId for the playground.
-   *
-   */
   tenantId: string;
-
-  /**
-   * userInfo for the playground.
-   */
-  userInfo: {
-    username: string;
-    avatarUrl?: string;
-  };
-
-  /**
-   *
-   * this argument is to ingnore replaying patterns.
-   *
-   */
-  ignoreReplayers?: string[];
+  userInfo: UserInfo;
+  // 可选, 默认连接到 www.1024paas.com
+  paasDomain?: string;
 
   /**
    *
@@ -439,33 +296,20 @@ export interface Options {
   components?: Component<ComponentPropsType>[];
 
   /**
-   * @deprecated to fix the issue of the playground.
    *
-   * render?: () => TComponent[]; keyof Dao_FrontType.CRDT[]
+   * Message listener to the application.
+   * @param Message
+   * @event
    */
-}
+  onMessage?: (message: Message) => void;
 
-/**
- *
- * @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
-   * todo: fix the type of any
+   * Error listener to the application.
+   * @param The error message block
+   * @event
    */
-  props?: any;
+  onError?: (error: Message) => void;
 }
 
 /**
@@ -481,15 +325,7 @@ export interface Component<T> {
  *
  * See {@link Options} for more details.
  */
-export class DaoPaaS {
-  constructor(options: Options);
-
-  get playgroundStatus(): PlaygroundStatus;
-
-  get dockerStatus(): DockerStatus;
-
-  get userList(): UserInfo[];
-
+export interface IDaoPaaS {
   /**
    *
    * Error listener to the application.
@@ -512,7 +348,7 @@ export class DaoPaaS {
    * @param {unFollowUser} args
    *
    */
-  dispose(): Promise<string>;
+  dispose(): void;
 
   /**
    *
@@ -537,7 +373,7 @@ export class DaoPaaS {
    * @param {DiffPatternInfo} args
    *
    */
-  setDiff(current: DiffPatternInfo, next: DiffPatternInfo): void;
+  // setDiff(current: DiffPatternInfo, next: DiffPatternInfo): void;
 
   /**
    *
@@ -545,14 +381,14 @@ export class DaoPaaS {
    *
    */
 
-  replayAll(): void;
+  // replayAll(): void;
   /**
    *
    * Replaying method for global calling.
    * @param {ReplayType} args
    *
    */
-  replay(agentUserId: Pick<UserInfo, 'agentUserId'>): void;
+  // replay(agentUserId: Pick<UserInfo, 'agentUserId'>): void;
 
   /**
    *
@@ -560,23 +396,7 @@ export class DaoPaaS {
    * @param {boolean} arg
    *
    */
-  record(arg?: boolean): void;
-
-  /**
-   *
-   * async method to set Replayers.
-   * @param {keyof Dao_FrontType.CRDT[]} arg
-   *
-   */
-  setReplayers(arg: string[]): void;
-
-  /**
-   *
-   * Here you can switch language services by calling this method.
-   * @param {boolean} arg
-   *
-   */
-  switchLspServer(arg: boolean): void;
+  // record(arg?: boolean): void;
 
   /**
    *
@@ -614,7 +434,7 @@ export class DaoPaaS {
    *
    *
    */
-  Editor(args: Omit<Component<EditorProps>, 'item'>): void;
+  // Editor(args: Omit<Component<EditorProps>, 'item'>): void;
 
   /**
    *
@@ -624,7 +444,7 @@ export class DaoPaaS {
    * @param Component
    *
    */
-  Page(args: Omit<Component<TreeProps>, 'item'>): void;
+  // Page(args: Omit<Component<TreeProps>, 'item'>): void;
 
   /**
    *
@@ -643,7 +463,7 @@ export class DaoPaaS {
    * @param Component
    *
    */
-  Tree(args: Omit<Component<TreeProps>, 'item'>): void;
+  // Tree(args: Omit<Component<TreeProps>, 'item'>): void;
 
   /**
    *
@@ -663,7 +483,7 @@ export class DaoPaaS {
    * @param Component
    *
    */
-  Shell(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
+  // Shell(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
 
   /**
    *
@@ -682,7 +502,7 @@ export class DaoPaaS {
    * @param Component
    *
    */
-  Browser(args: Omit<Component<BrowserProps>, 'item'>): void;
+  // Browser(args: Omit<Component<BrowserProps>, 'item'>): void;
 
   /**
    *
@@ -702,7 +522,7 @@ export class DaoPaaS {
    * @param Component
    *
    */
-  Console(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
+  // Console(args: Omit<Component<ConsoleOrShellProps>, 'item'>): void;
 
   mapRender(components: Component<ComponentType>[]): void;
 }