Add decimal validation function

Author: fabian-hiller

library/CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to the library will be documented in this file.
 
 ## vX.X.X (Month DD, YYYY)
 
-- Add `creditCard`, `hash`, `hexadecimal`, `hexColor` and `octal` validation function (pull request #292, #304, #307, #308, #309)
+- Add `creditCard`, `decimal`, `hash`, `hexadecimal`, `hexColor` and `octal` validation function (pull request #292, #304, #307, #308, #309)
 
 ## v0.24.1 (December 11, 2023)
 

library/src/regex.ts

@@ -8,6 +8,11 @@ export const BIC_REGEX = /^[A-Z]{6}(?!00)[A-Z\d]{2}(?:[A-Z\d]{3})?$/u;
  */
 export const CUID2_REGEX = /^[a-z][\da-z]*$/u;
 
+/**
+ * [Decimal](https://en.wikipedia.org/wiki/Decimal) regex.
+ */
+export const DECIMAL_REGEX = /^\d+$/u;
+
 /**
  * Email regex.
  */

library/src/validations/decimal/decimal.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, test } from 'vitest';
+import { decimal } from './decimal.ts';
+
+describe('decimal', () => {
+  test('should pass only decimal strings', () => {
+    const validate = decimal();
+
+    const value1 = '0';
+    expect(validate._parse(value1).output).toBe(value1);
+    const value2 = '9';
+    expect(validate._parse(value2).output).toBe(value2);
+    const value3 = '123456789';
+    expect(validate._parse(value3).output).toBe(value3);
+
+    expect(validate._parse('').issues).toBeTruthy();
+    expect(validate._parse('0a').issues).toBeTruthy();
+    expect(validate._parse('0 0').issues).toBeTruthy();
+    expect(validate._parse('12345f').issues).toBeTruthy();
+    expect(validate._parse('#FFAABB').issues).toBeTruthy();
+    expect(validate._parse('XYZ123').issues).toBeTruthy();
+    expect(validate._parse('hello!').issues).toBeTruthy();
+    expect(validate._parse('11 22 33').issues).toBeTruthy();
+    expect(validate._parse('7G5H').issues).toBeTruthy();
+    expect(validate._parse('!@#$%^').issues).toBeTruthy();
+    expect(validate._parse('abc123xyz').issues).toBeTruthy();
+  });
+
+  test('should return custom error message', () => {
+    const error = 'Value is not decimal string!';
+    const validate = decimal(error);
+    expect(validate._parse('1G').issues?.[0].message).toBe(error);
+  });
+});

library/src/validations/decimal/decimal.ts

@@ -0,0 +1,41 @@
+import { DECIMAL_REGEX } from '../../regex.ts';
+import type { BaseValidation, ErrorMessage } from '../../types/index.ts';
+import { actionIssue, actionOutput } from '../../utils/index.ts';
+
+/**
+ * Decimal validation type.
+ */
+export type DecimalValidation<TInput extends string> =
+  BaseValidation<TInput> & {
+    /**
+     * The validation type.
+     */
+    type: 'decimal';
+    /**
+     * The decimal regex.
+     */
+    requirement: RegExp;
+  };
+
+/**
+ * Creates a validation function that validates a decimal string.
+ *
+ * @param message The error message.
+ *
+ * @returns A validation function.
+ */
+export function decimal<TInput extends string>(
+  message: ErrorMessage = 'Invalid decimal'
+): DecimalValidation<TInput> {
+  return {
+    type: 'decimal',
+    async: false,
+    message,
+    requirement: DECIMAL_REGEX,
+    _parse(input) {
+      return !this.requirement.test(input)
+        ? actionIssue(this.type, this.message, input, this.requirement)
+        : actionOutput(input);
+    },
+  };
+}

library/src/validations/decimal/index.ts

@@ -0,0 +1 @@
+export * from './decimal.ts';

library/src/validations/index.ts

@@ -3,6 +3,7 @@ export * from './bytes/index.ts';
 export * from './creditCard/index.ts';
 export * from './cuid2/index.ts';
 export * from './custom/index.ts';
+export * from './decimal/index.ts';
 export * from './email/index.ts';
 export * from './emoji/index.ts';
 export * from './endsWith/index.ts';

website/src/routes/api/(schemas)/any/index.mdx

@@ -72,6 +72,7 @@ The following APIs can be combined with `any`.
     'creditCard',
     'cuid2',
     'custom',
+    'decimal',
     'email',
     'emoji',
     'endsWith',

website/src/routes/api/(schemas)/string/index.mdx

@@ -119,6 +119,7 @@ The following APIs can be combined with `string`.
     'creditCard',
     'cuid2',
     'custom',
+    'decimal',
     'email',
     'emoji',
     'endsWith',

website/src/routes/api/(validations)/decimal/index.mdx

@@ -0,0 +1,9 @@
+---
+title: decimal
+contributors:
+  - fabian-hiller
+---
+
+# decimal
+
+> The content of this page is not yet ready. Until then just use the [source code](https://github.com/fabian-hiller/valibot/blob/main/library/src/validations/decimal/decimal.ts).

website/src/routes/api/menu.md

@@ -67,6 +67,7 @@
 - [creditCard](/api/creditCard/)
 - [cuid2](/api/cuid2/)
 - [custom](/api/custom/)
+- [decimal](/api/decimal/)
 - [email](/api/email/)
 - [emoji](/api/emoji/)
 - [endsWith](/api/endsWith/)

website/src/routes/guides/(main-concepts)/pipelines/index.mdx

@@ -48,6 +48,7 @@ Validation functions examine the input and, if the input does not meet a certain
     'creditCard',
     'cuid2',
     'custom',
+    'decimal',
     'email',
     'emoji',
     'endsWith',