@cnamts/synapse 0.0.12-alpha → 0.0.13-alpha

package/src/utils/rules/isNotAfterToday/tests/isNotAfterToday.spec.ts

@@ -0,0 +1,30 @@
+import dayjs from 'dayjs'
+import { it, describe, expect } from 'vitest'
+import { isNotAfterTodayFn } from '..'
+import { defaultErrorMessages } from '../locales'
+
+const DATE_FORMAT = 'DD/MM/YYYY'
+
+const pastDate = dayjs().subtract(1, 'year').format(DATE_FORMAT)
+const futureDate = dayjs().add(1, 'year').format(DATE_FORMAT)
+const today = dayjs().format(DATE_FORMAT)
+
+describe('notAfterTodayFn', () => {
+	const notAfterToday = isNotAfterTodayFn(defaultErrorMessages)
+
+	it('returns true when value is null', () => {
+		expect(notAfterToday(null)).toBe(true)
+	})
+
+	it('returns true when value is a date before today', () => {
+		expect(notAfterToday(pastDate)).toBe(true)
+	})
+
+	it('returns error message when value is a date after today', () => {
+		expect(notAfterToday(futureDate)).toBe(defaultErrorMessages.default)
+	})
+
+	it('returns true when value is today', () => {
+		expect(notAfterToday(today)).toBe(true)
+	})
+})

package/src/utils/rules/isNotBeforeDate/IsNotBeforeDate.mdx

@@ -0,0 +1,68 @@
+import { Meta, Canvas, Source } from '@storybook/blocks';
+import * as IsNotBeforeDateStories from './IsNotBeforeDate.stories';
+
+<Meta of={IsNotBeforeDateStories} />
+
+# Règle de validation `isNotBeforeDate`
+
+La règle de validation `isNotBeforeDate` permet de vérifier qu'une date n'est pas antérieure à une date de référence.
+
+## Usage
+
+Pour utiliser cette règle de validation, vous devez importer la fonction d'ordre supérieur `isNotBeforeDateFn` depuis le package `@cnamts/synapse`.
+
+<Source dark code={`
+import { isNotBeforeDateFn } from '@cnamts/synapse';
+`} />
+
+Vous devez ensuite faire appel à cette fonction en lui passant en paramètre la date de référence.
+
+<Source dark code={`
+const notBeforeToday = isNotBeforeDateFn('01/01/2022');
+`} />
+
+Vous pouvez ensuite utiliser la fonction retournée comme règle d'un champs de formulaire.
+
+<Source dark code={`
+<script setup lang="ts">
+import { isNotBeforeDateFn } from '@cnamts/synapse';
+import { VTextField } from 'vuetify/components';
+
+const notBefore = isNotBeforeDateFn('01/01/2022');
+
+</script>
+
+<template>
+	<VTextField
+		:rules="[notBefore]"
+		label="Date"
+	/>
+</template>
+`} />
+
+## API
+
+<Source dark code={`
+
+isNotBeforeDateFn(
+	date: string,
+	errorMessages?: {
+		default?: (date: string) => string;
+	}
+): (value: string) => true | string;
+
+`} />
+
+### Arguments
+
+- `date` : chaîne de caractères représentant la date de référence. La date doit être au format `JJ/MM/AAAA`.
+- `errorMessages` : objet optionnel permettant de personnaliser les messages d'erreur. Les clés disponibles sont :
+	- `default` : message d'erreur par défaut. Vous pouvez utiliser la variable `{{ date }}` pour afficher la date de référence.
+
+### Valeurs de retour
+
+Retourne une fonction de validation utilisable dans un champs de formulaire Vuetify qui permet de vérifier si la date passée en paramètre n'est pas antérieure à la date de référence.
+
+## Exemples
+
+<Canvas of={IsNotBeforeDateStories.Default} />

package/src/utils/rules/isNotBeforeDate/IsNotBeforeDate.stories.ts

