@nocobase/client-v2 2.1.0-beta.27 → 2.1.0-beta.30

package/src/flow/models/fields/DateTimeFieldModel/dateLimit.ts

@@ -0,0 +1,152 @@
+/**
+ * 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 { autorun } from '@formily/reactive';
+import { Form } from 'antd';
+import { useFlowContext } from '@nocobase/flow-engine';
+import { dayjs } from '@nocobase/utils/client';
+import { first, last } from 'lodash';
+import React, { useEffect, useRef, useState } from 'react';
+
+type DateLimitProps = {
+  _minDate?: any;
+  _maxDate?: any;
+  currentForm?: any;
+};
+
+export function useDateLimit(props: DateLimitProps) {
+  const ctx = useFlowContext();
+  const isAntdFormInstance = typeof props.currentForm?.getFieldsValue === 'function';
+  const currentFormValues = Form.useWatch([], isAntdFormInstance ? props.currentForm : undefined);
+  const [minDate, setMinDate] = useState<dayjs.Dayjs | null>(null);
+  const [maxDate, setMaxDate] = useState<dayjs.Dayjs | null>(null);
+  const [disabledDate, setDisabledDate] = useState<any>(null);
+  const [disabledTime, setDisabledTime] = useState<any>(null);
+  const disposeRef = useRef<any>(null);
+
+  useEffect(() => {
+    if (disposeRef.current) {
+      disposeRef.current();
+    }
+
+    disposeRef.current = autorun(() => {
+      void limitDate();
+    });
+
+    return () => {
+      disposeRef.current?.();
+    };
+  }, [ctx, currentFormValues, props._maxDate, props._minDate]);
+
+  const limitDate = async () => {
+    const resolvedParams = await ctx.resolveJsonTemplate({
+      _minDate: props._minDate,
+      _maxDate: props._maxDate,
+    });
+
+    const nextMinRaw = Array.isArray(resolvedParams?._minDate)
+      ? first(resolvedParams._minDate)
+      : resolvedParams?._minDate;
+    const nextMaxRaw = Array.isArray(resolvedParams?._maxDate)
+      ? last(resolvedParams._maxDate)
+      : resolvedParams?._maxDate;
+    const nextMinDate = nextMinRaw ? dayjs(nextMinRaw) : null;
+    const nextMaxDate = nextMaxRaw ? dayjs(nextMaxRaw) : null;
+
+    setMinDate(nextMinDate?.isValid?.() ? nextMinDate : null);
+    setMaxDate(nextMaxDate?.isValid?.() ? nextMaxDate : null);
+
+    const fullTimeArr = Array.from({ length: 60 }, (_, i) => i);
+
+    const nextDisabledDate = (current: dayjs.Dayjs) => {
+      if (!dayjs.isDayjs(current)) return false;
+
+      const min = nextMinDate?.isValid?.() ? nextMinDate.startOf('day') : null;
+      const max = nextMaxDate?.isValid?.() ? nextMaxDate.endOf('day') : null;
+
+      if (min && current.startOf('day').isBefore(min)) {
+        return true;
+      }
+      if (max && current.startOf('day').isAfter(max)) {
+        return true;
+      }
+      return false;
+    };
+
+    const nextDisabledTime = (current: dayjs.Dayjs) => {
+      if (!current || (!nextMinDate?.isValid?.() && !nextMaxDate?.isValid?.())) {
+        return { disabledHours: () => [], disabledMinutes: () => [], disabledSeconds: () => [] };
+      }
+
+      const isCurrentMinDay = !!nextMinDate?.isValid?.() && current.isSame(nextMinDate, 'day');
+      const isCurrentMaxDay = !!nextMaxDate?.isValid?.() && current.isSame(nextMaxDate, 'day');
+
+      const disabledHours = () => {
+        const hours = [];
+        if (isCurrentMinDay && nextMinDate) {
+          for (let hour = 0; hour < nextMinDate.hour(); hour++) {
+            hours.push(hour);
+          }
+        }
+        if (isCurrentMaxDay && nextMaxDate) {
+          for (let hour = nextMaxDate.hour() + 1; hour < 24; hour++) {
+            hours.push(hour);
+          }
+        }
+        return hours;
+      };
+
+      const disabledMinutes = (selectedHour: number) => {
+        if (isCurrentMinDay && nextMinDate && selectedHour === nextMinDate.hour()) {
+          return fullTimeArr.filter((minute) => minute < nextMinDate.minute());
+        }
+        if (isCurrentMaxDay && nextMaxDate && selectedHour === nextMaxDate.hour()) {
+          return fullTimeArr.filter((minute) => minute > nextMaxDate.minute());
+        }
+        return [];
+      };
+
+      const disabledSeconds = (selectedHour: number, selectedMinute: number) => {
+        if (
+          isCurrentMinDay &&
+          nextMinDate &&
+          selectedHour === nextMinDate.hour() &&
+          selectedMinute === nextMinDate.minute()
+        ) {
+          return fullTimeArr.filter((second) => second < nextMinDate.second());
+        }
+        if (
+          isCurrentMaxDay &&
+          nextMaxDate &&
+          selectedHour === nextMaxDate.hour() &&
+          selectedMinute === nextMaxDate.minute()
+        ) {
+          return fullTimeArr.filter((second) => second > nextMaxDate.second());
+        }
+        return [];
+      };
+
+      return {
+        disabledHours,
+        disabledMinutes,
+        disabledSeconds,
+      };
+    };
+
+    setDisabledDate(() => nextDisabledDate);
+    setDisabledTime(() => nextDisabledTime);
+  };
+
+  return {
+    minDate,
+    maxDate,
+    disabledDate,
+    disabledTime,
+  };
+}

package/src/flow/models/fields/JSEditableFieldModel.tsx

@@ -35,6 +35,10 @@ function JsEditableField() {
     ctx.setValue?.(v);
   };
 
+  if (ctx.readOnly) {
+    return <span>{String(value ?? '')}</span>;
+  }
+
   return (
     <Input
       {...ctx.model.props}
@@ -48,6 +52,23 @@ function JsEditableField() {
 ctx.render(<JsEditableField />);
 `;
 
+function getEffectivePattern(model?: JSEditableFieldModel) {
+  return (
+    model?.props?.pattern ??
+    (model?.context as { pattern?: string } | undefined)?.pattern ??
+    (model?.parent as { props?: { pattern?: string } } | undefined)?.props?.pattern
+  );
+}
+
+function isReadOnlyMode(model?: JSEditableFieldModel) {
+  return !!model?.props?.readOnly || getEffectivePattern(model) === 'readPretty';
+}
+
+function resolveScriptCode(codeParam?: string) {
+  const raw = codeParam ?? DEFAULT_CODE;
+  return typeof raw === 'string' ? raw.trim() : '';
+}
+
 const JSFormRuntime: React.FC<{
   model: JSEditableFieldModel;
   value?: any;
@@ -66,26 +87,27 @@ const JSFormRuntime: React.FC<{
   // 统一获取&裁剪脚本代码，直接依赖具体 code 字符串，避免顶层 stepParams 引用未变化导致不更新
   const codeParam = model.getStepParams('jsSettings', 'runJs')?.code as string | undefined;
   const scriptCode = useMemo(() => {
-    const raw = codeParam ?? DEFAULT_CODE;
-    return typeof raw === 'string' ? raw.trim() : '';
+    return resolveScriptCode(codeParam);
   }, [codeParam]);
 
+  useEffect(() => {
+    if (!containerRef.current || !scriptCode) return;
+    model.scheduleApplyJsSettings();
+  }, [model, scriptCode]);
+
   useEffect(() => {
     if (!containerRef.current || !scriptCode) return;
     const event = new CustomEvent('js-field:value-change', { detail: value });
     containerRef.current.dispatchEvent(event);
   }, [value, scriptCode]);
 
-  // 无自定义 JS 时默认渲染 Input，保持可用性
+  if (readOnly && !scriptCode) {
+    return <span>{String(value ?? '')}</span>;
+  }
+
   if (!scriptCode) {
     return (
-      <Input
-        value={value}
-        onChange={(e) => onChange?.(e.target.value)}
-        disabled={disabled}
-        readOnly={readOnly}
-        style={{ width: '100%' }}
-      />
+      <Input value={value} onChange={(e) => onChange?.(e.target.value)} disabled={disabled} style={{ width: '100%' }} />
     );
   }
 
@@ -100,14 +122,77 @@ const JSFormRuntime: React.FC<{
  */
 export class JSEditableFieldModel extends FieldModel {
   private _mountedOnce = false;
+  private _pendingJsSettingsApply = false;
+  private _lastAppliedJsSettings?: {
+    code: string;
+    disabled: boolean;
+    readOnly: boolean;
+    element: HTMLSpanElement | null;
+  };
+
+  scheduleApplyJsSettings() {
+    const codeParam = this.getStepParams('jsSettings', 'runJs')?.code as string | undefined;
+    if (!resolveScriptCode(codeParam)) return;
+
+    if (this._pendingJsSettingsApply) {
+      return;
+    }
+
+    this._pendingJsSettingsApply = true;
+    queueMicrotask(() => {
+      this._pendingJsSettingsApply = false;
+
+      const nextCodeParam = this.getStepParams('jsSettings', 'runJs')?.code as string | undefined;
+      const nextCode = resolveScriptCode(nextCodeParam);
+      const nextElement = this.context.ref?.current as HTMLSpanElement | null;
+      if (!nextCode || !nextElement) {
+        return;
+      }
+
+      const nextRun = {
+        code: nextCode,
+        disabled: !!this.props?.disabled,
+        readOnly: isReadOnlyMode(this),
+        element: nextElement,
+      };
+      const lastRun = this._lastAppliedJsSettings;
+      if (
+        lastRun &&
+        lastRun.code === nextRun.code &&
+        lastRun.disabled === nextRun.disabled &&
+        lastRun.readOnly === nextRun.readOnly &&
+        lastRun.element === nextRun.element
+      ) {
+        return;
+      }
+
+      this._lastAppliedJsSettings = nextRun;
+      void this.applyFlow('jsSettings');
+    });
+  }
+
+  useHooksBeforeRender() {
+    const codeParam = this.getStepParams('jsSettings', 'runJs')?.code as string | undefined;
+    const scriptCode = resolveScriptCode(codeParam);
+    const disabled = this.props?.disabled;
+
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    useEffect(() => {
+      if (!scriptCode) return;
+      this.scheduleApplyJsSettings();
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [scriptCode, disabled]);
+  }
+
   render() {
+    const readOnly = isReadOnlyMode(this);
     return (
       <JSFormRuntime
         model={this as JSEditableFieldModel}
         value={this.props?.value}
         onChange={this.props?.onChange}
         disabled={this.props?.disabled}
-        readOnly={this.props?.readOnly}
+        readOnly={readOnly}
       />
     );
   }
@@ -128,13 +213,17 @@ export class JSEditableFieldModel extends FieldModel {
   }
 }
 
-JSEditableFieldModel.define({
+const jsEditableFieldModelMeta = {
   label: tExpr('JS field'),
-});
+  preserveOnPatternChange: true,
+};
+
+JSEditableFieldModel.define(jsEditableFieldModelMeta);
 
 JSEditableFieldModel.registerFlow({
   key: 'jsSettings',
   title: tExpr('JavaScript settings'),
+  manual: true,
   steps: {
     runJs: {
       title: tExpr('Write JavaScript'),
@@ -174,6 +263,10 @@ JSEditableFieldModel.registerFlow({
       },
       async handler(ctx, params) {
         const { code, version } = resolveRunJsParams(ctx, params);
+        if (!code?.trim()) {
+          return;
+        }
+
         ctx.onRefReady(ctx.ref, async (element) => {
           // 暴露容器与读写能力（使用动态 getter 绑定 ref.current，避免容器变更失效）
           ctx.defineProperty('element', {
@@ -201,7 +294,10 @@ JSEditableFieldModel.registerFlow({
           });
           ctx.defineProperty('namePath', { get: () => ctx.model.props?.name, cache: false });
           ctx.defineProperty('disabled', { get: () => !!ctx.model.props?.disabled, cache: false });
-          ctx.defineProperty('readOnly', { get: () => !!ctx.model.props?.readOnly, cache: false });
+          ctx.defineProperty('readOnly', {
+            get: () => isReadOnlyMode(ctx.model),
+            cache: false,
+          });
           const navigator = createSafeNavigator();
           await ctx.runjs(
             code,

package/src/flow/models/fields/__tests__/ClickableFieldModel.test.ts

@@ -0,0 +1,87 @@
+/**
+ * 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, vi } from 'vitest';
+import { FlowEngine } from '@nocobase/flow-engine';
+import { ClickableFieldModel } from '../ClickableFieldModel';
+
+function createRolesFieldModel(sourceRecord: Record<string, any>) {
+  const engine = new FlowEngine();
+  engine.registerModels({ ClickableFieldModel });
+
+  const usersCollection = {
+    name: 'users',
+    filterTargetKey: 'id',
+  };
+  const rolesCollection = {
+    name: 'roles',
+    filterTargetKey: 'name',
+  };
+  const rolesField = {
+    name: 'roles',
+    target: 'roles',
+    targetKey: 'name',
+    type: 'belongsToMany',
+    interface: 'm2m',
+    collection: usersCollection,
+    targetCollection: rolesCollection,
+    isAssociationField: () => true,
+  };
+
+  const model = engine.createModel<ClickableFieldModel>({
+    use: ClickableFieldModel,
+    uid: `clickable-roles-${sourceRecord?.id ?? 'new'}`,
+  });
+  model.context.defineProperty('collectionField', { value: rolesField });
+  model.context.defineProperty('blockModel', { value: { collection: usersCollection } });
+  model.context.defineProperty('record', { value: sourceRecord });
+
+  const dispatchEvent = vi.spyOn(model, 'dispatchEvent').mockResolvedValue([]);
+  return { model, dispatchEvent };
+}
+
+describe('ClickableFieldModel', () => {
+  it('opens an association display value as a normal target record when source record has no id', () => {
+    const { model, dispatchEvent } = createRolesFieldModel({});
+    const event = { type: 'click' };
+
+    model.onClick(event, { name: 'admin', title: 'Admin' });
+
+    expect(dispatchEvent).toHaveBeenCalledWith(
+      'click',
+      {
+        event,
+        filterByTk: 'admin',
+        collectionName: 'roles',
+        associationName: null,
+        sourceId: null,
+      },
+      { debounce: true },
+    );
+  });
+
+  it('keeps using the association resource when the source record has an id', () => {
+    const { model, dispatchEvent } = createRolesFieldModel({ id: 1 });
+    const event = { type: 'click' };
+
+    model.onClick(event, { name: 'admin', title: 'Admin' });
+
+    expect(dispatchEvent).toHaveBeenCalledWith(
+      'click',
+      {
+        event,
+        filterByTk: 'admin',
+        collectionName: 'users',
+        associationName: 'users.roles',
+        sourceId: 1,
+      },
+      { debounce: true },
+    );
+  });
+});

package/src/flow/models/fields/__tests__/JSEditableFieldModel.test.tsx

@@ -0,0 +1,210 @@
+/**
+ * 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 React from 'react';
+import { act, render, screen, waitFor } from '@testing-library/react';
+import { describe, expect, it, vi } from 'vitest';
+import { FlowEngine, FlowEngineProvider, FlowModel, FlowModelRenderer } from '@nocobase/flow-engine';
+import { JSEditableFieldModel } from '../JSEditableFieldModel';
+
+function createField(props?: Record<string, any>, code = '') {
+  const engine = new FlowEngine();
+  engine.registerModels({ JSEditableFieldModel });
+  return engine.createModel<JSEditableFieldModel>({
+    use: 'JSEditableFieldModel',
+    uid: `js-field-${props?.pattern || 'editable'}`,
+    props,
+    stepParams: {
+      jsSettings: {
+        runJs: {
+          code,
+        },
+      },
+    },
+  });
+}
+
+function renderField(props?: Record<string, any>, code?: string) {
+  const field = createField(props, code);
+
+  render(<>{field.render()}</>);
+
+  return field;
+}
+
+const EDITABLE_CODE = `
+function JsEditableField() {
+  const React = ctx.React;
+  const { Input } = ctx.antd;
+  const [value, setValue] = React.useState(ctx.getValue?.() ?? '');
+
+  React.useEffect(() => {
+    const handler = (ev) => setValue(ev?.detail ?? '');
+    ctx.element?.addEventListener('js-field:value-change', handler);
+    return () => ctx.element?.removeEventListener('js-field:value-change', handler);
+  }, []);
+
+  const onChange = (e) => {
+    const v = e?.target?.value ?? '';
+    setValue(v);
+    ctx.setValue?.(v);
+  };
+
+  return (
+    <Input
+      {...ctx.model.props}
+      value={value}
+      onChange={onChange}
+    />
+  );
+}
+
+ctx.render(<JsEditableField />);
+`;
+
+const READONLY_AWARE_CODE = `
+const React = ctx.React;
+ctx.render(<span data-testid="js-readonly-state">{String(ctx.readOnly)}</span>);
+`;
+
+class ParentModel extends FlowModel<any> {
+  render() {
+    return <FlowModelRenderer model={this.subModels.field} />;
+  }
+}
+
+function renderParentFieldWithFlowRenderer(
+  fieldProps?: Record<string, any>,
+  parentProps?: Record<string, any>,
+  code = EDITABLE_CODE,
+) {
+  const engine = new FlowEngine();
+  engine.registerModels({ JSEditableFieldModel, ParentModel });
+  const parent = engine.createModel<ParentModel>({
+    use: ParentModel,
+    uid: 'js-field-parent',
+    props: parentProps,
+    subModels: {
+      field: {
+        use: 'JSEditableFieldModel',
+        uid: 'js-field-with-parent',
+        props: fieldProps,
+        stepParams: {
+          jsSettings: {
+            runJs: {
+              code,
+            },
+          },
+        },
+      },
+    },
+  });
+
+  render(
+    <FlowEngineProvider engine={engine}>
+      <FlowModelRenderer model={parent} />
+    </FlowEngineProvider>,
+  );
+
+  return parent;
+}
+
+describe('JSEditableFieldModel', () => {
+  it('renders configured JavaScript in display only mode', async () => {
+    const field = renderParentFieldWithFlowRenderer(
+      { pattern: 'readPretty', value: 'hello' },
+      undefined,
+      READONLY_AWARE_CODE,
+    ).subModels.field as JSEditableFieldModel;
+
+    await waitFor(() => {
+      expect(screen.getByTestId('js-readonly-state')).toHaveTextContent('true');
+      expect(field.context.ref.current).toBeInstanceOf(HTMLSpanElement);
+    });
+  });
+
+  it('renders fallback as text in display only mode when code is empty', () => {
+    renderField({ pattern: 'readPretty', value: 'hello' });
+
+    expect(screen.getByText('hello')).toBeInTheDocument();
+    expect(screen.queryByDisplayValue('hello')).not.toBeInTheDocument();
+  });
+
+  it('renders fallback input for editable mode', () => {
+    renderField({ value: 'hello' });
+
+    expect(screen.getByDisplayValue('hello')).toBeInTheDocument();
+  });
+
+  it('rerenders as text when owner form item switches to display only', async () => {
+    const parent = renderParentFieldWithFlowRenderer({ value: 'hello' }, undefined, '');
+
+    await act(async () => {
+      parent.setProps({ pattern: 'readPretty' });
+    });
+
+    await waitFor(() => {
+      expect(screen.getByText('hello')).toBeInTheDocument();
+      expect(screen.queryByRole('textbox')).not.toBeInTheDocument();
+    });
+  });
+
+  it('does not rerun JavaScript settings when field value changes', async () => {
+    const parent = renderParentFieldWithFlowRenderer({ value: 'hello' });
+    const field = parent.subModels.field as JSEditableFieldModel;
+    const applyFlowSpy = vi.spyOn(field, 'applyFlow');
+
+    await waitFor(() => {
+      expect(screen.getByRole('textbox')).toBeInTheDocument();
+    });
+
+    applyFlowSpy.mockClear();
+
+    await act(async () => {
+      field.setProps({ value: 'hello1' });
+    });
+
+    expect(applyFlowSpy).not.toHaveBeenCalled();
+  });
+
+  it('coalesces script and pattern changes into one JavaScript settings run', async () => {
+    const parent = renderParentFieldWithFlowRenderer({ value: 'hello' }, undefined, '');
+    const field = parent.subModels.field as JSEditableFieldModel;
+    const applyFlowSpy = vi.spyOn(field, 'applyFlow');
+
+    await act(async () => {
+      field.setStepParams('jsSettings', 'runJs', { code: READONLY_AWARE_CODE });
+      parent.setProps({ pattern: 'readPretty' });
+      field.scheduleApplyJsSettings();
+    });
+
+    await waitFor(() => {
+      expect(screen.getByTestId('js-readonly-state')).toHaveTextContent('true');
+    });
+
+    expect(applyFlowSpy).toHaveBeenCalledTimes(1);
+    expect(applyFlowSpy).toHaveBeenCalledWith('jsSettings');
+  });
+
+  it('applies JavaScript settings once on initial render', async () => {
+    const applyFlowSpy = vi.spyOn(FlowModel.prototype, 'applyFlow');
+    renderParentFieldWithFlowRenderer({ value: 'hello' });
+
+    try {
+      await waitFor(() => {
+        expect(screen.getByRole('textbox')).toBeInTheDocument();
+      });
+
+      expect(applyFlowSpy).toHaveBeenCalledTimes(1);
+      expect(applyFlowSpy.mock.calls).toEqual([['jsSettings']]);
+    } finally {
+      applyFlowSpy.mockRestore();
+    }
+  });
+});

package/src/flow/system-settings/useSystemSettings.tsx

@@ -7,8 +7,10 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
+import { useFlowEngine } from '@nocobase/flow-engine';
 import { useApp } from '../../flow-compat';
-import { useEffect, useState } from 'react';
+import languageCodes from '../../locale/languageCodes';
+import { useEffect, useMemo, useState } from 'react';
 
 /**
  * 读取系统设置并兼容旧 hook 的返回结构。
@@ -25,7 +27,19 @@ import { useEffect, useState } from 'react';
 export const useSystemSettings = () => {
   const app = useApp();
   const source = app.systemSettings;
+  const flowEngine = useFlowEngine({ throwError: false });
   const [, forceUpdate] = useState(0);
+  const enabledLanguages = source.data?.data?.enabledLanguages;
+  const languageOptions = useMemo(
+    () =>
+      (Array.isArray(enabledLanguages) ? enabledLanguages : [])
+        .filter((code) => languageCodes[code])
+        .map((code) => ({
+          label: languageCodes[code].label,
+          value: code,
+        })),
+    [enabledLanguages],
+  );
 
   useEffect(() => {
     void source.load();
@@ -34,6 +48,27 @@ export const useSystemSettings = () => {
     });
   }, [source]);
 
+  useEffect(() => {
+    if (!flowEngine) {
+      return;
+    }
+
+    flowEngine.context.defineProperty('locale', {
+      get: (ctx) => ctx.api?.auth?.locale || ctx.i18n?.language,
+      cache: false,
+      meta: {
+        type: 'string',
+        title: '{{t("Current language")}}',
+        sort: 970,
+        interface: 'select',
+        uiSchema: {
+          enum: languageOptions,
+          'x-component': 'Select',
+        },
+      },
+    });
+  }, [flowEngine, languageOptions]);
+
   return {
     loading: source.loading,
     data: source.data,