docs: add workspace docs

liujuping · JackLian · commit 840e70e3d01a · 2022-12-26T12:15:16.000+08:00
diff --git a/docs/docs/api/model/window.md b/docs/docs/api/model/window.md
@@ -0,0 +1,23 @@
+---
+title: Window
+sidebar_position: 12
+---
+
+> **@types** [IPublicModelWindow](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/model/window.ts)<br/>
+> **@since** v1.1.0
+
+
+## 基本介绍
+
+低代码设计器窗口模型
+
+## 方法签名
+
+### importSchema(schema: IPublicTypeNodeSchema)
+当前窗口导入 schema
+
+### changeViewType(viewName: string)
+修改当前窗口视图类型
+
+### async save
+调用当前窗口视图保存钩子
diff --git a/docs/docs/api/workspace.md b/docs/docs/api/workspace.md
@@ -0,0 +1,34 @@
+---
+title: workspace - 应用级 API
+sidebar_position: 12
+---
+
+> **@types** [IPublicApiWorkspace](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/api/workspace.ts)<br/>
+> **@since** v1.1.0
+
+
+## 模块简介
+
+通过该模块可以开发应用级低代码设计器。
+
+## 变量
+
+### isActive
+
+是否启用 workspace 模式
+
+### window
+
+当前设计器窗口模型
+
+关联模型 [IPublicModelWindow](./model/window)
+
+## 方法签名
+
+### registerResourceType
+注册资源
+
+```typescript
+/** 注册资源 */
+registerResourceType(resourceName: string, resourceType: 'editor', options: IPublicResourceOptions): void;
+```
diff --git a/packages/shell/src/model/window.ts b/packages/shell/src/model/window.ts
@@ -17,7 +17,7 @@ export class Window implements IPublicModelWindow {
     this[windowSymbol].changeViewType(viewName);
   }
 
-  save() {
-    return this[windowSymbol].save();
+  async save() {
+    return await this[windowSymbol].save();
   }
 }
diff --git a/packages/types/src/shell/api/workspace.ts b/packages/types/src/shell/api/workspace.ts
@@ -1 +1,13 @@
-export interface IPublicApiWorkspace {}
+import { IPublicModelWindow } from '../model';
+import { IPublicResourceOptions } from '../type';
+
+export interface IPublicApiWorkspace {
+  /** 是否启用 workspace 模式 */
+  isActive: boolean;
+
+  /** 当前设计器窗口 */
+  window: IPublicModelWindow;
+
+  /** 注册资源 */
+  registerResourceType(resourceName: string, resourceType: 'editor', options: IPublicResourceOptions): void;
+}
diff --git a/packages/types/src/shell/model/window.ts b/packages/types/src/shell/model/window.ts
@@ -1 +1,14 @@
-export interface IPublicModelWindow {}
+import { IPublicTypeNodeSchema } from '../type';
+
+export interface IPublicModelWindow {
+  /** 当前窗口导入 schema */
+  importSchema(schema: IPublicTypeNodeSchema): void;
+
+  /** 修改当前窗口视图类型 */
+  changeViewType(viewName: string): void;
+
+  /** 调用当前窗口视图保存钩子 */
+  save(): Promise<{
+    [viewName: string]: IPublicTypeNodeSchema | any;
+  }>;
+}
diff --git a/packages/types/src/shell/type/index.ts b/packages/types/src/shell/type/index.ts
@@ -72,4 +72,5 @@ export * from './setter-config';
 export * from './tip-config';
 export * from './widget-config-area';
 export * from './hotkey-callback';
-export * from './plugin-register-options';
+export * from './plugin-register-options';
+export * from './resource-options';
diff --git a/packages/types/src/shell/type/resource-options.ts b/packages/types/src/shell/type/resource-options.ts
@@ -0,0 +1,32 @@
+export interface IPublicViewFunctions {
+  /** 视图初始化 */
+  init?: () => Promise<void>;
+  /** 资源保存时调用视图的钩子 */
+  save?: () => Promise<void>;
+}
+
+export interface IPublicEditorView {
+  /** 资源名字 */
+  viewName: string;
+  (ctx: any): IPublicViewFunctions;
+}
+
+export interface IPublicResourceOptions {
+  /** 资源名字 */
+  name: string;
+
+  /** 资源描述 */
+  description?: string;
+
+  /** 默认视图类型 */
+  defaultViewType: string;
+
+  /** 资源视图 */
+  editorViews: IPublicEditorView[];
+
+  /** save 钩子 */
+  save?: () => Promise<void>;
+
+  /** import 钩子 */
+  import?: () => Promise<void>;
+}
diff --git a/packages/workspace/src/editor-window/context.ts b/packages/workspace/src/editor-window/context.ts
@@ -26,7 +26,7 @@ export class EditorWindow {
       const saveResult = await this.editorViews.get(name)?.save();
       value[name] = saveResult;
     }
-    this.resource.save(value);
+    return await this.resource.save(value);
   }
 
   async init() {
diff --git a/packages/workspace/src/index.ts b/packages/workspace/src/index.ts
@@ -2,6 +2,7 @@ import { Editor } from '@alilc/lowcode-editor-core';
 import {
   Skeleton as InnerSkeleton,
 } from '@alilc/lowcode-editor-skeleton';
+import { IPublicResourceOptions } from '@alilc/lowcode-types';
 import { EditorWindow } from './editor-window/context';
 import { Resource } from './resource';
 
@@ -35,7 +36,7 @@ export class Workspace {
 
   private resources: Map<string, Resource> = new Map();
 
-  registerResourceType(resourceName: string, resourceType: 'editor' | 'webview', options: ResourceOptions): void {
+  registerResourceType(resourceName: string, resourceType: 'editor' | 'webview', options: IPublicResourceOptions): void {
     if (resourceType === 'editor') {
       const resource = new Resource(options);
       this.resources.set(resourceName, resource);
@@ -62,23 +63,3 @@ export class Workspace {
 
   openEditorWindow() {}
 }
-
-export interface ResourceOptions {
-  description: string;
-  defaultViewType?: string;
-  editorViews?: EditorViewOptions[];
-  init: (ctx: any) => Promise<void>;
-  dispose: (ctx: any) => Promise<void>;
-  import: (ctx: any) => Promise<any>;
-  save: (value: any) => Promise<any>;
-}
-
-export interface ViewFunctions {
-  init: () => Promise<void>;
-  save: () => Promise<void>;
-}
-
-export type EditorViewOptions = {
-  viewName: string;
-  (ctx: any): ViewFunctions;
-};

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export class Window implements IPublicModelWindow {`
`17`	`17`	`this[windowSymbol].changeViewType(viewName);`
`18`	`18`	`}`
`19`	`19`
`20`		`- save() {`
`21`		`- return this[windowSymbol].save();`
	`20`	`+ async save() {`
	`21`	`+ return await this[windowSymbol].save();`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ export class EditorWindow {`
`26`	`26`	`const saveResult = await this.editorViews.get(name)?.save();`
`27`	`27`	`value[name] = saveResult;`
`28`	`28`	`}`
`29`		`- this.resource.save(value);`
	`29`	`+ return await this.resource.save(value);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`async init() {`