@neeloong/form 0.13.0 → 0.15.0

package/README.md

@@ -311,6 +311,7 @@ render(store, layouts, app);
    - `$creatable` 只读 值是否可创建（`$new` 为 `true` 时，字段只读）
    - `$immutable` 只读 值是否不可改变（`$new` 为 `false` 时，字段只读）
    - `$new` 只读 是否新建项
+   - `$loading` 只读 加载状态
    - `$readonly` 只读 是否只读
    - `$hidden` 只读 是否可隐藏
    - `$clearable` 只读 是否可清除

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.13.0
+* @neeloong/form v0.15.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -13,7 +13,7 @@ export { Signal } from 'signal-polyfill';
  * @param {Layout.Options} [options] 解析选项
  * @returns {Layout.Child[]}
  */
-declare function parse(source: string, { createCalc, createInit, createEvent, simpleTag, enableHTML, }?: Options): Child[];
+declare function parse(source: string, { createCalc, createInit, createEvent, simpleTag, enableHTML, }?: Options$1): Child[];
 
 /**
  * 增强信息
@@ -39,7 +39,7 @@ type Enhancement$1 = {
 /**
  * 解析选项
  */
-type Options = {
+type Options$1 = {
     /**
      * 启用 `!html` 指令
      */
@@ -349,13 +349,12 @@ type index_d_Enum = Enum;
 type index_d_EventListener = EventListener;
 type index_d_Fragment = Fragment;
 declare const index_d_Node: typeof Node;
-type index_d_Options = Options;
 type index_d_Select = Select;
 type index_d_Template = Template;
 type index_d_Variable<T = unknown> = Variable<T>;
 declare const index_d_parse: typeof parse;
 declare namespace index_d {
-  export { type index_d_Calc as Calc, type index_d_CallTemplate as CallTemplate, type index_d_Child as Child, type index_d_Content as Content, type index_d_Divergent as Divergent, type index_d_DivergentChildren as DivergentChildren, type Enhancement$1 as Enhancement, type index_d_Enum as Enum, type index_d_EventListener as EventListener, type index_d_Fragment as Fragment, index_d_Node as Node, type index_d_Options as Options, type index_d_Select as Select, type index_d_Template as Template, type index_d_Variable as Variable, index_d_parse as parse };
+  export { type index_d_Calc as Calc, type index_d_CallTemplate as CallTemplate, type index_d_Child as Child, type index_d_Content as Content, type index_d_Divergent as Divergent, type index_d_DivergentChildren as DivergentChildren, type Enhancement$1 as Enhancement, type index_d_Enum as Enum, type index_d_EventListener as EventListener, type index_d_Fragment as Fragment, index_d_Node as Node, type Options$1 as Options, type index_d_Select as Select, type index_d_Template as Template, type index_d_Variable as Variable, index_d_parse as parse };
 }
 
 type VerifyError = any;
@@ -586,6 +585,7 @@ declare namespace Schema {
          * 元信息
          */
         meta?: M_1 | undefined;
+        default?: ((store: Store) => any) | any;
         /**
          * 自定义组件
          */
@@ -814,6 +814,7 @@ declare class Store<T = any, M = any> {
      * @param {Schema.Field<M>} schema 字段的 Schema 定义
      * @param {object} [options] 可选配置
      * @param {Store?} [options.parent]
+     * @param {((store: Store) => any) | any} [options.default]
      * @param {*} [options.state]
      * @param {number | string | null} [options.index]
      * @param {number | Signal.State<number> | Signal.Computed<number>} [options.size]
@@ -848,8 +849,9 @@ declare class Store<T = any, M = any> {
      * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
      * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdateState]
      */
-    constructor(schema: Schema.Field<M>, { null: isNull, state, ref, setValue, setState, convert, onUpdate, onUpdateState, validator, validators, index, size, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, removable, label, description, placeholder, min, max, step, minLength, maxLength, pattern, values }?: {
+    constructor(schema: Schema.Field<M>, { null: isNull, state, ref, default: defaultValue, setValue, setState, convert, onUpdate, onUpdateState, 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> | null | undefined;
+        default?: ((store: Store) => any) | any;
         state?: any;
         index?: string | number | null | undefined;
         size?: number | Signal.State<number> | Signal.Computed<number> | undefined;
@@ -922,6 +924,9 @@ declare class Store<T = any, M = any> {
     get kind(): string;
     get ref(): Ref;
     schema: Schema.Field<M>;
+    createDefault(): any;
+    set loading(loading: boolean);
+    get loading(): boolean;
     /** 存储对象自身 */
     get store(): this;
     /** 父级存储对象 */
@@ -1053,17 +1058,17 @@ declare class Store<T = any, M = any> {
     /**
      * 异步校验
      * @overload
-     * @param {null} [path]
+     * @param {true} [path]
      * @returns {Promise<string[] | null>}
      */
-    validate(path?: null | undefined): Promise<string[] | null>;
+    validate(path?: true | undefined): Promise<string[] | null>;
     /**
      * 异步校验
      * @overload
-     * @param {(string | number)[]} path 到当前层级的路径
+     * @param {(string | number)[] | false | null} [path] 到当前层级的路径
      * @returns {Promise<{ path: (string | number)[]; store: Store; errors: string[]}[]>}
      */
-    validate(path: (string | number)[]): Promise<{
+    validate(path?: false | (string | number)[] | null | undefined): Promise<{
         path: (string | number)[];
         store: Store;
         errors: string[];
@@ -1073,6 +1078,122 @@ declare class Store<T = any, M = any> {
     #private;
 }
 
+/** @import { Schema } from '../types.mjs' */
+/**
+ * @template {Record<string, any>} [T=Record<string, any>]
+ * @template [M=any]
+ * @extends {Store<T, M>}
+ */
+declare class ObjectStore<T extends Record<string, any> = Record<string, any>, M = any> extends Store<T, M> {
+    /**
+     * @param {Schema.Object<M> & Schema.Attr<M>} schema
+     * @param {object} [options]
+     * @param {Store?} [options.parent]
+     * @param {number | string | null} [options.index]
+     * @param {boolean} [options.new]
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdate]
+     * @param {((value: T?, index: any, store: Store) => void)?} [options.onUpdateState]
+     */
+    constructor(schema: Schema.Object<M> & Schema.Attr<M>, { parent, index, new: isNew, onUpdate, onUpdateState }?: {
+        parent?: Store<any, any> | null | undefined;
+        index?: string | number | null | undefined;
+        new?: boolean | undefined;
+        onUpdate?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+        onUpdateState?: ((value: T | null, index: any, store: Store) => void) | null | undefined;
+    });
+    [Symbol.iterator](): Generator<[string, Store<any, any>], void, unknown>;
+    #private;
+}
+
+/** @import { Schema } from '../types.mjs' */
+/**
+ * @template [T=any]
+ * @template [M=any]
+ * @extends {Store<(T | null)[], M>}
+ */
+declare class ArrayStore<T = any, M = any> extends Store<(T | null)[], M> {
+    /**
+     * @param {Schema.Field<M>} schema
+     * @param {object} [options]
+     * @param {Store?} [options.parent]
+     * @param {string | number | null} [options.index]
+     * @param {boolean} [options.new]
+     * @param {boolean} [options.addable]
+     * @param {(value: any, index: any, store: Store) => void} [options.onUpdate]
+     * @param {(value: any, index: any, store: Store) => void} [options.onUpdateState]
+     */
+    constructor(schema: Schema.Field<M>, { parent, onUpdate, onUpdateState, index, new: isNew, addable }?: {
+        parent?: Store<any, any> | null | undefined;
+        index?: string | number | null | undefined;
+        new?: boolean | undefined;
+        addable?: boolean | undefined;
+        onUpdate?: ((value: any, index: any, store: Store) => void) | undefined;
+        onUpdateState?: ((value: any, index: any, store: Store) => void) | undefined;
+    });
+    get children(): Store<any, any>[];
+    set selfAddable(v: boolean | null);
+    get selfAddable(): boolean | null;
+    set addable(v: boolean);
+    /** 是否禁用字段 */
+    get addable(): boolean;
+    /**
+     *
+     * @param {number} index
+     * @param {T?} [value]
+     * @param {boolean} [isNew]
+     * @returns
+     */
+    insert(index: number, value?: T | null, isNew?: boolean): boolean;
+    /**
+     *
+     * @param {T?} [value]
+     * @returns
+     */
+    add(value?: T | null): boolean;
+    /**
+     *
+     * @param {number} index
+     * @returns
+     */
+    remove(index: number): T | null | undefined;
+    /**
+     *
+     * @param {number} from
+     * @param {number} to
+     * @returns
+     */
+    move(from: number, to: number): boolean;
+    /**
+     *
+     * @param {number} a
+     * @param {number} b
+     * @returns
+     */
+    exchange(a: number, b: number): boolean;
+    [Symbol.iterator](): Generator<[number, Store<any, any>], undefined, unknown>;
+    #private;
+}
+
+type GridFormItemTemplate = {
+    field: string;
+    subFields?: GridFormTemplate | null | undefined;
+    span: number;
+    headers?: string[] | undefined;
+};
+type GridFormTemplate = GridFormItemTemplate[];
+type Options = object;
+type FieldRenderer = (store: Store<any, any>, component: any, Options: Options) => [HTMLElement, () => void];
+
+/**
+ *
+ * @param {Store} store
+ * @param {HTMLElement} root
+ * @param {FieldRenderer} fieldRenderer
+ * @param {boolean} editable
+ * @param {GridFormTemplate?} [template]
+ */
+declare function _default(store: Store, root: HTMLElement, fieldRenderer: FieldRenderer, editable: boolean, template?: GridFormTemplate | null): () => void;
+
 /**
  * @param {Store} store 存储实例
  * @param {Layout.Child[]} layouts 布局信息
@@ -1113,4 +1234,14 @@ declare function watch<T>(getter: () => T, callback: (value: T) => void, immedia
  */
 declare function effect(fn: () => void): () => void;
 
-export { type AsyncValidator, Component, Enhancement, index_d as Layout, type Ref, type Relatedness, Schema, Store, type Validator, type VerifyError, effect, render, watch };
+/**
+ *
+ * @param {(store: Store<any, any>, component: any) => [HTMLElement, () => void]?} renderField
+ * @param {Store} store
+ * @param {HTMLElement} root
+ * @param {string | ParentNode} [html]
+ * @param {boolean} [clone]
+ */
+declare function renderHtml(renderField: (store: Store<any, any>, component: any) => [HTMLElement, () => void] | null, store: Store, root: HTMLElement, html?: string | ParentNode, clone?: boolean): () => void;
+
+export { ArrayStore, type AsyncValidator, Component, Enhancement, type FieldRenderer, type GridFormItemTemplate, type GridFormTemplate, index_d as Layout, ObjectStore, type Options, type Ref, type Relatedness, Schema, Store, type Validator, type VerifyError, effect, render, _default as renderGrid, renderHtml, watch };