@nocobase/plugin-ui-templates 2.0.0-alpha.58 → 2.0.0-alpha.60

package/src/client/models/__tests__/SubModelTemplateImporterModel.test.ts

@@ -40,11 +40,6 @@ describe('SubModelTemplateImporterModel', () => {
       parentId: grid.uid,
       subKey: 'items',
       subType: 'array',
-      props: {
-        mountToParentLevel: 1,
-        defaultSourcePath: 'subModels.grid',
-        defaultMountSubKey: 'grid',
-      },
     });
     importer.setParent(grid);
 
@@ -76,8 +71,6 @@ describe('SubModelTemplateImporterModel', () => {
     expect(saved.mode).toBe('reference');
     expect(saved.targetUid).toBe('tpl-root');
     expect(saved.templateName).toBe('Template 1');
-    expect(saved.targetPath).toBe('subModels.grid');
-    expect(saved.mountSubKey).toBe('grid');
   });
 
   it('filters by expectedRootUse and disables mismatched dataSource/collection', async () => {
@@ -307,11 +300,6 @@ describe('SubModelTemplateImporterModel', () => {
       parentId: grid.uid,
       subKey: 'items',
       subType: 'array',
-      props: {
-        mountToParentLevel: 1,
-        defaultSourcePath: 'subModels.grid',
-        defaultMountSubKey: 'grid',
-      },
     });
     grid.addSubModel('items', importer);
 
@@ -342,6 +330,86 @@ describe('SubModelTemplateImporterModel', () => {
     expect(view.close).not.toHaveBeenCalled();
   });
 
+  it('prompts confirm when details grid has existing items', async () => {
+    const engine = new FlowEngine();
+
+    class DetailsBlockModel extends FlowModel {}
+    class DetailsGridModel extends FlowModel {}
+    class DummyItemModel extends FlowModel {}
+    class FormItemModel extends FlowModel {}
+    class FormCustomItemModel extends FlowModel {}
+    class FormJSFieldItemModel extends FlowModel {}
+
+    engine.registerModels({
+      DetailsBlockModel,
+      DetailsGridModel,
+      DummyItemModel,
+      FormItemModel,
+      FormCustomItemModel,
+      FormJSFieldItemModel,
+      SubModelTemplateImporterModel,
+    });
+
+    const block = engine.createModel<DetailsBlockModel>({ uid: 'host-details', use: 'DetailsBlockModel' });
+    const grid = engine.createModel<DetailsGridModel>({
+      uid: 'host-grid',
+      use: 'DetailsGridModel',
+      parentId: block.uid,
+      subKey: 'grid',
+      subType: 'object',
+    });
+    block.setSubModel('grid', grid);
+
+    const dummy = engine.createModel<DummyItemModel>({
+      uid: 'dummy-item',
+      use: 'DummyItemModel',
+      parentId: grid.uid,
+      subKey: 'items',
+      subType: 'array',
+    });
+    grid.addSubModel('items', dummy);
+
+    const importer = engine.createModel<SubModelTemplateImporterModel>({
+      uid: 'importer-1',
+      use: 'SubModelTemplateImporterModel',
+      parentId: grid.uid,
+      subKey: 'items',
+      subType: 'array',
+    });
+    grid.addSubModel('items', importer);
+
+    const flow: any = importer.getFlow('subModelTemplateImportSettings');
+    const step: any = flow?.getStep?.('selectTemplate')?.serialize?.();
+    expect(typeof step?.beforeParamsSave).toBe('function');
+
+    const viewer = {
+      dialog: vi.fn((opts: any) => {
+        // 默认模拟用户关闭弹窗 => 视为取消
+        opts?.onClose?.();
+      }),
+    };
+    const view = { close: vi.fn() };
+    const ctx: any = {
+      model: importer,
+      api: {
+        resource: () => ({
+          get: async () => ({ data: { data: { uid: 'tpl-1', name: 'Template 1', targetUid: 'tpl-root' } } }),
+        }),
+      },
+      viewer,
+      view,
+      t: (k: string) => k,
+      message: { warning: vi.fn(), error: vi.fn() },
+    };
+
+    const params: any = { templateUid: 'tpl-1', mode: 'reference' };
+    importer.setStepParams('subModelTemplateImportSettings', 'selectTemplate', params);
+    await expect(step.beforeParamsSave(ctx, params)).rejects.toBeTruthy();
+
+    expect(view.close).toHaveBeenCalled();
+    expect(viewer.dialog).toHaveBeenCalled();
+  });
+
   it('waits parent grid saveStepParams before replaceModel save', async () => {
     const engine = new FlowEngine();
 
@@ -411,11 +479,6 @@ describe('SubModelTemplateImporterModel', () => {
       parentId: grid.uid,
       subKey: 'items',
       subType: 'array',
-      props: {
-        mountToParentLevel: 1,
-        defaultSourcePath: 'subModels.grid',
-        defaultMountSubKey: 'grid',
-      },
       stepParams: {
         subModelTemplateImportSettings: {
           selectTemplate: {
@@ -423,8 +486,6 @@ describe('SubModelTemplateImporterModel', () => {
             targetUid: 'tpl-root',
             templateName: 'Template 1',
             mode: 'reference',
-            targetPath: 'subModels.grid',
-            mountSubKey: 'grid',
           },
         },
       },

package/src/client/models/referenceShared.tsx

@@ -25,6 +25,14 @@ export function ensureBlockScopedEngine(flowEngine: FlowEngine, scopedEngine?: F
   return scopedEngine ?? createBlockScopedEngine(flowEngine);
 }
 
+export function ensureScopedEngineView(engine: FlowEngine, hostContext?: FlowContext): void {
+  if (!engine?.context || !hostContext) return;
+  engine.context.defineProperty('view', {
+    cache: false,
+    get: () => hostContext.view,
+  });
+}
+
 export function unlinkScopedEngine(engine?: FlowEngine): void {
   engine?.unlinkFromStack?.();
 }

package/src/client/utils/__tests__/templateCopy.test.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { describe, expect, it } from 'vitest';
+import { FlowEngine, FlowModel } from '@nocobase/flow-engine';
+import { patchGridOptionsFromTemplateRoot } from '../templateCopy';
+
+describe('patchGridOptionsFromTemplateRoot', () => {
+  it('fills missing layout/linkageRules from template root', () => {
+    const engine = new FlowEngine();
+    class RootModel extends FlowModel {}
+    engine.registerModels({ RootModel });
+
+    const root = engine.createModel<RootModel>({
+      uid: 'tpl-root',
+      use: 'RootModel',
+      stepParams: {
+        formModelSettings: { layout: { layout: 'horizontal', labelWidth: 160 } },
+        eventSettings: { linkageRules: { value: [{ key: 'r1' }] } },
+      },
+    });
+
+    const gridOptions: any = { uid: 'dup-grid', use: 'GridModel', stepParams: {} };
+    const merged = patchGridOptionsFromTemplateRoot(root, gridOptions);
+    expect(merged.patched).toBe(true);
+    expect(merged.options.stepParams.formModelSettings.layout).toEqual({ layout: 'horizontal', labelWidth: 160 });
+    expect(merged.options.stepParams.eventSettings.linkageRules).toEqual({ value: [{ key: 'r1' }] });
+
+    // should be deep-cloned (mutating merged options must not affect template root)
+    merged.options.stepParams.formModelSettings.layout.layout = 'vertical';
+    expect(root.getStepParams('formModelSettings', 'layout')).toEqual({ layout: 'horizontal', labelWidth: 160 });
+  });
+
+  it('does not override existing grid values', () => {
+    const engine = new FlowEngine();
+    class RootModel extends FlowModel {}
+    engine.registerModels({ RootModel });
+
+    const root = engine.createModel<RootModel>({
+      uid: 'tpl-root',
+      use: 'RootModel',
+      stepParams: {
+        formModelSettings: { layout: { layout: 'horizontal', labelWidth: 160 } },
+        eventSettings: { linkageRules: { value: [{ key: 'r1' }] } },
+      },
+    });
+
+    const gridOptions: any = {
+      uid: 'dup-grid',
+      use: 'GridModel',
+      stepParams: {
+        formModelSettings: { layout: { layout: 'vertical', labelWidth: 120 } },
+        eventSettings: { linkageRules: { value: [] } },
+      },
+    };
+    const merged = patchGridOptionsFromTemplateRoot(root, gridOptions);
+    expect(merged.patched).toBe(false);
+    expect(merged.options.stepParams.formModelSettings.layout).toEqual({ layout: 'vertical', labelWidth: 120 });
+    expect(merged.options.stepParams.eventSettings.linkageRules).toEqual({ value: [] });
+  });
+});

package/src/client/utils/templateCopy.ts

@@ -0,0 +1,59 @@
+/**
+ * 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 _ from 'lodash';
+import { FlowModel } from '@nocobase/flow-engine';
+
+const DELEGATED_STEP_PARAMS: Array<{ flowKey: string; stepKey: string }> = [
+  { flowKey: 'formModelSettings', stepKey: 'layout' },
+  { flowKey: 'eventSettings', stepKey: 'linkageRules' },
+];
+
+function isPlainObject(val: unknown): val is Record<string, any> {
+  return !!val && typeof val === 'object' && !Array.isArray(val);
+}
+
+/**
+ * 字段模板 copy 模式只会 duplicate `subModels.grid`，而历史模板可能把部分配置（如布局/连动规则）
+ * 存在模板 root 上。reference 模式通过 getStepParams 的 fallback 能读到这些值，但 copy 模式需要
+ * 主动把这些 stepParams 合并进 grid 的 stepParams，避免丢失。
+ *
+ * - 仅在 grid 上缺失对应 stepKey 时才回填（不覆盖 grid 上已有值）
+ * - 返回 patched 标记，方便调用方决定是否需要 `saveStepParams()`
+ */
+export function patchGridOptionsFromTemplateRoot(
+  templateRoot: FlowModel | undefined,
+  gridOptions: any,
+): { options: any; patched: boolean } {
+  if (!templateRoot || !isPlainObject(gridOptions)) {
+    return { options: gridOptions, patched: false };
+  }
+
+  const baseStepParams = isPlainObject(gridOptions.stepParams) ? (gridOptions.stepParams as Record<string, any>) : {};
+  const nextStepParams: Record<string, any> = { ...baseStepParams };
+  let patched = false;
+
+  for (const { flowKey, stepKey } of DELEGATED_STEP_PARAMS) {
+    const val = templateRoot.getStepParams?.(flowKey, stepKey);
+    if (typeof val === 'undefined') continue;
+
+    const flow = isPlainObject(nextStepParams[flowKey]) ? { ...(nextStepParams[flowKey] as any) } : {};
+    const has = Object.prototype.hasOwnProperty.call(flow, stepKey);
+    if (!has || typeof flow[stepKey] === 'undefined') {
+      flow[stepKey] = _.cloneDeep(val);
+      nextStepParams[flowKey] = flow;
+      patched = true;
+    }
+  }
+
+  if (!patched) {
+    return { options: gridOptions, patched: false };
+  }
+  return { options: { ...gridOptions, stepParams: nextStepParams }, patched: true };
+}

package/src/locale/zh-CN.json

@@ -1,5 +1,5 @@
 {
-  "UI templates": "界面模板",
+  "UI templates": "UI 模板",
   "Block templates (v2)": "区块模板 (v2)",
   "Popup templates (v2)": "弹窗模板 (v2)",
   "Actions": "操作",

package/dist/client/subModelMenuExtensions.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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 type { FlowEngine } from '@nocobase/flow-engine';
-export declare function registerSubModelMenuExtensions(engine: FlowEngine): void;

package/dist/client/utils/refHost.d.ts

@@ -1,20 +0,0 @@
-/**
- * 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 type { FlowModel } from '@nocobase/flow-engine';
-export type RefHostInfo = {
-    ref?: {
-        mountSubKey?: unknown;
-        mode?: unknown;
-        [key: string]: unknown;
-    };
-    [key: string]: unknown;
-};
-export declare function findRefHostInfoFromAncestors(model: FlowModel, options?: {
-    maxDepth?: number;
-}): RefHostInfo | undefined;

package/src/client/subModelMenuExtensions.ts

@@ -1,103 +0,0 @@
-/**
- * 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 type { FlowEngine, FlowModel, FlowModelContext } from '@nocobase/flow-engine';
-import { NAMESPACE } from './locale';
-import { findRefHostInfoFromAncestors } from './utils/refHost';
-
-function findFormModel(model: FlowModel): FlowModel | undefined {
-  let cur: FlowModel | undefined = model;
-  let depth = 0;
-  while (cur && depth < 6) {
-    const use = cur?.use;
-    if (use === 'CreateFormModel' || use === 'EditFormModel') return cur;
-    cur = cur?.parent as FlowModel | undefined;
-    depth++;
-  }
-  return undefined;
-}
-
-function isFormInsideReferenceBlock(formModel: FlowModel | undefined): boolean {
-  if (!formModel) return false;
-  // 检查表单的 parent 是否是 ReferenceBlockModel
-  const parent = formModel?.parent as FlowModel | undefined;
-  return parent?.use === 'ReferenceBlockModel';
-}
-
-export function registerSubModelMenuExtensions(engine: FlowEngine) {
-  type ModelClass = typeof FlowModel & {
-    __subModelTemplateMenuPatched?: boolean;
-    defineChildren?: (ctx: FlowModelContext) => any;
-  };
-  const FormCustomItemModel = engine.getModelClass?.('FormCustomItemModel') as ModelClass | undefined;
-  if (!FormCustomItemModel || FormCustomItemModel.__subModelTemplateMenuPatched) return;
-  FormCustomItemModel.__subModelTemplateMenuPatched = true;
-
-  const originalDefineChildren = FormCustomItemModel.defineChildren;
-
-  FormCustomItemModel.defineChildren = async function patchedDefineChildren(ctx: FlowModelContext) {
-    const raw = originalDefineChildren ? await originalDefineChildren.call(this, ctx) : [];
-    const children = Array.isArray(raw) ? raw : [];
-
-    const label = ctx.t?.('Field template', { ns: [NAMESPACE, 'client'], nsMode: 'fallback' }) || 'Field template';
-    const formModel = findFormModel(ctx.model);
-    const parentUse = formModel?.use || ctx.model.parent?.use;
-    const expectedRootUse =
-      parentUse === 'CreateFormModel' || parentUse === 'EditFormModel'
-        ? ['CreateFormModel', 'EditFormModel']
-        : parentUse;
-    const resourceInit = formModel?.getStepParams?.('resourceSettings', 'init') || {};
-    const expectedDataSourceKey =
-      typeof resourceInit?.dataSourceKey === 'string' ? resourceInit.dataSourceKey : undefined;
-    const expectedCollectionName =
-      typeof resourceInit?.collectionName === 'string' ? resourceInit.collectionName : undefined;
-
-    const fromTemplateItem = {
-      key: '__fromTemplate__',
-      label,
-      sort: -999,
-      hide: async (innerCtx: FlowModelContext) => {
-        // 1) 若处于"字段模板引用"内部（当前正在渲染模板 grid），直接隐藏，避免误清空模板侧字段
-        const hostInfo = findRefHostInfoFromAncestors(innerCtx.model);
-        const hostRef = hostInfo?.ref;
-        if (hostRef && hostRef.mountSubKey === 'grid' && hostRef.mode !== 'copy') {
-          return true;
-        }
-
-        // 2) 若当前表单是 ReferenceBlockModel 渲染的 target，隐藏 "From template"
-        // 因为在 ReferenceBlockModel 内部编辑字段会直接影响被引用的模板
-        const fm = findFormModel(innerCtx.model);
-        if (isFormInsideReferenceBlock(fm)) {
-          return true;
-        }
-
-        // 3) 常规：当前表单区块已经使用引用 grid（字段模板），隐藏 "From template"
-        const mountTarget = fm || (innerCtx.model.parent as FlowModel | undefined);
-        if (!mountTarget) return false;
-        const grid = (mountTarget?.subModels as any)?.grid;
-        const isReferenceGrid = !!grid && String(grid?.use || '') === 'ReferenceFormGridModel';
-        return isReferenceGrid;
-      },
-      createModelOptions: () => ({
-        use: 'SubModelTemplateImporterModel',
-        props: {
-          // 表单字段的复用以 grid 为单位引入，保留模板里的布局
-          defaultSourcePath: 'subModels.grid',
-          defaultMountSubKey: 'grid',
-          mountToParentLevel: 1,
-          expectedRootUse,
-          expectedDataSourceKey,
-          expectedCollectionName,
-        },
-      }),
-    };
-
-    return [fromTemplateItem, ...children].filter(Boolean);
-  };
-}

package/src/client/utils/refHost.ts

@@ -1,44 +0,0 @@
-/**
- * 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 type { FlowModel } from '@nocobase/flow-engine';
-import { REF_HOST_CTX_KEY } from '../constants';
-
-export type RefHostInfo = {
-  ref?: {
-    mountSubKey?: unknown;
-    mode?: unknown;
-    [key: string]: unknown;
-  };
-  [key: string]: unknown;
-};
-
-export function findRefHostInfoFromAncestors(
-  model: FlowModel,
-  options?: { maxDepth?: number },
-): RefHostInfo | undefined {
-  const maxDepth = options?.maxDepth ?? 8;
-  let cur: FlowModel | undefined = model;
-  let depth = 0;
-  while (cur && depth < maxDepth) {
-    try {
-      const ctx = cur.context as unknown as Record<string, unknown>;
-      // 只读取自身 context 上定义的 host 信息，避免从 delegate 链“误捡到”其他 view/弹窗的标记
-      if (ctx && Object.prototype.hasOwnProperty.call(ctx, REF_HOST_CTX_KEY)) {
-        const v = ctx[REF_HOST_CTX_KEY] as RefHostInfo | undefined;
-        if (v) return v;
-      }
-    } catch {
-      // ignore
-    }
-    cur = cur.parent as FlowModel | undefined;
-    depth++;
-  }
-  return undefined;
-}