feat(source): add CNLL source

refs: #360

Author: guillermau

api/src/core/adapters/CNLL/getExternalData.ts

@@ -0,0 +1,71 @@
+import memoize from "memoizee";
+
+import { GetSoftwareExternalData, SoftwareExternalData } from "../../ports/GetSoftwareExternalData";
+import { Source } from "../../usecases/readWriteSillData";
+import { SchemaOrganization } from "../dbApi/kysely/kysely.database";
+import { identifersUtils } from "../../utils";
+import { getCnllPrestatairesSill } from "../getCnllPrestatairesSill";
+import { CnllPrestatairesSill } from "../../ports/GetCnllPrestatairesSill";
+
+export const getCNLLSoftwareExternalData: GetSoftwareExternalData = memoize(
+    async ({
+        externalId,
+        source
+    }: {
+        externalId: string;
+        source: Source;
+    }): Promise<SoftwareExternalData | undefined> => {
+        if (source.kind !== "CNLL") throw new Error("This source if not compatible with CNLL Adapter");
+
+        const cNLLProviders = await getCnllPrestatairesSill();
+
+        const providersForExternalId = cNLLProviders.find(element => element.sill_id.toString() === externalId);
+
+        if (!providersForExternalId) return undefined;
+
+        return formatCNLLProvidersToExternalData(providersForExternalId, source);
+    }
+);
+
+const cNLLproviderToCMProdivers = (provider: CnllPrestatairesSill.Prestataire): SchemaOrganization => {
+    return {
+        "@type": "Organization" as const,
+        name: provider.nom,
+        url: provider.url ?? undefined,
+        identifiers: [
+            identifersUtils.makeSIRENIdentifier({
+                SIREN: provider.siren,
+                additionalType: "Organization"
+            })
+        ]
+    };
+};
+
+const formatCNLLProvidersToExternalData = (
+    cNLLProdivers: CnllPrestatairesSill,
+    source: Source
+): SoftwareExternalData => ({
+    externalId: cNLLProdivers.sill_id.toString(),
+    sourceSlug: source.slug,
+    developers: [],
+    label: { "fr": cNLLProdivers.nom },
+    description: { "fr": "" },
+    isLibreSoftware: true,
+    logoUrl: undefined,
+    websiteUrl: undefined,
+    sourceUrl: undefined,
+    documentationUrl: undefined,
+    license: undefined,
+    softwareVersion: undefined,
+    keywords: [],
+    programmingLanguages: [],
+    applicationCategories: [],
+    publicationTime: undefined,
+    referencePublications: [],
+    identifiers: [
+        identifersUtils.makeCNLLIdentifier({
+            cNNLId: cNLLProdivers.sill_id.toString()
+        })
+    ],
+    providers: cNLLProdivers.prestataires.map(prodiver => cNLLproviderToCMProdivers(prodiver))
+});

api/src/core/adapters/dbApi/kysely/kysely.database.ts

@@ -114,7 +114,7 @@ type InstancesTable = {
 };
 
 type ExternalId = string;
-export type ExternalDataOriginKind = "wikidata" | "HAL" | "ComptoirDuLibre";
+export type ExternalDataOriginKind = "wikidata" | "HAL" | "ComptoirDuLibre" | "CNLL";
 type LocalizedString = Partial<Record<string, string>>;
 
 type SimilarExternalSoftwareExternalDataTable = {

api/src/core/adapters/dbApi/kysely/migrations/1747296861930-add_source_CNLL.ts

@@ -0,0 +1,35 @@
+import { sql, type Kysely } from "kysely";
+
+export async function up(db: Kysely<any>): Promise<void> {
+    await db.schema
+        .alterTable("sources")
+        .alterColumn("kind", col => col.setDataType("text"))
+        .execute();
+
+    await db.schema.dropType("external_data_origin_type").execute();
+    await db.schema.createType("external_data_origin_type").asEnum(["wikidata", "HAL", "ComptoirDuLibre", "CNLL"]).execute();
+
+    await db.schema
+        .alterTable("sources")
+        .alterColumn("kind", col =>
+            col.setDataType(sql`external_data_origin_type USING kind::external_data_origin_type`)
+        )
+        .execute();
+}
+
+export async function down(db: Kysely<any>): Promise<void> {
+    await db.schema
+        .alterTable("sources")
+        .alterColumn("kind", col => col.setDataType("text"))
+        .execute();
+
+    await db.schema.dropType("external_data_origin_type").execute();
+    await db.schema.createType("external_data_origin_type").asEnum(["wikidata", "HAL", "ComptoirDuLibre"]).execute();
+
+    await db.schema
+        .alterTable("sources")
+        .alterColumn("kind", col =>
+            col.setDataType(sql`external_data_origin_type USING kind::external_data_origin_type`)
+        )
+        .execute();
+}

api/src/core/utils.ts

@@ -58,6 +58,13 @@ export const orcidSource: WebSite = {
     additionalType: "ORCID"
 };
 
+export const nationalSIREN: WebSite = {
+    "@type": "Website" as const,
+    name: "L’Annuaire des Entreprises",
+    url: new URL("https://annuaire-entreprises.data.gouv.fr"),
+    additionalType: "SIREN"
+};
+
 export const identifersUtils = {
     makeGenericIdentifier: (params: { value: string; url?: string | URL }): SchemaIdentifier => {
         const { value, url } = params;
@@ -112,12 +119,12 @@ export const identifersUtils = {
             ...(additionalType ? { additionalType: additionalType } : {})
         };
     },
-    makeCNLLIdentifier: (params: { cNNLId: string; url: string; additionalType?: string }): SchemaIdentifier => {
+    makeCNLLIdentifier: (params: { cNNLId: string; url?: string; additionalType?: string }): SchemaIdentifier => {
         const { cNNLId, url, additionalType } = params;
         return {
             "@type": "PropertyValue" as const,
             value: cNNLId,
-            url: url,
+            url: url ?? undefined,
             subjectOf: cNNLSource,
             ...(additionalType ? { additionalType: additionalType } : {})
         };
@@ -168,6 +175,18 @@ export const identifersUtils = {
             subjectOf: orcidSource,
             ...(additionalType ? { additionalType: additionalType } : {})
         };
+    },
+    makeSIRENIdentifier: (params: { SIREN: string; additionalType?: string; url?: string }) => {
+        const { SIREN, additionalType, url } = params;
+        return {
+            ...{
+                "@type": "PropertyValue" as const,
+                value: SIREN,
+                url: url ?? undefined,
+                subjectOf: nationalSIREN
+            },
+            ...(additionalType ? { additionalType: additionalType } : {})
+        };
     }
 };