@dao42/d42paas-front 0.7.31 → 0.7.34

package/dist/README.md

@@ -0,0 +1,47 @@
+
+# PaaS SDK
+<!-- ## 使用示例 -->
+## Install
+
+```sh
+npm install @dao42/d42paas-front@latest
+```
+## Usage
+```js
+
+import DaoPaaS from '@dao42/d42paas-front';
+
+let options = {
+  debug: true,
+  playgroundId: '364948495318253568',
+  tenantId: '1',
+  ticket: 'MXwzNjQ5NDg0OTUzMTgyNTM1Njh8MXxudWxsfDE4OTU2NTMzODMwMDA=',
+  userId: '1',
+  serviceWorkerOrigin: 'https://develop.1024paas.com',
+  components: [
+    {
+      container: '.Tree',
+      item: 'Tree',
+    },
+    {
+      container: '.Editor',
+      item: 'Editor',
+    },
+    {
+      container: '.Shell',
+      item: 'Shell',
+    },
+  ],
+  onMessage: (message) => {},
+  onError: (error) => {},
+};
+
+let Dao = new DaoPaaS(options);
+
+```
+
+## JS API
+
+### DaoPaaS(options)
+
+If a string is provided, it is treated as a shortcut for [`options`](https://develop.1024paas.com/tsdoc/interfaces/Options.html).

package/dist/editor.d.ts

@@ -1,305 +1,305 @@
-/*!-----------------------------------------------------------
- * 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 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[];
-};
-
-type ErrorType = {
-  PlaygroundStatus?: any;
-  dockerStatus?: DockerStatus;
-  userList?: UserInfo[];
-};
-
-/**
- * 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;
-};
-
-/**
- * Passing the values to init the playground.
- */
-export interface Options {
-  debug?: boolean;
-
-  /**
-   *
-   * Error listener to the aplication.
-   * @param error
-   */
-  onError?: (error: any) => 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: string;
-}
-
-/**
- *
- * @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: () => void): void;
-
-  /**
-   *
-   * Replaying method for global calling.
-   * @param {followUser} args
-   *
-   */
-  followUser(user: UserInfo, callback: () => 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
-      | {
-          containerStyle: any;
-          editorStyle: any;
-          menuStyle: any;
-        },
-  ): void;
-
-  /**
-   *
-   * Page component.
-   * @param ComponentArgs
-   *
-   */
-  Page(args: ComponentArgs): void;
-
-  /**
-   *
-   * Tree component.
-   * @param ComponentArgs
-   *
-   */
-  Tree(args: ComponentArgs): void;
-
-  /**
-   *
-   * Shell component.
-   * @param ComponentArgs
-   *
-   */
-  Shell(args: ComponentArgs): void;
-
-  /**
-   *
-   * Browser component.
-   * @param ComponentArgs
-   *
-   */
-  Browser(args: ComponentArgs): void;
-
-  /**
-   *
-   * Console component.
-   * @param ComponentArgs
-   *
-   */
-  Console(args: ComponentArgs): void;
-}
+/*!-----------------------------------------------------------
+ * 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 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[];
+};
+
+type ErrorType = {
+  PlaygroundStatus?: any;
+  dockerStatus?: DockerStatus;
+  userList?: UserInfo[];
+};
+
+/**
+ * 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;
+};
+
+/**
+ * Passing the values to init the playground.
+ */
+export interface Options {
+  debug?: boolean;
+
+  /**
+   *
+   * Error listener to the aplication.
+   * @param error
+   */
+  onError?: (error: any) => 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: string;
+}
+
+/**
+ *
+ * @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
+      | {
+          containerStyle: any;
+          editorStyle: any;
+          menuStyle: any;
+        },
+  ): void;
+
+  /**
+   *
+   * Page component.
+   * @param ComponentArgs
+   *
+   */
+  Page(args: ComponentArgs): void;
+
+  /**
+   *
+   * Tree component.
+   * @param ComponentArgs
+   *
+   */
+  Tree(args: ComponentArgs): void;
+
+  /**
+   *
+   * Shell component.
+   * @param ComponentArgs
+   *
+   */
+  Shell(args: ComponentArgs): void;
+
+  /**
+   *
+   * Browser component.
+   * @param ComponentArgs
+   *
+   */
+  Browser(args: ComponentArgs): void;
+
+  /**
+   *
+   * Console component.
+   * @param ComponentArgs
+   *
+   */
+  Console(args: ComponentArgs): void;
+}