envoc-form 4.1.0 → 5.0.1

package/es/Field/FieldSection.js

@@ -1,20 +1,9 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-import { useContext } from 'react';
-import { FieldNameContext } from './FieldNameContext';
-export default function FieldSection(_a) {
-    var children = _a.children, name = _a.name;
-    var parentContext = useContext(FieldNameContext);
-    var effectiveValue = parentContext ? "".concat(parentContext, ".").concat(name) : name;
-    return (_jsx(FieldNameContext.Provider, __assign({ value: effectiveValue }, { children: children })));
-}
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useContext } from 'react';
+import { FieldNameContext } from './FieldNameContext';
+export default function FieldSection(_a) {
+    var children = _a.children, name = _a.name;
+    var parentContext = useContext(FieldNameContext);
+    var effectiveValue = parentContext ? "".concat(parentContext, ".").concat(name) : name;
+    return (_jsx(FieldNameContext.Provider, { value: effectiveValue, children: children }));
+}

package/es/Field/InjectedFieldProps.d.ts

@@ -1,7 +1,7 @@
-import { CustomFieldInputProps } from './CustomFieldInputProps';
-import { CustomFieldMetaProps } from './CustomFieldMetaProps';
-/** Defines what is injected by a Field wrapper of some TRenderComponent */
-export interface InjectedFieldProps<TValue> {
-    input: CustomFieldInputProps<TValue>;
-    meta: CustomFieldMetaProps<TValue>;
-}
+import { CustomFieldInputProps } from './CustomFieldInputProps';
+import { CustomFieldMetaProps } from './CustomFieldMetaProps';
+/** Defines what is injected by a Field wrapper of some TRenderComponent */
+export interface InjectedFieldProps<TValue> {
+    input: CustomFieldInputProps<TValue>;
+    meta: CustomFieldMetaProps<TValue>;
+}

package/es/Field/InjectedFieldProps.js

@@ -1 +1 @@
-export {};
+export {};

package/es/Field/StandAloneInput.d.ts

@@ -1,13 +1,13 @@
-import { ElementType } from 'react';
-import { RenderComponent, RenderComponentProps } from './Field';
-import { InjectedFieldProps } from './InjectedFieldProps';
-export declare type StandAloneInputProps<TValue, TRenderComponent extends ElementType> = {
-    /** Component to render inside of the field. */
-    Component: RenderComponent<TValue, TRenderComponent>;
-    /** Value of the field. */
-    value: TValue;
-    /** Function to change the value of the field. */
-    onChange: (arg: TValue) => void;
-} & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | 'validate'>;
-/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
-export default function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): JSX.Element;
+import { ElementType } from 'react';
+import { RenderComponent, RenderComponentProps } from './Field';
+import { InjectedFieldProps } from './InjectedFieldProps';
+export type StandAloneInputProps<TValue, TRenderComponent extends ElementType> = {
+    /** Component to render inside of the field. */
+    Component: RenderComponent<TValue, TRenderComponent>;
+    /** Value of the field. */
+    value: TValue;
+    /** Function to change the value of the field. */
+    onChange: (arg: TValue) => void;
+} & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | 'validate'>;
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
+export default function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): import("react/jsx-runtime").JSX.Element;

package/es/Field/StandAloneInput.js

