@neeloong/form 0.6.2 → 0.8.0

package/README.md

@@ -196,17 +196,25 @@ render(store, layouts, app);
    - `$min` 只读属性
    - `$max` 只读属性
    - `$step` 只读属性
+   - `$minLength` 只读属性
+   - `$maxLength` 只读属性
+   - `$pattern` 只读属性
    - `$values` 只读属性
    - `$type` 只读属性
    - `$meta` 只读属性
    - `$component` 只读属性
    - `$kind` 只读属性
+   - `$error` 只读属性
+   - `$errors` 只读属性
 1. 数组字段扩展隐式函数（只在事件中可用）
    - `$insert(index, value)`
    - `$add(value)`
    - `$remove(index)`
    - `$move(from, to)`
    - `$exchange(a, b)`
+   - `$reset()`
+   - `$validate()`
+   - `$validate(true)`
 1. 数组成员字段扩展隐式属性
    - `$upMovable` 只读属性
    - `$downMovable` 只读属性

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.6.2
+* @neeloong/form v0.8.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -108,6 +108,7 @@ declare namespace Component {
         events: [string, ($event: any) => void, AddEventListenerOptions][];
         tagAttrs: Record<string, any>;
         watchAttr: (name: any, fn: (value: any, old: any, name: string) => void) => () => void;
+        relate: (el: Element) => () => void;
         destroyed: boolean;
         init: boolean;
         listen: <K extends keyof Component.Context.Events>(event: K, listener: (...p: Component.Context.Events[K]) => void) => () => void;
@@ -173,35 +174,38 @@ declare namespace Schema {
         component?: any;
         immutable?: boolean | undefined;
         creatable?: boolean | undefined;
-        hidden?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
-        clearable?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
-        required?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
-        disabled?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
-        readonly?: boolean | ((store: Store, root: Store) => boolean) | null | undefined;
+        hidden?: boolean | ((store: Store) => boolean) | null | undefined;
+        clearable?: boolean | ((store: Store) => boolean) | null | undefined;
+        required?: boolean | ((store: Store) => boolean) | null | undefined;
+        disabled?: boolean | ((store: Store) => boolean) | null | undefined;
+        readonly?: boolean | ((store: Store) => boolean) | null | undefined;
         /**
          * 字段标签
          */
-        label?: string | ((store: Store, root: Store) => string) | null | undefined;
+        label?: string | ((store: Store) => string | null) | null | undefined;
         /**
          * 字段描述
          */
-        description?: string | ((store: Store, root: Store) => string) | null | undefined;
+        description?: string | ((store: Store) => string | null) | null | undefined;
         /**
          * 占位符
          */
-        placeholder?: string | ((store: Store, root: Store) => string) | null | undefined;
+        placeholder?: string | ((store: Store) => string | null) | null | undefined;
         /**
          * 日期、时间、数字的最小值
          */
-        min?: number | ((store: Store, root: Store) => number) | null | undefined;
+        min?: number | ((store: Store) => number | null) | null | undefined;
         /**
          * 日期、时间、数字的最大值
          */
-        max?: number | ((store: Store, root: Store) => number) | null | undefined;
+        max?: number | ((store: Store) => number | null) | null | undefined;
         /**
          * 日期、时间、数字的步长
          */
-        step?: number | ((store: Store, root: Store) => number) | null | undefined;
+        step?: number | ((store: Store) => number | null) | null | undefined;
+        minLength?: number | ((store: Store) => number | null) | null | undefined;
+        maxLength?: number | ((store: Store) => number | null) | null | undefined;
+        pattern?: RegExp | ((store: Store) => RegExp | null) | null | undefined;
         /**
          * 可选值
          */
@@ -213,10 +217,24 @@ declare namespace Schema {
             focus?: ((this: Store, value: Event, store: Store) => void | boolean | null) | null | undefined;
             blur?: ((this: Store, value: Event, store: Store) => void | boolean | null) | null | undefined;
         } | undefined;
+        validator?: Validator | Validator[] | null | undefined;
+        validators?: {
+            change?: AsyncValidator | AsyncValidator[] | null | undefined;
+            blur?: AsyncValidator | AsyncValidator[] | null | undefined;
+        } | undefined;
     };
 }
+type Validator = (store: Store) => string | string[] | void | null;
+type AsyncValidator = (store: Store, signal: AbortSignal) => PromiseLike<string | string[] | void | null> | string | string[] | void | null;
+
+declare const ref: unique symbol;
+type Ref = {
+    [ref]: Store;
+    [k: string]: Ref | undefined;
+};
 
