fix: name fixes, types, configs

guillermau · guillermau · commit bf6738f31687 · 2025-05-19T10:41:40.000+02:00
refs: #295
diff --git a/api/src/core/adapters/comptoirDuLibre/getCDLExternalData.ts b/api/src/core/adapters/comptoirDuLibre/getCDLExternalData.ts
@@ -5,7 +5,7 @@ import { Source } from "../../usecases/readWriteSillData";
 import { comptoirDuLibreApi } from "../comptoirDuLibreApi";
 import { ComptoirDuLibre } from "../../ports/ComptoirDuLibreApi";
 import { SchemaOrganization } from "../dbApi/kysely/kysely.database";
-import { identifersUtils } from "../../utils";
+import { identifersUtils } from "../../../tools/identifiersTools";
 
 export const getCDLSoftwareExternalData: GetSoftwareExternalData = memoize(
     async ({
@@ -22,10 +22,13 @@ export const getCDLSoftwareExternalData: GetSoftwareExternalData = memoize(
         if (!comptoirSoftware) return undefined;
 
         return formatCDLSoftwareToExternalData(comptoirSoftware, source);
+    },
+    {
+        maxAge: 3 * 3600 * 1000
     }
 );
 
-const cDLproviderToCMProdivers = (provider: ComptoirDuLibre.Provider): SchemaOrganization => {
+const cdlProviderToCMProdivers = (provider: ComptoirDuLibre.Provider): SchemaOrganization => {
     return {
         "@type": "Organization" as const,
         name: provider.name,
@@ -41,26 +44,26 @@ const cDLproviderToCMProdivers = (provider: ComptoirDuLibre.Provider): SchemaOrg
 };
 
 const formatCDLSoftwareToExternalData = (
-    cDLSoftwareItem: ComptoirDuLibre.Software,
+    cdlSoftwareItem: ComptoirDuLibre.Software,
     source: Source
 ): SoftwareExternalData => {
-    const splittedCNLLUrl = !Array.isArray(cDLSoftwareItem.external_resources.cnll)
-        ? cDLSoftwareItem.external_resources.cnll.url.split("/")
+    const splittedCNLLUrl = !Array.isArray(cdlSoftwareItem.external_resources.cnll)
+        ? cdlSoftwareItem.external_resources.cnll.url.split("/")
         : undefined;
 
     return {
-        externalId: cDLSoftwareItem.id.toString(),
+        externalId: cdlSoftwareItem.id.toString(),
         sourceSlug: source.slug,
         developers: [],
-        label: { "fr": cDLSoftwareItem.name },
+        label: { "fr": cdlSoftwareItem.name },
         description: { "fr": "" },
         isLibreSoftware: true,
         //
         logoUrl: undefined, // Use scrapper ?
-        websiteUrl: cDLSoftwareItem.external_resources.website ?? undefined,
-        sourceUrl: cDLSoftwareItem.external_resources.repository ?? undefined,
+        websiteUrl: cdlSoftwareItem.external_resources.website ?? undefined,
+        sourceUrl: cdlSoftwareItem.external_resources.repository ?? undefined,
         documentationUrl: undefined,
-        license: cDLSoftwareItem.licence,
+        license: cdlSoftwareItem.licence,
         softwareVersion: undefined,
         keywords: [],
         programmingLanguages: [],
@@ -69,37 +72,37 @@ const formatCDLSoftwareToExternalData = (
         referencePublications: [],
         identifiers: [
             identifersUtils.makeCDLIdentifier({
-                cdlId: cDLSoftwareItem.id.toString(),
-                url: cDLSoftwareItem.url,
+                cdlId: cdlSoftwareItem.id.toString(),
+                url: cdlSoftwareItem.url,
                 additionalType: "Software"
             }),
-            ...(!Array.isArray(cDLSoftwareItem.external_resources.cnll) && splittedCNLLUrl
+            ...(!Array.isArray(cdlSoftwareItem.external_resources.cnll) && splittedCNLLUrl
                 ? [
                       identifersUtils.makeCNLLIdentifier({
                           cNNLId: splittedCNLLUrl[splittedCNLLUrl.length - 1],
-                          url: cDLSoftwareItem.external_resources.cnll.url
+                          url: cdlSoftwareItem.external_resources.cnll.url
                       })
                   ]
                 : []),
-            ...(!Array.isArray(cDLSoftwareItem.external_resources.framalibre)
+            ...(!Array.isArray(cdlSoftwareItem.external_resources.framalibre)
                 ? [
                       identifersUtils.makeFramaIndentifier({
-                          framaLibreId: cDLSoftwareItem.external_resources.framalibre.slug,
-                          url: cDLSoftwareItem.external_resources.framalibre.url,
+                          framaLibreId: cdlSoftwareItem.external_resources.framalibre.slug,
+                          url: cdlSoftwareItem.external_resources.framalibre.url,
                           additionalType: "Software"
                       })
                   ]
                 : []),
-            ...(!Array.isArray(cDLSoftwareItem.external_resources.wikidata)
+            ...(!Array.isArray(cdlSoftwareItem.external_resources.wikidata)
                 ? [
                       identifersUtils.makeWikidataIdentifier({
-                          wikidataId: cDLSoftwareItem.external_resources.wikidata.id,
-                          url: cDLSoftwareItem.external_resources.wikidata.url,
+                          wikidataId: cdlSoftwareItem.external_resources.wikidata.id,
+                          url: cdlSoftwareItem.external_resources.wikidata.url,
                           additionalType: "Software"
                       })
                   ]
                 : [])
         ],
-        providers: cDLSoftwareItem.providers.map(prodiver => cDLproviderToCMProdivers(prodiver))
+        providers: cdlSoftwareItem.providers.map(prodiver => cdlProviderToCMProdivers(prodiver))
     };
 };
diff --git a/api/src/core/adapters/comptoirDuLibre/getCDLSoftwareOptions.ts b/api/src/core/adapters/comptoirDuLibre/getCDLSoftwareOptions.ts
@@ -9,25 +9,25 @@ import { ComptoirDuLibre } from "../../ports/ComptoirDuLibreApi";
 
 export const rawCDLSoftwareToExternalOption =
     ({ source }: { language: Language; source: Source }) =>
-    (cDLSoftware: ComptoirDuLibre.Software): SoftwareExternalDataOption => {
+    (cdlSoftware: ComptoirDuLibre.Software): SoftwareExternalDataOption => {
         return {
-            externalId: cDLSoftware.id.toString(),
-            label: cDLSoftware.name,
+            externalId: cdlSoftware.id.toString(),
+            label: cdlSoftware.name,
             description: "",
             isLibreSoftware: true,
             sourceSlug: source.slug
         };
     };
 
-// HAL documentation is here : https://api.archives-ouvertes.fr/docs/search
-
 export const getCDLSoftwareOptions: GetSoftwareExternalDataOptions = async ({ queryString, language, source }) => {
     if (source.kind !== "ComptoirDuLibre") throw new Error(`Not a Comptoir Du Libre source, was : ${source.kind}`);
 
-    const comptoirAPi = await comptoirDuLibreApi.getComptoirDuLibre();
-    const comptoirSoftware = comptoirAPi.softwares.filter(softwareItem => softwareItem.name.includes(queryString));
+    const { softwares: cdlAllSoftwarePackages } = await comptoirDuLibreApi.getComptoirDuLibre();
+    const comptoirSoftwarePackage = cdlAllSoftwarePackages.filter(softwareItem =>
+        softwareItem.name.includes(queryString)
+    );
 
-    if (!comptoirSoftware) return [];
+    if (!comptoirSoftwarePackage) return [];
 
-    return comptoirSoftware.map(rawCDLSoftwareToExternalOption({ language, source }));
+    return comptoirSoftwarePackage.map(rawCDLSoftwareToExternalOption({ language, source }));
 };
diff --git a/api/src/core/adapters/comptoirDuLibreApi.ts b/api/src/core/adapters/comptoirDuLibreApi.ts
@@ -29,7 +29,10 @@ export const comptoirDuLibreApi: ComptoirDuLibreApi = {
                 };
             }
         },
-        { "promise": true }
+        {
+            "promise": true,
+            maxAge: 3 * 3600 * 1000
+        }
     ),
     "getIconUrl": async ({ comptoirDuLibreId }) => {
         let imgSrc: string | undefined;
diff --git a/api/src/core/adapters/dbApi/kysely/kysely.database.ts b/api/src/core/adapters/dbApi/kysely/kysely.database.ts
@@ -240,11 +240,11 @@ export namespace PgComptoirDuLibre {
         external_resources: {
             website: string | null;
             repository: string | null;
-            wikidata: WikidataIdentifier | any[];
-            sill: SILLIdentifier | any[];
-            wikipedia: WikipediaIdentifier | any[];
-            cnll: CNLLIdentifier | any[];
-            framalibre: FramaLibreIdentifier | any[];
+            wikidata: WikidataIdentifier | never[];
+            sill: SILLIdentifier | never[];
+            wikipedia: WikipediaIdentifier | never[];
+            cnll: CNLLIdentifier | never[];
+            framalibre: FramaLibreIdentifier | never[];
         };
         providers: Provider[];
         users: User[];
diff --git a/api/src/core/ports/ComptoirDuLibreApi.ts b/api/src/core/ports/ComptoirDuLibreApi.ts
@@ -48,11 +48,11 @@ export declare namespace ComptoirDuLibre {
         external_resources: {
             website: string | null;
             repository: string | null;
-            wikidata: WikidataIdentifier | any[];
-            sill: SILLIdentifier | any[];
-            wikipedia: WikipediaIdentifier | any[];
-            cnll: CNLLIdentifier | any[];
-            framalibre: FramaLibreIdentifier | any[];
+            wikidata: WikidataIdentifier | never[];
+            sill: SILLIdentifier | never[];
+            wikipedia: WikipediaIdentifier | never[];
+            cnll: CNLLIdentifier | never[];
+            framalibre: FramaLibreIdentifier | never[];
         };
         providers: Provider[];
         users: User[];
@@ -169,11 +169,11 @@ export const { zComptoirDuLibre } = (() => {
         "external_resources": z.object({
             "website": z.union([z.string(), z.null()]),
             "repository": z.union([z.string(), z.null()]),
-            "wikidata": z.any(),
-            "sill": z.any(),
-            "wikipedia": z.any(),
-            "cnll": z.any(),
-            "framalibre": z.any()
+            "wikidata": zWikidataIdentifier.or(z.array(z.never()).max(0)),
+            "sill": zSILLIdentifier.or(z.array(z.never()).max(0)),
+            "wikipedia": zWikipediaIdentifier.or(z.array(z.never()).max(0)),
+            "cnll": zCNLLIdentifier.or(z.array(z.never()).max(0)),
+            "framalibre": zFramaLibreIdentifier.or(z.array(z.never()).max(0))
         }),
         "providers": z.array(zProvider),
         "users": z.array(zUser)
diff --git a/api/src/tools/identifiersTools.ts b/api/src/tools/identifiersTools.ts
@@ -1,6 +1,6 @@
 import { ArticleIdentifier, SchemaIdentifier, WebSite } from "../core/adapters/dbApi/kysely/kysely.database";
 
-const cNNLSource: WebSite = {
+const cnllSource: WebSite = {
     "@type": "Website" as const,
     name: "Union des entreprises du logiciel libre et du numérique ouvert",
     url: new URL("https://cnll.fr"),
@@ -35,14 +35,14 @@ const wikidataSource: WebSite = {
     additionalType: "wikidata"
 };
 
-const cDLSource: WebSite = {
+const cdlSource: WebSite = {
     "@type": "Website" as const,
     name: "Comptoir du libre",
     url: new URL("https://comptoir-du-libre.org"),
     additionalType: "ComptoirDuLibre"
 };
 
-const sWHSource: WebSite = {
+const swhSource: WebSite = {
     "@type": "Website" as const,
     name: "Software Heritage instance",
     url: new URL("https://www.softwareheritage.org/"),
@@ -106,7 +106,7 @@ export const identifersUtils = {
             additionalType: "Organization",
             value: cdlId,
             url: url,
-            subjectOf: cDLSource,
+            subjectOf: cdlSource,
             ...(additionalType ? { additionalType: additionalType } : {})
         };
     },
@@ -116,7 +116,7 @@ export const identifersUtils = {
             "@type": "PropertyValue" as const,
             value: cNNLId,
             url: url,
-            subjectOf: cNNLSource,
+            subjectOf: cnllSource,
             ...(additionalType ? { additionalType: additionalType } : {})
         };
     },
@@ -153,7 +153,7 @@ export const identifersUtils = {
             "@type": "PropertyValue" as const,
             value: swhId,
             url: url,
-            subjectOf: sWHSource,
+            subjectOf: swhSource,
             ...(additionalType ? { additionalType: additionalType } : {})
         };
     },
diff --git a/api/src/tools/test.helpers.ts b/api/src/tools/test.helpers.ts
@@ -3,7 +3,7 @@ import { Db } from "../core/ports/DbApi";
 import { DeclarationFormData, InstanceFormData, SoftwareFormData, Source } from "../core/usecases/readWriteSillData";
 import { Kysely } from "kysely";
 import { Database } from "../core/adapters/dbApi/kysely/kysely.database";
-import { ExternalDataOrigin } from "../lib/ApiTypes";
+import { ExternalDataOriginKind } from "../lib/ApiTypes";
 
 export const testPgUrl = "postgresql://sill:pg_password@localhost:5432/sill";
 
@@ -149,7 +149,7 @@ export const resetDB = async (db: Kysely<Database>) => {
         .insertInto("sources")
         .values({
             ...testSource,
-            kind: testSource.kind as ExternalDataOrigin
+            kind: testSource.kind as ExternalDataOriginKind
         })
         .execute();
 };
