@vef-framework/components 1.0.135 → 2.0.1

package/types/vef-form/components/form-actions.d.ts

@@ -1,20 +0,0 @@
-import type { Handler, ObjectType } from "@vef-framework/shared";
-import type { FC } from "react";
-import type { VefFormProps } from "../props";
-import type { FormScene, FormSchema } from "../types";
-/**
- * The props of the form actions component.
- *
- * @param T - The type of the form values.
- * @param R - The type of the submitted result of the form.
- * @param S - The type of the form schema.
- */
-export interface FormActionsProps<Values extends ObjectType, Result, Scene extends FormScene, Schema extends FormSchema<Values, Scene>> extends Pick<VefFormProps<Values, Result, Scene, Schema>, "submissionButton" | "resetButton"> {
-    /**
-     * Resets the form fields to their initial values.
-     */
-    handleReset: Handler;
-}
-declare function VefFormActionsBase<Values extends ObjectType, Result, Scene extends FormScene, Schema extends FormSchema<Values, Scene>>({ submissionButton, resetButton, handleReset, }: FormActionsProps<Values, Result, Scene, Schema>): import("@emotion/react/jsx-runtime").JSX.Element | null;
-declare const VefFormActions: typeof VefFormActionsBase & Pick<FC, "displayName">;
-export default VefFormActions;

package/types/vef-form/components/form-content.d.ts

@@ -1,23 +0,0 @@
-import type { ObjectType } from "@vef-framework/shared";
-import type { VefFormProps } from "../props";
-import type { FormScene, FormSchema, FormTabsUse } from "../types";
-/**
- * The props of the form content component.
- */
-export interface VefFormContentProps<Values extends ObjectType, Scene extends FormScene, Schema extends FormSchema<Values, Scene>> {
-    /**
-     * The schema of the form.
-     */
-    schema: Schema;
-    /**
-     * The use of the form tabs.
-     */
-    showTabs: false | FormTabsUse;
-    /**
-     * The height of the form content.
-     */
-    height: VefFormProps["height"];
-}
-declare function VefFormContentBase<Values extends ObjectType, Scene extends FormScene, Schema extends FormSchema<Values, Scene>>({ schema, showTabs, height, }: VefFormContentProps<Values, Scene, Schema>): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const VefFormContent: typeof VefFormContentBase;
-export default VefFormContent;

package/types/vef-form/components/form-field.d.ts

@@ -1,5 +0,0 @@
-import type { ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormScene } from "../types";
-import type { VefFormFieldProps } from "./fields";
-declare function VefFormField<Values extends ObjectType, Key extends StringKey<Values>, Scene extends FormScene>(props: VefFormFieldProps<Values, Key, Scene>): import("@emotion/react/jsx-runtime").JSX.Element;
-export default VefFormField;

package/types/vef-form/components/form-group.d.ts

@@ -1,22 +0,0 @@
-import type { ObjectType, StringKey } from "@vef-framework/shared";
-import type { FC, ReactNode, RefAttributes } from "react";
-import type { FormGroup, FormScene } from "../types";
-/**
- * The props of the form group.
- */
-export interface VefFormGroupProps<Values extends ObjectType, Scene extends FormScene> {
-    /**
-     * The title of the form group.
-     */
-    title?: ReactNode;
-    /**
-     * Whether to disable the form group.
-     */
-    disabled: boolean;
-    /**
-     * The rows of the form group.
-     */
-    rows: FormGroup<Values, StringKey<Values>, Scene>["rows"];
-}
-declare const VefFormGroup: (<Values extends ObjectType, Scene extends FormScene>(props: VefFormGroupProps<Values, Scene> & RefAttributes<HTMLDivElement | null>) => ReactNode) & Pick<FC, "displayName">;
-export default VefFormGroup;

package/types/vef-form/components/form-hidden-item.d.ts

