@leav/ui 0.0.1-alpha-2 → 0.0.1-alpha-3

package/src/components/RecordEdition/EditRecord/_types.ts

@@ -1,154 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {
-    AnyPrimitive,
-    FormFieldTypes,
-    FormUIElementTypes,
-    ICommonFieldsSettings,
-    IDateRangeValue,
-    IKeyValue,
-    Override
-} from '@leav/utils';
-import {Checkbox, DatePicker, InputRef} from 'antd';
-import {MutableRefObject} from 'react';
-import {RecordFormElementsValue} from '_ui/hooks/useGetRecordForm';
-import {IRecordIdentity, IRecordIdentityWhoAmI} from '_ui/types/records';
-import {ITreeNodeWithRecord} from '_ui/types/trees';
-import {IValueVersion} from '_ui/types/values';
-import {RecordFormAttributeFragment, SaveValueBatchMutation, ValueDetailsFragment, ValueInput} from '_ui/_gqlTypes';
-import {IRecordPropertyAttribute, RecordProperty} from '_ui/_queries/records/getRecordPropertiesQuery';
-import {RecordFormElementFragment} from '../../../_gqlTypes';
-import {IStandardFieldReducerState, IStandardFieldValue} from './reducers/standardFieldReducer/standardFieldReducer';
-
-export interface IValueToSubmit {
-    attribute: string;
-    value: AnyPrimitive | null;
-    idValue: string;
-    metadata?: IKeyValue<AnyPrimitive>;
-}
-
-export enum APICallStatus {
-    SUCCESS = 'SUCCESS',
-    ERROR = 'ERROR',
-    PARTIAL = 'PARTIAL'
-}
-
-export type FieldSubmitMultipleFunc = (
-    record: IRecordIdentityWhoAmI,
-    values: IValueToSubmit[],
-    version?: IValueVersion,
-    deleteEmpty?: boolean
-) => Promise<ISubmitMultipleResult>;
-export interface ISubmitMultipleResult {
-    status: APICallStatus;
-    error?: string;
-    values?: ValueDetailsFragment[];
-    errors?: SaveValueBatchMutation['saveValueBatch']['errors'];
-}
-
-export interface IDeleteValueResult {
-    status: APICallStatus;
-    error?: string;
-}
-
-export interface IRecordEditionContext {
-    elements: IFormElementsByContainer;
-    readOnly: boolean;
-    record: IRecordIdentityWhoAmI;
-}
-
-export interface IFormElementsByContainer {
-    [containerId: string]: Array<FormElement<unknown>>;
-}
-
-export interface ISubmittedValueStandard extends ISubmittedValueBase {
-    value: AnyPrimitive;
-}
-
-export interface ISubmittedValueLink extends ISubmittedValueBase {
-    value: IRecordIdentity;
-}
-
-export interface ISubmittedValueTree extends ISubmittedValueBase {
-    value: ITreeNodeWithRecord;
-}
-
-export type SubmittedValue = ISubmittedValueStandard | ISubmittedValueLink | ISubmittedValueTree;
-
-export type SubmitValueFunc = (values: SubmittedValue[], version: IValueVersion) => Promise<ISubmitMultipleResult>;
-export type DeleteValueFunc = (value: ValueInput | null, attribute: string) => Promise<IDeleteValueResult>;
-export type DeleteMultipleValuesFunc = (
-    attribute: string,
-    values: RecordProperty[],
-    version: IValueVersion
-) => Promise<ISubmitMultipleResult>;
-
-export type MetadataSubmitValueFunc = (
-    value: RecordProperty,
-    attribute: RecordFormAttributeFragment,
-    metadata: IKeyValue<AnyPrimitive>
-) => Promise<ISubmitMultipleResult>;
-
-export interface ISubmittedValueBase {
-    attribute: RecordFormAttributeFragment;
-    idValue: string;
-    metadata?: IKeyValue<AnyPrimitive>;
-}
-
-export interface IFormElementProps<SettingsType> {
-    element: FormElement<SettingsType>;
-    onValueSubmit?: SubmitValueFunc;
-    onValueDelete?: DeleteValueFunc;
-    onDeleteMultipleValues?: DeleteMultipleValuesFunc;
-    metadataEdit?: boolean;
-}
-
-export type FormElement<SettingsType> = Override<
-    RecordFormElementFragment,
-    {
-        settings: SettingsType;
-        uiElementType: FormUIElementTypes | FormFieldTypes;
-        values: RecordFormElementsValue[];
-    }
-> & {
-    uiElement: (props: IFormElementProps<unknown>) => JSX.Element;
-};
-
-export interface IDependencyValues {
-    [attributeId: string]: Array<{id: string; library: string}>;
-}
-
-export interface IStandardInputProps {
-    state: IStandardFieldReducerState;
-    fieldValue: IStandardFieldValue;
-    onFocus: () => void;
-    onChange: (value: string) => void;
-    onSubmit: (valueToSave: StandardValueTypes) => void;
-    onPressEnter?: () => void;
-    settings: ICommonFieldsSettings;
-    inputRef: MutableRefObject<InputRefPossibleTypes>;
-}
-
-export type InputRefPossibleTypes = InputRef | typeof DatePicker | typeof Checkbox;
-
-export type StandardValueTypes = AnyPrimitive | IDateRangeValue;
-
-export enum FieldScope {
-    INHERITED = 'INHERITED', // inherited values
-    CURRENT = 'CURRENT' // values of "current" version, eg. the version selected in the form
-}
-
-export interface ICommonFieldsReducerState<ValuesType> {
-    record: IRecordIdentityWhoAmI;
-    formElement: FormElement<ICommonFieldsSettings>;
-    attribute: IRecordPropertyAttribute;
-    isReadOnly: boolean;
-    activeScope: FieldScope;
-    values: {
-        [scope in FieldScope]: {
-            version: IValueVersion;
-            values: ValuesType;
-        } | null;
-    };
-}

