feat: optimize ts definition

liujuping · JackLian · commit 88961aa6409c · 2023-03-08T18:26:35.000+08:00
diff --git a/packages/designer/src/document/document-model.ts b/packages/designer/src/document/document-model.ts
@@ -326,7 +326,7 @@ export class DocumentModel implements IDocumentModel {
     };
   }
 
-  onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions) => void): IPublicTypeDisposable {
+  onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions<INode>) => void): IPublicTypeDisposable {
     this.designer.editor?.eventBus.on(EDITOR_EVENT.NODE_VISIBLE_CHANGE, fn);
 
     return () => {
diff --git a/packages/designer/src/document/node/modal-nodes-manager.ts b/packages/designer/src/document/node/modal-nodes-manager.ts
@@ -83,7 +83,7 @@ export class ModalNodesManager implements IModalNodesManager {
   }
 
   private addNode(node: INode) {
-    if (node.componentMeta.isModal) {
+    if (node?.componentMeta.isModal) {
       this.hideModalNodes();
       this.modalNodes.push(node);
       this.addNodeEvent(node);
diff --git a/packages/engine/src/engine-core.ts b/packages/engine/src/engine-core.ts
@@ -119,6 +119,7 @@ const pluginContextApiAssembler: ILowCodePluginContextApiAssembler = {
     context.canvas = canvas;
     context.plugins = plugins;
     context.logger = new Logger({ level: 'warn', bizName: `plugin:${pluginName}` });
+    context.workspace = workspace;
   },
 };
 
diff --git a/packages/shell/src/model/resource.ts b/packages/shell/src/model/resource.ts
@@ -37,7 +37,7 @@ export class Resource implements IPublicModelResource {
     return this[resourceSymbol].children.map((child) => new Resource(child));
   }
 
-  get viewType() {
-    return this[resourceSymbol].viewType;
+  get viewName() {
+    return this[resourceSymbol].viewName;
   }
 }
diff --git a/packages/types/src/shell/model/document-model.ts b/packages/types/src/shell/model/document-model.ts
@@ -179,13 +179,13 @@ export interface IPublicModelDocumentModel<
    * 当前 document 的节点 children 变更事件
    * @param fn
    */
-  onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions) => void): IPublicTypeDisposable;
+  onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions<Node>) => void): IPublicTypeDisposable;
 
   /**
    * 当前 document 节点属性修改事件
    * @param fn
    */
-  onChangeNodeProp(fn: (info: IPublicTypePropChangeOptions) => void): IPublicTypeDisposable;
+  onChangeNodeProp(fn: (info: IPublicTypePropChangeOptions<Node>) => void): IPublicTypeDisposable;
 
   /**
    * import schema event
diff --git a/packages/types/src/shell/model/resource.ts b/packages/types/src/shell/model/resource.ts
@@ -5,11 +5,15 @@ export interface IPublicModelResource {
 
   get icon(): ReactElement | undefined;
 
-  get options(): Object;
+  get options(): Record<string, any>;
 
   get name(): string | undefined;
 
   get type(): string | undefined;
 
   get category(): string | undefined;
+
+  get children(): IPublicModelResource[];
+
+  get viewName(): string | undefined;
 }
diff --git a/packages/types/src/shell/type/on-change-options.ts b/packages/types/src/shell/type/on-change-options.ts
@@ -1,6 +1,8 @@
 import { IPublicModelNode } from '..';
 
-export interface IPublicTypeOnChangeOptions {
+export interface IPublicTypeOnChangeOptions<
+  Node = IPublicModelNode
+> {
   type: string;
-  node: IPublicModelNode;
+  node: Node;
 }
diff --git a/packages/types/src/shell/type/prop-change-options.ts b/packages/types/src/shell/type/prop-change-options.ts
@@ -3,10 +3,12 @@ import {
   IPublicModelProp,
 } from '../model';
 
-export interface IPublicTypePropChangeOptions {
+export interface IPublicTypePropChangeOptions<
+  Node = IPublicModelNode
+> {
   key?: string | number;
   prop?: IPublicModelProp;
-  node: IPublicModelNode;
+  node: Node;
   newValue: any;
   oldValue: any;
 }
diff --git a/packages/types/src/shell/type/resource-list.ts b/packages/types/src/shell/type/resource-list.ts
@@ -1,14 +1,21 @@
 import { ReactElement } from 'react';
 
 export interface IPublicResourceData {
+  /** 资源名字 */
   resourceName: string;
+  /** 资源标题 */
   title: string;
+  /** 分类 */
   category?: string;
-  viewType?: string;
+  /** 资源视图 */
+  viewName?: string;
+  /** 资源 icon */
   icon?: ReactElement;
+  /** 资源其他配置 */
   options: {
     [key: string]: any;
   };
+  /** 资源子元素 */
   children?: IPublicResourceData[];
 }
 
diff --git a/packages/workspace/src/resource.ts b/packages/workspace/src/resource.ts
@@ -17,8 +17,8 @@ export class Resource implements IPublicModelResource {
     return this.resourceType.name;
   }
 
-  get viewType() {
-    return this.resourceData.viewType;
+  get viewName() {
+    return this.resourceData.viewName || (this.resourceData as any).viewType;
   }
 
   get description() {

Original file line number	Diff line number	Diff line change
`@@ -326,7 +326,7 @@ export class DocumentModel implements IDocumentModel {`
`326`	`326`	`};`
`327`	`327`	`}`
`328`	`328`
`329`		`- onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions) => void): IPublicTypeDisposable {`
	`329`	`+ onChangeNodeChildren(fn: (info: IPublicTypeOnChangeOptions<INode>) => void): IPublicTypeDisposable {`
`330`	`330`	`this.designer.editor?.eventBus.on(EDITOR_EVENT.NODE_VISIBLE_CHANGE, fn);`
`331`	`331`
`332`	`332`	`return () => {`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ export class ModalNodesManager implements IModalNodesManager {`
`83`	`83`	`}`
`84`	`84`
`85`	`85`	`private addNode(node: INode) {`
`86`		`- if (node.componentMeta.isModal) {`
	`86`	`+ if (node?.componentMeta.isModal) {`
`87`	`87`	`this.hideModalNodes();`
`88`	`88`	`this.modalNodes.push(node);`
`89`	`89`	`this.addNodeEvent(node);`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ export class Resource implements IPublicModelResource {`
`37`	`37`	`return this[resourceSymbol].children.map((child) => new Resource(child));`
`38`	`38`	`}`
`39`	`39`
`40`		`- get viewType() {`
`41`		`- return this[resourceSymbol].viewType;`
	`40`	`+ get viewName() {`
	`41`	`+ return this[resourceSymbol].viewName;`
`42`	`42`	`}`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,8 @@ export class Resource implements IPublicModelResource {`
`17`	`17`	`return this.resourceType.name;`
`18`	`18`	`}`
`19`	`19`
`20`		`- get viewType() {`
`21`		`- return this.resourceData.viewType;`
	`20`	`+ get viewName() {`
	`21`	`+ return this.resourceData.viewName \|\| (this.resourceData as any).viewType;`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`get description() {`