@@ -1,14 +0,0 @@
-import type { ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormItem, FormScene } from "../types";
-/**
- * The props of the form hidden item.
- */
-export interface VefFormHiddenItemProps<Values extends ObjectType, Key extends StringKey<Values>, Scene extends FormScene> {
-    /**
-     * The item of the form.
-     */
-    item: FormItem<Values, Key, Scene>;
-}
-declare function VefFormHiddenItemBase<Values extends ObjectType, Key extends StringKey<Values>, Scene extends FormScene>({ item, }: VefFormHiddenItemProps<Values, Key, Scene>): import("@emotion/react/jsx-runtime").JSX.Element | null;
-declare const VefFormHiddenItem: typeof VefFormHiddenItemBase;
-export default VefFormHiddenItem;

package/types/vef-form/components/form-item.d.ts

@@ -1,18 +0,0 @@
-import type { ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormItem, FormScene } from "../types";
-/**
- * The props of the form item.
- */
-export interface VefFormItemProps<Values extends ObjectType, Key extends StringKey<Values>, Scene extends FormScene> {
-    /**
-     * The item of the form.
-     */
-    item: FormItem<Values, Key, Scene>;
-    /**
-     * Whether to disable the form item.
-     */
-    disabled: boolean;
-}
-declare function VefFormItemBase<Values extends ObjectType, Key extends StringKey<Values>, Scene extends FormScene>({ item, disabled, }: VefFormItemProps<Values, Key, Scene>): import("@emotion/react/jsx-runtime").JSX.Element | null;
-declare const VefFormItem: typeof VefFormItemBase;
-export default VefFormItem;

package/types/vef-form/components/form-row.d.ts

@@ -1,26 +0,0 @@
-import type { KeyValue, ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormRow, FormScene } from "../types";
-/**
- * The props of the form row.
- */
-export interface VefFormRowProps<Values extends ObjectType, Scene extends FormScene> {
-    /**
-     * The key of the row.
-     */
-    rowKey: KeyValue;
-    /**
-     * Whether to disable the row.
-     */
-    disabled: boolean;
-    /**
-     * Whether to auto expand the row.
-     */
-    autoExpand?: boolean;
-    /**
-     * The columns of the row.
-     */
-    columns: FormRow<Values, StringKey<Values>, Scene>["columns"];
-}
-declare function VefFormRowBase<Values extends ObjectType, Scene extends FormScene>({ rowKey, columns, disabled, autoExpand: rowAutoExpand, }: VefFormRowProps<Values, Scene>): import("@emotion/react/jsx-runtime").JSX.Element;
-declare const VefFormRow: typeof VefFormRowBase;
-export default VefFormRow;

package/types/vef-form/event.d.ts

@@ -1,15 +0,0 @@
-import type { Consumer, ObjectType } from "@vef-framework/shared";
-import type { FormValues } from "./types";
-/**
- * The form event bus.
- */
-export declare class FormEventBus<Values extends ObjectType = any> {
-    #private;
-    clear(): void;
-    onChange(handler: Consumer<FormValues<Values>>): void;
-    offChange(handler: Consumer<FormValues<Values>>): void;
-    emitChange(value: FormValues<Values>): void;
-    onSubmitResult(handler: Consumer<boolean>): void;
-    offSubmitResult(handler: Consumer<boolean>): void;
-    emitSubmitResult(result: boolean): void;
-}

package/types/vef-form/helper.d.ts

@@ -1,11 +0,0 @@
-import type { MaybeUndefined, ObjectType } from "@vef-framework/shared";
-import type { FormComputedType, FormScene } from "./types";
-/**
- * Decide the value with default value.
- *
- * @param value - The value to decide.
- * @param values - The form values.
- * @param scene - The form scene.
- * @param defaultValue - The default value to use if value is undefined.
- */
-export declare function computeValue<Values extends ObjectType, Scene extends FormScene, ComputedValue>(value: MaybeUndefined<FormComputedType<Values, Scene, ComputedValue>>, values: Values, scene: Scene, defaultValue: ComputedValue): ComputedValue;

package/types/vef-form/hooks/use-action-handlers.d.ts

