Merge remote-tracking branch 'origin/develop' into add_metadata_block

Author: jp-tosca

CHANGELOG.md

@@ -8,6 +8,16 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 
 ### Added
 
+### Changed
+
+### Fixed
+
+### Removed
+
+## [v2.2.0] -- 2026-04-24
+
+### Added
+
 - Datasets: Added `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms.
 - Datasets: Added `getDatasetStorageDriver` use case and repository method to support Dataverse endpoint `GET /datasets/{identifier}/storageDriver`, for retrieving dataset storage driver configuration with properties: name, type, label, directUpload, directDownload, and uploadOutOfBand.
 - Datasets: Added `getDatasetUploadLimits` use case and repository method to support Dataverse endpoint `GET /datasets/{id}/uploadlimits`, for retrieving remaining storage upload quotas, if present.
@@ -32,6 +42,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Templates: Rename `CreateDatasetTemplateDTO` to `CreateTemplateDTO`.
 - Templates: Rename `createDatasetTemplate` repository method to `createTemplate`.
 - Templates: Rename `getDatasetTemplates` repository method to `getTemplatesByCollectionId`.
+- Collections: `updateCollection` now supports partial updates by accepting `Partial<CollectionDTO>`. Only explicitly provided fields are sent in update requests, aligning with Dataverse API semantics. Metadata blocks handling was adjusted to respect inheritance flags and avoid invalid field combinations.
 
 ### Fixed
 
@@ -42,7 +53,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 
 - Removed date fields validations in create and update dataset use cases, since validation is already handled in the backend and SPA frontend (other clients should perform client side validation also). This avoids duplicated logic and keeps the package focused on its core responsibility.
 
-[Unreleased]: https://github.com/IQSS/dataverse-client-javascript/compare/v2.1.0...develop
+[Unreleased]: https://github.com/IQSS/dataverse-client-javascript/compare/v2.2.0...develop
 
 ---
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@iqss/dataverse-client-javascript",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Dataverse API wrapper package for JavaScript/TypeScript-based applications",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package.json

@@ -1,4 +1,11 @@
+import { ApiConfig, DataverseApiAuthMechanism } from '../../../core/infra/repositories/ApiConfig'
+import { WriteError } from '../../../core/domain/repositories/WriteError'
+import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import {
+  buildRequestConfig,
+  buildRequestUrl
+} from '../../../core/infra/repositories/apiConfigBuilders'
 import { GuestbookResponseDTO } from '../../domain/dtos/GuestbookResponseDTO'
 import { IAccessRepository } from '../../domain/repositories/IAccessRepository'
 
@@ -13,14 +20,7 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
     const endpoint = this.buildApiEndpoint(`${this.accessResourceName}/datafile`, undefined, fileId)
     const queryParams = format ? { signed: true, format } : { signed: true }
 
-    return this.doPost(endpoint, guestbookResponse, queryParams)
-      .then((response) => {
-        const signedUrl = response.data.data.signedUrl
-        return signedUrl
-      })
-      .catch((error) => {
-        throw error
-      })
+    return await this.submitGuestbookDownload(endpoint, guestbookResponse, queryParams)
   }
 
   public async submitGuestbookForDatafilesDownload(
@@ -30,21 +30,14 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
   ): Promise<string> {
     const queryParams = format ? { signed: true, format } : { signed: true }
 
-    return this.doPost(
+    return await this.submitGuestbookDownload(
       this.buildApiEndpoint(
         this.accessResourceName,
         `datafiles/${Array.isArray(fileIds) ? fileIds.join(',') : fileIds}`
       ),
       guestbookResponse,
       queryParams
     )
-      .then((response) => {
-        const signedUrl = response.data.data.signedUrl
-        return signedUrl
-      })
-      .catch((error) => {
-        throw error
-      })
   }
 
   public async submitGuestbookForDatasetDownload(
@@ -59,14 +52,7 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
     )
     const queryParams = format ? { signed: true, format } : { signed: true }
 
-    return this.doPost(endpoint, guestbookResponse, queryParams)
-      .then((response) => {
-        const signedUrl = response.data.data.signedUrl
-        return signedUrl
-      })
-      .catch((error) => {
-        throw error
-      })
+    return await this.submitGuestbookDownload(endpoint, guestbookResponse, queryParams)
   }
 
   public async submitGuestbookForDatasetVersionDownload(
@@ -82,13 +68,112 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
     )
     const queryParams = format ? { signed: true, format } : { signed: true }
 
-    return this.doPost(endpoint, guestbookResponse, queryParams)
-      .then((response) => {
-        const signedUrl = response.data.data.signedUrl
-        return signedUrl
-      })
-      .catch((error) => {
-        throw error
-      })
+    return await this.submitGuestbookDownload(endpoint, guestbookResponse, queryParams)
+  }
+
+  private async submitGuestbookDownload(
+    apiEndpoint: string,
+    guestbookResponse: GuestbookResponseDTO,
+    queryParams: object
+  ): Promise<string> {
+    const requestConfig = buildRequestConfig(
+      true,
+      queryParams,
+      ApiConstants.CONTENT_TYPE_APPLICATION_JSON
+    )
+    const response = await fetch(
+      this.buildUrlWithQueryParams(buildRequestUrl(apiEndpoint), queryParams),
+      {
+        method: 'POST',
+        headers: this.buildFetchHeaders(requestConfig.headers),
+        credentials: this.getFetchCredentials(requestConfig.withCredentials),
+        body: JSON.stringify(guestbookResponse)
+      }
+    ).catch((error) => {
+      throw new WriteError(error instanceof Error ? error.message : String(error))
+    })
+
+    const responseData = await this.parseResponseBody(response)
+
+    if (!response.ok) {
+      throw new WriteError(this.buildFetchErrorMessage(response.status, responseData))
+    }
+
+    return this.getSignedUrlOrThrow(responseData)
+  }
+
+  private getFetchCredentials(withCredentials?: boolean): RequestCredentials | undefined {
+    if (ApiConfig.dataverseApiAuthMechanism === DataverseApiAuthMechanism.BEARER_TOKEN) {
+      return 'omit'
+    }
+
+    if (withCredentials) {
+      return 'include'
+    }
+
+    return undefined
+  }
+
+  private buildUrlWithQueryParams(requestUrl: string, queryParams: object): string {
+    const url = new URL(requestUrl)
+
+    Object.entries(queryParams).forEach(([key, value]) => {
+      if (value !== undefined && value !== null) {
+        url.searchParams.append(key, String(value))
+      }
+    })
+
+    return url.toString()
+  }
+
+  private buildFetchHeaders(headers?: Record<string, unknown>): Record<string, string> {
+    const fetchHeaders: Record<string, string> = {}
+
+    if (!headers) {
+      return fetchHeaders
+    }
+
+    Object.entries(headers).forEach(([key, value]) => {
+      if (value !== undefined) {
+        fetchHeaders[key] = String(value)
+      }
+    })
+
+    return fetchHeaders
+  }
+
+  private async parseResponseBody(response: Response): Promise<any> {
+    const contentType = response.headers.get('content-type') ?? ''
+
+    if (contentType.includes('application/json')) {
+      return await response.json()
+    }
+
+    const responseText = await response.text()
+
+    try {
+      return JSON.parse(responseText)
+    } catch {
+      return responseText
+    }
+  }
+
+  private buildFetchErrorMessage(status: number, responseData: any): string {
+    const message =
+      typeof responseData === 'string'
+        ? responseData
+        : responseData?.message || responseData?.data?.message || 'unknown error'
+
+    return `[${status}] ${message}`
+  }
+
+  private getSignedUrlOrThrow(responseData: any): string {
+    const signedUrl = responseData?.data?.signedUrl
+
+    if (typeof signedUrl !== 'string' || signedUrl.length === 0) {
+      throw new WriteError('Missing signedUrl in access download response.')
+    }
+
+    return signedUrl
   }
 }

src/access/infra/repositories/AccessRepository.ts

@@ -44,7 +44,7 @@ export interface ICollectionsRepository {
   ): Promise<MyDataCollectionItemSubset>
   updateCollection(
     collectionIdOrAlias: number | string,
-    updatedCollection: CollectionDTO
+    updatedCollection: Partial<CollectionDTO>
   ): Promise<void>
   getCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<FeaturedItem[]>
   updateCollectionFeaturedItems(

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -19,7 +19,7 @@ export class UpdateCollection implements UseCase<void> {
    */
   async execute(
     collectionIdOrAlias: number | string,
-    updatedCollection: CollectionDTO
+    updatedCollection: Partial<CollectionDTO>
   ): Promise<void> {
     return await this.collectionsRepository.updateCollection(collectionIdOrAlias, updatedCollection)
   }

src/collections/domain/useCases/UpdateCollection.ts

@@ -215,9 +215,9 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
   public async updateCollection(
     collectionIdOrAlias: string | number,
-    updatedCollection: CollectionDTO
+    updatedCollection: Partial<CollectionDTO>
   ): Promise<void> {
-    const requestBody = this.createCreateOrUpdateRequestBody(updatedCollection)
+    const requestBody = this.createUpdateRequestBody(updatedCollection)
 
     return this.doPut(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, requestBody)
       .then(() => undefined)
@@ -332,6 +332,86 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     }
   }
 
+  private createUpdateRequestBody(
+    collectionDTO: Partial<CollectionDTO>
+  ): Partial<NewCollectionRequestPayload> {
+    const dataverseContacts: NewCollectionContactRequestPayload[] | undefined =
+      collectionDTO.contacts?.map((contact) => ({
+        contactEmail: contact
+      }))
+    const inputLevelsRequestBody: NewCollectionInputLevelRequestPayload[] | undefined =
+      collectionDTO.inputLevels?.map((inputLevel) => ({
+        datasetFieldTypeName: inputLevel.datasetFieldName,
+        include: inputLevel.include,
+        required: inputLevel.required
+      }))
+    let metadataBlocksRequestBody: Partial<NewCollectionMetadataBlocksRequestPayload> | undefined
+
+    const hasMetadataBlocksData =
+      collectionDTO.metadataBlockNames !== undefined ||
+      collectionDTO.facetIds !== undefined ||
+      collectionDTO.inputLevels !== undefined ||
+      collectionDTO.inheritMetadataBlocksFromParent !== undefined ||
+      collectionDTO.inheritFacetsFromParent !== undefined
+
+    if (hasMetadataBlocksData) {
+      metadataBlocksRequestBody = {}
+      if (collectionDTO.inheritMetadataBlocksFromParent !== true) {
+        if (collectionDTO.metadataBlockNames !== undefined) {
+          metadataBlocksRequestBody.metadataBlockNames = collectionDTO.metadataBlockNames
+        }
+        if (inputLevelsRequestBody !== undefined) {
+          metadataBlocksRequestBody.inputLevels = inputLevelsRequestBody
+        }
+      }
+      if (collectionDTO.inheritFacetsFromParent !== true) {
+        if (collectionDTO.facetIds !== undefined) {
+          metadataBlocksRequestBody.facetIds = collectionDTO.facetIds
+        }
+      }
+      if (collectionDTO.inheritMetadataBlocksFromParent !== undefined) {
+        metadataBlocksRequestBody.inheritMetadataBlocksFromParent =
+          collectionDTO.inheritMetadataBlocksFromParent
+      }
+      if (collectionDTO.inheritFacetsFromParent !== undefined) {
+        metadataBlocksRequestBody.inheritFacetsFromParent = collectionDTO.inheritFacetsFromParent
+      }
+    }
+
+    // Build the final request body, only including defined fields
+    const requestBody: Partial<NewCollectionRequestPayload> = {}
+
+    if (collectionDTO.alias !== undefined) {
+      requestBody.alias = collectionDTO.alias
+    }
+
+    if (collectionDTO.name !== undefined) {
+      requestBody.name = collectionDTO.name
+    }
+
+    if (dataverseContacts !== undefined) {
+      requestBody.dataverseContacts = dataverseContacts
+    }
+
+    if (collectionDTO.type !== undefined) {
+      requestBody.dataverseType = collectionDTO.type
+    }
+
+    if (collectionDTO.description !== undefined) {
+      requestBody.description = collectionDTO.description
+    }
+
+    if (collectionDTO.affiliation !== undefined) {
+      requestBody.affiliation = collectionDTO.affiliation
+    }
+
+    if (metadataBlocksRequestBody !== undefined) {
+      requestBody.metadataBlocks = metadataBlocksRequestBody
+    }
+
+    return requestBody
+  }
+
   private applyCollectionSearchCriteriaToQueryParams(
     queryParams: URLSearchParams,
     collectionSearchCriteria: CollectionSearchCriteria

src/collections/infra/repositories/CollectionsRepository.ts

@@ -3,17 +3,20 @@ export class ApiConfig {
   static dataverseApiAuthMechanism: DataverseApiAuthMechanism
   static dataverseApiKey?: string
   static bearerTokenLocalStorageKey?: string
+  static bearerTokenGetFunction?: () => string | null
 
   static init(
     dataverseApiUrl: string,
     dataverseApiAuthMechanism: DataverseApiAuthMechanism,
     dataverseApiKey?: string,
-    bearerTokenLocalStorageKey?: string
+    bearerTokenLocalStorageKey?: string,
+    bearerTokenGetFunction?: () => string | null
   ) {
     this.dataverseApiUrl = dataverseApiUrl
     this.dataverseApiAuthMechanism = dataverseApiAuthMechanism
     this.dataverseApiKey = dataverseApiKey
     this.bearerTokenLocalStorageKey = bearerTokenLocalStorageKey
+    this.bearerTokenGetFunction = bearerTokenGetFunction
   }
 }