@@ -0,0 +1,114 @@
+import type { StoryObj } from '@storybook/vue3'
+import { VTextField } from 'vuetify/components'
+
+import { isNotBeforeDateFn } from './index'
+import { ref } from 'vue'
+
+export default {
+	title: 'Guide du dev/Règles De Validation/isNotBeforeDate',
+	component: isNotBeforeDateFn,
+}
+
+export const Default: StoryObj<unknown> = {
+	render: () => {
+		return {
+			components: { VTextField },
+			setup() {
+				const date = isNotBeforeDateFn('01/01/2022')
+				const model = ref('12/12/2021')
+
+				return { date, model }
+			},
+			template: `
+				<VTextField
+					v-model="model"
+					:rules="[date]"
+					label="Date"
+					variant="outlined"
+					validate-on="eager blur"
+				/>
+			`,
+		}
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Script',
+				code: `
+				<script setup lang="ts">
+					import { VTextField } from 'vuetify/components'
+					import { isNotBeforeDateFn } from '@cnamts/synapse'
+
+					const date = isNotBeforeDateFn('01/01/2022')
+				</script>
+				`,
+			},
+			{
+				name: 'Template',
+				code: `
+				<template>
+					<VTextField
+						:rules="[date]"
+						label="Date"
+						variant="outlined"
+					/>
+				</template>
+				`,
+			},
+		],
+	},
+}
+
+export const WithCustomMessage: StoryObj<unknown> = {
+	render: () => {
+		return {
+			components: { VTextField },
+			setup() {
+				const date = isNotBeforeDateFn('01/01/2022', {
+					default: (date: string) => `the date must not be before ${date}`,
+				})
+				const model = ref('12/12/2021')
+
+				return { date, model }
+			},
+			template: `
+				<VTextField
+					v-model="model"
+					:rules="[date]"
+					label="Date after 2022"
+					variant="outlined"
+					validate-on="eager blur"
+				/>
+			`,
+		}
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Script',
+				code: `
+				<script setup lang="ts">
+					import { VTextField } from 'vuetify/components'
+					import { isNotBeforeDateFn } from '@cnamts/synapse'
+
+					const date = isNotBeforeDateFn('01/01/2022', {
+						default: (date: string) => \`the date must not be before \${date}\`,
+					})
+				</script>
+				`,
+			},
+			{
+				name: 'Template',
+				code: `
+				<template>
+					<VTextField
+						:rules="[date]"
+						label="Date after 2022"
+						variant="outlined"
+					/>
+				</template>
+				`,
+			},
+		],
+	},
+}

package/src/utils/rules/isNotBeforeDate/index.ts

@@ -0,0 +1,25 @@
+import type { ValidationRule, ValidationResult, Value } from '../types'
+import { defaultErrorMessages } from './locales'
+import { isDateBefore } from '../../functions/validation/isDateBefore'
+import { formatDate } from '@/utils/formatDate'
+import { parseDate } from '@/utils/parseDate'
+import { ruleMessage } from '@/utils/ruleMessage'
+
+/** Check that the value is not after the specified date (DD/MM/YYYY format) */
+export function isNotBeforeDateFn(
+	date: string,
+	errorMessages = defaultErrorMessages,
+): ValidationRule {
+	return (value: Value): ValidationResult => {
+		if (!value) {
+			return true
+		}
+
+		const formattedValue = formatDate(parseDate(date))
+
+		return (
+			!isDateBefore(date, value)
+			|| ruleMessage(errorMessages, 'default', [formattedValue])
+		)
+	}
+}

package/src/utils/rules/isNotBeforeDate/locales.ts

@@ -0,0 +1,6 @@
+import type { ErrorMessages } from '../types'
+
+export const defaultErrorMessages: ErrorMessages = {
+	default: (date: string) =>
+		`La date doit être postérieure ou égale au ${date}.`,
+}

package/src/utils/rules/isNotBeforeDate/tests/IsNotBeforeDate.spec.ts

@@ -0,0 +1,25 @@
+import { isNotBeforeDateFn } from '..'
+import { describe, it, expect } from 'vitest'
+
+import dayjs from 'dayjs'
+import { formatDate } from '@/utils/formatDate'
+
+describe('isNotBeforeDate', () => {
+	const currentDate = formatDate(dayjs())
+	const pastDate = formatDate(dayjs().subtract(1, 'year'))
+	const futureDate = formatDate(dayjs().add(1, 'year'))
+
+	const rule = isNotBeforeDateFn(currentDate)
+
+	it('returns true with a future date', () => {
+		expect(rule(futureDate)).toBe(true)
+	})
+
+	it('returns an error with a past date', () => {
+		expect(typeof rule(pastDate)).toBe('string')
+	})
+
+	it('returns true if the value is falsy', () => {
+		expect(rule('')).toBe(true)
+	})
+})

package/src/utils/rules/isNotBeforeToday/IsNotBeforeToday.mdx

