Merge develop into fea/352-external-tool-use-cases

Author: g-saracca

docs/useCases.md

@@ -89,8 +89,16 @@ The different use cases currently available in the package are classified below,
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
   - [Get ZIP Download Limit](#get-zip-download-limit)
   - [Get Application Terms of Use](#get-application-terms-of-use)
+  - [Get Available Dataset Metadata Export Formats](#get-available-dataset-metadata-export-formats)
+- [Licenses](#Licenses)
+  - [Get Available Standard License Terms](#get-available-standard-license-terms)
 - [Contact](#Contact)
   - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
+- [Notifications](#Notifications)
+  - [Get All Notifications by User](#get-all-notifications-by-user)
+  - [Delete Notification](#delete-notification)
+  - [Get Unread Count](#get-unread-count)
+  - [Mark As Read](#mark-as-read)
 - [Search](#Search)
   - [Get Search Services](#get-search-services)
 - [External Tools](#external-tools)
@@ -2089,6 +2097,51 @@ getApplicationTermsOfUse.execute().then((termsOfUse: string) => {
 
 _See [use case](../src/info/domain/useCases/GetApplicationTermsOfUse.ts) implementation_.
 
+#### Get Available Dataset Metadata Export Formats
+
+Returns a [DatasetMetadataExportFormats](../src/info/domain/models/DatasetMetadataExportFormats.ts) object containing the available dataset metadata export formats.
+
+##### Example call:
+
+```typescript
+import {
+  getAvailableDatasetMetadataExportFormats,
+  DatasetMetadataExportFormats
+} from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAvailableDatasetMetadataExportFormats
+  .execute()
+  .then((datasetMetadataExportFormats: DatasetMetadataExportFormats) => {
+    /* ... */
+  })
+
+/* ... */
+```
+
+_See [use case](../src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts) implementation_.
+
+## Licenses
+
+### Get Available Standard License Terms
+
+Returns a list of available standard licenses that can be selected for a dataset.
+
+##### Example call:
+
+```typescript
+import { getAvailableStandardLicenses, License } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAvailableStandardLicenses.execute().then((licenses: License[]) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/licenses/domain/useCases/GetAvailableStandardLicenses.ts) implementation_.
+
 ## Contact
 
 #### Send Feedback to Object Contacts
@@ -2126,6 +2179,92 @@ In ContactDTO, it takes the following information:
 - **body**: the email body to send.
 - **fromEmail**: the email to list in the reply-to field.
 
+## Notifications
+
+#### Get All Notifications by User
+
+Returns a [Notification](../src/notifications/domain/models/Notification.ts) array containing all notifications for the current authenticated user.
+
+##### Example call:
+
+```typescript
+import { getAllNotificationsByUser } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAllNotificationsByUser.execute().then((notifications: Notification[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/GetAllNotificationsByUser.ts) implementation_.
+
+#### Delete Notification
+
+Deletes a specific notification for the current authenticated user by its ID.
+
+##### Example call:
+
+```typescript
+import { deleteNotification } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const notificationId = 123
+
+deleteNotification.execute(notificationId: number).then(() => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/DeleteNotification.ts) implementation_.
+
+#### Get Unread Count
+
+Returns the number of unread notifications for the current authenticated user.
+
+##### Example call:
+
+```typescript
+import { getUnreadNotificationsCount } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getUnreadNotificationsCount.execute().then((count: number) => {
+  console.log(`You have ${count} unread notifications`)
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/GetUnreadNotificationsCount.ts) implementation_.
+
+#### Mark As Read
+
+Marks a specific notification as read for the current authenticated user. This operation is idempotent - marking an already-read notification as read will not cause an error.
+
+##### Example call:
+
+```typescript
+import { markNotificationAsRead } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const notificationId = 123
+
+markNotificationAsRead.execute(notificationId).then(() => {
+  console.log('Notification marked as read')
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/MarkNotificationAsRead.ts) implementation_.
+
 ## Search
 
 #### Get Search Services

src/index.ts

@@ -8,5 +8,7 @@ export * from './collections'
 export * from './metadataBlocks'
 export * from './files'
 export * from './contactInfo'
+export * from './notifications'
 export * from './search'
+export * from './licenses'
 export * from './externalTools'

src/info/domain/models/DatasetMetadataExportFormats.ts

@@ -0,0 +1,16 @@
+export type DatasetMetadataExportFormats = Record<string, DatasetMetadataExportFormat>
+
+type DatasetMetadataExportFormat = DatasetMetadataExportFormatBase | XmlDatasetMetadataExportFormat
+
+interface DatasetMetadataExportFormatBase {
+  displayName: string
+  mediaType: string
+  isHarvestable: boolean
+  isVisibleInUserInterface: boolean
+}
+
+interface XmlDatasetMetadataExportFormat extends DatasetMetadataExportFormatBase {
+  XMLNameSpace: string
+  XMLSchemaLocation: string
+  XMLSchemaVersion: string
+}

src/info/domain/repositories/IDataverseInfoRepository.ts

@@ -1,8 +1,10 @@
+import { DatasetMetadataExportFormats } from '../models/DatasetMetadataExportFormats'
 import { DataverseVersion } from '../models/DataverseVersion'
 
 export interface IDataverseInfoRepository {
   getDataverseVersion(): Promise<DataverseVersion>
   getZipDownloadLimit(): Promise<number>
   getMaxEmbargoDurationInMonths(): Promise<number>
   getApplicationTermsOfUse(lang?: string): Promise<string>
+  getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats>
 }

src/info/domain/useCases/GetAvailableDatasetMetadataExportFormats.ts

@@ -0,0 +1,22 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetMetadataExportFormats } from '../models/DatasetMetadataExportFormats'
+import { IDataverseInfoRepository } from '../repositories/IDataverseInfoRepository'
+
+export class GetAvailableDatasetMetadataExportFormats
+  implements UseCase<DatasetMetadataExportFormats>
+{
+  private dataverseInfoRepository: IDataverseInfoRepository
+
+  constructor(dataverseInfoRepository: IDataverseInfoRepository) {
+    this.dataverseInfoRepository = dataverseInfoRepository
+  }
+
+  /**
+   * Returns a DatasetMetadataExportFormats object containing the available dataset metadata export formats.
+   *
+   * @returns {Promise<DatasetMetadataExportFormats>}
+   */
+  async execute(): Promise<DatasetMetadataExportFormats> {
+    return await this.dataverseInfoRepository.getAvailableDatasetMetadataExportFormats()
+  }
+}

src/info/index.ts

@@ -3,17 +3,24 @@ import { GetDataverseVersion } from './domain/useCases/GetDataverseVersion'
 import { GetZipDownloadLimit } from './domain/useCases/GetZipDownloadLimit'
 import { GetMaxEmbargoDurationInMonths } from './domain/useCases/GetMaxEmbargoDurationInMonths'
 import { GetApplicationTermsOfUse } from './domain/useCases/GetApplicationTermsOfUse'
+import { GetAvailableDatasetMetadataExportFormats } from './domain/useCases/GetAvailableDatasetMetadataExportFormats'
 
 const dataverseInfoRepository = new DataverseInfoRepository()
 
 const getDataverseVersion = new GetDataverseVersion(dataverseInfoRepository)
 const getZipDownloadLimit = new GetZipDownloadLimit(dataverseInfoRepository)
 const getMaxEmbargoDurationInMonths = new GetMaxEmbargoDurationInMonths(dataverseInfoRepository)
 const getApplicationTermsOfUse = new GetApplicationTermsOfUse(dataverseInfoRepository)
+const getAvailableDatasetMetadataExportFormats = new GetAvailableDatasetMetadataExportFormats(
+  dataverseInfoRepository
+)
 
 export {
   getDataverseVersion,
   getZipDownloadLimit,
   getMaxEmbargoDurationInMonths,
-  getApplicationTermsOfUse
+  getApplicationTermsOfUse,
+  getAvailableDatasetMetadataExportFormats
 }
+
+export { DatasetMetadataExportFormats } from './domain/models/DatasetMetadataExportFormats'

src/info/infra/repositories/DataverseInfoRepository.ts

@@ -2,6 +2,7 @@ import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { IDataverseInfoRepository } from '../../domain/repositories/IDataverseInfoRepository'
 import { DataverseVersion } from '../../domain/models/DataverseVersion'
 import { AxiosResponse } from 'axios'
+import { DatasetMetadataExportFormats } from '../../domain/models/DatasetMetadataExportFormats'
 
 export class DataverseInfoRepository extends ApiRepository implements IDataverseInfoRepository {
   private readonly infoResourceName: string = 'info'
@@ -55,4 +56,14 @@ export class DataverseInfoRepository extends ApiRepository implements IDataverse
         throw error
       })
   }
+
+  public async getAvailableDatasetMetadataExportFormats(): Promise<DatasetMetadataExportFormats> {
+    return this.doGet(this.buildApiEndpoint(this.infoResourceName, `exportFormats`))
+      .then((response: AxiosResponse<{ data: DatasetMetadataExportFormats }>) => {
+        return response.data.data
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
 }

src/licenses/domain/models/License.ts

@@ -0,0 +1,14 @@
+export interface License {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUri?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}

src/licenses/domain/repositories/ILicensesRepository.ts

@@ -0,0 +1,5 @@
+import { License } from '../models/License'
+
+export interface ILicensesRepository {
+  getAvailableStandardLicenses(): Promise<License[]>
+}

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

@@ -0,0 +1,14 @@
+export interface LicensePayload {
+  id: number
+  name: string
+  shortDescription?: string
+  uri: string
+  iconUrl?: string
+  active: boolean
+  isDefault: boolean
+  sortOrder: number
+  rightsIdentifier?: string
+  rightsIdentifierScheme?: string
+  schemeUri?: string
+  languageCode?: string
+}