@vertigis/workflow 5.33.0 → 5.34.0

package/forms/constants.d.ts

@@ -34,34 +34,9 @@ export declare const FormElementTypes: {
     TEXTBOX: string;
     TIMEPICKER: string;
 };
-export declare const CssClasses: {
-    /**
-     * The Form Element contains a drop down list.
-     */
-    DROPDOWN: string;
-    /**
-     * The Form Element has an error.
-     */
-    ERROR: string;
-    /**
-     * The Form Element cannot contain any more items.
-     */
-    FULL: string;
-    /**
-     * The Form Element is a Number or Number Slider.
-     */
-    NUMERIC: string;
-    /**
-     * The Form Element can only contain a single item.
-     */
-    SINGLE: string;
-    /**
-     * The Form Element allows increment by steps.
-     */
-    STEPPER: 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. */
@@ -77,13 +52,9 @@ export declare enum ScanType {
     BarCode = "barcode",
     QrCode = "qrcode"
 }
-/**
- * The default number of rows for a Text Area in the Scanner Form Element.
- * This is defined outside of scanner.tsx to prevent webpack from pulling @zxing/library into the designer.
- */
-export declare const SCANNER_DEFAULT_ROW_COUNT = 5;
 /**
  * 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. */

package/forms/constants.js

@@ -1 +1 @@
-const FormElementTypes={AUTOCOMPLETE:"AutoComplete",BUTTONBAR:"ButtonBar",CHECKBOX:"CheckBox",CHECKGROUP:"CheckGroup",CUSTOM:"Custom",DATEPICKER:"DatePicker",DATERANGEPICKER:"DateRangePicker",DATETIMEPICKER:"DateTimePicker",DROPDOWNLIST:"DropDownList",FILEPICKER:"FilePicker",GEOMETRYPICKER:"GeometryPicker",HEADER:"Header",HORIZONTALRULE:"HorizontalRule",IMAGE:"Image",ITEMPICKER:"ItemPicker",LISTBOX:"ListBox",NUMBER:"Number",NUMBERRANGESLIDER:"NumberRangeSlider",NUMBERSLIDER:"NumberSlider",PASSWORDBOX:"PasswordBox",RADIOGROUP:"RadioGroup",SCANNER:"Scanner",SECTION:"Section",TEXT:"Text",TEXTAREA:"TextArea",TEXTBOX:"TextBox",TIMEPICKER:"TimePicker"},CssClasses={DROPDOWN:"dropdown",ERROR:"error",FULL:"full",NUMERIC:"Numeric",SINGLE:"single",STEPPER:"stepper"},Orientation={HORIZONTAL:"horizontal",VERTICAL:"vertical"};var ScanType;!function(e){e.BarCode="barcode",e.QrCode="qrcode"}(ScanType=ScanType||{});const SCANNER_DEFAULT_ROW_COUNT=5,TitleLocation={ABOVE:"above",BESIDE:"beside"};export{FormElementTypes,CssClasses,Orientation,ScanType,SCANNER_DEFAULT_ROW_COUNT,TitleLocation};
+const FormElementTypes={AUTOCOMPLETE:"AutoComplete",BUTTONBAR:"ButtonBar",CHECKBOX:"CheckBox",CHECKGROUP:"CheckGroup",CUSTOM:"Custom",DATEPICKER:"DatePicker",DATERANGEPICKER:"DateRangePicker",DATETIMEPICKER:"DateTimePicker",DROPDOWNLIST:"DropDownList",FILEPICKER:"FilePicker",GEOMETRYPICKER:"GeometryPicker",HEADER:"Header",HORIZONTALRULE:"HorizontalRule",IMAGE:"Image",ITEMPICKER:"ItemPicker",LISTBOX:"ListBox",NUMBER:"Number",NUMBERRANGESLIDER:"NumberRangeSlider",NUMBERSLIDER:"NumberSlider",PASSWORDBOX:"PasswordBox",RADIOGROUP:"RadioGroup",SCANNER:"Scanner",SECTION:"Section",TEXT:"Text",TEXTAREA:"TextArea",TEXTBOX:"TextBox",TIMEPICKER:"TimePicker"},Orientation={HORIZONTAL:"horizontal",VERTICAL:"vertical"};var ScanType;!function(e){e.BarCode="barcode",e.QrCode="qrcode"}(ScanType=ScanType||{});const TitleLocation={ABOVE:"above",BESIDE:"beside"};export{FormElementTypes,Orientation,ScanType,TitleLocation};

package/forms/dateUtilities.d.ts

@@ -1,4 +1,14 @@
-import { DateRangeRef } from "./FormDefinition";
+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.
@@ -15,7 +25,7 @@ export declare function tryParseYear(year: string): string;
  * Returns undefined if input is valid.
  * @param month The string for the month.
  */
-export declare function tryParseMonth(month: string): string;
+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.
@@ -53,12 +63,6 @@ export declare function getLocaleDateFormatSeparator(): string;
  * 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;
-/**
- * Returns a string formatted using the locale date format while always using 'yyyy', 'MM' and
- * 'dd' token styles ie two digit months and days and four digit years.
- * @param date The input date
- */
-export declare function getDateAsLocaleFormattedString(date: Date): string;
 /**
  * Inputs that can be converted to a DateRangeRef. Requires two values that can be converted into
  * start and end dates
@@ -75,7 +79,7 @@ export declare type DateRangeLike = (Date | number | string)[] | {
  *              DateRangeRef like object.
  * @returns A valid DateRangeRef if possible. Undefined otherwise.
  */
-export declare function convertToDateRangeRef(value: DateRangeLike): DateRangeRef;
+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
@@ -83,3 +87,31 @@ export declare function convertToDateRangeRef(value: DateRangeLike): DateRangeRe
  * @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 {};

package/forms/dateUtilities.js

@@ -1 +1 @@
-import{parse,isAfter}from"date-fns";import{parseLocale}from"../definition/ProgramInspector.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 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}function getDateAsLocaleFormattedString(e){if(!isValidDate(e))return"";var a=tryParseYear(e.getFullYear().toString()),t=tryParseMonth((e.getMonth()+1).toString()),e=tryParseDay(e.getDate().toString());let r=getLocaleDateFormat();return r=r.replace("yyyy",a),r=r.replace("MM",t),r=r.replace("dd",e),r}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=void 0,t=void 0,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}export{isValidDate,tryParseYear,tryParseMonth,tryParseDay,tryParseDateText,getDateFnsLocale,getLocaleDateFormat,getLocaleDateFormatSeparator,getLocaleDateFormatTokenPosition,getDateAsLocaleFormattedString,convertToDateRangeRef,__test__setlocaleDateFormatInCache};
+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};