@@ -0,0 +1,83 @@
+import { Meta, Canvas, Source } from '@storybook/blocks';
+import * as IsNotBeforeTodayStories from './IsNotBeforeToday.stories';
+
+<Meta of={IsNotBeforeTodayStories} />
+
+# Règle de validation `isNotBeforeToday`
+
+La règle de validation `isNotBeforeToday` permet de vérifier qu'une date n'est pas antérieur à la date du jour.
+
+## Usage
+
+Pour utiliser cette règle de validation, vous devez importer la règle depuis le package `@cnamts/synapse`.
+
+<Source dark code={`
+import { isNotBeforeToday } from '@cnamts/synapse';
+`} />
+
+
+Vous pouvez ensuite utiliser la fonction comme règle d'un champs de formulaire.
+
+<Source dark code={`
+<script setup lang="ts">
+import { isNotBeforeToday } from '@cnamts/synapse';
+import { VTextField } from 'vuetify/components';
+
+</script>
+
+<template>
+	<VTextField
+		:rules="[isNotBeforeToday]"
+		label="Date"
+	/>
+</template>
+`} />
+
+## Customisation des messages d'erreur
+
+Vous pouvez personnaliser les messages d'erreur en passant un objet `errorMessages` en paramètre de la fonction `isNotBeforeTodayFn`.
+Puis en utilisant la fonction retournée comme règle d'un champs de formulaire.
+
+<Source dark code={`
+<script setup lang="ts">
+import { isNotBeforeTodayFn } from '@cnamts/synapse';
+import { VTextField } from 'vuetify/components';
+
+const notBeforeToday = isNotBeforeTodayFn({
+	default: \`The date must not be Before today\`,
+});
+
+</script>
+
+<template>
+	<VTextField
+		:rules="[notBeforeToday]"
+		label="Date"
+	/>
+</template>
+`} />
+
+## API
+
+<Source dark code={`
+
+isNotBeforeTodayFn(
+	errorMessages?: {
+		default: string;
+	}
+): (value: string) => true | string;
+
+`} />
+
+### Arguments
+
+- `errorMessages` : objet optionnel permettant de personnaliser les messages d'erreur. Les clés disponibles sont :
+	- `default` : message d'erreur par défaut.
+
+### Valeurs de retour
+
+Retourne une fonction qui prend en paramètre une chaîne de caractères représentant une date et retourne `true` si la date n'est pas antérieur à la date du jour, sinon retourne un message d'erreur.
+
+## Exemples
+
+<Canvas of={IsNotBeforeTodayStories.Default} />

package/src/utils/rules/isNotBeforeToday/IsNotBeforeToday.stories.ts

@@ -0,0 +1,110 @@
+import type { StoryObj } from '@storybook/vue3'
+import { VTextField } from 'vuetify/components'
+import { isNotBeforeToday, isNotBeforeTodayFn } from './index'
+import { ref } from 'vue'
+
+export default {
+	title: 'Guide du dev/Règles De Validation/isNotBeforeToday',
+	component: isNotBeforeTodayFn,
+}
+
+export const Default: StoryObj<unknown> = {
+	render: () => {
+		return {
+			components: { VTextField },
+			setup() {
+				const model = ref('12/12/2050')
+
+				return { model, isNotBeforeToday }
+			},
+			template: `
+				<VTextField
+					v-model="model"
+					:rules="[isNotBeforeToday]"
+					label="Date"
+					variant="outlined"
+					validate-on="eager blur"
+				/>
+			`,
+		}
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Script',
+				code: `
+				<script setup lang="ts">
+					import { VTextField } from 'vuetify/components'
+					import { isNotBeforeToday } from '@cnamts/synapse'
+				</script>
+				`,
+			},
+			{
+				name: 'Template',
+				code: `
+				<template>
+					<VTextField
+						:rules="[isNotBeforeToday]"
+						label="Date"
+						variant="outlined"
+					/>
+				</template>
+				`,
+			},
+		],
+	},
+}
+
+export const CustomMessage: StoryObj<unknown> = {
+	render: () => {
+		return {
+			components: { VTextField },
+			setup() {
+				const messages = {
+					default: 'The date must not be Before today.',
+				}
+				const dateRule = isNotBeforeTodayFn(messages)
+
+				return { dateRule }
+			},
+			template: `
+				<VTextField
+					:rules="[dateRule]"
+					label="Date"
+					variant="outlined"
+					validate-on="eager blur"
+				/>
+			`,
+		}
+	},
+	parameters: {
+		sourceCode: [
+			{
+				name: 'Script',
+				code: `
+				<script setup lang="ts">
+					import { VTextField } from 'vuetify/components'
+					import { isNotBeforeTodayFn } from '@cnamts/synapse'
+				
+					const messages = {
+						default: 'The date must not be Before today.',
+					}
+					const dateRule = isNotBeforeTodayFn(messages)
+				</script>
+				`,
+			},
+			{
+				name: 'Template',
+				code: `
+				<template>
+					<VTextField
+						:rules="[dateRule]"
+						label="Date"
+						variant="outlined"
+					/>
+				</template>
+				`,
+			},
+		],
+	},
+}

package/src/utils/rules/isNotBeforeToday/index.ts

