Merge branch 'main' into feat-zip-publisher-support-browser

.github/workflows/publish docs.yml

@@ -0,0 +1,53 @@
+name: Update and Publish Docs
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - 'docs/docs/**'
+  workflow_dispatch:
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          ref: 'develop'
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+      - run: cd docs && npm install
+      - run: |
+          cd docs
+          npm version patch
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+          git add package.json
+          git commit -m "chore(docs): publish documentation"
+          git push
+      - run: cd docs && npm run build && npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Get version
+        id: get_version
+        run: echo "::set-output name=version::$(node -p "require('./docs/package.json').version")"
+
+  comment-pr:
+    needs: publish-docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment on PR
+        if: github.event_name == 'pull_request' && github.event.action == 'closed' && github.event.pull_request.merged == true
+        uses: actions/github-script@v4
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            github.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: '🚀 New version has been released: ' + '${{ needs.publish-docs.outputs.version }}'
+            })

.github/workflows/publish engine beta.yml

@@ -0,0 +1,30 @@
+name: Publish Engine Beta
+
+on:
+  push:
+    branches:
+      - 'release/[0-9]+.[0-9]+.[0-9]+-beta'
+    paths:
+      - 'packages/**'
+
+jobs:
+  publish-engine:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install && npm run setup
+      - run: |
+          npm run build
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+      - run: npm run pub:prerelease
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Get version
+        id: get_version
+        run: echo "::set-output name=version::$(node -p "require('./package.json').version")"

.github/workflows/publish engine.yml

@@ -0,0 +1,29 @@
+name: Publish Engine
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-engine:
+    runs-on: ubuntu-latest
+    if: >-
+      contains(github.ref, 'refs/heads/release/') &&
+      (github.actor == 'JackLian' || github.actor == 'liujuping')
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install && npm run setup
+      - run: |
+          npm run build
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+      - run: npm run pub
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Get version
+        id: get_version
+        run: echo "::set-output name=version::$(node -p "require('./package.json').version")"

docs/docs/api/material.md

@@ -116,6 +116,21 @@ material.setAssets(assets1);
 material.loadIncrementalAssets(assets2);
 ```
 
+更新特定物料的描述文件
+
+```typescript
+import { material } from '@alilc/lowcode-engine';
+material.loadIncrementalAssets({
+  version: '',
+  components: [
+      {
+          "componentName": 'Button',
+          "props": [{ name: 'new', title: 'new', propType: 'string' }]
+      }
+  ],
+})
+```
+
 ### 设计器辅助层
 #### addBuiltinComponentAction
 在设计器辅助层增加一个扩展 action

docs/docs/api/skeleton.md

@@ -69,6 +69,7 @@ skeleton.add({
   props: {
     align: "left",
     icon: "wenjian",
+    title: '标题', // 图标下方展示的标题
     description: "JS 面板",
   },
   panelProps: {
@@ -295,6 +296,85 @@ showArea(areaName: string): void;
  */
 hideArea(areaName: string): void;
 ```
