@dao42/d42paas-front 0.7.26 → 0.7.31

package/dist/editor.d.ts

@@ -8,19 +8,30 @@
  *  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 TMode = 'tsdoc' | 'singleFile' | 'IDE';
+export type PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
 
-export type T_PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
+export type Replay = 'stop' | 'disabled' | 'pause';
 
-export type TReplay = 'stop' | 'disabled' | 'pause';
+export type DockerStatus = 'RUNNING' | 'STOP';
 
-export type T_DockerStatus = 'RUNNING' | 'STOP';
+type MessageType = {
+  PlaygroundStatus?: PlaygroundStatus;
+  dockerStatus?: DockerStatus;
+  userList?: UserInfo[];
+};
+
+type ErrorType = {
+  PlaygroundStatus?: any;
+  dockerStatus?: DockerStatus;
+  userList?: UserInfo[];
+};
 
 /**
- * JS API
+ * Userinfo type
  */
-interface TUserInfo {
+interface UserInfo {
   playgroundId?: string;
   operation?: any;
   uuid?: string;
@@ -33,15 +44,30 @@ interface TUserInfo {
   onlineCount?: number;
 }
 
+type ReplayType = {
+  userId?: UserInfo['userId'];
+  timestamp: number;
+};
+
 /**
- * the arguments of the Playground.
+ * Passing the values to init the playground.
  */
-interface TConstructor {
+export interface Options {
   debug?: boolean;
 
+  /**
+   *
+   * Error listener to the aplication.
+   * @param error
+   */
   onError?: (error: any) => void;
 
-  onMessage?: (message: any) => void;
+  /**
+   *
+   * Message listener to the aplication.
+   * @param MessageType
+   */
+  onMessage?: (message: MessageType) => void;
 
   serviceWorkerOrigin?: string;
 
@@ -50,12 +76,11 @@ interface TConstructor {
    * init the playground with the mode.
    *
    */
-
-  mode?: TMode;
+  mode?: Mode;
 
   /**
    *
-   * init the playground with the env.
+   * init the playground with the paasDomain.
    *
    */
   paasDomain: string;
@@ -118,22 +143,21 @@ interface TConstructor {
    */
 }
 
-export interface UserComponent extends TComponentArgs {
+export interface UserComponent extends ComponentArgs {
   item: string;
 }
 
 /**
  *
- * @interface TComponentArgs
+ * @interface ComponentArgs
  * @desc
  *
  */
-export interface TComponentArgs {
+export interface ComponentArgs {
   /**
    *
    * the DOM for the component.
    * @type {(string | HTMLElement | Element)}
-   * @memberof TComponentArgs
    *
    */
   container: string | HTMLElement | Element;
@@ -141,14 +165,17 @@ export interface TComponentArgs {
   props?: any;
 }
 
+/**
+ * This is the entry point for the application.
+ */
 export class DaoPaaS {
-  constructor(args: TConstructor);
+  constructor(options: Options);
 
-  get playgroundStatus(): T_PlaygroundStatus;
+  get playgroundStatus(): PlaygroundStatus;
 
-  get dockerStatus(): T_DockerStatus;
+  get dockerStatus(): DockerStatus;
 
-  get userList(): TUserInfo[];
+  get userList(): UserInfo[];
 
   /**
    *
@@ -157,7 +184,7 @@ export class DaoPaaS {
    *
    */
 
-  unFollowUser(user: any, callback: () => void): void;
+  unFollowUser(user: UserInfo, callback: () => void): void;
 
   /**
    *
@@ -165,16 +192,15 @@ export class DaoPaaS {
    * @param {followUser} args
    *
    */
-
-  followUser(user: any, callback: () => void): void;
+  followUser(user: UserInfo, callback: () => void): void;
 
   /**
    *
    * Replaying method for global calling.
-   * @param {TReplay} args
+   * @param {ReplayType} args
    *
    */
-  replay(args: { userId: TUserInfo['userId']; timestamp: string }): void;
+  replay(param: ReplayType): void;
 
   /**
    *
@@ -182,7 +208,7 @@ export class DaoPaaS {
    * @param {boolean} arg
    *
    */
-  record(arg: boolean): void;
+  record(arg?: boolean): void;
 
   /**
    *
@@ -203,7 +229,6 @@ export class DaoPaaS {
   /**
    *
    * Active the playground handler.
-   * @memberof DaoPaaS
    *
    */
   activePlayground(): void;
@@ -211,7 +236,6 @@ export class DaoPaaS {
   /**
    *
    * Run the playground handler.
-   * @memberof DaoPaaS
    *
    */
   runPlayground(): void;
@@ -219,7 +243,6 @@ export class DaoPaaS {
   /**
    *
    * Stop the playground.
-   * @memberof DaoPaaS
    *
    */
   stopPlayground(): void;
@@ -227,12 +250,12 @@ export class DaoPaaS {
   /**
    *
    * Editor component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    * CSS.Properties<string | number>
    */
   Editor(
     args:
-      | TComponentArgs
+      | ComponentArgs
       | {
           containerStyle: any;
           editorStyle: any;
@@ -243,40 +266,40 @@ export class DaoPaaS {
   /**
    *
    * Page component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    *
    */
-  Page(args: TComponentArgs): void;
+  Page(args: ComponentArgs): void;
 
   /**
    *
    * Tree component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    *
    */
-  Tree(args: TComponentArgs): void;
+  Tree(args: ComponentArgs): void;
 
   /**
    *
    * Shell component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    *
    */
-  Shell(args: TComponentArgs): void;
+  Shell(args: ComponentArgs): void;
 
   /**
    *
    * Browser component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    *
    */
-  Browser(args: TComponentArgs): void;
+  Browser(args: ComponentArgs): void;
 
   /**
    *
    * Console component.
-   * @memberof DaoPaaS
+   * @param ComponentArgs
    *
    */
-  Console(args: TComponentArgs): void;
+  Console(args: ComponentArgs): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dao42/d42paas-front",
-  "version": "0.7.26",
+  "version": "0.7.31",
   "description": "> TODO: description",
   "author": "eric183 <kk297466058@gmail.com>",
   "homepage": "https://github.com/dao42/d42paas_frontend#readme",
@@ -26,7 +26,7 @@
   "scripts": {
     "prebuild": "rimraf dist",
     "webpack": "cross-env TS_NODE_PROJECT=\"tsconfig.dev.json\" webpack --config ./config/webpack.prod.config.ts",
-    "start:web": "yarn vite && yarn workNameSpaceToFix",
+    "start:web": "yarn vite && yarn workNameSpaceToFix && yarn typedoc",
     "storybook": "start-storybook -p 6006",
     "build-storybook": "build-storybook -o .storybook/dist",
     "dev:disble": "cross-env TS_NODE_PROJECT=\"tsconfig.dev.json\" webpack serve --open --config ./config/webpack.dev.config.ts",
@@ -34,8 +34,10 @@
     "dev": "vite serve --host --config ./config/vite.config.ts",
     "dev:patch": "vite serve --host --config ./config/vite.dev.config.ts",
     "vite": "cross-env NODE_ENV=production vite build --config ./config/vite.config.ts && yarn run copyTS",
+    "typedoc": "npx typedoc --tsconfig ./doc.tsconfig.json",
     "fix": "eslint --fix --ext .jsx src/**",
     "copyTS": "shx cp ./src/types/editor.d.ts ./dist",
+    "copyMD": "shx cp ../../README.md ./dist",
     "np": "npm publish --access-public",
     "patch": "yarn vite && npm version patch && yarn clean",
     "test": "jest --verbose",
@@ -83,7 +85,6 @@
     "@types/react-dom": "^17.0.9",
     "@types/tailwindcss": "^2.2.4",
     "@types/uuid": "^8.3.1",
-    "@types/webpack": "^5.28.0",
     "@vitejs/plugin-react": "^1.0.7",
     "autoprefixer": "^10.0.2",
     "babel-core": "^6.26.3",