@vertigis/workflow 5.35.1 → 5.37.0

package/forms/components/TextBox.d.ts

@@ -1,21 +1,7 @@
-/// <reference types="react" />
-import { BaseFormElementProps } from "../FormElement";
-interface TextBoxProps extends BaseFormElementProps {
-    /**
-     * Whether this is a text box or a password input. Default is "text".
-     *
-     * The differences are:
-     *
-     * - `"text"` renders as a text box, `"password"` as a password.
-     * (Obvious, but there you go.)
-     * - `"text"` will convert a numeric value to a string, `"password"` will not.
-     * - `"password"` does not support `element.maxLength` or `element.readOnly`.
-     *
-     */
-    type?: "text" | "password";
-}
-/**
- * The component for the "Text Box" and "Password Box" Form Elements.
- */
-declare const TextBox: ({ className, component, element, type }: TextBoxProps) => JSX.Element;
-export default TextBox;
+/// <reference types="react" />
+import { FormElementProps } from "../..";
+/**
+ * The component for the "Text Box" and "Password Box" Form Elements.
+ */
+declare const TextBox: ({ className, component, element, enabled, formatNumber, type: elementType, maxLength: elementMaxLength, name, prompt, readOnly: elementReadOnly, renderFocus: hostRenderFocus, require, tooltip, value: elementValue, renderText, setValue: setElementValue, }: FormElementProps<string | undefined>) => JSX.Element;
+export default TextBox;

package/forms/components/TextBox.js

@@ -1 +1 @@
-import Input from"@vertigis/react-ui/Input";import*as React from"react";import{useEffect,useState}from"react";import FormElement from"../FormElement.js";import{getKeyString}from"../keyboard.js";import{makeUniqueId}from"../utils.js";const TextBox=({className:e,component:r,element:a,type:t})=>{const[n,o]=useState(""),{host:u,name:l}=r.props;var p=`${makeUniqueId(l)}-input`,m="password"===t,i=m?void 0:a.maxLength,s=u.renderText(a.prompt),c=m?void 0:a.readOnly,m=u.renderText(a.tooltip);useEffect(()=>{let e="";var t=a.value;"string"==typeof t?e=t:"number"==typeof t&&(e=u.formatNumber(t)),a.value!==e&&(a.value=e,r.forceUpdate()),o(e)},[a.value]);const d=e=>{a.value=e,u.post("changed",{name:l,value:e}),o(e)};return React.createElement(FormElement,{className:e,component:r,element:a,inputId:p},React.createElement(Input,{disabled:!r.enabled,fullWidth:!0,id:p,inputProps:{maxLength:i,onKeyDown:e=>{var t=getKeyString(e);return"enter"===t?(e=>{const t=e.currentTarget;var r=t.value;if(r!==a.value)return d(r),t.select(),e.stopPropagation(),e.preventDefault(),!1})(e):"escape"===t?(e=>{const t=e.currentTarget;if(t.value!==a.value)return o(a.value),t.select(),e.stopPropagation(),e.preventDefault(),!1})(e):void 0},title:m},inputRef:e=>{null===e||e.disabled||u.renderFocus(e,l)},onBlur:e=>{e=e.target.value;e!=a.value&&d(e)},onChange:e=>{e=e.target.value;e!=n&&o(e)},placeholder:s,readOnly:c,required:a.require,type:t,value:n}))};export default TextBox;
+import Input from"@vertigis/react-ui/Input";import*as React from"react";import{useEffect,useState}from"react";import FormElement from"../FormElement.js";import{FormElementTypes}from"../constants.js";import{getKeyString}from"../keyboard.js";import{makeUniqueId}from"../utils.js";const TextBox=({className:e,component:t,element:r,enabled:n,formatNumber:o,type:a,maxLength:m,name:l,prompt:u,readOnly:s,renderFocus:p,require:i,tooltip:c,value:d,renderText:f,setValue:g})=>{const[v,y]=useState("");var x=`${makeUniqueId(l)}-input`;const E=a===FormElementTypes.PASSWORDBOX;m=E?void 0:m,u=f(u),s=E?void 0:s,c=f(c);useEffect(()=>{let e="";"string"==typeof d?e=d:"number"!=typeof d||E||(e=o(d)),d!==e&&g(e,!1),v!==e&&y(e)},[d]);const T=e=>{g(e),y(e)};return React.createElement(FormElement,{className:e,component:t,element:r,inputId:x},React.createElement(Input,{disabled:!n,fullWidth:!0,id:x,inputProps:{maxLength:m,onKeyDown:e=>{var t=getKeyString(e);return"enter"===t?(e=>{const t=e.currentTarget;var r=t.value;if(r!==d)return T(r),t.select(),e.stopPropagation(),e.preventDefault(),!1})(e):"escape"===t?(e=>{const t=e.currentTarget;if(t.value!==d)return y(d),t.select(),e.stopPropagation(),e.preventDefault(),!1})(e):void 0},title:c},inputRef:e=>{null===e||e.disabled||p(e,l)},onBlur:e=>{e=e.target.value;e!=d&&T(e)},onChange:e=>{e=e.target.value;e!=v&&y(e)},placeholder:u,readOnly:s,required:i,type:E?"password":"text",value:v}))};export default TextBox;

package/forms/components/TimePicker.d.ts

@@ -1,7 +1,8 @@
-/// <reference types="react" />
-import { BaseFormElementProps } from "../FormElement";
-/**
- * The component for the "Time Picker" Form Element.
- */
-declare const TimePicker: ({ className, component, element }: BaseFormElementProps) => JSX.Element;
-export default TimePicker;
+/// <reference types="react" />
+import { FormElementProps } from "../..";
+import { defs } from "../FormHost";
+/**
+ * The component for the "Time Picker" Form Element.
+ */
+declare const TimePicker: ({ className, component, deriveLocale, element, enabled, error, name, prompt, renderFocus, renderText, setProperty, setValue: setElementValue, tooltip: elementTooltip, value: elementValue, }: FormElementProps<defs.DateTimeRef | undefined>) => JSX.Element;
+export default TimePicker;

package/forms/components/TimePicker.js

