@neeloong/form 0.28.0 → 0.30.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.28.0
+* @neeloong/form v0.30.0
 * (c) 2024-2026 Fierflame
 * @license Apache-2.0
 */
@@ -135,20 +135,37 @@ declare namespace StoreLayout {
     type Renderer<T_1 = unknown> = (store: Store<any, any, any>, renderer?: T_1 | string, options?: StoreLayout.Options | null) => HTMLElement | null;
 }
 
+type MaybePromise<T> = PromiseLike<T> | T;
 type Schema<M = any, S extends {
     [x: string]: Schema.State;
 } = {
     [x: string]: Schema.State;
 }> = Record<string, Schema.Field<M, S>>;
 declare namespace Schema {
+    type ValidatorResult = string | string[] | void | null;
     /**
      * 同步验证器
      */
-    type Validator = (store: Store) => string | string[] | void | null;
+    type SyncValidator = (store: Store) => Schema.ValidatorResult;
     /**
      * 异步验证器
      */
-    type AsyncValidator = (store: Store, signal: AbortSignal) => PromiseLike<string | string[] | void | null> | string | string[] | void | null;
+    type AsyncValidator = (store: Store, signal: AbortSignal) => MaybePromise<Schema.ValidatorResult>;
+    /**
+     * 事件验证器
+     */
+    type EventValidator = {
+        event: string;
+        validator: Schema.AsyncValidator;
+    };
+    /**
+     * 即刻验证器
+     */
+    type InstantValidator = {
+        event?: null | undefined;
+        validator: Schema.SyncValidator;
+    };
+    type Validator = Schema.InstantValidator | Schema.EventValidator | Schema.SyncValidator;
     /**
      * 字段定义
      */
@@ -392,13 +409,6 @@ declare namespace Schema {
          * 同步验证器
          */
         validator?: Schema.Validator | Schema.Validator[] | null | undefined;
-        /**
-         * 异步验证器
-         */
-        validators?: {
-            change?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-            blur?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-        } | undefined;
         layout?: StoreLayout.Field<any> | undefined;
     };
     type State = string | boolean | number | Object | null;
@@ -410,31 +420,6 @@ type Ref = {
     [k: string]: Ref | undefined;
 };
 
-/** @import { Schema } from '../Schema.types.mjs' */
-/**
- * @template [T=any]
- * @template [M=any]
- * @template {Object.<string, Schema.State>} [S=Object.<string, Schema.State>]
- * @extends {Store<T, M, S>}
- */
-declare class BindObjectStore<T = any, M = any, S extends {
-    [x: string]: Schema.State;
-} = {
-    [x: string]: Schema.State;
-}> extends Store<T, M, S> {
-    /**
-     * @param {Schema<any, Object.<string, Schema.State>>} schema 数据结构模式
-     * @param {Store<T, M, S>} store
-     */
-    constructor(schema: Schema<any, {
-        [x: string]: Schema.State;
-    }>, store: Store<T, M, S>);
-    [Symbol.iterator](): Generator<[string, Store<any, any, {
-        [x: string]: Schema.State;
-    }>], void, unknown>;
-    #private;
-}
-
 /** @import { Ref } from './ref.mjs' */
 /** @import { Schema } from '../Schema.types.mjs' */
 /** @import { StoreLayout } from '../StoreLayout.types.mjs' */
@@ -476,95 +461,9 @@ declare class Store<T = any, M = any, S extends {
     }): void;
     /**
      * @param {Schema.Field<M, S> | Store<T,M,S>} schema 字段的 Schema 定义
-     * @param {object} [options] 可选配置
-     * @param {Store?} [options.parent]
-     * @param {Partial<S>?} [options.states]
-     * @param {((store: Store, value?: any) => any) | object | number | string | boolean | null | undefined} [options.default]
-     * @param {number | string | null} [options.index]
-     * @param {number | Signal.State<number> | Signal.Computed<number>} [options.size]
-     * @param {boolean} [options.null]
-     * @param {boolean} [options.new]
-     * @param {boolean} [options.hidden]
-     * @param {boolean} [options.clearable]
-     * @param {boolean} [options.required]
-     * @param {boolean} [options.disabled]
-     * @param {boolean} [options.readonly]
-     * @param {boolean} [options.removable]
-     *
-     * @param {string} [options.label] 字段标签
-     * @param {string} [options.description] 字段描述
-     * @param {string} [options.placeholder] 占位符
-     * @param {number} [options.min] 日期、时间、数字的最小值
-     * @param {number} [options.max] 日期、时间、数字的最大值
-     * @param {number} [options.step] 日期、时间、数字的步长
-     * @param {number} [options.minLength]
-     * @param {number} [options.maxLength]
-     * @param {RegExp} [options.pattern]
-     * @param {(Schema.Value.Group | Schema.Value | string | number)[]} [options.values] 可选值
-     * @param {Schema.Validator | Schema.Validator[] | null} [options.validator]
-     * @param {{[k in keyof Schema.Events]?: Schema.AsyncValidator | Schema.AsyncValidator[] | null}} [options.validators]
-     *
-     * @param {Ref?} [options.ref]
-     *
-     * @param {((value: any) => any)?} [options.setValue]
-     * @param {((value: any) => any)?} [options.convert]
-     *
-     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
+     * @param {StoreOptions | AbortSignal | null} [options] 可选配置
      */
