feat(metadata): replaced crossref with ror

Author: nsemets

src/app/core/interceptors/auth.interceptor.ts

@@ -13,7 +13,7 @@ export const authInterceptor: HttpInterceptorFn = (
 
   const csrfToken = cookieService.get('api-csrf');
 
-  if (!req.url.includes('/api.crossref.org/funders')) {
+  if (!req.url.includes('/api.ror')) {
     const headers: Record<string, string> = {};
 
     headers['Accept'] = req.responseType === 'text' ? '*/*' : 'application/vnd.api+json;version=2.20';

src/app/features/metadata/dialogs/funding-dialog/funding-dialog.component.html

@@ -10,13 +10,13 @@
           <p-select
             [id]="'funderName-' + $index"
             formControlName="funderName"
-            [options]="funderOptions()"
-            optionLabel="label"
-            optionValue="value"
+            [options]="fundersList()"
+            optionLabel="name"
+            optionValue="name"
             [placeholder]="'project.metadata.funding.dialog.selectFunder' | translate"
             class="w-full"
             [filter]="true"
-            filterBy="label"
+            filterBy="name"
             [showClear]="true"
             [loading]="fundersLoading()"
             [emptyFilterMessage]="filterMessage() | translate"

src/app/features/metadata/dialogs/funding-dialog/funding-dialog.component.spec.ts

@@ -5,14 +5,16 @@ import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog';
 import { DestroyRef } from '@angular/core';
 import { ComponentFixture, TestBed } from '@angular/core/testing';
 
+import { RorFunderOption } from '../../models/ror.model';
 import { MetadataSelectors } from '../../store';
 
 import { FundingDialogComponent } from './funding-dialog.component';
 
-import { MOCK_FUNDERS } from '@testing/mocks/funder.mock';
 import { OSFTestingModule } from '@testing/osf.testing.module';
 import { provideMockStore } from '@testing/providers/store-provider.mock';
 
+const MOCK_ROR_FUNDERS: RorFunderOption[] = [{ id: 'https://ror.org/0test', name: 'Test Funder' }];
+
 describe('FundingDialogComponent', () => {
   let component: FundingDialogComponent;
   let fixture: ComponentFixture<FundingDialogComponent>;
@@ -25,7 +27,7 @@ describe('FundingDialogComponent', () => {
         MockProvider(DynamicDialogConfig, { data: { funders: [] } }),
         provideMockStore({
           signals: [
-            { selector: MetadataSelectors.getFundersList, value: MOCK_FUNDERS },
+            { selector: MetadataSelectors.getFundersList, value: MOCK_ROR_FUNDERS },
             { selector: MetadataSelectors.getFundersLoading, value: false },
           ],
         }),
@@ -145,6 +147,16 @@ describe('FundingDialogComponent', () => {
     expect(entry.get('funderIdentifierType')?.value).toBe(initialValues.funderIdentifierType);
   });
 
+  it('should update funding entry when funder is selected from ROR list', () => {
+    const entry = component.fundingEntries.at(0);
+
+    component.onFunderSelected('Test Funder', 0);
+
+    expect(entry.get('funderName')?.value).toBe('Test Funder');
+    expect(entry.get('funderIdentifier')?.value).toBe('https://ror.org/0test');
+    expect(entry.get('funderIdentifierType')?.value).toBe('ROR ID');
+  });
+
   it('should remove funding entry when more than one exists', () => {
     component.addFundingEntry();
     expect(component.fundingEntries.length).toBe(2);

src/app/features/metadata/dialogs/funding-dialog/funding-dialog.component.ts

@@ -33,15 +33,6 @@ export class FundingDialogComponent implements OnInit {
 
   fundersList = select(MetadataSelectors.getFundersList);
   fundersLoading = select(MetadataSelectors.getFundersLoading);
-  funderOptions = computed(() => {
-    const funders = this.fundersList() || [];
-    return funders.map((funder) => ({
-      label: funder.name,
-      value: funder.name,
-      id: funder.id,
-      uri: funder.uri,
-    }));
-  });
 
   fundingForm = new FormGroup<FundingForm>({ fundingEntries: new FormArray<FormGroup<FundingEntryForm>>([]) });
 
@@ -132,8 +123,8 @@ export class FundingDialogComponent implements OnInit {
       const entry = this.fundingEntries.at(index);
       entry.patchValue({
         funderName: selectedFunder.name,
-        funderIdentifier: selectedFunder.uri,
-        funderIdentifierType: 'Crossref Funder ID',
+        funderIdentifier: selectedFunder.id,
+        funderIdentifierType: 'ROR',
       });
     }
   }

src/app/features/metadata/mappers/index.ts

@@ -1,2 +1,3 @@
 export * from './cedar-records.mapper';
 export * from './metadata.mapper';
+export * from './ror.mapper';

src/app/features/metadata/mappers/ror.mapper.ts

@@ -0,0 +1,19 @@
+import { RorFunderOption, RorOrganization, RorSearchResponse } from '../models/ror.model';
+
+export class RorMapper {
+  static toFunderOptions(response: RorSearchResponse): RorFunderOption[] {
+    return response.items.map((org) => ({
+      id: org.id,
+      name: this.getRorDisplayName(org),
+    }));
+  }
+
+  static getRorDisplayName(org: RorOrganization): string {
+    const rorDisplay = org.names?.find((n) => n.types?.includes('ror_display'));
+    if (rorDisplay?.value) return rorDisplay.value;
+    const label = org.names?.find((n) => n.types?.includes('label'));
+    if (label?.value) return label.value;
+    if (org.names?.length && org.names[0].value) return org.names[0].value;
+    return org.id ?? '';
+  }
+}

src/app/features/metadata/models/index.ts

@@ -5,3 +5,4 @@ export * from './funding-dialog.model';
 export * from './metadata.model';
 export * from './metadata-json-api.model';
 export * from './resource-information-form.model';
+export * from './ror.model';

src/app/features/metadata/models/metadata.model.ts

@@ -40,33 +40,3 @@ export interface Funder {
   awardUri: string;
   awardTitle: string;
 }
-
-export interface CrossRefFundersResponse {
-  status: string;
-  'message-type': string;
-  'message-version': string;
-  message: CrossRefFundersMessage;
-}
-
-export interface CrossRefFundersMessage {
-  'items-per-page': number;
-  query: CrossRefQuery;
-  'total-results': number;
-  items: CrossRefFunder[];
-}
-
-export interface CrossRefQuery {
-  'start-index': number;
-  'search-terms': string | null;
-}
-
-export interface CrossRefFunder {
-  id: string;
-  location: string;
-  name: string;
-  'alt-names': string[];
-  uri: string;
-  replaces: string[];
-  'replaced-by': string[];
-  tokens: string[];
-}

src/app/features/metadata/models/ror.model.ts

@@ -0,0 +1,111 @@
+export interface RorAdmin {
+  created: {
+    date: string;
+    schema_version: string;
+  };
+  last_modified: {
+    date: string;
+    schema_version: string;
+  };
+}
+
+export interface RorExternalId {
+  all: string[];
+  preferred: string | null;
+  type: 'grid' | 'fundref' | 'isni' | 'wikidata';
+}
+
+export interface RorLink {
+  type: 'website' | 'wikipedia';
+  value: string;
+}
+
+export interface RorGeonamesDetails {
+  continent_code: string;
+  continent_name: string;
+  country_code: string;
+  country_name: string;
+  country_subdivision_code: string;
+  country_subdivision_name: string;
+  lat: number;
+  lng: number;
+  name: string;
+}
+
+export interface RorLocation {
+  geonames_details: RorGeonamesDetails;
+  geonames_id: number;
+}
+
+export interface RorName {
+  lang: string | null;
+  types: ('ror_display' | 'label' | 'alias' | 'acronym')[];
+  value: string;
+}
+
+export interface RorRelationship {
+  type: string;
+  id: string;
+  label: string;
+}
+
+export interface RorOrganization {
+  id: string;
+  admin: RorAdmin;
+  domains: string[];
+  established: number | null;
+  external_ids: RorExternalId[];
+  links: RorLink[];
+  locations: RorLocation[];
+  names: RorName[];
+  relationships: RorRelationship[];
+  status: 'active' | 'inactive' | 'withdrawn';
+  types: (
+    | 'education'
+    | 'healthcare'
+    | 'company'
+    | 'archive'
+    | 'nonprofit'
+    | 'government'
+    | 'facility'
+    | 'other'
+    | 'funder'
+  )[];
+}
+
+export interface RorMetaCount {
+  id: string;
+  title: string;
+  count: number;
+}
+
+export interface RorMeta {
+  types: RorMetaCount[];
+  countries: RorMetaCount[];
+  continents: RorMetaCount[];
+  statuses: RorMetaCount[];
+}
+
+export interface RorSearchResponse {
+  items: RorOrganization[];
+  meta: RorMeta;
+  number_of_results: number;
+  time_taken: number;
+}
+
+export interface RorFunderOption {
+  id: string;
+  name: string;
+}
+
+export interface RorDisplayData {
+  id: string;
+  displayName: string;
+  acronym?: string;
+  type: string;
+  country: string;
+  city: string;
+  established?: number;
+  website?: string;
+  status: string;
+}

src/app/features/metadata/services/metadata.service.ts

@@ -10,7 +10,7 @@ import { LicenseOptions } from '@osf/shared/models/license/license.model';
 import { BaseNodeAttributesJsonApi } from '@osf/shared/models/nodes/base-node-attributes-json-api.model';
 import { JsonApiService } from '@osf/shared/services/json-api.service';
 
-import { CedarRecordsMapper, MetadataMapper } from '../mappers';
+import { CedarRecordsMapper, MetadataMapper, RorMapper } from '../mappers';
 import {
   CedarMetadataRecord,
   CedarMetadataRecordJsonApi,
@@ -21,7 +21,8 @@ import {
   MetadataJsonApi,
   MetadataJsonApiResponse,
 } from '../models';
-import { CrossRefFundersResponse, CustomItemMetadataRecord, MetadataModel } from '../models/metadata.model';
+import { CustomItemMetadataRecord, MetadataModel } from '../models/metadata.model';
+import { RorFunderOption, RorSearchResponse } from '../models/ror.model';
 
 @Injectable({
   providedIn: 'root',
@@ -78,14 +79,14 @@ export class MetadataService {
     );
   }
 
-  getFundersList(searchQuery?: string): Observable<CrossRefFundersResponse> {
-    let url = `${this.funderApiUrl}funders?mailto=support%40osf.io`;
+  getFundersList(searchQuery?: string): Observable<RorFunderOption[]> {
+    let url = `${this.funderApiUrl}/organizations?filter=types:funder`;
 
     if (searchQuery && searchQuery.trim()) {
       url += `&query=${encodeURIComponent(searchQuery.trim())}`;
     }
 
-    return this.jsonApiService.get<CrossRefFundersResponse>(url);
+    return this.jsonApiService.get<RorSearchResponse>(url).pipe(map((response) => RorMapper.toFunderOptions(response)));
   }
 
   getMetadataCedarTemplates(url?: string): Observable<CedarMetadataTemplateJsonApi> {