@@ -1 +1 @@
-import{buttonBaseClasses}from"@vertigis/react-ui/ButtonBase";import{clockClasses}from"@vertigis/react-ui/ClockPicker";import FormHelperText from"@vertigis/react-ui/FormHelperText";import FormLabelTextField from"@vertigis/react-ui/FormLabelTextField";import BaseTimePicker from"@vertigis/react-ui/TimePicker";import{styled}from"@vertigis/react-ui/styles";import clsx from"clsx";import*as React from"react";import{useEffect,useRef,useState}from"react";import{Calendar}from"../Calendar.js";import FormElement from"../FormElement.js";import{useFocusCallback}from"../common.js";import{hasErrorChanged,isInvalidDate,makeProperFormat,makeProperValue,updateElementValue}from"../dateUtilities.js";import{makeUniqueId}from"../utils.js";const StylableTimePicker=e=>{const{PopperProps:r={},className:t,...a}=e;return React.createElement(BaseTimePicker,{PopperProps:{...r,className:clsx(r.className,t)},...a})},StyledTimePicker=styled(StylableTimePicker)(({theme:{palette:e}})=>({[`& .${clockClasses.amButton}, .${clockClasses.pmButton}`]:{[`&.${buttonBaseClasses.focusVisible}`]:{color:e.action.active}}})),TimePicker=({className:e,component:r,element:t})=>{const[a,o]=useState(!1),[l,s]=useState(!1),[i,m]=useState(null),c=useRef(),n=useRef(!0),{host:u,name:p}=r.props;var d=useFocusCallback(r);const f=u.renderText(t.tooltip),k=makeProperFormat(t.value,t.format),P=Calendar.useNative(),v="time";useEffect(()=>{var e=makeProperValue(t.value,P);updateElementValue(t,e,v,k,P),m(e||null)},[t.value]),useEffect(()=>{n.current?n.current=!1:l||a||(isInvalidDate(i)?F({status:"invalid"}):(F(),updateElementValue(t,i,v,k,P)&&u.post("changed",{name:p,value:t.value})))},[l,a]);const F=e=>{hasErrorChanged(t,e)&&(t.error=e,r.forceUpdate())},T=`${makeUniqueId(p)}-input`,E=u.renderText(t.prompt);return React.createElement(FormElement,{className:e,component:r,element:t,inputId:T},t.error&&React.createElement(FormHelperText,{component:"div",error:!0,role:"alert"},c.current),React.createElement(StyledTimePicker,{disabled:!r.enabled,key:"date-picker",inputRef:d,onChange:e=>{m(e)},onOpen:()=>{s(!0)},onClose:()=>{s(!1)},renderInput:e=>(c.current=e.inputProps?.placeholder,e.error=!!t.error,e.inputProps={...e.inputProps,id:T,onBlur:()=>{o(!1)},onFocus:()=>{o(!0)},placeholder:E||e.inputProps?.placeholder,title:f},React.createElement(FormLabelTextField,{...e})),value:i}))};export default TimePicker;
+import{buttonBaseClasses}from"@vertigis/react-ui/ButtonBase";import{clockClasses}from"@vertigis/react-ui/ClockPicker";import FormHelperText from"@vertigis/react-ui/FormHelperText";import FormLabelTextField from"@vertigis/react-ui/FormLabelTextField";import BaseTimePicker from"@vertigis/react-ui/TimePicker";import{styled}from"@vertigis/react-ui/styles";import clsx from"clsx";import*as React from"react";import{useEffect,useRef,useState}from"react";import{Calendar}from"../Calendar.js";import FormElement from"../FormElement.js";import{useFocusCallback}from"../common.js";import{areValuesEqual,isInvalidDate,makeProperValue}from"../dateUtilities.js";import{getNewElementValue}from"../dateUtilities.js";import{isInvalidError}from"../textUtilities.js";import{makeUniqueId}from"../utils.js";const StylableTimePicker=e=>{const{PopperProps:t={},className:r,...a}=e;return React.createElement(BaseTimePicker,{PopperProps:{...t,className:clsx(t.className,r)},...a})},StyledTimePicker=styled(StylableTimePicker)(({theme:{palette:e}})=>({[`& .${clockClasses.amButton}, .${clockClasses.pmButton}`]:{[`&.${buttonBaseClasses.focusVisible}`]:{color:e.action.active}}})),TimePicker=({className:e,component:t,deriveLocale:r,element:a,enabled:o,error:l,name:i,prompt:s,renderFocus:m,renderText:c,setProperty:n,setValue:u,tooltip:p,value:d})=>{const[f,k]=useState(!1),[v,P]=useState(!1),[E,F]=useState(null),T=useRef(),C=useRef(!0);m=useFocusCallback(o,i,m);const b=c(p),x={locale:r(),timezone:(new Intl.DateTimeFormat).resolvedOptions().timeZone},g=Calendar.useNative(),R="time",V=isInvalidError(l);useEffect(()=>{var e=makeProperValue(d,g),t=getNewElementValue(e,R,x,g);areValuesEqual(d,t)||u(t,!1),F(e||null)},[d]),useEffect(()=>{var e;C.current?C.current=!1:v||f||(isInvalidDate(E)?V||n("error",{status:"invalid"}):(V&&n("error",void 0),e=getNewElementValue(E,R,x,g),areValuesEqual(d,e)||u(e)))},[v,f]);const y=`${makeUniqueId(i)}-input`,B=c(s);return React.createElement(FormElement,{className:e,component:t,element:a,inputId:y},V&&React.createElement(FormHelperText,{component:"div",error:!0,role:"alert"},T.current),React.createElement(StyledTimePicker,{disabled:!o,key:"date-picker",inputRef:m,onChange:e=>{F(e)},onOpen:()=>{P(!0)},onClose:()=>{P(!1)},renderInput:e=>(T.current=e.inputProps?.placeholder,e.error=!!l,e.inputProps={...e.inputProps,id:y,onBlur:()=>{k(!1)},onFocus:()=>{k(!0)},placeholder:B||e.inputProps?.placeholder,title:b},React.createElement(FormLabelTextField,{...e})),value:E}))};export default TimePicker;

package/forms/constants.d.ts