@@ -1,14 +0,0 @@
-import type { Handler, Mapper, ObjectType } from "@vef-framework/shared";
-import type { FormProps } from "antd";
-import type { VefFormProps } from "../props";
-import type { FormScene, FormSchema, FormVirtualKey } from "../types";
-type SubmitFailedHandler<Values extends ObjectType> = NonNullable<FormProps<Values>["onFinishFailed"]>;
-/**
- * The use action handlers hook.
- */
-export declare function useActionHandlers<Values extends ObjectType, Result, Scene extends FormScene, Schema extends FormSchema<Values, Scene>, VirtualKeys extends FormVirtualKey<Schema>>({ submitApi, submitTip, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitFailure, onReset, }: Pick<VefFormProps<Values, Result, Scene, Schema, VirtualKeys>, "submitApi" | "submitTip" | "onBeforeSubmit" | "onSubmit" | "onSubmitSuccess" | "onSubmitFailure" | "onReset">): {
-    handleReset: Handler;
-    handleSubmit: Mapper<Values, Promise<void>>;
-    handleSubmitFailed: SubmitFailedHandler<Values>;
-};
-export {};

package/types/vef-form/hooks/use-columns-layout.d.ts

@@ -1,12 +0,0 @@
-import type { KeyValue, ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormColumn, FormLayoutMode, FormScene } from "../types";
-/**
- * Get the layout of the columns.
- *
- * @param rowKey - The key of the row.
- * @param columns - The columns of the row.
- * @param layoutMode - The layout mode of the form.
- * @param autoExpand - Whether to auto expand the columns.
- * @returns The layout of the columns.
- */
-export declare function useColumnsLayout<Values extends ObjectType, Scene extends FormScene>(rowKey: KeyValue, columns: Array<FormColumn<Values, StringKey<Values>, Scene>>, layoutMode: FormLayoutMode, autoExpand: boolean): Record<string, number> | Record<string, Record<string, number>>;

package/types/vef-form/hooks/use-computed-values.d.ts

@@ -1,42 +0,0 @@
-import type { ObjectType } from "@vef-framework/shared";
-import type { FormComputedType, FormScene } from "../types";
-type ExtractValueType<T> = T extends {
-    rawValue: FormComputedType<any, any, infer ComputedValue>;
-} ? T extends {
-    defaultValue: NonNullable<ComputedValue>;
-} ? NonNullable<ComputedValue> : ComputedValue : never;
-type ComputedValueTuple<T extends ReadonlyArray<ComputedValue<any, any, unknown>>> = {
-    [K in keyof T]: ExtractValueType<T[K]>;
-};
-type ComputedValueRecord<T extends ReadonlyArray<ComputedValue<any, any, unknown>>> = {
-    [K in T[number]["key"]]: ExtractValueType<Extract<T[number], {
-        key: K;
-    }>>;
-};
-type ComputedValueResult<T extends ReadonlyArray<ComputedValue<any, any, unknown>>, R extends boolean> = R extends true ? ComputedValueRecord<T> : ComputedValueTuple<T>;
-/**
- * The computed value.
- */
-export interface ComputedValue<Values extends ObjectType, Scene extends FormScene, ComputedValue> {
-    /**
-     * The key of the computed value.
-     */
-    key: string;
-    /**
-     * The raw value of the computed value.
-     */
-    rawValue?: FormComputedType<Values, Scene, ComputedValue>;
-    /**
-     * The default value of the computed value.
-     */
-    defaultValue?: ComputedValue;
-}
-/**
- * Use the computed values.
- *
- * @param values The computed values.
- * @param returnAsObject Whether to return the computed values as an object.
- * @returns The computed values.
- */
-export declare function useComputedValues<Values extends ObjectType, Scene extends FormScene, T extends ReadonlyArray<ComputedValue<any, Scene, unknown>>, R extends boolean = false>(values: T, returnAsObject?: R): ComputedValueResult<T, R>;
-export {};

package/types/vef-form/hooks/use-form-context.d.ts

@@ -1,6 +0,0 @@
-import type { InternalFormContext } from "../types";
-declare const useFormContextSelector: <R>(selector: import("@vef-framework/shared").Mapper<InternalFormContext, R>) => R, useFormContext: import("@vef-framework/shared").Provider<InternalFormContext>, FormContextProvider: import("react").ComponentType<{
-    value: InternalFormContext;
-    children: import("react").ReactNode;
-}>;
-export { FormContextProvider, useFormContext, useFormContextSelector, };

