@neeloong/form 0.6.1 → 0.7.0

package/index.d.mts

@@ -1,5 +1,5 @@
 /*!
-* @neeloong/form v0.6.1
+* @neeloong/form v0.7.0
 * (c) 2024-2025 Fierflame
 * @license Apache-2.0
 */
@@ -216,6 +216,13 @@ declare namespace Schema {
     };
 }
 
+declare const ref: unique symbol;
+type Ref = {
+    [ref]: Store;
+    [k: string]: Ref | undefined;
+};
+
+/** @import { Ref } from './ref.mjs' */
 /** @import { Schema } from '../types.mjs' */
 /**
  * @template [T=any]
@@ -228,10 +235,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]
@@ -252,13 +266,16 @@ declare class Store<T = any> {
      * @param {number} [options.step] 日期、时间、数字的步长
      * @param {(Schema.Value.Group | Schema.Value | string | number)[]} [options.values] 可选值
      *
+     * @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, index, length, new: isNew, parent: parentNode, hidden, clearable, required, disabled, readonly, label, description, placeholder, min, max, step, values }?: {
         parent?: any;
         state?: any;
         index?: string | number | null | undefined;
@@ -277,11 +294,12 @@ declare class Store<T = any> {
         max?: number | undefined;
         step?: number | undefined;
         values?: (string | number | Schema.Value | Schema.Value.Group)[] | 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 +318,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;
@@ -372,37 +391,15 @@ 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;
+    reset(value?: T | null): void;
     /** @returns {IterableIterator<[key: string | number, value: Store]>} */
     [Symbol.iterator](): IterableIterator<[key: string | number, value: Store]>;
     #private;
 }
-declare class ObjectStore extends Store<any> {
-    /**
-     * @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]
-     */
-    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>;
-    #private;
-}
 
 /**
  * @overload
@@ -429,4 +426,21 @@ declare function _default(store: Store, layouts: (Node | string)[], parent: Elem
  */
 declare function _default(store: Store, layouts: (Node | string)[], parent: Element, components?: Component.Getter | null | undefined): () => void;
 
-export { Component, index_d as Layout, Schema, Store, type VerifyError, _default as render };
+/**
+ * 创建可赋值计算值
+ * @template T
+ * @param {() => T} getter 取值方法
+ * @param {(value: T) => void} callback 取值方法
+ * @param {boolean} immediate
+ * @returns {() => void}
+ */
+declare function watch<T>(getter: () => T, callback: (value: T) => void, immediate: boolean): () => void;
+
+/**
+ *
+ * @param {() => void} fn
+ * @returns {() => void}
+ */
+declare function effect(fn: () => void): () => void;
+
+export { Component, index_d as Layout, type Ref, Schema, Store, type VerifyError, effect, _default as render, watch };