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

package/src/hooks/useCanEditRecord/useCanEditRecord.ts

@@ -1,71 +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 {PermissionsActions, PermissionTypes, useGetLibraryPermissionsQuery, useIsAllowedQuery} from '_ui/_gqlTypes';
-
-export interface IUseCanEditRecordHook {
-    loading: boolean;
-    canEdit: boolean;
-    isReadOnly: boolean;
-}
-
-export const useCanEditRecord = (library: {id: string}, recordId?: string): IUseCanEditRecordHook => {
-    const isCreationMode = !recordId;
-
-    // Query runs if record is specified (= record edition)
-    const {
-        loading: recordPermissionsLoading,
-        error: recordPermissionsError,
-        data: recordPermissionsData
-    } = useIsAllowedQuery({
-        variables: {
-            type: PermissionTypes.record,
-            applyTo: library.id,
-            target: {
-                recordId
-            },
-            actions: [
-                PermissionsActions.access_record,
-                PermissionsActions.create_record,
-                PermissionsActions.edit_record,
-                PermissionsActions.delete_record
-            ]
-        },
-        skip: isCreationMode,
-        fetchPolicy: 'cache-and-network'
-    });
-
-    // Query runs if record is not specified (= record creation)
-    const {
-        loading: libraryPermissionsLoading,
-        error: libraryPermissionsError,
-        data: libraryPermissionsData
-    } = useGetLibraryPermissionsQuery({
-        variables: {libraryId: [library.id]},
-        skip: !isCreationMode,
-        fetchPolicy: 'cache-and-network'
-    });
-
-    if (recordPermissionsError || libraryPermissionsError) {
-        return {loading: false, canEdit: false, isReadOnly: true};
-    }
-
-    const libraryPermissionsElem = libraryPermissionsData?.libraries.list[0];
-    const recordPermissionsElem: {[key in PermissionsActions]?: boolean} = recordPermissionsData?.isAllowed.reduce(
-        (recordPerms, perm) => {
-            recordPerms[perm.name] = perm.allowed;
-            return recordPerms;
-        },
-        {}
-    );
-
-    return {
-        loading: recordPermissionsLoading || libraryPermissionsLoading,
-        canEdit: isCreationMode
-            ? libraryPermissionsElem?.permissions.create_record
-            : recordPermissionsElem?.access_record,
-        isReadOnly: isCreationMode
-            ? !libraryPermissionsElem?.permissions.create_record
-            : !recordPermissionsElem?.edit_record
-    };
-};

package/src/hooks/useExecuteAddViewMutation/useExecuteAddViewMutation.ts

@@ -1,54 +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 {FetchResult} from '@apollo/client';
-import {
-    AddViewMutation,
-    AddViewMutationVariables,
-    GetViewsListQuery,
-    GetViewsListQueryVariables,
-    useAddViewMutation
-} from '_ui/_gqlTypes';
-import {getViewsListQuery} from '_ui/_queries/views/getViewsListQuery';
-
-export interface IUseAddViewMutationHook {
-    addView: (variables: AddViewMutationVariables) => Promise<FetchResult<AddViewMutation>>;
-}
-
-export default function useExecuteAddViewMutation(): IUseAddViewMutationHook {
-    const [executeAddView] = useAddViewMutation();
-
-    return {
-        addView(variables) {
-            return executeAddView({
-                variables,
-                update: (cache, mutationResult, options) => {
-                    if (options.variables.view.id) {
-                        return; // it's an update
-                    }
-
-                    const queryToUpdate = {
-                        query: getViewsListQuery,
-                        variables: {
-                            libraryId: options.variables.view.library
-                        }
-                    };
-
-                    const cacheData = cache.readQuery<GetViewsListQuery, GetViewsListQueryVariables>(queryToUpdate);
-
-                    if (cacheData) {
-                        cache.writeQuery<GetViewsListQuery, GetViewsListQueryVariables>({
-                            ...queryToUpdate,
-                            data: {
-                                views: {
-                                    list: [...cacheData.views.list, mutationResult.data.saveView],
-                                    totalCount: cacheData.views.totalCount + 1
-                                }
-                            }
-                        });
-                    }
-                }
-            });
-        }
-    };
-}

package/src/hooks/useExecuteDeleteViewMutation/useExecuteDeleteViewMutation.ts