-    constructor(schema: Schema.Field<M, S> | Store<T, M, S>, { null: isNull, ref, default: defaultValue, setValue, convert, onUpdate, states, validator, validators, index, size, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, removable, label, description, placeholder, min, max, step, minLength, maxLength, pattern, values }?: {
-        parent?: Store<any, any, {
-            [x: string]: Schema.State;
-        }> | null | undefined;
-        states?: Partial<S> | null | undefined;
-        default?: ((store: Store, value?: any) => any) | object | number | string | boolean | null | undefined;
-        index?: string | number | null | undefined;
-        size?: number | Signal.State<number> | Signal.Computed<number> | undefined;
-        null?: boolean | undefined;
-        new?: boolean | undefined;
-        hidden?: boolean | undefined;
-        clearable?: boolean | undefined;
-        required?: boolean | undefined;
-        disabled?: boolean | undefined;
-        readonly?: boolean | undefined;
-        removable?: boolean | undefined;
-        label?: string | undefined;
-        description?: string | undefined;
-        placeholder?: string | undefined;
-        min?: number | undefined;
-        max?: number | undefined;
-        step?: number | undefined;
-        minLength?: number | undefined;
-        maxLength?: number | undefined;
-        pattern?: RegExp | undefined;
-        values?: (string | number | Schema.Value | Schema.Value.Group)[] | undefined;
-        validator?: Schema.Validator | Schema.Validator[] | null | undefined;
-        validators?: {
-            /**
-             * 输入
-             */
-            input?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-            /**
-             * 变化
-             */
-            change?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-            /**
-             * 点击
-             */
-            click?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-            /**
-             * 聚焦
-             */
-            focus?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-            /**
-             * 失焦
-             */
-            blur?: Schema.AsyncValidator | Schema.AsyncValidator[] | null | undefined;
-        } | undefined;
-        ref?: Ref | null | undefined;
-        setValue?: ((value: any) => any) | null | undefined;
-        convert?: ((value: any) => any) | null | undefined;
-        onUpdate?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
-    });
+    constructor(schema: Schema.Field<M, S> | Store<T, M, S>, options?: StoreOptions | AbortSignal | null);
     get schema(): Schema.Field<M, S>;
     /**
      * 触发事件并通知监听器
@@ -577,11 +476,21 @@ declare class Store<T = any, M = any, S extends {
     /**
      * 监听事件
      * @template {keyof Schema.Events} K
+     * @overload
      * @param {K} event
      * @param  {(this: this, p: Schema.Events[K], store: this) => void | boolean | null} listener
      * @returns {() => void}
      */
     listen<K extends keyof Schema.Events>(event: K, listener: (this: this, p: Schema.Events[K], store: this) => void | boolean | null): () => void;
+    /**
+     * 监听事件
+     * @template {keyof Schema.Events} K
+     * @overload
+     * @param {string} event
+     * @param  {(this: this, p: unknown, store: this) => void | boolean | null} listener
+     * @returns {() => void}
+     */
+    listen<K extends keyof Schema.Events>(event: string, listener: (this: this, p: unknown, store: this) => void | boolean | null): () => void;
     /** 是否为无效空存储 */
     get null(): boolean;
     /** 存储类类别，继承的自定义类需要设置自定义的此只读属性 */
