@vertigis/workflow 5.33.1 → 5.35.0

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{FormComponentTypes,FormElementTypes}from"./constants.js";import{renderComponent,renderElement,renderNone as renderers_renderNone}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){if(e.props.type!==FormComponentTypes.ELEMENT)return renderComponent(e);var r=e.prepare();if(null==r)return;var n=r.type;return"string"!=typeof n?void 0:n===FormElementTypes.CUSTOM?e.props.host.renderCustom(e,r):e.elementRegistration?createElement(e.elementRegistration.component,getElementProps(e,r)):renderElement(n,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,8 @@
 /// <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";
-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;
+import { Element } from "./FormDefinition";
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function renderComponent(component: FormComponent): JSX.Element;
 export declare function renderNone(component: FormComponent): any;
-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;
-}
-export declare function getElementProps(component: FormComponent, element: defs.Element): FormElementProps;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function renderElement(type: string, component: FormComponent, element: Element): JSX.Element;

package/forms/renderers.js

@@ -1 +1 @@
-import{styled}from"@vertigis/react-ui/styles";import*as React from"react";import{createElement}from"react";import{FormComponent,FormElement as FormElementComponent}from"./FormComponent.js";import*as defs from"./FormDefinition.js";import FormElement from"./FormElement.js";import LegacyStyles from"./LegacyStyles.js";import{renderChevronDown,renderChevronUp}from"./assets/stock.js";import{renderDescription,renderError,renderFocus,renderTitle}from"./common.js";import Text from"./components/Text.js";import TextArea from"./components/TextArea.js";import TextBox from"./components/TextBox.js";import{FormElementTypes,Orientation}from"./constants.js";import*as datetime from"./datetime.js";import*as files from"./files.js";import*as geometry from"./geometry.js";import{getKeyString}from"./keyboard.js";import*as number from"./number.js";import*as scanner from"./scanner.js";import*as selectors from"./selectors.js";import{makeSafeClassName,sort,makeUniqueId}from"./utils.js";const Root=styled("div")(()=>LegacyStyles);function renderForm(e){const o=e.props.host,n={host:o,type:"header",children:[]},s={host:o,type:"body",children:[]},c={host:o,type:"main",children:[]},a={host:o,type:"footer",children:[]},r={host:o,type:"body",children:[]},i={},m=[];function t(e){if(void 0===e)return s;if("header"===e)return n;if("footer"===e)return a;let r;r="object"==typeof e?e.name:e;let t=(e=>{for(const r of m)if(r.name===e)return r})(r);return void 0===t&&(t={host:o,name:r,type:"section",children:[]},m.push(t)),t}function l(e){return"Section"!==e}function d(e){return e===n||e===s||e===a?`${e.type}-section`:e.name}const p=sort(e.props.host.form.elements);for(const R in p){var u,f=p[R];if(!0!==(h=f).hoisted&&(!1!==h.visible&&l(h.type)))if(!0!==f.overlay){let e=t(f.section);void 0!==f.rowNumber&&(u=d(e),e=function(e,r){let t=i[r];t=t||(i[r]=[]);let n=t[e];return void 0===n&&(n=t[e]={host:o,type:"row",children:[]}),n}(f.rowNumber,u)),e.children.push(React.createElement(FormElementComponent,{key:R,host:o,type:"element",name:R}))}else r.children.push(React.createElement(FormElementComponent,{key:R,host:o,type:"element",name:R}))}var h,y;const E=[];if(0<n.children.length&&E.push(React.createElement(FormComponent,{key:"header",...n})),0<r.children.length)E.push(React.createElement(FormComponent,{key:"main",...r}));else{v(s);for(const g of m)y=g.name,null!=(y=p[y])&&(l(y.type)||!0===y.hoisted||!1===y.visible)||v(t(g.name));0<c.children.length&&E.push(React.createElement(FormComponent,{key:"main",...c}))}function v(e){var r=e===s?"body":`$${e.name}`,t=d(e),n=i[t];if(n)for(const m of Object.keys(n).sort((e,r)=>parseInt(e)-parseInt(r))){var o,a=n[m];1<a.children.length?(o=`row-${m}`,e.children.push(React.createElement(FormComponent,{key:o,...a}))):1===a.children.length&&e.children.push(...a.children)}0<e.children.length&&c.children.push(React.createElement(FormComponent,{key:r,...e}))}return 0<a.children.length&&E.push(React.createElement(FormComponent,{key:"footer",...a})),React.createElement(Root,{className:"gcx-forms defaults custom",ref:function(e){o.renderFocus(e)},onKeyDown:function(e){"enter"===getKeyString(e)&&(e.target instanceof HTMLButtonElement||o.post("clicked"))}},E)}function renderHeader(e){return React.createElement("div",{className:"Header"},e.props.children)}function renderFooter(e){return React.createElement("div",{className:"Footer"},e.props.children)}function renderBody(e){return React.createElement("div",{className:"Body"},e.props.children)}function renderRow(e){return React.createElement("div",{className:"Row"},e.props.children)}function renderMain(e){return React.createElement("div",{className:"Main"},e.props.children)}function renderNone(e){return React.createElement("div",{className:"None"},"--- Unsupported Form Element (name=",e.props.name,") ---")}var element;function getElementProps(e,r){return{...r,element:r,name:e.props.name,enabled:r.enabled,setProperty:e.setProperty,setValue:e.setValue,raiseEvent:e.raiseEvent,value:r.value}}!function(e){e.renderPasswordBox=function(e,r){return React.createElement(TextBox,{component:e,element:r,type:"password"})},e.renderText=function(e,r){return React.createElement(Text,{component:e,element:r})},e.renderTextArea=function(e,r){return React.createElement(TextArea,{component:e,element:r})},e.renderTextBox=function(e,r){return React.createElement(TextBox,{component:e,element:r})},e.renderNumber=number.renderNumber,e.renderNumberRangeSlider=number.renderNumberRangeSlider,e.renderNumberSlider=number.renderNumberSlider,e.renderAutoComplete=selectors.renderAutoComplete,e.renderCheckBox=selectors.renderCheckBox,e.renderCheckGroup=selectors.renderCheckGroup,e.renderDropDownList=selectors.renderDropDownList,e.renderItemPicker=selectors.renderItemPicker,e.renderListBox=selectors.renderListBox,e.renderRadioGroup=selectors.renderRadioGroup,e.renderDatePicker=datetime.renderDateTimePicker,e.renderDateRangePicker=datetime.renderDateRangePicker,e.renderTimePicker=datetime.renderDateTimePicker,e.renderDateTimePicker=datetime.renderDateTimePicker,e.renderGeometryPicker=geometry.renderGeometryPicker,e.renderFilePicker=files.renderFilePicker,e.renderScanner=scanner.renderScanner,e.renderSection=function(r,t){const n=r.props.host,o=r.props.name;let e=void 0;null!=t&&t.format&&(e=t.format),e=void 0!==e&&null!==e?e:defs.DEFAULT_SECTION_FORMAT;const a="accordion-section"===e;var m=a||"collapsible-section"===e;const s=[t.type,makeSafeClassName(o),e];t.styleName&&s.push(makeSafeClassName(t.styleName));let c=null,i;var l=makeUniqueId(o);let d="content";if(m){let e="form-element-title";t.collapsed&&(e+=" collapsed",d+=" collapsed");var p=(t.collapsed?renderChevronDown:renderChevronUp)();c=renderTitle(n,t,l,void 0,"caption"),i=React.createElement("button",{className:e,onClick:function(){a&&t.collapsed?n.updateAccordionSections(o):(t.collapsed=!t.collapsed,r.forceUpdate())},ref:e=>renderFocus(e,o,n)},c||React.createElement("span",{className:"caption"}),p)}else c=renderTitle(n,t,l),i=c;var u=renderDescription(n,t,l),m=renderError(n,t),p=c?.props?.id,l=u?.props?.id;return React.createElement("div",{"aria-labelledby":p,"aria-describedby":l,className:s.join(" ")},i,React.createElement("div",{className:d},u,m,r.props.children))},e.renderHorizontalRule=function(e,r){e=e.props.name;const t=[FormElementTypes.HORIZONTALRULE,makeSafeClassName(e)];return r.styleName&&t.push(makeSafeClassName(r.styleName)),React.createElement("hr",{className:t.join(" ")})},e.renderImage=function(e,r){const t=e.props["host"];let n,o;var a=r.size;"number"==typeof a&&(o=a,n=a),"object"==typeof a&&("number"==typeof a.width&&(n=a.width),"number"==typeof a.height&&(o=a.height));let m=void 0;return"string"==typeof(a=r.value)&&(m=a),a=t.renderText(r.tooltip),React.createElement(FormElement,{component:e,element:r,legacyMode:!0},React.createElement("img",{src:m,title:a,width:n,height:o}))},e.renderButtonBar=function(e,r){const{host:n,name:o}=e.props;var t=sort(r.items);let a=void 0;const m=[];for(const f in t){var s=t[f],c=e.enabled&&!1!==s.enabled&&!1!==s.visible,i={__html:n.renderHtml(s.label,defs.HTMLContentCategory.Phrasing)},l=n.renderText(s.tooltip),d=t[f].value;c&&void 0===a&&(a=f);var p=s.styleName?makeSafeClassName(s.styleName):void 0;!1!==s.visible&&m.push(React.createElement("button",{className:p,key:f,disabled:!c,title:l,ref:function(r){return function(e){null!==e&&r===a&&n.renderFocus(e,o)}}(f),onClick:function(r,t){return function(e){n.post("clicked",{name:o,item:r,value:t})}}(f,d),dangerouslySetInnerHTML:i}))}const u=["items"];return r.orientation===Orientation.VERTICAL&&u.push("vertical"),React.createElement(FormElement,{component:e,element:r,legacyMode:!0},React.createElement("div",{className:u.join(" ")},m))},e.renderCustom=function(e,r){var t=e.props.name;return e.elementRegistration||console.warn(`Unable to render custom form element '${t}' of type '${r.customType}'.`),React.createElement(FormElement,{component:e,element:r,legacyMode:!0},e.elementRegistration?createElement(e.elementRegistration.component,getElementProps(e,r)):`--- ${r.customType} ---`)}}(element=element||{});export{renderForm,renderHeader,renderFooter,renderBody,renderRow,renderMain,renderNone,element,getElementProps};
+import Box from"@vertigis/react-ui/Box";import*as React from"react";import AccordionGroup from"./components/AccordionGroup.js";import AutoComplete from"./components/AutoComplete.js";import ButtonBar from"./components/ButtonBar.js";import CheckBox from"./components/CheckBox.js";import CheckGroup from"./components/CheckGroup.js";import Custom from"./components/Custom.js";import DatePicker from"./components/DatePicker.js";import DateRangePicker from"./components/DateRangePicker.js";import DateTimePicker from"./components/DateTimePicker.js";import DropDownList from"./components/DropDownList.js";import FilePicker from"./components/FilePicker.js";import Form,{formClasses}from"./components/Form.js";import GeometryPicker from"./components/GeometryPicker.js";import HorizontalRule from"./components/HorizontalRule.js";import Image from"./components/Image.js";import ItemPicker from"./components/ItemPicker.js";import ListBox from"./components/ListBox.js";import Number from"./components/Number.js";import NumberRangeSlider from"./components/NumberRangeSlider.js";import NumberSlider from"./components/NumberSlider.js";import RadioGroup from"./components/RadioGroup.js";import Scanner from"./components/Scanner.js";import Section from"./components/Section.js";import Signature from"./components/Signature.js";import Text from"./components/Text.js";import TextArea from"./components/TextArea.js";import TextBox from"./components/TextBox.js";import TimePicker from"./components/TimePicker.js";import{FormComponentTypes,FormElementTypes}from"./constants.js";function renderComponent(e){switch(e.props.type){case FormComponentTypes.FORM:return React.createElement(Form,{component:e});case FormComponentTypes.HEADER:return renderBox(e.props.children,formClasses.header);case FormComponentTypes.MAIN:return renderBox(e.props.children,formClasses.main);case FormComponentTypes.FOOTER:return renderBox(e.props.children,formClasses.footer);case FormComponentTypes.BODY:return renderBox(e.props.children,formClasses.body);case FormComponentTypes.ROW:return renderBox(e.props.children,formClasses.row);case FormComponentTypes.SECTION:return renderElement(FormElementTypes.SECTION,e,e.prepare());case FormComponentTypes.ACCORDIONGROUP:return React.createElement(AccordionGroup,{component:e});default:return null}}function renderNone(e){return renderBox([`--- Unsupported Form Element (name=${e.props.name}) ---`],"None")}function renderBox(e,t){return React.createElement(Box,{className:t},e)}function renderElement(e,t,r){switch(e){case FormElementTypes.AUTOCOMPLETE:return React.createElement(AutoComplete,{component:t,element:r});case FormElementTypes.BUTTONBAR:return React.createElement(ButtonBar,{component:t,element:r});case FormElementTypes.CHECKBOX:return React.createElement(CheckBox,{component:t,element:r});case FormElementTypes.CHECKGROUP:return React.createElement(CheckGroup,{component:t,element:r});case FormElementTypes.CUSTOM:return React.createElement(Custom,{component:t,element:r});case FormElementTypes.DATEPICKER:return React.createElement(DatePicker,{component:t,element:r});case FormElementTypes.DATERANGEPICKER:return React.createElement(DateRangePicker,{component:t,element:r});case FormElementTypes.DATETIMEPICKER:return React.createElement(DateTimePicker,{component:t,element:r});case FormElementTypes.DROPDOWNLIST:return React.createElement(DropDownList,{component:t,element:r});case FormElementTypes.FILEPICKER:return React.createElement(FilePicker,{component:t,element:r});case FormElementTypes.GEOMETRYPICKER:return React.createElement(GeometryPicker,{component:t,element:r});case FormElementTypes.HORIZONTALRULE:return React.createElement(HorizontalRule,{component:t,element:r});case FormElementTypes.IMAGE:return React.createElement(Image,{component:t,element:r});case FormElementTypes.ITEMPICKER:return React.createElement(ItemPicker,{component:t,element:r});case FormElementTypes.LISTBOX:return React.createElement(ListBox,{component:t,element:r});case FormElementTypes.NUMBER:return React.createElement(Number,{component:t,element:r});case FormElementTypes.NUMBERRANGESLIDER:return React.createElement(NumberRangeSlider,{component:t,element:r});case FormElementTypes.NUMBERSLIDER:return React.createElement(NumberSlider,{component:t,element:r});case FormElementTypes.PASSWORDBOX:return React.createElement(TextBox,{component:t,element:r,type:"password"});case FormElementTypes.RADIOGROUP:return React.createElement(RadioGroup,{component:t,element:r});case FormElementTypes.SCANNER:return React.createElement(Scanner,{component:t,element:r});case FormElementTypes.SECTION:return React.createElement(Section,{component:t,element:r});case FormElementTypes.SIGNATURE:return React.createElement(Signature,{component:t,element:r});case FormElementTypes.TEXT:return React.createElement(Text,{component:t,element:r});case FormElementTypes.TEXTAREA:return React.createElement(TextArea,{component:t,element:r});case FormElementTypes.TEXTBOX:return React.createElement(TextBox,{component:t,element:r});case FormElementTypes.TIMEPICKER:return React.createElement(TimePicker,{component:t,element:r});default:return null}}export{renderComponent,renderNone,renderElement};

package/forms/textUtilities.d.ts

@@ -1,3 +1,4 @@
+import { markdownToSafeHtml } from "@vertigis/react-ui/utils/markdown";
 import * as defs from "./FormDefinition";
 /**
  * Ensures the supplied string can be rendered literally in markdown by
@@ -14,8 +15,9 @@ import * as defs from "./FormDefinition";
  * @param literalString A string to be treated literally in markdown.
  */
 export declare function escapeTextForMarkdown(literalString: string): string;
-export declare function isMarkdown(text: Partial<defs.MarkdownRef> & defs.Text): text is defs.MarkdownRef;
-export declare function isStatus(text: Partial<defs.StatusRef> & defs.Text): text is defs.StatusRef;
-export declare function textToHtml(text: string): string;
-export declare function markdownToHtml(markdown: string, htmlContentCategory?: defs.HTMLContentCategory): string;
+export declare function hasContent(text: defs.Text | undefined): boolean;
+export declare function isMarkdown(text: (Partial<defs.MarkdownRef> & defs.Text) | undefined | null): text is defs.MarkdownRef;
+export declare function isStatus(text: (Partial<defs.StatusRef> & defs.Text) | undefined | null): text is defs.StatusRef;
 export declare function markdownToText(markdown: string): string;
+export declare function textToHtml(text: string): string;
+export { markdownToSafeHtml };

package/forms/textUtilities.js

@@ -1 +1 @@
-import{Remarkable}from"remarkable";import*as defs from"./FormDefinition.js";const htmlContent=document.createElement("div"),textContent=document.createElement("div"),textNode=document.createTextNode("");htmlContent.appendChild(textNode);const phrasingContentElement=document.createElement("span"),markdownCharsRegExp=/[\\`*_{}[\]()#+\-.!>~]/g,markdownCodeBlockSpacesRegExp=/^[ ]{4}/gm,markdownCodeBlockTabRegExp=/^[ ]{0,3}[	]{1}/gm,markdownLineBreakSuffixRegExp=/[ ]{2}$/gm,remarkable=new Remarkable("commonmark",{html:!1,linkTarget:"_blank"});function escapeTextForMarkdown(e){let t=e.replace(markdownCharsRegExp,"\\$&");return t=t.replace(markdownCodeBlockSpacesRegExp," "),t=t.replace(markdownCodeBlockTabRegExp," "),t=t.replace(markdownLineBreakSuffixRegExp," "),t}function isMarkdown(e){return null!=e&&"string"==typeof e.markdown}function isStatus(e){return null!=e&&"string"==typeof e.status}function textToHtml(e){return textNode.data=e,htmlContent.innerHTML}const phrasingContentTags=["abbr","audio","b","bdo","br","button","canvas","cite","code","command","data","datalist","dfn","em","embed","i","iframe","img","input","kbd","keygen","label","mark","math","meter","noscript","object","output","progress","q","ruby","samp","script","select","small","span","strong","sub","sup","svg","textarea","time","var","video","wbr"];function isPhrasingContent(e){let t=!1;var n;return e instanceof Text?(n=e.textContent.trim(),t=""!==n):e instanceof HTMLElement&&(e=e.tagName.toLowerCase(),t=-1!==phrasingContentTags.indexOf(e)),t}function nodeToPhrasingContent(t){let n="",e="";if(isPhrasingContent(t))if(t instanceof Text)n+=textToHtml(t.textContent);else if(t instanceof HTMLElement){const a=t.outerHTML;var o=a.substring(0,a.indexOf(">")+1);n+=o;var r=a.lastIndexOf("<");e=r<o.length?"":a.substring(r)}for(let e=0;e<t.childNodes.length;e++)n+=nodeToPhrasingContent(t.childNodes[e]);return n+=e,n}function htmlToPhrasingContent(e){phrasingContentElement.innerHTML=e;let t="";for(let e=0;e<phrasingContentElement.childNodes.length;e++)t+=nodeToPhrasingContent(phrasingContentElement.childNodes[e]);return t}function markdownToHtml(e,t=defs.HTMLContentCategory.Flow){let n=remarkable.render(e);return t===defs.HTMLContentCategory.Phrasing&&(n=htmlToPhrasingContent(n)),n}function markdownToText(e){return textContent.innerHTML=markdownToHtml(e,defs.HTMLContentCategory.Flow),textContent.innerText}export{escapeTextForMarkdown,isMarkdown,isStatus,textToHtml,markdownToHtml,markdownToText};
+import{markdownToSafeHtml}from"@vertigis/react-ui/utils/markdown";const htmlContent=document.createElement("div"),textContent=document.createElement("div"),textNode=document.createTextNode("");htmlContent.appendChild(textNode);const markdownCharsRegExp=/[\\`*_{}[\]()#+\-.!>~]/g,markdownCodeBlockSpacesRegExp=/^[ ]{4}/gm,markdownCodeBlockTabRegExp=/^[ ]{0,3}[	]{1}/gm,markdownLineBreakSuffixRegExp=/[ ]{2}$/gm;function escapeTextForMarkdown(t){let e=t.replace(markdownCharsRegExp,"\\$&");return e=e.replace(markdownCodeBlockSpacesRegExp," "),e=e.replace(markdownCodeBlockTabRegExp," "),e=e.replace(markdownLineBreakSuffixRegExp," "),e}function hasContent(t){return"string"==typeof t?!!t:isMarkdown(t)?!!t.markdown:!!isStatus(t)&&!!t.status}function isMarkdown(t){return null!=t&&"string"==typeof t.markdown}function isStatus(t){return null!=t&&"string"==typeof t.status}function markdownToText(t){return textContent.innerHTML=markdownToSafeHtml(t),textContent.innerText}function textToHtml(t){return textNode.data=t,htmlContent.innerHTML}export{escapeTextForMarkdown,hasContent,isMarkdown,isStatus,markdownToText,textToHtml,markdownToSafeHtml};

package/forms/utils.d.ts

@@ -1,5 +1,37 @@
+import { Lookup } from "../Collections";
+import { FormComponent } from "./FormComponent";
 import * as defs from "./FormDefinition";
 import * as text from "./textUtilities";
+import { FormElementProps } from "./index";
+/**
+ * Constraints for a property that may specify a default value and bounds.
+ */
+export interface PropertyConstraints<T> {
+    default?: T;
+    maximum?: T;
+    minimum?: T;
+}
+/**
+ * Constraints for a property that specifies a default value.
+ */
+export interface PropertyConstraintsWithDefault<T> extends PropertyConstraints<T> {
+    default: T;
+}
+/**
+ * Constraints for a property that specifies a maximum value.
+ */
+export interface PropertyConstraintsWithMaximum<T> extends PropertyConstraints<T> {
+    maximum: T;
+}
+/**
+ * Constraints for a property that specifies a minimum value.
+ */
+export interface PropertyConstraintsWithMinimum<T> extends PropertyConstraints<T> {
+    minimum: T;
+}
+export interface FormElementPropertyConstraints {
+    [key: string]: PropertyConstraints<any> | undefined;
+}
 export interface DebounceResult {
     /** Invoke the scheduled function immediately, without any further delay. */
     now: () => void;
@@ -12,39 +44,89 @@ export interface DebounceResult {
  **/
 export { text };
 export declare function makeId(): string;
-/** Performs key/item sorting. */
-export declare function sort<T>(items: T, predicate?: (item: T[keyof T], index: number) => number): T;
-export declare function sortItems(element: defs.Element): {
-    [key: string]: defs.Item;
+/**
+ * Performs key/item sorting.
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ */
+export declare function sort<T>(items: T | undefined, predicate?: (item: T[keyof T], index: number) => number | undefined): T;
+/**
+ * This function does a few things relating to items within an element.
+ *
+ *   1. The items are sorted by index, falling back to their order of the keys if no index is present.
+ *   2. Any items with visibe = false are excluded.
+ *   3. It ensures `element.value` and `element.current` are consistent.
+ *   4. It updates `element.label` to match the current item.
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ * @param element The element whose items are to be sorted.
+ * @returns An array of visible items, sorted by index.
+ */
+export declare function sortItems(element: defs.Element): Lookup<defs.Item>;
+/**
+ * Details returned by `sortAndFilterItems()`.
+ */
+declare type sortAndFilterItemsResult = {
+    /** The index of the now-selected item, based on the new value of `items`. */
+    current: string | undefined;
+    /** The sorted and filtered items. */
+    items: Lookup<defs.Item>;
+    /** The new `label` of the element, based on the new value of `current`. */
+    label: defs.Text | undefined;
+    /** The new `value` of the element, based on the new value of `current`. */
+    value: defs.Value | undefined;
 };
-export declare function makeSafeClassName(elementName: string): string;
-export declare function makeUniqueId(elementName: string): string;
+/**
+ * This function produces a set of `items` based on the supplied `element`.
+ * They are sorted based on `element.index` or the ordinal position.
+ * They are filtered to exclude `undefined`, `null` or elements with `visible` set to `false.`
+ *
+ * Unlike `sortItems()`, this function does not attempt to change `element`.
+ * Instead, new values for `current`, `label` and `value` are included in the result.
+ * It is then the responsibility of the caller to update them in the original `element` if necessary.
+ * @param element The element whose items are to be sorted.
+ * @returns A sorted and filtered set if items, along with a few properties that should be updated on `element`.
+ */
+export declare function sortAndFilterItems(element: defs.Element): sortAndFilterItemsResult;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function makeSafeClassName(elementName: string | undefined): string;
+/** @public */
+export declare function makeUniqueId(elementName: string | undefined): string;
 export declare function addClass(element: HTMLElement, name: string): void;
 export declare function removeClass(element: HTMLElement, name: string): void;
 export declare function setClass(element: HTMLElement, name: string, exists: boolean): void;
-export declare function isBoolean(value: defs.Value): value is boolean;
-export declare function isNumber(value: defs.Value): value is number;
-export declare function isString(value: defs.Value): value is string;
-export declare function isDataRef(value: defs.Value): value is defs.DataRef;
-export declare function isDateRangeRef(value: defs.Value): value is defs.DateRangeRef;
-export declare function isDateTimeRef(value: defs.Value): value is defs.DateTimeRef;
-export declare function isFilesRef(value: defs.Value): value is defs.FilesRef;
-export declare function isScanRef(value: defs.Value): value is defs.ScanRef;
-export declare function isGeometryRef(value: defs.Value): value is defs.GeometryRef;
-export declare function isItemsRef(value: defs.Value): value is defs.ItemsRef;
-export declare function isNumberRef(value: defs.Value): value is defs.NumberRef;
-export declare function sanitizeGeometryRef(value: defs.Value): defs.GeometryRef;
+export declare function isBoolean(value: defs.Value | undefined): value is boolean;
+export declare function isNumber(value: defs.Value | undefined): value is number;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function isString(value: defs.Value | undefined): value is string;
+export declare function isDataRef(value: defs.Value | undefined): value is defs.DataRef;
+export declare function isDateRangeRef(value: defs.Value | undefined): value is defs.DateRangeRef;
+export declare function isDateTimeRef(value: defs.Value | undefined): value is defs.DateTimeRef;
+export declare function isFilesRef(value: defs.Value | undefined): value is defs.FilesRef;
+export declare function isScanRef(value: defs.Value | undefined): value is defs.ScanRef;
+export declare function isGeometryRef(value: defs.Value | undefined): value is defs.GeometryRef;
+export declare function isItemsRef(value: defs.Value | undefined): value is defs.ItemsRef;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function isNumberRef(value: defs.Value | undefined): value is defs.NumberRef;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function sanitizeGeometryRef(value: defs.Value | undefined): defs.GeometryRef;
+/** @product This is intended for internal use only within VertiGIS Studio products. */
 export declare function createGeometryRef(format: defs.GeometryFormat): defs.GeometryRef;
-export declare function addStyleToDocument(css: string): HTMLStyleElement;
 /**
  * Creates a throttled function that will invoke the given
  * function at most once per the given delay.
  * @param func The function to invoke.
  * @param delay The delay to wait (in milliseconds) before invoking the function again.
  */
-export declare function throttle(func: Function, delay?: number): () => void;
+export declare function throttle(func: Function, delay?: number): (this: any) => void;
 /**
  * Determines whether a value is numeric, i.e. a number or a numeric string.
  * @param value The value to check.
  */
 export declare function isNumeric(value: unknown): boolean;
+export declare function getElementProps(component: FormComponent, element: defs.Element): FormElementProps;
+/**
+ * Gets the id of an item from a Lookup<defs.Item>.
+ * @param item The item to find.
+ * @param items The items to look through.
+ * @returns The key corresponding to the item, or undefined if no match was found.
+ */
+export declare function getItemId(item: defs.Item | null | undefined, items: Lookup<defs.Item>): string;

package/forms/utils.js

@@ -1 +1 @@
-import*as text from"./textUtilities.js";const DEFAULT_THROTTLE_DELAY=100;let next=0,seed=(new Date).valueOf();const guid="5DDC9A38-AAAB-44C1-AD87-415160F43D75";function makeId(){return 2147483648<=next&&(seed=(new Date).valueOf(),next=0),`${guid}:${seed}:${next++}`}function indexOf(e,t){if(null!=e){e=e.index;return"number"==typeof e?e:t}}function compareIndex(e,t){return compareNumber(e.index,t.index)}function compareNumber(e,t){return e<t?-1:t<e?1:0}function sort(e,t){void 0===t&&(t=indexOf);const n={};if("object"!=typeof e||null===e)return n;let i=0;const r=[];for(const a in e){var s=e[a],o=t(s,i++);"number"==typeof o&&r.push({key:a,index:o,item:s})}for(const u of r.sort(compareIndex))n[u.key]=u.item;return n}function sortItems(e){let t=e.current;var n=e.value,i=sort(e.items,function(e,t){if(null!=e&&!1!==e.visible){e=e.index;return"number"==typeof e?e:t}});if(void 0!==t&&null!==t&&void 0!==i[t]||(t=void 0),void 0===t&&null!=n)for(const r in i){if(i[r].value===n)break;t=void 0}return void 0!==t?(e.current=t,e.label=i[t].label,e.value=i[t].value):(e.current=void 0,e.label=void 0,e.value=void 0),i}function stripClassName(e,t){return e.className.split(" ").filter(e=>0<e.length&&e!==t).join(" ")}function makeSafeClassName(e){return`gcx-forms-${e?.replace(/[\W]/g,"")||"element"}`}let idSuffix=0;function makeUniqueId(e){return`${makeSafeClassName(e)}-${++idSuffix}`}function addClass(e,t){void 0!==e.classList?e.classList.add(t):e.className=stripClassName(e,t)+" "+t}function removeClass(e,t){void 0!==e.classList?e.classList.remove(t):e.className=stripClassName(e,t)}function setClass(e,t,n){(n?addClass:removeClass)(e,t)}function isObjectType(e,t){return"object"==typeof e&&null!==e&&(!Array.isArray(e)&&e.refValueType===t)}function isBoolean(e){return"boolean"==typeof e}function isNumber(e){return"number"==typeof e}function isString(e){return"string"==typeof e}function isDataRef(e){return isObjectType(e,"data")}function isDateRangeRef(e){return isObjectType(e,"daterange")}function isDateTimeRef(e){return isObjectType(e,"date")||isObjectType(e,"time")||isObjectType(e,"datetime")}function isFilesRef(e){return isObjectType(e,"files")}function isScanRef(e){return isObjectType(e,"scan")}function isGeometryRef(e){return isObjectType(e,"geometry")}function isItemsRef(e){return isObjectType(e,"items")}function isNumberRef(e){return isObjectType(e,"number")}function sanitizeGeometryRef(e){if(isGeometryRef(e)){var t=e.geometry;if(Array.isArray(t)&&0<t.length)switch(e.format){case"point":case"polygon":case"polyline":case"polygon-freehand":case"polyline-freehand":case"extent":case"line":return e}}}function createGeometryRef(e){return{refValueType:"geometry",format:e,geometry:[]}}function addStyleToDocument(e){const t=document.createElement("style");t.appendChild(document.createTextNode(e));const n=document.head;return n.insertBefore(t,n.firstChild),t}function throttle(r,s=DEFAULT_THROTTLE_DELAY){let o,a;return function(){const e=this,t=arguments;function n(){a=void 0,o=Date.now(),r.apply(e,t)}var i=Date.now();o&&i<o+s?(clearTimeout(a),a=setTimeout(n,s)):n()}}function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}export{text,makeId,sort,sortItems,makeSafeClassName,makeUniqueId,addClass,removeClass,setClass,isBoolean,isNumber,isString,isDataRef,isDateRangeRef,isDateTimeRef,isFilesRef,isScanRef,isGeometryRef,isItemsRef,isNumberRef,sanitizeGeometryRef,createGeometryRef,addStyleToDocument,throttle,isNumeric};
+import*as text from"./textUtilities.js";const DEFAULT_THROTTLE_DELAY=100;let next=0,seed=(new Date).valueOf();const guid="5DDC9A38-AAAB-44C1-AD87-415160F43D75";function makeId(){return 2147483648<=next&&(seed=(new Date).valueOf(),next=0),`${guid}:${seed}:${next++}`}function indexOf(e,t){if(null!=e){e=e.index;return"number"==typeof e?e:t}}function compareIndex(e,t){return compareNumber(e.index,t.index)}function compareNumber(e,t){return e<t?-1:t<e?1:0}function sort(e,t){void 0===t&&(t=indexOf);const n={};if("object"!=typeof e||null===e)return n;let i=0;const r=[];for(const o in e){var s=e[o],a=t(s,i++);"number"==typeof a&&r.push({key:o,index:a,item:s})}for(const u of r.sort(compareIndex))n[u.key]=u.item;return n}function sortItems(e){let t=e.current;var n=e.value,i=sort(e.items,function(e,t){if(null!=e&&!1!==e.visible){e=e.index;return"number"==typeof e?e:t}});if(void 0!==t&&null!==t&&void 0!==i[t]||(t=void 0),void 0===t&&null!=n)for(const r in i){if(i[r].value===n){t=r;break}t=void 0}return void 0!==t?(e.current=t,e.label=i[t].label,e.value=i[t].value):(e.current=void 0,e.label=void 0,e.value=void 0),i}function sortAndFilterItems(e){var t={...e},e=sortItems(t);return{current:t.current,items:e,label:t.label,value:t.value}}function stripClassName(e,t){return e.className.split(" ").filter(e=>0<e.length&&e!==t).join(" ")}function makeSafeClassName(e){return`gcx-forms-${e?.replace(/[\W]/g,"")||"element"}`}let idSuffix=0;function makeUniqueId(e){return`${makeSafeClassName(e)}-${++idSuffix}`}function addClass(e,t){void 0!==e.classList?e.classList.add(t):e.className=stripClassName(e,t)+" "+t}function removeClass(e,t){void 0!==e.classList?e.classList.remove(t):e.className=stripClassName(e,t)}function setClass(e,t,n){(n?addClass:removeClass)(e,t)}function isObjectType(e,t){return"object"==typeof e&&null!==e&&(!Array.isArray(e)&&e.refValueType===t)}function isBoolean(e){return"boolean"==typeof e}function isNumber(e){return"number"==typeof e}function isString(e){return"string"==typeof e}function isDataRef(e){return isObjectType(e,"data")}function isDateRangeRef(e){return isObjectType(e,"daterange")}function isDateTimeRef(e){return isObjectType(e,"date")||isObjectType(e,"time")||isObjectType(e,"datetime")}function isFilesRef(e){return isObjectType(e,"files")}function isScanRef(e){return isObjectType(e,"scan")}function isGeometryRef(e){return isObjectType(e,"geometry")}function isItemsRef(e){return isObjectType(e,"items")}function isNumberRef(e){return isObjectType(e,"number")}function sanitizeGeometryRef(e){if(isGeometryRef(e)){var t=e.geometry;if(Array.isArray(t)&&0<t.length)switch(e.format){case"point":case"polygon":case"polyline":case"polygon-freehand":case"polyline-freehand":case"extent":case"line":return e}}}function createGeometryRef(e){return{refValueType:"geometry",format:e,geometry:[]}}function throttle(r,s=DEFAULT_THROTTLE_DELAY){let a,o;return function(){const e=this,t=arguments;function n(){o=void 0,a=Date.now(),r.apply(e,t)}var i=Date.now();a&&i<a+s?(clearTimeout(o),o=setTimeout(n,s)):n()}}function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}function getElementProps(e,t){return{...t,element:t,name:e.props.name,enabled:!!t.enabled,setProperty:e.setProperty,setValue:e.setValue,raiseEvent:e.raiseEvent,value:t.value}}function getItemId(e,t){if(e)for(const n in t)if(t[n]===e)return n}export{text,makeId,sort,sortItems,sortAndFilterItems,makeSafeClassName,makeUniqueId,addClass,removeClass,setClass,isBoolean,isNumber,isString,isDataRef,isDateRangeRef,isDateTimeRef,isFilesRef,isScanRef,isGeometryRef,isItemsRef,isNumberRef,sanitizeGeometryRef,createGeometryRef,throttle,isNumeric,getElementProps,getItemId};

package/index.d.ts

@@ -1,2 +1,2 @@
 export type { IActivityHandler } from "./IActivityHandler";
-export * from "./forms/index";
+export type { FormElementProps, FormElementSettableProps, PropertyChangeEvent, FormElementRegistration, } from "./forms/index";

package/index.js

@@ -1 +0,0 @@
-export*from"./forms/index.js";

package/libs/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "5.33.1+4";
+export declare const VERSION = "5.35.0+38";

package/libs/version.js

@@ -1 +1 @@
-const VERSION="5.33.1+4";export{VERSION};
+const VERSION="5.35.0+38";export{VERSION};

package/package.json

@@ -1,26 +1,25 @@
 {
   "name": "@vertigis/workflow",
-  "version": "5.33.1",
+  "version": "5.35.0",
   "author": "VertiGIS",
   "dependencies": {
-    "@zxing/library": "^0.18.3",
+    "@zxing/library": "^0.20.0",
+    "autosuggest-highlight": "^3.3.4",
     "bluebird": "3.5.5",
+    "clsx": "^1.2.1",
     "date-fns": "^2.16.1",
-    "react-date-range": "^1.1.3",
-    "react-range": "^1.8.14",
-    "remarkable": "^2.0.1"
+    "react-signature-pad-wrapper": "^3.3.2"
   },
   "type": "module",
   "devDependencies": {
     "@arcgis/core": "^4.25.5",
     "@types/arcgis-js-api": "^4.24.0",
+    "@types/autosuggest-highlight": "^3.2.0",
     "@types/jest": "^29.2.3",
     "@types/react": "^17.0.53",
-    "@types/react-date-range": "1.1.7",
     "@types/react-dom": "^17.0.18",
-    "@types/remarkable": "^2.0.0",
     "@vertigis-internal/licensing": "^5.0.102865",
-    "@vertigis/react-ui": "11.21.2",
+    "@vertigis/react-ui": "11.32.0",
     "cross-env": "7.0.3",
     "jest": "29.3.1",
     "jest-environment-jsdom": "^29.3.1",
@@ -32,11 +31,12 @@
     "react-dom": "^17.0.2",
     "ts-jest": "^29.0.3",
     "tslib": "^2.3.1",
-    "typescript": "4.5.5"
+    "typescript": "4.5.5",
+    "typescript-strict-plugin": "^2.1.0"
   },
   "peerDependencies": {
     "@arcgis/core": ">= 4.24.0  < 5.0.0",
-    "@vertigis/react-ui": ">= 11 < 12",
+    "@vertigis/react-ui": ">= 11.26 < 12",
     "react": ">= 17 < 19",
     "react-dom": ">= 17 < 19"
   },

package/app/ActivityPackUtils.d.ts

@@ -1,10 +0,0 @@
-/**
- * This method allows an activity pack author to register a library
- * to be used by their code.
- * @param mapEntries An object defining paths to modules for names of libraries.
- * @param modulePrefix The prefix for the activity pack, as provided by runtime.
- * @param libraryPath (Optional) The path to a library within the activity pack.
- * This can be used when a particular set of entries only apply to a subset of
- * the activity pack.
- */
-export declare function mapDependencies(mapEntries: any, modulePrefix: string, libraryPath?: string): void;

package/app/ActivityPackUtils.js

@@ -1 +0,0 @@
-import{global}from"../execution/ModuleLoader.js";function mapDependencies(o,e,t){let i=e;"/"===i[i.length-1]&&(i=i.substring(0,i.length-1));var r=i;t&&(i=`${i}/${t}`);let n=global.require.map[i];if(!n){n={};var s=global.require.map["@vertigis/workflow"];for(const l in s)n[l]=s[l]}for(const p in o){let e=o[p];"string"==typeof e&&("./"===e.substring(0,2)?e=`${r}${e.substring(1)}`:"/"===e.substring(0,1)?e=`${r}${e}`:"@"!==e.substring(0,1)&&(e=`${r}/${e}`),n[p]=e)}const a={map:{}};a.map[i]=n,global.require(a)}console.warn("The @vertigis/workflow/app/ActivityPackUtils module is deprecated and will be removed in Workflow 5.35. Upgrade your activity pack to the new SDK before August 2023 for continued operation. More details: https://community.vertigis.com/hc/en-us/community/posts/11043551431698");export{mapDependencies};