amis-core 6.14.0-beta.1 → 6.14.0-beta.11

package/lib/renderers/Form.d.ts

@@ -1,10 +1,10 @@
-/// <reference types="lodash" />
 import React from 'react';
 import { RendererProps } from '../factory';
 import { IFormStore } from '../store/form';
-import { SchemaNode, ActionObject, ClassName, BaseApiObject, SchemaExpression, SchemaClassName, DataChangeReason } from '../types';
+import { SchemaNode, ActionObject, DataChangeReason } from '../types';
 import { IScopedContext } from '../Scoped';
 import type { LabelAlign } from './Item';
+import { AMISApi, AMISClassName, AMISDefaultData, AMISExpression, AMISSchemaCollection, AMISSchemaBase, AMISButtonSchema } from '../schema';
 export interface FormHorizontal {
     left?: number;
     right?: number;
@@ -15,7 +15,7 @@ export interface FormHorizontal {
     labelWidth?: number | string;
     labelOverflow?: 'default' | 'ellipsis';
 }
-export interface FormSchemaBase {
+export interface AMISFormBase extends AMISSchemaBase {
     /**
      * 表单标题
      */
@@ -23,11 +23,12 @@ export interface FormSchemaBase {
     /**
      * 按钮集合，会固定在底部显示。
      */
-    actions?: Array<any>;
+    actions?: Array<AMISButtonSchema>;
     /**
      * 表单项集合
      */
-    body?: any;
+    body?: AMISSchemaCollection;
+    className?: AMISClassName;
     /**
      * @deprecated 请用类型 tabs
      */
@@ -36,7 +37,7 @@ export interface FormSchemaBase {
      * @deprecated 请用类型 fieldSet
      */
     fieldSet?: any;
-    data?: any;
+    data?: AMISDefaultData;
     /**
      * 是否开启调试，开启后会在顶部实时显示表单项数据。
      */
@@ -74,11 +75,11 @@ export interface FormSchemaBase {
     /**
      * 用来初始化表单数据
      */
-    initApi?: string | BaseApiObject;
+    initApi?: AMISApi;
     /**
      * Form 用来获取初始数据的 api,与initApi不同的是，会一直轮询请求该接口，直到返回 finished 属性为 true 才 结束。
      */
-    initAsyncApi?: string | BaseApiObject;
+    initAsyncApi?: AMISApi;
     /**
      * 设置了initAsyncApi后，默认会从返回数据的data.finished来判断是否完成，也可以设置成其他的xxx，就会从data.xxx中获取
      */
@@ -94,7 +95,7 @@ export interface FormSchemaBase {
     /**
      * 建议改成 api 的 sendOn 属性。
      */
-    initFetchOn?: string;
+    initFetchOn?: AMISExpression;
     /**
      * 设置后将轮询调用 initApi
      */
@@ -106,7 +107,7 @@ export interface FormSchemaBase {
     /**
      * 配置停止轮询的条件
      */
-    stopAutoRefreshWhen?: string;
+    stopAutoRefreshWhen?: AMISExpression;
     /**
      * 是否开启本地缓存
      */
@@ -124,7 +125,7 @@ export interface FormSchemaBase {
      *
      * 详情：https://aisuda.bce.baidu.com/amis/zh-CN/components/form/index#%E8%A1%A8%E5%8D%95%E6%8F%90%E4%BA%A4
      */
-    api?: string | BaseApiObject;
+    api?: AMISApi;
     /**
      * Form 也可以配置 feedback。
      */
@@ -132,7 +133,7 @@ export interface FormSchemaBase {
     /**
      * 设置此属性后，表单提交发送保存接口后，还会继续轮询请求该接口，直到返回 finished 属性为 true 才 结束。
      */
-    asyncApi?: string | BaseApiObject;
+    asyncApi?: AMISApi;
     /**
      * 轮询请求的时间间隔，默认为 3秒。设置 asyncApi 才有效
      */
@@ -178,7 +179,7 @@ export interface FormSchemaBase {
     /**
      * 配置容器 panel className
      */
-    panelClassName?: ClassName;
+    panelClassName?: AMISClassName;
     /**
      * 设置主键 id, 当设置后，检测表单是否完成时（asyncApi），只会携带此数据。
      * @default id
@@ -242,14 +243,29 @@ export interface FormSchemaBase {
      * 展示态时的className
      */
     static?: boolean;
-    staticOn?: SchemaExpression;
-    staticClassName?: SchemaClassName;
+    staticOn?: AMISExpression;
+    staticClassName?: AMISClassName;
     /**
      * 是否可以访问上层数据，默认是会允许，这样顶层同名数据会自动赋值到同名表单项
      * @default true
      */
     canAccessSuperData?: boolean;
 }
+export type FormSchemaBase = AMISFormBase;
+/**
+ * 表单容器组件，用于收集和提交用户输入数据。支持字段验证、数据提交、布局配置等。
+ */
+export interface AMISFormSchema extends AMISFormBase {
+    /**
+     * 指定为表单渲染器
+     */
+    type: 'form';
+}
+declare module '../schema' {
+    interface AMISSchemaRegistry {
+        form: AMISFormSchema;
+    }
+}
 export type FormGroup = FormSchemaBase & {
     title?: string;
     className?: string;
@@ -339,7 +355,7 @@ export default class Form extends React.Component<FormProps, object> {
     getNormalizedRules(): {
         message: any;
         rule: string;
-        name?: string | string[] | undefined;
+        name?: string | Array<string>;
     }[];
     dispatchInited(value: any): Promise<any>;
     blockRouting(): any;
@@ -366,7 +382,7 @@ export default class Form extends React.Component<FormProps, object> {
     handleChange(value: any, name: string, submit: boolean, changePristine?: boolean, changeReason?: DataChangeReason): void;
     jumpToErrorComponent(renderer: any): void;
     dispatchEvent(e: React.MouseEvent<any> | string, data: any, renderer?: React.Component<RendererProps>, // for didmount
-    scoped?: IScopedContext): Promise<import("../utils").RendererEvent<any, any>>;
+    scoped?: IScopedContext): Promise<import("../utils").RendererEvent<any>>;
     emittedData: any;
     emitting: boolean;
     emitChange(submit: boolean, emitedFromWatch?: boolean): Promise<void>;
@@ -383,7 +399,15 @@ export default class Form extends React.Component<FormProps, object> {
     reloadTarget(target: string, data?: any): void;
     closeTarget(target: string): void;
     openFeedback(dialog: any, ctx: any): Promise<unknown>;
-    buildActions(): any[] | undefined;
+    buildActions(): AMISButtonSchema[] | {
+        type: string;
+        label: any;
+        primary: boolean;
+        loadingConfig: {
+            root?: string;
+            show?: boolean;
+        } | undefined;
+    }[] | undefined;
     renderFormItems(schema: Partial<FormSchemaBase> & {
         controls?: Array<any>;
     }, region?: string, otherProps?: Partial<FormProps>): React.ReactNode;

package/lib/renderers/Form.js

@@ -1,5 +1,5 @@
 /**
- * amis-core v6.14.0-beta.1
+ * amis-core v6.14.0-beta.11
  * Copyright 2018-2025 fex
  */
 
@@ -240,17 +240,17 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
             .filter(function (item) { return item.rule && typeof item.rule === 'string'; });
     };
     Form.prototype.dispatchInited = function (value) {
-        var _a;
         return tslib.__awaiter(this, void 0, void 0, function () {
-            var _b, data, store, dispatchEvent, result;
+            var _a, data, store, dispatchEvent, result;
+            var _b;
             return tslib.__generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:
-                        _b = this.props, data = _b.data, store = _b.store, dispatchEvent = _b.dispatchEvent;
+                        _a = this.props, data = _a.data, store = _a.store, dispatchEvent = _a.dispatchEvent;
                         if (!mobxStateTree.isAlive(store) || store.fetching) {
                             return [2 /*return*/, value];
                         }
-                        return [4 /*yield*/, dispatchEvent('inited', object.createObject(data, tslib.__assign(tslib.__assign({}, value === null || value === void 0 ? void 0 : value.data), { responseData: (_a = value === null || value === void 0 ? void 0 : value.data) !== null && _a !== void 0 ? _a : {}, responseStatus: store.error ? 1 : 0, responseMsg: store.msg })))];
+                        return [4 /*yield*/, dispatchEvent('inited', object.createObject(data, tslib.__assign(tslib.__assign({}, value === null || value === void 0 ? void 0 : value.data), { responseData: (_b = value === null || value === void 0 ? void 0 : value.data) !== null && _b !== void 0 ? _b : {}, responseStatus: store.error ? 1 : 0, responseMsg: store.msg })))];
                     case 1:
                         result = _c.sent();
                         return [2 /*return*/, result];
@@ -418,12 +418,12 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
     Form.prototype.isValidated = function () {
         return this.props.store.validated;
     };
-    Form.prototype.validate = function (forceValidate, throwErrors, toastErrors, skipFlush) {
-        if (throwErrors === void 0) { throwErrors = false; }
-        if (toastErrors === void 0) { toastErrors = true; }
-        if (skipFlush === void 0) { skipFlush = false; }
-        return tslib.__awaiter(this, void 0, void 0, function () {
+    Form.prototype.validate = function (forceValidate_1) {
+        return tslib.__awaiter(this, arguments, void 0, function (forceValidate, throwErrors, toastErrors, skipFlush) {
             var _a, store, dispatchEvent, data, messages, __, result;
+            if (throwErrors === void 0) { throwErrors = false; }
+            if (toastErrors === void 0) { toastErrors = true; }
+            if (skipFlush === void 0) { skipFlush = false; }
             return tslib.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -467,11 +467,11 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
             type: 'action'
         });
     };
-    Form.prototype.submit = function (fn, throwErrors, skipFlush) {
-        if (throwErrors === void 0) { throwErrors = false; }
-        if (skipFlush === void 0) { skipFlush = false; }
-        return tslib.__awaiter(this, void 0, void 0, function () {
+    Form.prototype.submit = function (fn_1) {
+        return tslib.__awaiter(this, arguments, void 0, function (fn, throwErrors, skipFlush) {
             var _a, store, messages, __, dispatchEvent, data, validateErrCb;
+            if (throwErrors === void 0) { throwErrors = false; }
+            if (skipFlush === void 0) { skipFlush = false; }
             return tslib.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -620,10 +620,10 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
         }
         return this.props.dispatchEvent(e, data, renderer, scoped);
     };
-    Form.prototype.emitChange = function (submit, emitedFromWatch) {
-        if (emitedFromWatch === void 0) { emitedFromWatch = false; }
-        return tslib.__awaiter(this, void 0, void 0, function () {
+    Form.prototype.emitChange = function (submit_1) {
+        return tslib.__awaiter(this, arguments, void 0, function (submit, emitedFromWatch) {
             var _a, onChange, store, submitOnChange, dispatchEvent_1, data, originData, diff, changeProps, dispatcher;
+            if (emitedFromWatch === void 0) { emitedFromWatch = false; }
             return tslib.__generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -704,16 +704,16 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
             onReset && onReset(data, action);
         };
     };
-    Form.prototype.handleAction = function (e, action, data, throwErrors, delegate) {
-        var _a, _b;
-        if (throwErrors === void 0) { throwErrors = false; }
-        return tslib.__awaiter(this, void 0, void 0, function () {
-            var _c, store, onSubmit, api$1, asyncApi, finishedField, checkInterval, _d, saveSuccess, saveFailed, resetAfterSubmit, clearAfterSubmit, onAction, onSaved, onReset, onFinished, onFailed, redirect, reload, target, env, onChange, clearPersistDataAfterSubmit, trimValues, dispatchEvent, __, fields, validationRes, dispatcher, _e, dispatchEvent_2, onEvent, submitEvent, dispatcher, successMsg, failMsg;
+    Form.prototype.handleAction = function (e_2, action_1, data_1) {
+        return tslib.__awaiter(this, arguments, void 0, function (e, action, data, throwErrors, delegate) {
+            var _a, store, onSubmit, api$1, asyncApi, finishedField, checkInterval, _b, saveSuccess, saveFailed, resetAfterSubmit, clearAfterSubmit, onAction, onSaved, onReset, onFinished, onFailed, redirect, reload, target, env, onChange, clearPersistDataAfterSubmit, trimValues, dispatchEvent, __, fields, validationRes, dispatcher, _c, dispatchEvent_2, onEvent, submitEvent, dispatcher, successMsg, failMsg;
             var _this = this;
+            var _d, _e;
+            if (throwErrors === void 0) { throwErrors = false; }
             return tslib.__generator(this, function (_f) {
                 switch (_f.label) {
                     case 0:
-                        _c = this.props, store = _c.store, onSubmit = _c.onSubmit, api$1 = _c.api, asyncApi = _c.asyncApi, finishedField = _c.finishedField, checkInterval = _c.checkInterval, _d = _c.messages, saveSuccess = _d.saveSuccess, saveFailed = _d.saveFailed, resetAfterSubmit = _c.resetAfterSubmit, clearAfterSubmit = _c.clearAfterSubmit, onAction = _c.onAction, onSaved = _c.onSaved, onReset = _c.onReset, onFinished = _c.onFinished, onFailed = _c.onFailed, redirect = _c.redirect, reload = _c.reload, target = _c.target, env = _c.env, onChange = _c.onChange, clearPersistDataAfterSubmit = _c.clearPersistDataAfterSubmit, trimValues = _c.trimValues, dispatchEvent = _c.dispatchEvent, __ = _c.translate;
+                        _a = this.props, store = _a.store, onSubmit = _a.onSubmit, api$1 = _a.api, asyncApi = _a.asyncApi, finishedField = _a.finishedField, checkInterval = _a.checkInterval, _b = _a.messages, saveSuccess = _b.saveSuccess, saveFailed = _b.saveFailed, resetAfterSubmit = _a.resetAfterSubmit, clearAfterSubmit = _a.clearAfterSubmit, onAction = _a.onAction, onSaved = _a.onSaved, onReset = _a.onReset, onFinished = _a.onFinished, onFailed = _a.onFailed, redirect = _a.redirect, reload = _a.reload, target = _a.target, env = _a.env, onChange = _a.onChange, clearPersistDataAfterSubmit = _a.clearPersistDataAfterSubmit, trimValues = _a.trimValues, dispatchEvent = _a.dispatchEvent, __ = _a.translate;
                         if (!!action.skipFormFlush) return [3 /*break*/, 2];
                         return [4 /*yield*/, this.flush()];
                     case 1:
@@ -759,8 +759,8 @@ var _J$F_ = (__react_jsx__["default"] || __react_jsx__).Fragment;
                             action.actionType === 'confirm' ||
                             action.actionType === 'reset-and-submit' ||
                             action.actionType === 'clear-and-submit')) return [3 /*break*/, 8];
-                        _e = this.props, dispatchEvent_2 = _e.dispatchEvent, onEvent = _e.onEvent;
-                        submitEvent = (_b = (_a = onEvent === null || onEvent === void 0 ? void 0 : onEvent.submit) === null || _a === void 0 ? void 0 : _a.actions) === null || _b === void 0 ? void 0 : _b.length;
+                        _c = this.props, dispatchEvent_2 = _c.dispatchEvent, onEvent = _c.onEvent;
+                        submitEvent = (_e = (_d = onEvent === null || onEvent === void 0 ? void 0 : onEvent.submit) === null || _d === void 0 ? void 0 : _d.actions) === null || _e === void 0 ? void 0 : _e.length;
                         return [4 /*yield*/, dispatchEvent_2('submit', this.props.data)];
                     case 7:
                         dispatcher = _f.sent();
@@ -1551,10 +1551,10 @@ var FormRendererBase = /** @class */ (function (_super) {
         if (throwErrors === void 0) { throwErrors = false; }
         return this.handleAction(undefined, action, data, throwErrors);
     };
-    FormRendererBase.prototype.handleAction = function (e, action, ctx, throwErrors, delegate) {
-        if (throwErrors === void 0) { throwErrors = false; }
-        return tslib.__awaiter(this, void 0, void 0, function () {
+    FormRendererBase.prototype.handleAction = function (e_2, action_1, ctx_1) {
+        return tslib.__awaiter(this, arguments, void 0, function (e, action, ctx, throwErrors, delegate) {
             var scoped_1;
+            if (throwErrors === void 0) { throwErrors = false; }
             return tslib.__generator(this, function (_a) {
                 // 禁用了不要做任何动作。@先注释掉，会引起其他问题
                 // if (this.props.disabled) {