@cnamts/synapse 0.0.0-alpha.0 → 0.0.2-alpha

package/README.md

@@ -1,2 +1,72 @@
-# design-system-v3
-📦 Un Design System pour l’Assurance Maladie
+# Synapse
+
+🗃️ Ce package contient les composants du Design System de l'Assurance Maladie réécrits en Vue 3.
+
+## Changelog
+
+Pour consulter les changements récents, veuillez consulter le [CHANGELOG](https://github.com/assurance-maladie-digital/design-system-v3/CHANGELOG.md).
+
+## Prérequis
+
+Pour utiliser ce Design System, vous devez avoir au moins les versions suivantes de Node :
+
+-   Node : 18.0.0
+
+## Stack Technique
+
+-   Vue 3
+-   Vuetify 3
+-   Vue Router 4
+
+## Outils Inclus
+
+-   Typescript
+-   Axios
+-   Sass
+-   Vitest pour les tests unitaires
+
+## Installation et utilisation
+
+### Starter kit
+
+Pour utiliser ce package, vous pouvez installer le starter kit suivant :
+
+-   [Starter Kit Synapse](https://gitlab.cnqd.cnamts.fr/human/developpement/SKV3_X)
+
+### Librairie uniquement
+
+Vous pouvez également utiliser ce package en tant que librairie de composants dans votre projet.
+Pour cela, vous pouvez l'installer via npm ou un autre gestionnaire de paquets :
+
+```bash
+npm i @cnamts/synapse
+```
+
+## Commandes disponibles
+
+```bash
+		"pnpm build": Build du projet,
+		"pnpm dev": Lancement du serveur de développement,
+		"pnpm preview": Lancement du serveur de prévisualisation,
+		"pnpm test:unit": Lancement des tests unitaires,
+		"pnpm lint": Lancement de l\'analyseur de code,
+```
+
+## Contribution
+
+Nous encourageons les contributions de la communauté ! Si vous souhaitez contribuer à ce projet, veuillez suivre les étapes suivantes :
+
+### Fork du dépôt
+
+-   Créez une branche pour votre fonctionnalité ou correction de bogue
+-   Effectuez les modifications nécessaires
+-   Soumettez une pull request
+-   Assurez-vous de suivre notre Guide de contribution pour plus de détails.
+
+### Support
+
+Si vous rencontrez des problèmes ou avez des questions, n'hésitez pas à ouvrir une issue.
+
+## Licence
+
+Ce projet est sous licence MIT. Veuillez consulter le fichier LICENSE pour plus d'informations.

package/dist/design-system-v3.d.ts

@@ -1,9 +1,18 @@
+import { AxiosResponse } from 'axios';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { LinkItem } from './types';
+import { ListItem } from './types';
+import { PropType } from 'vue';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
+import { RouteLocationAsPathGeneric } from 'vue-router';
+import { RouteLocationAsRelativeGeneric } from 'vue-router';
+import { SocialMediaLink } from './types';
+import { SocialMediaLink as SocialMediaLink_2 } from '../SocialMediaLinks/types';
 
 declare type __VLS_PublicProps = {
     modelValue?: boolean;
@@ -51,6 +60,24 @@ declare type __VLS_WithTemplateSlots_6<T, S> = T & {
     };
 };
 
+declare type __VLS_WithTemplateSlots_7<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_8<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
+declare type __VLS_WithTemplateSlots_9<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+
 export declare const Alert: __VLS_WithTemplateSlots_2<DefineComponent<__VLS_PublicProps, {
 prependIcon: ComputedRef<string>;
 dismissAlert: typeof dismissAlert;
@@ -67,6 +94,17 @@ variant: "tonal" | "outlined";
     default?(_: {}): any;
 }>;
 
+export declare const BackBtn: __VLS_WithTemplateSlots_6<DefineComponent<    {
+hideBackIcon?: boolean | undefined;
+dark?: boolean | undefined;
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
+hideBackIcon?: boolean | undefined;
+dark?: boolean | undefined;
+}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
+    icon?(_: {}): any;
+    default?(_: {}): any;
+}>;
+
 export declare const BackToTopBtn: __VLS_WithTemplateSlots_5<DefineComponent<Props & CustomizableOptions, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<Props & CustomizableOptions> & Readonly<{}>, {
 target: string;
 threshold: number;
@@ -77,6 +115,14 @@ nudgeBottom: string | number;
     icon?(_: {}): any;
 }>;
 
+export declare const CollapsibleList: DefineComponent<    {
+listTitle: string | null;
+items: ListItem[];
+}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
+listTitle: string | null;
+items: ListItem[];
+}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
 declare type ComponentsProps = Record<string, PropsList>;
 
 declare function copy(): void;
