feat(kit): new maskitoStringifyNumber helper (#1987)

Author: ggomarighetti

projects/kit/src/index.ts

@@ -6,7 +6,12 @@ export {
 } from './lib/masks/date';
 export {maskitoDateRangeOptionsGenerator} from './lib/masks/date-range';
 export {maskitoDateTimeOptionsGenerator} from './lib/masks/date-time';
-export {maskitoNumberOptionsGenerator, maskitoParseNumber} from './lib/masks/number';
+export {
+    maskitoNumberOptionsGenerator,
+    type MaskitoNumberParams,
+    maskitoParseNumber,
+    maskitoStringifyNumber,
+} from './lib/masks/number';
 export {
     maskitoParseTime,
     maskitoStringifyTime,

projects/kit/src/lib/masks/number/index.ts

@@ -1,2 +1,3 @@
 export {maskitoNumberOptionsGenerator} from './number-mask';
-export {maskitoParseNumber} from './utils';
+export type {MaskitoNumberParams} from './number-params';
+export {maskitoParseNumber, maskitoStringifyNumber} from './utils';

projects/kit/src/lib/masks/number/number-mask.ts

@@ -15,6 +15,7 @@ import {
     maskitoPostfixPostprocessorGenerator,
     maskitoPrefixPostprocessorGenerator,
 } from '../../processors';
+import type {MaskitoNumberParams} from './number-params';
 import {
     createLeadingZeroesValidationPlugin,
     createMinMaxPlugin,
@@ -46,18 +47,7 @@ export function maskitoNumberOptionsGenerator({
     prefix: unsafePrefix = '',
     postfix = '',
     minusSign = CHAR_MINUS,
-}: {
-    min?: number;
-    max?: number;
-    precision?: number;
-    decimalSeparator?: string;
-    decimalPseudoSeparators?: string[]; // TODO v4: => readonly string[]
-    decimalZeroPadding?: boolean;
-    thousandSeparator?: string;
-    prefix?: string;
-    postfix?: string;
-    minusSign?: string;
-} = {}): Required<MaskitoOptions> {
+}: MaskitoNumberParams = {}): Required<MaskitoOptions> {
     const pseudoMinuses = [
         CHAR_HYPHEN,
         CHAR_EN_DASH,

projects/kit/src/lib/masks/number/number-params.ts

@@ -0,0 +1,12 @@
+export interface MaskitoNumberParams {
+    min?: number;
+    max?: number;
+    precision?: number;
+    decimalSeparator?: string;
+    decimalPseudoSeparators?: string[]; // TODO v4: => readonly string[]
+    decimalZeroPadding?: boolean;
+    thousandSeparator?: string;
+    prefix?: string;
+    postfix?: string;
+    minusSign?: string;
+}

projects/kit/src/lib/masks/number/utils/index.ts

@@ -1,5 +1,6 @@
 export * from './generate-mask-expression';
 export * from './parse-number';
+export * from './stringify-number';
 export * from './stringify-number-without-exp';
 export * from './to-number-parts';
 export * from './validate-decimal-pseudo-separators';

projects/kit/src/lib/masks/number/utils/stringify-number.ts

@@ -0,0 +1,24 @@
+import {maskitoTransform} from '@maskito/core';
+
+import {clamp} from '../../../utils';
+import {maskitoNumberOptionsGenerator} from '../number-mask';
+import type {MaskitoNumberParams} from '../number-params';
+
+export function maskitoStringifyNumber(
+    number: number,
+    params: MaskitoNumberParams,
+): string {
+    if (Number.isNaN(number) || number === null) {
+        return '';
+    }
+
+    const {
+        min = Number.MIN_SAFE_INTEGER,
+        max = Number.MAX_SAFE_INTEGER,
+        decimalSeparator = '.',
+    } = params;
+
+    const value = clamp(number, min, max).toString().replace('.', decimalSeparator);
+
+    return maskitoTransform(value, maskitoNumberOptionsGenerator(params));
+}