@@ -1,29 +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 {FetchResult} from '@apollo/client';
-import {WithTypename} from '@leav/utils';
-import {DeleteViewMutation, useDeleteViewMutation} from '_ui/_gqlTypes';
-
-export interface IUseExecuteDeleteViewMutationHook {
-    deleteView: (viewId: string) => Promise<FetchResult<DeleteViewMutation>>;
-}
-
-export default function useExecuteDeleteViewMutation(): IUseExecuteDeleteViewMutationHook {
-    const [executeDeleteView] = useDeleteViewMutation();
-
-    return {
-        deleteView(viewId: string) {
-            return executeDeleteView({
-                variables: {
-                    viewId
-                },
-                update: (cache, {data}) => {
-                    const cacheKey = cache.identify(data.deleteView as WithTypename<DeleteViewMutation['deleteView']>);
-                    cache.evict({id: cacheKey});
-                    cache.gc();
-                }
-            });
-        }
-    };
-}

package/src/hooks/useGetLibraryDetailExtendedQuery/useGetLibraryDetailExtendedQuery.ts

@@ -1,30 +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 {useQuery} from '@apollo/client';
-import {
-    getLibraryDetailExtendedQuery,
-    IGetLibraryDetailExtendedQuery,
-    IGetLibraryDetailExtendedVariables
-} from '_ui/_queries/libraries/getLibraryDetailExtendQuery';
-
-export interface IUseGetLibraryDetailExtendedQueryHookParams {
-    library: string;
-}
-
-const DEPTH_EMBEDDED_FIELDS = 100;
-
-export default function useGetLibraryDetailExtendedQuery({library}: IUseGetLibraryDetailExtendedQueryHookParams) {
-    const query = useQuery<IGetLibraryDetailExtendedQuery, IGetLibraryDetailExtendedVariables>(
-        getLibraryDetailExtendedQuery(DEPTH_EMBEDDED_FIELDS),
-        {
-            variables: {
-                libId: [library]
-            },
-            skip: !library
-        }
-    );
-
-    return query;
-}

package/src/hooks/useGetPreparedFileData/useGetPreparedFileData.ts

@@ -1,54 +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 {QueryResult} from '@apollo/client';
-import {useEffect, useState} from 'react';
-import {useGetFileDataQuery} from '_ui/_gqlTypes';
-import {IFileDataWithPreviewsStatus} from '../../_queries/records/getFileDataQuery';
-
-export interface IUseGetFileDataQueryHook {
-    loading: boolean;
-    error: QueryResult['error'];
-    fileData: IFileDataWithPreviewsStatus;
-}
-
-export default function useGetPreparedFileData(libraryId: string, fileId: string): IUseGetFileDataQueryHook {
-    const [fileData, setFileData] = useState<IFileDataWithPreviewsStatus>();
-
-    const {data, error, loading} = useGetFileDataQuery({
-        fetchPolicy: 'cache-and-network',
-        skip: !fileId,
-        variables: {library: libraryId, fileId, previewsStatusAttribute: `${libraryId}_previews_status`}
-    });
-
-    useEffect(() => {
-        if (data) {
-            if (!data.records.list?.length) {
-                setFileData(null);
-                return;
-            }
-
-            const rawFileData = data.records?.list[0];
-            // Convert preview status to an object
-            const previewsStatus = rawFileData?.previews_status
-                ? JSON.parse(rawFileData.previews_status?.[0]?.value)
-                : null;
-            const file: IFileDataWithPreviewsStatus = {
-                ...rawFileData,
-                previews_status: previewsStatus,
-                isPreviewsGenerationPending: previewsStatus
-                    ? Object.keys(previewsStatus).some(key => previewsStatus[key]?.status === -1)
-                    : false
-            };
-
-            setFileData(file);
-        }
-    }, [data]);
-
-    return {
-        error,
-        loading: loading || (!loading && typeof fileData === undefined),
-        fileData
-    };
-}

package/src/hooks/useGetRecordForm/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
-export * from './useGetRecordForm';
-export {default} from './useGetRecordForm';

package/src/hooks/useGetRecordForm/useGetRecordForm.test.tsx