@@ -722,18 +631,6 @@ declare class Store<T = any, M = any, S extends {
      * @returns {Store?}
      */
     child(key: string | number): Store | null;
-    /**
-     * @template [M=any]
-     * @template {Object.<string, Schema.State>} [S=Object.<string, Schema.State>]
-     * @param {Schema<M, S>} schema 数据结构模式
-     * @param {AbortSignal} [signal]
-     * @returns {BindObjectStore}
-     */
-    bindObject<M_1 = any, S_1 extends {
-        [x: string]: Schema.State;
-    } = {
-        [x: string]: Schema.State;
-    }>(schema: Schema<M_1, S_1>, signal?: AbortSignal): BindObjectStore;
     /** 内容是否已改变 */
     get changed(): boolean;
     set value(v: T | null);
@@ -763,6 +660,63 @@ declare class Store<T = any, M = any, S extends {
     [Symbol.iterator](): IterableIterator<[key: string | number, value: Store]>;
     #private;
 }
+type StoreOptions<T = any, M = any, S extends {
+    [x: string]: Schema.State;
+} = {
+    [x: string]: Schema.State;
+}> = {
+    parent?: Store<any, any, {
+        [x: string]: Schema.State;
+    }> | null | undefined;
+    states?: Partial<S> | null | undefined;
+    default?: ((store: Store, value?: any) => any) | object | number | string | boolean | null | undefined;
+    index?: string | number | null | undefined;
+    size?: number | Signal.State<number> | Signal.Computed<number> | undefined;
+    null?: boolean | undefined;
+    new?: boolean | undefined;
+    hidden?: boolean | undefined;
+    clearable?: boolean | undefined;
+    required?: boolean | undefined;
+    disabled?: boolean | undefined;
+    readonly?: boolean | undefined;
+    removable?: boolean | undefined;
+    /**
+     * 字段标签
+     */
+    label?: string | undefined;
+    /**
+     * 字段描述
+     */
+    description?: string | undefined;
+    /**
+     * 占位符
+     */
+    placeholder?: string | undefined;
+    /**
+     * 日期、时间、数字的最小值
+     */
+    min?: number | undefined;
+    /**
+     * 日期、时间、数字的最大值
+     */
+    max?: number | undefined;
+    /**
+     * 日期、时间、数字的步长
+     */
+    step?: number | undefined;
+    minLength?: number | undefined;
+    maxLength?: number | undefined;
+    pattern?: RegExp | undefined;
+    /**
+     * 可选值
+     */
+    values?: (string | number | Schema.Value | Schema.Value.Group)[] | undefined;
+    validator?: Schema.Validator | Schema.Validator[] | null | undefined;
+    ref?: Ref | null | undefined;
+    setValue?: ((value: any) => any) | null | undefined;
+    convert?: ((value: any) => any) | null | undefined;
+    onUpdate?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+};
 
 /** @import { Schema } from '../Schema.types.mjs' */
 /**
@@ -879,6 +833,32 @@ declare class ArrayStore<T = any, M = any, S extends {
     #private;
 }
 
+/** @import { Schema } from '../Schema.types.mjs' */
+/**
+ * @template [T=any]
+ * @template [M=any]
+ * @template {Object.<string, Schema.State>} [S=Object.<string, Schema.State>]
+ * @extends {Store<T, M, S>}
+ */
+declare class BindObjectStore<T = any, M = any, S extends {
+    [x: string]: Schema.State;
+} = {
+    [x: string]: Schema.State;
+}> extends Store<T, M, S> {
+    /**
+     * @param {Schema<any, Object.<string, Schema.State>>} schema 数据结构模式
+     * @param {Store<T, M, S>} store
+     * @param {AbortSignal} [signal]
+     */
+    constructor(schema: Schema<any, {
+        [x: string]: Schema.State;
+    }>, store: Store<T, M, S>, signal?: AbortSignal);
+    [Symbol.iterator](): Generator<[string, Store<any, any, {
+        [x: string]: Schema.State;
+    }>], void, unknown>;
+    #private;
+}
+
 /**
  * 解析模板内容
  * @param {string} source 输入源字符串
@@ -1486,4 +1466,4 @@ declare function renderStore<T>(store: Store, fieldRenderer: StoreLayout.Rendere
     clone?: boolean;
 }) | null): void;
 
-export { ArrayStore, Component, Enhancement, index_d as Layout, ObjectStore, type Ref, Schema, Store, StoreLayout, effect, render, renderStore, watch };
+export { ArrayStore, BindObjectStore, Component, Enhancement, index_d as Layout, type MaybePromise, ObjectStore, type Ref, Schema, Store, StoreLayout, type StoreOptions, effect, render, renderStore, watch };