@@ -1,81 +1,81 @@
-/**
- * All of the types of component used in forms within VertiGIS Studio Workflow.
- * Most are containers that hold other things. In the case of "element",
- * we use `FormElementTypes` to specify which type of element it represents.
- */
-export declare const FormComponentTypes: {
-    ACCORDIONGROUP: string;
-    BODY: string;
-    ELEMENT: string;
-    FOOTER: string;
-    FORM: string;
-    HEADER: string;
-    MAIN: string;
-    ROW: string;
-    SECTION: string;
-};
-/**
- * All of the types of Form Element that are included in VertiGIS Studio Workflow.
- *
- * IMPORTANT: These are used as element classes when the form is rendered.
- *            Changing these values could introduce breaking changes to
- *           custom styling of existing workflows.
- */
-export declare const FormElementTypes: {
-    AUTOCOMPLETE: string;
-    BUTTONBAR: string;
-    CHECKBOX: string;
-    CHECKGROUP: string;
-    CUSTOM: string;
-    DATEPICKER: string;
-    DATERANGEPICKER: string;
-    DATETIMEPICKER: string;
-    DROPDOWNLIST: string;
-    FILEPICKER: string;
-    GEOMETRYPICKER: string;
-    HEADER: string;
-    HORIZONTALRULE: string;
-    IMAGE: string;
-    ITEMPICKER: string;
-    LISTBOX: string;
-    NUMBER: string;
-    NUMBERRANGESLIDER: string;
-    NUMBERSLIDER: string;
-    PASSWORDBOX: string;
-    RADIOGROUP: string;
-    SCANNER: string;
-    SECTION: string;
-    SIGNATURE: string;
-    TEXT: string;
-    TEXTAREA: string;
-    TEXTBOX: string;
-    TIMEPICKER: string;
-};
-/**
- * The way that Form Element Items are presented to the user.
- * @public
- */
-export declare const Orientation: {
-    /** The items are laid out side-by-side, in a row. */
-    HORIZONTAL: string;
-    /** The items are laid out one above the other, in a column */
-    VERTICAL: string;
-};
-/**
- * The type of scan being performed in a Scanner Form Element.
- * This is defined outside of scanner.tsx to prevent webpack from pulling @zxing/library into the designer.
- */
-export declare enum ScanType {
-    BarCode = "barcode",
-    QrCode = "qrcode"
-}
-/**
- * The way that a Form Element's title is positioned relative to its content.
- * @public
- */
-export declare const TitleLocation: {
-    /** The title is shown above the element's content. */
-    ABOVE: string;
-    /** The title is shown before the element's content. */
-    BESIDE: string;
-};
+/**
+ * All of the types of component used in forms within VertiGIS Studio Workflow.
+ * Most are containers that hold other things. In the case of "element",
+ * we use `FormElementTypes` to specify which type of element it represents.
+ */
+export declare const FormComponentTypes: {
+    ACCORDIONGROUP: string;
+    BODY: string;
+    ELEMENT: string;
+    FOOTER: string;
+    FORM: string;
+    HEADER: string;
+    MAIN: string;
+    ROW: string;
+    SECTION: string;
+};
+/**
+ * All of the types of Form Element that are included in VertiGIS Studio Workflow.
+ *
+ * IMPORTANT: These are used as element classes when the form is rendered.
+ *            Changing these values could introduce breaking changes to
+ *           custom styling of existing workflows.
+ */
+export declare const FormElementTypes: {
+    AUTOCOMPLETE: string;
+    BUTTONBAR: string;
+    CHECKBOX: string;
+    CHECKGROUP: string;
+    CUSTOM: string;
+    DATEPICKER: string;
+    DATERANGEPICKER: string;
+    DATETIMEPICKER: string;
+    DROPDOWNLIST: string;
+    FILEPICKER: string;
+    GEOMETRYPICKER: string;
+    HEADER: string;
+    HORIZONTALRULE: string;
+    IMAGE: string;
+    ITEMPICKER: string;
+    LISTBOX: string;
+    NUMBER: string;
+    NUMBERRANGESLIDER: string;
+    NUMBERSLIDER: string;
+    PASSWORDBOX: string;
+    RADIOGROUP: string;
+    SCANNER: string;
+    SECTION: string;
+    SIGNATURE: string;
+    TEXT: string;
+    TEXTAREA: string;
+    TEXTBOX: string;
+    TIMEPICKER: string;
+};
+/**
+ * The way that Form Element Items are presented to the user.
+ * @public
+ */
+export declare const Orientation: {
+    /** The items are laid out side-by-side, in a row. */
+    HORIZONTAL: string;
+    /** The items are laid out one above the other, in a column */
+    VERTICAL: string;
+};
+/**
+ * The type of scan being performed in a Scanner Form Element.
+ * This is defined outside of scanner.tsx to prevent webpack from pulling @zxing/library into the designer.
+ */
+export declare enum ScanType {
+    BarCode = "barcode",
+    QrCode = "qrcode"
+}
+/**
+ * The way that a Form Element's title is positioned relative to its content.
+ * @public
+ */
+export declare const TitleLocation: {
+    /** The title is shown above the element's content. */
+    ABOVE: string;
+    /** The title is shown before the element's content. */
+    BESIDE: string;
+};

package/forms/dateUtilities.d.ts