package/forms/elements/AutoComplete.d.ts

@@ -1,6 +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 {};

package/forms/elements/AutoComplete.js

@@ -0,0 +1 @@
+const autoCompletePropertyConstraints={delay:{default:300,minimum:1},minLength:{default:3,minimum:1}};export{autoCompletePropertyConstraints};

package/forms/elements/Number.d.ts

@@ -1,6 +1,11 @@
 import { NumberRef } from "../FormDefinition";
+import { NumberFormatConfiguration } from "../numberUtilities";
 import * as types from "./types";
 export interface Number extends types.ElementBase, types.EditableElement, types.ElementWithRequire {
     /** Indicates the current value. */
     readonly value: NumberRef;
 }
+/**
+ * Constraints that the Number element enforces on the bounds.
+ */
+export declare const numberFormatConfiguration: Partial<NumberFormatConfiguration>;

package/forms/elements/Number.js

@@ -0,0 +1 @@
+const numberFormatConfiguration={lowerBound:{default:void 0},upperBound:{default:void 0}};export{numberFormatConfiguration};

package/forms/elements/NumberRangeSlider.d.ts

@@ -1,8 +1,10 @@
+import { NumberFormatConfiguration } from "../numberUtilities";
 import * as types from "./types";
 export interface NumberRangeSlider extends types.ElementBase, types.EditableElement {
     /** Indicates the current value. */
     readonly value: number[];
 }
-export declare const MIN_DECIMALS = 0;
-export declare const DEFAULT_DECIMALS = 0;
-export declare const DEFAULT_STEP = 0;
+/**
+ * Constraints that the Number Range Slider enforces on the precision.
+ */
+export declare const numberFormatConfiguration: Partial<NumberFormatConfiguration>;

package/forms/elements/NumberRangeSlider.js

@@ -1 +1 @@
-const MIN_DECIMALS=0,DEFAULT_DECIMALS=0,DEFAULT_STEP=0;export{MIN_DECIMALS,DEFAULT_DECIMALS,DEFAULT_STEP};
+const numberFormatConfiguration={precision:{default:0,minimum:0}};export{numberFormatConfiguration};

package/forms/elements/NumberSlider.d.ts

@@ -4,6 +4,3 @@ export interface NumberSlider extends types.ElementBase, types.EditableElement {
     /** Indicates the current value. */
     readonly value: NumberRef;
 }
-export declare const MIN_DECIMALS = -20;
-export declare const DEFAULT_DECIMALS = 3;
-export declare const DEFAULT_STEP = 1;

package/forms/elements/NumberSlider.js

@@ -1 +0,0 @@
-const MIN_DECIMALS=-20,DEFAULT_DECIMALS=3,DEFAULT_STEP=1;export{MIN_DECIMALS,DEFAULT_DECIMALS,DEFAULT_STEP};

package/forms/elements/Scanner.d.ts

@@ -1,4 +1,5 @@
 import { ScanRef } from "../FormDefinition";
+import { FormElementPropertyConstraints, PropertyConstraintsWithDefault, PropertyConstraintsWithMinimum } from "../utils";
 import * as types from "./types";
 export interface Scanner extends types.ElementBase, types.EditableElement, types.ElementWithAutoActivate, types.ElementWithRequire {
     /** True if this element should support manual user entry, false otherwise. */
@@ -8,3 +9,11 @@ export interface Scanner extends types.ElementBase, types.EditableElement, types
     /** Indicates the current value. */
     readonly value: ScanRef;
 }
+interface ScannerConfiguration extends FormElementPropertyConstraints {
+    rows: PropertyConstraintsWithDefault<number> & PropertyConstraintsWithMinimum<number>;
+}
+/**
+ * Constraints that the Scanner enforces on the rows.
+ */
+export declare const scannerConfiguration: ScannerConfiguration;
+export {};

package/forms/elements/Scanner.js

@@ -0,0 +1 @@
+const scannerConfiguration={rows:{default:5,minimum:1}};export{scannerConfiguration};

package/forms/elements/types.d.ts

@@ -1,6 +1,8 @@
 import * as defs from "../FormDefinition";
-/** We re-define Text here to hide defs.StatusRef from the end user.
- *  It is only for internal use, and adds no value in this context.
+/**
+ * We re-define Text here to hide defs.StatusRef from the end user.
+ * It is only for internal use, and adds no value in this context.
+ * @public
  */
 export declare type Text = string | defs.MarkdownRef;
 /** Properties common to all Elements, except the Header. */

package/forms/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
-export * from "./constants";
-import { Text } from "./elements/types";
+export { Orientation, TitleLocation } from "./constants";
+export type { Text } from "./elements/types";
+/** @public */
 export interface FormElementProps<TValue = undefined> extends FormElementSettableProps<TValue> {
     /** The description of the element. */
     description?: Text;
@@ -35,12 +36,14 @@ export interface FormElementProps<TValue = undefined> extends FormElementSettabl
      */
     setValue: (value: this["value"]) => void;
 }
+/** @public */
 export interface FormElementSettableProps<TValue = undefined> {
     /** The value of the element. */
     value: TValue;
 }
 declare type SettablePropsFromProps<TProps extends FormElementProps> = Omit<TProps, keyof FormElementProps> & FormElementSettableProps<TProps["value"]>;
 declare type Unionize<T> = T[keyof T];
+/** @public */
 export declare type PropertyChangeEvent<TSettableProps, TSetProperty> = Unionize<{
     [K in keyof Required<TSettableProps>]: {
         properties: Readonly<TSettableProps>;
@@ -48,6 +51,7 @@ export declare type PropertyChangeEvent<TSettableProps, TSetProperty> = Unionize
         setProperty: TSetProperty;
     };
 }>;
