mon-entreprise/site/source/sitePaths.ts

381 lines
10 KiB
TypeScript
Raw Permalink Normal View History

2022-07-25 09:02:08 +00:00
import { useTranslation } from 'react-i18next'
2023-06-19 10:41:14 +00:00
import { MetadataSrc } from '@/pages/simulateurs-et-assistants/metadata-src'
2022-11-03 16:32:04 +00:00
const rawSitePathsFr = {
2020-04-26 17:18:18 +00:00
index: '',
assistants: {
index: 'assistants',
formulaireMobilité: 'demande-mobilité',
'recherche-code-ape': 'recherche-code-ape',
'déclaration-charges-sociales-indépendant':
2022-07-25 09:02:08 +00:00
'declaration-charges-sociales-independant',
économieCollaborative: {
index: 'économie-collaborative',
},
'pour-mon-entreprise': {
index: 'pour-mon-entreprise',
entreprise: ':entreprise',
},
déclarationIndépendant: {
index: 'aide-declaration-independants-v2',
},
'choix-du-statut': {
index: 'choix-du-statut',
'recherche-activité': 'recherche-activite',
'détails-activité': 'details-activite',
commune: 'commune',
association: 'association',
associé: 'associe',
rémunération: 'remuneration',
comparateur: 'comparateur',
2023-06-30 14:26:36 +00:00
résultat: {
index: 'resultat',
AE: 'auto-entrepreneur',
EURL: 'EURL',
SARL: 'SARL',
EI: 'entreprise-individuelle',
SASU: 'SASU',
SAS: 'SAS',
SELARL: 'SELARL',
SELARLU: 'SELARLU',
SELAS: 'SELAS',
SELASU: 'SELASU',
association: 'association',
},
},
},
2020-04-26 17:18:18 +00:00
simulateurs: {
2022-07-25 09:02:08 +00:00
index: 'simulateurs',
'coût-création-entreprise': 'cout-creation-entreprise',
2022-07-25 09:02:08 +00:00
'auto-entrepreneur': 'auto-entrepreneur',
'entreprise-individuelle': 'entreprise-individuelle',
eirl: 'eirl',
sasu: 'sasu',
eurl: 'eurl',
indépendant: 'indépendant',
comparaison: 'comparaison-régimes-sociaux',
pamc: 'pamc',
salarié: 'salaire-brut-net',
'artiste-auteur': 'artiste-auteur',
'profession-libérale': {
2022-07-25 09:02:08 +00:00
index: 'profession-liberale',
médecin: 'medecin',
pharmacien: 'pharmacien',
auxiliaire: 'auxiliaire-medical',
'chirurgien-dentiste': 'chirurgien-dentiste',
'sage-femme': 'sage-femme',
avocat: 'avocat',
'expert-comptable': 'expert-comptable',
cipav: 'cipav',
},
2022-07-25 09:02:08 +00:00
'chômage-partiel': 'chômage-partiel',
is: 'impot-societe',
dividendes: 'dividendes',
'réduction-générale': 'réduction-générale',
2020-04-26 17:18:18 +00:00
},
2023-06-20 11:15:07 +00:00
nouveautés: {
index: 'nouveautés',
date: ':date',
},
2023-02-27 15:16:35 +00:00
stats: 'statistiques',
2022-07-25 09:02:08 +00:00
accessibilité: 'accessibilité',
budget: 'budget',
2023-03-02 17:46:33 +00:00
simulateursEtAssistants: 'simulateurs-et-assistants',
développeur: {
2022-07-25 09:02:08 +00:00
index: 'développeur',
iframe: 'iframe',
library: 'bibliothèque-de-calcul',
api: 'api',
spreadsheet: 'tableur',
2020-04-26 17:18:18 +00:00
},
documentation: {
2022-07-25 09:02:08 +00:00
index: 'documentation',
},
2023-02-27 18:42:08 +00:00
plan: 'plan-du-site',
2020-04-26 17:18:18 +00:00
} as const
🔥 Migration vers TypeScript Outils ====== Ce commit retire le tooling de Flow, et ajoute le support de TypeScript pour les fichiers .ts et .tsx. Il n'est pas nécessaire de tout migrer d'un coup ce qui facilite la transition. On garde en effet le compilateur Babel avec un preset TypeScript (ce qui permet donc de retirer à la fois les types Flow et TypeScript) plutôt que d'utiliser le compilateur standard pour la conversion du code. Cela permet aussi de mieux s'intégrer avec d'autres outils, notamment les test-runners. Ajout d'une nouvelle commande `yarn run type-check`, intégrée dans CircleCI. Par ailleurs ajout du support de l'opérateur ?? pour donner des valeurs par défaut (nullish-coalescing-operator). Typage des libraires tierces ============================ Les principales libraires que nous utilisons ont un typage TypeScript de bon niveau, ce qui facilite l'intégration. J'ai mis à jour react-i18next et i18next afin de corriger un problème de typage. Typage du code ============== Le typage est loin d'être complet dans ce commit, en particulier il manque les types relatifs au state Redux, ainsi qu'au moteur (règle, explication). Néanmoins le typage des contextes fonctionne, en particulier sitePaths (avec un type récursif non trivial !) qui a déjà permis de détecter un lien mort. Le typage des "paths" (Components/, Règles/, etc.) fonctionne bien, y compris avec l'auto-complétion automatique des import par Typescript. TypeScript se révèle déjà bien agréable dans VSCode (auto-complétion, refacto, etc.) ! Reste à migrer progressivement le reste du code !
2019-10-26 16:21:09 +00:00
const rawSitePathsEn = {
...rawSitePathsFr,
assistants: {
index: 'assistants',
formulaireMobilité: 'posting-demand',
'recherche-code-ape': 'search-code-ape',
2022-04-04 11:10:02 +00:00
'déclaration-charges-sociales-indépendant':
2022-07-25 09:02:08 +00:00
'declaration-social-charges-independent',
économieCollaborative: {
index: 'sharing-economy',
votreSituation: 'your-situation',
},
'pour-mon-entreprise': {
index: 'for-my-business',
entreprise: ':entreprise',
},
déclarationIndépendant: {
index: 'declaration-aid-independent-v2',
imposition: 'taxation',
entreprise: 'company',
déclaration: 'declaration',
cotisations: 'contributions',
},
'choix-du-statut': {
2023-03-02 16:16:02 +00:00
index: 'choice-of-status',
2023-06-07 15:18:33 +00:00
'recherche-activité': 'recherche-activite',
'détails-activité': 'details-activite',
après: 'after-registration',
commune: 'commune',
association: 'association',
2023-04-20 14:52:36 +00:00
associé: 'partnership',
rémunération: 'remuneration',
comparateur: 'comparator',
2023-06-30 14:26:36 +00:00
résultat: {
index: 'result',
AE: 'auto-entrepreneur',
EURL: 'EURL',
SARL: 'SARL',
EI: 'entreprise-individuelle',
SASU: 'SASU',
SAS: 'SAS',
SELARL: 'SELARL',
SELARLU: 'SELARLU',
SELAS: 'SELAS',
SELASU: 'SELASU',
association: 'association',
},
},
},
2020-04-26 17:18:18 +00:00
simulateurs: {
2022-07-25 09:02:08 +00:00
index: 'calculators',
2023-01-18 17:03:31 +00:00
'coût-création-entreprise': 'coût-création-entreprise',
2022-07-25 09:02:08 +00:00
indépendant: 'independant',
'entreprise-individuelle': 'sole-proprietorship',
'auto-entrepreneur': 'auto-entrepreneur',
eirl: 'eirl',
sasu: 'sasu',
eurl: 'eurl',
pamc: 'pamc',
comparaison: 'social-scheme-comparaison',
salarié: 'salary',
'artiste-auteur': 'artist-author',
'chômage-partiel': 'partial-unemployement',
'profession-libérale': {
2022-07-25 09:02:08 +00:00
index: 'liberal-profession',
médecin: 'doctor',
pharmacien: 'pharmacist',
auxiliaire: 'medical-auxiliary',
'chirurgien-dentiste': 'dental-surgeon',
'sage-femme': 'midwife',
avocat: 'lawyer',
'expert-comptable': 'accountant',
cipav: 'cipav',
},
2022-07-25 09:02:08 +00:00
is: 'corporate-tax',
dividendes: 'dividends',
'réduction-générale': 'réduction-générale',
2020-04-26 17:18:18 +00:00
},
2023-06-20 11:15:07 +00:00
nouveautés: {
index: 'news',
date: ':date',
},
2023-02-27 15:16:35 +00:00
stats: 'statistics',
2022-07-25 09:02:08 +00:00
accessibilité: 'accessibility',
2023-03-02 17:46:33 +00:00
simulateursEtAssistants: 'simulators-and-assistants',
développeur: {
...rawSitePathsFr.développeur,
2022-07-25 09:02:08 +00:00
index: 'developer',
library: 'library',
api: 'api',
spreadsheet: 'spreadsheet',
},
2023-02-27 18:42:08 +00:00
plan: 'sitemap',
2020-04-26 17:18:18 +00:00
} as const
/**
* Le but des types suivants est d'obtenir un typage statique des chaînes de caractères
2022-07-25 09:02:08 +00:00
* comme "simulateurs.auto-entrepreneur" utilisés comme identifiants des routes (via les pathId dans metadata-src.ts).
* Cela permet de ne pas avoir de faute dans les clés comme 'aide-embauche' au lieu de 'aides-embauche'
*/
// Transfrom string type like PathToType<'simulateurs.auto-entrepreneur', number>
// into { simulateurs : { auto-entrepreneur: number }}
type PathToType<T extends string, W> = T extends `${infer U}.${infer V}`
? { [key in U]: V extends string ? PathToType<V, W> : never }
: { [key in T]: W }
// Transform type A | B into A & B
type UnionToIntersection<T> = (
T extends unknown ? (x: T) => void : never
) extends (x: infer R) => void
? R
: never
// Union of pathId
type PathIds = MetadataSrc[keyof MetadataSrc]['pathId']
type RequiredPath = Required<UnionToIntersection<PathToType<PathIds, string>>>
// If there is a type error here, check rawSitePathsFr object matches the metadata-src.ts pathId
const checkedSitePathsFr = rawSitePathsFr satisfies RequiredPath
// If there is a type error here, check rawSitePathsEn object matches the metadata-src.ts pathId
const checkedSitePathsEn = rawSitePathsEn satisfies RequiredPath
2023-08-01 10:58:30 +00:00
// eslint-disable-next-line @typescript-eslint/no-unused-vars
type SitePathsFr = typeof checkedSitePathsFr
2023-08-01 10:58:30 +00:00
// eslint-disable-next-line @typescript-eslint/no-unused-vars
type SitePathsEn = typeof checkedSitePathsEn
2022-07-25 09:02:08 +00:00
type GenericSitePath = { [key: string]: string | GenericSitePath }
const encodeRelativeSitePaths = <T extends GenericSitePath>(base: T): T => {
const sitepaths = Object.entries(base).reduce(
(obj, [key, val]) => ({
...obj,
[key]: typeof val === 'string' ? val : encodeRelativeSitePaths(val),
2022-07-25 09:02:08 +00:00
}),
{} as T
)
return sitepaths
}
const encodedRelativeSitePaths = encodeRelativeSitePaths({
fr: rawSitePathsFr,
en: rawSitePathsEn,
})
2022-07-28 18:04:44 +00:00
const encodedAbsoluteSitePaths = {
fr: constructAbsoluteSitePaths(rawSitePathsFr),
en: constructAbsoluteSitePaths(rawSitePathsEn),
}
export const relativeSitePaths = encodedRelativeSitePaths
export const absoluteSitePaths = encodedAbsoluteSitePaths
export type RelativeSitePaths =
2023-02-01 11:39:16 +00:00
(typeof relativeSitePaths)[keyof typeof relativeSitePaths]
2022-07-28 18:04:44 +00:00
export type AbsoluteSitePaths =
2023-02-01 11:39:16 +00:00
(typeof absoluteSitePaths)[keyof typeof absoluteSitePaths]
2022-07-28 18:04:44 +00:00
export const useSitePaths = <T extends 'fr' | 'en'>(lang?: T) => {
2022-07-25 09:02:08 +00:00
const { language } = useTranslation().i18n
2022-07-28 18:04:44 +00:00
lang ??= language as T
2022-07-25 09:02:08 +00:00
2022-07-28 18:04:44 +00:00
return {
relativeSitePaths: relativeSitePaths[lang],
absoluteSitePaths: absoluteSitePaths[lang],
}
2022-07-25 09:02:08 +00:00
}
type SitePath = { [key: string]: string | SitePath } & { index: string }
type SitePathBuilt<T extends SitePath, Root extends string = ''> = {
[K in keyof T]: T[K] extends string
? K extends 'index'
2022-07-25 09:02:08 +00:00
? `${Root}${T[K]}` extends ''
? '/'
: `${Root}${T[K]}`
: T extends { index: string }
2022-07-25 09:02:08 +00:00
? `${Root}${T['index']}/${T[K]}`
: `${Root}${T[K]}`
: SitePathBuilt<
T[K] extends SitePath ? T[K] : never,
2022-07-25 09:02:08 +00:00
T extends { index: string } ? `${Root}${T['index']}/` : `${Root}`
>
🔥 Migration vers TypeScript Outils ====== Ce commit retire le tooling de Flow, et ajoute le support de TypeScript pour les fichiers .ts et .tsx. Il n'est pas nécessaire de tout migrer d'un coup ce qui facilite la transition. On garde en effet le compilateur Babel avec un preset TypeScript (ce qui permet donc de retirer à la fois les types Flow et TypeScript) plutôt que d'utiliser le compilateur standard pour la conversion du code. Cela permet aussi de mieux s'intégrer avec d'autres outils, notamment les test-runners. Ajout d'une nouvelle commande `yarn run type-check`, intégrée dans CircleCI. Par ailleurs ajout du support de l'opérateur ?? pour donner des valeurs par défaut (nullish-coalescing-operator). Typage des libraires tierces ============================ Les principales libraires que nous utilisons ont un typage TypeScript de bon niveau, ce qui facilite l'intégration. J'ai mis à jour react-i18next et i18next afin de corriger un problème de typage. Typage du code ============== Le typage est loin d'être complet dans ce commit, en particulier il manque les types relatifs au state Redux, ainsi qu'au moteur (règle, explication). Néanmoins le typage des contextes fonctionne, en particulier sitePaths (avec un type récursif non trivial !) qui a déjà permis de détecter un lien mort. Le typage des "paths" (Components/, Règles/, etc.) fonctionne bien, y compris avec l'auto-complétion automatique des import par Typescript. TypeScript se révèle déjà bien agréable dans VSCode (auto-complétion, refacto, etc.) ! Reste à migrer progressivement le reste du code !
2019-10-26 16:21:09 +00:00
}
2022-07-28 18:04:44 +00:00
function constructAbsoluteSitePaths<T extends SitePath>(
obj: T,
root = ''
): SitePathBuilt<T> {
const { index } = obj
const entries = Object.entries(obj)
2022-03-28 12:57:11 +00:00
return Object.fromEntries(
entries.map(([k, value]) => [
k,
typeof value === 'string'
? root + (k === 'index' ? value : index + '/' + value) || '/'
2022-07-28 18:04:44 +00:00
: constructAbsoluteSitePaths(value, root + index + '/'),
])
) as SitePathBuilt<T>
}
2022-06-13 11:07:46 +00:00
type Obj = { [k: string]: string | Obj }
const deepReduce = (
fn: (acc: string[], val: string, key: string) => string[],
initialValue: string[],
object: Obj
): string[] =>
Object.entries(object).reduce(
(acc, [key, value]) =>
typeof value === 'object'
? deepReduce(fn, acc, value)
: fn(acc, value, key),
initialValue
)
type SiteMap = Array<string>
2022-03-28 12:57:11 +00:00
2022-07-28 18:04:44 +00:00
export const generateSiteMap = (sitePaths: AbsoluteSitePaths): SiteMap =>
deepReduce(
2022-06-13 11:07:46 +00:00
(paths: Array<string>, path: string) =>
/\/:/.test(path) ? paths : [...paths, ...[path]],
[],
sitePaths
)
2023-04-11 17:37:43 +00:00
export const alternatePathname = () => {
type Lang = 'fr' | 'en'
type Sitepath = { [k: string]: string | Sitepath }
type LangSitepath = { [k in Lang]: string }
type Return = { [k: string]: LangSitepath | Return }
const buildSitemap = (
lang: Lang,
sitePath: Sitepath,
initialValue: Return = {}
): Return =>
Object.entries(sitePath).reduce(
(acc, [key, path]): Return =>
typeof path === 'object'
? { ...acc, [key]: buildSitemap(lang, path, acc[key] as Return) }
: ({ ...acc, [key]: { ...acc[key], [lang]: path } } as Return),
initialValue
)
const buildPathname = (
sitemap: Return,
initialValue: Record<Lang, Record<string, string>> = { fr: {}, en: {} }
) =>
Object.values(sitemap).reduce(
(acc, obj): Record<Lang, Record<string, string>> =>
typeof obj === 'object' && ('fr' in obj || 'en' in obj)
? {
fr: {
...acc.fr,
...('fr' in obj
? { [obj.fr as string]: (obj.en || obj.fr) as string }
: null),
},
en: {
...acc.en,
...('en' in obj
? { [obj.en as string]: (obj.fr || obj.en) as string }
: null),
},
}
: buildPathname(obj, acc),
initialValue
)
return buildPathname(
buildSitemap(
'en',
absoluteSitePaths.en,
buildSitemap('fr', absoluteSitePaths.fr)
)
2022-06-13 11:07:46 +00:00
)
}