@@ -1,117 +1,102 @@
-import { Calendar } from "./Calendar";
-import { DateRangeRef, DateTimeFormat, DateTimeRef, DateTimeType } from "./FormDefinition";
-import { defs } from "./FormHost";
-import { FormPresenterHost } from "./FormPresenterHost";
-/**
- * Checks if a form element's value is equal to the supplied value.
- * @param element A Form Element to inspect.
- * @param newValue A new value for the Form Element.
- * @returns True if the element's current value and the new value are equal, false otherwise.
- */
-export declare function areValuesEqual(element: defs.Element, newValue: DateTimeRef | DateRangeRef): boolean;
-/**
- * Checks if a given date is valid or not.
- * @param date The date object to check.
- */
-export declare function isValidDate(date: Date): boolean;
-/**
- * Converts a given two-digit year to its four digit string equivalent or pads with leading zero's to make four digit.
- * Returns undefined if the input is invalid.
- * @param year The string for the year.
- */
-export declare function tryParseYear(year: string): string;
-/**
- * Converts a given string to a corresponding two digit month. Performs basic validation.
- * Returns undefined if input is valid.
- * @param month The string for the month.
- */
-export declare function tryParseMonth(month: string): string | undefined;
-/**
- * Converts a given string to a corresponding two digit day. Performs basic validation.
- * Returns undefined if input is valid.
- * @param month The string for the day.
- */
-export declare function tryParseDay(day: string): string;
-/**
- * Processes user input and parses it in the current date format if possible. Else returns undefined.
- * The purpose of this function is to allow maximum leeway to the user. As long as there are three
- * numeric values in the input, we'll parse it correctly regardless of separator used and regardless
- * of whether the day/month were entered as 1 or 2 digits or whether year was entered as 2 or 4 digits.
- * While some basic validation is performed, this function is simply intended to format user input
- * correctly and should not be relied upon for validation. Note that this function will always return
- * four digit year and two digit day and month tokens.
- * @param input The input date text.
- */
-export declare function tryParseDateText(input: string): string;
-/**
- * Retrieves the DateFns locale corresponding to the specified language. This function will return undefined
- * if the locale is not found.
- * If the specified language is region specific eg. 'de-AT', this function will first try to retrieve it. In
- * the event of failure, it will also try to retrieve the generic locale for the given language i.e. 'de' for the
- * current example.
- * @param language The target language to retrieve the locale for.
- */
-export declare function getDateFnsLocale(language: string): Promise<Locale | undefined>;
-/**
- * Gets the date format based on the current browser locale. This function will always return four digit year tokens
- * and two digit month and day tokens. The browser locale however, will determine their placement and the separator.
- */
-export declare function getLocaleDateFormat(): string;
-export declare function getLocaleDateFormatSeparator(): string;
-/**
- * Returns the position of the year, month or day in the date format. eg. 2 for year position in mm/dd/yyyy
- * 1 for year position in mm/yyyy/dd and 0 for year position in yyyy/mm/dd.
- */
-export declare function getLocaleDateFormatTokenPosition(token: "yyyy" | "dd" | "MM"): number;
-/**
- * Inputs that can be converted to a DateRangeRef. Requires two values that can be converted into
- * start and end dates
- */
-export declare type DateRangeLike = (Date | number | string)[] | {
-    startDate: Date | string;
-    endDate: Date | string;
-};
-/**
- * Attempts to convert user input into a valid DateRangeRef if possible. If arrays of dates,
- * numbers are provided, the lower value will be used as the startDate irrespective of order defined. If a
- * dateRangeRef like object is provided with explicit startDate and endDate properties no swapping will be done.
- * @param value DateRangeLike inputs which could be an array of string, number, Date or a
- *              DateRangeRef like object.
- * @returns A valid DateRangeRef if possible. Undefined otherwise.
- */
-export declare function convertToDateRangeRef(value: DateRangeLike): DateRangeRef | undefined;
-/**
- * This function is for the sole purpose of facilitating testing. This should not be
- * used for any other purpose. An incorrect value set here will result in incorrect
- * behaviour for the duration of the session or until the value is cleared.
- * @param dateFormat The date format to set in cache.
- */
-export declare function __test__setlocaleDateFormatInCache(dateFormat: string): void;
-export declare function loadLocale(host: FormPresenterHost): Promise<Locale>;
-declare type Partial = void | boolean | number | string | {
-    [name: string]: any;
-    format?: Partial | void;
-    locale?: string;
-    timezone?: string;
-    refValueType?: string;
-    value?: number;
-};
-export declare function makeProperFormat(value: Partial, format: Partial): defs.DateTimeFormat;
-export declare function makeProperValue(value: number | string | Partial, calendar: Calendar): Date;
-export declare function isInvalidDate(date: Date | null): boolean;
-export declare function hasErrorChanged(element: defs.Element, error: defs.StatusRef | undefined): boolean;
-/**
- * Updates `element.value` with a new `DateTimeRef` using the supplied parameters.
- *
- * Care is taken to ensure we don't replace `element.value` with an identical
- * `DateTimeRef` as this can lead to infinite loops in react components
- * when `element.value` is a dependency of a hook such as `useEffect`.
- * @param element The element to be updated.
- * @param date The new `Date` value to use.
- * @param refValueType The type of value that this represents.
- * @param format The format of the value.
- * @param calendar A calendar to use to get a text representation of the date.
- * @returns True if the value was updated, false otherwise.
- */
-export declare function updateElementValue(element: defs.Element, date: Date | undefined | null, refValueType: DateTimeType, format: DateTimeFormat, calendar: Calendar): boolean;
-export {};
+import { Calendar } from "./Calendar";
+import { DateRangeRef, DateTimeFormat, DateTimeRef, DateTimeType } from "./FormDefinition";
+import { defs } from "./FormHost";
+import { FormPresenterHost } from "./FormPresenterHost";
+/**
+ * Checks if a form element's value is equal to the supplied value.
+ * @param elementValue The current value of a Form Element.
+ * @param newValue A new value for the Form Element.
+ * @returns True if the element's current value and the new value are equal, false otherwise.
+ */
+export declare function areValuesEqual(elementValue: defs.Value | undefined, newValue: DateTimeRef | DateRangeRef | undefined | null): boolean;
+/**
+ * Checks if a given date is valid or not.
+ * @param date The date object to check.
+ */
+export declare function isValidDate(date: Date): boolean;
+/**
+ * Converts a given two-digit year to its four digit string equivalent or pads with leading zero's to make four digit.
+ * Returns undefined if the input is invalid.
+ * @param year The string for the year.
+ */
+export declare function tryParseYear(year: string): string | undefined;
+/**
+ * Converts a given string to a corresponding two digit month. Performs basic validation.
+ * Returns undefined if input is valid.
+ * @param month The string for the month.
+ */
+export declare function tryParseMonth(month: string): string | undefined;
+/**
+ * Converts a given string to a corresponding two digit day. Performs basic validation.
+ * Returns undefined if input is valid.
+ * @param month The string for the day.
+ */
+export declare function tryParseDay(day: string): string | undefined;
+/**
+ * Processes user input and parses it in the current date format if possible. Else returns undefined.
+ * The purpose of this function is to allow maximum leeway to the user. As long as there are three
+ * numeric values in the input, we'll parse it correctly regardless of separator used and regardless
+ * of whether the day/month were entered as 1 or 2 digits or whether year was entered as 2 or 4 digits.
+ * While some basic validation is performed, this function is simply intended to format user input
+ * correctly and should not be relied upon for validation. Note that this function will always return
+ * four digit year and two digit day and month tokens.
+ * @param input The input date text.
+ */
+export declare function tryParseDateText(input: string): string | undefined;
+/**
+ * Retrieves the DateFns locale corresponding to the specified language. This function will return undefined
+ * if the locale is not found.
+ * If the specified language is region specific eg. 'de-AT', this function will first try to retrieve it. In
+ * the event of failure, it will also try to retrieve the generic locale for the given language i.e. 'de' for the
+ * current example.
+ * @param language The target language to retrieve the locale for.
+ */
+export declare function getDateFnsLocale(language: string): Promise<Locale | undefined>;
+/**
+ * Gets the date format based on the current browser locale. This function will always return four digit year tokens
+ * and two digit month and day tokens. The browser locale however, will determine their placement and the separator.
+ */
+export declare function getLocaleDateFormat(): string;
+export declare function getLocaleDateFormatSeparator(): string;
+/**
+ * Returns the position of the year, month or day in the date format. eg. 2 for year position in mm/dd/yyyy
+ * 1 for year position in mm/yyyy/dd and 0 for year position in yyyy/mm/dd.
+ */
+export declare function getLocaleDateFormatTokenPosition(token: "yyyy" | "dd" | "MM"): number;
+/**
+ * Inputs that can be converted to a DateRangeRef. Requires two values that can be converted into
+ * start and end dates
+ */
+export type DateRangeLike = (Date | number | string)[] | {
+    startDate: Date | string;
+    endDate: Date | string;
+};
+/**
+ * Attempts to convert user input into a valid DateRangeRef if possible. If arrays of dates,
+ * numbers are provided, the lower value will be used as the startDate irrespective of order defined. If a
+ * dateRangeRef like object is provided with explicit startDate and endDate properties no swapping will be done.
+ * @param value DateRangeLike inputs which could be an array of string, number, Date or a
+ *              DateRangeRef like object.
+ * @returns A valid DateRangeRef if possible. Undefined otherwise.
+ */
+export declare function convertToDateRangeRef(value: DateRangeLike): DateRangeRef | undefined;
+/**
+ * This function is for the sole purpose of facilitating testing. This should not be
+ * used for any other purpose. An incorrect value set here will result in incorrect
+ * behaviour for the duration of the session or until the value is cleared.
+ * @param dateFormat The date format to set in cache.
+ */
+export declare function __test__setlocaleDateFormatInCache(dateFormat: string): void;
+export declare function loadLocale(host: FormPresenterHost): Promise<Locale | undefined>;
+type Partial = void | boolean | number | string | {
+    [name: string]: any;
+    format?: Partial | void;
+    locale?: string;
+    timezone?: string;
+    refValueType?: string;
+    value?: number;
+};
+export declare function makeProperValue(value: number | string | Partial, calendar: Calendar): Date | undefined;
+export declare function isInvalidDate(date: Date | null): boolean;
+export declare function getNewElementValue(date: Date | undefined | null, refValueType: DateTimeType, format: DateTimeFormat, calendar: Calendar): DateTimeRef | undefined;
+export {};

