@nocobase/plugin-ui-templates 2.0.0-alpha.57

package/src/locale/uk-UA.json

@@ -0,0 +1,14 @@
+{
+  "Block UID": "Block UID",
+  "Block UID is already set and cannot be modified": "Block UID is already set and cannot be modified",
+  "Copy": "Copy",
+  "Other blocks": "Other blocks",
+  "Please configure target block": "Please configure target block",
+  "Reference": "Reference",
+  "Reference block": "Reference block",
+  "Reference mode": "Reference mode",
+  "Reference settings": "Reference settings",
+  "Some configurations using uid may need to be reconfigured": "Some configurations using uid may need to be reconfigured",
+  "Target UID": "Target UID",
+  "Target block is invalid": "Target block is invalid"
+}

package/src/locale/vi-VN.json

@@ -0,0 +1,14 @@
+{
+  "Block UID": "Block UID",
+  "Block UID is already set and cannot be modified": "Block UID is already set and cannot be modified",
+  "Copy": "Copy",
+  "Other blocks": "Other blocks",
+  "Please configure target block": "Please configure target block",
+  "Reference": "Reference",
+  "Reference block": "Reference block",
+  "Reference mode": "Reference mode",
+  "Reference settings": "Reference settings",
+  "Some configurations using uid may need to be reconfigured": "Some configurations using uid may need to be reconfigured",
+  "Target UID": "Target UID",
+  "Target block is invalid": "Target block is invalid"
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,71 @@
+{
+  "UI templates": "界面模板",
+  "Block templates (v2)": "区块模板 (v2)",
+  "Popup templates (v2)": "弹窗模板 (v2)",
+  "Actions": "操作",
+  "Are you sure you want to delete this item? This action cannot be undone.": "确定要删除此项吗？此操作不可撤销。",
+  "Block UID": "区块 UID",
+  "Block UID is already set and cannot be modified": "当前已经指定区块UID，不允许修改",
+  "Block template": "区块模板",
+  "Select block template": "选择区块模板",
+  "Block templates": "区块模板",
+  "Duplicate": "复制",
+  "Delete template": "删除模板",
+  "Deleted": "已删除",
+  "Edit": "编辑",
+  "Edit template": "编辑模板",
+  "Mode": "模式",
+  "Other blocks": "其他区块",
+  "Please configure target block": "请先配置目标区块",
+  "Reference": "引用",
+  "Saved": "已保存",
+  "Search templates": "搜索模板",
+  "Some configurations using uid may need to be reconfigured": "部分使用uid的配置可能需要重新配置",
+  "Target block is invalid": "目标区块无效",
+  "Template": "模板",
+  "Cannot resolve template parameter {{param}}": "缺少 {{param}}，无法使用",
+  "Template description": "模板描述",
+  "Template name": "模板名称",
+  "Template name is required": "模板名称必填",
+  "Template settings": "模板配置",
+  "Template is in use and cannot be deleted": "当前模板正在被使用中，无法删除",
+  "Usage count": "引用数量",
+  "Using reference fields will remove existing fields": "使用引用字段会将当前已经添加的字段移除",
+  "This block already references field template, please convert fields to copy first": "当前区块已引用字段模板，请先将引用字段转换为复制",
+  "Convert reference to duplicate": "将引用转换为复制",
+  "Save as template": "保存为模板",
+  "Convert reference to duplicate is unavailable": "将引用转换为复制不可用",
+  "Are you sure to convert this template block to copy mode?": "确定将此模板区块转换为复制模式吗？",
+  "Convert reference fields to duplicate": "将引用字段转换为复制",
+  "Field template": "字段模板",
+  "Are you sure to convert referenced fields to copy mode?": "确定将引用字段转换为复制模式吗？",
+  "Template missing data source/collection info": "模板缺少数据源/数据表信息",
+  "Template collection mismatch": "数据表不匹配：当前为 \"{{expected}}\"，模板适用于 \"{{actual}}\"",
+  "Template data source mismatch": "数据源不匹配：当前为 \"{{expected}}\"，模板适用于 \"{{actual}}\"",
+  "No association": "（无）",
+  "Template association mismatch": "关联名不匹配：当前为 \"{{expected}}\"，模板适用于 \"{{actual}}\"",
+  "Popup template": "弹窗模板",
+  "Popup templates": "弹窗模板",
+  "Select popup template": "选择弹窗模板",
+  "Replace current block with reference template": "用模板引用替换当前区块",
+  "Replace current popup with reference template": "用模板引用替换当前弹窗",
+  "Are you sure to convert this pop-up to copy mode?": "确定将此弹窗转换为复制模式吗？",
+  "This pop-up is not using a popup template": "当前弹窗未使用弹窗模板",
+  "Converted": "已转换",
+  "Only Popup can be saved as popup template": "仅支持将「弹窗」保存为弹窗模板",
+  "Popup template not found": "弹窗模板不存在",
+  "Failed to duplicate pop-up": "复制弹窗失败",
+  "Failed to copy popup from template": "从弹窗模板复制失败",
+  "Template field section description": "将使用指定区块模板的字段部分",
+  "Reference mode description": "修改区块所有引用该模板的地方都会被修改。",
+  "Duplicate mode description": "基于模板生成新内容，所有 UID（包括子节点的 UID）都会重新生成。涉及跨区块的 UID 引用在复制后将不再生效。",
+  "Save mode": "保存模式",
+  "Convert current block to template": "将当前区块转为模板",
+  "Convert current block to template description": "当前区块本身会变成模板引用",
+  "Duplicate current block as template": "复制当前区块为模板",
+  "Duplicate current block as template description": "保留原区块，复制一份作为模板",
+  "Convert current popup to template": "将当前弹窗转为模板",
+  "Convert current popup to template description": "当前弹窗本身会变成模板引用",
+  "Duplicate current popup as template": "复制当前弹窗为模板",
+  "Duplicate current popup as template description": "保留原弹窗，复制一份作为模板"
+}

package/src/locale/zh-TW.json

@@ -0,0 +1,14 @@
+{
+  "Block UID": "Block UID",
+  "Block UID is already set and cannot be modified": "Block UID is already set and cannot be modified",
+  "Copy": "Copy",
+  "Other blocks": "Other blocks",
+  "Please configure target block": "Please configure target block",
+  "Reference": "Reference",
+  "Reference block": "Reference block",
+  "Reference mode": "Reference mode",
+  "Reference settings": "Reference settings",
+  "Some configurations using uid may need to be reconfigured": "Some configurations using uid may need to be reconfigured",
+  "Target UID": "Target UID",
+  "Target block is invalid": "Target block is invalid"
+}

package/src/server/__tests__/template-usage.test.ts

@@ -0,0 +1,351 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { createMockServer, MockServer } from '@nocobase/test';
+import { vi } from 'vitest';
+import FlowModelRepository from '../../../../plugin-flow-engine/src/server/repository';
+
+describe('ui templates and usages', () => {
+  let app: MockServer | null;
+  let flowRepo: FlowModelRepository;
+  let usageRepo: any;
+
+  const buildOptions = (templateUid?: string, useTemplateExtra: Record<string, any> = {}) => {
+    return {
+      use: 'ReferenceBlockModel',
+      stepParams: {
+        referenceSettings: {
+          target: {
+            targetUid: 'target-block',
+          },
+          ...(templateUid
+            ? {
+                useTemplate: {
+                  templateUid,
+                  templateName: `name-${templateUid}`,
+                  templateDescription: `desc-${templateUid}`,
+                  ...useTemplateExtra,
+                },
+              }
+            : {}),
+        },
+      },
+    };
+  };
+
+  const createReferenceBlock = async (uid: string, templateUid: string) => {
+    return await flowRepo.create({
+      values: {
+        uid,
+        options: buildOptions(templateUid),
+      },
+    });
+  };
+
+  const updateReferenceBlockOptions = (uid: string, templateUid: string) => {
+    return flowRepo.update({
+      filter: { uid },
+      values: { options: buildOptions(templateUid) },
+    });
+  };
+
+  const destroyBlock = (uid: string) => {
+    return flowRepo.destroy({
+      filter: { uid },
+    });
+  };
+
+  const getBlockOptions = async (uid: string) => {
+    const record = await flowRepo.findOne({ filter: { uid } });
+    return FlowModelRepository.optionsToJson(record?.get('options'));
+  };
+
+  const countUsage = (filter: Record<string, any>) => {
+    return usageRepo.count({ filter });
+  };
+
+  beforeEach(async () => {
+    app = await createMockServer({
+      plugins: ['flow-engine', 'ui-templates'],
+      registerActions: true,
+    });
+    expect(app.pm.get('ui-templates')).toBeTruthy();
+    flowRepo = app.db.getRepository('flowModels') as FlowModelRepository;
+    usageRepo = app.db.getRepository('flowModelTemplateUsages');
+    await flowRepo.create({ values: { uid: 'target-block', options: { use: 'TargetBlock' } } });
+    expect(app.db.listeners('flowModels.afterSaveWithAssociations').length).toBeGreaterThan(0);
+  });
+
+  afterEach(async () => {
+    vi.restoreAllMocks();
+    if (app) {
+      await app.destroy();
+      app = null;
+    }
+  });
+
+  it('should create usage and switch template updates usage records', async () => {
+    const block = await createReferenceBlock('ref-1', 'tpl-1');
+    expect(await countUsage({ templateUid: 'tpl-1', modelUid: 'ref-1' })).toBe(1);
+
+    await updateReferenceBlockOptions(block.get('uid'), 'tpl-2');
+    expect(await countUsage({ templateUid: 'tpl-1', modelUid: 'ref-1' })).toBe(0);
+    expect(await countUsage({ templateUid: 'tpl-2', modelUid: 'ref-1' })).toBe(1);
+  });
+
+  it('should remove usages when reference block is destroyed', async () => {
+    const block = await createReferenceBlock('ref-3', 'tpl-destroy');
+    expect(await countUsage({ modelUid: 'ref-3' })).toBe(1);
+    await destroyBlock(block.get('uid'));
+    expect(await countUsage({ modelUid: 'ref-3' })).toBe(0);
+  });
+
+  it('should return usageCount and block deletion guard via resources', async () => {
+    const agent = app.agent();
+    const tplResp = await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-resource',
+        name: 'Template Resource',
+        targetUid: 'target-block',
+      },
+    });
+    expect(tplResp.status).toBe(200);
+    const createdTpl = tplResp.body?.data || tplResp.body;
+    expect(createdTpl?.usageCount).toBe(0);
+
+    const block = await createReferenceBlock('ref-4', 'tpl-resource');
+    expect(block).toBeTruthy();
+    expect(await countUsage({ templateUid: 'tpl-resource', modelUid: 'ref-4' })).toBe(1);
+
+    const getResp = await agent.resource('flowModelTemplates').get({
+      filterByTk: 'tpl-resource',
+    });
+    expect(getResp.status).toBe(200);
+    const gotTpl = getResp.body?.data || getResp.body;
+    expect(gotTpl?.usageCount).toBe(1);
+
+    const destroyResp = await agent.resource('flowModelTemplates').destroy({
+      filterByTk: 'tpl-resource',
+    });
+    expect(destroyResp.status).not.toBe(200);
+    const blockedTpl = await agent.resource('flowModelTemplates').get({
+      filterByTk: 'tpl-resource',
+    });
+    const blockedTplData = blockedTpl.body?.data || blockedTpl.body;
+    expect(blockedTplData?.uid).toBe('tpl-resource');
+    expect(blockedTplData?.usageCount).toBe(1);
+
+    await destroyBlock(block.get('uid'));
+    expect(await countUsage({ templateUid: 'tpl-resource', modelUid: 'ref-4' })).toBe(0);
+
+    const destroyResp2 = await agent.resource('flowModelTemplates').destroy({
+      filterByTk: 'tpl-resource',
+    });
+    expect(destroyResp2.status).toBe(200);
+  });
+
+  it('should sync template name/description to reference blocks on template update', async () => {
+    const agent = app.agent();
+    await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-sync',
+        name: 'Template Old',
+        description: 'Desc Old',
+        targetUid: 'target-block',
+      },
+    });
+
+    await createReferenceBlock('ref-sync', 'tpl-sync');
+
+    const updateResp = await agent.resource('flowModelTemplates').update({
+      filterByTk: 'tpl-sync',
+      values: {
+        name: 'Template New',
+        description: 'Desc New',
+      },
+    });
+    expect(updateResp.status).toBe(200);
+
+    const options = await getBlockOptions('ref-sync');
+    const useTemplate = options?.stepParams?.referenceSettings?.useTemplate;
+    expect(useTemplate?.templateUid).toBe('tpl-sync');
+    expect(useTemplate?.templateName).toBe('Template New');
+    expect(useTemplate?.templateDescription).toBe('Desc New');
+  });
+
+  it('should persist associationName in flowModelTemplates', async () => {
+    const agent = app.agent();
+    const tplResp = await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-assoc',
+        name: 'Template Assoc',
+        targetUid: 'target-block',
+        dataSourceKey: 'main',
+        collectionName: 'bad',
+        associationName: 'users.roles',
+      },
+    });
+    expect(tplResp.status).toBe(200);
+    const createdTpl = tplResp.body?.data || tplResp.body;
+    expect(createdTpl?.associationName).toBe('users.roles');
+
+    const getResp = await agent.resource('flowModelTemplates').get({
+      filterByTk: 'tpl-assoc',
+    });
+    expect(getResp.status).toBe(200);
+    const gotTpl = getResp.body?.data || getResp.body;
+    expect(gotTpl?.associationName).toBe('users.roles');
+  });
+
+  it('should create usage for ReferenceFormGridModel', async () => {
+    const agent = app.agent();
+    await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-sub',
+        name: 'Template Sub',
+        targetUid: 'target-block',
+      },
+    });
+
+    await flowRepo.create({
+      values: {
+        uid: 'block-sub',
+        options: {
+          use: 'FormBlockModel',
+          stepParams: {},
+        },
+      },
+    });
+
+    await flowRepo.create({
+      values: {
+        uid: 'grid-sub',
+        options: {
+          use: 'ReferenceFormGridModel',
+          parentId: 'block-sub',
+          subKey: 'grid',
+          subType: 'object',
+          stepParams: {
+            referenceSettings: {
+              useTemplate: {
+                templateUid: 'tpl-sub',
+                templateName: 'Template Sub',
+                targetUid: 'target-block',
+                targetPath: 'subModels.grid',
+                mode: 'reference',
+              },
+            },
+          },
+        },
+      },
+    });
+
+    expect(await countUsage({ templateUid: 'tpl-sub', modelUid: 'grid-sub' })).toBe(1);
+
+    await flowRepo.update({
+      filter: { uid: 'grid-sub' },
+      values: {
+        options: {
+          use: 'ReferenceFormGridModel',
+          parentId: 'block-sub',
+          subKey: 'grid',
+          subType: 'object',
+          stepParams: {},
+        },
+      },
+    });
+
+    expect(await countUsage({ modelUid: 'grid-sub' })).toBe(0);
+  });
+
+  it('should maintain usages via flowModels:save/destroy actions', async () => {
+    const agent = app.agent();
+    await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-save',
+        name: 'Template Save',
+        targetUid: 'target-block',
+      },
+    });
+    await agent.resource('flowModelTemplates').create({
+      values: {
+        uid: 'tpl-save-2',
+        name: 'Template Save 2',
+        targetUid: 'target-block',
+      },
+    });
+
+    const saveResp = await agent.resource('flowModels').save({
+      values: {
+        uid: 'ref-save',
+        ...buildOptions('tpl-save'),
+      },
+    });
+    expect(saveResp.status).toBe(200);
+    expect(await countUsage({ templateUid: 'tpl-save', modelUid: 'ref-save' })).toBe(1);
+
+    const listResp = await agent.resource('flowModelTemplates').list();
+    expect(listResp.status).toBe(200);
+    const listData = listResp.body?.data ?? listResp.body;
+    const rows = Array.isArray(listData) ? listData : Array.isArray(listData?.rows) ? listData.rows : [];
+    const row = (rows as Array<{ uid?: string; usageCount?: number }>).find((r) => r?.uid === 'tpl-save');
+    expect(row?.usageCount).toBe(1);
+
+    const saveResp2 = await agent.resource('flowModels').save({
+      values: {
+        uid: 'ref-save',
+        ...buildOptions('tpl-save-2'),
+      },
+    });
+    expect(saveResp2.status).toBe(200);
+    expect(await countUsage({ templateUid: 'tpl-save', modelUid: 'ref-save' })).toBe(0);
+    expect(await countUsage({ templateUid: 'tpl-save-2', modelUid: 'ref-save' })).toBe(1);
+
+    // uid 省略时后端应补齐，并能正确维护 usages
+    const saveResp3 = await agent.resource('flowModels').save({
+      values: {
+        ...buildOptions('tpl-save'),
+      },
+    });
+    expect(saveResp3.status).toBe(200);
+    const createdUid = saveResp3.body?.data ?? saveResp3.body;
+    expect(typeof createdUid).toBe('string');
+    expect(await countUsage({ templateUid: 'tpl-save', modelUid: createdUid })).toBe(1);
+
+    // openView 的 step key 不一定是 "openView"，应能扫描 popupSettings 下所有 stepParams
+    const saveResp4 = await agent.resource('flowModels').save({
+      values: {
+        uid: 'popup-save',
+        use: 'PopupActionModel',
+        stepParams: {
+          popupSettings: {
+            openViewX: {
+              popupTemplateUid: 'tpl-save',
+              popupTemplateMode: 'reference',
+            },
+          },
+        },
+      },
+    });
+    expect(saveResp4.status).toBe(200);
+    expect(await countUsage({ templateUid: 'tpl-save', modelUid: 'popup-save' })).toBe(1);
+
+    const destroyResp = await agent.resource('flowModels').destroy({ filterByTk: 'ref-save' });
+    expect(destroyResp.status).toBe(200);
+    expect(await countUsage({ modelUid: 'ref-save' })).toBe(0);
+
+    const destroyResp2 = await agent.resource('flowModels').destroy({ filterByTk: createdUid });
+    expect(destroyResp2.status).toBe(200);
+    expect(await countUsage({ modelUid: createdUid })).toBe(0);
+
+    const destroyResp3 = await agent.resource('flowModels').destroy({ filterByTk: 'popup-save' });
+    expect(destroyResp3.status).toBe(200);
+    expect(await countUsage({ modelUid: 'popup-save' })).toBe(0);
+  });
+});

