@proconnect-gouv/proconnect.identite 1.0.0

package/src/services/postgres/index.ts

@@ -0,0 +1,3 @@
+//
+
+export * from "./hash-to-postgres-params.js";

package/src/types/claims.ts

@@ -0,0 +1,21 @@
+//
+
+import { z } from "zod";
+
+//
+
+export const UserClaimsSchema = z.object({
+  email_verified: z.boolean(),
+  email: z.string(),
+  family_name: z.string().optional(),
+  given_name: z.string().optional(),
+  job: z.string().optional(),
+  phone_number_verified: z.boolean(),
+  phone_number: z.string().optional(),
+  sub: z.string(),
+  uid: z.string(),
+  updated_at: z.date(),
+  usual_name: z.string().optional(),
+});
+
+export type UserClaims = z.output<typeof UserClaimsSchema>;

package/src/types/contexts.ts

@@ -0,0 +1,9 @@
+//
+
+import Pg from "pg";
+
+//
+
+export type DatabaseContext = {
+  pg: Pg.Pool;
+};

package/src/types/dirigeant.ts

@@ -0,0 +1,13 @@
+//
+
+import { z } from "zod";
+
+//
+
+export const IdentityVectorSchema = z.object({
+  birthdate: z.date().nullable(),
+  birthplace: z.string().nullable(),
+  family_name: z.string().nullable(),
+  given_name: z.string().nullable(),
+});
+export type IdentityVector = z.output<typeof IdentityVectorSchema>;

package/src/types/email-domain.ts

@@ -0,0 +1,48 @@
+//
+
+import { z } from "zod";
+
+//
+
+export const EMAIL_DOMAIN_APPROVED_VERIFICATION_TYPES = z.enum([
+  "official_contact",
+  "trackdechets_postal_mail",
+  "verified",
+]);
+
+export type EmailDomainApprovedVerificationType = z.output<
+  typeof EMAIL_DOMAIN_APPROVED_VERIFICATION_TYPES
+>;
+
+//
+
+export const EMAIL_DOMAIN_REJECTED_VERIFICATION_TYPES = z.enum([
+  "blacklisted", // unused
+  "external", // domain used by external employees (eg. ext.numerique.gouv.fr)
+  "refused",
+]);
+
+export type EmailDomainRejectedVerificationType = z.output<
+  typeof EMAIL_DOMAIN_REJECTED_VERIFICATION_TYPES
+>;
+
+//
+
+export type EmailDomainVerificationType =
+  | EmailDomainApprovedVerificationType
+  | EmailDomainRejectedVerificationType
+  | null; // domain is not verified, but users are still permitted to use it
+
+export interface EmailDomain {
+  id: number;
+  organization_id: number;
+  domain: string;
+  verification_type: EmailDomainVerificationType;
+  // Unused.
+  can_be_suggested: boolean;
+  // Can be updated when verification_type changes.
+  // In practice, entries are deleted and recreated rather than updated directly
+  verified_at: Date | null;
+  created_at: Date;
+  updated_at: Date;
+}

package/src/types/franceconnect.ts

@@ -0,0 +1,37 @@
+//
+
+import { z } from "zod";
+
+//
+
+/**
+ * @see https://docs.partenaires.franceconnect.gouv.fr/fs/fs-technique/fs-technique-scope-fc/#liste-des-claims
+ */
+export const FranceConnectUserInfoResponseSchema = z.object({
+  birthdate: z.coerce.date(),
+  birthplace: z.string(),
+  family_name: z.string(),
+  gender: z.string(),
+  given_name: z.string(),
+  preferred_username: z.string().optional(),
+  sub: z.string(),
+  // NOTE(douglasduteil): the following ignore extra keys (aud, given_name_array)
+});
+
+export type FranceConnectUserInfoResponse = z.output<
+  typeof FranceConnectUserInfoResponseSchema
+>;
+
+//
+
+export const FranceConnectUserInfoSchema =
+  FranceConnectUserInfoResponseSchema.merge(
+    z.object({
+      created_at: z.coerce.date(),
+      updated_at: z.coerce.date(),
+      user_id: z.number(),
+    }),
+  );
+export type FranceConnectUserInfo = z.output<
+  typeof FranceConnectUserInfoSchema
+>;

package/src/types/index.ts

