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.

Sign up for GitHub

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: add dynamic field store mutators, add store value hook #139

Merged
merged 1 commit into from
Nov 20, 2023
Merged

feat: add dynamic field store mutators, add store value hook #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions src/lib/core/components/Form/Controller.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import React from 'react';

import _ from 'lodash';

import {Spec} from '../../types';

import {EMPTY_MUTATOR} from './constants';
import {
useComponents,
useControllerMirror,
Expand All @@ -28,13 +31,24 @@ export interface ControllerProps<Value extends FieldValue, SpecType extends Spec
}

export const Controller = <Value extends FieldValue, SpecType extends Spec>({
spec,
spec: _spec,
name,
value,
parentOnChange,
parentOnUnmount,
}: ControllerProps<Value, SpecType>) => {
const {tools, externalErrors, __mirror} = useDynamicFormsCtx();
const {tools, mutators, __mirror} = useDynamicFormsCtx();

const spec = React.useMemo(() => {
const specMutator = _.get(mutators.spec, name, EMPTY_MUTATOR);

if (specMutator !== EMPTY_MUTATOR) {
return _.merge(_spec, specMutator);
}

return _spec;
}, [_spec, mutators.spec, name]);

const {inputEntity, Layout} = useComponents(spec);
const render = useRender({name, spec, inputEntity, Layout});
const validate = useValidate(spec);
Expand All @@ -47,7 +61,7 @@ export const Controller = <Value extends FieldValue, SpecType extends Spec>({
tools,
parentOnChange,
parentOnUnmount,
externalErrors,
mutators,
});
const withSearch = useSearch(spec, renderProps.input.value, name);

Expand Down
15 changes: 9 additions & 6 deletions src/lib/core/components/Form/DynamicField.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ import {
useCreateSearchContext,
useDynamicFieldMirror,
useIntegrationFF,
useMutators,
useSearchStore,
useStore,
} from './hooks';
import {BaseValidateError, DynamicFormConfig, FieldValue, WonderMirror} from './types';
import {DynamicFormConfig, DynamicFormMutators, FieldValue, WonderMirror} from './types';
import {getDefaultSearchFunction, isCorrectConfig} from './utils';

export interface DynamicFieldProps {
Expand All @@ -27,7 +28,7 @@ export interface DynamicFieldProps {
search?: string | ((spec: Spec, input: FieldValue, name: string) => boolean);
generateRandomValue?: (spec: StringSpec) => string;
withoutInsertFFDebounce?: boolean;
errors?: Record<string, BaseValidateError>;
mutators?: DynamicFormMutators;
__mirror?: WonderMirror;
}

Expand All @@ -39,25 +40,27 @@ export const DynamicField: React.FC<DynamicFieldProps> = ({
generateRandomValue,
search,
withoutInsertFFDebounce,
errors: externalErrors,
mutators: externalMutators,
__mirror,
}) => {
const DynamicFormsCtx = useCreateContext();
const SearchContext = useCreateSearchContext();
const {tools, store} = useStore(name);
const watcher = useIntegrationFF(store, withoutInsertFFDebounce);
const {mutators, mutateDFState} = useMutators(externalMutators);
const {store: searchStore, setField, removeField, isHiddenField} = useSearchStore();

const context = React.useMemo(
() => ({
config,
Monaco: isValidElementType(Monaco) ? Monaco : undefined,
generateRandomValue,
tools,
externalErrors,
tools: {...tools, mutateDFState},
store,
mutators,
__mirror,
}),
[tools, config, Monaco, __mirror, generateRandomValue, externalErrors],
[tools, config, Monaco, __mirror, generateRandomValue, mutators, mutateDFState, store],
);

const searchContext = React.useMemo(
Expand Down
30 changes: 15 additions & 15 deletions src/lib/core/components/Form/__tests__/DynamicField.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,12 +176,12 @@ test('Form/hooks/DynamicField', () => {
};

const errors = {
name: false,
name: undefined,
'name.name': ErrorMessages.REQUIRED,
'name.description': ErrorMessages.REQUIRED,
'name.settings': ErrorMessages.REQUIRED,
'name.autor': false,
'name.autor.external': false,
'name.autor': undefined,
'name.autor.external': undefined,
'name.autor.external.name': ErrorMessages.REQUIRED,
'name.autor.external.age': ErrorMessages.REQUIRED,
'name.autor.external.license': ErrorMessages.REQUIRED,
Expand Down Expand Up @@ -211,17 +211,17 @@ test('Form/hooks/DynamicField', () => {
};

const errors1 = {
name: false,
name: undefined,
'name.name': ErrorMessages.REQUIRED,
'name.description': ErrorMessages.REQUIRED,
'name.settings': ErrorMessages.REQUIRED,
'name.autor': false,
'name.autor.external': false,
'name.autor': undefined,
'name.autor.external': undefined,
'name.autor.external.name': ErrorMessages.REQUIRED,
'name.autor.external.age': ErrorMessages.REQUIRED,
'name.autor.external.license': ErrorMessages.REQUIRED,
'name.labels': ErrorMessages.minLengthArr(1),
'name.additional': false,
'name.additional': undefined,
'name.additional.surname': ErrorMessages.REQUIRED,
'name.additional.username': ErrorMessages.REQUIRED,
};
Expand All @@ -247,13 +247,13 @@ test('Form/hooks/DynamicField', () => {
};

const errors2 = {
name: false,
name: undefined,
'name.name': ErrorMessages.REQUIRED,
'name.description': ErrorMessages.REQUIRED,
'name.settings': ErrorMessages.REQUIRED,
'name.autor': ErrorMessages.REQUIRED,
'name.labels': ErrorMessages.minLengthArr(1),
'name.additional': false,
'name.additional': undefined,
'name.additional.surname': ErrorMessages.REQUIRED,
'name.additional.username': ErrorMessages.REQUIRED,
};
Expand Down Expand Up @@ -318,13 +318,13 @@ test('Form/hooks/DynamicField', () => {
};

const errors4 = {
name: false,
name: undefined,
'name.id': false,
'name.name': ErrorMessages.REQUIRED,
'name.description': ErrorMessages.REQUIRED,
'name.settings': ErrorMessages.REQUIRED,
'name.autor': false,
'name.autor.external': false,
'name.autor': undefined,
'name.autor.external': undefined,
'name.autor.external.name': ErrorMessages.REQUIRED,
'name.autor.external.age': ErrorMessages.REQUIRED,
'name.autor.external.license': ErrorMessages.REQUIRED,
Expand Down Expand Up @@ -368,13 +368,13 @@ test('Form/hooks/DynamicField', () => {
};

const errors5 = {
name: false,
name: undefined,
'name.id': false,
'name.name': ErrorMessages.REQUIRED,
'name.description': ErrorMessages.REQUIRED,
'name.settings': ErrorMessages.REQUIRED,
'name.autor': false,
'name.autor.external': false,
'name.autor': undefined,
'name.autor.external': undefined,
'name.autor.external.name': ErrorMessages.REQUIRED,
'name.autor.external.age': ErrorMessages.REQUIRED,
'name.autor.external.license': ErrorMessages.REQUIRED,
Expand Down
2 changes: 2 additions & 0 deletions src/lib/core/components/Form/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ export const OBJECT_ARRAY_FLAG = '____arr-obj';
export const OBJECT_ARRAY_CNT = '____arr-obj-cnt';

export const SPEC_TYPE_FOR_GENERATE_BUTTON = ['base', 'password', 'textarea'];

export const EMPTY_MUTATOR = '____empty-mutator';
16 changes: 8 additions & 8 deletions src/lib/core/components/Form/hooks/__tests__/useField.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,12 +252,12 @@ describe('Form/hooks/useField', () => {
expect(mirror.field.useStore?.store.values[name]).not.toBe(nextValue);
expect(mirror.field.useStore?.store.values[name]).toMatchObject(nextValue);
expect(mirror.field.useStore?.store.errors).toMatchObject({
[name]: false,
[name]: undefined,
[`${name}.key`]: 'too long',
});

expect(mirror.controller[name]?.useField?.meta.dirty).toBe(true);
expect(mirror.controller[name]?.useField?.meta.error).toBe(false);
expect(mirror.controller[name]?.useField?.meta.error).toBe(undefined);
expect(mirror.controller[name]?.useField?.meta.invalid).toBe(false);
expect(mirror.controller[name]?.useField?.meta.modified).toBe(true);
expect(mirror.controller[name]?.useField?.meta.touched).toBe(true);
Expand Down Expand Up @@ -285,12 +285,12 @@ describe('Form/hooks/useField', () => {
expect(mirror.field.useStore?.store.values[name]).not.toBe(value[name]);
expect(mirror.field.useStore?.store.values[name]).toMatchObject(value[name]);
expect(mirror.field.useStore?.store.errors).toMatchObject({
[name]: false,
[name]: undefined,
[`${name}.key`]: false,
});

expect(mirror.controller[name]?.useField?.meta.dirty).toBe(false);
expect(mirror.controller[name]?.useField?.meta.error).toBe(false);
expect(mirror.controller[name]?.useField?.meta.error).toBe(undefined);
expect(mirror.controller[name]?.useField?.meta.invalid).toBe(false);
expect(mirror.controller[name]?.useField?.meta.modified).toBe(true);
expect(mirror.controller[name]?.useField?.meta.touched).toBe(true);
Expand Down Expand Up @@ -343,10 +343,10 @@ describe('Form/hooks/useField', () => {
expect(mirror.controller[name]?.useField?.input.value).toBe(undefined);
expect(mirror.controller[name]?.useField?.arrayInput.value).toBe(undefined);
expect(mirror.field.useStore?.store.values[name]).toBe(undefined);
expect(mirror.field.useStore?.store.errors).toMatchObject({[name]: false});
expect(mirror.field.useStore?.store.errors).toMatchObject({[name]: undefined});

expect(mirror.controller[name]?.useField?.meta.dirty).toBe(true);
expect(mirror.controller[name]?.useField?.meta.error).toBe(false);
expect(mirror.controller[name]?.useField?.meta.error).toBe(undefined);
expect(mirror.controller[name]?.useField?.meta.invalid).toBe(false);
expect(mirror.controller[name]?.useField?.meta.modified).toBe(true);
expect(mirror.controller[name]?.useField?.meta.touched).toBe(true);
Expand Down Expand Up @@ -591,10 +591,10 @@ describe('Form/hooks/useField', () => {
expect(mirror.controller[name]?.useField?.arrayInput.value).toMatchObject(nextValue1);
expect(mirror.field.useStore?.store.values[name]).toMatchObject(nextValue1);

expect(mirror.field.useStore?.store.errors).toMatchObject({[name]: false});
expect(mirror.field.useStore?.store.errors).toMatchObject({[name]: undefined});

expect(mirror.controller[name]?.useField?.meta.dirty).toBe(true);
expect(mirror.controller[name]?.useField?.meta.error).toBe(false);
expect(mirror.controller[name]?.useField?.meta.error).toBe(undefined);
expect(mirror.controller[name]?.useField?.meta.invalid).toBe(false);
expect(mirror.controller[name]?.useField?.meta.modified).toBe(true);
expect(mirror.controller[name]?.useField?.meta.touched).toBe(true);
Expand Down
2 changes: 1 addition & 1 deletion src/lib/core/components/Form/hooks/__tests__/useIntegrationFF.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ describe('Form/hooks/useIntegrationFF', () => {
mirror.controller[name]?.useField?.input.onChange({});
});

expect(mirror.field.useStore?.store.errors[name]).toBe(false);
expect(mirror.field.useStore?.store.errors[name]).toBe(undefined);
expect(mirror.field.useIntegrationFF?.props.validate()).toBe(undefined);
expect(form?.getState().errors?.[name]).toBe(undefined);
});
Expand Down
3 changes: 3 additions & 0 deletions src/lib/core/components/Form/hooks/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ export * from './useDynamicFormsCtx';
export * from './useField';
export * from './useGenerateRandomValue';
export * from './useIntegrationFF';
export * from './useMutateDFState';
export * from './useMutators';
export * from './useRender';
export * from './useStore';
export * from './useStoreValue';
export * from './useValidate';
export * from './useMonaco';
export * from './useSearchStore';
Expand Down
Loading