package/forms/dateUtilities.js

@@ -1 +1 @@
-import{parse,isAfter}from"date-fns";import{DEFAULT_LOCALE}from"../constants.js";import{parseLocale}from"../definition/ProgramInspector.js";import{Calendar}from"./Calendar.js";import{isStatus}from"./textUtilities.js";import{isDateRangeRef,isDateTimeRef}from"./utils.js";const CURRENT_CENTURY_YEAR_CUTOFF=29,SUPPORTED_DATE_FNS_LOCALES=["cs","da","de","de-AT","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","en-ZA","fr","fr-CA","fr-CH","it","nb","nl","nl-BE","nn","pt","pt-BR"];let localeDateFormat="",dateFormatSeparator;function areValuesEqual(e,a){const t=e.value;return void 0===t&&void 0===a||null===t&&null===a||(isDateTimeRef(t)&&isDateTimeRef(a)?t.display===a.display&&t.format===a.format&&t.refValueType===a.refValueType&&t.value===a.value:!(!isDateRangeRef(t)||!isDateRangeRef(a))&&(t.endDate?.valueOf()===a.endDate?.valueOf()&&t.refValueType===a.refValueType&&t.startDate?.valueOf()===a.startDate?.valueOf()))}function isValidDate(e){return e instanceof Date&&!isNaN(e.valueOf())}function tryParseYear(e){if(/^\d+$/.test(e)&&!(4<e.length)){for(2===e.length&&(e=`${CURRENT_CENTURY_YEAR_CUTOFF>=parseInt(e,10)?20:19}${e}`);e.length<4;)e=`0${e}`;return e}}function tryParseMonth(e){if(/^\d+$/.test(e)&&!(2<e.length)){1===e.length&&(e=`0${e}`);var a=parseInt(e,10);if(!(a<1||12<a))return e}}function tryParseDay(e){if(/^\d+$/.test(e)&&!(2<e.length)){1===e.length&&(e=`0${e}`);var a=parseInt(e,10);if(!(a<1||31<a))return e}}function tryParseDateText(e){if(e){const r=(e=e.replace(/\\/g,"\\\\")).match(/(\d+)/g);if(3===r?.length){var e=getLocaleDateFormatSeparator(),a=getLocaleDateFormatTokenPosition("yyyy"),t=getLocaleDateFormatTokenPosition("MM");for(let e=0;e<3;e++){switch(e){case a:r[e]=tryParseYear(r[e]);break;case t:r[e]=tryParseMonth(r[e]);break;default:r[e]=tryParseDay(r[e])}if(void 0===r[e])return}return`${r[0]}${e}${r[1]}${e}${r[2]}`}}}async function getDateFnsLocale(e){const a=[];e=parseLocale(e);if(e){e.territory&&a.push(`${e.language}-${e.territory}`),a.push(e.language);for(const t of a)if(-1!==SUPPORTED_DATE_FNS_LOCALES.indexOf(t)){let e;try{switch(t){case"cs":e=(await import("date-fns/locale/cs")).default;break;case"da":e=(await import("date-fns/locale/da")).default;break;case"de":e=(await import("date-fns/locale/de")).default;break;case"de-AT":e=(await import("date-fns/locale/de-AT")).default;break;case"en-AU":e=(await import("date-fns/locale/en-AU")).default;break;case"en-CA":e=(await import("date-fns/locale/en-CA")).default;break;case"en-GB":e=(await import("date-fns/locale/en-GB")).default;break;case"en-IN":e=(await import("date-fns/locale/en-IN")).default;break;case"en-NZ":e=(await import("date-fns/locale/en-NZ")).default;break;case"en-US":e=(await import("date-fns/locale/en-US")).default;break;case"en-ZA":e=(await import("date-fns/locale/en-ZA")).default;break;case"fr":e=(await import("date-fns/locale/fr")).default;break;case"fr-CA":e=(await import("date-fns/locale/fr-CA")).default;break;case"fr-CH":e=(await import("date-fns/locale/fr-CH")).default;break;case"it":e=(await import("date-fns/locale/it")).default;break;case"nb":e=(await import("date-fns/locale/nb")).default;break;case"nl":e=(await import("date-fns/locale/nl")).default;break;case"nl-BE":e=(await import("date-fns/locale/nl-BE")).default;break;case"nn":e=(await import("date-fns/locale/nn")).default;break;case"pt":e=(await import("date-fns/locale/pt")).default;break;case"pt-BR":e=(await import("date-fns/locale/pt-BR")).default}}catch{continue}if(e?.localize)return e}}}function getLocaleDateFormat(){if(localeDateFormat)return localeDateFormat;const e=new Date(1999,11,31,0,0,0);return localeDateFormat=e.toLocaleDateString(void 0,{year:"numeric",month:"numeric",day:"numeric"}),localeDateFormat=localeDateFormat.replace("1999","yyyy"),localeDateFormat=localeDateFormat.replace("99","yyyy"),localeDateFormat=localeDateFormat.replace("12","MM"),localeDateFormat=localeDateFormat.replace("31","dd"),localeDateFormat}function getLocaleDateFormatSeparator(){var e;return void 0===dateFormatSeparator&&(e=/[^dMy]+/.exec(getLocaleDateFormat()),dateFormatSeparator=e?e[0]:""),dateFormatSeparator}function getLocaleDateFormatTokenPosition(e){const a=getLocaleDateFormat();var t=a.indexOf("yyyy"),r=a.indexOf("MM"),o=a.indexOf("dd");return"yyyy"===e?0===t?0:r<t&&o<t?2:1:"MM"===e?0===r?0:o<r&&t<r?2:1:0===o?0:r<o&&t<o?2:1}const coerceIntoDate=e=>{if(e instanceof Date&&isValidDate(e))return new Date(e.valueOf());if("string"==typeof e)if(/^\d+$/.test(e))e=Number(e);else{var a=tryParseDateText(e);if(a){var t=getLocaleDateFormat(),t=parse(a,t,0);if(isValidDate(t))return t}}if("number"==typeof e){e=new Date(e);if(isValidDate(e))return e}};function convertToDateRangeRef(e){let a,t,r=!1;Array.isArray(e)?(a=coerceIntoDate(e[0]),t=coerceIntoDate(e[1]),r=!0):"object"==typeof e&&(a=coerceIntoDate(e.startDate),t=coerceIntoDate(e.endDate));var o=!!a&&!!t;let n=o&&!isAfter(a,t);return r&&o&&!n&&(e=a,a=t,t=e,n=!0),o&&n?{refValueType:"daterange",startDate:a,endDate:t}:void 0}function __test__setlocaleDateFormatInCache(e){localeDateFormat=e,dateFormatSeparator=void 0}async function loadLocale(e){e=e.deriveLocale();if("inv"!==e&&"en"!==e&&e!==DEFAULT_LOCALE)return getDateFnsLocale(e)}function makeProperFormat(e,a){if("object"==typeof e&&null!==e)switch(e.refValueType){case"date":case"time":case"datetime":a=e.format}if("object"!=typeof a)return"app"===a?a:"device";if(null===a)return"device";var t=a.locale,r=a.timezone;return"string"==typeof t&&"string"==typeof r?{locale:t,timezone:r}:"device"}function makeProperValue(e,a){if("object"==typeof e){if(null===e)return;switch(e.refValueType){case"date":case"time":case"datetime":break;default:return}e=e.value}if("number"==typeof e||"string"==typeof e){const t=a.coerceIntoValue(e);if(void 0!==t&&null!==t&&isFinite(t.valueOf()))return t}}function isInvalidDate(e){return e instanceof Date&&isNaN(e.getDate())}function hasErrorChanged(e,a){e=e.error;return(void 0!==e||void 0!==a)&&((null!==e||null!==a)&&(!isStatus(e)||!isStatus(a)||e.status!==a.status))}function updateElementValue(e,a,t,r,o){if(null!=a&&isFinite(a.valueOf())){a={refValueType:t,format:r,display:o.format(a,Calendar.fullFormat),value:a.valueOf()};if(!areValuesEqual(e,a))return e.value=a,!0}else if(void 0!==e.value)return!(e.value=void 0);return!1}export{areValuesEqual,isValidDate,tryParseYear,tryParseMonth,tryParseDay,tryParseDateText,getDateFnsLocale,getLocaleDateFormat,getLocaleDateFormatSeparator,getLocaleDateFormatTokenPosition,convertToDateRangeRef,__test__setlocaleDateFormatInCache,loadLocale,makeProperFormat,makeProperValue,isInvalidDate,hasErrorChanged,updateElementValue};
+import{parse,isAfter}from"date-fns";import{DEFAULT_LOCALE}from"../constants.js";import{parseLocale}from"../definition/ProgramInspector.js";import{Calendar}from"./Calendar.js";import{isDateRangeRef,isDateTimeRef}from"./utils.js";const CURRENT_CENTURY_YEAR_CUTOFF=29,SUPPORTED_DATE_FNS_LOCALES=["cs","da","de","de-AT","en-AU","en-CA","en-GB","en-IN","en-NZ","en-US","en-ZA","fr","fr-CA","fr-CH","it","nb","nl","nl-BE","nn","pt","pt-BR"];let localeDateFormat="",dateFormatSeparator;function areValuesEqual(e,a){return void 0===e&&void 0===a||null===e&&null===a||(isDateTimeRef(e)&&a&&isDateTimeRef(a)?e.display===a.display&&e.refValueType===a.refValueType&&e.value===a.value&&areFormatsEqual(e.format,a.format):!!(isDateRangeRef(e)&&a&&isDateRangeRef(a))&&(e.endDate?.valueOf()===a.endDate?.valueOf()&&e.refValueType===a.refValueType&&e.startDate?.valueOf()===a.startDate?.valueOf()))}function areFormatsEqual(e,a){return void 0===e&&void 0===a||("string"==typeof e&&"string"==typeof a?e===a:"object"==typeof e&&"object"==typeof a&&(null===e||null===a?e===a:e.locale===a.locale&&e.timezone===a.timezone))}function isValidDate(e){return e instanceof Date&&!isNaN(e.valueOf())}function tryParseYear(e){if(/^\d+$/.test(e)&&!(4<e.length)){for(2===e.length&&(e=`${CURRENT_CENTURY_YEAR_CUTOFF>=parseInt(e,10)?20:19}${e}`);e.length<4;)e=`0${e}`;return e}}function tryParseMonth(e){if(/^\d+$/.test(e)&&!(2<e.length)){1===e.length&&(e=`0${e}`);var a=parseInt(e,10);if(!(a<1||12<a))return e}}function tryParseDay(e){if(/^\d+$/.test(e)&&!(2<e.length)){1===e.length&&(e=`0${e}`);var a=parseInt(e,10);if(!(a<1||31<a))return e}}function tryParseDateText(e){if(e){const r=(e=e.replace(/\\/g,"\\\\")).match(/(\d+)/g);if(3===r?.length){var e=getLocaleDateFormatSeparator(),a=getLocaleDateFormatTokenPosition("yyyy"),t=getLocaleDateFormatTokenPosition("MM");for(let e=0;e<3;e++){switch(e){case a:r[e]=tryParseYear(r[e]);break;case t:r[e]=tryParseMonth(r[e]);break;default:r[e]=tryParseDay(r[e])}if(void 0===r[e])return}return`${r[0]}${e}${r[1]}${e}${r[2]}`}}}async function getDateFnsLocale(e){const a=[];e=parseLocale(e);if(e){e.territory&&a.push(`${e.language}-${e.territory}`),a.push(e.language);for(const t of a)if(-1!==SUPPORTED_DATE_FNS_LOCALES.indexOf(t)){let e;try{switch(t){case"cs":e=(await import("date-fns/locale/cs")).default;break;case"da":e=(await import("date-fns/locale/da")).default;break;case"de":e=(await import("date-fns/locale/de")).default;break;case"de-AT":e=(await import("date-fns/locale/de-AT")).default;break;case"en-AU":e=(await import("date-fns/locale/en-AU")).default;break;case"en-CA":e=(await import("date-fns/locale/en-CA")).default;break;case"en-GB":e=(await import("date-fns/locale/en-GB")).default;break;case"en-IN":e=(await import("date-fns/locale/en-IN")).default;break;case"en-NZ":e=(await import("date-fns/locale/en-NZ")).default;break;case"en-US":e=(await import("date-fns/locale/en-US")).default;break;case"en-ZA":e=(await import("date-fns/locale/en-ZA")).default;break;case"fr":e=(await import("date-fns/locale/fr")).default;break;case"fr-CA":e=(await import("date-fns/locale/fr-CA")).default;break;case"fr-CH":e=(await import("date-fns/locale/fr-CH")).default;break;case"it":e=(await import("date-fns/locale/it")).default;break;case"nb":e=(await import("date-fns/locale/nb")).default;break;case"nl":e=(await import("date-fns/locale/nl")).default;break;case"nl-BE":e=(await import("date-fns/locale/nl-BE")).default;break;case"nn":e=(await import("date-fns/locale/nn")).default;break;case"pt":e=(await import("date-fns/locale/pt")).default;break;case"pt-BR":e=(await import("date-fns/locale/pt-BR")).default}}catch{continue}if(e?.localize)return e}}}function getLocaleDateFormat(){if(localeDateFormat)return localeDateFormat;const e=new Date(1999,11,31,0,0,0);return localeDateFormat=e.toLocaleDateString(void 0,{year:"numeric",month:"numeric",day:"numeric"}),localeDateFormat=localeDateFormat.replace("1999","yyyy"),localeDateFormat=localeDateFormat.replace("99","yyyy"),localeDateFormat=localeDateFormat.replace("12","MM"),localeDateFormat=localeDateFormat.replace("31","dd"),localeDateFormat}function getLocaleDateFormatSeparator(){var e;return void 0===dateFormatSeparator&&(e=/[^dMy]+/.exec(getLocaleDateFormat()),dateFormatSeparator=e?e[0]:""),dateFormatSeparator}function getLocaleDateFormatTokenPosition(e){const a=getLocaleDateFormat();var t=a.indexOf("yyyy"),r=a.indexOf("MM"),o=a.indexOf("dd");return"yyyy"===e?0===t?0:r<t&&o<t?2:1:"MM"===e?0===r?0:o<r&&t<r?2:1:0===o?0:r<o&&t<o?2:1}const coerceIntoDate=e=>{if(e instanceof Date&&isValidDate(e))return new Date(e.valueOf());if("string"==typeof e)if(/^\d+$/.test(e))e=Number(e);else{var a=tryParseDateText(e);if(a){var t=getLocaleDateFormat(),t=parse(a,t,0);if(isValidDate(t))return t}}if("number"==typeof e){e=new Date(e);if(isValidDate(e))return e}};function convertToDateRangeRef(e){let a,t,r=!1;Array.isArray(e)?(a=coerceIntoDate(e[0]),t=coerceIntoDate(e[1]),r=!0):"object"==typeof e&&(a=coerceIntoDate(e.startDate),t=coerceIntoDate(e.endDate));var o=!!a&&!!t;let n=o&&!isAfter(a,t);return r&&o&&!n&&(e=a,a=t,t=e,n=!0),o&&n?{refValueType:"daterange",startDate:a,endDate:t}:void 0}function __test__setlocaleDateFormatInCache(e){localeDateFormat=e,dateFormatSeparator=void 0}async function loadLocale(e){e=e.deriveLocale();if("inv"!==e&&"en"!==e&&e!==DEFAULT_LOCALE)return getDateFnsLocale(e)}function makeProperValue(e,a){if("object"==typeof e){if(null===e)return;switch(e.refValueType){case"date":case"time":case"datetime":break;default:return}e=e.value}if("number"==typeof e||"string"==typeof e){const t=a.coerceIntoValue(e);if(void 0!==t&&null!==t&&isFinite(t.valueOf()))return t}}function isInvalidDate(e){return e instanceof Date&&isNaN(e.getDate())}function getNewElementValue(e,a,t,r){if(null!=e&&isFinite(e.valueOf()))return{refValueType:a,format:t,display:r.format(e,Calendar.fullFormat),value:e.valueOf()}}export{areValuesEqual,isValidDate,tryParseYear,tryParseMonth,tryParseDay,tryParseDateText,getDateFnsLocale,getLocaleDateFormat,getLocaleDateFormatSeparator,getLocaleDateFormatTokenPosition,convertToDateRangeRef,__test__setlocaleDateFormatInCache,loadLocale,makeProperValue,isInvalidDate,getNewElementValue};

