@cnamts/synapse 1.0.26 → 1.0.27

package/dist/composables/unifyValidation/documentationValidationProps.d.ts

@@ -1,230 +1,230 @@
 export declare function getValidationDocumentation(type?: 'date' | 'number' | 'string' | 'all'): {
-    readonly: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly readonly: {
+        readonly description: "Permet de rendre le champ en lecture seule, le champ deviens grisé.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    disabled: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly disabled: {
+        readonly description: "Désactive le champ sans changement visuel pour l'utilisateur.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    required: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly required: {
+        readonly description: "Indique que le champ est requis.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    isValidateOnBlur: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly isValidateOnBlur: {
+        readonly description: "Détermine si la validation doit être déclenchée lors de la saisie ou du blur de l'input.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "true";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    showSuccessMessages: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly showSuccessMessages: {
+        readonly description: "Affiche les messages de succès lorsque la validation est réussie. Si la prop est à `false` cela cache uniquement les messages texte, l'état visuel reste actif.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "true";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    disableErrorHandling: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly disableErrorHandling: {
+        readonly description: "Désactive la gestion des erreurs, utile lorsque vous souhaitez gérer les erreurs manuellement.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    useVuetifyValidation: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly useVuetifyValidation: {
+        readonly description: "Indique si la validation doit être gérée par Vuetify (true) ou par Synapse (false).";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    label: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly label: {
+        readonly description: "Le label du champ.";
+        readonly control: "text";
+        readonly table: {
+            readonly type: {
+                readonly summary: "string";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    rules: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
-                detail: string;
+    readonly rules: {
+        readonly description: "Les règles de validation Vuetify à appliquer au champ si useVuetifyValidation est true.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array";
+                readonly detail: "\n\t\t\t\t\t\t(value: unknown) => boolean | string\n\t\t\t\t\t";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    customRules: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
-                detail: string;
+    readonly customRules: {
+        readonly description: "Les règles de validation personnalisées d'erreur (bloquantes) à appliquer au champ. Elles sont évaluées à partir de la valeur du champ.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array";
+                readonly detail: "\n{\n\ttype: 'required' | 'custom',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tmessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tmessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tmessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tmessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tmessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    customWarningRules: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
-                detail: string;
+    readonly customWarningRules: {
+        readonly description: "Les règles de validation personnalisées d'avertissement (non bloquantes) à appliquer au champ. Elles sont évaluées à partir de la valeur du champ.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array";
+                readonly detail: "\n{\n\ttype: 'required' | 'custom',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\twarningMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\twarningMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\twarningMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\twarningMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\twarningMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    customSuccessRules: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
-                detail: string;
+    readonly customSuccessRules: {
+        readonly description: "Les règles de validation personnalisées de succès à appliquer au champ. Elles sont évaluées à partir de la valeur du champ.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array";
+                readonly detail: "\n{\n\ttype: 'required' | 'custom',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tsuccessMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tsuccessMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tsuccessMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tsuccessMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t" | "\n{\n\ttype: 'required' | 'custom' | 'min' | 'max' | 'minLength' | 'maxLength' | 'exactLength' | 'email' | 'matchPattern' | 'noWeekend' | 'noBeforeToday' | 'notAfterToday' | 'notBeforeDate' | 'notAfterDate' | 'dateExact' | 'isHolidayDay',\n\toptions: {\n\t\tvalidate: (value: unknown) => boolean | string,\n\t\tsuccessMessage: string,\n\t\t[key: string]: unknown\n\t}\n}\n\t\t\t\t\t\t";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    errorMessages: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly errorMessages: {
+        readonly description: "Permet d'injecter des messages d'erreur depuis le parent. Aucun calcul de validation n'est exécuté.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array<string>";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    warningMessages: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly warningMessages: {
+        readonly description: "Permet d'injecter des messages d'avertissement depuis le parent. Aucun calcul de validation n'est exécuté.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array<string>";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    successMessages: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly successMessages: {
+        readonly description: "Permet d'injecter des messages de succès depuis le parent. Aucun calcul de validation n'est exécuté.";
+        readonly control: "object";
+        readonly table: {
+            readonly type: {
+                readonly summary: "array<string>";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    hasError: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly hasError: {
+        readonly description: "Indique si le champ a une erreur, peut être utilisé pour forcer l'état d'erreur.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    hasWarning: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly hasWarning: {
+        readonly description: "Indique si le champ a un avertissement, peut être utilisé pour forcer l'état d'avertissement.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    hasSuccess: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly hasSuccess: {
+        readonly description: "Indique si le champ a un succès, peut être utilisé pour forcer l'état de succès.";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    hideDetails: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly hideDetails: {
+        readonly description: "Masque la section des détails (messages d'erreur, compteur)";
+        readonly control: "boolean";
+        readonly table: {
+            readonly type: {
+                readonly summary: "boolean";
             };
-            defaultValue: {
-                summary: string;
+            readonly defaultValue: {
+                readonly summary: "false";
             };
-            category: string;
+            readonly category: "props";
         };
     };
-    maxErrors: {
-        description: string;
-        control: string;
-        table: {
-            type: {
-                summary: string;
+    readonly maxErrors: {
+        readonly description: "Le nombre maximum d'erreurs à afficher, applicable uniquement si useVuetifyValidation est true.";
+        readonly control: "number";
+        readonly table: {
+            readonly type: {
+                readonly summary: "number";
             };
-            category: string;
+            readonly category: "props";
         };
     };
 };

package/dist/composables/unifyValidation/useValidation.d.ts

@@ -1,27 +1,29 @@
 import { ValidationRule as SyValidationRule } from '../validation/useValidation';
 import { Ref } from 'vue';
 import { ValidationRule as VuetifyValidationRule } from 'vuetify';
+export type { VuetifyValidationRule };
+export type { SyValidationRule as ValidationRule };
 export interface FieldValidationProps {
-    modelValue?: unknown;
-    readonly?: boolean;
-    disabled?: boolean;
-    required?: boolean;
-    isValidateOnBlur?: boolean;
-    showSuccessMessages?: boolean;
-    disableErrorHandling?: boolean;
-    useVuetifyValidation?: boolean;
-    label?: string;
-    rules?: VuetifyValidationRule[];
     customRules?: SyValidationRule[];
-    customWarningRules?: SyValidationRule[];
     customSuccessRules?: SyValidationRule[];
+    customWarningRules?: SyValidationRule[];
+    disableErrorHandling?: boolean;
+    disabled?: boolean;
     errorMessages?: string[] | null;
-    warningMessages?: string[] | null;
-    successMessages?: string[] | null;
     hasError?: boolean;
-    hasWarning?: boolean;
     hasSuccess?: boolean;
+    hasWarning?: boolean;
+    isValidateOnBlur?: boolean;
+    label?: string;
     maxErrors?: number;
+    modelValue?: unknown;
+    readonly?: boolean;
+    required?: boolean;
+    rules?: VuetifyValidationRule[];
+    showSuccessMessages?: boolean;
+    successMessages?: string[] | null;
+    useVuetifyValidation?: boolean;
+    warningMessages?: string[] | null;
 }
 /**
  * Point d'entrée de la validation pour les composants de champ.