@vertigis/workflow 5.35.1 → 5.37.0

package/forms/numberUtilities.d.ts

@@ -1,113 +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 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[];
+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: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};
+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{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};
+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;

package/forms/renderers.js

@@ -1 +1 @@
-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};
+import Box from"@vertigis/react-ui/Box";import*as React from"react";import AccordionGroup from"./components/AccordionGroup.js";import Form,{formClasses}from"./components/Form.js";import{FormComponentTypes}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.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,r){return React.createElement(Box,{className:r},e)}export{renderComponent,renderNone};

package/forms/textUtilities.d.ts

@@ -1,23 +1,33 @@
-import { markdownToSafeHtml } from "@vertigis/react-ui/utils/markdown";
-import * as defs from "./FormDefinition";
-/**
- * Ensures the supplied string can be rendered literally in markdown by
- * escaping any characters that have special meaning in
- * markdown syntax.
- *
- * This method assumes that we are using a markdown parser that complies
- * with the commonmark specification. (http://commonmark.org/)
- * As such, the only escaping performed is that which is necessary for
- * the features suppored by commonmark.
- *
- * You can test commonmark behaviour here: http://spec.commonmark.org/dingus/
- *
- * @param literalString A string to be treated literally in markdown.
- */
-export declare function escapeTextForMarkdown(literalString: string): 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 };
+import { markdownToSafeHtml } from "@vertigis/react-ui/utils/markdown";
+import * as defs from "./FormDefinition";
+/**
+ * Ensures the supplied string can be rendered literally in markdown by
+ * escaping any characters that have special meaning in
+ * markdown syntax.
+ *
+ * This method assumes that we are using a markdown parser that complies
+ * with the commonmark specification. (http://commonmark.org/)
+ * As such, the only escaping performed is that which is necessary for
+ * the features suppored by commonmark.
+ *
+ * You can test commonmark behaviour here: http://spec.commonmark.org/dingus/
+ *
+ * @param literalString A string to be treated literally in markdown.
+ */
+export declare function escapeTextForMarkdown(literalString: string): string;
+/**
+ * Returns the underlying content from a `defs.Text` input.
+ * This function does not perform any translation or markdown rendering.
+ * Its sole purpose is to expose the string from inside the relevant object,
+ * or return the input itself if it's already a string or undefined.
+ * @param text The text to extract content from.
+ * @returns
+ */
+export declare function getContent(text: defs.Text | undefined): string | undefined;
+export declare function hasContent(text: defs.Text | undefined): text is defs.Text;
+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 isInvalidError(text: (Partial<defs.StatusRef> & defs.Text) | undefined | null): boolean;
+export declare function markdownToText(markdown: string): string;
+export declare function textToHtml(text: string): string;
+export { markdownToSafeHtml };

package/forms/textUtilities.js

@@ -1 +1 @@
-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};
+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 getContent(t){return isMarkdown(t)?t.markdown:isStatus(t)?t.status:t}function hasContent(t){return!!getContent(t)}function isMarkdown(t){return null!=t&&"string"==typeof t.markdown}function isStatus(t){return null!=t&&"string"==typeof t.status}function isInvalidError(t){return isStatus(t)&&"invalid"===t.status}function markdownToText(t){return textContent.innerHTML=markdownToSafeHtml(t),textContent.innerText}function textToHtml(t){return textNode.data=t,htmlContent.innerHTML}export{escapeTextForMarkdown,getContent,hasContent,isMarkdown,isStatus,isInvalidError,markdownToText,textToHtml,markdownToSafeHtml};