The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { isHiddenSystemField } from '@/object-metadata/utils/isHiddenSystemField';
import { StyledSettingsDataModelTableBodyContainer } from '@/settings/data-model/components/SettingsDataModelTableBodyContainer';
import {
OBJECT_FIELD_TABLE_ROW_GRID_TEMPLATE_COLUMNS,
SettingsObjectFieldItemTableRow,
} from '@/settings/data-model/object-details/components/SettingsObjectFieldItemTableRow';
import { useMostlyEmptyFieldMetadataIds } from '@/settings/data-model/object-details/hooks/useMostlyEmptyFieldMetadataIds';
import { settingsObjectFieldsFamilyState } from '@/settings/data-model/object-details/states/settingsObjectFieldsFamilyState';
import { DropdownRoot } from '@/ui/layout/dropdown/components/DropdownRoot';
import { DropdownContent } from '@/ui/layout/dropdown/components/DropdownContent';
import { SortableTableHeader } from '@/ui/layout/table/components/SortableTableHeader';
import { Table } from '@/ui/layout/table/components/Table';
import { TableBody } from '@/ui/layout/table/components/TableBody';
import { TableHeader } from '@/ui/layout/table/components/TableHeader';
import { TableRow } from '@/ui/layout/table/components/TableRow';
import { useSortedArray } from '@/ui/layout/table/hooks/useSortedArray';
import { type TableMetadata } from '@/ui/layout/table/types/TableMetadata';
import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';
import { useSetAtomFamilyState } from '@/ui/utilities/state/jotai/hooks/useSetAtomFamilyState';
import { styled } from '@linaria/react';
import { msg } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
import { useEffect, useMemo, useState } from 'react';
import { FieldMetadataType } from 'twenty-shared/types';
import { SearchInput } from 'twenty-ui/components/input';
import { Dropdown } from 'twenty-ui/components/navigation';
import { SettingsRow } from 'twenty-ui/components/settings';
import { IconArchive, IconCircleDashed, IconSettings } from 'twenty-ui/icon';
import { themeCssVariables } from 'twenty-ui/theme';
import { useMapFieldMetadataItemToSettingsObjectDetailTableItem } from '@/settings/data-model/object-details/hooks/useMapFieldMetadataItemToSettingsObjectDetailTableItem';
import { type SettingsObjectDetailTableItem } from '@/settings/data-model/types/SettingsObjectDetailTableItem';
import { normalizeSearchText } from 'twenty-ui/utilities';
import { SettingsSearchFilterTrigger } from '@/settings/components/SettingsSearchFilterTrigger';
const StyledSearchContainer = styled.div`
padding-bottom: ${themeCssVariables.spacing[2]};
`;
const SETTINGS_OBJECT_FIELD_TABLE_METADATA: TableMetadata<SettingsObjectDetailTableItem> =
{
tableId: 'settingsObjectDetail',
fields: [
{
fieldLabel: msg`Name`,
fieldName: 'label',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`App`,
fieldName: 'fieldType',
fieldType: 'string',
align: 'left',
},
{
fieldLabel: msg`Data type`,
fieldName: 'dataType',
fieldType: 'string',
align: 'left',
},
],
initialSort: {
fieldName: 'label',
direction: 'asc',
},
};
export type SettingsObjectFieldTableProps = {
objectMetadataItem: EnrichedObjectMetadataItem;
mode: 'view' | 'new-field';
excludeRelations?: boolean;
};
// TODO: find another way than using mode which feels like it could be replaced by another pattern
export const SettingsObjectFieldTable = ({
objectMetadataItem,
mode,
excludeRelations = false,
}: SettingsObjectFieldTableProps) => {
const { t } = useLingui();
const [searchTerm, setSearchTerm] = useState('');
const [showInactive, setShowInactive] = useState(true);
const [showSystemFields, setShowSystemFields] = useState(false);
const [showOnlyMostlyEmpty, setShowOnlyMostlyEmpty] = useState(false);
const { mostlyEmptyFieldMetadataIds } = useMostlyEmptyFieldMetadataIds({
objectMetadataItemId: objectMetadataItem.id,
skip: mode !== 'view',
});
const tableMetadata = SETTINGS_OBJECT_FIELD_TABLE_METADATA;
const { mapFieldMetadataItemToSettingsObjectDetailTableItem } =
useMapFieldMetadataItemToSettingsObjectDetailTableItem(objectMetadataItem);
const settingsObjectFields = useAtomFamilyStateValue(
settingsObjectFieldsFamilyState,
{ objectMetadataItemId: objectMetadataItem.id },
);
const setSettingsObjectFields = useSetAtomFamilyState(
settingsObjectFieldsFamilyState,
{ objectMetadataItemId: objectMetadataItem.id },
);
useEffect(() => {
setSettingsObjectFields(objectMetadataItem.fields);
}, [objectMetadataItem, setSettingsObjectFields]);
const allObjectSettingsDetailItems = useMemo(() => {
const filteredBySystem = showSystemFields
? settingsObjectFields
: settingsObjectFields?.filter(
(fieldMetadataItem) => !isHiddenSystemField(fieldMetadataItem),
);
const fieldsToDisplay = excludeRelations
? filteredBySystem?.filter(
(fieldMetadataItem) =>
fieldMetadataItem.type !== FieldMetadataType.RELATION &&
fieldMetadataItem.type !== FieldMetadataType.MORPH_RELATION,
)
: filteredBySystem;
return (
fieldsToDisplay?.map(
mapFieldMetadataItemToSettingsObjectDetailTableItem,
) ?? []
);
}, [
settingsObjectFields,
mapFieldMetadataItemToSettingsObjectDetailTableItem,
excludeRelations,
showSystemFields,
]);
const sortedAllObjectSettingsDetailItems = useSortedArray(
allObjectSettingsDetailItems,
tableMetadata,
);
const filteredItems = useMemo(() => {
const searchNormalized = normalizeSearchText(searchTerm);
return sortedAllObjectSettingsDetailItems.filter((item) => {
const matchesActiveFilter =
showInactive || item.fieldMetadataItem.isActive;
const matchesMostlyEmptyFilter =
!showOnlyMostlyEmpty ||
mostlyEmptyFieldMetadataIds.has(item.fieldMetadataItem.id);
const matchesSearch =
normalizeSearchText(item.label).includes(searchNormalized) ||
normalizeSearchText(item.dataType).includes(searchNormalized);
return matchesActiveFilter && matchesMostlyEmptyFilter && matchesSearch;
});
}, [
sortedAllObjectSettingsDetailItems,
searchTerm,
showInactive,
showOnlyMostlyEmpty,
mostlyEmptyFieldMetadataIds,
]);
return (
<>
<StyledSearchContainer>
<SearchInput
placeholder={t`Search a field...`}
value={searchTerm}
onValueChange={setSearchTerm}
actions={
<DropdownRoot
dropdownId="settings-fields-filter-dropdown"
type="panel"
>
<SettingsSearchFilterTrigger />
<DropdownContent
side="bottom"
align="end"
sideOffset={8}
alignOffset={0}
>
<Dropdown.Section>
<SettingsRow
startElement={<IconArchive />}
onCheckedChange={() => setShowInactive(!showInactive)}
checked={showInactive}
>{t`Inactive`}</SettingsRow>
{(mostlyEmptyFieldMetadataIds.size > 0 ||
showOnlyMostlyEmpty) && (
<SettingsRow
startElement={<IconCircleDashed />}
onCheckedChange={() =>
setShowOnlyMostlyEmpty(!showOnlyMostlyEmpty)
}
checked={showOnlyMostlyEmpty}
>{t`Mostly empty`}</SettingsRow>
)}
<SettingsRow
startElement={<IconSettings />}
onCheckedChange={() =>
setShowSystemFields(!showSystemFields)
}
checked={showSystemFields}
>{t`System fields`}</SettingsRow>
</Dropdown.Section>
</DropdownContent>
</DropdownRoot>
}
/>
</StyledSearchContainer>
<Table>
<TableRow
gridTemplateColumns={OBJECT_FIELD_TABLE_ROW_GRID_TEMPLATE_COLUMNS}
>
{tableMetadata.fields.map((item) => (
<SortableTableHeader
key={item.fieldName}
fieldName={item.fieldName}
label={t(item.fieldLabel)}
tableId={tableMetadata.tableId}
initialSort={tableMetadata.initialSort}
/>
))}
<TableHeader></TableHeader>
</TableRow>
<StyledSettingsDataModelTableBodyContainer>
<TableBody>
{filteredItems.map((objectSettingsDetailItem) => {
const status = objectSettingsDetailItem.fieldMetadataItem.isActive
? 'active'
: 'disabled';
return (
<SettingsObjectFieldItemTableRow
key={objectSettingsDetailItem.fieldMetadataItem.id}
settingsObjectDetailTableItem={objectSettingsDetailItem}
status={status}
mode={mode}
isMostlyEmpty={mostlyEmptyFieldMetadataIds.has(
objectSettingsDetailItem.fieldMetadataItem.id,
)}
/>
);
})}
</TableBody>
</StyledSettingsDataModelTableBodyContainer>
</Table>
</>
);
};