@@ -1,159 +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 {MockedProvider} from '@apollo/client/testing';
-import {FormElementTypes, RecordFormDocument} from '_ui/_gqlTypes';
-import {renderHook, waitFor} from '_ui/_tests/testUtils';
-import {mockFormAttribute} from '_ui/__mocks__/common/attribute';
-import {mockRecord} from '_ui/__mocks__/common/record';
-import useGetRecordForm from './useGetRecordForm';
-
-describe('useGetRecordForm', () => {
-    test('Run query and format result', async () => {
-        const mocks = [
-            {
-                request: {
-                    query: RecordFormDocument,
-                    variables: {
-                        libraryId: 'test_lib',
-                        recordId: '987654',
-                        formId: 'edition',
-                        version: [
-                            {
-                                treeId: 'tree_1',
-                                treeNodeId: '1337'
-                            }
-                        ]
-                    }
-                },
-                result: {
-                    data: {
-                        recordForm: {
-                            id: 'edition',
-                            recordId: '987654',
-                            library: {
-                                id: 'test_lib'
-                            },
-                            elements: [
-                                {
-                                    id: '123456789',
-                                    containerId: '_root',
-                                    uiElementType: 'text_input',
-                                    attribute: {
-                                        ...mockFormAttribute,
-                                        values_list: null,
-                                        __typename: 'StandardAttribute'
-                                    },
-                                    type: FormElementTypes.field,
-                                    valueError: null,
-                                    values: [
-                                        {
-                                            __typename: 'Value',
-                                            id_value: '987654321',
-                                            created_at: 1234567890,
-                                            modified_at: 1234567890,
-                                            created_by: {
-                                                __typename: 'User',
-                                                id: '1',
-                                                whoAmI: mockRecord
-                                            },
-                                            modified_by: {
-                                                __typename: 'User',
-                                                id: '1',
-                                                whoAmI: mockRecord
-                                            },
-                                            metadata: null,
-                                            version: [
-                                                {
-                                                    __typename: 'ValueVersion',
-                                                    treeId: 'tree_1',
-                                                    treeNode: {
-                                                        id: '1337',
-                                                        record: {
-                                                            id: '1337',
-                                                            whoAmI: {
-                                                                id: '1337',
-                                                                label: 'Some tree element',
-                                                                library: {
-                                                                    id: 'test_lib'
-                                                                }
-                                                            }
-                                                        }
-                                                    }
-                                                }
-                                            ],
-                                            value: 'some value',
-                                            raw_value: 'some value'
-                                        }
-                                    ],
-                                    settings: []
-                                }
-                            ]
-                        }
-                    }
-                }
-            }
-        ];
-
-        const {result} = renderHook(
-            () =>
-                useGetRecordForm({
-                    libraryId: 'test_lib',
-                    recordId: '987654',
-                    formId: 'edition',
-                    version: {tree_1: {id: '1337', label: 'Some tree element'}}
-                }),
-            {
-                wrapper: ({children}) => <MockedProvider mocks={mocks}>{children as JSX.Element}</MockedProvider>
-            }
-        );
-
-        expect(result.current.loading).toBe(true);
-
-        await waitFor(() => expect(result.current.loading).toBe(false));
-
-        expect(result.current.error).toBeUndefined();
-        expect(result.current.recordForm).toMatchObject({
-            id: 'edition',
-            recordId: '987654',
-            library: {
-                id: 'test_lib'
-            },
-            elements: [
-                {
-                    id: '123456789',
-                    containerId: '_root',
-                    uiElementType: 'text_input',
-                    type: FormElementTypes.field,
-                    valueError: null,
-                    attribute: {...mockFormAttribute, values_list: null},
-                    values: [
-                        {
-                            id_value: '987654321',
-                            created_at: 1234567890,
-                            modified_at: 1234567890,
-                            created_by: {
-                                id: '1',
-                                whoAmI: mockRecord
-                            },
-                            modified_by: {
-                                id: '1',
-                                whoAmI: mockRecord
-                            },
-                            metadata: [],
-                            version: {
-                                tree_1: {
-                                    id: '1337',
-                                    label: 'Some tree element'
-                                }
-                            },
-                            value: 'some value',
-                            raw_value: 'some value'
-                        }
-                    ],
-                    settings: []
-                }
-            ]
-        });
-    });
-});

package/src/hooks/useGetRecordForm/useGetRecordForm.ts