@@ -113,6 +159,96 @@ declare interface CustomizableOptions {
 
 declare function dismissAlert(): void;
 
+declare function download(): Promise<void>;
+
+export declare const DownloadBtn: __VLS_WithTemplateSlots_7<DefineComponent<Props_2 & CustomizableOptions, {
+getFileInfo: typeof getFileInfo;
+download: typeof download;
+state: Ref<State, State>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+error: (...args: any[]) => void;
+success: (...args: any[]) => void;
+}, string, PublicProps, Readonly<Props_2 & CustomizableOptions> & Readonly<{
+onError?: ((...args: any[]) => any) | undefined;
+onSuccess?: ((...args: any[]) => any) | undefined;
+}>, {
+fallbackFilename: string;
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
+    icon?(_: {}): any;
+    default?(_: {}): any;
+}>;
+
+declare interface FileInfo {
+    name: string;
+    type: string;
+}
+
+export declare const FooterBar: __VLS_WithTemplateSlots_9<DefineComponent<CustomizableOptions & {
+a11yCompliance?: string | undefined;
+linkItems?: LinkItem[] | null | undefined;
+items?: LinkItem[] | null | undefined;
+sitemapRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+cguRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+cookiesRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+legalNoticeRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+a11yStatementRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+hideSitemapLink?: boolean | undefined;
+hideCguLink?: boolean | undefined;
+hideCookiesLink?: boolean | undefined;
+hideLegalNoticeLink?: boolean | undefined;
+hideA11yLink?: boolean | undefined;
+version?: string | undefined;
+hideLogo?: boolean | undefined;
+hideSocialMediaLinks?: boolean | undefined;
+socialMediaLinks?: SocialMediaLink_2[] | undefined;
+light?: boolean | undefined;
+}, {
+logoSize: ComputedRef<"small" | "normal">;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<CustomizableOptions & {
+a11yCompliance?: string | undefined;
+linkItems?: LinkItem[] | null | undefined;
+items?: LinkItem[] | null | undefined;
+sitemapRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+cguRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+cookiesRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+legalNoticeRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+a11yStatementRoute?: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric | undefined;
+hideSitemapLink?: boolean | undefined;
+hideCguLink?: boolean | undefined;
+hideCookiesLink?: boolean | undefined;
+hideLegalNoticeLink?: boolean | undefined;
+hideA11yLink?: boolean | undefined;
+version?: string | undefined;
+hideLogo?: boolean | undefined;
+hideSocialMediaLinks?: boolean | undefined;
+socialMediaLinks?: SocialMediaLink_2[] | undefined;
+light?: boolean | undefined;
+}> & Readonly<{}>, {
+light: boolean;
+items: LinkItem[] | null;
+a11yCompliance: string;
+linkItems: LinkItem[] | null;
+sitemapRoute: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+cguRoute: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+cookiesRoute: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+legalNoticeRoute: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+a11yStatementRoute: string | RouteLocationAsRelativeGeneric | RouteLocationAsPathGeneric;
+hideSitemapLink: boolean;
+hideCguLink: boolean;
+hideCookiesLink: boolean;
+hideLegalNoticeLink: boolean;
+hideA11yLink: boolean;
+version: string;
+hideLogo: boolean;
+hideSocialMediaLinks: boolean;
+socialMediaLinks: SocialMediaLink_2[];
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, {
+    logo?(_: {}): any;
+    default?(_: {}): any;
+    prepend?(_: {}): any;
+    append?(_: {}): any;
+}>;
+
 export declare const FranceConnectBtn: DefineComponent<    {
 href: string;
 isConnectPlus?: boolean | undefined;
@@ -122,10 +258,15 @@ href: string;
 isConnectPlus?: boolean | undefined;
 dark?: boolean | undefined;
 }> & Readonly<{}>, {
-isConnectPlus: boolean;
 dark: boolean;
+isConnectPlus: boolean;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
+/**
+ * Get filename and content type from headers
+ */
+declare function getFileInfo(header: Record<string, string>): FileInfo;
+
 export declare const LangBtn: DefineComponent<CustomizableOptions & {
 modelValue?: string | undefined;
 hideDownArrow?: boolean | undefined;
@@ -159,6 +300,76 @@ hideDownArrow: boolean;
 availableLanguages: string[] | "*";
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
 
+export declare const Logo: DefineComponent<ExtractPropTypes<    {
+hideSignature: {
+type: BooleanConstructor;
+default: boolean;
+};
+hideOrganism: {
+type: BooleanConstructor;
+default: boolean;
+};
+risquePro: {
+type: BooleanConstructor;
+default: boolean;
+};
+ariaLabel: {
+type: StringConstructor;
+default: undefined;
+};
+avatar: {
+type: BooleanConstructor;
+default: boolean;
+};
+dark: {
+type: BooleanConstructor;
+default: boolean;
+};
+size: {
+type: PropType<"small" | "x-small" | "normal">;
+default: "normal";
+validator: (value: string) => boolean;
+};
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+hideSignature: {
+type: BooleanConstructor;
+default: boolean;
+};
+hideOrganism: {
+type: BooleanConstructor;
+default: boolean;
+};
+risquePro: {
+type: BooleanConstructor;
+default: boolean;
+};
+ariaLabel: {
+type: StringConstructor;
+default: undefined;
+};
+avatar: {
+type: BooleanConstructor;
+default: boolean;
+};
+dark: {
+type: BooleanConstructor;
+default: boolean;
+};
+size: {
+type: PropType<"small" | "x-small" | "normal">;
+default: "normal";
+validator: (value: string) => boolean;
+};
+}>> & Readonly<{}>, {
+size: "small" | "x-small" | "normal";
+ariaLabel: string;
+dark: boolean;
+hideSignature: boolean;
+hideOrganism: boolean;
+risquePro: boolean;
+avatar: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
 declare interface Notification_2 {
     id: string;
     message: string;
@@ -167,7 +378,7 @@ declare interface Notification_2 {
     icon?: string | null;
 }
 
-export declare const NotificationBar: __VLS_WithTemplateSlots_6<DefineComponent<CustomizableOptions & {
+export declare const NotificationBar: __VLS_WithTemplateSlots_8<DefineComponent<CustomizableOptions & {
 closeBtnText?: string | undefined;
 rounded?: true | 0 | "xl" | "xs" | "sm" | "lg" | 1 | 2 | 3 | 4 | "circle" | "pill" | "shaped" | undefined;
 bottom?: boolean | undefined;
@@ -226,6 +437,11 @@ declare interface Props {
     target?: string;
 }
 
+declare interface Props_2 {
+    filePromise: () => Promise<AxiosResponse<Blob>>;
+    fallbackFilename?: string;
+}
+
 declare type PropsList = Record<string, unknown>;
 
 export declare const SkipLink: __VLS_WithTemplateSlots_4<DefineComponent<    {
@@ -241,6 +457,22 @@ target: string;
     default?(_: {}): any;
 }>;
 
+export declare const SocialMediaLinks: DefineComponent<ExtractPropTypes<    {
+links: {
+type: PropType<SocialMediaLink[]>;
+default: null;
+};
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+links: {
+type: PropType<SocialMediaLink[]>;
+default: null;
+};
+}>> & Readonly<{}>, {
+links: SocialMediaLink[];
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+declare type State = 'idle' | 'loading' | 'success' | 'error';
+
 declare function updateLang(lang: string): void;
 
 export { }