Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.
TypeScript ai-agentsbill-of-materialserpinventory-managementleanmanufacturingmanufacturing-execution-systemmcp-servermesmrpopen-source-erppostgresqlproduction-planningqmsquality-management-systemreact-routerself-hostedsupabasetraceabilitytypescript
// SPDX-License-Identifier: AGPL-3.0-only
// Carbon (github.com/crbnos/carbon). Modified or adapted versions of this file,
// including ports, remain AGPLv3; serving them over a network requires releasing their source.
import { useMemo } from "react";
import {
useClearError,
useDefaultValuesForForm,
useFieldErrors,
useFieldErrorsForForm,
useFormActionProp,
useFormSubactionProp,
useFormValues,
useInternalFormContext,
useInternalHasBeenSubmitted,
useInternalIsSubmitting,
useInternalIsValid,
useResetFormElement,
useSetFieldErrors,
useSetTouched,
useSmartValidate,
useSubmitForm,
useSyncedDefaultValues,
useTouchedFields,
useValidate
} from "../internal/hooks";
import type {
FieldErrors,
TouchedFields,
ValidationResult
} from "../validation/types";
export type FormState = {
fieldErrors: FieldErrors;
isSubmitting: boolean;
hasBeenSubmitted: boolean;
touchedFields: TouchedFields;
defaultValues: { [fieldName: string]: any };
action?: string;
subaction?: string;
isValid: boolean;
};
/**
* Returns information about the form.
*
* @param formId the id of the form. Only necessary if being used outside a ValidatedForm.
*/
export const useFormState = (formId?: string): FormState => {
const formContext = useInternalFormContext(formId, "useFormState");
const isSubmitting = useInternalIsSubmitting(formContext.formId);
const hasBeenSubmitted = useInternalHasBeenSubmitted(formContext.formId);
const touchedFields = useTouchedFields(formContext.formId);
const isValid = useInternalIsValid(formContext.formId);
const action = useFormActionProp(formContext.formId);
const subaction = useFormSubactionProp(formContext.formId);
const syncedDefaultValues = useSyncedDefaultValues(formContext.formId);
const defaultValuesToUse = useDefaultValuesForForm(formContext);
const hydratedDefaultValues =
defaultValuesToUse.hydrateTo(syncedDefaultValues);
const fieldErrorsFromState = useFieldErrors(formContext.formId);
const fieldErrorsToUse = useFieldErrorsForForm(formContext);
const hydratedFieldErrors = fieldErrorsToUse.hydrateTo(fieldErrorsFromState);
return useMemo(
() => ({
action,
subaction,
defaultValues: hydratedDefaultValues,
fieldErrors: hydratedFieldErrors ?? {},
hasBeenSubmitted,
isSubmitting,
touchedFields,
isValid
}),
[
action,
hasBeenSubmitted,
hydratedDefaultValues,
hydratedFieldErrors,
isSubmitting,
isValid,
subaction,
touchedFields
]
);
};
export type FormHelpers = {
/**
* Clear the error of the specified field.
*/
clearError: (fieldName: string) => void;
/**
* Validate the specified field.
*/
validateField: (fieldName: string) => Promise<string | null>;
/**
* Change the touched state of the specified field.
*/
setTouched: (fieldName: string, touched: boolean) => void;
/**
* Validate the whole form and populate any errors.
*/
validate: () => Promise<ValidationResult<unknown>>;
/**
* Clears all errors on the form.
*/
clearAllErrors: () => void;
/**
* Resets the form.
*
* _Note_: The equivalent behavior can be achieved by calling formElement.reset()
* or clicking a button element with `type="reset"`.
*/
reset: () => void;
/**
* Submits the form, running all validations first.
*
* _Note_: This is equivalent to clicking a button element with `type="submit"` or calling formElement.submit().
*/
submit: () => void;
/**
* Returns the current form values as FormData
*/
getValues: () => FormData;
};
/**
* Returns helpers that can be used to update the form state.
*
* @param formId the id of the form. Only necessary if being used outside a ValidatedForm.
*/
export const useFormHelpers = (formId?: string): FormHelpers => {
const formContext = useInternalFormContext(formId, "useFormHelpers");
const setTouched = useSetTouched(formContext);
const validateField = useSmartValidate(formContext.formId);
const validate = useValidate(formContext.formId);
const clearError = useClearError(formContext);
const setFieldErrors = useSetFieldErrors(formContext.formId);
const reset = useResetFormElement(formContext.formId);
const submit = useSubmitForm(formContext.formId);
const getValues = useFormValues(formContext.formId);
return useMemo(
() => ({
setTouched,
validateField: async (fieldName: string) => {
const res = await validateField({
alwaysIncludeErrorsFromFields: [fieldName]
});
return res.error?.fieldErrors[fieldName] ?? null;
},
clearError,
validate,
clearAllErrors: () => setFieldErrors({}),
reset,
submit,
getValues
}),
[
clearError,
reset,
setFieldErrors,
setTouched,
submit,
validate,
validateField,
getValues
]
);
};