@@ -1,153 +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 {objectToNameValueArray, Override} from '@leav/utils';
-import React from 'react';
-import {IValueVersion} from '_ui/types/values';
-import {
-    RecordFormElementFragment,
-    RecordFormQuery,
-    RecordFormQueryResult,
-    useRecordFormQuery,
-    ValueDetailsLinkValueFragment,
-    ValueDetailsTreeValueFragment,
-    ValueDetailsValueFragment
-} from '_ui/_gqlTypes';
-import {arrayValueVersionToObject} from '_ui/_utils';
-
-export type RecordFormElementsValueStandardValue = Override<
-    ValueDetailsValueFragment,
-    {
-        version?: IValueVersion;
-        metadata?: Array<{
-            name: string;
-            value: Override<ValueDetailsValueFragment['metadata'][number]['value'], {version?: IValueVersion}>;
-        }>;
-    }
->;
-
-export type RecordFormElementsValueLinkValue = Override<
-    ValueDetailsLinkValueFragment,
-    {
-        version?: IValueVersion;
-        metadata?: Array<{
-            name: string;
-            value: Override<ValueDetailsLinkValueFragment['metadata'][number]['value'], {version?: IValueVersion}>;
-        }>;
-    }
->;
-
-export type RecordFormElementsValueTreeValue = Override<
-    ValueDetailsTreeValueFragment,
-    {
-        version?: IValueVersion;
-        metadata?: Array<{
-            name: string;
-            value: Override<ValueDetailsTreeValueFragment['metadata'][number]['value'], {version?: IValueVersion}>;
-        }>;
-    }
->;
-
-export type RecordFormElementsValue =
-    | RecordFormElementsValueStandardValue
-    | RecordFormElementsValueLinkValue
-    | RecordFormElementsValueTreeValue;
-
-export type RecordFormElement = Override<
-    RecordFormElementFragment,
-    {
-        values: RecordFormElementsValue[];
-    }
->;
-
-export type IRecordForm = Override<
-    RecordFormQuery['recordForm'],
-    {
-        elements: RecordFormElement[];
-    }
->;
-
-export interface IUseGetRecordFormHook {
-    loading: boolean;
-    error: ApolloError;
-    recordForm: IRecordForm;
-    refetch: RecordFormQueryResult['refetch'];
-}
-
-const useGetRecordForm = ({
-    libraryId,
-    recordId,
-    formId,
-    version
-}: {
-    libraryId: string;
-    recordId: string;
-    formId: string;
-    version: IValueVersion;
-}): IUseGetRecordFormHook => {
-    const [recordForm, setRecordForm] = React.useState<IRecordForm>(null);
-
-    const requestVersion = version
-        ? objectToNameValueArray(version)
-              .filter(arrayVersion => !!arrayVersion.value)
-              .map(({name, value}) => ({
-                  treeId: name,
-                  treeNodeId: value.id
-              }))
-        : null;
-
-    const {loading, error, refetch} = useRecordFormQuery({
-        fetchPolicy: 'network-only',
-        notifyOnNetworkStatusChange: true,
-        variables: {
-            libraryId,
-            recordId,
-            formId,
-            version: requestVersion
-        },
-        onCompleted: data => {
-            // Transform result to format values version to a more convenient object
-            const recordFormFormatted: IRecordForm = {
-                ...data.recordForm,
-                elements: data.recordForm.elements.map(
-                    (element): RecordFormElement => {
-                        return {
-                            ...element,
-                            values: (element?.values ?? []).map(value => {
-                                return {
-                                    ...value,
-                                    version: arrayValueVersionToObject(value.version ?? []),
-                                    metadata: (value.metadata ?? []).map(metadata => ({
-                                        ...metadata,
-                                        value: {
-                                            ...metadata.value,
-                                            version: arrayValueVersionToObject(metadata.value.version ?? [])
-                                        }
-                                    }))
-                                };
-                            })
-                        };
-                    }
-                )
-            };
-
-            setRecordForm(recordFormFormatted);
-        }
-    });
-
-    const refetchRecordForm = () => {
-        return refetch({
-            libraryId,
-            recordId,
-            formId,
-            version: requestVersion
-        });
-    };
-
-    // To avoid a moment where loading is done and record form is not available yet, we force loading to be true until
-    // record form is available
-    return {loading: loading || (!recordForm && !error), error, recordForm, refetch: refetchRecordForm};
-};
-
-export default useGetRecordForm;

