@flowgram.ai/form 0.2.16 → 0.2.18

package/dist/index.d.mts

@@ -4,8 +4,17 @@ import * as _flowgram_ai_utils from '@flowgram.ai/utils';
 import { MaybePromise, Disposable, Emitter, DisposableCollection } from '@flowgram.ai/utils';
 import { ReactiveState } from '@flowgram.ai/reactive';
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 type Context = any;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FeedbackLevel {
     Error = "error",
     Warning = "warning"
@@ -58,6 +67,10 @@ declare enum ValidateTrigger {
 }
 type FormValidateReturn = (FieldError | FieldWarning)[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare class Path {
     protected _path: string[];
     constructor(path: string | string[]);
@@ -82,6 +95,11 @@ declare class Path {
     replaceParent(parent: Path, newParent: Path): Path;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class Store<TValues = FieldValue> {
     protected _values: TValues;
     get values(): TValues;
@@ -252,6 +270,11 @@ declare class FormModel<TValues = any> implements Disposable {
     dispose(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FormState {
     /**
      * If the form data is valid
@@ -367,6 +390,11 @@ interface OnFormValuesUpdatedPayload {
     options?: OnFormValuesChangeOptions;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldValue = any;
 type FieldName = string;
 type CustomElement = Partial<HTMLElement> & {
@@ -527,6 +555,11 @@ interface FieldModelState extends Omit<FieldState, 'errors' | 'warnings'> {
     warnings?: Warnings;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldProps<TValue> = FieldOptions<TValue> & {
     /**
      * A React element or a render prop
@@ -542,6 +575,11 @@ type FieldProps<TValue> = FieldOptions<TValue> & {
  */
 declare function Field<TValue>({ name, defaultValue, render, children, deps, }: FieldProps<TValue>): React$1.ReactElement;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FormProps<TValues> = FormOptions & {
     /**
      * React children or child render prop
@@ -564,17 +602,32 @@ type FormProps<TValues> = FormOptions & {
  */
 declare function Form<TValues>(props: FormProps<TValues>): React__default.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get Form instance. It should be use in a child component of  <Form />
  */
 declare function useForm(): Form$1;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Listen to the field data change and refresh the React component.
  * @param name the field's uniq name (path)
  */
 declare function useWatch<TValue = FieldValue>(name: FieldName): TValue;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldArrayProps<TValue> = FieldArrayOptions<TValue> & {
     /**
      * A React element or a render prop
@@ -590,6 +643,11 @@ type FieldArrayProps<TValue> = FieldArrayOptions<TValue> & {
  */
 declare function FieldArray<TValue extends FieldValue>({ name, defaultValue, deps, render, children, }: FieldArrayProps<TValue>): React$1.ReactElement;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * @deprecated
  * `useField` is deprecated because its return relies on React render. if the Field is not rendered, the return would be
@@ -602,6 +660,11 @@ declare function useFormState(control?: FormControl<any> | Form$1): FormState;
 declare function useFormErrors(control?: FormControl<any> | Form$1): Errors | undefined;
 declare function useFormWarnings(control?: FormControl<any> | Form$1): Warnings | undefined;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found.
  * The reason could be that the field is not rendered yet or the name given is wrong.
@@ -609,16 +672,31 @@ declare function useFormWarnings(control?: FormControl<any> | Form$1): Warnings
  */
 declare function useFieldValidate(name?: FieldName): () => void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get the current Field. It should be used in a child component of <Field />, otherwise it throws an error
  */
 declare function useCurrentField<TFieldValue = FieldValue, TField extends Field$1<TFieldValue> | FieldArray$1<TFieldValue> = Field$1<TFieldValue>>(): Field$1<TFieldValue> | FieldArray$1<TFieldValue>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get the current field state. It should be used in a child component of <Field />, otherwise it throws an error
  */
 declare function useCurrentFieldState(): FieldState;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type CreateFormOptions<T = any> = FormOptions<T> & {
     /**
      * 为 true 时，createForm 不会对form 初始化， 用户需要手动调用 control.init()
@@ -629,6 +707,10 @@ type CreateFormOptions<T = any> = FormOptions<T> & {
 };
 declare function createForm<TValues>(options?: CreateFormOptions<TValues>): CreateFormReturn<TValues>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare namespace Glob {
     const DIVIDER = ".";
     const ALL = "*";
@@ -685,8 +767,18 @@ declare function toFieldState(modelState: FieldModelState): {
     readonly warnings: FieldWarning[] | undefined;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function toFieldArray<TValue>(model: FieldArrayModel<TValue>): FieldArray$1<TValue>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function toForm<TValue>(model: FormModel): Form$1<TValue>;
 declare function toFormState(modelState: FormModelState): FormState;
 

package/dist/index.d.ts

@@ -4,8 +4,17 @@ import * as _flowgram_ai_utils from '@flowgram.ai/utils';
 import { MaybePromise, Disposable, Emitter, DisposableCollection } from '@flowgram.ai/utils';
 import { ReactiveState } from '@flowgram.ai/reactive';
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 type Context = any;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FeedbackLevel {
     Error = "error",
     Warning = "warning"
@@ -58,6 +67,10 @@ declare enum ValidateTrigger {
 }
 type FormValidateReturn = (FieldError | FieldWarning)[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare class Path {
     protected _path: string[];
     constructor(path: string | string[]);
@@ -82,6 +95,11 @@ declare class Path {
     replaceParent(parent: Path, newParent: Path): Path;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class Store<TValues = FieldValue> {
     protected _values: TValues;
     get values(): TValues;
@@ -252,6 +270,11 @@ declare class FormModel<TValues = any> implements Disposable {
     dispose(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FormState {
     /**
      * If the form data is valid
@@ -367,6 +390,11 @@ interface OnFormValuesUpdatedPayload {
     options?: OnFormValuesChangeOptions;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldValue = any;
 type FieldName = string;
 type CustomElement = Partial<HTMLElement> & {
@@ -527,6 +555,11 @@ interface FieldModelState extends Omit<FieldState, 'errors' | 'warnings'> {
     warnings?: Warnings;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldProps<TValue> = FieldOptions<TValue> & {
     /**
      * A React element or a render prop
@@ -542,6 +575,11 @@ type FieldProps<TValue> = FieldOptions<TValue> & {
  */
 declare function Field<TValue>({ name, defaultValue, render, children, deps, }: FieldProps<TValue>): React$1.ReactElement;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FormProps<TValues> = FormOptions & {
     /**
      * React children or child render prop
@@ -564,17 +602,32 @@ type FormProps<TValues> = FormOptions & {
  */
 declare function Form<TValues>(props: FormProps<TValues>): React__default.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get Form instance. It should be use in a child component of  <Form />
  */
 declare function useForm(): Form$1;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Listen to the field data change and refresh the React component.
  * @param name the field's uniq name (path)
  */
 declare function useWatch<TValue = FieldValue>(name: FieldName): TValue;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FieldArrayProps<TValue> = FieldArrayOptions<TValue> & {
     /**
      * A React element or a render prop
@@ -590,6 +643,11 @@ type FieldArrayProps<TValue> = FieldArrayOptions<TValue> & {
  */
 declare function FieldArray<TValue extends FieldValue>({ name, defaultValue, deps, render, children, }: FieldArrayProps<TValue>): React$1.ReactElement;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * @deprecated
  * `useField` is deprecated because its return relies on React render. if the Field is not rendered, the return would be
@@ -602,6 +660,11 @@ declare function useFormState(control?: FormControl<any> | Form$1): FormState;
 declare function useFormErrors(control?: FormControl<any> | Form$1): Errors | undefined;
 declare function useFormWarnings(control?: FormControl<any> | Form$1): Warnings | undefined;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found.
  * The reason could be that the field is not rendered yet or the name given is wrong.
@@ -609,16 +672,31 @@ declare function useFormWarnings(control?: FormControl<any> | Form$1): Warnings
  */
 declare function useFieldValidate(name?: FieldName): () => void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get the current Field. It should be used in a child component of <Field />, otherwise it throws an error
  */
 declare function useCurrentField<TFieldValue = FieldValue, TField extends Field$1<TFieldValue> | FieldArray$1<TFieldValue> = Field$1<TFieldValue>>(): Field$1<TFieldValue> | FieldArray$1<TFieldValue>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Get the current field state. It should be used in a child component of <Field />, otherwise it throws an error
  */
 declare function useCurrentFieldState(): FieldState;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type CreateFormOptions<T = any> = FormOptions<T> & {
     /**
      * 为 true 时，createForm 不会对form 初始化， 用户需要手动调用 control.init()
@@ -629,6 +707,10 @@ type CreateFormOptions<T = any> = FormOptions<T> & {
 };
 declare function createForm<TValues>(options?: CreateFormOptions<TValues>): CreateFormReturn<TValues>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare namespace Glob {
     const DIVIDER = ".";
     const ALL = "*";
@@ -685,8 +767,18 @@ declare function toFieldState(modelState: FieldModelState): {
     readonly warnings: FieldWarning[] | undefined;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function toFieldArray<TValue>(model: FieldArrayModel<TValue>): FieldArray$1<TValue>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function toForm<TValue>(model: FormModel): Form$1<TValue>;
 declare function toFormState(modelState: FormModelState): FormState;