@@ -0,0 +1,28 @@
+import { formatDate } from '@/utils/formatDate'
+import { ruleMessage } from '@/utils/ruleMessage'
+import dayjs from 'dayjs'
+import { isDateBefore } from '../../functions/validation/isDateBefore'
+import type {
+	ErrorMessages,
+	ValidationResult,
+	ValidationRule,
+	Value,
+} from '../types'
+import { defaultErrorMessages } from './locales'
+
+/** Check that the value is not before today (DD/MM/YYYY format) */
+export function isNotBeforeTodayFn(
+	errorMessages: ErrorMessages = defaultErrorMessages,
+): ValidationRule {
+	return (value: Value): ValidationResult => {
+		if (!value) {
+			return true
+		}
+
+		return (
+			!isDateBefore(formatDate(dayjs()), value) || ruleMessage(errorMessages, 'default')
+		)
+	}
+}
+
+export const isNotBeforeToday = isNotBeforeTodayFn()

package/src/utils/rules/isNotBeforeToday/locales.ts

@@ -0,0 +1,5 @@
+import type { ErrorMessages } from '../types'
+
+export const defaultErrorMessages: ErrorMessages = {
+	default: 'La date doit être postérieure à aujourd’hui.',
+}

package/src/utils/rules/isNotBeforeToday/tests/notBeforeToday.spec.ts

@@ -0,0 +1,36 @@
+import dayjs from 'dayjs'
+
+import { isNotBeforeToday, isNotBeforeTodayFn } from '..'
+import { describe, it, expect } from 'vitest'
+
+const DATE_FORMAT = 'DD/MM/YYYY'
+
+const pastDate = dayjs().subtract(1, 'year').format(DATE_FORMAT)
+const futureDate = dayjs().add(1, 'year').format(DATE_FORMAT)
+const today = dayjs().format(DATE_FORMAT)
+
+describe('isNotBeforeToday', () => {
+	it('returns an error when the date is past', () => {
+		expect(typeof isNotBeforeToday(pastDate)).toBe('string')
+	})
+
+	it('returns true when the date is future', () => {
+		expect(isNotBeforeToday(futureDate)).toBe(true)
+	})
+
+	it('returns true if the value is falsy', () => {
+		expect(isNotBeforeToday('')).toBe(true)
+	})
+
+	it('works with custom error messages', () => {
+		const rule = isNotBeforeTodayFn({
+			default: 'test',
+		})
+
+		expect(rule(pastDate)).toBe('test')
+	})
+
+	it('returns true when value is today', () => {
+		expect(isNotBeforeToday(today)).toBe(true)
+	})
+})

package/src/utils/rules/isRequired/IsRequired.mdx

@@ -0,0 +1,81 @@
+import { Meta, Canvas, Source } from '@storybook/blocks';
+import * as IsRequiredStories from './IsRequired.stories';
+
+<Meta of={IsRequiredStories} />
+
+# Règle de validation `isRequired`
+
+La règle de validation `isRequired` permet de vérifier qu'un champ de formulaire est rempli.
+
+## Usage
+
+Pour utiliser cette règle de validation, vous devez importer la fonction d'ordre supérieur `isRequiredFn` depuis le package `@cnamts/synapse`.
+
+<Source dark code={`
+import { isRequiredFn } from '@cnamts/synapse';
+`} />
+
+Vous devez ensuite faire appel à cette fonction pour obtenir la règle de validation.
+
+<Source dark code={`
+const isRequired = isRequiredFn(/* options */);
+`} />
+
+Vous pouvez ensuite utiliser la fonction retournée comme règle d'un champs de formulaire.
+
+<Source dark code={`
+<script setup lang="ts">
+import { isRequiredFn } from '@cnamts/synapse';
+import { VTextField } from 'vuetify/components';
+
+const isRequired = isRequiredFn(/* options */);
+
+</script>
+
+<template>
+	<VTextField
+		:rules="[isRequired]"
+		label="Required field"
+	/>
+</template>
+`} />
+
+Si vous utilisez cette règle sans options, vous pouvez faire appel à la fonction `isRequired`.
+
+<Source dark code={`
+<script setup lang="ts">
+import { isRequired } from '@cnamts/synapse';
+import { VTextField } from 'vuetify/components';
+</script>
+
+<template>
+	<VTextField
+		:rules="[isRequired]"
+		label="Required field"
+	/>
+</template>
+
+`} />
+
+## API
+
+<Source dark code={`
+isRequiredFn(
+	errorMessages?: {
+		default?: string;
+	}
+): (value: string) => true | string;
+`} />
+
+### Arguments
+
+- `errorMessages` : objet optionnel permettant de personnaliser les messages d'erreur. Les clés disponibles sont :
+	- `default` : message d'erreur par défaut.
+
+### Valeurs de retour
+
+Retourne une fonction pouvant être utilisée comme règle de validation pour un champs de formulaire Vuetify.
+
+## Exemples
+
+<Canvas of={IsRequiredStories.Default} />