@nocobase/flow-engine 2.0.0-alpha.4 → 2.0.0-alpha.41

package/src/utils/pruneFilter.ts

@@ -0,0 +1,41 @@
+/**
+ * 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.
+ */
+
+/**
+ * 递归清理筛选对象中的“空值”。
+ *
+ * 规则：
+ * - 移除：`null`、`undefined`、空字符串 `''`、空数组 `[]`、空对象 `{}`；
+ * - 保留：`false`、`0` 等有意义的“假值”。
+ *
+ * 注意：当清理后整体变为空结构时，返回 `undefined`，用于表示无需下发该条件。
+ *
+ * @param input 任意筛选对象/数组/原始值
+ * @returns 清理后的对象；若为空则返回 `undefined`
+ */
+export function pruneFilter<T = any>(input: T): T | undefined {
+  // Arrays: prune items and drop empty arrays
+  if (Array.isArray(input)) {
+    const arr = (input as unknown[]).map((v) => pruneFilter(v)).filter((v) => v !== undefined);
+    return (arr.length ? (arr as unknown as T) : undefined) as any;
+  }
+
+  // Objects: prune properties and drop empty objects
+  if (input && typeof input === 'object') {
+    const out: Record<string, any> = {};
+    Object.keys(input as Record<string, any>).forEach((k) => {
+      const v = pruneFilter((input as any)[k]);
+      if (v !== undefined) out[k] = v;
+    });
+    return (Object.keys(out).length ? (out as unknown as T) : undefined) as any;
+  }
+
+  // Primitives: keep false/0; drop null/undefined/''
+  return input === null || input === undefined || (typeof input === 'string' && input === '') ? undefined : input;
+}

package/src/utils/safeGlobals.ts

@@ -8,9 +8,10 @@
  */
 
 /**
- * 统一的安全全局对象代理：window/document
- * - 默认仅允许常用的定时器、console、Math、Date、addEventListener（绑定原 window）
- * - document 仅允许 createElement/querySelector/querySelectorAll
+ * 统一的安全全局对象代理：window/document/navigator
+ * - window：仅允许常用的定时器、console、Math、Date、addEventListener、open（安全包装）、location（安全代理）
+ * - document：仅允许 createElement/querySelector/querySelectorAll
+ * - navigator：仅提供极少量低风险能力（clipboard.writeText、onLine、language、languages）
  * - 不允许随意访问未声明的属性，最小权限原则
  */
 
@@ -186,3 +187,48 @@ export function createSafeDocument(extra?: Record<string, any>) {
     },
   );
 }
+
+export function createSafeNavigator(extra?: Record<string, any>) {
+  const nav: any = (typeof window !== 'undefined' && window.navigator) || undefined;
+
+  // 始终提供 clipboard 对象，避免可选链访问时抛错
+  const clipboard: Record<string, any> = {};
+  const writeText = nav?.clipboard?.writeText;
+  if (typeof writeText === 'function') {
+    clipboard.writeText = writeText.bind(nav.clipboard);
+  }
+
+  const allowed: Record<string, any> = {
+    clipboard,
+  };
+
+  // 只读常用标识，避免泄露更多指纹信息
+  Object.defineProperty(allowed, 'onLine', {
+    get: () => !!nav?.onLine,
+    enumerable: true,
+    configurable: false,
+  });
+  Object.defineProperty(allowed, 'language', {
+    get: () => nav?.language,
+    enumerable: true,
+    configurable: false,
+  });
+  Object.defineProperty(allowed, 'languages', {
+    get: () => (nav?.languages ? [...nav.languages] : undefined),
+    enumerable: true,
+    configurable: false,
+  });
+
+  // 允许额外注入（例如自定义能力的受控暴露）
+  Object.assign(allowed, extra || {});
+
+  return new Proxy(
+    {},
+    {
+      get(_t, prop: string) {
+        if (prop in allowed) return (allowed as any)[prop];
+        throw new Error(`Access to navigator property "${String(prop)}" is not allowed.`);
+      },
+    },
+  );
+}

package/src/utils/schema-utils.ts

