@trackunit/custom-field-components 0.0.386 → 0.0.395

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@trackunit/custom-field-components",
-  "version": "0.0.386",
+  "version": "0.0.395",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=16.x"
   },
   "dependencies": {
-    "@trackunit/iris-app-runtime-core": "0.3.50",
-    "@trackunit/iris-app-runtime-core-api": "0.3.44",
-    "@trackunit/react-components": "0.1.117",
-    "@trackunit/react-core-contexts-test": "0.1.75",
-    "@trackunit/react-form-components": "0.0.67",
-    "@trackunit/tailwind-styled-components": "0.0.57",
+    "@trackunit/iris-app-runtime-core": "0.3.51",
+    "@trackunit/iris-app-runtime-core-api": "0.3.45",
+    "@trackunit/react-components": "0.1.124",
+    "@trackunit/react-core-contexts-test": "0.1.77",
+    "@trackunit/react-form-components": "0.0.76",
+    "@trackunit/tailwind-styled-components": "0.0.58",
     "libphonenumber-js": "1.10.36",
     "react": "18.2.0",
     "react-hook-form": "7.40.0",

package/src/BooleanCustomField.d.ts

@@ -1,80 +1,80 @@
-import { CheckboxProps } from "@trackunit/react-form-components";
-import * as React from "react";
-import { FieldValues, UseFormRegister, UseFormSetValue } from "react-hook-form";
-import { ValidationRules } from "./getValidationRules";
-import { FormGroupExposedProps } from "./types";
-export interface BooleanCustomFieldProps extends Omit<CheckboxProps, "value" | "defaultValue" | "label">, FormGroupExposedProps {
-    /**
-     * A id for the field
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    id: string;
-    /**
-     * A value to be displayed by a input field
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    description?: string;
-    /**
-     * A text to be displayed under the input with a short description of field purpose
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    value?: boolean;
-    /**
-     * A default value to be displayed by a input field
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    defaultValue?: boolean;
-    /**
-     * A id that can be used in tests to get the component
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    dataTestId?: string;
-    /**
-     * A custom handler for onChange event
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    onChange?: (event: React.SyntheticEvent<HTMLInputElement>) => void;
-    /**
-     * A flag that can be used to disable the input, default value is false
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    disabled?: boolean;
-    /**
-     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    setValue?: UseFormSetValue<FieldValues>;
-    /**
-     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    register?: UseFormRegister<FieldValues>;
-    /**
-     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    validationRules?: ValidationRules;
-    /**
-     * If a value is set, the field is rendered in its invalid state.
-     *
-     * @memberof BooleanCustomFieldProps
-     */
-    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;
+import { CheckboxProps } from "@trackunit/react-form-components";
+import * as React from "react";
+import { FieldValues, UseFormRegister, UseFormSetValue } from "react-hook-form";
+import { ValidationRules } from "./getValidationRules";
+import { FormGroupExposedProps } from "./types";
+export interface BooleanCustomFieldProps extends Omit<CheckboxProps, "value" | "defaultValue" | "label">, FormGroupExposedProps {
+    /**
+     * A id for the field
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    id: string;
+    /**
+     * A value to be displayed by a input field
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    description?: string;
+    /**
+     * A text to be displayed under the input with a short description of field purpose
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    value?: boolean;
+    /**
+     * A default value to be displayed by a input field
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    defaultValue?: boolean;
+    /**
+     * A id that can be used in tests to get the component
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    dataTestId?: string;
+    /**
+     * A custom handler for onChange event
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    onChange?: (event: React.SyntheticEvent<HTMLInputElement>) => void;
+    /**
+     * A flag that can be used to disable the input, default value is false
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    disabled?: boolean;
+    /**
+     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    setValue?: UseFormSetValue<FieldValues>;
+    /**
+     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    register?: UseFormRegister<FieldValues>;
+    /**
+     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    validationRules?: ValidationRules;
+    /**
+     * If a value is set, the field is rendered in its invalid state.
+     *
+     * @memberof BooleanCustomFieldProps
+     */
+    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

@@ -1,36 +1,36 @@
-/// <reference types="react" />
-import { AbstractValueAndDefinition } from "@trackunit/iris-app-runtime-core";
-import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core-api";
-import { FieldValues, FormState, UseFormRegister, UseFormSetValue } from "react-hook-form";
-import { UnitPreference } from "./UnitPreference";
-interface ICustomFieldProps {
-    field: AbstractValueAndDefinition;
-    register: UseFormRegister<FieldValues>;
-    formState: FormState<FieldValues>;
-    setValue: UseFormSetValue<FieldValues>;
-    unitPreference?: UnitPreference;
-    /**
-     * An optional Id to override the definition.key
-     */
-    fieldId?: string;
-}
-export interface ICustomFieldValidation {
-    register: UseFormRegister<FieldValues>;
-    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 {};
+/// <reference types="react" />
+import { AbstractValueAndDefinition } from "@trackunit/iris-app-runtime-core";
+import { ValueAndDefinition } from "@trackunit/iris-app-runtime-core-api";
+import { FieldValues, FormState, UseFormRegister, UseFormSetValue } from "react-hook-form";
+import { UnitPreference } from "./UnitPreference";
+interface ICustomFieldProps {
+    field: AbstractValueAndDefinition;
+    register: UseFormRegister<FieldValues>;
+    formState: FormState<FieldValues>;
+    setValue: UseFormSetValue<FieldValues>;
+    unitPreference?: UnitPreference;
+    /**
+     * An optional Id to override the definition.key
+     */
+    fieldId?: string;
+}
+export interface ICustomFieldValidation {
+    register: UseFormRegister<FieldValues>;
+    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

@@ -1,54 +1,54 @@
-/// <reference types="react" />
-import { DateFieldProps } from "@trackunit/react-form-components";
-import { FieldValues, RegisterOptions, UseFormRegister, UseFormSetValue } from "react-hook-form";
-import { FormGroupExposedProps } from "./types";
-export interface DateCustomFieldProps extends Omit<DateFieldProps, "label">, FormGroupExposedProps {
-    /**
-     * A id for the field
-     *
-     * @memberof DateCustomFieldProps
-     */
-    id: string;
-    /**
-     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
-     *
-     * @memberof DateCustomFieldProps
-     */
-    setValue?: UseFormSetValue<FieldValues>;
-    /**
-     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
-     *
-     * @memberof DateCustomFieldProps
-     */
-    register?: UseFormRegister<FieldValues>;
-    /**
-     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
-     *
-     * @memberof DateCustomFieldProps
-     */
-    validationRules?: RegisterOptions;
-    /**
-     * If a value is set, the field is rendered in its invalid state.
-     *
-     * @memberof DateCustomFieldProps
-     */
-    errorMessage?: string;
-    /**
-     * A boolean flag to set a component into invalid state
-     * which means that selected value is breaking validation rules
-     *
-     * @memberof DateCustomFieldProps
-     */
-    isInvalid?: boolean;
-    /**
-     * The label for the Date.
-     */
-    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;
+/// <reference types="react" />
+import { DateFieldProps } from "@trackunit/react-form-components";
+import { FieldValues, RegisterOptions, UseFormRegister, UseFormSetValue } from "react-hook-form";
+import { FormGroupExposedProps } from "./types";
+export interface DateCustomFieldProps extends Omit<DateFieldProps, "label">, FormGroupExposedProps {
+    /**
+     * A id for the field
+     *
+     * @memberof DateCustomFieldProps
+     */
+    id: string;
+    /**
+     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
+     *
+     * @memberof DateCustomFieldProps
+     */
+    setValue?: UseFormSetValue<FieldValues>;
+    /**
+     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
+     *
+     * @memberof DateCustomFieldProps
+     */
+    register?: UseFormRegister<FieldValues>;
+    /**
+     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
+     *
+     * @memberof DateCustomFieldProps
+     */
+    validationRules?: RegisterOptions;
+    /**
+     * If a value is set, the field is rendered in its invalid state.
+     *
+     * @memberof DateCustomFieldProps
+     */
+    errorMessage?: string;
+    /**
+     * A boolean flag to set a component into invalid state
+     * which means that selected value is breaking validation rules
+     *
+     * @memberof DateCustomFieldProps
+     */
+    isInvalid?: boolean;
+    /**
+     * The label for the Date.
+     */
+    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

@@ -1,100 +1,100 @@
-import * as React from "react";
-import { FieldValues, RegisterOptions, UseFormRegister, UseFormSetValue } from "react-hook-form";
-import { FormGroupExposedProps } from "./types";
-export interface DropdownCustomFieldProps extends FormGroupExposedProps {
-    /**
-     * A id for the field
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    id: string;
-    /**
-     * A text to be displayed under the input with a short description of field purpose
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    description?: string;
-    /**
-     * A default value to be displayed by a input field
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    defaultValue?: string[];
-    /**
-     * A id that can be used in tests to get the component
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    dataTestId?: string;
-    /**
-     * A custom handler for onChange event
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    onChange?: OnChange;
-    /**
-     * A flag that can be used to disable the dropdown, default value is false
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    disabled?: boolean;
-    /**
-     * A flag that can be used to enable multiselect mode, default value is false
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    multiSelect?: boolean;
-    /**
-     * An array of values to select for
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    allValues: string[] | undefined;
-    /**
-     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    setValue?: UseFormSetValue<FieldValues>;
-    /**
-     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    register?: UseFormRegister<FieldValues>;
-    /**
-     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
-     *
-     * @memberof  DropdownCustomFieldProps
-     */
-    validationRules?: RegisterOptions;
-    /**
-     * A custom handler for the onBlur event
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    onBlur?: OnBlur;
-    /**
-     * If a value is set, the field is rendered in its invalid state.
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    errorMessage?: string;
-    /**
-     * A boolean flag to set a component into invalid state
-     * which means that selected value is breaking validation rules
-     *
-     * @memberof DropdownCustomFieldProps
-     */
-    isInvalid?: boolean;
-}
-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 {};
+import * as React from "react";
+import { FieldValues, RegisterOptions, UseFormRegister, UseFormSetValue } from "react-hook-form";
+import { FormGroupExposedProps } from "./types";
+export interface DropdownCustomFieldProps extends FormGroupExposedProps {
+    /**
+     * A id for the field
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    id: string;
+    /**
+     * A text to be displayed under the input with a short description of field purpose
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    description?: string;
+    /**
+     * A default value to be displayed by a input field
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    defaultValue?: string[];
+    /**
+     * A id that can be used in tests to get the component
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    dataTestId?: string;
+    /**
+     * A custom handler for onChange event
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    onChange?: OnChange;
+    /**
+     * A flag that can be used to disable the dropdown, default value is false
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    disabled?: boolean;
+    /**
+     * A flag that can be used to enable multiselect mode, default value is false
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    multiSelect?: boolean;
+    /**
+     * An array of values to select for
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    allValues: string[] | undefined;
+    /**
+     * Used for field validation by React Hook Form library it dynamically set the value of a registered field and have the options to validate and update the form state. At the same time, it tries to avoid unnecessary rerender.
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    setValue?: UseFormSetValue<FieldValues>;
+    /**
+     * This method allows you to register an input or select element and apply validation rules to React Hook Form. Validation rules are all based on the HTML standard and also allow for custom validation methods.
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    register?: UseFormRegister<FieldValues>;
+    /**
+     * Validation rules that can be passed to the field, they can be pass along with error messages. Rules are described here https://react-hook-form.com/api/useform/register
+     *
+     * @memberof  DropdownCustomFieldProps
+     */
+    validationRules?: RegisterOptions;
+    /**
+     * A custom handler for the onBlur event
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    onBlur?: OnBlur;
+    /**
+     * If a value is set, the field is rendered in its invalid state.
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    errorMessage?: string;
+    /**
+     * A boolean flag to set a component into invalid state
+     * which means that selected value is breaking validation rules
+     *
+     * @memberof DropdownCustomFieldProps
+     */
+    isInvalid?: boolean;
+}
+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/UnitPreference.d.ts

@@ -1 +1 @@
-export type UnitPreference = "SI" | "US_CUSTOMARY";
+export type UnitPreference = "SI" | "US_CUSTOMARY";