package/forms/elements/AutoComplete.d.ts

@@ -1,13 +1,13 @@
-import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMinimum } from "../utils";
-import * as types from "./types";
-export interface AutoComplete extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithStringLabel, types.ElementWithRequire {
-    /** Indicates the current value. */
-    readonly value?: any;
-}
-export declare type Item = types.ElementItemBase<any>;
-interface AutoCompletePropertyConstraints extends FormElementPropertyConstraints {
-    delay: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
-    minLength: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
-}
-export declare const autoCompletePropertyConstraints: AutoCompletePropertyConstraints;
-export {};
+import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMinimum } from "../utils";
+import * as types from "./types";
+export interface AutoComplete extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithStringLabel, types.ElementWithRequire {
+    /** Indicates the current value. */
+    readonly value?: any;
+}
+export type Item = types.ElementItemBase<any>;
+interface AutoCompletePropertyConstraints extends FormElementPropertyConstraints {
+    delay: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
+    minLength: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
+}
+export declare const autoCompletePropertyConstraints: AutoCompletePropertyConstraints;
+export {};

package/forms/elements/ButtonBar.d.ts

@@ -1,9 +1,9 @@
-import * as types from "./types";
-export interface ButtonBar extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item> {
-}
-export interface Item extends types.ElementItemBase<any> {
-    /** Indicates if the item is a default. */
-    readonly default?: boolean;
-    /** Indicates if the element triggers validation when submitting. */
-    readonly validates?: boolean;
-}
+import * as types from "./types";
+export interface ButtonBar extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item> {
+}
+export interface Item extends types.ElementItemBase<any> {
+    /** Indicates if the item is a default. */
+    readonly default?: boolean;
+    /** Indicates if the element triggers validation when submitting. */
+    readonly validates?: boolean;
+}

