refactor: update license handling across dataset models and transformers

Author: g-saracca

src/datasets/domain/models/Dataset.ts

@@ -1,4 +1,5 @@
 import { DvObjectOwnerNode } from '../../../core/domain/models/DvObjectOwnerNode'
+import { License } from '../../../licenses'
 
 export interface Dataset {
   id: number
@@ -32,11 +33,7 @@ export enum DatasetVersionState {
   DEACCESSIONED = 'DEACCESSIONED'
 }
 
-export interface DatasetLicense {
-  name: string
-  uri: string
-  iconUri?: string
-}
+export type DatasetLicense = Pick<License, 'name' | 'uri' | 'iconUri'>
 
 export interface CustomTerms {
   termsOfUse: string

src/datasets/domain/models/DatasetTemplate.ts

@@ -1,4 +1,5 @@
-import { DatasetLicense, DatasetMetadataBlock, TermsOfUse } from './Dataset'
+import { DatasetMetadataBlock, TermsOfUse } from './Dataset'
+import { License } from '../../../licenses/domain/models/License'
 
 export interface DatasetTemplate {
   id: number
@@ -13,7 +14,7 @@ export interface DatasetTemplate {
   instructions: DatasetTemplateInstruction[]
   // 👇 From Edit Template Terms
   termsOfUse: TermsOfUse
-  license?: DatasetLicense // This license property is going to be present if not custom terms are added in the UI
+  license?: License // This license property is going to be present if not custom terms are added in the UI
 }
 
 export interface DatasetTemplateInstruction {

src/datasets/infra/repositories/transformers/DatasetPayload.ts

@@ -13,7 +13,7 @@ export interface DatasetPayload {
   lastUpdateTime: string
   releaseTime: string
   metadataBlocks: MetadataBlocksPayload
-  license?: LicensePayload
+  license?: DatasetLicensePayload
   alternativePersistentId?: string
   publicationDate?: string
   citationDate?: string
@@ -38,7 +38,7 @@ export interface DatasetPayload {
   deaccessionNote?: string
 }
 
-export interface LicensePayload {
+export interface DatasetLicensePayload {
   name: string
   uri: string
   iconUri?: string

src/datasets/infra/repositories/transformers/DatasetTemplatePayload.ts

@@ -1,3 +1,4 @@
+import { LicensePayload } from '../../../../licenses/domain/repositories/transformers/LicensePayload'
 import { MetadataFieldPayload } from './DatasetPayload'
 
 export interface DatasetTemplatePayload {
@@ -16,20 +17,7 @@ export interface DatasetTemplatePayload {
     id: number
     fileAccessRequest: boolean
     // This license property is going to be present if not custom terms are added in the UI
-    license?: {
-      id: number
-      name: string
-      shortDescription: string
-      uri: string
-      iconUrl?: string
-      active: boolean
-      isDefault: boolean
-      sortOrder: number
-      rightsIdentifier: string
-      rightsIdentifierScheme?: string
-      schemeUri: string
-      languageCode: string
-    }
+    license?: LicensePayload
     // Below fields are going to be present if are added in "Restricted Files + Terms of Access"
     termsOfAccess?: string // This is terms of access for restricted files in the JSF UI
     dataAccessPlace?: string

src/datasets/infra/repositories/transformers/datasetTemplateTransformers.ts

@@ -1,3 +1,4 @@
+import { transformPayloadLicenseToLicense } from '../../../../licenses/domain/repositories/transformers/licenseTransformers'
 import { DatasetTemplate } from '../../../domain/models/DatasetTemplate'
 import { DatasetTemplatePayload } from './DatasetTemplatePayload'
 import { transformPayloadToDatasetMetadataBlocks } from './datasetTransformers'
@@ -34,11 +35,9 @@ export const transformDatasetTemplatePayloadToDatasetTemplate = (
     }
 
     if (payload.termsOfUseAndAccess.license) {
-      datasetTemplate.license = {
-        name: payload.termsOfUseAndAccess.license.name,
-        uri: payload.termsOfUseAndAccess.license.uri,
-        iconUri: payload.termsOfUseAndAccess.license.iconUrl
-      }
+      datasetTemplate.license = transformPayloadLicenseToLicense(
+        payload.termsOfUseAndAccess.license
+      )
     } else {
       datasetTemplate.termsOfUse.customTerms = {
         termsOfUse: payload.termsOfUseAndAccess.termsOfUse as string,

src/datasets/infra/repositories/transformers/datasetTransformers.ts

@@ -11,7 +11,7 @@ import {
 import { AxiosResponse } from 'axios'
 import {
   DatasetPayload,
-  LicensePayload,
+  DatasetLicensePayload,
   MetadataFieldPayload,
   MetadataBlocksPayload,
   MetadataFieldValuePayload,
@@ -261,7 +261,7 @@ export const transformVersionPayloadToDataset = (
   }
   if ('license' in versionPayload) {
     datasetModel.license = transformPayloadToDatasetLicense(
-      versionPayload.license as LicensePayload
+      versionPayload.license as DatasetLicensePayload
     )
   } else {
     datasetModel.termsOfUse.customTerms = {
@@ -297,7 +297,7 @@ export const transformVersionPayloadToDataset = (
 }
 
 const transformPayloadToDatasetLicense = (
-  licensePayload: LicensePayload
+  licensePayload: DatasetLicensePayload
 ): DatasetLicense | undefined => {
   if (!licensePayload) {
     return undefined

src/licenses/domain/repositories/transformers/licenseTransformers.ts

@@ -2,21 +2,23 @@ import { AxiosResponse } from 'axios'
 import { License } from '../../models/License'
 import { LicensePayload } from './LicensePayload'
 
-export const transformPayloadToLicense = (response: AxiosResponse): License[] => {
+export const transformPayloadToLicenses = (response: AxiosResponse): License[] => {
   const payload = response.data.data as LicensePayload[]
 
-  return payload.map((license: LicensePayload) => ({
-    id: license.id,
-    name: license.name,
-    shortDescription: license.shortDescription,
-    uri: license.uri,
-    iconUri: license.iconUrl, // in payload, it is called iconUrl, but iconUri is the name matching everywhere else
-    active: license.active,
-    isDefault: license.isDefault,
-    sortOrder: license.sortOrder,
-    rightsIdentifier: license.rightsIdentifier,
-    rightsIdentifierScheme: license.rightsIdentifierScheme,
-    schemeUri: license.schemeUri,
-    languageCode: license.languageCode
-  }))
+  return payload.map((license: LicensePayload) => transformPayloadLicenseToLicense(license))
 }
+
+export const transformPayloadLicenseToLicense = (license: LicensePayload): License => ({
+  id: license.id,
+  name: license.name,
+  shortDescription: license.shortDescription,
+  uri: license.uri,
+  iconUri: license.iconUrl, // in payload, it is called iconUrl, but iconUri is the name matching everywhere else
+  active: license.active,
+  isDefault: license.isDefault,
+  sortOrder: license.sortOrder,
+  rightsIdentifier: license.rightsIdentifier,
+  rightsIdentifierScheme: license.rightsIdentifierScheme,
+  schemeUri: license.schemeUri,
+  languageCode: license.languageCode
+})

src/licenses/infra/repositories/LicensesRepository.ts

@@ -1,14 +1,14 @@
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ILicensesRepository } from '../../domain/repositories/ILicensesRepository'
 import { License } from '../../domain/models/License'
-import { transformPayloadToLicense } from '../../domain/repositories/transformers/licenseTransformers'
+import { transformPayloadToLicenses } from '../../domain/repositories/transformers/licenseTransformers'
 
 export class LicensesRepository extends ApiRepository implements ILicensesRepository {
   private readonly licensesResourceName: string = 'licenses'
 
   public async getAvailableStandardLicenses(): Promise<License[]> {
     return this.doGet(this.buildApiEndpoint(this.licensesResourceName))
-      .then((response) => transformPayloadToLicense(response))
+      .then((response) => transformPayloadToLicenses(response))
       .catch((error) => {
         throw error
       })