+
+### getAreaItems
+
+获取某个区域下的所有面板实例
+
+```typescript
+/**
+  * 获取某个区域下的所有面板实例
+  * @param areaName IPublicTypeWidgetConfigArea
+  */
+getAreaItems(areaName: IPublicTypeWidgetConfigArea): IPublicModelSkeletonItem[] | undefined;
+```
+
+相关类型：[IPublicModelSkeletonItem](https://github.com/alibaba/lowcode-engine/blob/main/packages/shell/src/model/skeleton-item.ts)
+
+
+
+### registerConfigTransducer
+
+注册一个面板的配置转换器（transducer）。
+
+```typescript
+/**
+ * 注册一个面板的配置转换器（transducer）。
+ * Registers a configuration transducer for a panel.
+ * @param {IPublicTypeConfigTransducer} transducer 
+ *   - 要注册的转换器函数。该函数接受一个配置对象（类型为 IPublicTypeSkeletonConfig）作为输入，并返回修改后的配置对象。
+ *   - The transducer function to be registered. This function takes a configuration object 
+ * 
+ * @param {number} level 
+ *   - 转换器的优先级。优先级较高的转换器会先执行。
+ *   - The priority level of the transducer. Transducers with higher priority levels are executed first.
+ * 
+ * @param {string} [id] 
+ *   - （可选）转换器的唯一标识符。用于在需要时引用或操作特定的转换器。
+ *   - (Optional) A unique identifier for the transducer. Used for referencing or manipulating a specific transducer when needed.
+ */
+registerConfigTransducer(transducer: IPublicTypeConfigTransducer, level: number, id?: string): void;
+```
+
+使用示例
+
+```typescript
+import { IPublicModelPluginContext, IPublicTypeSkeletonConfig } from '@alilc/lowcode-types';
+
+function updatePanelWidth(config: IPublicTypeSkeletonConfig) {
+  if (config.type === 'PanelDock') {
+    return {
+      ...config,
+      panelProps: {
+        ...(config.panelProps || {}),
+        width: 240,
+      },
+    }
+  }
+
+  return config;
+}
+
+const controlPanelWidthPlugin = (ctx: IPublicModelPluginContext) => {
+  const { skeleton } = ctx;
+  (skeleton as any).registerConfigTransducer?.(updatePanelWidth, 1, 'update-panel-width');
+
+  return {
+    init() {},
+  };
+};
+
+controlPanelWidthPlugin.pluginName = 'controlPanelWidthPlugin';
+controlPanelWidthPlugin.meta = {
+  dependencies: [],
+  engines: {
+    lowcodeEngine: '^1.2.3', // 插件需要配合 ^1.0.0 的引擎才可运行
+  },
+};
+
+export default controlPanelWidthPlugin;
+```
+
 ## 事件
 ### onShowPanel
 
@@ -307,7 +387,7 @@ hideArea(areaName: string): void;
  * @param listener
  * @returns
  */
-onShowPanel(listener: (...args: any[]) => void): IPublicTypeDisposable;
+onShowPanel(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
 ```
 
 相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
@@ -323,11 +403,38 @@ onShowPanel(listener: (...args: any[]) => void): IPublicTypeDisposable;
  * @param listener
  * @returns
  */
-onHidePanel(listener: (...args: any[]) => void): IPublicTypeDisposable;
+onHidePanel(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
+```
+
+相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
+
+### onDisableWidget
+
+监听 Widget 实例 Disable 事件
+
+```typescript
+/**
+ * 监听 Widget 实例 Disable 事件
+ * @param listener
+ */
+onDisableWidget(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
 ```
 
 相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
 
+### onEnableWidget
+
+监听 Widget 实例 Enable 事件
+
+```typescript
+/**
+ * 监听 Widget 实例 Enable 事件
+ * @param listener
+ */
+onEnableWidget(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
+```
+
+相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
 
 ### onShowWidget
 
@@ -340,7 +447,7 @@ onHidePanel(listener: (...args: any[]) => void): IPublicTypeDisposable;
  * @param listener
  * @returns
  */
-onShowWidget(listener: (...args: any[]) => void): IPublicTypeDisposable;
+onShowWidget(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
 ```
 
 相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)
@@ -356,7 +463,7 @@ onShowWidget(listener: (...args: any[]) => void): IPublicTypeDisposable;
  * @param listener
  * @returns
  */
-onHideWidget(listener: (...args: any[]) => void): IPublicTypeDisposable;
+onHideWidget(listener: (paneName?: string, panel?: IPublicModelSkeletonItem) => void): IPublicTypeDisposable;
 ```
 
 相关类型：[IPublicTypeDisposable](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/disposable.ts)

docs/docs/api/workspace.md

@@ -87,7 +87,7 @@ registerResourceType(resourceTypeModel: IPublicTypeResourceType): void;
 setResourceList(resourceList: IPublicResourceList) {}
 ```
 
-相关类型：[IPublicResourceOptions](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/resource-options.ts)
+相关类型：[IPublicResourceData](https://github.com/alibaba/lowcode-engine/blob/main/packages/types/src/shell/type/resource-list.ts)
 
 ### openEditorWindow
 

docs/docs/article/index.md

@@ -6,6 +6,7 @@
 - [2022/12/21 低代码多分支协同开发的建设与实践](https://mp.weixin.qq.com/s/DmwxL67htHfTUP1U966N-Q)
 - [2022/11/24 低代码引擎半岁啦，来跟大家唠唠嗑...](https://segmentfault.com/a/1190000042884409)
 - [2022/10/27 低代码技术在研发团队的应用模式探讨](https://mp.weixin.qq.com/s/Ynk_wjJbmNw7fEG6UtGZbQ)
+- [2022/08/23 基于 LowCodeEngine 的调试能力建设与实践](https://mp.weixin.qq.com/s/H8KvEOylmzLPgIuuBO0S9w)
 - [2022/06/23 低代码渲染那些事](https://mp.weixin.qq.com/s/yqYey76qLGYPfDtpGkVFfA)
 - [2022/06/16 关于 LowCode&ProCode 混合研发的思考](https://mp.weixin.qq.com/s/TY3VXjkSmsQoT47xma3wig)
 - [2022/04/07 磁贴布局在钉钉宜搭报表设计引擎中的实现](https://mp.weixin.qq.com/s/PSTut5ahAB8nlJ9kBpBaxw)

docs/docs/faq/faq023.md

@@ -0,0 +1,31 @@
+---
+title: Slot组件渲染报错问题
+sidebar_position: 23
+tags: [FAQ]
+---
+
+## 问题描述
+在低代码引擎的页面渲染过程中，可能会遇到一个关于Slot组件的报错，提示“Slot找不到”。实际上，在渲染态时不应使用Slot组件。
+
+## 问题原因
+低代码引擎渲染分为两个状态：设计态和渲染态。
+- **设计态**：为了帮助插槽进行可视化设计，引入了Slot组件。
+- **渲染态**：在此状态下，不需要使用Slot组件。
+
+这个问题通常是因为在渲染态错误地使用了设计态的schema。
+
+## 解决方案
+1. **区分设计态和渲染态**：通过`project.exportSchema(TransformStage.Save)`的参数来区分。
+   - `TransformStage.Save`代表渲染态的schema，其中不包含Slot组件。
+   - 【默认值】`TransformStage.Render`代表设计态的schema，其中包含Slot组件。
+2. **使用正确的API和参数**：确保在渲染态使用正确的schema，避免引用设计态的Slot组件。
+3. **处理脏数据问题**：如果问题是由脏数据导致，清除数据并重新拖拽组件以恢复正常。
+
+## 注意事项
+- 确保在代码和配置中正确区分设计态和渲染态。
+- 如果遇到持续的问题，检查是否有脏数据或配置错误，并进行相应的清理和调整。
+
+## 相关链接
+- Issue链接：[Issue #1798](https://github.com/alibaba/lowcode-engine/issues/1798)
+
+---