@@ -1,50 +1,50 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-import { jsx as _jsx } from "react/jsx-runtime";
-import { useRef } from 'react';
-import * as uuid from 'uuid';
-/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
-export default function StandAloneInput(props) {
-    var Component = props.Component, value = props.value, onChange = props.onChange, disabled = props.disabled, rest = __rest(props, ["Component", "value", "onChange", "disabled"]);
-    var handleChange = function (arg) {
-        if (!disabled) {
-            onChange(arg);
-        }
-    };
-    var Wrapped = Component;
-    var idRef = useRef(uuid.v4());
-    var input = {
-        id: idRef.current,
-        name: idRef.current,
-        value: value,
-        onChange: handleChange,
-        onBlur: function () { },
-    };
-    var meta = {
-        warning: undefined,
-        value: value,
-        touched: false,
-        initialTouched: false,
-    };
-    return _jsx(Wrapped, __assign({}, rest, { disabled: disabled, input: input, meta: meta }));
-}
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useRef } from 'react';
+import * as uuid from 'uuid';
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
+export default function StandAloneInput(props) {
+    var Component = props.Component, value = props.value, onChange = props.onChange, disabled = props.disabled, rest = __rest(props, ["Component", "value", "onChange", "disabled"]);
+    var handleChange = function (arg) {
+        if (!disabled) {
+            onChange(arg);
+        }
+    };
+    var Wrapped = Component;
+    var idRef = useRef(uuid.v4());
+    var input = {
+        id: idRef.current,
+        name: idRef.current,
+        value: value,
+        onChange: handleChange,
+        onBlur: function () { },
+    };
+    var meta = {
+        warning: undefined,
+        value: value,
+        touched: false,
+        initialTouched: false,
+    };
+    return _jsx(Wrapped, __assign({}, rest, { disabled: disabled, input: input, meta: meta }));
+}

package/es/Field/useStandardField.d.ts

@@ -1,21 +1,21 @@
-import { CustomFieldInputProps } from './CustomFieldInputProps';
-import { CustomFieldMetaProps } from './CustomFieldMetaProps';
-import { NormalizationFunction } from '../Normalization/NormalizationFunction';
-import { ValidationFunction } from '../Validation/ValidationFunction';
-export interface useStandardFieldProps<TValue> {
-    /** Id of the field. */
-    id?: string;
-    /** Name of the field. */
-    name: string;
-    /** Whether the field should be disabled. */
-    disabled?: boolean;
-    /** Function to validate the field. */
-    validate?: ValidationFunction<TValue> | ValidationFunction<TValue>[];
-    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
-    normalize?: NormalizationFunction<TValue>;
-}
-/** Provides a consistent way to deal with all form fields (non array). */
-export default function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
-    CustomFieldInputProps<TValue>,
-    CustomFieldMetaProps<TValue>
-];
+import { CustomFieldInputProps } from './CustomFieldInputProps';
+import { CustomFieldMetaProps } from './CustomFieldMetaProps';
+import { NormalizationFunction } from '../Normalization/NormalizationFunction';
+import { ValidationFunction } from '../Validation/ValidationFunction';
+export interface useStandardFieldProps<TValue> {
+    /** Id of the field. */
+    id?: string;
+    /** Name of the field. */
+    name: string;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    /** Function to validate the field. */
+    validate?: ValidationFunction<TValue> | ValidationFunction<TValue>[];
+    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
+    normalize?: NormalizationFunction<TValue>;
+}
+/** Provides a consistent way to deal with all form fields (non array). */
+export default function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
+    CustomFieldInputProps<TValue>,
+    CustomFieldMetaProps<TValue>
+];

package/es/Field/useStandardField.js

