@vertigis/workflow 5.36.0 → 5.37.1

package/forms/numberFormatter.d.ts

@@ -1,94 +1,90 @@
-export { isNumeric } from "./utils";
-/**
- * Pre-defined format specifiers for use with format().
- */
-export declare enum NumberDisplayFormat {
-    /**
-     * A localized representation of a number with a decimal separator and group
-     * separators (e.g. "12,345.67", "-42" for en-US locale).
-     */
-    NUMBER = "n",
-    /**
-     * A localized representation of a number with a decimal separator (e.g.
-     * "12345.67", "-42" for en-US locale).
-     */
-    FIXED_POINT = "f",
-    /**
-     * A localized representation of a monetary amount in a specific currency
-     * (e.g. "$123.45" for USD, "£123.45" for GBP for en-US locale).
-     */
-    CURRENCY = "c",
-    /**
-     * Same as CURRENCY, except that in many locales, negative values may be displayed in
-     * parentheses instead of using a "-" sign.
-     */
-    ACCOUNTING = "a",
-    /**
-     * A localized representation of a percentage (e.g. 0.99 -\> "99%" in the
-     * en-US locale).
-     */
-    PERCENT = "p",
-    /**
-     * An invariant representation of a number (e.g. "12345.67"). Guarantees
-     * that the number can be parsed back into the same number, regardless of
-     * locale.
-     */
-    ROUND_TRIP = "r",
-    /**
-     * The default representation for number values (equivalent to NUMBER).
-     */
-    DEFAULT = "n",
-    /**
-     * A custom format string.
-     */
-    CUSTOM = "custom"
-}
-/**
- * Options supported by {@link format}.
- */
-export interface FormatOptions {
-    /**
-     * The locale to use when formatting the number.
-     */
-    locale: string;
-    /**
-     * The number format. See {@link NumberFormatter.format}.
-     */
-    format?: NumberDisplayFormat;
-    /**
-     * See NumberFormat.currency.
-     */
-    currency?: string;
-    /**
-     * The custom number format. Required for a format type of 'Custom'
-     */
-    customDisplayFormat?: string;
-    /**
-     * See NumberFormat.precision.
-     */
-    fractionalDigits?: number;
-}
-export declare const DEFAULT_CURRENCY = "USD";
-export declare const DEFAULT_CUSTOM_FORMAT = "#.##";
-export declare const DEFAULT_FRACTIONAL_DIGITS = 4;
-export declare const SUPPORTED_CURRENCIES: string[];
-/**
- * Formats a number for display in the current locale.
- *
- * @param num The number to format.
- */
-export declare function format(num: number): string;
-/**
- * Formats a number for display.
- *
- * @param format See {@link NumberFormatter.format}.
- * @param num The number to format.
- */
-export declare function format(format: string, num: number): string;
-/**
- * Formats a number for display.
- *
- * @param options Specifies the format settings to use.
- * @param num The number to format.
- */
-export declare function format(options: FormatOptions, num: number): string;
+export { isNumeric } from "./utils";
+/**
+ * Pre-defined format specifiers for use with format().
+ */
+export declare enum NumberDisplayFormat {
+    /**
+     * A localized representation of a number with a decimal separator and group
+     * separators (e.g. "12,345.67", "-42" for en-US locale).
+     */
+    NUMBER = "n",
+    /**
+     * A localized representation of a number with a decimal separator (e.g.
+     * "12345.67", "-42" for en-US locale).
+     */
+    FIXED_POINT = "f",
+    /**
+     * A localized representation of a monetary amount in a specific currency
+     * (e.g. "$123.45" for USD, "£123.45" for GBP for en-US locale).
+     */
+    CURRENCY = "c",
+    /**
+     * Same as CURRENCY, except that in many locales, negative values may be displayed in
+     * parentheses instead of using a "-" sign.
+     */
+    ACCOUNTING = "a",
+    /**
+     * A localized representation of a percentage (e.g. 0.99 -\> "99%" in the
+     * en-US locale).
+     */
+    PERCENT = "p",
+    /**
+     * An invariant representation of a number (e.g. "12345.67"). Guarantees
+     * that the number can be parsed back into the same number, regardless of
+     * locale.
+     */
+    ROUND_TRIP = "r",
+    /**
+     * A custom format string.
+     */
+    CUSTOM = "custom"
+}
+/**
+ * Options supported by {@link format}.
+ */
+export interface FormatOptions {
+    /**
+     * The locale to use when formatting the number.
+     */
+    locale: string;
+    /**
+     * The number format. See {@link NumberFormatter.format}.
+     */
+    format?: NumberDisplayFormat;
+    /**
+     * See NumberFormat.currency.
+     */
+    currency?: string;
+    /**
+     * The custom number format. Required for a format type of 'Custom'
+     */
+    customDisplayFormat?: string;
+    /**
+     * See NumberFormat.precision.
+     */
+    fractionalDigits?: number;
+}
+export declare const DEFAULT_CURRENCY = "USD";
+export declare const DEFAULT_CUSTOM_FORMAT = "#.##";
+export declare const DEFAULT_FRACTIONAL_DIGITS = 4;
+export declare const SUPPORTED_CURRENCIES: string[];
+/**
+ * Formats a number for display in the current locale.
+ *
+ * @param num The number to format.
+ */
+export declare function format(num: number): string;
+/**
+ * Formats a number for display.
+ *
+ * @param format See {@link NumberFormatter.format}.
+ * @param num The number to format.
+ */
+export declare function format(format: string, num: number): string;
+/**
+ * Formats a number for display.
+ *
+ * @param options Specifies the format settings to use.
+ * @param num The number to format.
+ */
+export declare function format(options: FormatOptions, num: number): string;

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={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};
+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.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.NUMBER;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 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};

