feat: add Contains decorator (#210)

Author: yuchem2

README.ko.md

@@ -29,6 +29,13 @@ Validates that a number is within the specified range, inclusive of the minimum
 - **`min`**: The minimum allowed value.
 - **`max`**: The maximum allowed value.
 
+### `@Contains(seed: string)`
+
+Validates that the string contains the specified substring.
+
+- **`seed`**: The substring that must be present in the string.
+- **`message`** (optional): The error message to display when validation fails. If omitted, a default message will be used.
+
 ### `@Prefix(value: string)`
 
 Validates that a string starts with the specified prefix.

README.md

@@ -29,6 +29,13 @@ Validiert, dass eine Zahl innerhalb des angegebenen Bereichs liegt, einschließl
 - **`min`**: Der zulässige Mindestwert.
 - **`max`**: Der zulässige Höchstwert.
 
+### `@Contains(seed: string)`
+
+Validiert, dass ein String den angegebenen Teilstring enthält.
+
+- **`seed`**: Der Teilstring, der im String enthalten sein muss.
+- **`message`** (optional): Die Fehlermeldung, die bei fehlgeschlagener Validierung angezeigt wird. Wenn nicht angegeben, wird eine Standardmeldung verwendet.
+
 ### `@Prefix(value: string)`
 
 Validiert, dass ein String mit dem angegebenen Präfix beginnt.

apps/docs/docs/decorators/validators.md

@@ -29,6 +29,13 @@ Valide qu'un nombre est dans la plage spécifiée, inclusivement des valeurs min
 - **`min`** : La valeur minimale autorisée.
 - **`max`** : La valeur maximale autorisée.
 
+### `@Contains(seed: string)`
+
+Valide qu'une chaîne contient la sous-chaîne spécifiée.
+
+- **`seed`** : La sous-chaîne qui doit être présente dans la chaîne.
+- **`message`** (optionnel) : Le message d'erreur à afficher en cas d'échec de la validation. Si omis, un message par défaut sera utilisé.
+
 ### `@Prefix(value: string)`
 
 Valide qu'une chaîne commence par le préfixe spécifié.

apps/docs/i18n/de/docusaurus-plugin-content-docs/current/decorators/validators.md

@@ -43,6 +43,15 @@ title: 유효성 검사 데코레이터
 
 ---
 
+### `@Contains(seed: string)`
+
+문자열이 지정된 부분 문자열을 포함하는지 검증합니다.
+
+* **`seed`**: 문자열에 반드시 포함되어야 하는 부분 문자열
+* **`message`** (선택): 검증 실패 시 표시할 오류 메시지. 생략하면 기본 메시지가 사용됩니다.
+
+---
+
 ### `@Prefix(value: string)`
 
 문자열이 지정된 접두사로 시작하는지 검증합니다.

apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/decorators/validators.md

@@ -29,6 +29,13 @@ Express-Cargo использует декораторы для валидаци
 - **`min`**: Минимально допустимое значение.
 - **`max`**: Максимально допустимое значение.
 
+### `@Contains(seed: string)`
+
+Проверяет, что строка содержит указанную подстроку.
+
+- **`seed`**: Подстрока, которая должна присутствовать в строке.
+- **`message`** (необязательно): Сообщение об ошибке, отображаемое при неудачной валидации. Если не указано, используется сообщение по умолчанию.
+
 ### `@Prefix(value: string)`
 
 Проверяет, что строка начинается с указанного префикса.

apps/docs/i18n/ko/docusaurus-plugin-content-docs/current/decorators/validators.md

@@ -362,6 +362,29 @@ curl -X POST 'http://localhost:3000/range' \
 
 ---
 
+### @Contains
+
+```typescript
+class ContainsExample {
+    @Body()
+    @Contains('hello')
+    greeting!: string
+}
+
+router.post('/contains', bindingCargo(ContainsExample), (req, res) => {
+    const cargo = getCargo<ContainsExample>(req)
+    res.json(cargo)
+})
+```
+
+```shell
+curl -X POST 'http://localhost:3000/contains' \
+    -H 'Content-Type: application/json' \
+    -d '{"greeting": "hello world"}'
+```
+
+---
+
 ### @Prefix
 
 ```typescript

apps/docs/i18n/ru/docusaurus-plugin-content-docs/current/decorators/validators.md

@@ -33,6 +33,7 @@ import {
     With,
     Without,
     Enum,
+    Contains,
     ListContains, ListNotContains, ListMaxSize, Type, List, ListMinSize,
 } from 'express-cargo'
 
@@ -121,6 +122,17 @@ router.post('/not-equal', bindingCargo(NotEqualExample), (req, res) => {
     res.json(cargo)
 })
 
+class ContainsExample {
+    @Body()
+    @Contains('hello')
+    greeting!: string
+}
+
+router.post('/contains', bindingCargo(ContainsExample), (req, res) => {
+    const cargo = getCargo<ContainsExample>(req)
+    res.json(cargo)
+})
+
 class PrefixExample {
     @Body()
     @Prefix('https://')

apps/example/README.md

@@ -49,6 +49,26 @@ export function Max(maximum: number, message?: cargoErrorMessage): TypedProperty
     }
 }
 
+/**
+ * Checks if the string contains the specified substring.
+ * @param seed - The substring to search for.
+ * @param message - Optional custom error message.
+ */
+export function Contains(seed: string, message?: cargoErrorMessage): TypedPropertyDecorator<string> {
+    return (target, propertyKey) => {
+        addValidator(
+            target,
+            propertyKey,
+            new ValidatorRule(
+                propertyKey,
+                'contains',
+                val => typeof val === 'string' && val.includes(seed),
+                message || `${String(propertyKey)} must contain ${seed}`,
+            ),
+        )
+    }
+}
+
 /**
  * Checks if the string starts with the specified prefix.
  * @param prefixText - The prefix string.