package/src/hooks/useGetRecordUpdatesSubscription/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 {useGetRecordUpdatesSubscription} from './useGetRecordUpdatesSubscription';

package/src/hooks/useGetRecordUpdatesSubscription/useGetRecordUpdatesSubscription.ts

@@ -1,21 +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 {useValuesCacheUpdate} from '_ui/hooks/useValuesCacheUpdate';
-import {RecordUpdateFilterInput, useRecordUpdateSubscription} from '_ui/_gqlTypes';
-
-export const useGetRecordUpdatesSubscription = (filters: RecordUpdateFilterInput, skip?: boolean) => {
-    const updateValuesCache = useValuesCacheUpdate();
-
-    return useRecordUpdateSubscription({
-        skip,
-        variables: {filters},
-        onData: ({data}) => {
-            const {record, updatedValues} = data.data.recordUpdate;
-            updateValuesCache(
-                record.whoAmI,
-                updatedValues.map(val => val.value)
-            );
-        }
-    });
-};

package/src/hooks/useGetRecordValuesQuery/useGetRecordValuesQuery.ts

@@ -1,82 +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 {QueryResult, useQuery} from '@apollo/client';
-import {Override} from '@leav/utils';
-import {useState} from 'react';
-import {RecordFilterCondition, RecordFilterInput, RecordFilterOperator} from '_ui/_gqlTypes';
-import {
-    getRecordColumnsValues,
-    GetRecordColumnsValuesRecord,
-    IGetRecordColumnsValues,
-    IGetRecordColumnsValuesVariables
-} from '../../_queries/records/getRecordColumnsValues';
-
-export interface IColumnsValuesByRecord {
-    [recordId: string]: GetRecordColumnsValuesRecord;
-}
-
-export type IUseGetRecordColumnsValuesQueryHook = Override<
-    QueryResult<IGetRecordColumnsValues>,
-    {data: IColumnsValuesByRecord}
->;
-
-const _recordIdsToQueryFilters = (recordIds: string[]): RecordFilterInput[] =>
-    recordIds.reduce((allFilters: RecordFilterInput[], recordId: string, i: number) => {
-        if (i) {
-            allFilters.push({operator: RecordFilterOperator.OR});
-        }
-
-        allFilters.push({field: 'id', condition: RecordFilterCondition.EQUAL, value: recordId});
-
-        return allFilters;
-    }, []);
-
-export const useGetRecordValuesQuery = (
-    libraryId: string,
-    columns: string[],
-    recordIds: string[]
-): IUseGetRecordColumnsValuesQueryHook => {
-    const [queryData, setQueryData] = useState<IColumnsValuesByRecord>();
-
-    const _convertQueryResult = (queryResult: IGetRecordColumnsValues): IColumnsValuesByRecord =>
-        (queryResult.records.list ?? []).reduce((valuesByRecord, recordValues) => {
-            valuesByRecord[recordValues._id] = recordValues;
-            return valuesByRecord;
-        }, {});
-
-    const query = useQuery<IGetRecordColumnsValues, IGetRecordColumnsValuesVariables>(getRecordColumnsValues(columns), {
-        variables: {
-            library: libraryId,
-            // Turn records ids into filters with OR operators
-            filters: _recordIdsToQueryFilters(recordIds)
-        },
-        skip: !libraryId || !columns.length || !recordIds.length,
-        onCompleted: data => {
-            const cleanData: IColumnsValuesByRecord = _convertQueryResult(data);
-            setQueryData(cleanData);
-        }
-    });
-
-    const customRefetch = async (refetchRecordIds: string[]) => {
-        const customVariables = {
-            filters: _recordIdsToQueryFilters(refetchRecordIds ?? [])
-        };
-
-        const refetchData = await query.refetch(customVariables);
-
-        const cleanData: IColumnsValuesByRecord = _convertQueryResult(refetchData.data);
-        setQueryData({...queryData, ...cleanData});
-
-        return refetchData;
-    };
-
-    // @ts-ignore
-    return {
-        ...query,
-        loading: query.loading || typeof queryData === undefined,
-        data: queryData,
-        refetch: customRefetch
-    };
-};

package/src/hooks/useLang/__mocks__/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 useLang from './useLang';
-export default useLang;