@dao42/d42paas-front 0.5.4 → 0.5.5

package/dist/editor.d.ts

@@ -1,22 +1,72 @@
-// export = DaoPaaS;
-// export as namespace DaoPaaS;
-
-// import { T_PlaygroundStatus } from "~/stores/oTStore";
+/*!-----------------------------------------------------------
+ * 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 T_PlaygroundStatus = 'EMPTY' | 'ACTIVE' | 'INACTIVE';
+export type TReplay = 'stop' | 'disabled' | 'pause';
+
+/**
+ *
+ * the arguments of the Playground
+ */
 interface TConstructor {
+  /**
+   * initing 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;
+
+  /**
+   * avatar for the playground but not necessarily
+   */
   avatar?: string;
+
+  /**
+   * avatarUrl for the playground but not necessarily
+   */
   avatarUrl?: string;
+
 }
 
-type TReplay = 'stop' | 'disabled' | 'pause';
+/**
+ *
+ * @interface TComponentArgs
+ * @desc
+ */
 
 interface TComponentArgs {
+
+  /**
+   *
+   * @type {(string | HTMLElement | Element)}
+   * @memberof TComponentArgs
+   * @desc the DOM for the component
+   */
   container: string | HTMLElement | Element;
   props?: any;
 }
@@ -30,9 +80,32 @@ export class DaoPaaS {
   record(arg: boolean): void;
   switchLspServer(arg: boolean): void;
   activePlayground(): void;
-  /* Components */
+
+  /**
+   *
+   * @memberof DaoPaaS
+   * Editor component
+   */
   Editor(args: TComponentArgs): void;
+
+  /**
+   *
+   * @memberof DaoPaaS
+   * Page component
+   */
   Page(args: TComponentArgs): void;
+
+  /**
+   *
+   * @memberof DaoPaaS
+   * Tree component
+   */
   Tree(args: TComponentArgs): void;
+
+  /**
+   *
+   * @memberof DaoPaaS
+   * Shell component
+   */
   Shell(args: TComponentArgs): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dao42/d42paas-front",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "> TODO: description",
   "author": "eric183 <kk297466058@gmail.com>",
   "homepage": "https://github.com/dao42/d42paas_frontend#readme",
@@ -31,7 +31,7 @@
     "dev": "cross-env TS_NODE_PROJECT=\"tsconfig.dev.json\" webpack serve --open --config ./config/webpack.dev.config.ts",
     "analyse": "cross-env NODE_ENV=production TS_NODE_PROJECT=\"tsconfig.json\" webpack --config ./config/webpack.analytics.config.js",
     "vite:dev": "NODE_ENV=development vite serve --host --config ./config/vite.config.ts",
-    "vite": "NODE_ENV=production vite build --config ./config/vite.config.ts && yarn run copyTS && yarn patch && yarn np",
+    "vite": "NODE_ENV=production vite build --config ./config/vite.config.ts && yarn run copyTS && yarn patch",
     "fix": "eslint --fix --ext .jsx src/**",
     "copyTS": "shx cp ./src/types/editor.d.ts ./dist",
     "np": "npm publish --access-public",