package/forms/numberUtilities.d.ts

@@ -1,150 +1,150 @@
-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 custom format string and returns the result.
- * The supplied value is treated as one of Microsoft's [Custom numeric format strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings)
- *
- * There are lots of unusual ways you can combine the supported characters, but for simplicity, we support the most common use case
- * which is using `#` and numeric characters as placeholders.
- * @param customFormat The custom format to be inspected.
- * @returns The number of decimal places in `customFormat`.
- */
-export declare function countDecimalsInCustomFormat(customFormat: string | undefined): number;
-/**
- * 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 countDecimalsInValue(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 elementValue The current value of a Form Element.
- * @param newValue A new value for the Form Element.
- * @returns True if the element's current value and the new value are equal, false otherwise.
- */
-export declare function areValuesEqual(elementValue: defs.Value | undefined, newValue: 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[];
-/**
- * Rounds a value to the specified number of decimals in a way that should avoid rounding errors.
- * This is based on an example found here:
- * https://medium.com/swlh/how-to-round-to-a-certain-number-of-decimal-places-in-javascript-ed74c471c1b8
- * @param value The value to be rounded.
- * @param decimalPlaces The number of decimal places to round to.
- * @returns An accurately rounded value.
- */
-export declare function roundAccurately(value: number, decimalPlaces: number): number;
-/**
- * Details about a symbol that is used to represent currency or percentage.
- */
-declare type SymbolInfo = {
-    /**
-     * Whether the symbol should appear at the start (before the value) or end (after it).
-     */
-    position: "start" | "end";
-    /**
-     * The symbol to displayed.
-     */
-    symbol: string;
-    symbolCount?: number;
-    integerCount?: number;
-};
-export declare function getCurrencySymbolInfo(locale: string, currency: string): SymbolInfo;
-export declare function getPercentSymbolInfo(locale: string): SymbolInfo;
-export {};
+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 custom format string and returns the result.
+ * The supplied value is treated as one of Microsoft's [Custom numeric format strings](https://learn.microsoft.com/en-us/dotnet/standard/base-types/custom-numeric-format-strings)
+ *
+ * There are lots of unusual ways you can combine the supported characters, but for simplicity, we support the most common use case
+ * which is using `#` and numeric characters as placeholders.
+ * @param customFormat The custom format to be inspected.
+ * @returns The number of decimal places in `customFormat`.
+ */
+export declare function countDecimalsInCustomFormat(customFormat: string | undefined): number;
+/**
+ * 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 countDecimalsInValue(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 elementValue The current value of a Form Element.
+ * @param newValue A new value for the Form Element.
+ * @returns True if the element's current value and the new value are equal, false otherwise.
+ */
+export declare function areValuesEqual(elementValue: defs.Value | undefined, newValue: 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[];
+/**
+ * Rounds a value to the specified number of decimals in a way that should avoid rounding errors.
+ * This is based on an example found here:
+ * https://medium.com/swlh/how-to-round-to-a-certain-number-of-decimal-places-in-javascript-ed74c471c1b8
+ * @param value The value to be rounded.
+ * @param decimalPlaces The number of decimal places to round to.
+ * @returns An accurately rounded value.
+ */
+export declare function roundAccurately(value: number, decimalPlaces: number): number;
+/**
+ * Details about a symbol that is used to represent currency or percentage.
+ */
+type SymbolInfo = {
+    /**
+     * Whether the symbol should appear at the start (before the value) or end (after it).
+     */
+    position: "start" | "end";
+    /**
+     * The symbol to displayed.
+     */
+    symbol: string;
+    symbolCount?: number;
+    integerCount?: number;
+};
+export declare function getCurrencySymbolInfo(locale: string, currency: string): SymbolInfo | undefined;
+export declare function getPercentSymbolInfo(locale: string): SymbolInfo | undefined;
+export {};

package/forms/numberUtilities.js

@@ -1 +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:t,upperBound:n}=e=e||{};let{precision:i,step:u}=e;var o,r=getNumberFormatConfiguration(r);let a=isNumeric(t)?t:r.lowerBound.default,m=isNumeric(n)?n:r.upperBound.default;return void 0!==m&&void 0!==a&&m<=a&&(a=r.lowerBound.default,m=r.upperBound.default),i="number"!=typeof i||Number.isNaN(i)?r.precision.default:i,void 0!==r.precision.minimum&&(i=Math.max(i,r.precision.minimum)),void 0!==r.precision.maximum&&(i=Math.min(i,r.precision.maximum)),i<0?(o=Math.pow(10,-1*i),void 0!==u&&u%o==0||(u=o)):(u=isNumeric(u)&&0<u?u:r.step.default,void 0!==m&&void 0!==a&&(u=Math.min(u,m-a),o=(m-a)/u,Number.isInteger(o)||(r=countDecimalsInValue(u),m=roundAccurately(a+Math.floor(o)*u,r)))),{maximum:m,minimum:a,step:u}}const intlNumberFormat=new Intl.NumberFormat("en-US",{minimumFractionDigits:0,maximumFractionDigits:20,useGrouping:!1}),customDecimals=/\.([#\d]+)/;function countDecimalsInCustomFormat(e){if(e){e=customDecimals.exec(e);if(e)return e[1].length}return 0}function countDecimalsInValue(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,t){t=getNumberFormatConfiguration(t);void 0===e&&(e=t.precision.default);r=countDecimalsInValue(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 t in e)r[t]=Object.assign(r[t],e[t]);return r}function enforceConstraints(e,r){var t,n,{maximum:i,minimum:u,step:r}=r;return void 0!==u?(t=(e-u)/r,Number.isInteger(t)||(n=countDecimalsInValue(r),e=roundAccurately(u+Math.round(t)*r,n))):void 0!==i&&(t=(i-e)/r,Number.isInteger(t)||(n=countDecimalsInValue(r),e=roundAccurately(i-Math.round(t)*r,n))),void 0!==u&&e<u&&(e=u),e=void 0!==i&&i<e?i:e}function getNumberSliderValues(e,r,t=!1){let n=[],i=NaN,u=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?i=e:"number"==typeof e?.numeric&&(i=e.numeric);if(Array.isArray(e)&&1<=e.length&&(i=e[0],u=e[1]),void 0===i||isNaN(i)||(i=enforceConstraints(i,r),void 0===u||isNaN(u)?t&&n.push(i):(u=enforceConstraints(u,r),n.push(i,u))),n=n.sort((e,r)=>e-r),n.length===(t?1:2))return n;var o=r.maximum,e=r.minimum;return t?[enforceConstraints((e+o)/2,r)]:[e,o]}function areValuesEqual(e,r){if(void 0===e&&void 0===r||null===e&&null===r)return!0;var t,n;return!(!isNumberRef(e)||!isNumberRef(r))&&(e.display===r.display&&e.refValueType===r.refValueType&&e.numeric===r.numeric&&(t=e.format,n=r.format,void 0===t&&void 0===n||void 0!==t&&void 0!==n&&(t.currency===n.currency&&t.customDisplayFormat===n.customDisplayFormat&&t.displayFormat===n.displayFormat&&t.lowerBound===n.lowerBound&&t.precision===n.precision&&t.step===n.step&&t.upperBound===n.upperBound)))}function getMarks(r,t,n,e,i,u){if(i&&u){const o=[{value:t,label:format(e,t)}];for(let e=t+n;e<r;e+=n)o.push({value:e});return o.push({value:r,label:format(e,r)}),o}return i&&!u?[{value:t,label:format(e,t)},{value:r,label:format(e,r)}]:u}function roundAccurately(e,r){return Number(Math.round(Number(e+`e${r}`))+`e-${r}`)}function getCurrencySymbolInfo(e,r){const t=new Intl.NumberFormat(e,{style:"currency",currency:r,minimumFractionDigits:0,maximumFractionDigits:0,useGrouping:!1}),n=t.formatToParts(0);e=n.filter(e=>"currency"===e.type)[0],r=n.filter(e=>"integer"===e.type)[0];if(e&&r)return{position:n.indexOf(e)<n.indexOf(r)?"start":"end",symbol:e.value}}function getPercentSymbolInfo(e){const r=new Intl.NumberFormat(e,{style:"percent",minimumFractionDigits:0,maximumFractionDigits:0,useGrouping:!1}),t=r.formatToParts(0);var n=t.filter(e=>"percentSign"===e.type)[0],e=t.filter(e=>"integer"===e.type)[0];if(n&&e)return{position:t.indexOf(n)<t.indexOf(e)?"start":"end",symbol:n.value}}export{defaultNumberFormatConfiguration,getNumberConstraints,countDecimalsInCustomFormat,countDecimalsInValue,sanitizePrecision,getNumberFormatConfiguration,enforceConstraints,getNumberSliderValues,areValuesEqual,getMarks,roundAccurately,getCurrencySymbolInfo,getPercentSymbolInfo};
+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:t,upperBound:n}=e=e||{};let{precision:i,step:u}=e;var o,r=getNumberFormatConfiguration(r);let a=isNumeric(t)?t:r.lowerBound.default,m=isNumeric(n)?n:r.upperBound.default;return void 0!==m&&void 0!==a&&m<=a&&(a=r.lowerBound.default,m=r.upperBound.default),i="number"!=typeof i||Number.isNaN(i)?r.precision.default:i,void 0!==r.precision.minimum&&(i=Math.max(i,r.precision.minimum)),void 0!==r.precision.maximum&&(i=Math.min(i,r.precision.maximum)),i<0?(o=Math.pow(10,-1*i),void 0!==u&&u%o==0||(u=o)):(u=isNumeric(u)&&0<u?u:r.step.default,void 0!==m&&void 0!==a&&(u=Math.min(u,m-a),o=(m-a)/u,Number.isInteger(o)||(r=countDecimalsInValue(u),m=roundAccurately(a+Math.floor(o)*u,r)))),{maximum:m,minimum:a,step:u}}const intlNumberFormat=new Intl.NumberFormat("en-US",{minimumFractionDigits:0,maximumFractionDigits:20,useGrouping:!1}),customDecimals=/\.([#\d]+)/;function countDecimalsInCustomFormat(e){if(e){e=customDecimals.exec(e);if(e)return e[1].length}return 0}function countDecimalsInValue(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,t){t=getNumberFormatConfiguration(t);void 0===e&&(e=t.precision.default);r=countDecimalsInValue(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 t in e)r[t]=Object.assign(r[t]||{},e[t]);return r}function enforceConstraints(e,r){var t,n,{maximum:i,minimum:u,step:r}=r;return void 0!==u?(t=(e-u)/r,Number.isInteger(t)||(n=countDecimalsInValue(r),e=roundAccurately(u+Math.round(t)*r,n))):void 0!==i&&(t=(i-e)/r,Number.isInteger(t)||(n=countDecimalsInValue(r),e=roundAccurately(i-Math.round(t)*r,n))),void 0!==u&&e<u&&(e=u),e=void 0!==i&&i<e?i:e}function getNumberSliderValues(e,r,t=!1){let n=[],i=NaN,u=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?i=e:"number"==typeof e?.numeric&&(i=e.numeric);if(Array.isArray(e)&&1<=e.length&&(i=e[0],u=e[1]),void 0===i||isNaN(i)||(i=enforceConstraints(i,r),void 0===u||isNaN(u)?t&&n.push(i):(u=enforceConstraints(u,r),n.push(i,u))),n=n.sort((e,r)=>e-r),n.length===(t?1:2))return n;var o=r.maximum,e=r.minimum;return t?[enforceConstraints((e+o)/2,r)]:[e,o]}function areValuesEqual(e,r){if(void 0===e&&void 0===r||null===e&&null===r)return!0;var t,n;return!(!isNumberRef(e)||!isNumberRef(r))&&(e.display===r.display&&e.refValueType===r.refValueType&&e.numeric===r.numeric&&(t=e.format,n=r.format,void 0===t&&void 0===n||void 0!==t&&void 0!==n&&(t.currency===n.currency&&t.customDisplayFormat===n.customDisplayFormat&&t.displayFormat===n.displayFormat&&t.lowerBound===n.lowerBound&&t.precision===n.precision&&t.step===n.step&&t.upperBound===n.upperBound)))}function getMarks(r,t,n,e,i,u){if(i&&u){const o=[{value:t,label:format(e,t)}];for(let e=t+n;e<r;e+=n)o.push({value:e});return o.push({value:r,label:format(e,r)}),o}return i&&!u?[{value:t,label:format(e,t)},{value:r,label:format(e,r)}]:u}function roundAccurately(e,r){return Number(Math.round(Number(e+`e${r}`))+`e-${r}`)}function getCurrencySymbolInfo(e,r){const t=new Intl.NumberFormat(e,{style:"currency",currency:r,minimumFractionDigits:0,maximumFractionDigits:0,useGrouping:!1}),n=t.formatToParts(0);e=n.filter(e=>"currency"===e.type)[0],r=n.filter(e=>"integer"===e.type)[0];if(e&&r)return{position:n.indexOf(e)<n.indexOf(r)?"start":"end",symbol:e.value}}function getPercentSymbolInfo(e){const r=new Intl.NumberFormat(e,{style:"percent",minimumFractionDigits:0,maximumFractionDigits:0,useGrouping:!1}),t=r.formatToParts(0);var n=t.filter(e=>"percentSign"===e.type)[0],e=t.filter(e=>"integer"===e.type)[0];if(n&&e)return{position:t.indexOf(n)<t.indexOf(e)?"start":"end",symbol:n.value}}export{defaultNumberFormatConfiguration,getNumberConstraints,countDecimalsInCustomFormat,countDecimalsInValue,sanitizePrecision,getNumberFormatConfiguration,enforceConstraints,getNumberSliderValues,areValuesEqual,getMarks,roundAccurately,getCurrencySymbolInfo,getPercentSymbolInfo};

package/forms/presenter.d.ts

@@ -1,21 +1,21 @@
-import { FormPresenterHost } from "./FormComponent";
-export declare function refresh(component: {}): void;
-/**
- * Refreshes an element.
- * @param host The host for the presenter.
- * @param name The name of the element to refresh.
- */
-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;
-/** Renders a component's visual. */
-export declare function render(component: {}): any;
-/**
- * Renders an element with a placeholder.
- * @param owner
- */
-export declare function renderNone(component: {}): any;
+import { FormPresenterHost } from "./FormComponent";
+export declare function refresh(component: {}): void;
+/**
+ * Refreshes an element.
+ * @param host The host for the presenter.
+ * @param name The name of the element to refresh.
+ */
+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;
+/** Renders a component's visual. */
+export declare function render(component: {}): any;
+/**
+ * Renders an element with a placeholder.
+ * @param owner
+ */
+export declare function renderNone(component: {}): any;

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 Custom from"./components/Custom.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:e.elementRegistration?createElement(e.elementRegistration.component,getElementProps(e,r)):n===FormElementTypes.CUSTOM?createElement(Custom,getElementProps(e,r)):renderElement(n,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 Custom from"./components/Custom.js";import{FormComponentTypes,FormElementTypes}from"./constants.js";import{renderComponent,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",children:[]}),r)}function releaseForm(e){unmountComponentAtNode(e)}function render(e){if(e instanceof FormComponent){var r=e.props.type;if(r!==FormComponentTypes.ELEMENT&&r!==FormComponentTypes.SECTION)return renderComponent(e);var n=e.prepare();if(null==n)return;r=n.type;if("string"!=typeof r)return;if(r===FormElementTypes.CUSTOM)return createElement(Custom,getElementProps(e,n));if(e.elementRegistration)return createElement(e.elementRegistration.component,getElementProps(e,n))}}function renderNone(e){if(e instanceof FormComponent)return renderers_renderNone(e)}export{refresh,refreshForm,releaseForm,render,renderNone};

package/forms/renderers.d.ts

@@ -1,8 +1,5 @@
-/// <reference types="react" />
-import { FormComponent } from "./FormComponent";
-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;
-/** @product This is intended for internal use only within VertiGIS Studio products. */
-export declare function renderElement(type: string, component: FormComponent, element: Element): JSX.Element;
+/// <reference types="react" />
+import { FormComponent } from "./FormComponent";
+/** @product This is intended for internal use only within VertiGIS Studio products. */
+export declare function renderComponent(component: FormComponent): JSX.Element | null;
+export declare function renderNone(component: FormComponent): any;