356 publish dataset

packages/design-system/CHANGELOG.md

@@ -37,6 +37,8 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 - **Card:** NEW card element to show header and body.
 - **ProgressBar:** NEW progress bar element to show progress.
 - **SelectAdvanced:** NEW ehanced select to search across options, and perform both single and multiple selections.
+- **FormRadioGroup:** NEW radio group element to show radio buttons.
+- **FormRadio:** NEW radio element to show radio button.
 - **NavbarDropdownItem:** Now accepts `as` prop and takes `as` Element props.
 - **FormInputGroup:** extend Props Interface to accept `hasValidation` prop to properly show rounded corners in an <InputGroup> with validation
 - **Button:** extend Props Interface to accept `size` prop.

packages/design-system/src/lib/components/form/Form.tsx

@@ -4,6 +4,7 @@ import { Form as FormBS } from 'react-bootstrap'
 import { FormGroupWithMultipleFields } from './form-group-multiple-fields/FormGroupWithMultipleFields'
 import { FormInputGroup } from './form-group/form-input-group/FormInputGroup'
 import { FormCheckboxGroup } from './form-checkbox-group/FormCheckboxGroup'
+import { FormRadioGroup } from './form-radio-group/FormRadioGroup'
 
 interface FormProps {
   className?: string
@@ -23,5 +24,5 @@ Form.InputGroup = FormInputGroup
 Form.Group = FormGroup
 Form.GroupWithMultipleFields = FormGroupWithMultipleFields
 Form.CheckboxGroup = FormCheckboxGroup
-
+Form.RadioGroup = FormRadioGroup
 export { Form }

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

@@ -10,6 +10,7 @@ import { Row } from '../../grid/Row'
 import { FormCheckbox } from './form-element/FormCheckbox'
 import { FormFeedback } from './form-element/FormFeedback'
 import { FormSelectAdvanced } from './form-element/FormSelectAdvanced'
+import { FormRadio } from './form-element/FormRadio'
 
 interface FormGroupProps extends ColProps {
   as?: typeof Col | typeof Row
@@ -31,6 +32,7 @@ FormGroup.SelectAdvanced = FormSelectAdvanced
 FormGroup.TextArea = FormTextArea
 FormGroup.Text = FormText
 FormGroup.Checkbox = FormCheckbox
+FormGroup.Radio = FormRadio
 FormGroup.Feedback = FormFeedback
 
 export { FormGroup }

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

@@ -0,0 +1,31 @@
+import { Form as FormBS } from 'react-bootstrap'
+import * as React from 'react'
+
+export interface FormRadioProps extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'type'> {
+  id: string
+  label: string
+  isValid?: boolean
+  isInvalid?: boolean
+  invalidFeedback?: string
+  validFeedback?: string
+}
+
+export const FormRadio = React.forwardRef(function FormRadio(
+  { label, id, isValid, isInvalid, validFeedback, invalidFeedback, ...props }: FormRadioProps,
+  ref
+) {
+  return (
+    <FormBS.Check type="radio" id={id}>
+      <FormBS.Check.Input
+        type="radio"
+        isValid={isValid}
+        isInvalid={isInvalid}
+        ref={ref as React.ForwardedRef<HTMLInputElement>}
+        {...props}
+      />
+      <FormBS.Check.Label>{label}</FormBS.Check.Label>
+      <FormBS.Control.Feedback type="invalid">{invalidFeedback}</FormBS.Control.Feedback>
+      <FormBS.Control.Feedback type="valid">{validFeedback}</FormBS.Control.Feedback>
+    </FormBS.Check>
+  )
+})

packages/design-system/src/lib/components/form/form-radio-group/FormRadioGroup.module.scss

@@ -0,0 +1,7 @@
+@import 'src/lib/assets/styles/design-tokens/typography.module';
+
+.title {
+  display: inline-block;
+  margin-bottom: 0.5rem;
+  font-weight: $dv-font-weight-bold;
+}

packages/design-system/src/lib/components/form/form-radio-group/FormRadioGroup.tsx

@@ -0,0 +1,41 @@
+import { PropsWithChildren } from 'react'
+import { Row } from '../../grid/Row'
+import { Col } from '../../grid/Col'
+import { RequiredInputSymbol } from '../required-input-symbol/RequiredInputSymbol'
+import { QuestionMarkTooltip } from '../../tooltip/question-mark-tooltip/QuestionMarkTooltip'
+import styles from './FormRadioGroup.module.scss'
+
+interface FormRadioGroupProps {
+  title: string
+  required?: boolean
+  message?: string
+  isValid?: boolean
+  isInvalid?: boolean
+}
+
+export function FormRadioGroup({
+  title,
+  required,
+  message,
+  isValid,
+  isInvalid,
+  children
+}: PropsWithChildren<FormRadioGroupProps>) {
+  const validationClass = isInvalid ? 'is-invalid' : isValid ? 'is-valid' : ''
+  return (
+    <Row className="mb-3">
+      <Col sm={3}>
+        <span className={styles.title}>
+          {title} {required && <RequiredInputSymbol />}{' '}
+          {message && (
+            <QuestionMarkTooltip placement="right" message={message}></QuestionMarkTooltip>
+          )}
+        </span>
+      </Col>
+      <Col sm={9}>
+        {<div className={validationClass}></div>}
+        {children}
+      </Col>
+    </Row>
+  )
+}

packages/design-system/src/lib/stories/form/Form.stories.tsx

@@ -288,7 +288,31 @@ export const Checkbox: Story = {
     </Form>
   )
 }
-
+export const Radio: Story = {
+  render: () => (
+    <Form>
+      <Form.RadioGroup title="Version Update Types">
+        <Form.Group.Radio
+          defaultChecked
+          name="update-type"
+          label="Minor Version"
+          id="version-update-minor"
+        />
+        <Form.Group.Radio
+          required
+          name="update-type"
+          label="Major Version"
+          id="version-update-majoy"
+        />
+        <Form.Group.Radio
+          name="update-type"
+          label="Update Current Version"
+          id="version-type-update-current"
+        />
+      </Form.RadioGroup>
+    </Form>
+  )
+}
 export const GroupWithMultipleFields: Story = {
   render: () => (
     <Form>

packages/design-system/tests/component/form/form-group/FormGroupRadio.spec.tsx

@@ -0,0 +1,156 @@
+import { FormGroup } from '../../../../src/lib/components/form/form-group/FormGroup'
+import { Form } from '../../../../src/lib'
+import { FormRadioGroup } from '../../../../src/lib/components/form/form-radio-group/FormRadioGroup'
+
+const option1Label = 'Test Label 1'
+const option2Label = 'Test Label 2'
+const option3Label = 'Test Label 3'
+const radioName = 'radio-name'
+
+describe('FormRadio', () => {
+  it('renders label and radio input', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio">
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <FormGroup.Radio id="radio-3" label={option3Label} name={radioName} />
+      </FormRadioGroup>
+    )
+
+    const radio1 = cy.findByLabelText(option1Label)
+    radio1.should('exist')
+
+    const radio2 = cy.findByLabelText(option2Label)
+    radio2.should('exist')
+
+    const radio3 = cy.findByLabelText(option3Label)
+    radio3.should('exist')
+  })
+
+  it('renders without label', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio">
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <FormGroup.Radio id="radio-3" label={option3Label} name={radioName} />
+      </FormRadioGroup>
+    )
+
+    const radio2 = cy.findByLabelText(option2Label)
+
+    radio2.click()
+
+    radio2.should('be.checked')
+  })
+
+  it('should render with the required symbol', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio" required>
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <FormGroup.Radio id="radio-3" label={option3Label} name={radioName} />
+      </FormRadioGroup>
+    )
+
+    const requiredSymbol = cy.findByRole('img')
+    requiredSymbol.should('exist')
+  })
+
+  it('should render with the a tooltip message', () => {
+    const tooltipMessage = 'This is a tooltip message'
+    cy.mount(
+      <FormRadioGroup title="Radio" required message={tooltipMessage}>
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <FormGroup.Radio id="radio-3" label={option3Label} name={radioName} />
+      </FormRadioGroup>
+    )
+
+    cy.findByLabelText('tooltip icon').trigger('mouseover')
+    cy.findByRole('tooltip').should('be.visible')
+    cy.findByText(tooltipMessage).should('be.visible')
+  })
+
+  it('renders with invalid feedback', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio">
+        <FormGroup.Radio
+          id="radio-1"
+          label={option1Label}
+          name={radioName}
+          isInvalid
+          invalidFeedback="Invalid feedback"
+        />
+      </FormRadioGroup>
+    )
+
+    cy.findByText('Invalid feedback').should('exist')
+  })
+
+  it('renders with valid feedback', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio">
+        <FormGroup.Radio
+          id="radio-1"
+          label={option1Label}
+          name={radioName}
+          isValid
+          validFeedback="Valid feedback"
+        />
+      </FormRadioGroup>
+    )
+
+    cy.findByText('Valid feedback').should('exist')
+  })
+
+  it('renders with invalid feedback as a group', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio" isInvalid>
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <Form.Group.Feedback type="valid">Valid radio</Form.Group.Feedback>
+        <Form.Group.Feedback type="invalid">Invalid radio</Form.Group.Feedback>
+      </FormRadioGroup>
+    )
+
+    cy.findByText('Invalid radio').should('be.visible')
+    cy.findByText('Valid radio').should('not.be.visible')
+  })
+
+  it('renders with valid feedback as a group', () => {
+    cy.mount(
+      <FormRadioGroup title="Radio" isValid>
+        <FormGroup.Radio id="radio-1" label={option1Label} name={radioName} />
+        <FormGroup.Radio id="radio-2" label={option2Label} name={radioName} />
+        <Form.Group.Feedback type="valid">Valid radio</Form.Group.Feedback>
+        <Form.Group.Feedback type="invalid">Invalid radio</Form.Group.Feedback>
+      </FormRadioGroup>
+    )
+
+    cy.findByText('Invalid radio').should('not.be.visible')
+    cy.findByText('Valid radio').should('be.visible')
+  })
+  describe('FormRadioGroup', () => {
+    it('calls the onChange prop when a radio button is clicked', () => {
+      const handleChange = cy.stub()
+      const option1Label = 'Test Label 1'
+      const radioName = 'radio-name'
+
+      cy.mount(
+        <FormRadioGroup title="Radio">
+          <FormGroup.Radio
+            id="radio-1"
+            onChange={handleChange}
+            label={option1Label}
+            name={radioName}
+          />
+        </FormRadioGroup>
+      )
+
+      const radio1 = cy.findByLabelText(option1Label)
+      radio1.click()
+
+      cy.wrap(handleChange).should('have.been.calledOnce')
+    })
+  })
+})