package/src/components/RecordEdition/EditRecord/helpers/extractFormElements/extractFormElements.test.tsx

@@ -1,115 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {FormFieldTypes, FormUIElementTypes} from '@leav/utils';
-import {FormElementTypes} from '_ui/_gqlTypes';
-import {mockFormElementContainer, mockFormElementInput, mockRecordForm} from '_ui/__mocks__/common/form';
-import Container from '../../uiElements/Container';
-import StandardField from '../../uiElements/StandardField';
-import {extractFormElements} from './extractFormElements';
-
-jest.mock('../../uiElements/StandardField', () => {
-    return function MockStandardField() {
-        return <div>StandardField</div>;
-    };
-});
-
-describe('extractFormElements', () => {
-    test('Return form elements grouped by container', async () => {
-        const baseForm = {
-            ...mockRecordForm,
-            elements: [
-                {
-                    ...mockFormElementInput,
-                    id: 'rootElem1',
-                    containerId: '__root',
-                    settings: [{key: 'foo', value: 'bar'}],
-                    attribute: null,
-                    type: FormElementTypes.field,
-                    uiElementType: FormFieldTypes.TEXT_INPUT
-                },
-                {
-                    ...mockFormElementContainer,
-                    id: 'rootElem2',
-                    containerId: '__root',
-                    settings: [],
-                    attribute: null,
-                    type: FormElementTypes.layout,
-                    uiElementType: FormUIElementTypes.FIELDS_CONTAINER
-                },
-                {
-                    ...mockFormElementContainer,
-                    id: 'containerElem1',
-                    containerId: 'rootElem2',
-                    settings: [],
-                    attribute: null,
-                    type: FormElementTypes.layout,
-                    uiElementType: FormUIElementTypes.FIELDS_CONTAINER
-                },
-                {
-                    ...mockFormElementInput,
-                    id: 'subContainerElem1',
-                    containerId: 'containerElem1',
-                    settings: [],
-                    attribute: null,
-                    type: FormElementTypes.field,
-                    uiElementType: FormFieldTypes.TEXT_INPUT
-                }
-            ]
-        };
-
-        const convertForm = extractFormElements(baseForm);
-
-        const expectation = {
-            __root: [
-                {
-                    ...mockFormElementInput,
-                    id: 'rootElem1',
-                    containerId: '__root',
-                    settings: {foo: 'bar'},
-                    attribute: null,
-                    type: FormElementTypes.field,
-                    uiElementType: FormFieldTypes.TEXT_INPUT,
-                    uiElement: StandardField
-                },
-                {
-                    ...mockFormElementContainer,
-                    id: 'rootElem2',
-                    containerId: '__root',
-                    settings: {},
-                    attribute: null,
-                    type: FormElementTypes.layout,
-                    uiElementType: FormUIElementTypes.FIELDS_CONTAINER,
-                    uiElement: Container
-                }
-            ],
-            rootElem2: [
-                {
-                    ...mockFormElementContainer,
-                    id: 'containerElem1',
-                    containerId: 'rootElem2',
-                    settings: {},
-                    attribute: null,
-                    type: FormElementTypes.layout,
-                    uiElementType: FormUIElementTypes.FIELDS_CONTAINER,
-                    uiElement: Container
-                }
-            ],
-            containerElem1: [
-                {
-                    ...mockFormElementInput,
-                    id: 'subContainerElem1',
-                    containerId: 'containerElem1',
-                    settings: {},
-                    attribute: null,
-                    type: FormElementTypes.field,
-                    uiElementType: FormFieldTypes.TEXT_INPUT,
-                    uiElement: StandardField
-                }
-            ]
-        };
-
-        // Test on stringified objext due to failure caused by some object references
-        expect(convertForm).toEqual(expectation);
-    });
-});

