@trackunit/react-form-components 0.0.276 → 0.0.277

package/index.cjs.js

@@ -2227,6 +2227,14 @@ const UrlField = React.forwardRef((_a, ref) => {
     return (jsxRuntime.jsx(FormGroup, { htmlFor: htmlForId, label: label, tip: tip, isInvalid: renderAsInvalid, helpText: renderAsInvalid ? errorMessage : helpText, helpAddon: helpAddon, disabled: rest.disabled, dataTestId: dataTestId && `${dataTestId}-FormGroup`, children: jsxRuntime.jsx(UrlInput, Object.assign({ id: htmlForId, "aria-labelledby": htmlForId + "-label", ref: ref, value: value || defaultValue, isInvalid: renderAsInvalid, disabled: rest.disabled }, rest, { className: className, dataTestId: dataTestId })) }));
 });
 
+/**
+ * A utility function to get the error message from a FieldError object.
+ * This handles the case where the field is required and the u-ser has not entered a value.
+ */
+const errorMessageFromFieldError = (cannotBeEmptyMessage, error) => {
+    return (error === null || error === void 0 ? void 0 : error.message) || (error === null || error === void 0 ? void 0 : error.type) === "required" ? cannotBeEmptyMessage : undefined;
+};
+
 /*
  * ----------------------------
  * | SETUP TRANSLATIONS START |
@@ -2297,6 +2305,7 @@ exports.cvaSelectMenu = cvaSelectMenu;
 exports.cvaSelectMenuList = cvaSelectMenuList;
 exports.cvaSelectPrefix = cvaSelectPrefix;
 exports.cvaSelectXIcon = cvaSelectXIcon;
+exports.errorMessageFromFieldError = errorMessageFromFieldError;
 exports.getCountryAbbreviation = getCountryAbbreviation;
 exports.getOrderedOptions = getOrderedOptions;
 exports.getPhoneNumberWithPlus = getPhoneNumberWithPlus;

package/index.esm.js

@@ -2197,6 +2197,14 @@ const UrlField = forwardRef((_a, ref) => {
     return (jsx(FormGroup, { htmlFor: htmlForId, label: label, tip: tip, isInvalid: renderAsInvalid, helpText: renderAsInvalid ? errorMessage : helpText, helpAddon: helpAddon, disabled: rest.disabled, dataTestId: dataTestId && `${dataTestId}-FormGroup`, children: jsx(UrlInput, Object.assign({ id: htmlForId, "aria-labelledby": htmlForId + "-label", ref: ref, value: value || defaultValue, isInvalid: renderAsInvalid, disabled: rest.disabled }, rest, { className: className, dataTestId: dataTestId })) }));
 });
 
+/**
+ * A utility function to get the error message from a FieldError object.
+ * This handles the case where the field is required and the u-ser has not entered a value.
+ */
+const errorMessageFromFieldError = (cannotBeEmptyMessage, error) => {
+    return (error === null || error === void 0 ? void 0 : error.message) || (error === null || error === void 0 ? void 0 : error.type) === "required" ? cannotBeEmptyMessage : undefined;
+};
+
 /*
  * ----------------------------
  * | SETUP TRANSLATIONS START |
@@ -2206,4 +2214,4 @@ const UrlField = forwardRef((_a, ref) => {
  */
 setupLibraryTranslations();
 
-export { ActionButton, BaseInput, Checkbox, CreatableSelect, DateField, DateInput, DropZone, EMAIL_REGEX, EmailField, EmailInput, FormGroup, Label, MultiSelectMenuItem, NumberField, NumberInput, OptionCard, PasswordField, PasswordInput, PhoneField, PhoneInput, RadioGroup, RadioItem, Schedule, ScheduleVariant, Search, Select, SingleSelectMenuItem, TextArea, TextAreaField, TextField, TextInput, TimeRange, TimeRangeField, Toggle, UploadField, UploadInput, UrlField, UrlInput, checkIfPhoneNumberHasPlus, countryCodeToFlagEmoji, cvaInput, cvaInputAddon, cvaInputAddonAfter, cvaInputAddonBefore, cvaInputBase, cvaInputBaseDisabled, cvaInputBaseInvalid, cvaInputField, cvaInputPrefix, cvaInputSuffix, cvaSelect, cvaSelectCounter, cvaSelectDynamicTagContainer, cvaSelectIcon, cvaSelectMenu, cvaSelectMenuList, cvaSelectPrefix, cvaSelectXIcon, getCountryAbbreviation, getOrderedOptions, getPhoneNumberWithPlus, isInvalidCountryCode, isInvalidPhoneNumber, isMultiValue, parseSchedule, serializeSchedule, useCustomComponents, usePhoneInput, validateEmailAddress, validatePhoneNumber, weekDay };
+export { ActionButton, BaseInput, Checkbox, CreatableSelect, DateField, DateInput, DropZone, EMAIL_REGEX, EmailField, EmailInput, FormGroup, Label, MultiSelectMenuItem, NumberField, NumberInput, OptionCard, PasswordField, PasswordInput, PhoneField, PhoneInput, RadioGroup, RadioItem, Schedule, ScheduleVariant, Search, Select, SingleSelectMenuItem, TextArea, TextAreaField, TextField, TextInput, TimeRange, TimeRangeField, Toggle, UploadField, UploadInput, UrlField, UrlInput, checkIfPhoneNumberHasPlus, countryCodeToFlagEmoji, cvaInput, cvaInputAddon, cvaInputAddonAfter, cvaInputAddonBefore, cvaInputBase, cvaInputBaseDisabled, cvaInputBaseInvalid, cvaInputField, cvaInputPrefix, cvaInputSuffix, cvaSelect, cvaSelectCounter, cvaSelectDynamicTagContainer, cvaSelectIcon, cvaSelectMenu, cvaSelectMenuList, cvaSelectPrefix, cvaSelectXIcon, errorMessageFromFieldError, getCountryAbbreviation, getOrderedOptions, getPhoneNumberWithPlus, isInvalidCountryCode, isInvalidPhoneNumber, isMultiValue, parseSchedule, serializeSchedule, useCustomComponents, usePhoneInput, validateEmailAddress, validatePhoneNumber, weekDay };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-form-components",
-  "version": "0.0.276",
+  "version": "0.0.277",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/index.d.ts

@@ -34,4 +34,5 @@ export * from "./components/UploadInput/UploadInput";
 export * from "./components/UrlField/UrlField";
 export * from "./components/UrlInput/UrlInput";
 export * from "./utilities/emailUtils";
+export * from "./utilities/formErrorMessageUtils";
 export * from "./utilities/usePhoneInput";

package/src/utilities/formErrorMessageUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * A utility function to get the error message from a FieldError object.
+ * This handles the case where the field is required and the u-ser has not entered a value.
+ */
+export declare const errorMessageFromFieldError: (cannotBeEmptyMessage: string, error?: {
+    message?: string;
+    type?: string;
+}) => string | undefined;