@@ -1,92 +1,92 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import { useContext, useEffect } from 'react';
-import { useField, useFormikContext } from 'formik';
-import { FieldNameContext } from './FieldNameContext';
-import { ServerErrorContext } from '../Form/ServerErrorContext';
-/** Provides a consistent way to deal with all form fields (non array). */
-export default function useStandardField(_a) {
-    var providedId = _a.id, providedName = _a.name, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize;
-    // because the formik errors are evaluated all at the same time we need to keep server errors separate
-    var _b = useContext(ServerErrorContext), getServerError = _b.getError, setServerError = _b.setError;
-    // ensure that form section values are obeyed, e.g. homeAddress.zipCode
-    var fieldNameContextValue = useContext(FieldNameContext);
-    var name = fieldNameContextValue
-        ? "".concat(fieldNameContextValue, ".").concat(providedName)
-        : providedName;
-    // ensure that nested contexts don't have duplicate id issues when an id is specified
-    var id = providedId
-        ? fieldNameContextValue
-            ? "".concat(fieldNameContextValue, ".").concat(providedId)
-            : providedId
-        : name;
-    // ensure that our custom validation rules are handled
-    // e.g. we allow arrays of validators
-    var _c = useField({
-        name: name,
-        id: id ? id : name,
-        disabled: disabled,
-        validate: callAllValidators,
-    }), formikInput = _c[0], formikMeta = _c[1];
-    var _d = useFormikContext(), setFieldTouched = _d.setFieldTouched, setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
-    var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
-    useEffect(function () {
-        if (!touched && isSubmitting) {
-            // because we do not always register all fields up front.
-            // e.g. formik expects even a 'create' form to have all fields given, at least, blank values
-            // It looks like this was going to be a thing: https://github.com/jaredpalmer/formik/issues/691
-            // Formik appears to not have an active maintainer: https://github.com/jaredpalmer/formik/discussions/3526
-            // We previously had a different fix in place using handleBlur, but it was causing an infinite update cycle.
-            // This was noted as existing, but there was a note about it not working for FieldArray (this does appear to work in my testing with FieldArray)
-            setFieldTouched(name);
-        }
-    }, [isSubmitting, name, setFieldTouched, touched]);
-    // these are the props we expect consumers of this hook to pass directly to the input (or other control)
-    var resultInput = {
-        name: formikInput.name,
-        // pass any direct from server props through normalize without making the form dirty (e.g. phone number)
-        value: normalize ? normalize(formikInput.value) : formikInput.value,
-        onChange: handleChange,
-        onBlur: handleBlur,
-        // extensions to formik
-        id: id,
-    };
-    var resultMeta = __assign(__assign({}, formikMeta), { error: getServerError(name) || (touched ? formikMeta.error : undefined), 
-        // extensions to formik
-        warning: undefined, touched: touched });
-    return [resultInput, resultMeta];
-    function handleBlur() {
-        formikInput.onBlur({ target: { name: name } });
-    }
-    function handleChange(value) {
-        if (disabled) {
-            return;
-        }
-        var normalized = normalize ? normalize(value) : value;
-        setFieldValue(name, normalized);
-        setServerError(name, undefined);
-    }
-    function callAllValidators(value) {
-        if (disabled || !validate) {
-            return;
-        }
-        if (!Array.isArray(validate)) {
-            return validate(value);
-        }
-        for (var i = 0; i < validate.length; i++) {
-            var result = validate[i](value);
-            if (result) {
-                return result;
-            }
-        }
-    }
-}
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { useContext, useEffect } from 'react';
+import { useField, useFormikContext } from 'formik';
+import { FieldNameContext } from './FieldNameContext';
+import { ServerErrorContext } from '../Form/ServerErrorContext';
+/** Provides a consistent way to deal with all form fields (non array). */
+export default function useStandardField(_a) {
+    var providedId = _a.id, providedName = _a.name, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize;
+    // because the formik errors are evaluated all at the same time we need to keep server errors separate
+    var _b = useContext(ServerErrorContext), getServerError = _b.getError, setServerError = _b.setError;
+    // ensure that form section values are obeyed, e.g. homeAddress.zipCode
+    var fieldNameContextValue = useContext(FieldNameContext);
+    var name = fieldNameContextValue
+        ? "".concat(fieldNameContextValue, ".").concat(providedName)
+        : providedName;
+    // ensure that nested contexts don't have duplicate id issues when an id is specified
+    var id = providedId
+        ? fieldNameContextValue
+            ? "".concat(fieldNameContextValue, ".").concat(providedId)
+            : providedId
+        : name;
+    // ensure that our custom validation rules are handled
+    // e.g. we allow arrays of validators
+    var _c = useField({
+        name: name,
+        id: id ? id : name,
+        disabled: disabled,
+        validate: callAllValidators,
+    }), formikInput = _c[0], formikMeta = _c[1];
+    var _d = useFormikContext(), setFieldTouched = _d.setFieldTouched, setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
+    var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
+    useEffect(function () {
+        if (!touched && isSubmitting) {
+            // because we do not always register all fields up front.
+            // e.g. formik expects even a 'create' form to have all fields given, at least, blank values
+            // It looks like this was going to be a thing: https://github.com/jaredpalmer/formik/issues/691
+            // Formik appears to not have an active maintainer: https://github.com/jaredpalmer/formik/discussions/3526
+            // We previously had a different fix in place using handleBlur, but it was causing an infinite update cycle.
+            // This was noted as existing, but there was a note about it not working for FieldArray (this does appear to work in my testing with FieldArray)
+            setFieldTouched(name);
+        }
+    }, [isSubmitting, name, setFieldTouched, touched]);
+    // these are the props we expect consumers of this hook to pass directly to the input (or other control)
+    var resultInput = {
+        name: formikInput.name,
+        // pass any direct from server props through normalize without making the form dirty (e.g. phone number)
+        value: normalize ? normalize(formikInput.value) : formikInput.value,
+        onChange: handleChange,
+        onBlur: handleBlur,
+        // extensions to formik
+        id: id,
+    };
+    var resultMeta = __assign(__assign({}, formikMeta), { error: getServerError(name) || (touched ? formikMeta.error : undefined), 
+        // extensions to formik
+        warning: undefined, touched: touched });
+    return [resultInput, resultMeta];
+    function handleBlur() {
+        formikInput.onBlur({ target: { name: name } });
+    }
+    function handleChange(value) {
+        if (disabled) {
+            return;
+        }
+        var normalized = normalize ? normalize(value) : value;
+        setFieldValue(name, normalized);
+        setServerError(name, undefined);
+    }
+    function callAllValidators(value) {
+        if (disabled || !validate) {
+            return;
+        }
+        if (!Array.isArray(validate)) {
+            return validate(value);
+        }
+        for (var i = 0; i < validate.length; i++) {
+            var result = validate[i](value);
+            if (result) {
+                return result;
+            }
+        }
+    }
+}