package/src/components/RecordEdition/EditRecord/helpers/extractFormElements/extractFormElements.tsx

@@ -1,26 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {IRecordForm} from '_ui/hooks/useGetRecordForm/useGetRecordForm';
-import {formComponents} from '../../uiElements';
-import ErrorField from '../../uiElements/ErrorField';
-import {IFormElementsByContainer} from '../../_types';
-
-export const extractFormElements = (form: IRecordForm): IFormElementsByContainer =>
-    form.elements.reduce((allElements, element) => {
-        if (typeof allElements[element.containerId] === 'undefined') {
-            allElements[element.containerId] = [];
-        }
-
-        const uiElement = element.valueError ? ErrorField : formComponents[element.uiElementType];
-        allElements[element.containerId].push({
-            ...element,
-            uiElement,
-            settings: element.settings.reduce(
-                (allSettings, curSettings) => ({...allSettings, [curSettings.key]: curSettings.value}),
-                {}
-            )
-        });
-
-        return allElements;
-    }, {});

package/src/components/RecordEdition/EditRecord/helpers/extractFormElements/index.ts

@@ -1,5 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {extractFormElements} from './extractFormElements';
-export default extractFormElements;

package/src/components/RecordEdition/EditRecord/helpers/getActiveFieldValues/getActiveFieldValues.ts

@@ -1,8 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {ICommonFieldsReducerState} from '../../_types';
-
-export default <ValuesType = any>(state: ICommonFieldsReducerState<ValuesType>) => {
-    return state.values[state.activeScope].values;
-};

package/src/components/RecordEdition/EditRecord/helpers/getActiveFieldValues/index.ts

@@ -1,4 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-export {default} from './getActiveFieldValues';

package/src/components/RecordEdition/EditRecord/helpers/isCurrentVersion/index.ts

@@ -1,4 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-export {default} from './isCurrentVersion';

package/src/components/RecordEdition/EditRecord/helpers/isCurrentVersion/isCurrentVersion.test.ts