@@ -181,7 +181,7 @@ export async function resolveStepUiSchema<TModel extends FlowModel = FlowModel>(
 
   if (step.use) {
     try {
-      const action = model.flowEngine?.getAction?.(step.use);
+      const action = model.getAction?.(step.use);
       if (action && action.uiSchema) {
         stepUiSchema = stepUiSchema || action.uiSchema;
       }

package/src/utils/serverContextParams.ts

@@ -14,6 +14,7 @@ export type RecordRef = {
   id?: any; // primary key value
   filterByTk?: any; // alias for id
   dataSourceKey?: string;
+  sourceId?: any;
   fields?: string[];
   appends?: string[];
   record?: any; // full record object (try to infer pk from it)

package/src/utils/translation.ts

@@ -27,11 +27,16 @@ export function getT(model: FlowModel): (key: string, options?: any) => string {
   return (key: string) => key;
 }
 
-export function escapeT(text: TFuncKey | TFuncKey[], options?: TOptions) {
+export function tExpr(text: TFuncKey | TFuncKey[], options?: TOptions) {
   if (options) {
     return `{{t(${JSON.stringify(text)}, ${JSON.stringify(options)})}}`;
   }
   return `{{t(${JSON.stringify(text)})}}`;
 }
 
-export { escapeT as tExpr };
+/**
+ * @deprecated use tExpr from `@nocobase/flow-engine` instead
+ */
+export function escapeT(text: TFuncKey | TFuncKey[], options?: TOptions) {
+  return tExpr(text, options);
+}

package/src/utils/variablesParams.ts

@@ -7,15 +7,17 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import type { FlowContext, PropertyMeta, PropertyMetaFactory } from '../flowContext';
-import type { JSONValue } from './params-resolvers';
-import type { Collection } from '../data-source';
-import { createCollectionContextMeta } from './createCollectionContextMeta';
-import { buildServerContextParams, type RecordRef, type ServerContextParams } from '../utils/serverContextParams';
 import {
   extractUsedVariableNames as _extractUsedVariableNames,
   extractUsedVariablePaths as _extractUsedVariablePaths,
-} from '@nocobase/utils/client';
+} from '@nocobase/shared';
+import type { Collection } from '../data-source';
+import type { FlowContext, PropertyMeta, PropertyMetaFactory } from '../flowContext';
+import { buildServerContextParams, type RecordRef, type ServerContextParams } from '../utils/serverContextParams';
+import { createCollectionContextMeta } from './createCollectionContextMeta';
+import { createAssociationSubpathResolver } from './associationObjectVariable';
+import type { JSONValue } from './params-resolvers';
+import _ from 'lodash';
 
 // Narrowest resource shape we rely on for inference
 type ResourceLike = {
@@ -45,6 +47,7 @@ function getCollection(ctx: FlowContext): CollectionShape | undefined {
   return undefined;
 }
 
+// 从 FlowContext 中推断当前记录的 context params 信息
 export function inferRecordRef(ctx: FlowContext): RecordRef | undefined {
   const resource = getResource(ctx);
   const collectionObj = getCollection(ctx);
@@ -59,13 +62,130 @@ export function inferRecordRef(ctx: FlowContext): RecordRef | undefined {
   return { collection, dataSourceKey, filterByTk };
 }
 
+// 从 FlowContext.view 中推断记录的 context params 信息
+export function inferViewRecordRef(ctx: FlowContext): RecordRef | undefined {
+  const view = ctx.view;
+  if (!view) return undefined;
+  const inputArgs = (view as any)?.inputArgs || {};
+  const collection = inputArgs?.collectionName || (view as any)?.record?.collection;
+  const dataSourceKey = inputArgs?.dataSourceKey || (view as any)?.record?.dataSourceKey || 'main';
+  const filterByTk = inputArgs?.filterByTk || (view as any)?.record?.filterByTk;
+  const sourceId = inputArgs?.sourceId;
+  if (!collection || typeof filterByTk === 'undefined' || filterByTk === null) return undefined;
+  return { collection, dataSourceKey, filterByTk, sourceId };
+}
+
+// 统一视图场景中“视图记录”的本地复用逻辑：
+// - 当视图 inputArgs.filterByTk 与父 FlowContext.record.filterByTk 一致时，
+//   认为视图正在查看同一条记录，此时返回父记录的深拷贝作为 view.record；
+// - 否则视为不同记录，不复用父记录（返回 undefined，让后续逻辑走服务端解析）。
+
+export function getViewRecordFromParent(flowContext: FlowContext, viewContext: FlowContext): unknown {
+  const parentRecord = flowContext.inputArgs?.record;
+  const parentTk = flowContext.collection?.filterTargetKey;
+  if (!parentRecord || !parentTk) return undefined;
+
+  const view = viewContext.view;
+  const viewFilterByTk = view?.inputArgs?.filterByTk;
+  const recordFilterByTk = parentRecord[parentTk];
+
+  // 仅当视图的 filterByTk 与父记录的 filterByTk 一致时，才复用父记录，
+  // 否则视为不同记录，不返回本地记录（统一走服务端解析）。
+  if (viewFilterByTk == null || recordFilterByTk == null) return undefined;
+  if (viewFilterByTk !== recordFilterByTk) return undefined;
+
+  return _.cloneDeep(parentRecord);
+}
+
+// 针对视图场景（Page/Dialog/Drawer），创建用于 view.resolveOnServer 的判定函数
+export function createViewRecordResolveOnServer(
+  ctx: FlowContext,
+  getLocalRecord: () => unknown,
+): (subPath: string) => boolean {
+  return (p: string) => {
+    if (!(p === 'record' || p.startsWith('record.'))) return false;
+    const local = getLocalRecord();
+    // 前端没有可用记录数据：统一走服务端
+    if (!local) return true;
+
+    // 直接访问整个 record 对象，使用前端值
+    if (p === 'record') return false;
+
+    // 仅在访问关联字段子路径时走服务端；非关联字段使用前端值
+    const ref = inferViewRecordRef(ctx);
+    const colName = ref?.collection;
+    const dsKey = ref?.dataSourceKey || 'main';
+    if (!colName) return true; // 未能推断集合，保守起见走服务端
+    const ds = (
+      ctx as FlowContext & { dataSourceManager?: { getDataSource?: (key: string) => any } }
+    ).dataSourceManager?.getDataSource?.(dsKey);
+    const collection = ds?.collectionManager?.getCollection?.(colName);
+    if (!collection) return true; // 未找到集合定义，保守走服务端
+
+    const resolver = createAssociationSubpathResolver(
+      () => collection as Collection,
+      () => local,
+    );
+    const subPath = p.startsWith('record.') ? p.slice('record.'.length) : '';
+    if (!subPath) return false;
+    return resolver(subPath);
+  };
+}
+
+/**
+ * 创建一个用于 “ctx.record” 变量的 resolveOnServer 判定函数：
+ * - 若本地 record 不存在：统一走服务端；
+ * - 若本地 record 存在：
+ *   - 访问空子路径（"{{ ctx.record }}"）时使用本地值，不走服务端；
+ *   - 访问非关联字段（如 id/title）：使用本地值；
+ *   - 访问关联字段：
+ *     - 若本地该字段无值（undefined/null），则交给服务端解析（无论是 "author" 还是 "author.name"）；
+ *     - 若本地已有值，则仅在访问子属性且本地缺少该子属性值时交给服务端。
+ */
+export function createRecordResolveOnServerWithLocal(
+  collectionAccessor: () => Collection | null,
+  valueAccessor: () => unknown,
+): (subPath: string) => boolean {
+  const assocSubpathResolver = createAssociationSubpathResolver(collectionAccessor, () => valueAccessor());
+  return (p: string) => {
+    const local = valueAccessor();
+    if (!local) return true;
+    if (!p) return false;
+
+    const collection = collectionAccessor() as any;
+
+    // 访问关联字段整体：当本地该字段无值时，统一交给服务端
+    if (!p.includes('.')) {
+      const name = p;
+      let field: any;
+      if (collection) {
+        if (typeof collection.getField === 'function') {
+          field = collection.getField(name);
+        }
+        if (!field && typeof collection.getFields === 'function') {
+          const fields = collection.getFields() || [];
+          field = fields.find((f: any) => f?.name === name);
+        }
+      }
+      const isAssoc = !!field?.isAssociationField?.();
+      if (!isAssoc) return false;
+      const value = (local as any)?.[name];
+      if (value === undefined || value === null) return true;
+      return false;
+    }
+
+    // 访问关联字段子属性：复用 associationSubpathResolver 的“本地优先 + 关联字段才走服务端”逻辑
+    return assocSubpathResolver(p);
+  };
+}
+
 export function inferParentRecordRef(ctx: FlowContext): RecordRef | undefined {
   const resource = getResource(ctx);
   const dataSourceKey = getCollection(ctx)?.dataSourceKey || resource?.getDataSourceKey?.();
-  const rn = resource?.getResourceName?.();
+  const resourceName = resource?.getResourceName?.();
   const sourceId = resource?.getSourceId?.();
-  if (!rn || typeof sourceId === 'undefined' || sourceId === null) return undefined;
-  const parts = String(rn).split('.');
+  if (!resourceName || typeof sourceId === 'undefined' || sourceId === null) return undefined;
+  const parts = String(resourceName).split('.');
   if (parts.length < 2) return undefined;
   return { collection: parts[0], dataSourceKey, filterByTk: sourceId };
 }
@@ -110,8 +230,11 @@ export function createRecordMetaFactory(
 export function createCurrentRecordMetaFactory(
   ctx: FlowContext,
   collectionAccessor: () => Collection | null,
+  options?: { title?: string },
 ): PropertyMetaFactory {
-  const title = (ctx as any)?.t?.('Current record') || 'Current record';
+  const title = options?.title
+    ? ctx.t?.(options.title) || options.title
+    : ctx.t?.('Current record') || 'Current record';
   return createRecordMetaFactory(collectionAccessor, title, (c) => inferRecordRef(c));
 }
 
@@ -141,35 +264,30 @@ export async function collectContextParamsForTemplate(
   ctx: FlowContext,
   template: JSONValue,
 ): Promise<ServerContextParams | undefined> {
-  try {
-    const usage = _extractUsedVariablePaths(template) || {};
-    const varNames = Object.keys(usage);
-    if (!varNames.length) return undefined;
-
-    const input: Record<string, any> = {};
-    for (const key of varNames) {
-      const opt = (ctx as any).getPropertyOptions?.(key);
-      const meta: PropertyMeta | (() => Promise<PropertyMeta | null> | PropertyMeta | null) | undefined = opt?.meta;
-      if (!meta) continue;
-      let built: any;
-      try {
-        const resolvedMeta = typeof meta === 'function' ? await (meta as any)() : (meta as any);
-        const builder = resolvedMeta?.buildVariablesParams;
-        if (typeof builder === 'function') {
-          built = await builder(ctx);
-        }
-      } catch (err) {
-        // 忽略构建变量参数时的异常，继续处理其他变量
-        // 使用 void 引用以避免 no-unused-vars，同时避免空代码块触发 no-empty
-        void err;
-        continue;
-      }
-      if (built) {
-        input[key] = built;
+  const usage = _extractUsedVariablePaths(template) || {};
+  const varNames = Object.keys(usage);
+  if (!varNames.length) return undefined;
+
+  const input: Record<string, any> = {};
+  for (const key of varNames) {
+    const opt = ctx.getPropertyOptions?.(key);
+    const meta: PropertyMeta | (() => Promise<PropertyMeta | null> | PropertyMeta | null) | undefined = opt?.meta;
+    if (!meta) continue;
+    let built: any;
+    try {
+      const resolvedMeta = typeof meta === 'function' ? await (meta as any)() : (meta as any);
+      const builder = resolvedMeta?.buildVariablesParams;
+      if (typeof builder === 'function') {
+        built = await builder(ctx);
       }
+    } catch (err) {
+      // 忽略构建变量参数时的异常，继续处理其他变量
+      void err;
+      continue;
+    }
+    if (built) {
+      input[key] = built;
     }
-    return buildServerContextParams(ctx, input);
-  } catch (_) {
-    return undefined;
   }
+  return buildServerContextParams(ctx, input);
 }

package/src/views/DrawerComponent.tsx

@@ -10,12 +10,13 @@
 // components/drawer/useDrawer/DrawerComponent.tsx
 import { Drawer } from 'antd';
 import * as React from 'react';
+import { MobilePopup } from '../components/MobilePopup';
 
 const DrawerComponent = React.forwardRef((props: any, ref) => {
-  const { children, footer: initialFooter, title, extra, hidden, ...drawerProps } = props;
+  const { children, footer: initialFooter, title, extra, hidden, isMobile, ...drawerProps } = props;
   const [open, setOpen] = React.useState(true);
   const [footer, setFooter] = React.useState(() => initialFooter);
-  const [header, setHeader] = React.useState({ title, extra });
+  const [header, setHeader] = React.useState({ title, extra, ...drawerProps.header });
 
   React.useImperativeHandle(
     ref,
@@ -46,6 +47,24 @@ const DrawerComponent = React.forwardRef((props: any, ref) => {
     return document.querySelector('#nocobase-app-container');
   }, []);
 
+  if (isMobile) {
+    return (
+      <MobilePopup
+        className={hidden ? 'nb-hidden' : ''}
+        visible={open}
+        {...drawerProps}
+        footer={footer}
+        {...header}
+        onClose={() => {
+          setOpen(false);
+          drawerProps.afterClose?.();
+        }}
+      >
+        {children}
+      </MobilePopup>
+    );
+  }
+
   return (
     <Drawer
       rootClassName={hidden ? 'nb-hidden' : ''}

package/src/views/PageComponent.tsx

@@ -24,7 +24,7 @@ export const PageComponent = forwardRef((props: any, ref) => {
     hidden,
     title: _title,
     styles = {},
-    zIndex,
+    zIndex = 4, // 这个默认值是为了防止表格的阴影显示到子页面上面
   } = mergedProps;
   const closedRef = useRef(false);
   const flowEngine = useFlowEngine();

package/src/views/ViewNavigation.ts

@@ -8,16 +8,21 @@
  */
 
 import { FlowEngineContext } from '../flowContext';
-
-interface ViewParam {
-  /** 视图唯一标识符，一般为某个 Model 实例的 uid */
-  viewUid?: string;
-  /** 标签页唯一标识符 */
-  tabUid?: string;
-  /** 弹窗记录的 id */
-  filterByTk?: string;
-  /** source Id */
-  sourceId?: string;
+import { ViewParam as SharedViewParam } from '../utils';
+
+type ViewParam = Omit<SharedViewParam, 'viewUid'> & { viewUid?: string };
+
+function encodeFilterByTk(val: SharedViewParam['filterByTk']): string {
+  if (val === undefined || val === null) return '';
+  // 1.x 兼容：对象按 key1=v1&key2=v2 拼接后整体 encodeURIComponent
+  if (val && typeof val === 'object' && !Array.isArray(val)) {
+    const pairs = Object.entries(val).map(([k, v]) => {
+      return `${encodeURIComponent(String(k))}=${encodeURIComponent(String(v))}`;
+    });
+    return encodeURIComponent(pairs.join('&'));
+  }
+  // 其它情况按原单值编码（字符串）
+  return encodeURIComponent(String(val));
 }
 
 /**
@@ -53,8 +58,11 @@ export function generatePathnameFromViewParams(viewParams: ViewParam[]): string
     if (viewParam.tabUid) {
       segments.push('tab', viewParam.tabUid);
     }
-    if (viewParam.filterByTk) {
-      segments.push('filterbytk', viewParam.filterByTk);
+    if (viewParam.filterByTk != null) {
+      const encoded = encodeFilterByTk(viewParam.filterByTk);
+      if (encoded) {
+        segments.push('filterbytk', encoded);
+      }
     }
     if (viewParam.sourceId) {
       segments.push('sourceid', viewParam.sourceId);

package/src/views/__tests__/ViewNavigation.test.ts

@@ -173,6 +173,16 @@ describe('generatePathnameFromViewParams', () => {
     );
   });
 
+  it('should encode object filterByTk as encoded key-value string', () => {
+    const path = generatePathnameFromViewParams([{ viewUid: 'xxx', filterByTk: { id: 1, tenant: 'ac' } }]);
+    expect(path).toBe('/admin/xxx/filterbytk/' + encodeURIComponent('id=1&tenant=ac'));
+  });
+
+  it('should omit filterByTk segment for empty string or when absent', () => {
+    expect(generatePathnameFromViewParams([{ viewUid: 'xxx' }])).toBe('/admin/xxx');
+    expect(generatePathnameFromViewParams([{ viewUid: 'xxx', filterByTk: '' }])).toBe('/admin/xxx');
+  });
+
   it('should match parsePathnameToViewParams test cases', () => {
     // Test cases from parsePathnameToViewParams.test.ts
     expect(generatePathnameFromViewParams([{ viewUid: 'xxx' }])).toBe('/admin/xxx');