Skip to content

Commit

Permalink
feat(editor): support version tag
Browse files Browse the repository at this point in the history
Co-authored-by: Vinicius Goulart <vinicius.goulart@camunda.com>

Related to camunda/camunda-modeler#4463
  • Loading branch information
philippfromme authored and vsgoulart committed Aug 23, 2024
1 parent 967279e commit bc6a48c
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { get } from 'min-dash';

import { useService } from '../hooks';

import { TextFieldEntry, isTextFieldEntryEdited } from '@bpmn-io/properties-panel';

export function VersionTagEntry(props) {
const { editField, field } = props;

const entries = [];

entries.push({
id: 'versionTag',
component: VersionTag,
editField: editField,
field: field,
isEdited: isTextFieldEntryEdited,
isDefaultVisible: (field) => field.type === 'default',
});

return entries;
}

function VersionTag(props) {
const { editField, field, id } = props;

const debounce = useService('debounce');

const path = ['versionTag'];

const getValue = () => {
return get(field, path, '');
};

const setValue = (value, error) => {
if (error) {
return;
}

return editField(field, path, value);
};

const tooltip = <div>Version tag by which this form can be referenced.</div>;

return TextFieldEntry({
debounce,
element: field,
getValue,
id,
label: 'Version tag',
setValue,
tooltip,
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ export { RowCountEntry } from './RowCountEntry';
export { HeadersSourceSelectEntry } from './HeadersSourceSelectEntry';
export { ColumnsExpressionEntry } from './ColumnsExpressionEntry';
export { StaticColumnsSourceEntry } from './StaticColumnsSourceEntry';
export { VersionTagEntry } from './VersionTagEntry';
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ import {
TableDataSourceEntry,
PaginationEntry,
RowCountEntry,
VersionTagEntry,
} from '../entries';

export function GeneralGroup(field, editField, getService) {
const entries = [
...IdEntry({ field, editField }),
...VersionTagEntry({ field, editField }),
...LabelEntry({ field, editField }),
...DescriptionEntry({ field, editField }),
...KeyEntry({ field, editField, getService }),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,75 @@ describe('GeneralGroup', function () {
});
});

describe('versionTag', function () {
it('should render for default', function () {
// given
const field = { type: 'default' };

// when
const { container } = renderGeneralGroup({ field });

// then
const versionTagInput = findInput('versionTag', container);

expect(versionTagInput).to.exist;
});

it('should NOT render for textfield', function () {
// given
const field = { type: 'textfield' };

// when
const { container } = renderGeneralGroup({ field });

// then
const versionTagInput = findInput('versionTag', container);

expect(versionTagInput).to.not.exist;
});

it('should read', function () {
// given
const field = {
type: 'default',
id: 'foobar',
versionTag: 'v1',
};

// when
const { container } = renderGeneralGroup({ field });

// when
const versionTagInput = findInput('versionTag', container);

// then
expect(versionTagInput).to.exist;
expect(versionTagInput.value).to.equal('v1');
});

it('should write', function () {
// given
const field = {
type: 'default',
id: 'foobar',
versionTag: 'v1',
};

const editFieldSpy = sinon.spy((field, path, value) => set(field, path, value));

const { container } = renderGeneralGroup({ field, editField: editFieldSpy });

const versionTagInput = findInput('versionTag', container);

// when
fireEvent.input(versionTagInput, { target: { value: 'newVal' } });

// then
expect(editFieldSpy).to.have.been.calledOnce;
expect(field.versionTag).to.equal('newVal');
});
});

describe('label', function () {
it('should NOT render for default', function () {
// given
Expand Down

0 comments on commit bc6a48c

Please sign in to comment.