@@ -1,87 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {IValueVersion} from '_ui/types/values';
-import isCurrentVersion from './isCurrentVersion';
-
-describe('isCurrentVersion', () => {
-    test('Check if 2 given versions are strictly equals', async () => {
-        const refVersion: IValueVersion = {
-            tree1: {
-                id: '123456',
-                label: 'Some tree node'
-            },
-            tree2: {
-                id: '987654',
-                label: 'Some tree node'
-            }
-        };
-
-        const otherVersionWithOneDifference: IValueVersion = {
-            tree1: {
-                id: '123457',
-                label: 'Some tree node'
-            },
-            tree2: {
-                id: '987654',
-                label: 'Some tree node'
-            }
-        };
-
-        const otherVersionWithTwoDifferences: IValueVersion = {
-            tree1: {
-                id: '111111',
-                label: 'Some tree node'
-            },
-            tree2: {
-                id: '222222',
-                label: 'Some tree node'
-            }
-        };
-
-        const otherVersionWithMoreKeys: IValueVersion = {
-            tree1: {
-                id: '123456',
-                label: 'Some tree node'
-            },
-            tree2: {
-                id: '987654',
-                label: 'Some tree node'
-            },
-            tree3: {
-                id: '456123',
-                label: 'Some tree node'
-            }
-        };
-
-        const otherVersionWithDifferentKeys: IValueVersion = {
-            tree1: {
-                id: '123456',
-                label: 'Some tree node'
-            },
-            tree42: {
-                id: '987654',
-                label: 'Some tree node'
-            }
-        };
-
-        const otherVersionWithOneKey: IValueVersion = {
-            tree1: {
-                id: '123456',
-                label: 'Some tree node'
-            }
-        };
-
-        expect(isCurrentVersion(refVersion, refVersion)).toBe(true);
-        expect(isCurrentVersion(refVersion, otherVersionWithOneKey)).toBe(true);
-        expect(isCurrentVersion(null, null)).toBe(true);
-        expect(isCurrentVersion(undefined, undefined)).toBe(true);
-
-        expect(isCurrentVersion(refVersion, otherVersionWithOneDifference)).toBe(false);
-        expect(isCurrentVersion(refVersion, otherVersionWithTwoDifferences)).toBe(false);
-        expect(isCurrentVersion(refVersion, otherVersionWithMoreKeys)).toBe(false);
-        expect(isCurrentVersion(refVersion, otherVersionWithDifferentKeys)).toBe(false);
-        expect(isCurrentVersion(refVersion, null)).toBe(false);
-        expect(isCurrentVersion(null, otherVersionWithOneKey)).toBe(false);
-    });
-});

package/src/components/RecordEdition/EditRecord/helpers/isCurrentVersion/isCurrentVersion.ts

@@ -1,27 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {IValueVersion} from '_ui/types/values';
-
-/**
- * Check if given version matches the reference version. As reference version might contains
- * trees that are not in the given version, we only check the nodes of given version against reference version.
- */
-export default (referenceVersion: IValueVersion, valueVersion: IValueVersion) => {
-    if (referenceVersion === valueVersion) {
-        // Mostly for the case that both are null or undefined
-        return true;
-    }
-
-    if (!referenceVersion || !valueVersion) {
-        return false;
-    }
-
-    for (const versionTreeId of Object.keys(valueVersion)) {
-        if (referenceVersion?.[versionTreeId]?.id !== valueVersion[versionTreeId].id) {
-            return false;
-        }
-    }
-
-    return true;
-};

package/src/components/RecordEdition/EditRecord/hooks/__mocks__/useDeleteValueMutation.ts

@@ -1,8 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-export default function useDeleteValueMutation() {
-    return {
-        deleteValue: jest.fn()
-    };
-}

package/src/components/RecordEdition/EditRecord/hooks/__mocks__/useSaveValueMutation.ts

@@ -1,8 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-export default function useSaveValueMutation() {
-    return {
-        saveValue: jest.fn()
-    };
-}

package/src/components/RecordEdition/EditRecord/hooks/helpers/getPropertyCacheFieldName.ts

@@ -1,4 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-export default (attribute: string): string => `property({"attribute":"${attribute}"})`;

package/src/components/RecordEdition/EditRecord/hooks/useExecuteDeleteValueMutation.ts

@@ -1,50 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {ApolloError} from '@apollo/client';
-import {ErrorTypes} from '@leav/utils';
-import {useSharedTranslation} from '_ui/hooks/useSharedTranslation';
-import {useValuesCacheUpdate} from '_ui/hooks/useValuesCacheUpdate';
-import {IRecordIdentityWhoAmI} from '_ui/types/records';
-import {useDeleteValueMutation} from '_ui/_gqlTypes';
-import {APICallStatus, DeleteValueFunc} from '../_types';
-
-export interface IDeleteValueHook {
-    deleteValue: DeleteValueFunc;
-}
-
-export default function useExecuteDeleteValueMutation(record: IRecordIdentityWhoAmI): IDeleteValueHook {
-    const updateValuesCache = useValuesCacheUpdate();
-    const [executeDeleteValue] = useDeleteValueMutation({
-        update: (cache, {data: {deleteValue}}) => {
-            updateValuesCache(record, [deleteValue]);
-        }
-    });
-    const {t} = useSharedTranslation();
-
-    return {
-        deleteValue: async (value, attribute) => {
-            try {
-                await executeDeleteValue({
-                    variables: {
-                        library: record.library.id,
-                        attribute,
-                        recordId: record.id,
-                        value
-                    }
-                });
-                return {status: APICallStatus.SUCCESS};
-            } catch (err) {
-                const gqlError = (err as ApolloError).graphQLErrors[0];
-
-                const message = gqlError?.extensions?.code
-                    ? gqlError.extensions.code === ErrorTypes.VALIDATION_ERROR
-                        ? gqlError.extensions.fields[attribute]
-                        : t(`error.${gqlError.extensions.code}`)
-                    : (err as Error).message;
-
-                return {status: APICallStatus.ERROR, error: message};
-            }
-        }
-    };
-}