package/types/vef-form/hooks/use-form-initialization.d.ts

@@ -1,14 +0,0 @@
-import type { BiConsumer, MaybeNull, ObjectType, StringKey } from "@vef-framework/shared";
-import type { FormContext, FormScene, FormSchema } from "../types";
-/**
- * Initialize the form values.
- *
- * @param schema The form schema
- * @param initialValues The form initial values
- * @returns The handled initial values and value changes
- */
-export declare function useFormInitialization<Values extends ObjectType, Scene extends FormScene, Schema extends FormSchema<Values, Scene>>(schema: Schema, initialValues?: Partial<Values>): {
-    mergedInitialValues: Partial<Values>;
-    valueChangeHandlers: Record<StringKey<Values>, BiConsumer<MaybeNull<Values[StringKey<Values>]>, FormContext<Values, Scene>>>;
-    virtualFieldNames: StringKey<Values>[];
-};

package/types/vef-form/hooks/use-form-instance.d.ts

@@ -1,10 +0,0 @@
-import type { Handler, ObjectType } from "@vef-framework/shared";
-import type { ForwardedRef } from "react";
-import type { VefFormInstance } from "../props";
-/**
- * Use the form instance.
- *
- * @param ref - The forwarded ref.
- * @param reset - The reset handler.
- */
-export declare function useFormInstance<Values extends ObjectType>(ref: ForwardedRef<VefFormInstance<Values>>, reset: Handler): void;

package/types/vef-form/hooks/use-form-values-change.d.ts

@@ -1,11 +0,0 @@
-import type { BiConsumer, ObjectType } from "@vef-framework/shared";
-import type { FormScene, FormValues } from "../types";
-/**
- * Use the form values change
- *
- * @param onChange The change handler
- * @returns The change handler
- */
-export declare function useFormValuesChange<Values extends ObjectType, Scene extends FormScene>(onChange?: BiConsumer<FormValues<Values>, Scene>): {
-    handleValuesChange: (_: any, values: FormValues<Values>) => void;
-};

package/types/vef-form/hooks/use-label-width.d.ts

@@ -1,9 +0,0 @@
-import type { FormLabelPosition } from "../types";
-/**
- * Use the label width of the form.
- *
- * @param labelPosition - The label position.
- * @param labelWidth - The label width.
- * @returns The label width to use.
- */
-export declare function useLabelWidth(labelPosition: FormLabelPosition, labelWidth?: number): number | undefined;

package/types/vef-form/index.d.ts

@@ -1,7 +0,0 @@
-import type { AnyValue, ObjectType, ObjectValue } from "@vef-framework/shared";
-import type { FC, ReactNode, RefAttributes } from "react";
-import type { VefFormInstance, VefFormProps } from "./props";
-import type { FormActionButtonConfig, FormColumn, FormContext, FormGroup, FormItem, FormLabelAlign, FormLabelPosition, FormLayoutMode, FormRow, FormScene, FormSchema, FormTabsUse, FormValidationRule, FormVirtualKey } from "./types";
-declare const VefForm: (<Values extends ObjectType = ObjectValue, Result = AnyValue, Scene extends FormScene = FormScene, Schema extends FormSchema<Values, Scene> = FormSchema<Values, Scene>, VirtualKeys extends FormVirtualKey<Schema> = FormVirtualKey<Schema>>(props: VefFormProps<Values, Result, Scene, Schema, VirtualKeys> & RefAttributes<VefFormInstance<Values>>) => ReactNode) & Pick<FC, "displayName">;
-export type { FormActionButtonConfig, FormColumn, FormContext, FormGroup, FormItem, FormLabelAlign, FormLabelPosition, FormLayoutMode, FormRow, FormScene, FormSchema, FormTabsUse, FormValidationRule, VefFormInstance, VefFormProps };
-export default VefForm;

package/types/vef-form/props.d.ts

