@elcrm/form 0.1.3 → 0.1.5

package/dist/hooks/use.d.ts

@@ -6,16 +6,31 @@ type FormChange = {
     value?: unknown;
 };
 type Listener = () => void;
+/**
+ * API {@link useForm}. Поля принимают этот объект в проп `form`.
+ *
+ * - `onValue` — записать без ререндера (набор символов).
+ * - `setValue` — записать и уведомить подписчиков поля (blur / внешний сет).
+ * - `getValue` / `getValues` — читать; `getValues()` — копия, не мутировать.
+ */
 export type UseFormApi<T extends FormValues = FormValues> = {
+    /** Живое хранилище. Снаружи не мутировать — только через onValue/setValue. */
     valuesRef: React.MutableRefObject<T>;
+    /** Запись без notify (ввод). Поле само не перерисуется. */
     onValue: (payload: FormChange) => void;
+    /** Запись + bump версии + ререндер подписчиков этого `name`. */
     setValue: (payload: FormChange) => void;
+    /** Несколько ключей сразу (notify только изменившихся). */
     setValues: (nextValues: Partial<T> & FormValues) => void;
-    /** Неглубокая копия текущих значений (защита от случайной мутации снаружи) */
+    /** Неглубокая копия текущих значений. */
     getValues: () => T;
+    /** Одно значение; если ключа нет — `fallback`. */
     getValue: <K extends string>(name: K, fallback?: unknown) => K extends keyof T ? T[K] : unknown;
+    /** Версия поля (растёт на `setValue`). */
     getVersion: (name: string) => number;
+    /** Вернуть к initial или к `nextValues`. */
     reset: (nextValues?: T) => void;
+    /** Подписка на одно имя (поля используют внутри). */
     subscribe: (name: string, listener: Listener) => () => void;
 };
 /**
@@ -31,16 +46,15 @@ export type UseFormApi<T extends FormValues = FormValues> = {
  * form.getValues().login; // string
  */
 export declare function useForm<T extends FormValues = FormValues>(initialValues?: T): UseFormApi<T>;
-/**
- * Подписка на одно поле формы: актуальное значение + версия (для key у contentEditable и т.п.).
- * Поля используют внутри себя; снаружи обычно достаточно передать form + name.
- */
-/** Результат хука подписки на поле (значение + версия для key) */
 export type UseFormFieldStateResult = {
     value: unknown;
     version: number;
 };
-export declare function useFormFieldState(form: UseFormApi | undefined, name: string, fallback: unknown): UseFormFieldStateResult;
+/**
+ * Подписка на одно поле формы: значение + версия (bump при `setValue`).
+ * Снаружи достаточно передать `form` + `name` в `*Field`.
+ */
+export declare function useFormFieldState(form: UseFormApi<any> | undefined, name: string, fallback: unknown): UseFormFieldStateResult;
 /** Подписка только на значение (без поля-компонента), например внешняя логика превью */
-export declare function useFormField(form: UseFormApi, name: string, fallback?: unknown): unknown;
+export declare function useFormField(form: UseFormApi<any>, name: string, fallback?: unknown): unknown;
 export {};

package/dist/index.d.ts

@@ -41,6 +41,8 @@ export type { TEmail } from './fields/Email';
 export type { TCard } from './fields/Card';
 export type { TUrl } from './fields/Url';
 export type { TSelect } from './fields/Select';
+export type { TOptions } from './fields/Options';
+export type { TModal } from './fields/Modal';
 export type { TDate } from './fields/Date';
 export type { TMoney } from './fields/Money';
 export type { TMask } from './fields/Mask';