@@ -0,0 +1,11 @@
+//
+
+export * from "./claims.js";
+export * from "./contexts.js";
+export * from "./dirigeant.js";
+export * from "./email-domain.js";
+export * from "./franceconnect.js";
+export * from "./organization-info.js";
+export * from "./organization.js";
+export * from "./user-organization-link.js";
+export * from "./user.js";

package/src/types/organization-info.ts

@@ -0,0 +1,32 @@
+//
+import type { TrancheEffectifs } from "@proconnect-gouv/proconnect.entreprise/types";
+import { z } from "zod";
+
+//
+
+export const OrganizationInfoSchema = z.object({
+  activitePrincipale: z.string(),
+  adresse: z.string(),
+  categorieJuridique: z.string(),
+  codeOfficielGeographique: z.string(),
+  codePostal: z.string().nullable(),
+  enseigne: z.string(),
+  estActive: z.boolean(),
+  estDiffusible: z.boolean(),
+  etatAdministratif: z.string(),
+  libelle: z.string(),
+  libelleActivitePrincipale: z.string(),
+  libelleCategorieJuridique: z.string(),
+  libelleTrancheEffectif: z.string(),
+  nomComplet: z.string(),
+  siret: z.string(),
+  statutDiffusion: z.enum([
+    "diffusible",
+    "partiellement_diffusible",
+    "non_diffusible",
+  ]),
+  trancheEffectifs: z.custom<TrancheEffectifs | null>().nullable(),
+  trancheEffectifsUniteLegale: z.string().nullable(),
+});
+
+export type OrganizationInfo = z.output<typeof OrganizationInfoSchema>;

package/src/types/organization.ts

@@ -0,0 +1,30 @@
+//
+
+import type { TrancheEffectifs } from "@proconnect-gouv/proconnect.entreprise/types";
+
+//
+
+export interface Organization {
+  id: number;
+  siret: string;
+  created_at: Date;
+  updated_at: Date;
+  cached_libelle: string | null;
+  cached_nom_complet: string | null;
+  cached_enseigne: string | null;
+  cached_tranche_effectifs: TrancheEffectifs;
+  cached_tranche_effectifs_unite_legale: string | null;
+  cached_libelle_tranche_effectif: string | null;
+  cached_etat_administratif: string | null;
+  cached_est_active: string | null;
+  cached_statut_diffusion: string | null;
+  cached_est_diffusible: string | null;
+  cached_adresse: string | null;
+  cached_code_postal: string | null;
+  cached_code_officiel_geographique: string | null;
+  cached_activite_principale: string | null;
+  cached_libelle_activite_principale: string | null;
+  cached_categorie_juridique: string | null;
+  cached_libelle_categorie_juridique: string | null;
+  organization_info_fetched_at: Date | null;
+}

package/src/types/user-organization-link.ts

@@ -0,0 +1,71 @@
+import { z } from "zod";
+
+export const UserOrganizationLinkVerificationTypeSchema = z.enum([
+  "code_sent_to_official_contact_email",
+  "domain",
+  "imported_from_coop_mediation_numerique",
+  "imported_from_inclusion_connect",
+  "in_liste_dirigeants_rna",
+  "in_liste_dirigeants_rne",
+  "no_validation_means_available",
+  "no_verification_means_for_entreprise_unipersonnelle",
+  "no_verification_means_for_small_association",
+  "official_contact_email",
+  "organization_dirigeant",
+  "proof_received",
+  // Used in the sandbox environment to bypass the verification process
+  "bypassed",
+]);
+
+export type UserOrganizationLinkVerificationType = z.output<
+  typeof UserOrganizationLinkVerificationTypeSchema
+>;
+
+//
+
+export const BaseUserOrganizationLinkSchema = z.object({
+  is_external: z.boolean(),
+  verification_type: UserOrganizationLinkVerificationTypeSchema.nullable(),
+  // updated when verification_type is changed
+  verified_at: z.date().or(z.literal(null)),
+  has_been_greeted: z.boolean(),
+  needs_official_contact_email_verification: z.boolean(),
+  official_contact_email_verification_token: z.string().nullable(),
+  official_contact_email_verification_sent_at: z.date().nullable(),
+});
+
+export type BaseUserOrganizationLink = z.output<
+  typeof BaseUserOrganizationLinkSchema
+>;
+
+//
+
+export const UserOrganizationLinkSchema = BaseUserOrganizationLinkSchema.extend(
+  {
+    user_id: z.number(),
+    organization_id: z.number(),
+    created_at: z.date(),
+    updated_at: z.date(),
+  },
+);
+
+export type UserOrganizationLink = z.output<typeof UserOrganizationLinkSchema>;
+
+//
+
+export const InsertUserOrganizationLinkSchema = UserOrganizationLinkSchema.pick(
+  {
+    organization_id: true,
+    user_id: true,
+    verification_type: true,
+  },
+).merge(
+  UserOrganizationLinkSchema.pick({
+    is_external: true,
+    needs_official_contact_email_verification: true,
+  }).partial(),
+);
+
+export type InsertUserOrganizationLink = z.output<
+  typeof InsertUserOrganizationLinkSchema
+>;

