@trackunit/custom-field-components 0.0.278 → 0.0.279

package/index.js

@@ -33,6 +33,12 @@ function __rest(s, e) {
     return t;
 }
 
+/**
+ * A component that can be used to render a boolean field
+ *
+ * @param options BooleanCustomFieldProps - options for the component
+ * @returns { JSX.Element } JSX.Element - a component that can be used to render a boolean field
+ */
 const BooleanCustomField = (_a) => {
     var { defaultValue, dataTestId = "booleanField", onChange, value, id, setValue, register, validationRules, disabled = false, label, tip, isInvalid, errorMessage, helpAddon, maxLength, helpText } = _a, rest = __rest(_a, ["defaultValue", "dataTestId", "onChange", "value", "id", "setValue", "register", "validationRules", "disabled", "label", "tip", "isInvalid", "errorMessage", "helpAddon", "maxLength", "helpText"]);
     const initialValue = value !== undefined ? value : defaultValue ? defaultValue : false;
@@ -57,6 +63,12 @@ const BooleanCustomField = (_a) => {
     return (jsx(FormGroup, Object.assign({ label: label, tip: tip, isInvalid: renderAsInvalid, helpText: errorMessage || helpText, helpAddon: helpAddon || null, dataTestId: dataTestId && `${dataTestId}-FormGroup` }, { children: jsx(Checkbox, Object.assign({ checked: internalValue, dataTestId: dataTestId, id: id, disabled: disabled, name: id, onChange: onChangeHandler, isInvalid: renderAsInvalid }, rest)) })));
 };
 
+/**
+ * A component that can be used to render a date field
+ *
+ * @param props DateCustomFieldProps - options for the component
+ * @returns { JSX.Element } JSX.Element - a component that can be used to render a date field
+ */
 const DateCustomField = (props) => {
     const { setValue, defaultValue, register, id, validationRules } = props, rest = __rest(props, ["setValue", "defaultValue", "register", "id", "validationRules"]);
     const onChangeHandler = useCallback((e) => {
@@ -75,6 +87,12 @@ const DateCustomField = (props) => {
 const convertToValueFormat = (value) => {
     return { label: value, value };
 };
+/**
+ * A custom field that can be used to render a dropdown
+ *
+ * @param options DropdownCustomFieldProps - an object with all the props
+ * @returns {JSX.Element} - a dropdown component
+ */
 const DropdownCustomField = ({ defaultValue, dataTestId, onChange, onBlur, id, disabled = false, allValues, multiSelect = false, register, validationRules, setValue, label, tip, errorMessage, helpText, isInvalid, helpAddon, }) => {
     const renderAsInvalid = isInvalid || Boolean(errorMessage);
     const [selectedValue, setSelectedValue] = React.useState(defaultValue ? defaultValue.map(convertToValueFormat) : []);
@@ -98,6 +116,12 @@ const DropdownCustomField = ({ defaultValue, dataTestId, onChange, onBlur, id, d
     return (jsx(FormGroup, Object.assign({ label: label, tip: tip, isInvalid: renderAsInvalid, helpText: errorMessage || helpText, helpAddon: helpAddon || null, dataTestId: dataTestId && `${dataTestId}-FormGroup` }, { children: jsx(Select, { disabled: disabled, dataTestId: dataTestId, onChange: onChangeHandler, hasError: renderAsInvalid, options: options, value: selectedValue, isMulti: multiSelect, isClearable: true }) })));
 };
 
+/**
+ * Get validation rules for a field
+ *
+ * @param { WebAddressFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getWebAddressValidationRules = (definition) => {
     const defaultRules = {};
     const pattern = {
@@ -109,6 +133,12 @@ const getWebAddressValidationRules = (definition) => {
     return definition.uiEditable
         ? Object.assign(Object.assign({}, pattern), defaultRules) : defaultRules;
 };
+/**
+ * Get validation rules for a field.
+ *
+ * @param { NumberFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getNumberValidationRules = (definition) => {
     const defaultRules = { valueAsNumber: true };
     const minimum = definition.minimumNumber && {
@@ -127,6 +157,12 @@ const getNumberValidationRules = (definition) => {
     return definition.uiEditable
         ? Object.assign(Object.assign(Object.assign({}, maximum), minimum), defaultRules) : defaultRules;
 };
+/**
+ * Get validation rules for a string field.
+ *
+ * @param { StringFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getStringValidationRules = (definition) => {
     const defaultRules = {};
     const minLength = definition.minimumLength
@@ -160,18 +196,42 @@ const getStringValidationRules = (definition) => {
     return definition.uiEditable
         ? Object.assign(Object.assign(Object.assign(Object.assign({}, maxLength), minLength), pattern), defaultRules) : defaultRules;
 };
+/**
+ * Get validation rules for a boolean field.
+ *
+ * @param { BooleanFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getBooleanValidationRules = (definition) => {
     const defaultRules = {};
     return defaultRules;
 };
+/**
+ * Get validation rules for a dropdown field.
+ *
+ * @param { DropDownFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getDropdownValidationRules = (definition) => {
     const defaultRules = {};
     return defaultRules;
 };
+/**
+ * Get validation rules for a date field.
+ *
+ * @param { DateFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getDateValidationRules = (definition) => {
     const defaultRules = {};
     return defaultRules;
 };
+/**
+ * Get validation rules for an email field.
+ *
+ * @param { EmailFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getEmailValidationRules = (definition) => {
     const defaultRules = {};
     const pattern = {
@@ -183,6 +243,12 @@ const getEmailValidationRules = (definition) => {
     return definition.uiEditable
         ? Object.assign(Object.assign({}, pattern), defaultRules) : defaultRules;
 };
+/**
+ * Get validation rules for a phonenumber field.
+ *
+ * @param { PhoneNumberFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 const getPhoneNumberValidationRules = (definition) => {
     const defaultRules = {};
     const pattern = {
@@ -192,6 +258,15 @@ const getPhoneNumberValidationRules = (definition) => {
         ? Object.assign(Object.assign({}, pattern), defaultRules) : defaultRules;
 };
 
+/**
+ * A component that renders a custom field based on the field definition
+ *
+ * @param field A field definition and value
+ * @param validation A validation object that contains the register, setValue and formState
+ * @param unitPreference A unit preference that can be used to override the default unit preference
+ * @param fieldId An optional Id to override the definition.key
+ * @returns { JSX.Element } A JSX.Element or null if the field definition is undefined
+ */
 const useCustomFieldResolver = (field, validation, unitPreference = "SI", fieldId) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
     const [isEditing, setIsEditing] = useState(false);
@@ -283,6 +358,9 @@ const useCustomFieldResolver = (field, validation, unitPreference = "SI", fieldI
             throw new Error(`Type not supported: ${type}`);
     }
 };
+/**
+ *
+ */
 const CustomField = ({ field, register, formState, setValue, unitPreference, fieldId }) => {
     const fieldComponent = useCustomFieldResolver(field, { register, setValue, formState }, unitPreference, fieldId);
     return fieldComponent;

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@trackunit/custom-field-components",
-  "version": "0.0.278",
+  "version": "0.0.279",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "dependencies": {
-    "@trackunit/react-core-contexts-test": "0.1.32",
-    "@trackunit/react-components": "0.1.63",
+    "@trackunit/react-core-contexts-test": "0.1.33",
+    "@trackunit/react-components": "0.1.64",
     "react": "18.2.0",
     "react-hook-form": "7.40.0",
-    "@trackunit/iris-app-runtime-core": "0.3.20",
-    "@trackunit/iris-app-runtime-core-api": "0.3.18",
+    "@trackunit/iris-app-runtime-core": "0.3.21",
+    "@trackunit/iris-app-runtime-core-api": "0.3.19",
     "@trackunit/tailwind-styled-components": "0.0.54",
     "react-select": "5.7.0",
     "libphonenumber-js": "1.10.24"

package/src/BooleanCustomField.d.ts

@@ -8,7 +8,6 @@ export interface BooleanCustomFieldProps extends Omit<CheckboxProps, "value" | "
      * A id for the field
      *
      * @memberof BooleanCustomFieldProps
-     *
      */
     id: string;
     /**
@@ -72,4 +71,10 @@ export interface BooleanCustomFieldProps extends Omit<CheckboxProps, "value" | "
      */
     errorMessage?: string;
 }
+/**
+ * A component that can be used to render a boolean field
+ *
+ * @param options BooleanCustomFieldProps - options for the component
+ * @returns { JSX.Element } JSX.Element - a component that can be used to render a boolean field
+ */
 export declare const BooleanCustomField: ({ defaultValue, dataTestId, onChange, value, id, setValue, register, validationRules, disabled, label, tip, isInvalid, errorMessage, helpAddon, maxLength, helpText, ...rest }: BooleanCustomFieldProps) => JSX.Element;

package/src/CustomField.d.ts

@@ -19,6 +19,18 @@ export interface ICustomFieldValidation {
     setValue: UseFormSetValue<FieldValues>;
     formState: FormState<FieldValues>;
 }
+/**
+ * A component that renders a custom field based on the field definition
+ *
+ * @param field A field definition and value
+ * @param validation A validation object that contains the register, setValue and formState
+ * @param unitPreference A unit preference that can be used to override the default unit preference
+ * @param fieldId An optional Id to override the definition.key
+ * @returns { JSX.Element } A JSX.Element or null if the field definition is undefined
+ */
 export declare const useCustomFieldResolver: (field: ValueAndDefinition, validation: ICustomFieldValidation, unitPreference?: UnitPreference, fieldId?: string) => JSX.Element | null;
+/**
+ *
+ */
 export declare const CustomField: ({ field, register, formState, setValue, unitPreference, fieldId }: ICustomFieldProps) => JSX.Element | null;
 export {};

package/src/DateCustomField.d.ts

@@ -45,4 +45,10 @@ export interface DateCustomFieldProps extends Omit<DateFieldProps, "label">, For
      */
     title?: string;
 }
+/**
+ * A component that can be used to render a date field
+ *
+ * @param props DateCustomFieldProps - options for the component
+ * @returns { JSX.Element } JSX.Element - a component that can be used to render a date field
+ */
 export declare const DateCustomField: (props: DateCustomFieldProps) => JSX.Element;

package/src/DropdownCustomField.d.ts

@@ -90,5 +90,11 @@ export interface DropdownCustomFieldProps extends FormGroupExposedProps {
 }
 type OnChange = (event?: React.ChangeEvent<HTMLInputElement>) => void;
 type OnBlur = (event: React.FocusEvent<HTMLDivElement>) => void;
+/**
+ * A custom field that can be used to render a dropdown
+ *
+ * @param options DropdownCustomFieldProps - an object with all the props
+ * @returns {JSX.Element} - a dropdown component
+ */
 export declare const DropdownCustomField: ({ defaultValue, dataTestId, onChange, onBlur, id, disabled, allValues, multiSelect, register, validationRules, setValue, label, tip, errorMessage, helpText, isInvalid, helpAddon, }: DropdownCustomFieldProps) => JSX.Element;
 export {};

package/src/getValidationRules.d.ts

@@ -1,11 +1,62 @@
 import { BooleanFieldDefinition, DateFieldDefinition, DropDownFieldDefinition, EmailFieldDefinition, NumberFieldDefinition, PhoneNumberFieldDefinition, StringFieldDefinition, WebAddressFieldDefinition } from "@trackunit/iris-app-runtime-core-api";
 import { RegisterOptions } from "react-hook-form";
+/**
+ * Validation rules for a field
+ */
 export type ValidationRules = RegisterOptions;
+/**
+ * Get validation rules for a field
+ *
+ * @param { WebAddressFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getWebAddressValidationRules: (definition: WebAddressFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a field.
+ *
+ * @param { NumberFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getNumberValidationRules: (definition: NumberFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a string field.
+ *
+ * @param { StringFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getStringValidationRules: (definition: StringFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a boolean field.
+ *
+ * @param { BooleanFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getBooleanValidationRules: (definition: BooleanFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a dropdown field.
+ *
+ * @param { DropDownFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getDropdownValidationRules: (definition: DropDownFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a date field.
+ *
+ * @param { DateFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getDateValidationRules: (definition: DateFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for an email field.
+ *
+ * @param { EmailFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getEmailValidationRules: (definition: EmailFieldDefinition) => ValidationRules;
+/**
+ * Get validation rules for a phonenumber field.
+ *
+ * @param { PhoneNumberFieldDefinition } definition the field definition
+ * @returns { ValidationRules} the validation rules
+ */
 export declare const getPhoneNumberValidationRules: (definition: PhoneNumberFieldDefinition) => ValidationRules;