package/es/FieldArray/FieldArray.d.ts

@@ -1,24 +1,24 @@
-import { ElementType } from 'react';
-import { FieldProps } from '../Field/Field';
-import { ValidationFunction } from '../Validation/ValidationFunction';
-export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined | null ? {
-    /** Name of the field, used on submission. If using codegen this must be the provided dto. */
-    name: TProp;
-    /** Label of the field. */
-    label?: string;
-    /** Whether the field should be disabled. */
-    disabled?: boolean;
-    /** Function to validate the value. */
-    validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
-    children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX.Element;
-} : never;
-export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> = TValue extends Array<infer TForm> | undefined | null ? TForm extends object ? {
-    Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX.Element;
-    FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
-} : never : never;
-/**
- * An array of fields that allows the user to add multiple instances of the same field.
- *
- * Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
- */
-export default function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): JSX.Element;
+import { ElementType } from 'react';
+import { FieldProps } from '../Field/Field';
+import { ValidationFunction } from '../Validation/ValidationFunction';
+export type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined | null ? {
+    /** Name of the field, used on submission. If using codegen this must be the provided dto. */
+    name: TProp;
+    /** Label of the field. */
+    label?: string;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    /** Function to validate the value. */
+    validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
+    children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX.Element;
+} : never;
+export type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> = TValue extends Array<infer TForm> | undefined | null ? TForm extends object ? {
+    Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX.Element;
+    FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
+} : never : never;
+/**
+ * An array of fields that allows the user to add multiple instances of the same field.
+ *
+ * Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
+ */
+export default function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): import("react/jsx-runtime").JSX.Element;