@@ -1,156 +0,0 @@
-import type { AnyValue, ApiResponse, BasicSize, BiConsumer, BiMapper, Consumer, Except, FormItemVariant, Handler, LengthValue, LiteralUnion, MaybePromise, MutationApi, ObjectType, ObjectValue, Provider, TriConsumer, VefError } from "@vef-framework/shared";
-import type { ReactNode } from "react";
-import type { FormActionButtonConfig, FormLabelAlign, FormLabelPosition, FormLayoutMode, FormScene, FormSchema, FormTabsUse, FormValues, FormVirtualKey } from "./types";
-/**
- * The instance of the VefForm component.
- *
- * @param Values - The type of the form values.
- */
-export interface VefFormInstance<Values extends ObjectType = ObjectValue> {
-    /**
-     * The submit provider of the form.
-     */
-    submit: Provider<MaybePromise<void>>;
-    /**
-     * The reset handler of the form.
-     */
-    reset: Handler;
-    /**
-     * The get values provider of the form.
-     */
-    getValues: Provider<FormValues<Values>>;
-    /**
-     * The set values consumer of the form.
-     */
-    setValues: Consumer<FormValues<Values>>;
-}
-/**
- * The props of the VefForm component.
- *
- * @param Values - The type of the form values.
- * @param Result - The type of the submitted result of the form.
- * @param Scene - The type of the form scene.
- * @param Schema - The type of the form schema.
- * @param VirtualKeys - The type of the virtual keys of the form.
- */
-export interface VefFormProps<Values extends ObjectType = ObjectValue, Result = AnyValue, Scene extends FormScene = FormScene, Schema extends FormSchema<Values, Scene> = FormSchema<Values, Scene>, VirtualKeys extends FormVirtualKey<Schema> = FormVirtualKey<Schema>> {
-    /**
-     * The scene of the form.
-     */
-    scene: Scene;
-    /**
-     * The schema of the form.
-     */
-    schema: Schema;
-    /**
-     * The initial values of the form.
-     */
-    initialValues?: Partial<Values>;
-    /**
-     * The layout mode of the form.
-     */
-    layoutMode?: FormLayoutMode;
-    /**
-     * Whether to auto expand the remaining space of the row.
-     * Only works when the `layoutMode` is `responsive`.
-     */
-    autoExpand?: boolean;
-    /**
-     * The position of the label.
-     */
-    labelPosition?: FormLabelPosition;
-    /**
-     * The alignment of the label.
-     * Only works when the `labelPosition` is `left`.
-     */
-    labelAlign?: FormLabelAlign;
-    /**
-     * The width of the label.
-     * Only works when the `labelPosition` is `left`.
-     */
-    labelWidth?: number;
-    /**
-     * The variant of the form.
-     */
-    variant?: FormItemVariant;
-    /**
-     * Whether to show tabs.
-     * When set to true, the form will be displayed in tabs, default use is 'switch'.
-     * When set to 'switch', the form will be displayed in switchable tabs.
-     * When set to 'navigation', the form will be displayed in navigation tabs.
-     */
-    showTabs?: boolean | FormTabsUse;
-    /**
-     * The height of the form.
-     */
-    height?: LiteralUnion<"auto" | "full", LengthValue>;
-    /**
-     * The size of the form.
-     */
-    size?: BasicSize;
-    /**
-     * Whether the form is disabled.
-     */
-    disabled?: boolean;
-    /**
-     * The submission button of the form.
-     */
-    submissionButton?: false | FormActionButtonConfig;
-    /**
-     * The reset button of the form.
-     */
-    resetButton?: false | FormActionButtonConfig;
-    /**
-     * The submit tip of the form.
-     */
-    submitTip?: ReactNode | BiMapper<Values, Scene, ReactNode>;
-    /**
-     * The submit API of the form.
-     */
-    submitApi?: Readonly<MutationApi<Except<Values, VirtualKeys>, Result>>;
-    /**
-     * The handler for processing the values of the form before submit.
-     *
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     * @returns The processed values of the form.
-     */
-    onBeforeSubmit?: BiMapper<Values, Scene, MaybePromise<Values>>;
-    /**
-     * The submit handler for customized processing logics.
-     *
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     */
-    onSubmit?: BiMapper<Except<Values, VirtualKeys>, Scene, MaybePromise<void>>;
-    /**
-     * The submit success event handler.
-     *
-     * @param result - The result of the submit API.
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     */
-    onSubmitSuccess?: TriConsumer<ApiResponse<Result>, Values, Scene>;
-    /**
-     * The submit failure event handler.
-     *
-     * @param error - The error.
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     */
-    onSubmitFailure?: TriConsumer<VefError, Values, Scene>;
-    /**
-     * The reset event handler.
-     *
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     */
-    onReset?: BiConsumer<FormValues<Values>, Scene>;
-    /**
-     * The change event handler.
-     *
-     * @param values - The values of the form.
-     * @param scene - The scene of the form.
-     */
-    onChange?: BiConsumer<FormValues<Values>, Scene>;
-}