-/** @import { Schema } from '../types.mjs' */
+/** @import { Ref } from './ref.mjs' */
+/** @import { AsyncValidator, Schema, Validator } from '../types.mjs' */
 /**
  * @template [T=any]
  */
@@ -228,10 +246,17 @@ declare class Store<T = any> {
      */
     static create(schema: Schema, options?: {
         new?: boolean | undefined;
-    }): ObjectStore;
+    }): Store<any>;
+    /**
+     * @param {string} type
+     * @param {{new(...p: ConstructorParameters<typeof Store>): Store}} Class
+     */
+    static setStore(type: string, Class: {
+        new (...p: ConstructorParameters<typeof Store>): Store;
+    }): void;
     /**
      * @param {Schema.Field} schema
-     * @param {object} options
+     * @param {object} [options]
      * @param {*} [options.parent]
      * @param {*} [options.state]
      * @param {number | string | null} [options.index]
@@ -250,15 +275,23 @@ declare class Store<T = any> {
      * @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 {Validator | Validator[] | null} [options.validator]
+     * @param {{[k in keyof Schema.Events]?: AsyncValidator | AsyncValidator[] | null}} [options.validators]
+     *
+     * @param {Ref?} [options.ref]
      *
      * @param {((value: any) => any)?} [options.setValue]
      * @param {((value: any) => any)?} [options.setState]
      * @param {((value: any, state: any) => [value: any, state: any])?} [options.convert]
-     * @param {((value: T?, index: any) => void)?} [options.onUpdate]
-     * @param {((value: T?, index: any) => void)?} [options.onUpdateState]
+     *
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdateState]
      */