package/src/server/collections/flowModelTemplateUsages.ts

@@ -0,0 +1,51 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  dumpRules: 'required',
+  migrationRules: ['overwrite', 'schema-only'],
+  name: 'flowModelTemplateUsages',
+  autoGenId: false,
+  timestamps: true,
+  fields: [
+    {
+      type: 'uid',
+      name: 'uid',
+      primaryKey: true,
+    },
+    {
+      type: 'string',
+      name: 'templateUid',
+      allowNull: false,
+    },
+    {
+      type: 'string',
+      name: 'modelUid',
+      allowNull: false,
+    },
+  ],
+  indexes: [
+    {
+      fields: ['uid'],
+      unique: true,
+    },
+    {
+      fields: ['templateUid', 'modelUid'],
+      unique: true,
+    },
+    {
+      fields: ['templateUid'],
+    },
+    {
+      fields: ['modelUid'],
+    },
+  ],
+} as CollectionOptions;

package/src/server/collections/flowModelTemplates.ts

@@ -0,0 +1,76 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { CollectionOptions } from '@nocobase/database';
+
+export default {
+  dumpRules: 'required',
+  migrationRules: ['overwrite', 'schema-only'],
+  name: 'flowModelTemplates',
+  autoGenId: false,
+  timestamps: true,
+  fields: [
+    {
+      type: 'uid',
+      name: 'uid',
+      primaryKey: true,
+    },
+    {
+      type: 'string',
+      name: 'name',
+      allowNull: false,
+    },
+    {
+      type: 'text',
+      name: 'description',
+    },
+    {
+      type: 'string',
+      name: 'targetUid',
+      allowNull: false,
+    },
+    {
+      type: 'string',
+      name: 'useModel',
+    },
+    {
+      type: 'string',
+      name: 'type',
+    },
+    {
+      type: 'string',
+      name: 'dataSourceKey',
+    },
+    {
+      type: 'string',
+      name: 'collectionName',
+    },
+    {
+      type: 'string',
+      name: 'associationName',
+    },
+    {
+      type: 'string',
+      name: 'filterByTk',
+    },
+    {
+      type: 'string',
+      name: 'sourceId',
+    },
+  ],
+  indexes: [
+    {
+      fields: ['uid'],
+      unique: true,
+    },
+    {
+      fields: ['targetUid'],
+    },
+  ],
+} as CollectionOptions;

package/src/server/index.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+export { default } from './plugin';