Link Collection & Link Dataset

CHANGELOG.md

@@ -11,6 +11,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Dataset Templates Selector in the Create Dataset page.
 - Metadata Export Dropdown to the metadata tab of Dataset Page and File Page.
 - External Tools integration. All types supported: Explore, Configure, Preview and Query tools in Dataset and File pages. Still not showing external tools for Auxiliary Files as additional development is needed.
+- Link Collection and Link Dataset features.
 
 ### Changed
 

package.json

@@ -18,7 +18,7 @@
     "@dnd-kit/sortable": "8.0.0",
     "@dnd-kit/utilities": "3.2.2",
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.67",
+    "@iqss/dataverse-client-javascript": "2.1.0-pr378.93da193",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

packages/design-system/CHANGELOG.md

@@ -17,6 +17,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
   - Support for options with a shape of `{ label: string; value: string; }[]` instead of just `string[]`.
 - **ButtonGroup:**
   - Fix styles for vertical button groups when using tooltips.
+- **FormText:** Add `className` prop to allow custom styling.
+- **FormInput:** Add `size` prop to allow different input sizes (e.g., 'sm', 'lg'). Defaults to standard size if not specified.
 
 # [2.0.2](https://github.com/IQSS/dataverse-frontend/compare/@iqss/[email protected]...@iqss/[email protected]) (2024-06-23)
 

packages/design-system/src/lib/components/form/form-group/form-element/FormInput.tsx

@@ -14,6 +14,7 @@ export interface FormInputProps extends Omit<React.InputHTMLAttributes<FormInput
   required?: boolean
   autoFocus?: boolean
   autoComplete?: string
