@blueking/bk-weweb 0.0.2-5.beta.1 → 0.0.2-5.beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueking/bk-weweb",
-  "version": "0.0.25.beta.1",
+  "version": "0.0.25.beta.2",
   "description": "bk micro frontend web",
   "private": false,
   "main": "dist/index.esm.js",
@@ -58,6 +58,7 @@
     "@types/node": "^20.10.3",
     "@typescript-eslint/eslint-plugin": "^6.13.2",
     "@typescript-eslint/parser": "^6.13.2",
+    "chalk": "^5.3.0",
     "cross-env": "^7.0.3",
     "eslint": "^8.55.0",
     "eslint-config-prettier": "^9.1.0",

package/typings/base-app/collect-source.d.ts

@@ -1 +1,4 @@
+/**
+ * 收集主应用的资源
+ */
 export declare function collectBaseSource(): void;

package/typings/base-app/element.d.ts

@@ -1,2 +1,15 @@
+/**
+ * @param parent 父节点
+ * @param newChild 新节点
+ * @param passiveChild 被动节点
+ * @param rawMethod 原始方法
+ * @returns 返回原始方法的执行结果
+ */
 export declare function baseElementInertHandle(parent: Node, newChild: Node, passiveChild: Node | null, rawMethod: Function): any;
+/**
+ * @param parent 父节点
+ * @param newChild 新节点
+ * @param rawMethod 原始方法
+ * @returns 返回原始方法的执行结果
+ */
 export declare function baseElementAppendHandle(parent: Node, newChild: Node, rawMethod: Function): any;

package/typings/common/state.d.ts

@@ -1,11 +1,11 @@
 export declare enum AppState {
-    ACTIVATED = "ACTIVATED",
-    DEACTIVATED = "DEACTIVATED",
-    ERROR = "ERROR",
-    LOADED = "LOADED",
-    LOADING = "LOADING",
-    MOUNTED = "MOUNTED",
-    MOUNTING = "MOUNTING",
-    UNMOUNT = "UNMOUNT",
+    ACTIVATED = "ACTIVATED",// 激活
+    DEACTIVATED = "DEACTIVATED",// 未激活
+    ERROR = "ERROR",// Error
+    LOADED = "LOADED",// 加载完成
+    LOADING = "LOADING",// 加载中
+    MOUNTED = "MOUNTED",// 挂载完成
+    MOUNTING = "MOUNTING",// 挂载中
+    UNMOUNT = "UNMOUNT",// 卸载
     UNSET = "UNSET"
 }

package/typings/component/web-compnent.d.ts

@@ -1,14 +1,14 @@
 import { IAppModleProps, IJsModelProps } from '../typings';
 export declare enum WewebCustomAttrs {
-    data = "data",
-    id = "id",
-    keepAlive = "keepAlive",
-    mode = "mode",
-    scopeCss = "scopeCss",
-    scopeJs = "scopeJs",
-    scopeLocation = "scopeLocation",
-    setShodowDom = "setShodowDom",
-    showSourceCode = "showSourceCode",
+    data = "data",// 传递给子应用的数据
+    id = "id",// 应用id
+    keepAlive = "keepAlive",// 是否缓存
+    mode = "mode",// 模式
+    scopeCss = "scopeCss",// 是否开启css隔离
+    scopeJs = "scopeJs",// 是否开启js隔离
+    scopeLocation = "scopeLocation",// 是否开启location隔离
+    setShodowDom = "setShodowDom",// 是否开启shadowDom
+    showSourceCode = "showSourceCode",// 是否显示源码
     url = "url"
 }
 export default class BkWewebElement extends HTMLElement {

package/typings/entry/script.d.ts

@@ -10,6 +10,11 @@ export declare class Script {
     scoped: boolean;
     url: string | undefined;
     constructor({ async, code, defer, fromHtml, initial, isModule, url }: IScriptOption);
+    /**
+     * @param app 应用
+     * @param needRelaceScriptElement 是否需要替换script标签
+     * @returns 返回执行后的script标签或注释
+     */
     excuteCode(app: BaseModel, needRelaceScriptElement?: boolean): Promise<Comment | HTMLScriptElement | undefined>;
     executeMemoryScript(app: BaseModel, scopedCode: string): void;
     executeSourceScript(scriptElement: HTMLScriptElement, scopedCode: string): void;

package/typings/entry/style.d.ts

@@ -9,8 +9,17 @@ export declare class Style {
     scopedCode: string;
     url: string | undefined;
     constructor({ code, fromHtml, initial, prefetch, preload, url }: IStyleOption);
+    /**
+     * @param templateStyle 模板样式
+     * @param styleElement 样式node
+     * @param app 应用实例
+     */
     commonScoped(templateStyle: HTMLStyleElement, styleElement: HTMLStyleElement, app: BaseModel): void;
     createStyleElement(): HTMLStyleElement;
+    /**
+     * @param app 应用实例
+     * @returns 返回执行后的style标签
+     */
     excuteCode(app: BaseModel): Promise<HTMLStyleElement>;
     getCode(app?: BaseModel): Promise<string>;
     linkedBaseStyle(styleElement: HTMLStyleElement, app: BaseModel): boolean;

package/typings/mode/instance.d.ts

@@ -26,7 +26,7 @@ export declare class MicroInstanceModel implements BaseModel {
     onMount(): void;
     registerRunningApp(): void;
     start(): Promise<void>;
+    unmount(needDestroy?: boolean): void;
     set status(v: AppState);
     get status(): AppState;
-    unmount(needDestroy?: boolean): void;
 }