package/src/types/user.ts

@@ -0,0 +1,29 @@
+//
+
+export interface User {
+  created_at: Date;
+  current_challenge: string | null;
+  email_verified_at: Date | null;
+  email_verified: boolean;
+  email: string;
+  encrypted_password: string | null;
+  encrypted_totp_key: string | null;
+  family_name: string | null;
+  force_2fa: boolean;
+  given_name: string | null;
+  id: number;
+  job: string | null;
+  last_sign_in_at: Date | null;
+  magic_link_sent_at: Date | null;
+  magic_link_token: string | null;
+  needs_inclusionconnect_onboarding_help: boolean;
+  needs_inclusionconnect_welcome_page: boolean;
+  phone_number: string | null;
+  reset_password_sent_at: Date | null;
+  reset_password_token: string | null;
+  sign_in_count: number;
+  totp_key_verified_at: Date | null;
+  updated_at: Date;
+  verify_email_sent_at: Date | null;
+  verify_email_token: string | null;
+}

package/testing/index.ts

@@ -0,0 +1,31 @@
+//
+
+import { PGlite } from "@electric-sql/pglite";
+import { noop } from "lodash-es";
+import { runner } from "node-pg-migrate";
+import { join } from "path";
+
+//
+
+export const pg = new PGlite();
+
+export function migrate() {
+  return runner({
+    dbClient: pg as any,
+    dir: join(import.meta.dirname, "../../../migrations"),
+    direction: "up",
+    migrationsTable: "pg-migrate",
+    log: noop,
+  });
+}
+
+export async function emptyDatabase() {
+  await pg.sql`delete from users_organizations;`;
+  //
+  await pg.sql`delete from organizations;`;
+  await pg.sql`ALTER SEQUENCE organizations_id_seq RESTART WITH 1`;
+  await pg.sql`delete from users;`;
+  await pg.sql`ALTER SEQUENCE users_id_seq RESTART WITH 1`;
+  await pg.sql`delete from email_domains;`;
+  await pg.sql`ALTER SEQUENCE email_domains_id_seq RESTART WITH 1`;
+}

package/testing/seed/franceconnect/index.ts

@@ -0,0 +1,40 @@
+import type { FranceConnectUserInfo } from "#src/types";
+
+export const LiElJonsonFranceConnectUserInfo: FranceConnectUserInfo = {
+  birthdate: new Date(29000, 10, 7),
+  birthplace: "Caliban",
+  created_at: new Date("4444-04-04"),
+  family_name: "El’Jonson",
+  gender: "male",
+  given_name: "Li",
+  preferred_username: "Li",
+  sub: "abcdefghijklmnopqrstuvwxyz",
+  updated_at: new Date("4444-04-05"),
+  user_id: NaN,
+};
+
+export const BelisariusCawlFranceConnectUserInfo: FranceConnectUserInfo = {
+  birthdate: new Date(28500, 1, 5),
+  birthplace: "MARS",
+  created_at: new Date("2023-04-10"),
+  family_name: "CAWL",
+  gender: "male",
+  given_name: "BELISARIUS",
+  preferred_username: "Archmagos",
+  sub: "belisariuscawlmechanicusdominus67890",
+  updated_at: new Date(),
+  user_id: NaN,
+};
+
+export const RogalDornFranceConnectUserInfo: FranceConnectUserInfo = {
+  birthdate: new Date(29000, 0, 7),
+  birthplace: "INWIT",
+  created_at: new Date("2023-04-10"),
+  family_name: "DORN",
+  gender: "male",
+  given_name: "ROGAL",
+  preferred_username: "FortressionPrimarch",
+  sub: "IMP7777777",
+  updated_at: new Date(),
+  user_id: NaN,
+};

package/testing/seed/insee/index.ts