+  size?: 'sm' | 'lg'
 }
 
 export const FormInput = React.forwardRef(function FormInput(
@@ -28,6 +29,7 @@ export const FormInput = React.forwardRef(function FormInput(
     required,
     autoFocus,
     autoComplete,
+    size,
     ...props
   }: FormInputProps,
   ref
@@ -45,6 +47,7 @@ export const FormInput = React.forwardRef(function FormInput(
       required={required}
       autoFocus={autoFocus}
       autoComplete={autoComplete}
+      size={size}
       ref={ref as React.ForwardedRef<HTMLInputElement>}
       {...props}
     />

packages/design-system/src/lib/components/form/form-group/form-element/FormText.tsx

@@ -1,6 +1,10 @@
 import { ReactNode } from 'react'
 import { Form as FormBS } from 'react-bootstrap'
 
-export function FormText({ children }: { children: ReactNode }) {
-  return <FormBS.Text muted>{children}</FormBS.Text>
+export function FormText({ children, className }: { children: ReactNode; className?: string }) {
+  return (
+    <FormBS.Text muted className={className}>
+      {children}
+    </FormBS.Text>
+  )
 }

public/locales/en/collection.json

@@ -69,5 +69,11 @@
   },
   "collectionDeletedSuccess": "Your collection has been deleted.",
   "defaultCollectionDeleteError": "Something went wrong deleting the collection. Try again later.",
-  "description": "Description"
+  "description": "Description",
+  "linkCollection": {
+    "title": "Link Collection",
+    "helper": "Choose which of your collections you would like to link this collection to.",
+    "save": "Save Linked Collection",
+    "success": "<wrapper>{{linkedCollectionName}} has been successfully linked to <a>{{linkingCollectionName}}</a></wrapper>"
+  }
 }

public/locales/en/dataset.json

@@ -36,7 +36,17 @@
       "removeCurrentStatus": "Remove Current Status"
     },
     "linkDataset": {
-      "title": "Link Dataset"
+      "title": "Link Dataset",
+      "helper": "Choose which of your collections you would like to link this dataset to.",
+      "linkedCollections": "Note: This dataset is already linked to the following collections:",
+      "save": "Save Linked Dataset",
+      "success": "<wrapper>Dataset from {{parentCollection}} has been successfully linked to <a>{{linkingCollectionName}}</a></wrapper>"
+    },
+    "unlinkDataset": {
+      "title": "Unlink Dataset",
+      "helper": "Choose which of your collections you would like to unlink this dataset from.",
+      "save": "Remove Linked Dataset",
+      "success": "<wrapper>Dataset unlinked from <a>{{unlinkingCollectionName}}</a></wrapper>"
     },
     "editDataset": {
       "title": "Edit Dataset",

public/locales/en/shared.json

@@ -27,6 +27,7 @@
   "dragHandleLabel": "press space to select and keys to drag",
   "unknown": "Unknown",
   "find": "Find",
+  "link": "Link",
   "allowPopups": "You must enable popups in your browser to open external tools in a new window or tab.",
   "externalToolOpeningFailed": "There was a problem opening the external tool. Please try again.",
   "exportMetadata": "Export Metadata",
@@ -292,6 +293,16 @@
     "truncateMoreTip": "Click to read the full {{contentName}}",
     "truncateLessTip": "Click to collapse the {{contentName}}"
   },
+  "collectionLinkSelect": {
+    "label": "Your Collection",
+    "select": "Select a Collection",
+    "placeholder": "Enter Collection Name",
+    "noOptions": "No collections found",
+    "onlyOneCollectionToLink": "You have one collection you can link this {{linkingObjectType}} to.",
+    "onlyOneCollectionToUnlink": "You have one collection you can unlink this {{linkingObjectType}} from.",
+    "noCollectionsToLink": "No collections are showing up to link. They may already be linked, or you might not have any yet. Create a new collection to continue.",
+    "noCollectionsToUnlink": "No collections are showing up to unlink."
+  },
   "exploreOptions": "Explore Options",
   "queryOptions": "Query Options",
   "configureOptions": "Configure Options"

src/assets/react-toastify-custom.scss

@@ -7,4 +7,5 @@
   --toastify-color-warning: #{$dv-warning-color};
   --toastify-color-error: #{$dv-danger-color};
   --toastify-font-family: #{$dv-font-family};
+  --toastify-toast-padding: 14px 28px 14px 14px;
 }

src/collection/domain/models/CollectionItemTypePreview.ts

@@ -12,4 +12,5 @@ export interface CollectionItemTypePreview {
   parentCollectionName: string
   parentCollectionAlias: string
   userRoles?: string[]
+  isLinked?: boolean
 }

src/collection/domain/models/CollectionLinks.ts

@@ -0,0 +1,7 @@
+import { CollectionSummary } from './CollectionSummary'
+
+export interface CollectionLinks {
+  linkedCollections: CollectionSummary[]
+  collectionsLinkingToThis: CollectionSummary[]
+  linkedDatasets: { persistentId: string; title: string }[]
+}

src/collection/domain/models/CollectionSummary.ts

@@ -0,0 +1,5 @@
+export interface CollectionSummary {
+  id: number
+  alias: string
+  displayName: string
+}

src/collection/domain/repositories/CollectionRepository.ts

@@ -10,6 +10,9 @@ import { CollectionDTO } from '../useCases/DTOs/CollectionDTO'
 import { FeaturedItemsDTO } from '../useCases/DTOs/FeaturedItemsDTO'
 import { CollectionItemType } from '@/collection/domain/models/CollectionItemType'
 import { PublicationStatus } from '@/shared/core/domain/models/PublicationStatus'
+import { LinkingObjectType } from '../useCases/getCollectionsForLinking'
+import { CollectionSummary } from '../models/CollectionSummary'
+import { CollectionLinks } from '../models/CollectionLinks'
 
 export interface CollectionRepository {
   getById: (id?: string) => Promise<Collection>
@@ -41,4 +44,19 @@ export interface CollectionRepository {
   ): Promise<FeaturedItem[]>
   deleteFeaturedItems(collectionIdOrAlias: number | string): Promise<void>
   deleteFeaturedItem(featuredItemId: number): Promise<void>
+  getForLinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm?: string
+  ): Promise<CollectionSummary[]>
+  getForUnlinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm?: string
+  ): Promise<CollectionSummary[]>
+  link(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void>
+  getLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks>
 }

src/collection/domain/useCases/getCollectionLinks.ts

@@ -0,0 +1,9 @@
+import { CollectionLinks } from '../models/CollectionLinks'
+import { CollectionRepository } from '../repositories/CollectionRepository'
+
+export async function getCollectionLinks(
+  collectionRepository: CollectionRepository,
+  collectionIdOrAlias: string | number
+): Promise<CollectionLinks> {
+  return collectionRepository.getLinks(collectionIdOrAlias)
+}

src/collection/domain/useCases/getCollectionsForLinking.ts

@@ -0,0 +1,13 @@
+import { CollectionRepository } from '../repositories/CollectionRepository'
+import { CollectionSummary } from '../models/CollectionSummary'
+
+export type LinkingObjectType = 'collection' | 'dataset'
+
+export async function getCollectionsForLinking(
+  collectionRepository: CollectionRepository,
+  objectType: LinkingObjectType,
+  id: number | string,
+  searchTerm?: string
+): Promise<CollectionSummary[]> {
+  return collectionRepository.getForLinking(objectType, id, searchTerm)
+}

src/collection/domain/useCases/getCollectionsForUnlinking.ts

@@ -0,0 +1,12 @@
+import { CollectionRepository } from '../repositories/CollectionRepository'
+import { CollectionSummary } from '../models/CollectionSummary'
+import { LinkingObjectType } from './getCollectionsForLinking'
+
+export async function getCollectionsForUnlinking(
+  collectionRepository: CollectionRepository,
+  objectType: LinkingObjectType,
+  id: number | string,
+  searchTerm?: string
+): Promise<CollectionSummary[]> {
+  return collectionRepository.getForUnlinking(objectType, id, searchTerm)
+}

src/collection/domain/useCases/linkCollection.ts

@@ -0,0 +1,9 @@
+import { CollectionRepository } from '../repositories/CollectionRepository'
+
+export async function linkCollection(
+  collectionRepository: CollectionRepository,
+  linkedCollectionIdOrAlias: number | string,
+  linkingCollectionIdOrAlias: number | string
+): Promise<void> {
+  return collectionRepository.link(linkedCollectionIdOrAlias, linkingCollectionIdOrAlias)
+}

src/collection/infrastructure/repositories/CollectionJSDataverseRepository.ts

@@ -13,7 +13,10 @@ import {
   updateCollectionFeaturedItems,
   deleteCollectionFeaturedItems,
   deleteCollection,
-  deleteCollectionFeaturedItem
+  deleteCollectionFeaturedItem,
+  getCollectionsForLinking,
+  linkCollection,
+  getCollectionLinks
 } from '@iqss/dataverse-client-javascript'
 import { JSCollectionMapper } from '../mappers/JSCollectionMapper'
 import { CollectionDTO } from '../../domain/useCases/DTOs/CollectionDTO'
@@ -28,6 +31,9 @@ import { FeaturedItemsDTO } from '@/collection/domain/useCases/DTOs/FeaturedItem
 import { MyDataCollectionItemSubset } from '@/collection/domain/models/MyDataCollectionItemSubset'
 import { CollectionItemType } from '@/collection/domain/models/CollectionItemType'
 import { PublicationStatus } from '@/shared/core/domain/models/PublicationStatus'
+import { CollectionSummary } from '@/collection/domain/models/CollectionSummary'
+import { LinkingObjectType } from '@/collection/domain/useCases/getCollectionsForLinking'
+import { CollectionLinks } from '@/collection/domain/models/CollectionLinks'
 
 export class CollectionJSDataverseRepository implements CollectionRepository {
   getById(id?: string): Promise<Collection> {
@@ -142,4 +148,31 @@ export class CollectionJSDataverseRepository implements CollectionRepository {
   deleteFeaturedItem(featuredItemId: number): Promise<void> {
     return deleteCollectionFeaturedItem.execute(featuredItemId)
   }
+
+  getForLinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm?: string
+  ): Promise<CollectionSummary[]> {
+    return getCollectionsForLinking.execute(objectType, id, searchTerm)
+  }
+
+  getForUnlinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm?: string
+  ): Promise<CollectionSummary[]> {
+    return getCollectionsForLinking.execute(objectType, id, searchTerm, true)
+  }
+
+  link(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void> {
+    return linkCollection.execute(linkedCollectionIdOrAlias, linkingCollectionIdOrAlias)
+  }
+
+  getLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks> {
+    return getCollectionLinks.execute(collectionIdOrAlias)
+  }
 }

src/dataset/domain/hooks/useGetDatasetLinkedCollections.ts

@@ -0,0 +1,63 @@
+import { useCallback, useEffect, useState } from 'react'
+import { ReadError } from '@iqss/dataverse-client-javascript'
+import { JSDataverseReadErrorHandler } from '@/shared/helpers/JSDataverseReadErrorHandler'
+import { CollectionSummary } from '@/collection/domain/models/CollectionSummary'
+import { DatasetRepository } from '../repositories/DatasetRepository'
+import { getDatasetLinkedCollections } from '../useCases/getDatasetLinkedCollections'
+
+interface useGetDatasetLinkedCollectionsProps {
+  datasetRepository: DatasetRepository
+  datasetId: string | number
+  autoFetch?: boolean
+}
+
+export const useGetDatasetLinkedCollections = ({
+  datasetRepository,
+  datasetId,
+  autoFetch = true
+}: useGetDatasetLinkedCollectionsProps) => {
+  const [datasetLinkedCollections, setDatasetLinkedCollections] = useState<CollectionSummary[]>([])
+  const [isLoadingDatasetLinkedCollections, setIsLoadingDatasetLinkedCollections] =
+    useState<boolean>(autoFetch)
+  const [errorGetDatasetLinkedCollections, setErrorGetDatasetLinkedCollections] = useState<
+    string | null
+  >(null)
+
+  const fetchDatasetLinkedCollections = useCallback(async () => {
+    setIsLoadingDatasetLinkedCollections(true)
+    setErrorGetDatasetLinkedCollections(null)
+
+    try {
+      const linkedCollections = await getDatasetLinkedCollections(datasetRepository, datasetId)
+
+      setDatasetLinkedCollections(linkedCollections)
+    } catch (err) {
+      if (err instanceof ReadError) {
+        const error = new JSDataverseReadErrorHandler(err)
+        const formattedError =
+          error.getReasonWithoutStatusCode() ?? /* istanbul ignore next */ error.getErrorMessage()
+
+        setErrorGetDatasetLinkedCollections(formattedError)
+      } else {
+        setErrorGetDatasetLinkedCollections(
+          'Something went wrong getting the dataset linked collections. Try again later.'
+        )
+      }
+    } finally {
+      setIsLoadingDatasetLinkedCollections(false)
+    }
+  }, [datasetRepository, datasetId])
+
+  useEffect(() => {
+    if (autoFetch) {
+      void fetchDatasetLinkedCollections()
+    }
+  }, [autoFetch, fetchDatasetLinkedCollections])
+
+  return {
+    datasetLinkedCollections,
+    isLoadingDatasetLinkedCollections,
+    errorGetDatasetLinkedCollections,
+    fetchDatasetLinkedCollections
+  }
+}

src/dataset/domain/models/DatasetItemTypePreview.ts

@@ -13,4 +13,5 @@ export interface DatasetItemTypePreview {
   parentCollectionName: string
   parentCollectionAlias: string
   userRoles?: string[]
+  isLinked?: boolean
 }