public/locales/en/dataset.json

@@ -110,5 +110,18 @@
       "heading": "Unpublished Dataset Private URL",
       "alertText": "This unpublished dataset is being privately shared."
     }
+  },
+  "publish": {
+    "draftQuestion": "Are you sure you want to publish this dataset? Once you do so, it must remain public.",
+    "previouslyReleasedQuestion": "Are you sure you want to republish this dataset?",
+    "termsText1": "By default datasets are published with the CC0-\"Public Domain Dedication\" waiver. Learn more about the CC0 waiver <a href=\"{{cc0Link}}\">here</a>: ",
+    "termsText2": "To publish with custom Terms of Use, click the Cancel button and go to the Terms tab for this dataset.",
+    "selectVersion": "Select if this is a minor or major version update.",
+    "continueButton": "Continue",
+    "cancelButton": "Cancel",
+    "minorVersion": "Minor Version",
+    "majorVersion": "Major Version",
+    "updateCurrentVersion": "Update Current Version",
+    "error": "An error occurred while publishing the dataset."
   }
 }

src/dataset/domain/models/Dataset.ts

@@ -196,7 +196,7 @@ export interface DatasetLicense {
   iconUri?: string
 }
 
-const defaultLicense: DatasetLicense = {
+export const defaultLicense: DatasetLicense = {
   name: 'CC0 1.0',
   uri: 'https://creativecommons.org/publicdomain/zero/1.0',
   iconUri: 'https://licensebuttons.net/p/zero/1.0/88x31.png'
@@ -380,7 +380,8 @@ export class Dataset {
     public readonly hierarchy: UpwardHierarchyNode,
     public readonly thumbnail?: string,
     public readonly privateUrl?: PrivateUrl, // will be set if the user requested a version that did not exist
-    public readonly requestedVersion?: string
+    public readonly requestedVersion?: string,
+    public readonly publicationDate?: string
   ) {}
 
   public checkIsLockedFromPublishing(userPersistentId: string): boolean {

src/dataset/domain/models/VersionUpdateType.ts

@@ -0,0 +1,5 @@
+export enum VersionUpdateType {
+  MAJOR = 'major',
+  MINOR = 'minor',
+  UPDATE_CURRENT = 'updateCurrent'
+}

src/dataset/domain/repositories/DatasetRepository.ts

@@ -1,15 +1,18 @@
-import { Dataset } from '../models/Dataset'
+import { Dataset, DatasetLock } from '../models/Dataset'
 import { DatasetPaginationInfo } from '../models/DatasetPaginationInfo'
 import { DatasetDTO } from '../useCases/DTOs/DatasetDTO'
 import { DatasetsWithCount } from '../models/DatasetsWithCount'
+import { VersionUpdateType } from '../models/VersionUpdateType'
 
 export interface DatasetRepository {
   getByPersistentId: (persistentId: string, version?: string) => Promise<Dataset | undefined>
+  getLocks(persistentId: string): Promise<DatasetLock[]>
   getByPrivateUrlToken: (privateUrlToken: string) => Promise<Dataset | undefined>
   create: (dataset: DatasetDTO, collectionId?: string) => Promise<{ persistentId: string }>
   updateMetadata: (datasetId: string | number, datasetDTO: DatasetDTO) => Promise<void>
   getAllWithCount: (
     collectionId: string,
     paginationInfo: DatasetPaginationInfo
   ) => Promise<DatasetsWithCount>
+  publish(persistentId: string, versionUpdateType: VersionUpdateType): Promise<void>
 }

src/dataset/domain/useCases/DTOs/DatasetDTO.ts

@@ -1,4 +1,7 @@
+import { DatasetLicense } from '../../models/Dataset'
+
 export interface DatasetDTO {
+  licence: DatasetLicense
   metadataBlocks: DatasetMetadataBlockValuesDTO[]
 }