refactor(api-type): change identifier type

refs: #296

# Conflicts:
#    api/src/core/utils.ts

Author: guillermau

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

@@ -14,13 +14,13 @@ export type ArticleIdentifierOrigin = "doi" | "arxiv" | "HAL";
 
 // from https://schema.org/PropertyValue
 export interface ArticleIdentifier extends SchemaIdentifier {
-    subjectOf: WebSite<ArticleIdentifierOrigin>;
+    subjectOf: WebSite;
     additionalType: "Article";
 }
 
 export type OrganizationIdentifierOrigin = "wikidata" | "HAL";
 export interface OrganizationIdentifer extends SchemaIdentifier {
-    subjectOf: WebSite<OrganizationIdentifierOrigin>;
+    subjectOf: WebSite;
     additionalType: "Organization";
 }
 
@@ -43,12 +43,12 @@ export type SchemaPerson = {
 };
 
 // from https://schema.org/WebSite
-export type WebSite<T> = {
+export type WebSite = {
     "@type": "Website";
     name: string; // Name of the website or database
     description?: string;
     url: URL; // Name of the website or database
-    additionalType?: T; // Type of the database
+    additionalType?: string; // Type of the database
 };
 
 // from https://schema.org/identifier & https://schema.org/PropertyValue
@@ -58,7 +58,7 @@ export type SchemaIdentifier = {
     value: string; // Value of the property
     url?: string | URL; // Url to direct access to the element on the database
     valueReference?: string; // Value of the instance / database
-    subjectOf?: WebSite<any>; // Value of the instance / database
+    subjectOf?: WebSite; // Value of the instance / database
     additionalType?: string; // Organization | Article | Person | ...
 };
 

api/src/core/adapters/hal/CrossRef/getScholarlyArticle.ts

@@ -1,5 +1,5 @@
-import { SILL } from "../../../../types/SILL";
 import { GetScholarlyArticle } from "../../../ports/GetScholarlyArticle";
+import { identifersUtils } from "../../../utils";
 import { crossRef } from "./api";
 
 export const getScholarlyArticle: GetScholarlyArticle = async doi => {
@@ -15,16 +15,7 @@ export const getScholarlyArticle: GetScholarlyArticle = async doi => {
     return {
         "@id": workData.message.DOI,
         "@type": "ScholarlyArticle",
-        identifiers: [
-            {
-                "@type": "PropertyValue",
-                name: "DOI id",
-                url: new URL(`https://doi.org/${doi}`),
-                value: workData.message.DOI,
-                additionalType: "Article",
-                subjectOf: SILL.doiSource
-            }
-        ],
+        identifiers: [identifersUtils.makeArticleDOIIdentifier({ doi: workData.message.DOI })],
         headline: workData.message.title[0]
     };
 };

api/src/core/adapters/hal/getHalSoftwareExternalData.ts

@@ -1,19 +1,13 @@
 import memoize from "memoizee";
 import { JSDOM } from "jsdom";
-import { SILL } from "../../../types/SILL";
 import { GetSoftwareExternalData, SoftwareExternalData } from "../../ports/GetSoftwareExternalData";
 import { Source } from "../../usecases/readWriteSillData";
 import { halAPIGateway } from "./HalAPI";
 import { HAL } from "./HalAPI/types/HAL";
 import { crossRefSource } from "./CrossRef";
 import { getScholarlyArticle } from "./getScholarlyArticle";
-import {
-    SchemaIdentifier,
-    SchemaOrganization,
-    SchemaPerson,
-    ScholarlyArticle,
-    WebSite
-} from "../dbApi/kysely/kysely.database";
+import { SchemaIdentifier, SchemaOrganization, SchemaPerson, ScholarlyArticle } from "../dbApi/kysely/kysely.database";
+import { identifersUtils } from "../../utils";
 
 const buildParentOrganizationTree = async (
     structureIdArray: number[] | string[] | undefined
@@ -76,27 +70,6 @@ const resolveStructId = (parsedXMLLabel: JSDOM, structAcronym: string) => {
     return Number(org[0].getAttribute("xml:id")?.split("-")[1]);
 };
 
-const HALSource: WebSite<SILL.SourceKind> = {
-    "@type": "Website" as const,
-    name: "HAL instance",
-    url: new URL("https://hal.science"),
-    additionalType: "HAL"
-};
-
-const SWHSource: WebSite<SILL.SourceKind> = {
-    "@type": "Website" as const,
-    name: "Software Heritage instance",
-    url: new URL("https://www.softwareheritage.org/"),
-    additionalType: "SWH"
-};
-
-const DOISource: WebSite<SILL.SourceKind> = {
-    "@type": "Website" as const,
-    name: "DOI instance",
-    url: new URL("https://www.doi.org"),
-    additionalType: "doi"
-};
-
 export const getHalSoftwareExternalData: GetSoftwareExternalData = memoize(
     async ({
         externalId,
@@ -131,7 +104,7 @@ export const getHalSoftwareExternalData: GetSoftwareExternalData = memoize(
         const authors = await Promise.all(
             codemetaSoftware.author.map(async role => {
                 const author = role.author;
-                const id = author?.["@id"]?.[0];
+                const id = author?.["@id"]?.[0] ?? "fuck that shit";
                 const affiliation = author.affiliation;
 
                 if (!id) throw new Error("Could find the author id");
@@ -189,19 +162,30 @@ export const getHalSoftwareExternalData: GetSoftwareExternalData = memoize(
         );
 
         const identifiers: SchemaIdentifier[] =
-            codemetaSoftware?.identifier?.map(halIdentifier => {
+            codemetaSoftware?.identifier?.map(identifierItem => {
                 const base = {
                     "@type": "PropertyValue" as const,
-                    value: halIdentifier.value,
-                    url: new URL(halIdentifier.propertyID)
+                    value: identifierItem.value,
+                    url: new URL(identifierItem.propertyID)
                 };
-                switch (halIdentifier["@type"]) {
+                switch (identifierItem["@type"]) {
                     case "hal":
-                        return { ...base, subjectOf: HALSource };
+                        return identifersUtils.makeHALIdentifier({
+                            halId: identifierItem.value,
+                            additionalType: "Software",
+                            url: identifierItem.propertyID
+                        });
                     case "swhid":
-                        return { ...base, subjectOf: SWHSource };
+                        return identifersUtils.makeSWHIdentifier({
+                            swhId: identifierItem.value,
+                            additionalType: "Software",
+                            url: identifierItem.propertyID
+                        });
                     case "doi":
-                        return { ...base, subjectOf: DOISource };
+                        return identifersUtils.makeDOIIdentifier({
+                            doi: identifierItem.value,
+                            additionalType: "Software"
+                        });
                     case "bibcode":
                     case "cern":
                     case "prodinra":

api/src/core/adapters/hal/getScholarlyArticle.ts

@@ -1,5 +1,5 @@
-import { SILL } from "../../../types/SILL";
 import { GetScholarlyArticle } from "../../ports/GetScholarlyArticle";
+import { identifersUtils } from "../../utils";
 import { halAPIGateway } from "./HalAPI";
 
 export const getScholarlyArticle: GetScholarlyArticle = async halDocId => {
@@ -15,16 +15,7 @@ export const getScholarlyArticle: GetScholarlyArticle = async halDocId => {
     return {
         "@id": halDocId,
         "@type": "ScholarlyArticle",
-        identifiers: [
-            {
-                "@type": "PropertyValue",
-                name: "DOI id",
-                url: new URL(`https://hal.science/${halDocId}`),
-                value: halDocId,
-                additionalType: "Article",
-                subjectOf: SILL.halSource
-            }
-        ],
+        identifiers: [identifersUtils.makeHALArticleIdentifier({ halId: halDocId })],
         headline: articleData.en_title_s?.[0] ?? articleData.fr_title_s?.[0] ?? articleData.title_s[0]
     };
 };

api/src/core/adapters/wikidata/getWikidataSoftware.ts

@@ -23,9 +23,9 @@ import {
     wikidataTimeToJSDate,
     WikidataTime
 } from "../../../tools/WikidataEntity";
-import { SILL } from "../../../types/SILL";
 import { Source } from "../../usecases/readWriteSillData";
-import { SchemaIdentifier, SchemaOrganization, SchemaPerson } from "../dbApi/kysely/kysely.database";
+import { SchemaOrganization, SchemaPerson } from "../dbApi/kysely/kysely.database";
+import { identifersUtils } from "../../utils";
 
 const { resolveLocalizedString } = createResolveLocalizedString({
     "currentLanguage": id<Language>("en"),
@@ -120,16 +120,6 @@ export const getWikidataSoftware: GetSoftwareExternalData = memoize(
 
         const framaLibreId = getClaimDataValue<"string">("P4107")[0];
 
-        const makeFramaIndentifer = (framaLibreId: string): SchemaIdentifier => {
-            return {
-                "@type": "PropertyValue",
-                name: "ID of FramaLibre",
-                value: framaLibreId,
-                url: new URL(framaLibreId),
-                subjectOf: SILL.framaLibreSource
-            };
-        };
-
         return {
             externalId,
             sourceSlug: source.slug,
@@ -256,13 +246,10 @@ export const getWikidataSoftware: GetSoftwareExternalData = memoize(
                             "@type": "Person",
                             name,
                             identifiers: [
-                                {
-                                    value: entity.id,
-                                    "@type": "PropertyValue",
-                                    url: `https://www.wikidata.org/wiki/${entity.id}`,
-                                    subjectOf: SILL.wikidataSource,
-                                    name: "Wikidata Id"
-                                }
+                                identifersUtils.makeWikidataIdentifier({
+                                    wikidataId: entity.id,
+                                    additionalType: "Person"
+                                })
                             ],
                             url: `https://www.wikidata.org/wiki/${entity.id}`
                         };
@@ -272,14 +259,10 @@ export const getWikidataSoftware: GetSoftwareExternalData = memoize(
                         "@type": "Organization",
                         name,
                         identifiers: [
-                            {
-                                value: entity.id,
-                                "@type": "PropertyValue",
-                                url: `https://www.wikidata.org/wiki/${entity.id}`,
-                                subjectOf: SILL.wikidataSource,
-                                name: "Wikidata Id",
+                            identifersUtils.makeWikidataIdentifier({
+                                wikidataId: entity.id,
                                 additionalType: "Organization"
-                            }
+                            })
                         ],
                         url: `https://www.wikidata.org/wiki/${entity.id}`
                     };
@@ -301,7 +284,13 @@ export const getWikidataSoftware: GetSoftwareExternalData = memoize(
             applicationCategories: undefined, // doesn't exit on wiki data
             referencePublications: undefined, // doesn't exit on wiki data
             publicationTime: publicationTimeDate,
-            identifiers: framaLibreId?.includes("https") ? [makeFramaIndentifer(framaLibreId)] : []
+            identifiers: [
+                ...(framaLibreId
+                    ? [identifersUtils.makeFramaIndentifier({ framaLibreId, additionalType: "Software" })]
+                    : []),
+                identifersUtils.makeWikidataIdentifier({ wikidataId: externalId, additionalType: "Software" })
+            ],
+            providers: []
         };
     },
     {