package/src/components/RecordEdition/EditRecord/hooks/useExecuteSaveValueBatchMutation.ts

@@ -1,75 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {ApolloError, useApolloClient} from '@apollo/client';
-import {ErrorTypes, objectToNameValueArray} from '@leav/utils';
-import {useSharedTranslation} from '_ui/hooks/useSharedTranslation';
-import {useValuesCacheUpdate} from '_ui/hooks/useValuesCacheUpdate';
-import {useSaveValueBatchMutation} from '_ui/_gqlTypes';
-import {APICallStatus, FieldSubmitMultipleFunc} from '../_types';
-
-export interface ISaveValueBatchHook {
-    saveValues: FieldSubmitMultipleFunc;
-    loading: boolean;
-}
-
-export default function useExecuteSaveValueBatchMutation(): ISaveValueBatchHook {
-    const {cache} = useApolloClient();
-    const [executeSaveValueBatch, {loading}] = useSaveValueBatchMutation();
-    const updateValuesCache = useValuesCacheUpdate();
-    const {t} = useSharedTranslation();
-
-    return {
-        saveValues: async (record, values, version, deleteEmpty = false) => {
-            try {
-                const saveRes = await executeSaveValueBatch({
-                    variables: {
-                        library: record.library.id,
-                        recordId: record.id,
-                        values: values.map(valueToSave => ({
-                            attribute: valueToSave.attribute,
-                            id_value: valueToSave.idValue,
-                            value: valueToSave.value !== null ? String(valueToSave.value) : null,
-                            metadata: valueToSave.metadata
-                                ? objectToNameValueArray(valueToSave.metadata).map(({name, value}) => ({
-                                      name,
-                                      value: String(value)
-                                  }))
-                                : null
-                        })),
-                        version: version
-                            ? objectToNameValueArray(version).map(v => ({treeId: v.name, treeNodeId: v.value.id}))
-                            : null,
-                        deleteEmpty
-                    }
-                });
-                const {values: savedValues, errors} = saveRes.data.saveValueBatch;
-
-                updateValuesCache(record, savedValues);
-
-                const status =
-                    errors?.length && savedValues.length
-                        ? APICallStatus.PARTIAL
-                        : errors?.length && !savedValues.length
-                        ? APICallStatus.ERROR
-                        : APICallStatus.SUCCESS;
-
-                return {
-                    status,
-                    ...saveRes.data.saveValueBatch
-                };
-            } catch (err) {
-                const gqlError = (err as ApolloError).graphQLErrors?.[0];
-
-                const message = gqlError?.extensions?.code
-                    ? gqlError.extensions.code === ErrorTypes.VALIDATION_ERROR
-                        ? Object.values(gqlError.extensions.fields).join('\n')
-                        : t(`error.${gqlError.extensions.code}`)
-                    : (err as Error).message;
-
-                return {status: APICallStatus.ERROR, error: message};
-            }
-        },
-        loading
-    };
-}

package/src/components/RecordEdition/EditRecord/hooks/useRecordEditionContext.ts

@@ -1,9 +0,0 @@
-// Copyright LEAV Solutions 2017
-// This file is released under LGPL V3
-// License text available at https://www.gnu.org/licenses/lgpl-3.0.txt
-import {createContext, useContext} from 'react';
-import {IRecordEditionContext} from '../_types';
-
-export const RecordEditionContext = createContext<IRecordEditionContext>({elements: {}, readOnly: false, record: null});
-
-export const useRecordEditionContext = () => useContext(RecordEditionContext);