# Les marques et les cartes du planning

Les types et les fonctions des marques et des cartes du planning, générés à partir du code.


:::note[Page générée]
Cette page est générée à partir des types et des fonctions de `lib/modules/marques.ts` et `lib/modules/planning.ts` par TypeDoc 0.28.20. Ne la modifiez pas ici : modifiez le code.
:::

Le planning reçoit de chaque module ouvert des marques sur les personnes et des cartes à poser. Le cœur les rassemble sans connaître le module : il ne découpe jamais l'identifiant d'une carte. Voir [les portes](/modules/portes/).

## MarqueDuPlanning

Une marque du planning : une information sur une personne pour un jour, fournie par un module.

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `employe_id` | `string` | oui |  |
| `jour` | `string` | oui |  |
| `texte` | `string` | oui |  |
| `gravite` | `"info" \| "attention" \| "urgent"` | oui |  |
| `module` | `string` | oui |  |

## marquesParPersonneEtJour

Les marques rangées par personne puis par jour, dans l'ordre où les modules les ont rendues.

```ts
function marquesParPersonneEtJour(
  marques: readonly MarqueDuPlanning[] | null | undefined,
): Record<string, Record<string, MarqueDuPlanning[]>>
```

## CarteDUnModule

Une carte que le module propose de poser.

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `module` | `string` | oui |  |
| `type` | `string` | oui |  |
| `id` | `string` | oui |  |
| `numero` | `string` | oui |  |
| `libelle` | `string` | oui |  |
| `client` | `string` | oui |  |
| `atelier` | `boolean` | oui |  |
| `famille` | `string` | non | Le groupe d'« À planifier » qui la prend : le `contenu` d'un groupe du réglage. |
| `genre` | `{ … }` | non | Le sous-groupe où elle se range dans sa famille, dans l'ordre. |
| `recherche` | `string` | non |  |
| `ensemble` | `boolean` | non | Une carte qui en rassemble d'autres : son bord le dit. |
| `posable` | `boolean` | non | Le module accepte que ce compte la pose ; la base le revérifie. |

## CaseDUnModule

Ce que le module dit d'une case qui porte un de ses objets.

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `numero` | `string` | non |  |
| `texte` | `string` | non | Le texte entier de la case, qui passe devant son libellé. |
| `reference` | `string` | non | Le repère écrit sur la barre. |
| `activite_fixe` | `boolean` | non | L'activité vient du module : le planning ne la change pas. |
| `marques` | `{ … }[]` | non |  |
| `lien` | `{ … }` | non |  |

## Facette

Un axe de filtre des personnes : ses valeurs, et celles que chaque personne porte.

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `code` | `string` | oui |  |
| `libelle` | `string` | oui | Le nom de l'axe, en minuscules : « Filtrer par compétence ». |
| `valeurs` | `{ … }[]` | oui |  |
| `personnes` | `Record<string, string[]>` | oui |  |

## GesteDeCarte

Un geste du panneau : un lien (`href`), ou une route qui reçoit les cartes cochées des types listés (`modele`, où `{ids}` est remplacé).

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `code` | `string` | oui |  |
| `libelle` | `string` | oui |  |
| `href` | `string` | non |  |
| `modele` | `string` | non |  |
| `types` | `string[]` | non |  |
| `bouton` | `string` | non | Le verbe du bouton qui ouvre la route avec les cartes cochées, et ce qu'il compte : « Grouper » 2 « intervention ». |
| `objet` | `string` | non |  |
| `annuler` | `string` | non | Le lien qui sort du geste sans rien faire : « ne pas grouper ». |

## DonneesDUnModule

| Propriété | Type | Obligatoire | Rôle |
| --- | --- | --- | --- |
| `familles` | `string[]` | non | Les contenus d'« À planifier » qui prennent ses cartes. |
| `cartes` | `CarteDUnModule[]` | non |  |
| `cases` | `Record<string, CaseDUnModule>` | non |  |
| `facettes` | `Facette[]` | non |  |
| `gestes` | `GesteDeCarte & { … }[]` | non |  |

## idDeCarte

L'identifiant d'une carte de module sur la grille : opaque, il ne se découpe pas.

```ts
function idDeCarte(c: { id: string; module: string; type: string }): string
```

## objetDeLaCase

Ce que vise une case : l'objet de module qu'elle porte, ou rien.

```ts
function objetDeLaCase(
  c: { objet_module?: string | null; objet_type?: string | null; objet_id?: string | null },
): string | null
```

## lesDonneesDesModules

Les données de tous les modules ouverts, mises ensemble : les cartes et les gestes à la suite, les cases fusionnées.

```ts
function lesDonneesDesModules(
  modules: Record<string, DonneesDUnModule | null> | null | undefined,
): { cartes: CarteDUnModule[]; cases: Record<string, CaseDUnModule>; facettes: Facette[]; familles: string[]; gestes: GesteDeCarte & { module: string }[] }
```
