Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/markdown editor #1105

Merged
merged 8 commits into from
Jan 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12,755 changes: 7,714 additions & 5,041 deletions package-lock.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@
},
"dependencies": {
"@tanstack/react-query": "^5.59.20",
"@uiw/react-md-editor": "^4.0.4",
"dayjs": "^1.11.6",
"dompurify": "2.5.6",
"draft-js": "0.11.7",
Expand Down
53 changes: 53 additions & 0 deletions src/packages/components/rich-editor/react-md-editor.spec.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import { describe, it, vi, expect } from 'vitest';

import { MDEditor } from './react-md-editor';

vi.mock('@uiw/react-md-editor', () => {
return {
italic: undefined,
bold: undefined,
unorderedListCommand: undefined,
default: ({
value,
onChange,
}: {
value: string;
onChange: (value?: string) => void;
}) => (
<textarea
data-testid="editor"
value={value}
onChange={(e) => onChange(e.target.value)}
/>
),
};
});

describe('MDEditor component', () => {
it('should render the editor with the initial text', () => {
const mockHandleChange = vi.fn();
const initialText = 'Initial text';

render(<MDEditor text={initialText} handleChange={mockHandleChange} />);

const editor = screen.getByTestId('editor') as HTMLInputElement;
expect(editor).toBeInTheDocument();
expect(editor.value).toBe(initialText);
});

it('should call handleChange when the text is updated', async () => {
const mockHandleChange = vi.fn();
const initialText = '';
const newText = 'Updated text';

render(<MDEditor text={initialText} handleChange={mockHandleChange} />);

const editor = screen.getByTestId('editor');
await userEvent.clear(editor);
await userEvent.type(editor, newText);

expect(mockHandleChange).toHaveBeenCalledTimes(12);
});
});
19 changes: 19 additions & 0 deletions src/packages/components/rich-editor/react-md-editor.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import Editor, {
bold,
italic,
unorderedListCommand,
} from '@uiw/react-md-editor';

export const MDEditor = ({
text,
handleChange,
}: Readonly<{ text: string; handleChange: (value?: string) => void }>) => {
return (
<Editor
value={text}
onChange={handleChange}
commands={[italic, bold, unorderedListCommand]}
preview="edit"
/>
);
};
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
import { locales } from '../../../tests-utils/default-values';
import { renderWithAppContext } from '../../../tests-utils/render';
import * as associationUtils from '../../utils/correspondence/association';
import Home from './home';

describe('association-home', () => {
it('renders without crashing', () => {
renderWithAppContext(
<Home
association={associationUtils.empty()}
secondLang={false}
langs={locales}
/>,
<Home association={associationUtils.empty()} secondLang={false} />,
);
});
});
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { locales } from '../../../tests-utils/default-values';
import { renderWithAppContext } from '../../../tests-utils/render';
import HomeGeneral from './home-general';

Expand All @@ -14,11 +13,7 @@ const correspondence = {
describe('correspondence-home-general', () => {
it('renders without crashing', () => {
renderWithAppContext(
<HomeGeneral
correspondence={correspondence}
secondLang={true}
langs={locales}
/>,
<HomeGeneral correspondence={correspondence} secondLang={true} />,
);
});
});
27 changes: 11 additions & 16 deletions src/packages/modules-datasets/datasets/edit/validation.spec.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
import { CatalogRecord } from '@model/Dataset';

import { validate } from './validation';

const catalogRecord = {
creator: 'creator',
contributor: ['contributor'],
} as CatalogRecord;
describe('validation', function () {
it('should return an error for labelLg1', function () {
expect(
validate({
labelLg2: 'labelLg2',
catalogRecord: {
creator: 'creator',
contributor: ['contributor'],
},
catalogRecord,
disseminationStatus: 'status',
wasGeneratedIRIs: ['id'],
}),
Expand All @@ -29,10 +32,7 @@ describe('validation', function () {
expect(
validate({
labelLg1: 'labelLg1',
catalogRecord: {
creator: 'creator',
contributor: ['contributor'],
},
catalogRecord,
disseminationStatus: 'status',
wasGeneratedIRIs: ['id'],
}),
Expand All @@ -55,6 +55,7 @@ describe('validation', function () {
labelLg1: 'labelLg2',
labelLg2: 'labelLg2',
contributor: [],
wasGeneratedIRIs: [],
}),
).toEqual({
errorMessage: [
Expand All @@ -81,10 +82,7 @@ describe('validation', function () {
validate({
labelLg1: 'labelLg2',
labelLg2: 'labelLg2',
catalogRecord: {
creator: 'creator',
contributor: ['contributor'],
},
catalogRecord,
disseminationStatus: 'status',
wasGeneratedIRIs: [],
}),
Expand All @@ -109,10 +107,7 @@ describe('validation', function () {
validate({
labelLg1: 'labelLg2',
labelLg2: 'labelLg2',
catalogRecord: {
creator: 'creator',
contributor: ['contributor'],
},
catalogRecord,
disseminationStatus: 'status',
wasGeneratedIRIs: ['id'],
}),
Expand Down
6 changes: 3 additions & 3 deletions src/packages/modules-datasets/distributions/edit.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import LabelRequired from '@components/label-required';
import { Row } from '@components/layout';
import { Loading, Saving } from '@components/loading';
import { PageTitleBlock } from '@components/page-title-block';
import { EditorMarkdown } from '@components/rich-editor/editor-markdown';
import { MDEditor } from '@components/rich-editor/react-md-editor';

import { DistributionApi } from '@sdk/index';

Expand Down Expand Up @@ -188,7 +188,7 @@ export const Component = () => {
<Row>
<div className="col-md-6 form-group">
<label htmlFor="descriptionLg1">{D1.descriptionTitle}</label>
<EditorMarkdown
<MDEditor
text={editingDistribution.descriptionLg1}
handleChange={(value) =>
setEditingDistribution({
Expand All @@ -200,7 +200,7 @@ export const Component = () => {
</div>
<div className="col-md-6 form-group">
<label htmlFor="descriptionLg2">{D2.descriptionTitle}</label>
<EditorMarkdown
<MDEditor
text={editingDistribution.descriptionLg2}
handleChange={(value) =>
setEditingDistribution({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ describe('validation', function () {
prefLabelLg1: 'prefLabelLg1',
prefLabelLg2: 'prefLabelLg2',
wasGeneratedBy: [{ id: 'i', type: 'series' }],
creators: [],
}),
).toEqual({
errorMessage: ['The property <strong>Owners</strong> is required.'],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ describe('validation', function () {
prefLabelLg2: '',
accrualPeriodicityCode: 'accrualPeriodicityCode',
typeCode: 'typeCode',
creators: [],
}),
).toEqual({
errorMessage: [
Expand Down
Loading