package/types/vef-form/store.d.ts

@@ -1,86 +0,0 @@
-import type { BiConsumer, BiConsumerOptional, ChildrenProps, Consumer, MaybeNull, ObjectType, Provider, StringKey } from "@vef-framework/shared";
-import type { FormInstance } from "antd";
-import type { FormEventBus } from "./event";
-import type { FormContext, FormScene, FormValues } from "./types";
-/**
- * The form state.
- */
-export interface FormState<Values extends ObjectType, Scene extends FormScene = FormScene> {
-    /**
-     * The scene of the form.
-     */
-    scene: Scene;
-    /**
-     * The form instance.
-     */
-    form: FormInstance<Values>;
-    /**
-     * The event bus of the form.
-     */
-    eventBus: FormEventBus<Values>;
-    /**
-     * The initial values of the form.
-     */
-    initialValues: Partial<Values>;
-    /**
-     * The value change handlers of the form.
-     */
-    valueChangeHandlers: Record<StringKey<Values>, BiConsumer<MaybeNull<Values[StringKey<Values>]>, FormContext<Values, Scene>>>;
-    /**
-     * Invokes the value change handlers of the form.
-     *
-     * @param values The values to invoke the value change handlers with
-     */
-    invokeValueChangeHandlers: BiConsumerOptional<FormValues<Values>, Array<StringKey<Values>>>;
-    /**
-     * The virtual field names of the form.
-     */
-    virtualFieldNames: Array<StringKey<Values>>;
-    /**
-     * Gets the form values.
-     *
-     * @returns The form values.
-     */
-    getValues: Provider<FormValues<Values>>;
-    /**
-     * Updates form values
-     *
-     * @param values The partial form values to update
-     */
-    setValues: Consumer<FormValues<Values>>;
-    /**
-     * The loading state of the form.
-     */
-    isLoading: boolean;
-    /**
-     * Sets the loading state of the form.
-     *
-     * @param loading The loading state to set
-     */
-    setIsLoading: Consumer<boolean>;
-    /**
-     * Whether to show the action buttons.
-     */
-    showActionButtons: boolean;
-    /**
-     * Sets whether to show the action buttons.
-     *
-     * @param showActionButtons The show action buttons state to set
-     */
-    setShowActionButtons: Consumer<boolean>;
-}
-/**
- * The props of the form store provider
- */
-export interface FormStoreProviderProps<Values extends ObjectType, Scene extends FormScene = FormScene> extends Pick<FormState<Values, Scene>, "form" | "scene" | "eventBus" | "initialValues" | "valueChangeHandlers" | "virtualFieldNames">, ChildrenProps {
-}
-declare const FormStoreProvider: import("react").FC<import("@vef-framework/shared").StoreProviderProps<FormStoreProviderProps<any, any>>>, useFormStore: <State extends FormState<any, any>, U>(selector: import("@vef-framework/shared").Mapper<State, U>) => U, useFormStoreApi: <State extends FormState<any, any>>() => Omit<import("zustand").StoreApi<State>, "subscribe"> & {
-    subscribe: {
-        (listener: (selectedState: State, previousSelectedState: State) => void): () => void;
-        <U>(selector: (state: State) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
-            equalityFn?: ((a: U, b: U) => boolean) | undefined;
-            fireImmediately?: boolean;
-        } | undefined): () => void;
-    };
-};
-export { FormStoreProvider, useFormStore, useFormStoreApi, };