package/forms/elements/CheckBox.d.ts

@@ -1,7 +1,7 @@
-import * as types from "./types";
-export interface CheckBox extends types.ElementBase, types.EditableElement, types.ElementWithTextLabel {
-    /** Indicates that the element is checked or not. */
-    readonly checked?: boolean;
-    /** Indicates the current value. */
-    readonly value?: any;
-}
+import * as types from "./types";
+export interface CheckBox extends types.ElementBase, types.EditableElement, types.ElementWithTextLabel {
+    /** Indicates that the element is checked or not. */
+    readonly checked?: boolean;
+    /** Indicates the current value. */
+    readonly value?: any;
+}

package/forms/elements/CheckGroup.d.ts

@@ -1,11 +1,11 @@
-import * as types from "./types";
-export interface CheckGroup extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithRequire {
-    /** Indicates the current value. */
-    readonly value: ItemsRef;
-}
-export interface Item extends types.ElementItemBase<any>, types.ElementItemWithChecked {
-}
-export interface ItemsRef {
-    /** The items that were selected. */
-    items: Item[];
-}
+import * as types from "./types";
+export interface CheckGroup extends types.ElementBase, types.EditableElement, types.ElementWithItems<Item>, types.ElementWithRequire {
+    /** Indicates the current value. */
+    readonly value: ItemsRef;
+}
+export interface Item extends types.ElementItemBase<any>, types.ElementItemWithChecked {
+}
+export interface ItemsRef {
+    /** The items that were selected. */
+    items: Item[];
+}

