Merge branch 'develop' into feat/258-replace-file-use-case

Author: g-saracca

.github/workflows/copy_labels.yml

@@ -0,0 +1,26 @@
+name: Copy labels from issue to pull request
+
+on:
+  pull_request:
+    types: [opened]
+
+jobs:
+  copy-labels:
+    runs-on: ubuntu-latest
+    name: Copy labels from linked issues
+    steps:
+      - name: copy-labels
+        uses: michalvankodev/[email protected]
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          labels-to-exclude: |
+            Size: 3
+            Size: 10
+            Size: 20
+            Size: 33
+            Size: 80
+            Original size: 3
+            Original size: 10
+            Original size: 20
+            Original size: 33
+            Original size: 80

docs/useCases.md

@@ -19,6 +19,7 @@ The different use cases currently available in the package are classified below,
     - [Create a Collection](#create-a-collection)
     - [Update a Collection](#update-a-collection)
     - [Publish a Collection](#publish-a-collection)
+    - [Delete a Collection](#delete-a-collection)
     - [Update Collection Featured Items](#update-collection-featured-items)
     - [Delete Collection Featured Items](#delete-collection-featured-items)
 - [Datasets](#Datasets)
@@ -52,6 +53,7 @@ The different use cases currently available in the package are classified below,
     - [File Uploading Use Cases](#file-uploading-use-cases)
     - [Delete a File](#delete-a-file)
     - [Replace a File](#replace-a-file)
+    - [Restrict or Unrestrict a File](#restrict-or-unrestrict-a-file)
 - [Metadata Blocks](#metadata-blocks)
   - [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
     - [Get All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
@@ -320,6 +322,24 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 _See [use case](../src/collections/domain/useCases/PublishCollection.ts)_ definition.
 
+### Delete a Collection
+
+```typescript
+import { deleteCollection } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const collectionIdOrAlias = 12345
+
+deleteCollection.execute(collectionIdOrAlias)
+
+/* ... */
+```
+
+The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
+
+_See [use case](../src/collections/domain/useCases/DeleteCollection.ts)_ definition.
+
 #### Update Collection Featured Items
 
 Updates all featured items, given a collection identifier and a CollectionFeaturedItemsDTO.
@@ -1296,6 +1316,28 @@ The `fileId` parameter should be a number, the numeric identifier.
 
 The `uploadedFileDTO` parameter is a [UploadedFileDTO](../src/files/domain/dtos/UploadedFileDTO.ts) and includes properties related to the uploaded files. Some of these properties should be calculated from the uploaded File Blob objects and the resulting storage identifiers from the Upload File use case.
 
+#### Restrict or Unrestrict a File
+
+Restrict or unrestrict an existing file.
+
+##### Example call:
+
+```typescript
+import { restrictFile } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const fileId = 12345
+
+restrictFile.execute(fileId, true)
+
+/* ... */
+```
+
+_See [use case](../src/files/domain/useCases/RestrictFile.ts) implementation_.
+
+The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
+
 ## Metadata Blocks
 
 ### Metadata Blocks read use cases

src/collections/domain/models/Collection.ts

@@ -15,6 +15,7 @@ export interface Collection {
   contacts?: CollectionContact[]
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
+  childCount: number
 }
 
 export interface CollectionInputLevel {

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -14,6 +14,7 @@ export interface ICollectionsRepository {
     parentCollectionId: number | string
   ): Promise<number>
   publishCollection(collectionIdOrAlias: number | string): Promise<void>
+  deleteCollection(collectionIdOrAlias: number | string): Promise<void>
   getCollectionFacets(collectionIdOrAlias: number | string): Promise<CollectionFacet[]>
   getCollectionUserPermissions(
     collectionIdOrAlias: number | string

src/collections/domain/useCases/DeleteCollection.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class DeleteCollection implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Deletes the Dataverse collection whose database ID or alias is given:
+   *
+   * @param {number | string} [collectionIdOrAlias] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
+   * @returns {Promise<void>} -This method does not return anything upon successful completion.
+   */
+  async execute(collectionIdOrAlias: number | string): Promise<void> {
+    return await this.collectionsRepository.deleteCollection(collectionIdOrAlias)
+  }
+}

src/collections/index.ts

@@ -9,6 +9,7 @@ import { GetCollectionFeaturedItems } from './domain/useCases/GetCollectionFeatu
 import { CollectionsRepository } from './infra/repositories/CollectionsRepository'
 import { UpdateCollectionFeaturedItems } from './domain/useCases/UpdateCollectionFeaturedItems'
 import { DeleteCollectionFeaturedItems } from './domain/useCases/DeleteCollectionFeaturedItems'
+import { DeleteCollection } from './domain/useCases/DeleteCollection'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -22,6 +23,7 @@ const updateCollection = new UpdateCollection(collectionsRepository)
 const getCollectionFeaturedItems = new GetCollectionFeaturedItems(collectionsRepository)
 const updateCollectionFeaturedItems = new UpdateCollectionFeaturedItems(collectionsRepository)
 const deleteCollectionFeaturedItems = new DeleteCollectionFeaturedItems(collectionsRepository)
+const deleteCollection = new DeleteCollection(collectionsRepository)
 
 export {
   getCollection,
@@ -33,7 +35,8 @@ export {
   updateCollection,
   getCollectionFeaturedItems,
   updateCollectionFeaturedItems,
-  deleteCollectionFeaturedItems
+  deleteCollectionFeaturedItems,
+  deleteCollection
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -70,7 +70,8 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<Collection> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, true, {
-      returnOwners: true
+      returnOwners: true,
+      returnChildCount: true
     })
       .then((response) => transformCollectionResponseToCollection(response))
       .catch((error) => {
@@ -102,6 +103,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+
   public async publishCollection(collectionIdOrAlias: string | number): Promise<void> {
     return this.doPost(
       `/${this.collectionsResourceName}/${collectionIdOrAlias}/actions/:publish`,
@@ -113,6 +115,14 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
   }
 
+  public async deleteCollection(collectionIdOrAlias: number | string): Promise<void> {
+    return this.doDelete(`/${this.collectionsResourceName}/${collectionIdOrAlias}`)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
+
   public async getCollectionUserPermissions(
     collectionIdOrAlias: number | string
   ): Promise<CollectionUserPermissions> {

src/collections/infra/repositories/transformers/CollectionPayload.ts

@@ -13,6 +13,7 @@ export interface CollectionPayload {
   dataverseType: string
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
+  childCount: number
 }
 
 export interface CollectionInputLevelPayload {

src/collections/infra/repositories/transformers/collectionTransformers.ts

@@ -6,7 +6,6 @@ import {
   CollectionPayload
 } from './CollectionPayload'
 import { transformPayloadToOwnerNode } from '../../../../core/infra/repositories/transformers/dvObjectOwnerNodeTransformer'
-import { transformHtmlToMarkdown } from '../../../../datasets/infra/repositories/transformers/datasetTransformers'
 import { CollectionFacet } from '../../../domain/models/CollectionFacet'
 import { CollectionFacetPayload } from './CollectionFacetPayload'
 import {
@@ -53,9 +52,8 @@ const transformPayloadToCollection = (collectionPayload: CollectionPayload): Col
     type: collectionPayload.dataverseType as CollectionType,
     isMetadataBlockRoot: collectionPayload.isMetadataBlockRoot,
     isFacetRoot: collectionPayload.isFacetRoot,
-    ...(collectionPayload.description && {
-      description: transformHtmlToMarkdown(collectionPayload.description)
-    }),
+    description: collectionPayload.description,
+    childCount: collectionPayload.childCount,
     ...(collectionPayload.isPartOf && {
       isPartOf: transformPayloadToOwnerNode(collectionPayload.isPartOf)
     }),

src/core/infra/repositories/ApiRepository.ts

@@ -20,7 +20,7 @@ export abstract class ApiRepository {
 
   public async doPost(
     apiEndpoint: string,
-    data: string | object,
+    data: string | object | boolean,
     queryParams: object = {},
     contentType: string = ApiConstants.CONTENT_TYPE_APPLICATION_JSON
   ): Promise<AxiosResponse> {
@@ -29,7 +29,7 @@ export abstract class ApiRepository {
 
   public async doPut(
     apiEndpoint: string,
-    data: string | object,
+    data: string | object | boolean,
     queryParams: object = {},
     contentType: string = ApiConstants.CONTENT_TYPE_APPLICATION_JSON
   ): Promise<AxiosResponse> {
@@ -70,12 +70,18 @@ export abstract class ApiRepository {
   private async doRequest(
     method: 'post' | 'put',
     apiEndpoint: string,
-    data: string | object,
+    data: string | object | boolean,
     queryParams: object = {},
     contentType: string = ApiConstants.CONTENT_TYPE_APPLICATION_JSON
   ): Promise<AxiosResponse> {
-    const requestData =
-      contentType == ApiConstants.CONTENT_TYPE_APPLICATION_JSON ? JSON.stringify(data) : data
+    let requestData = data
+
+    if (contentType === ApiConstants.CONTENT_TYPE_APPLICATION_JSON) {
+      if (typeof data === 'object' || typeof data === 'boolean') {
+        requestData = JSON.stringify(data)
+      }
+    }
+
     const requestUrl = buildRequestUrl(apiEndpoint)
     const requestConfig = buildRequestConfig(true, queryParams, contentType)