+/** @public */
 export interface FormElementRegistration<TProps extends FormElementProps<any> = FormElementProps, TSettableProps extends SettablePropsFromProps<TProps> = SettablePropsFromProps<TProps>> {
     /** The React component definition of the form element. */
     component: React.ComponentType<TProps>;

package/forms/index.js

@@ -1 +1 @@
-export*from"./constants.js";
+export{Orientation,TitleLocation}from"./constants.js";

package/forms/keyboard.d.ts

@@ -5,4 +5,5 @@ export interface KeyboardEvent {
     shiftKey: boolean;
     key: string;
 }
+/** @product This is intended for internal use only within VertiGIS Studio products. */
 export declare function getKeyString(event: KeyboardEvent): string;

package/forms/numberFormatter.d.ts

@@ -24,7 +24,7 @@ export declare enum NumberDisplayFormat {
      */
     ACCOUNTING = "a",
     /**
-     * A localized representation of a percentage (e.g. 0.99 -> "99%" in the
+     * A localized representation of a percentage (e.g. 0.99 -\> "99%" in the
      * en-US locale).
      */
     PERCENT = "p",
@@ -48,16 +48,15 @@ export declare enum NumberDisplayFormat {
  */
 export interface FormatOptions {
     /**
-     * The locale to use when formatting the number. If not specified, the
-     * current locale is used (see locale module).
+     * The locale to use when formatting the number.
      */
-    locale?: string;
+    locale: string;
     /**
      * The number format. See {@link NumberFormatter.format}.
      */
     format?: NumberDisplayFormat;
     /**
-     * See {@link NumberSettings.currency}.
+     * See NumberFormat.currency.
      */
     currency?: string;
     /**
@@ -65,7 +64,7 @@ export interface FormatOptions {
      */
     customDisplayFormat?: string;
     /**
-     * See {@link NumberSettings.fractionalDigits}.
+     * See NumberFormat.precision.
      */
     fractionalDigits?: number;
 }

package/forms/numberFormatter.js

@@ -1 +1 @@
-import{DEFAULT_LOCALE}from"../constants.js";export{isNumeric}from"./utils.js";var NumberDisplayFormat;!function(t){t.NUMBER="n",t.FIXED_POINT="f",t.CURRENCY="c",t.ACCOUNTING="a",t.PERCENT="p",t.ROUND_TRIP="r",t.DEFAULT="n",t.CUSTOM="custom"}(NumberDisplayFormat=NumberDisplayFormat||{});const DEFAULT_CURRENCY="USD",DEFAULT_CUSTOM_FORMAT="#.##",DEFAULT_FRACTIONAL_DIGITS=4,SUPPORTED_CURRENCIES=["ADP","AED","AFA","AFN","ALK","ALL","AMD","ANG","AOA","AOK","AON","AOR","ARA","ARL","ARM","ARP","ARS","ATS","AUD","AWG","AZM","AZN","BAD","BAM","BAN","BBD","BDT","BEC","BEF","BEL","BGL","BGM","BGN","BGO","BHD","BIF","BMD","BND","BOB","BOL","BOP","BOV","BRB","BRC","BRE","BRL","BRN","BRR","BRZ","BSD","BTN","BUK","BWP","BYB","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLE","CLF","CLP","CNH","CNX","CNY","COP","COU","CRC","CSD","CSK","CUC","CUP","CVE","CYP","CZK","DDM","DEM","DJF","DKK","DOP","DZD","ECS","ECV","EEK","EGP","ERN","ESA","ESB","ESP","ETB","EUR","FIM","FJD","FKP","FRF","GBP","GEK","GEL","GHC","GHS","GIP","GMD","GNF","GNS","GQE","GRD","GTQ","GWE","GWP","GYD","HKD","HNL","HRD","HRK","HTG","HUF","IDR","IEP","ILP","ILR","ILS","INR","IQD","IRR","ISJ","ISK","ITL","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRH","KRO","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LTT","LUC","LUF","LUL","LVL","LVR","LYD","MAD","MAF","MCF","MDC","MDL","MGA","MGF","MKD","MKN","MLF","MMK","MNT","MOP","MRO","MRU","MTL","MTP","MUR","MVP","MVR","MWK","MXN","MXP","MXV","MYR","MZE","MZM","MZN","NAD","NGN","NIC","NIO","NLG","NOK","NPR","NZD","OMR","PAB","PEI","PEN","PES","PGK","PHP","PKR","PLN","PLZ","PTE","PYG","QAR","RHD","ROL","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDD","SDG","SDP","SEK","SGD","SHP","SIT","SKK","SLL","SOS","SRD","SRG","SSP","STD","STN","SUR","SVC","SYP","SZL","THB","TJR","TJS","TMM","TMT","TND","TOP","TPE","TRL","TRY","TTD","TWD","TZS","UAH","UAK","UGS","UGX","USD","USN","USS","UYI","UYP","UYU","UYW","UZS","VEB","VEF","VES","VND","VNN","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XEU","XFO","XFU","XOF","XPD","XPF","XPT","XRE","XSU","XTS","XUA","XXX","YDD","YER","YUD","YUM","YUN","YUR","ZAL","ZAR","ZMK","ZMW","ZRN","ZRZ","ZWD","ZWL","ZWR"];function format(...t){return globalFormatter.format.apply(globalFormatter,t)}class NumberFormatter{format(...t){let r=NaN,a={};if(1===t.length?(r=t[0],a={}):2<=arguments.length&&(r=t[1],a="string"==typeof t[0]?{format:t[0]}:t[0]||a),null===r||void 0===r||isNaN(r))return"";let e=a.format||NumberDisplayFormat.DEFAULT;if(e===NumberDisplayFormat.CUSTOM&&(e=a.customDisplayFormat||DEFAULT_CUSTOM_FORMAT),e===NumberDisplayFormat.ROUND_TRIP)return r.toString();var m=e.toLowerCase();m===NumberDisplayFormat.CURRENCY||m===NumberDisplayFormat.ACCOUNTING?(i=a.currency||DEFAULT_CURRENCY,e=m,e+=a.fractionalDigits??"",e+=i?`$${i}`:""):m!==NumberDisplayFormat.NUMBER&&m!==NumberDisplayFormat.FIXED_POINT&&m!==NumberDisplayFormat.PERCENT||(e=m,e+=a.fractionalDigits??""),a.locale=a.locale||DEFAULT_LOCALE;const D=[a.locale];var i=`${D.join(";")}|${e}`;let N=numberFormatters.get(i);return N||(N=[],1===(m=e.split(";",3)).length?(N[0]=this._createNumberFormatter(D,m[0]),N[1]=N[0],N[2]=N[0]):2===m.length?(N[0]=this._createNumberFormatter(D,m[0]),N[1]=this._createNumberFormatter(D,m[1]),N[2]=N[0]):3===m.length&&(N[0]=this._createNumberFormatter(D,m[0]),N[1]=this._createNumberFormatter(D,m[1]),N[2]=this._createNumberFormatter(D,m[2])),numberFormatters.set(i,N)),0<r?N[0](r):r<0?N[1](r):N[2](r)}_createNumberFormatter(r,t){const a={};let e=t.match(standardFormatPattern);if(e){var m=e[1].toLowerCase(),D=Math.min(20,parseInt(e[2]));let t=e[3];m===NumberDisplayFormat.CURRENCY||m===NumberDisplayFormat.ACCOUNTING?t=(t||DEFAULT_CURRENCY).toUpperCase():(t="",void 0===a.minimumFractionDigits&&(a.minimumFractionDigits=0),void 0===a.maximumFractionDigits&&(a.maximumFractionDigits=Math.max(DEFAULT_FRACTIONAL_DIGITS,a.minimumFractionDigits))),m===NumberDisplayFormat.PERCENT?a.style="percent":m===NumberDisplayFormat.ACCOUNTING?a.currencySign="accounting":m===NumberDisplayFormat.FIXED_POINT&&(a.useGrouping=!1),isNaN(D)||(a.minimumFractionDigits=D,a.maximumFractionDigits=D);const E=t?new Intl.NumberFormat(r,{style:"currency",currency:t,...a}):new Intl.NumberFormat(r,a);return t=>E.format(t)}var i,N;e=t.match(/[0#]+|\.|,|%|\\.|(["'])[^\1]+\1|[^0#.,\\'"]+/g);let R=!1,F="",o="",n="",s="";a.minimumFractionDigits=0,a.maximumFractionDigits=0,a.useGrouping=!1;for(i of e)switch(i[0]){case".":R=!0;break;case",":a.useGrouping=!0;break;case"%":a.style="percent";break;case"0":case"#":R?o+=i:F+=i;break;default:0===i.indexOf('"')||0===i.indexOf("'")?i=i.slice(1,-1):0===i.indexOf("\\")&&(i=i.slice(1)),F||o?s+=i:n+=i}if(!F||0<=(N=F.indexOf("0"))&&(a.minimumIntegerDigits=F.length-N),o&&(N=o.lastIndexOf("0"),a.minimumFractionDigits=0<=N?N+1:0,a.maximumFractionDigits=Math.min(20,o.length)),F||o){const C=new Intl.NumberFormat(r,a);return t=>`${n}${C.format(t)}${s}`}return()=>n+s}}const numberFormatters=new Map,standardFormatPattern=/^([acfnp])(\d*)(?:\$([a-zA-Z]{3}))?$/i,globalFormatter=new NumberFormatter;export{NumberDisplayFormat,DEFAULT_CURRENCY,DEFAULT_CUSTOM_FORMAT,DEFAULT_FRACTIONAL_DIGITS,SUPPORTED_CURRENCIES,format};
+import{DEFAULT_LOCALE}from"../constants.js";export{isNumeric}from"./utils.js";var NumberDisplayFormat;!function(t){t.NUMBER="n",t.FIXED_POINT="f",t.CURRENCY="c",t.ACCOUNTING="a",t.PERCENT="p",t.ROUND_TRIP="r",t.DEFAULT="n",t.CUSTOM="custom"}(NumberDisplayFormat=NumberDisplayFormat||{});const DEFAULT_CURRENCY="USD",DEFAULT_CUSTOM_FORMAT="#.##",DEFAULT_FRACTIONAL_DIGITS=4,SUPPORTED_CURRENCIES=["ADP","AED","AFA","AFN","ALK","ALL","AMD","ANG","AOA","AOK","AON","AOR","ARA","ARL","ARM","ARP","ARS","ATS","AUD","AWG","AZM","AZN","BAD","BAM","BAN","BBD","BDT","BEC","BEF","BEL","BGL","BGM","BGN","BGO","BHD","BIF","BMD","BND","BOB","BOL","BOP","BOV","BRB","BRC","BRE","BRL","BRN","BRR","BRZ","BSD","BTN","BUK","BWP","BYB","BYN","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLE","CLF","CLP","CNH","CNX","CNY","COP","COU","CRC","CSD","CSK","CUC","CUP","CVE","CYP","CZK","DDM","DEM","DJF","DKK","DOP","DZD","ECS","ECV","EEK","EGP","ERN","ESA","ESB","ESP","ETB","EUR","FIM","FJD","FKP","FRF","GBP","GEK","GEL","GHC","GHS","GIP","GMD","GNF","GNS","GQE","GRD","GTQ","GWE","GWP","GYD","HKD","HNL","HRD","HRK","HTG","HUF","IDR","IEP","ILP","ILR","ILS","INR","IQD","IRR","ISJ","ISK","ITL","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRH","KRO","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LTT","LUC","LUF","LUL","LVL","LVR","LYD","MAD","MAF","MCF","MDC","MDL","MGA","MGF","MKD","MKN","MLF","MMK","MNT","MOP","MRO","MRU","MTL","MTP","MUR","MVP","MVR","MWK","MXN","MXP","MXV","MYR","MZE","MZM","MZN","NAD","NGN","NIC","NIO","NLG","NOK","NPR","NZD","OMR","PAB","PEI","PEN","PES","PGK","PHP","PKR","PLN","PLZ","PTE","PYG","QAR","RHD","ROL","RON","RSD","RUB","RUR","RWF","SAR","SBD","SCR","SDD","SDG","SDP","SEK","SGD","SHP","SIT","SKK","SLL","SOS","SRD","SRG","SSP","STD","STN","SUR","SVC","SYP","SZL","THB","TJR","TJS","TMM","TMT","TND","TOP","TPE","TRL","TRY","TTD","TWD","TZS","UAH","UAK","UGS","UGX","USD","USN","USS","UYI","UYP","UYU","UYW","UZS","VEB","VEF","VES","VND","VNN","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XEU","XFO","XFU","XOF","XPD","XPF","XPT","XRE","XSU","XTS","XUA","XXX","YDD","YER","YUD","YUM","YUN","YUR","ZAL","ZAR","ZMK","ZMW","ZRN","ZRZ","ZWD","ZWL","ZWR"];function format(...t){return globalFormatter.format.apply(globalFormatter,t)}class NumberFormatter{format(...t){let r=NaN,a={locale:DEFAULT_LOCALE};if(1===t.length?r=t[0]:2<=arguments.length&&(r=t[1],a="string"==typeof t[0]?{format:t[0],locale:DEFAULT_LOCALE}:t[0]||a),null===r||void 0===r||isNaN(r))return"";let e=a.format||NumberDisplayFormat.DEFAULT;if(e===NumberDisplayFormat.CUSTOM&&(e=a.customDisplayFormat||DEFAULT_CUSTOM_FORMAT),e===NumberDisplayFormat.ROUND_TRIP)return r.toString();var m=e.toLowerCase();m===NumberDisplayFormat.CURRENCY||m===NumberDisplayFormat.ACCOUNTING?(i=a.currency||DEFAULT_CURRENCY,e=m,e+=a.fractionalDigits??"",e+=i?`$${i}`:""):m!==NumberDisplayFormat.NUMBER&&m!==NumberDisplayFormat.FIXED_POINT&&m!==NumberDisplayFormat.PERCENT||(e=m,e+=a.fractionalDigits??"");const D=[a.locale];var i=`${D.join(";")}|${e}`;let N=numberFormatters.get(i);return N||(N=[],1===(m=e.split(";",3)).length?(N[0]=this._createNumberFormatter(D,m[0]),N[1]=N[0],N[2]=N[0]):2===m.length?(N[0]=this._createNumberFormatter(D,m[0]),N[1]=this._createNumberFormatter(D,m[1]),N[2]=N[0]):3===m.length&&(N[0]=this._createNumberFormatter(D,m[0]),N[1]=this._createNumberFormatter(D,m[1]),N[2]=this._createNumberFormatter(D,m[2])),numberFormatters.set(i,N)),0<r?N[0](r):r<0?N[1](r):N[2](r)}_createNumberFormatter(r,t){const a={};let e=t.match(standardFormatPattern);if(e){var m=e[1].toLowerCase(),D=Math.min(20,parseInt(e[2]));let t=e[3];m===NumberDisplayFormat.CURRENCY||m===NumberDisplayFormat.ACCOUNTING?t=(t||DEFAULT_CURRENCY).toUpperCase():(t="",void 0===a.minimumFractionDigits&&(a.minimumFractionDigits=0),void 0===a.maximumFractionDigits&&(a.maximumFractionDigits=Math.max(DEFAULT_FRACTIONAL_DIGITS,a.minimumFractionDigits))),m===NumberDisplayFormat.PERCENT?a.style="percent":m===NumberDisplayFormat.ACCOUNTING?a.currencySign="accounting":m===NumberDisplayFormat.FIXED_POINT&&(a.useGrouping=!1),isNaN(D)||(a.minimumFractionDigits=D,a.maximumFractionDigits=D);const E=t?new Intl.NumberFormat(r,{style:"currency",currency:t,...a}):new Intl.NumberFormat(r,a);return t=>E.format(t)}var i,N;e=t.match(/[0#]+|\.|,|%|\\.|(["'])[^\1]+\1|[^0#.,\\'"]+/g);let R=!1,F="",o="",n="",s="";a.minimumFractionDigits=0,a.maximumFractionDigits=0,a.useGrouping=!1;for(i of e)switch(i[0]){case".":R=!0;break;case",":a.useGrouping=!0;break;case"%":a.style="percent";break;case"0":case"#":R?o+=i:F+=i;break;default:0===i.indexOf('"')||0===i.indexOf("'")?i=i.slice(1,-1):0===i.indexOf("\\")&&(i=i.slice(1)),F||o?s+=i:n+=i}if(!F||0<=(N=F.indexOf("0"))&&(a.minimumIntegerDigits=F.length-N),o&&(N=o.lastIndexOf("0"),a.minimumFractionDigits=0<=N?N+1:0,a.maximumFractionDigits=Math.min(20,o.length)),F||o){const A=new Intl.NumberFormat(r,a);return t=>`${n}${A.format(t)}${s}`}return()=>n+s}}const numberFormatters=new Map,standardFormatPattern=/^([acfnp])(\d*)(?:\$([a-zA-Z]{3}))?$/i,globalFormatter=new NumberFormatter;export{NumberDisplayFormat,DEFAULT_CURRENCY,DEFAULT_CUSTOM_FORMAT,DEFAULT_FRACTIONAL_DIGITS,SUPPORTED_CURRENCIES,format};

package/forms/numberUtilities.d.ts

@@ -0,0 +1,113 @@
+import * as defs from "./FormDefinition";
+import { FormatOptions } from "./numberFormatter";
+import { PropertyConstraints, PropertyConstraintsWithDefault } from "./utils";
+/**
+ * Configuration for cleaning up a {@link defs.NumberFormat} used in producing a {@link defs.NumberConstraints}.
+ *
+ * This is a bit meta.
+ *   * A `NumberConstraints` is used at runtime to ensure the value that a user entered is valid.
+ *   * The `NumberConstraints` is generated from a `NumberFormat` which may only be partially defined, or may have values that are out of range.
+ *   * We need to populate and validate the `NumberFormat` first of all before we can generate a valid `NumberConstraints`.
+ */
+export interface NumberFormatConfiguration {
+    [key: string]: PropertyConstraints<any> | undefined;
+    lowerBound: PropertyConstraints<number>;
+    precision: PropertyConstraintsWithDefault<number>;
+    step: PropertyConstraintsWithDefault<number>;
+    upperBound: PropertyConstraints<number>;
+}
+export declare const defaultNumberFormatConfiguration: NumberFormatConfiguration;
+/**
+ * Returns constraints to be used to ensure a value is a valid number for a form element.
+ *
+ * Non-numeric or missing values are replaced by defaults.
+ *
+ * The step is sanitized as follows:
+ *   1. If it is not a number it is set to 1.
+ *   2. If it is <= zero it is set to 1. (The @vertigis/react-ui/Slider gets stuck on the minimum value if the step is zero.)
+ *   2. It cannot be greater than the full range. (max-min)
+ * @param numberFormat The formatting options to use, typically configured on a Form Element.
+ * @param partialNumberFormatConfiguration Additional configuration specific to the caller. These are combined with the defaults.
+ * @returns A {@link defs.NumberConstraints} containing values that can be safely used in a component.
+ */
+export declare function getNumberConstraints(numberFormat: defs.NumberFormat | undefined, partialNumberFormatConfiguration?: Partial<NumberFormatConfiguration>): defs.NumberConstraints;
+/**
+ * Counts the number of decimal places in the specified number and returns the result.
+ * This uses Intl.NumberFormat rather than number.toString() to ensure that large numbers don't get converted to an exponential format.
+ *
+ * Despite this, it may not be accurate for very large numbers as it seems the decimal places might still be ignored.
+ * e.g. `(10 ** 21.5) + 0.123456789 and `(10 ** 21.5)` both return "3162277660168379400000".
+ * @param value The value to be inspected.
+ * @returns The number of decimal places in `value`.
+ */
+export declare function countDecimalPlaces(value: number): number;
+/**
+ * Determines how many decimal places should be used in presenting values to the user.
+ *
+ * There must be at least enough decimal places for the step size, although there could be more.
+ * @param precision A precision value, likely from element.format.precision.
+ * @param step The step size being used. This must be a validated step size from a NumberConstraints.
+ * @param partialNumberFormatConfiguration Any configuration to normalize the supplied precision.
+ * @returns The number of decimal places to be used to display values.
+ */
+export declare function sanitizePrecision(precision: number | undefined, step: number, partialNumberFormatConfiguration?: Partial<NumberFormatConfiguration>): number;
+/**
+ * Combines the provided configuration with the default and returns a new {@link NumberFormatConfiguration}.
+ * @param partialConfiguration Configuration to be added with the defaults.
+ * @returns The full set of constraints to use.
+ */
+export declare function getNumberFormatConfiguration(partialConfiguration: Partial<NumberFormatConfiguration> | undefined): NumberFormatConfiguration;
+/**
+ * Compares a value with some constraints and returns an adjusted value that satisfies the constraints. There are three considerations:
+ *   1. The value must be >= `minimum`. Otherwise it is changed to `minimum`.
+ *   2. The value must be <= `maximum`. Otherwise it is changed to `maximum`.
+ *   3. The value must land on a valid step between the bounds. Otherwise it is moved to the nearest step.
+ *      This can only be enforced if `minimum` or `maximum` is specified.
+ *
+ * It is assumed that the supplied `numberConstraints` satisfy the following criteria:
+ *   * `maximum` must not be less than or equal to `minimum`.
+ *   * If `maximum` and `minimum` are both defined:
+ *     * `maximum` must be a whole number of steps greater than `minimum`.
+ *     * `step` must not be greater than `maximum - minimum`.
+ * @param value The value to be inspected.
+ * @param numberConstraints The constraints to be applied to the value.
+ * @returns A new value which satisfies the constraints.
+ */
+export declare function enforceConstraints(value: number, numberConstraints: defs.NumberConstraints): number;
+/**
+ * Retrieves the effective number slider values after applying various validation checks and bounds.
+ * @param values The initial input values based on which the result is computed.
+ * @param numberConstraints
+ * @returns A sorted numeric array with user entered values, if valid and default values if not.
+ */
+export declare function getNumberSliderValues(values: defs.Value | undefined, numberConstraints: defs.NumberConstraints, singleValue?: boolean): number[];
+/**
+ * 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: defs.NumberRef | undefined): boolean;
+/**
+ * A mark on the slider. This is a copy of the interface by the same name in @mui/base/useSlider.
+ * We use string rather than React.Node so that we can share this between runtime and designer without discrepancies between the typings.
+ */
+export interface Mark {
+    value: number;
+    label?: string;
+}
+/**
+ * Gets marks to be used with the @vertigis/react-ui/Slider component.
+ *
+ * Returning `true` is a shortcut to tell the Slider to generate its own marks based on the step size.
+ * This is only possible when `showMinMaxLabels` is false, though, as they are also rendered as marks.
+ * When `showMinMaxLabels` and `showTickMarks` are both true, we need to manually generate all of the marks.
+ * @param maximum The highest allowed value.
+ * @param minimum The lowest allowed value.
+ * @param step: The amount of change between values.
+ * @param formatOptions The FormatOptions for formatting text on the labels.
+ * @param showMinMaxLabels True if labels should be included for min and max, false otherwise.
+ * @param showTickMarks  True if tick marsks should be shown, false otherwise.
+ * @returns The value for the marks property for the slider.
+ */
+export declare function getMarks(maximum: number, minimum: number, step: number, formatOptions: FormatOptions, showMinMaxLabels: boolean, showTickMarks: boolean): boolean | Mark[];

package/forms/numberUtilities.js

@@ -0,0 +1 @@
+import{format}from"./numberFormatter.js";import{isNumberRef,isNumeric}from"./utils.js";const defaultNumberFormatConfiguration={lowerBound:{default:0},precision:{default:3,minimum:-20,maximum:20},step:{default:1},upperBound:{default:100}};function getNumberConstraints(e,r){var{lowerBound:i,upperBound:t}=e=e||{};let{precision:u,step:o}=e;var n,r=getNumberFormatConfiguration(r);let a=isNumeric(i)?i:r.lowerBound.default,m=isNumeric(t)?t:r.upperBound.default;return void 0!==m&&void 0!==a&&m<=a&&(a=r.lowerBound.default,m=r.upperBound.default),u="number"!=typeof u||Number.isNaN(u)?r.precision.default:u,void 0!==r.precision.minimum&&(u=Math.max(u,r.precision.minimum)),void 0!==r.precision.maximum&&(u=Math.min(u,r.precision.maximum)),u<0?(n=Math.pow(10,-1*u),void 0!==o&&o%n==0||(o=n)):(o=isNumeric(o)&&0<o?o:r.step.default,void 0!==m&&void 0!==a&&(o=Math.min(o,m-a),n=(m-a)/o,Number.isInteger(n)||(r=countDecimalPlaces(o),m=roundAccurately(a+Math.floor(n)*o,r)))),{maximum:m,minimum:a,step:o}}const intlNumberFormat=new Intl.NumberFormat("en-US",{minimumFractionDigits:0,maximumFractionDigits:20,useGrouping:!1});function countDecimalPlaces(e){if(Number.isInteger(e))return 0;const r=intlNumberFormat.format(e);e=r.indexOf(".");return-1===e?0:r.length-e-1}function sanitizePrecision(e,r,i){i=getNumberFormatConfiguration(i);void 0===e&&(e=i.precision.default);r=countDecimalPlaces(r);return Math.max(r,e)}function getNumberFormatConfiguration(e){const r={lowerBound:{...defaultNumberFormatConfiguration.lowerBound},precision:{...defaultNumberFormatConfiguration.precision},step:{...defaultNumberFormatConfiguration.step},upperBound:{...defaultNumberFormatConfiguration.upperBound}};if(void 0!==e)for(const i in e)r[i]=Object.assign(r[i],e[i]);return r}function enforceConstraints(e,r){var i,t,{maximum:u,minimum:o,step:r}=r;return void 0!==o?(i=(e-o)/r,Number.isInteger(i)||(t=countDecimalPlaces(r),e=roundAccurately(o+Math.round(i)*r,t))):void 0!==u&&(i=(u-e)/r,Number.isInteger(i)||(t=countDecimalPlaces(r),e=roundAccurately(u-Math.round(i)*r,t))),void 0!==o&&e<o&&(e=o),e=void 0!==u&&u<e?u:e}function getNumberSliderValues(e,r,i=!1){let t=[],u=NaN,o=NaN;if("string"==typeof e){const a=e.split("\n").filter(e=>""!==e);e=a.map(e=>(e=>(e=(e||"").trim(),isNumeric(e)?parseFloat(e):NaN))(e))}else"number"==typeof e?u=e:"number"==typeof e?.numeric&&(u=e.numeric);if(Array.isArray(e)&&1<=e.length&&(u=e[0],o=e[1]),void 0===u||isNaN(u)||(u=enforceConstraints(u,r),void 0===o||isNaN(o)?i&&t.push(u):(o=enforceConstraints(o,r),t.push(u,o))),t=t.sort((e,r)=>e-r),t.length===(i?1:2))return t;var n=r.maximum,e=r.minimum;return i?[enforceConstraints((e+n)/2,r)]:[e,n]}function areValuesEqual(e,r){e=e.value;if(void 0===e&&void 0===r||null===e&&null===r)return!0;var i,t;return!(!isNumberRef(e)||!isNumberRef(r))&&(e.display===r.display&&e.refValueType===r.refValueType&&e.numeric===r.numeric&&(i=e.format,t=r.format,void 0===i&&void 0===t||void 0!==i&&void 0!==t&&(i.currency===t.currency&&i.customDisplayFormat===t.customDisplayFormat&&i.displayFormat===t.displayFormat&&i.lowerBound===t.lowerBound&&i.precision===t.precision&&i.step===t.step&&i.upperBound===t.upperBound)))}function getMarks(r,i,t,e,u,o){if(u&&o){const n=[{value:i,label:format(e,i)}];for(let e=i+t;e<r;e+=t)n.push({value:e});return n.push({value:r,label:format(e,r)}),n}return u&&!o?[{value:i,label:format(e,i)},{value:r,label:format(e,r)}]:o}function roundAccurately(e,r){return Number(Math.round(Number(e+`e${r}`))+`e-${r}`)}export{defaultNumberFormatConfiguration,getNumberConstraints,countDecimalPlaces,sanitizePrecision,getNumberFormatConfiguration,enforceConstraints,getNumberSliderValues,areValuesEqual,getMarks};

package/forms/presenter.d.ts

@@ -8,6 +8,7 @@ export declare function refresh(component: {}): void;
 export declare function refreshForm(host: FormPresenterHost, container: Element): void;
 /**
  * Releases the underlying visual for the element.
+ * @product This is intended for internal use only within VertiGIS Studio products.
  * @param element The element to release from.
  */
 export declare function releaseForm(container: HTMLElement): void;

package/forms/presenter.js

@@ -1 +1 @@
-import{createElement}from"react";import*as React from"react";import{unmountComponentAtNode,render as reactRender}from"react-dom";import{FormComponent}from"./FormComponent.js";import*as renderers from"./renderers.js";function refresh(e){e instanceof FormComponent&&e.forceUpdate()}function refreshForm(e,r){reactRender(React.createElement(FormComponent,{host:e,type:"form"}),r)}function releaseForm(e){unmountComponentAtNode(e)}function render(e){if(e instanceof FormComponent){switch(e.props.type){case"form":return renderers.renderForm(e);case"header":return renderers.renderHeader(e);case"main":return renderers.renderMain(e);case"footer":return renderers.renderFooter(e);case"body":return renderers.renderBody(e);case"row":return renderers.renderRow(e);case"section":return renderers.element.renderSection(e,e.prepare());case"element":break;default:return}var r=e.prepare();if(null==r)return;var n=r.type;if("string"!=typeof n)return;if("Custom"===n)return e.props.host.renderCustom(e,r);if(e.elementRegistration)return createElement(e.elementRegistration.component,renderers.getElementProps(e,r));const t=renderers.element["render"+n];if("function"==typeof t)return t(e,r)}}function renderNone(e){if(e instanceof FormComponent)return renderers.renderNone(e)}export{refresh,refreshForm,releaseForm,render,renderNone};
+import{createElement}from"react";import*as React from"react";import{unmountComponentAtNode,render as reactRender}from"react-dom";import{FormComponent}from"./FormComponent.js";import*as renderers from"./renderers.js";import{getElementProps}from"./utils.js";function refresh(e){e instanceof FormComponent&&e.forceUpdate()}function refreshForm(e,r){reactRender(React.createElement(FormComponent,{host:e,type:"form"}),r)}function releaseForm(e){unmountComponentAtNode(e)}function render(e){if(e instanceof FormComponent){switch(e.props.type){case"form":return renderers.renderForm(e);case"header":return renderers.renderHeader(e);case"main":return renderers.renderMain(e);case"footer":return renderers.renderFooter(e);case"body":return renderers.renderBody(e);case"row":return renderers.renderRow(e);case"section":return renderers.element.renderSection(e,e.prepare());case"accordionGroup":return renderers.renderAccordionGroup(e);case"element":break;default:return}var r=e.prepare();if(null==r)return;var n=r.type;if("string"!=typeof n)return;if("Custom"===n)return e.props.host.renderCustom(e,r);if(e.elementRegistration)return createElement(e.elementRegistration.component,getElementProps(e,r));const o=renderers.element["render"+n];if("function"==typeof o)return o(e,r)}}function renderNone(e){if(e instanceof FormComponent)return renderers.renderNone(e)}export{refresh,refreshForm,releaseForm,render,renderNone};

package/forms/renderers.d.ts

@@ -1,46 +1,40 @@
 /// <reference types="react" />
 import { FormComponent } from "./FormComponent";
-import * as defs from "./FormDefinition";
-import * as datetime from "./datetime";
-import * as files from "./files";
-import * as geometry from "./geometry";
-import * as number from "./number";
-import * as scanner from "./scanner";
-import * as selectors from "./selectors";
-import { FormElementProps } from "./index";
+import { Element } from "./FormDefinition";
 export declare function renderForm(component: FormComponent): JSX.Element;
 export declare function renderHeader(component: FormComponent): JSX.Element;
 export declare function renderFooter(component: FormComponent): JSX.Element;
 export declare function renderBody(component: FormComponent): JSX.Element;
 export declare function renderRow(component: FormComponent): JSX.Element;
 export declare function renderMain(component: FormComponent): JSX.Element;
+export declare function renderAccordionGroup(component: FormComponent): JSX.Element;
 export declare function renderNone(component: FormComponent): any;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
 export declare namespace element {
-    function renderPasswordBox(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderText(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderTextArea(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderTextBox(component: FormComponent, element: defs.Element): JSX.Element;
-    export import renderNumber = number.renderNumber;
-    export import renderNumberRangeSlider = number.renderNumberRangeSlider;
-    export import renderNumberSlider = number.renderNumberSlider;
-    export import renderAutoComplete = selectors.renderAutoComplete;
-    export import renderCheckBox = selectors.renderCheckBox;
-    export import renderCheckGroup = selectors.renderCheckGroup;
-    export import renderDropDownList = selectors.renderDropDownList;
-    export import renderItemPicker = selectors.renderItemPicker;
-    export import renderListBox = selectors.renderListBox;
-    export import renderRadioGroup = selectors.renderRadioGroup;
-    export import renderDatePicker = datetime.renderDateTimePicker;
-    export import renderDateRangePicker = datetime.renderDateRangePicker;
-    export import renderTimePicker = datetime.renderDateTimePicker;
-    export import renderDateTimePicker = datetime.renderDateTimePicker;
-    export import renderGeometryPicker = geometry.renderGeometryPicker;
-    export import renderFilePicker = files.renderFilePicker;
-    export import renderScanner = scanner.renderScanner;
-    function renderSection(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderHorizontalRule(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderImage(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderButtonBar(component: FormComponent, element: defs.Element): JSX.Element;
-    function renderCustom(component: FormComponent, element: defs.Element): JSX.Element;
+    function renderAutoComplete(component: FormComponent, element: Element): JSX.Element;
+    function renderButtonBar(component: FormComponent, element: Element): JSX.Element;
+    function renderCheckBox(component: FormComponent, element: Element): JSX.Element;
+    function renderCheckGroup(component: FormComponent, element: Element): JSX.Element;
+    function renderCustom(component: FormComponent, element: Element): JSX.Element;
+    function renderDatePicker(component: FormComponent, element: Element): JSX.Element;
+    function renderDateRangePicker(component: FormComponent, element: Element): JSX.Element;
+    function renderDateTimePicker(component: FormComponent, element: Element): JSX.Element;
+    function renderDropDownList(component: FormComponent, element: Element): JSX.Element;
+    function renderFilePicker(component: FormComponent, element: Element): JSX.Element;
+    function renderGeometryPicker(component: FormComponent, element: Element): JSX.Element;
+    function renderHorizontalRule(component: FormComponent, element: Element): JSX.Element;
+    function renderImage(component: FormComponent, element: Element): JSX.Element;
+    function renderItemPicker(component: FormComponent, element: Element): JSX.Element;
+    function renderListBox(component: FormComponent, element: Element): JSX.Element;
+    function renderNumber(component: FormComponent, element: Element): JSX.Element;
+    function renderNumberRangeSlider(component: FormComponent, element: Element): JSX.Element;
+    function renderNumberSlider(component: FormComponent, element: Element): JSX.Element;
+    function renderPasswordBox(component: FormComponent, element: Element): JSX.Element;
+    function renderRadioGroup(component: FormComponent, element: Element): JSX.Element;
+    function renderScanner(component: FormComponent, element: Element): JSX.Element;
+    function renderSection(component: FormComponent, element: Element): JSX.Element;
+    function renderText(component: FormComponent, element: Element): JSX.Element;
+    function renderTextArea(component: FormComponent, element: Element): JSX.Element;
+    function renderTextBox(component: FormComponent, element: Element): JSX.Element;
+    function renderTimePicker(component: FormComponent, element: Element): JSX.Element;
 }
-export declare function getElementProps(component: FormComponent, element: defs.Element): FormElementProps;