@@ -0,0 +1,22 @@
+//
+
+import type { InseeSiretEstablishment } from "@proconnect-gouv/proconnect.insee/types";
+
+//
+export const LiElJonsonEstablishment: InseeSiretEstablishment = {
+  uniteLegale: {
+    codeCommuneNaissanceUniteLegale: "INW",
+    dateNaissanceUniteLegale: "285000205",
+    nomUniteLegale: "EL'JONSON",
+    prenom1UniteLegale: "LION",
+  },
+};
+
+export const RogalDornEstablishment: InseeSiretEstablishment = {
+  uniteLegale: {
+    codeCommuneNaissanceUniteLegale: "INWIT",
+    dateNaissanceUniteLegale: "290000107",
+    nomUniteLegale: "DORN",
+    prenom1UniteLegale: "ROGAL",
+  },
+};

package/testing/seed/mandataires/index.ts

@@ -0,0 +1,32 @@
+//
+
+import type { InfogreffeSirenMandatairesSociaux } from "@proconnect-gouv/proconnect.entreprise/types";
+
+//
+
+export const UlysseToriMandataire: InfogreffeSirenMandatairesSociaux = {
+  code_nationalite: "FR",
+  code_pays_naissance: "FR",
+  date_naissance_timestamp: 715824000000,
+  date_naissance: "1992-09-07",
+  fonction: "DIRIGEANT",
+  lieu_naissance: "Internet",
+  nationalite: "Française",
+  nom: "TOSI",
+  pays_naissance: "FRANCE",
+  prenom: "Ulysse",
+  type: "personne_physique",
+};
+export const RogalDornMandataire: InfogreffeSirenMandatairesSociaux = {
+  code_nationalite: "IM",
+  code_pays_naissance: "IM",
+  date_naissance_timestamp: 852984946800000,
+  date_naissance: "29000-01-07",
+  fonction: "Primarch",
+  lieu_naissance: "INWIT",
+  nationalite: "IMPERIAL",
+  nom: "DORN",
+  pays_naissance: "IMPERIUM",
+  prenom: "ROGAL",
+  type: "personne_physique",
+};

package/testing/seed/organizations/index.ts

@@ -0,0 +1,41 @@
+//
+
+import type { Organization } from "#src/types";
+
+//
+
+export const association_org_info = {
+  siret: "83511518900010",
+  cached_tranche_effectifs: "00",
+  cached_tranche_effectifs_unite_legale: "00",
+  cached_libelle_tranche_effectif:
+    "0 salarié (n'ayant pas d'effectif au 31/12 mais ayant employé des salariés au cours de l'année de référence), en 2020",
+  cached_activite_principale: "81.21Z",
+  cached_libelle_activite_principale:
+    "81.21Z - Nettoyage courant des bâtiments",
+  cached_categorie_juridique: "9220",
+  cached_libelle_categorie_juridique: "Association déclarée",
+} as Organization;
+
+export const small_association_org_info = {
+  siret: "39399933900046",
+  cached_tranche_effectifs: "12",
+  cached_tranche_effectifs_unite_legale: "12",
+  cached_libelle_tranche_effectif: "20 à 49 salariés, en 2022",
+  cached_activite_principale: "84.13Z",
+  cached_libelle_activite_principale:
+    "84.13Z - Administration publique (tutelle) des activités économiques",
+  cached_categorie_juridique: "9220",
+  cached_libelle_categorie_juridique: "Association déclarée",
+} as Organization;
+
+export const entreprise_unipersonnelle_org_info = {
+  siret: "82869625200018",
+  cached_tranche_effectifs: null,
+  cached_tranche_effectifs_unite_legale: null,
+  cached_libelle_tranche_effectif: null,
+  cached_activite_principale: "62.01Z",
+  cached_libelle_activite_principale: "62.01Z - Programmation informatique",
+  cached_categorie_juridique: "1000",
+  cached_libelle_categorie_juridique: "Entrepreneur individuel",
+} as Organization;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "resolveJsonModule": true,
+    "types": ["node"]
+  },
+  "extends": "@proconnect-gouv/proconnect.devtools.typescript/base/tsconfig.json",
+  "references": [
+    { "path": "../core/tsconfig.lib.json" },
+    { "path": "../entreprise/tsconfig.lib.json" },
+    { "path": "../insee/tsconfig.lib.json" }
+  ],
+  "include": ["./src/**/*", "./src/**/*.json", "testing"]
+}

package/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "exclude": ["src/**/*.test.ts", "testing"],
+  "extends": "./tsconfig.json",
+  "include": ["src"]
+}