-    constructor(schema: Schema.Field, { null: isNull, state, setValue, setState, convert, onUpdate, onUpdateState, index, length, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, label, description, placeholder, min, max, step, values }: {
+    constructor(schema: Schema.Field, { null: isNull, state, ref, setValue, setState, convert, onUpdate, onUpdateState, validator, validators, index, length, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, label, description, placeholder, min, max, step, minLength, maxLength, pattern, values }?: {
         parent?: any;
         state?: any;
         index?: string | number | null | undefined;
@@ -276,12 +309,24 @@ declare class Store<T = any> {
         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?: Validator | Validator[] | null | undefined;
+        validators?: {
+            input?: AsyncValidator | AsyncValidator[] | null | undefined;
+            change?: AsyncValidator | AsyncValidator[] | null | undefined;
+            click?: AsyncValidator | AsyncValidator[] | null | undefined;
+            focus?: AsyncValidator | AsyncValidator[] | null | undefined;
+            blur?: AsyncValidator | AsyncValidator[] | null | undefined;
+        } | undefined;
+        ref?: Ref | null | undefined;
         setValue?: ((value: any) => any) | null | undefined;
         setState?: ((value: any) => any) | null | undefined;
         convert?: ((value: any, state: any) => [value: any, state: any]) | null | undefined;
-        onUpdate?: ((value: T | null, index: any) => void) | null | undefined;
-        onUpdateState?: ((value: T | null, index: any) => void) | null | undefined;
+        onUpdate?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+        onUpdateState?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
     });
     /**
      *
@@ -300,6 +345,7 @@ declare class Store<T = any> {
     listen<K extends keyof Schema.Events>(event: K, listener: (this: this, p: Schema.Events[K], store: this) => void | boolean | null): () => void;
     get null(): boolean;
     get kind(): string;
+    get ref(): Ref;
     schema: Schema.Field;
     get store(): this;
     get parent(): Store<any> | null;
@@ -361,10 +407,24 @@ declare class Store<T = any> {
     get selfStep(): number | null;
     set step(v: number | null);
     get step(): number | null;
+    set selfMinLength(v: number | null);
+    get selfMinLength(): number | null;
+    set minLength(v: number | null);
+    get minLength(): number | null;
+    set selfMaxLength(v: number | null);
+    get selfMaxLength(): number | null;
+    set maxLength(v: number | null);
+    get maxLength(): number | null;
+    set selfPattern(v: RegExp | null);
+    get selfPattern(): RegExp | null;
+    set pattern(v: RegExp | null);
+    get pattern(): RegExp | null;
     set selfValues(v: (Schema.Value | Schema.Value.Group)[] | null);
     get selfValues(): (Schema.Value | Schema.Value.Group)[] | null;
     set values(v: (Schema.Value | Schema.Value.Group)[] | null);
     get values(): (Schema.Value | Schema.Value.Group)[] | null;
+    get errors(): string[];
+    get error(): string;
     /**
      *
      * @param {string | number} key
@@ -372,62 +432,53 @@ declare class Store<T = any> {
      */
     child(key: string | number): Store | null;
     get changed(): boolean;
-    get saved(): boolean;
     set value(v: T | null);
     get value(): T | null;
     set state(v: any);
     get state(): any;
-    get destroyed(): boolean;
-    destroy(): void;
-    /** @returns {IterableIterator<[key: string | number, value: Store]>} */
-    [Symbol.iterator](): IterableIterator<[key: string | number, value: Store]>;
-    #private;
-}
-declare class ObjectStore extends Store<any> {
+    reset(value?: T | null): void;
     /**
-     * @param {Schema.Object & Schema.Attr} schema
-     * @param {object} [options]
-     * @param {Store?} [options.parent]
-     * @param {string | number} [options.index]
-     * @param {boolean} [options.new]
-     * @param {(value: any, index: any) => void} [options.onUpdate]
-     * @param {(value: any, index: any) => void} [options.onUpdateState]
+     *
+     * @overload
+     * @param {null} [path]
+     * @returns {Promise<string[] | null>}
      */
-    constructor(schema: Schema.Object & Schema.Attr, { parent, index, new: isNew, onUpdate, onUpdateState }?: {
-        parent?: Store<any> | null | undefined;
-        index?: string | number | undefined;
-        new?: boolean | undefined;
-        onUpdate?: ((value: any, index: any) => void) | undefined;
-        onUpdateState?: ((value: any, index: any) => void) | undefined;
-    });
-    [Symbol.iterator](): Generator<[string, Store<any>], void, unknown>;
+    validate(path?: null | undefined): Promise<string[] | null>;
+    /**
+     * @overload
+     * @param {(string | number)[]} path
+     * @returns {Promise<{ path: (string | number)[]; store: Store; errors: string[]}[]>}
+     */
+    validate(path: (string | number)[]): Promise<{
+        path: (string | number)[];
+        store: Store;
+        errors: string[];
+    }[]>;
+    /** @returns {IterableIterator<[key: string | number, value: Store]>} */
+    [Symbol.iterator](): IterableIterator<[key: string | number, value: Store]>;
     #private;
 }
 
 /**
- * @overload
- * @param {Store} store
- * @param {(Layout.Node | string)[]} layouts
- * @param {Element} parent
- * @param {Record<string, Store | {get?(): any; set?(v: any): void; exec?(...p: any[]): any; calc?(...p: any[]): any }>} [global]
- * @param {(path: string[]) => Component?} [components]
- * @returns {() => void}
- */
-declare function _default(store: Store, layouts: (Node | string)[], parent: Element, global?: Record<string, Store<any> | {
-    get?(): any;
-    set?(v: any): void;
-    exec?(...p: any[]): any;
-    calc?(...p: any[]): any;
-}> | undefined, components?: ((path: string[]) => Component | null) | undefined): () => void;
-/**
- * @overload
  * @param {Store} store
  * @param {(Layout.Node | string)[]} layouts
  * @param {Element} parent
- * @param {Component.Getter?} [components]
+ * @param {object} [options]
+ * @param {Record<string, Store | {get?(): any; set?(v: any): void; exec?(...p: any[]): any; calc?(...p: any[]): any }>} [options.global]
+ * @param {(path: string[]) => Component?} [options.component]
+ * @param {(store: Store, el: Element) => () => void} [options.relate]
  * @returns {() => void}
  */
-declare function _default(store: Store, layouts: (Node | string)[], parent: Element, components?: Component.Getter | null | undefined): () => void;
+declare function _default(store: Store, layouts: (Node | string)[], parent: Element, { component, global, relate }?: {
+    global?: Record<string, Store<any> | {
+        get?(): any;
+        set?(v: any): void;
+        exec?(...p: any[]): any;
+        calc?(...p: any[]): any;
+    }> | undefined;
+    component?: ((path: string[]) => Component | null) | undefined;
+    relate?: ((store: Store, el: Element) => () => void) | undefined;
+}): () => void;
 
 /**
  * 创建可赋值计算值
@@ -446,4 +497,4 @@ declare function watch<T>(getter: () => T, callback: (value: T) => void, immedia
  */
 declare function effect(fn: () => void): () => void;
 
-export { Component, index_d as Layout, Schema, Store, type VerifyError, effect, _default as render, watch };
+export { type AsyncValidator, Component, index_d as Layout, type Ref, Schema, Store, type Validator, type VerifyError, effect, _default as render, watch };