package/forms/elements/Custom.d.ts

@@ -1,7 +1,7 @@
-import * as types from "./types";
-export interface Custom extends types.ElementBase, types.EditableElement {
-    /** Indicates the type name of the custom form element implementation. */
-    readonly customType?: string;
-    /** Indicates the current value. */
-    readonly value?: any;
-}
+import * as types from "./types";
+export interface Custom extends types.ElementBase, types.EditableElement {
+    /** Indicates the type name of the custom form element implementation. */
+    readonly customType?: string;
+    /** Indicates the current value. */
+    readonly value?: any;
+}

package/forms/elements/DatePicker.d.ts

@@ -1,6 +1,6 @@
-import { DateTimeRef } from "../FormDefinition";
-import * as types from "./types";
-export interface DatePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
-    /** Indicates the current value. */
-    readonly value?: DateTimeRef;
-}
+import { DateTimeRef } from "../FormDefinition";
+import * as types from "./types";
+export interface DatePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
+    /** Indicates the current value. */
+    readonly value?: DateTimeRef;
+}

package/forms/elements/DateRangePicker.d.ts

@@ -1,6 +1,6 @@
-import { DateRangeRef } from "../FormDefinition";
-import * as types from "./types";
-export interface DateRangePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
-    /** Indicates the current value. */
-    readonly value?: DateRangeRef;
-}
+import { DateRangeRef } from "../FormDefinition";
+import * as types from "./types";
+export interface DateRangePicker extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
+    /** Indicates the current value. */
+    readonly value?: DateRangeRef;
+}