houseassassin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: uniformize metadata store with flat types, SSE alignment, presentation endpoint & localStorage (#18647)

Browse Source 
## Summary

Uniformizes the metadata store to support **all** backend flat metadata
types, introduces a **minimal metadata endpoint** for fast initial
renders, replaces custom localStorage persistence with **Jotai's
built-in `atomWithStorage`**, and wires up a
**MinimalMetadataLoadEffect** for stale-while-revalidate loading.

### Key changes

- **All flat metadata types**: Added `FlatCommandMenuItem`,
`FlatFrontComponent`, `FlatWebhook`, `FlatRole`, `FlatRoleTarget`,
`FlatAgent`, `FlatSkill`, `FlatRowLevelPermissionPredicate`,
`FlatRowLevelPermissionPredicateGroup` — every entity in the backend
`MetadataEntityTypeMap` now has a corresponding frontend flat type
registered in `ALL_METADATA_ENTITY_KEYS` and `MetadataEntityTypeMap`.

- **Minimal metadata endpoint** (`minimalMetadata` GraphQL query): New
backend module (`MinimalMetadataModule`) returns lightweight object
metadata (names, icons, labels, flags) and basic views (id, type, key,
objectMetadataId) plus a `metadataVersion`. This enables fast first
paint before full metadata loads.

- **Jotai `atomWithStorage` for persistence**: Replaced the custom
`MetadataLocalStorageEffect` with Jotai's built-in `atomWithStorage` on
both `metadataStoreState` (family) and `metadataVersionState`. Added
`localStorageOptions` support to `createAtomFamilyState` for `{
getOnInit: true }` synchronous hydration. Each entity atom auto-persists
under keys like `metadataStoreState__objectMetadataItems`.

- **MinimalMetadataLoadEffect**: New effect mounted before
`MetadataProviderInitialEffects` that checks if the store already has
data (from Jotai localStorage hydration). If empty, it fetches minimal
metadata from the new endpoint. The full metadata load continues in
parallel, eventually enriching the store with complete data.

- **SSE effects alignment**: All metadata entity types now have
corresponding SSE effects that directly patch the metadata store via
`patchMetadataStoreFromSSEEvent`.

- **Existing selectors and joining logic**:
`objectMetadataItemsWithFieldsSelector`, `viewsWithRelationsSelector`,
`pageLayoutsWithRelationsSelector` reconstruct nested data from flat
entities for components that need it.

### Loading flow

```
App mount
  → Jotai atomWithStorage hydrates store from localStorage (sync, getOnInit)
  → MinimalMetadataLoadEffect
      → Store has data? → skip (app renders immediately)
      → Store empty? → fetch minimalMetadata endpoint → populate objects + views
  → MetadataProviderInitialEffects (full metadata load, runs in parallel)
  → LazyMetadataLoadEffect (page layouts, logic functions, nav menu, etc.)
  → IsAppMetadataReadyEffect (sets isAppMetadataReady)
```

## Test plan

- [ ] Verify app loads with empty localStorage (should fetch minimal
metadata, then full)
- [ ] Verify app loads with populated localStorage (should skip minimal
fetch, render immediately)
- [ ] Verify SSE events correctly update metadata store for all entity
types
- [ ] Verify logout clears metadata store (atom reset propagates to
localStorage)
- [ ] Verify all metadata selectors return correct joined data
- [ ] CI: lint, typecheck, tests pass
This commit is contained in:
Charles Bochet
2026-03-14 20:32:25 +01:00
committed by GitHub
parent 6711b40922
commit 7a3540788a
65 changed files with 1789 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/twenty-front/jest.config.mjs
+1 -1
View File
@@ -62,7 +62,7 @@ const jestConfig = {
coverageThreshold: {
global: {
statements: 48.8,
lines: 47.5,
lines: 47.0,
functions: 39.5,
},
},
packages/twenty-front/src/generated-metadata/graphql.ts
+30
View File
@@ -2419,6 +2419,35 @@ export type MetadataEventWithQueryIds = {
queryIds: Array<Scalars['String']>;
};
export type MinimalMetadata = {
__typename?: 'MinimalMetadata';
metadataVersion: Scalars['Int'];
objectMetadataItems: Array<MinimalObjectMetadata>;
views: Array<MinimalView>;
};
export type MinimalObjectMetadata = {
__typename?: 'MinimalObjectMetadata';
icon?: Maybe<Scalars['String']>;
id: Scalars['UUID'];
isActive: Scalars['Boolean'];
isCustom: Scalars['Boolean'];
isRemote: Scalars['Boolean'];
isSystem: Scalars['Boolean'];
labelPlural: Scalars['String'];
labelSingular: Scalars['String'];
namePlural: Scalars['String'];
nameSingular: Scalars['String'];
};
export type MinimalView = {
__typename?: 'MinimalView';
id: Scalars['UUID'];
key?: Maybe<ViewKey>;
objectMetadataId: Scalars['UUID'];
type: ViewType;
};
export enum ModelFamily {
ANTHROPIC = 'ANTHROPIC',
GOOGLE = 'GOOGLE',
@@ -4108,6 +4137,7 @@ export type Query = {
indexMetadatas: IndexConnection;
lineChartData: LineChartData;
listPlans: Array<BillingPlan>;
minimalMetadata: MinimalMetadata;
navigationMenuItem?: Maybe<NavigationMenuItem>;
navigationMenuItems: Array<NavigationMenuItem>;
object: Object;
packages/twenty-front/src/modules/app/components/AppRouterProviders.tsx
+3
View File
@@ -3,7 +3,9 @@ import { CommandMenuConfirmationModalManager } from '@/command-menu-item/confirm
import { ApolloProvider } from '@/apollo/components/ApolloProvider';
import { MetadataGater } from '@/metadata-store/components/MetadataGater';
import { IsAppMetadataReadyEffect } from '@/metadata-store/effect-components/IsAppMetadataReadyEffect';
import { GotoHotkeysEffectsProvider } from '@/app/effect-components/GotoHotkeysEffectsProvider';
import { MinimalMetadataLoadEffect } from '@/metadata-store/effect-components/MinimalMetadataLoadEffect';
import { MetadataProviderInitialEffects } from '@/metadata-store/effect-components/MetadataProviderInitialEffects';
import { PageChangeEffect } from '@/app/effect-components/PageChangeEffect';
import { AuthProvider } from '@/auth/components/AuthProvider';
@@ -43,6 +45,7 @@ export const AppRouterProviders = () => {
<ApolloProvider>
<BaseThemeProvider>
<ClientConfigProviderEffect />
<MinimalMetadataLoadEffect />
<MetadataProviderInitialEffects />
<LazyMetadataLoadEffect />
<IsAppMetadataReadyEffect />
packages/twenty-front/src/modules/metadata-store/effect-components/FieldMetadataSSEEffect.tsx
+5 -46
View File
@@ -1,6 +1,5 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { type FlatFieldMetadataItem } from '@/metadata-store/types/FlatFieldMetadataItem';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
import { AllMetadataName } from '~/generated-metadata/graphql';
@@ -21,51 +20,11 @@ export const FieldMetadataSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.fieldMetadata,
onMetadataOperationBrowserEvent: (eventDetail) => {
const entry = store.get(
metadataStoreState.atomFamily('fieldMetadataItems'),
patchMetadataStoreFromSSEEvent(
store,
'fieldMetadataItems',
eventDetail.operation,
);
const currentFields = entry.current as FlatFieldMetadataItem[];
switch (eventDetail.operation.type) {
case 'create': {
const createdField = eventDetail.operation
.createdRecord as unknown as FlatFieldMetadataItem;
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
...entry,
current: [...currentFields, createdField],
});
break;
}
case 'update': {
const updatedField = eventDetail.operation
.updatedRecord as unknown as FlatFieldMetadataItem;
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
...entry,
current: currentFields.map((field) =>
field.id === updatedField.id
? { ...field, ...updatedField }
: field,
),
});
break;
}
case 'delete': {
const deletedFieldId = eventDetail.operation
.deletedRecordId as string;
store.set(metadataStoreState.atomFamily('fieldMetadataItems'), {
...entry,
current: currentFields.filter(
(field) => field.id !== deletedFieldId,
),
});
break;
}
default:
return;
}
},
});
packages/twenty-front/src/modules/metadata-store/effect-components/MinimalMetadataLoadEffect.tsx
+63
View File
@@ -0,0 +1,63 @@
import { useIsLogged } from '@/auth/hooks/useIsLogged';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { isCurrentUserLoadedState } from '@/auth/states/isCurrentUserLoadedState';
import { useLoadMinimalMetadata } from '@/metadata-store/hooks/useLoadMinimalMetadata';
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useStore } from 'jotai';
import { useEffect, useState } from 'react';
import { isWorkspaceActiveOrSuspended } from 'twenty-shared/workspace';
export const MinimalMetadataLoadEffect = () => {
const isLoggedIn = useIsLogged();
const isCurrentUserLoaded = useAtomStateValue(isCurrentUserLoadedState);
const currentWorkspace = useAtomStateValue(currentWorkspaceState);
const store = useStore();
const [hasLoaded, setHasLoaded] = useState(false);
const { loadMinimalMetadata } = useLoadMinimalMetadata();
useEffect(() => {
if (hasLoaded) {
return;
}
if (!isCurrentUserLoaded || !isLoggedIn) {
return;
}
if (!isWorkspaceActiveOrSuspended(currentWorkspace)) {
return;
}
const objectsEntry = store.get(
metadataStoreState.atomFamily('objectMetadataItems'),
);
const viewsEntry = store.get(metadataStoreState.atomFamily('views'));
const hasObjectsFromStorage = objectsEntry.status === 'up-to-date';
const hasViewsFromStorage = viewsEntry.status === 'up-to-date';
if (hasObjectsFromStorage && hasViewsFromStorage) {
setHasLoaded(true);
return;
}
const load = async () => {
await loadMinimalMetadata();
setHasLoaded(true);
};
load();
}, [
hasLoaded,
isCurrentUserLoaded,
isLoggedIn,
currentWorkspace,
store,
loadMinimalMetadata,
]);
return null;
};
packages/twenty-front/src/modules/metadata-store/effect-components/NavigationMenuItemSSEEffect.tsx
+8 -1
View File
@@ -1,5 +1,6 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { useMetadataStore } from '@/metadata-store/hooks/useMetadataStore';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { navigationMenuItemsState } from '@/navigation-menu-item/states/navigationMenuItemsState';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
@@ -28,7 +29,13 @@ export const NavigationMenuItemSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.navigationMenuItem,
onMetadataOperationBrowserEvent: async () => {
onMetadataOperationBrowserEvent: async (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'navigationMenuItems',
eventDetail.operation,
);
const result = await client.query({
query: FindManyNavigationMenuItemsDocument,
fetchPolicy: 'network-only',
packages/twenty-front/src/modules/metadata-store/effect-components/ObjectMetadataItemSSEEffect.tsx
+5 -46
View File
@@ -1,6 +1,5 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { type FlatObjectMetadataItem } from '@/metadata-store/types/FlatObjectMetadataItem';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { navigationMenuItemsState } from '@/navigation-menu-item/states/navigationMenuItemsState';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
@@ -28,51 +27,11 @@ export const ObjectMetadataItemSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.objectMetadata,
onMetadataOperationBrowserEvent: async (eventDetail) => {
const entry = store.get(
metadataStoreState.atomFamily('objectMetadataItems'),
patchMetadataStoreFromSSEEvent(
store,
'objectMetadataItems',
eventDetail.operation,
);
const currentObjects = entry.current as FlatObjectMetadataItem[];
switch (eventDetail.operation.type) {
case 'create': {
const createdObject = eventDetail.operation
.createdRecord as unknown as FlatObjectMetadataItem;
store.set(metadataStoreState.atomFamily('objectMetadataItems'), {
...entry,
current: [...currentObjects, createdObject],
});
break;
}
case 'update': {
const updatedObject = eventDetail.operation
.updatedRecord as unknown as FlatObjectMetadataItem;
store.set(metadataStoreState.atomFamily('objectMetadataItems'), {
...entry,
current: currentObjects.map((object) =>
object.id === updatedObject.id
? { ...object, ...updatedObject }
: object,
),
});
break;
}
case 'delete': {
const deletedObjectId = eventDetail.operation
.deletedRecordId as string;
store.set(metadataStoreState.atomFamily('objectMetadataItems'), {
...entry,
current: currentObjects.filter(
(object) => object.id !== deletedObjectId,
),
});
break;
}
default:
return;
}
const navigationMenuItemsResult = await client.query({
query: FindManyNavigationMenuItemsDocument,
packages/twenty-front/src/modules/metadata-store/effect-components/PageLayoutSSEEffect.tsx
+10 -1
View File
@@ -1,11 +1,14 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useRefreshPageLayouts } from '@/page-layout/hooks/useRefreshPageLayouts';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const PageLayoutSSEEffect = () => {
const queryId = 'page-layout-metadata-sse-effect';
const store = useStore();
const { refreshPageLayouts } = useRefreshPageLayouts();
useListenToEventsForQuery({
@@ -18,7 +21,13 @@ export const PageLayoutSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.pageLayout,
onMetadataOperationBrowserEvent: () => {
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'pageLayouts',
eventDetail.operation,
);
refreshPageLayouts();
},
});
packages/twenty-front/src/modules/metadata-store/effect-components/PageLayoutTabSSEEffect.tsx
+11 -2
View File
@@ -1,11 +1,14 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useRefreshPageLayouts } from '@/page-layout/hooks/useRefreshPageLayouts';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const PageLayoutTabSSEEffect = () => {
const queryId = 'page-layout-sse-effect';
const queryId = 'page-layout-tab-sse-effect';
const store = useStore();
const { refreshPageLayouts } = useRefreshPageLayouts();
useListenToEventsForQuery({
@@ -18,7 +21,13 @@ export const PageLayoutTabSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.pageLayoutTab,
onMetadataOperationBrowserEvent: () => {
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'pageLayoutTabs',
eventDetail.operation,
);
refreshPageLayouts();
},
});
packages/twenty-front/src/modules/metadata-store/effect-components/PageLayoutWidgetSSEEffect.tsx
+10 -1
View File
@@ -1,11 +1,14 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useRefreshPageLayouts } from '@/page-layout/hooks/useRefreshPageLayouts';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useStore } from 'jotai';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const PageLayoutWidgetSSEEffect = () => {
const queryId = 'page-layout-widget-sse-effect';
const store = useStore();
const { refreshPageLayouts } = useRefreshPageLayouts();
useListenToEventsForQuery({
@@ -18,7 +21,13 @@ export const PageLayoutWidgetSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.pageLayoutWidget,
onMetadataOperationBrowserEvent: () => {
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'pageLayoutWidgets',
eventDetail.operation,
);
refreshPageLayouts();
},
});
packages/twenty-front/src/modules/metadata-store/effect-components/ViewFieldSSEEffect.tsx
+7
View File
@@ -1,4 +1,5 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { coreViewsState } from '@/views/states/coreViewState';
@@ -28,6 +29,12 @@ export const ViewFieldSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.viewField,
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'viewFields',
eventDetail.operation,
);
const coreViews = store.get(coreViewsState.atom);
let viewId: string | undefined;
packages/twenty-front/src/modules/metadata-store/effect-components/ViewFilterGroupSSEEffect.tsx
+72
View File
@@ -0,0 +1,72 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { coreViewsState } from '@/views/states/coreViewState';
import { useStore } from 'jotai';
import { isDefined } from 'twenty-shared/utils';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const ViewFilterGroupSSEEffect = () => {
const store = useStore();
const { refreshCoreViewsByObjectMetadataId } =
useRefreshCoreViewsByObjectMetadataId();
useListenToEventsForQuery({
queryId: 'view-filter-groups-sse-effect',
operationSignature: {
metadataName: AllMetadataName.viewFilterGroup,
variables: {},
},
});
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.viewFilterGroup,
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'viewFilterGroups',
eventDetail.operation,
);
const coreViews = store.get(coreViewsState.atom);
let viewId: string | undefined;
switch (eventDetail.operation.type) {
case 'create': {
viewId = (eventDetail.operation.createdRecord as { viewId?: string })
.viewId;
break;
}
case 'update': {
viewId = (eventDetail.operation.updatedRecord as { viewId?: string })
.viewId;
break;
}
case 'delete': {
const deletedId = eventDetail.operation.deletedRecordId as string;
viewId = coreViews.find((view) =>
view.viewFilterGroups?.some(
(viewFilterGroup) => viewFilterGroup.id === deletedId,
),
)?.id;
break;
}
}
if (!isDefined(viewId)) {
return;
}
const view = coreViews.find((coreView) => coreView.id === viewId);
if (isDefined(view)) {
refreshCoreViewsByObjectMetadataId(view.objectMetadataId);
}
},
});
return null;
};
packages/twenty-front/src/modules/metadata-store/effect-components/ViewFilterSSEEffect.tsx
+70
View File
@@ -0,0 +1,70 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { coreViewsState } from '@/views/states/coreViewState';
import { useStore } from 'jotai';
import { isDefined } from 'twenty-shared/utils';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const ViewFilterSSEEffect = () => {
const store = useStore();
const { refreshCoreViewsByObjectMetadataId } =
useRefreshCoreViewsByObjectMetadataId();
useListenToEventsForQuery({
queryId: 'view-filters-sse-effect',
operationSignature: {
metadataName: AllMetadataName.viewFilter,
variables: {},
},
});
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.viewFilter,
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(
store,
'viewFilters',
eventDetail.operation,
);
const coreViews = store.get(coreViewsState.atom);
let viewId: string | undefined;
switch (eventDetail.operation.type) {
case 'create': {
viewId = (eventDetail.operation.createdRecord as { viewId?: string })
.viewId;
break;
}
case 'update': {
viewId = (eventDetail.operation.updatedRecord as { viewId?: string })
.viewId;
break;
}
case 'delete': {
const deletedId = eventDetail.operation.deletedRecordId as string;
viewId = coreViews.find((view) =>
view.viewFilters.some((viewFilter) => viewFilter.id === deletedId),
)?.id;
break;
}
}
if (!isDefined(viewId)) {
return;
}
const view = coreViews.find((coreView) => coreView.id === viewId);
if (isDefined(view)) {
refreshCoreViewsByObjectMetadataId(view.objectMetadataId);
}
},
});
return null;
};
packages/twenty-front/src/modules/metadata-store/effect-components/ViewSSEEffect.tsx
+3
View File
@@ -1,4 +1,5 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { coreViewsState } from '@/views/states/coreViewState';
@@ -26,6 +27,8 @@ export const ViewSSEEffect = () => {
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.view,
onMetadataOperationBrowserEvent: async (eventDetail) => {
patchMetadataStoreFromSSEEvent(store, 'views', eventDetail.operation);
switch (eventDetail.operation.type) {
case 'create': {
const createdView = eventDetail.operation
packages/twenty-front/src/modules/metadata-store/effect-components/ViewSortSSEEffect.tsx
+66
View File
@@ -0,0 +1,66 @@
import { useListenToMetadataOperationBrowserEvent } from '@/browser-event/hooks/useListenToMetadataOperationBrowserEvent';
import { patchMetadataStoreFromSSEEvent } from '@/metadata-store/utils/patchMetadataStoreFromSSEEvent';
import { useListenToEventsForQuery } from '@/sse-db-event/hooks/useListenToEventsForQuery';
import { useRefreshCoreViewsByObjectMetadataId } from '@/views/hooks/useRefreshCoreViewsByObjectMetadataId';
import { coreViewsState } from '@/views/states/coreViewState';
import { useStore } from 'jotai';
import { isDefined } from 'twenty-shared/utils';
import { AllMetadataName } from '~/generated-metadata/graphql';
export const ViewSortSSEEffect = () => {
const store = useStore();
const { refreshCoreViewsByObjectMetadataId } =
useRefreshCoreViewsByObjectMetadataId();
useListenToEventsForQuery({
queryId: 'view-sorts-sse-effect',
operationSignature: {
metadataName: AllMetadataName.viewSort,
variables: {},
},
});
useListenToMetadataOperationBrowserEvent({
metadataName: AllMetadataName.viewSort,
onMetadataOperationBrowserEvent: (eventDetail) => {
patchMetadataStoreFromSSEEvent(store, 'viewSorts', eventDetail.operation);
const coreViews = store.get(coreViewsState.atom);
let viewId: string | undefined;
switch (eventDetail.operation.type) {
case 'create': {
viewId = (eventDetail.operation.createdRecord as { viewId?: string })
.viewId;
break;
}
case 'update': {
viewId = (eventDetail.operation.updatedRecord as { viewId?: string })
.viewId;
break;
}
case 'delete': {
const deletedId = eventDetail.operation.deletedRecordId as string;
viewId = coreViews.find((view) =>
view.viewSorts.some((viewSort) => viewSort.id === deletedId),
)?.id;
break;
}
}
if (!isDefined(viewId)) {
return;
}
const view = coreViews.find((coreView) => coreView.id === viewId);
if (isDefined(view)) {
refreshCoreViewsByObjectMetadataId(view.objectMetadataId);
}
},
});
return null;
};
packages/twenty-front/src/modules/metadata-store/graphql/queries/findMinimalMetadata.ts
+27
View File
@@ -0,0 +1,27 @@
import { gql } from '@apollo/client';
export const FIND_MINIMAL_METADATA = gql`
query FindMinimalMetadata {
minimalMetadata {
objectMetadataItems {
id
nameSingular
namePlural
labelSingular
labelPlural
icon
isCustom
isActive
isSystem
isRemote
}
views {
id
type
key
objectMetadataId
}
metadataVersion
}
}
`;
packages/twenty-front/src/modules/metadata-store/hooks/useFetchAndLoadIndexViews.ts
+19 -3
View File
@@ -1,6 +1,6 @@
import { useMetadataStore } from '@/metadata-store/hooks/useMetadataStore';
import { useSetIndexViews } from '@/metadata-store/hooks/useSetIndexViews';
import { type View } from '@/views/types/View';
import { splitViewWithRelated } from '@/metadata-store/utils/splitViewWithRelated';
import { useCallback } from 'react';
import { isDefined } from 'twenty-shared/utils';
import { useApolloClient } from '@apollo/client/react';
@@ -25,8 +25,24 @@ export const useFetchAndLoadIndexViews = () => {
if (isDefined(result.data?.getCoreViews)) {
setIndexViews(result.data.getCoreViews);
// TODO: align generated ViewType with app ViewType to remove this cast
updateDraft('views', result.data.getCoreViews as unknown as View[]);
const {
flatViews,
flatViewFields,
flatViewFilters,
flatViewSorts,
flatViewGroups,
flatViewFilterGroups,
flatViewFieldGroups,
} = splitViewWithRelated(result.data.getCoreViews);
updateDraft('views', flatViews);
updateDraft('viewFields', flatViewFields);
updateDraft('viewFilters', flatViewFilters);
updateDraft('viewSorts', flatViewSorts);
updateDraft('viewGroups', flatViewGroups);
updateDraft('viewFilterGroups', flatViewFilterGroups);
updateDraft('viewFieldGroups', flatViewFieldGroups);
applyChanges();
}
}, [client, setIndexViews, updateDraft, applyChanges]);
packages/twenty-front/src/modules/metadata-store/hooks/useLoadMinimalMetadata.ts
+70
View File
@@ -0,0 +1,70 @@
import { FIND_MINIMAL_METADATA } from '@/metadata-store/graphql/queries/findMinimalMetadata';
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { metadataVersionState } from '@/metadata-store/states/metadataVersionState';
import { type FlatObjectMetadataItem } from '@/metadata-store/types/FlatObjectMetadataItem';
import { type FlatView } from '@/metadata-store/types/FlatView';
import { type FindMinimalMetadataQuery } from '@/metadata-store/types/MinimalMetadata';
import { useApolloClient } from '@apollo/client/react';
import { useStore } from 'jotai';
import { useCallback } from 'react';
import { isDefined } from 'twenty-shared/utils';
export const useLoadMinimalMetadata = () => {
const client = useApolloClient();
const store = useStore();
const loadMinimalMetadata = useCallback(async () => {
const result = await client.query<FindMinimalMetadataQuery>({
query: FIND_MINIMAL_METADATA,
fetchPolicy: 'network-only',
});
if (!isDefined(result.data?.minimalMetadata)) {
return null;
}
const { objectMetadataItems, views, metadataVersion } =
result.data.minimalMetadata;
const localMetadataVersion = store.get(metadataVersionState.atom);
// Skip hydration if data already loaded with same or newer version
if (
isDefined(localMetadataVersion) &&
localMetadataVersion >= metadataVersion
) {
return { metadataVersion, isStale: false };
}
const objectsEntry = store.get(
metadataStoreState.atomFamily('objectMetadataItems'),
);
if (objectsEntry.status === 'empty') {
store.set(metadataStoreState.atomFamily('objectMetadataItems'), {
current: objectMetadataItems as unknown as FlatObjectMetadataItem[],
draft: [],
status: 'up-to-date',
});
}
const viewsEntry = store.get(metadataStoreState.atomFamily('views'));
if (viewsEntry.status === 'empty') {
store.set(metadataStoreState.atomFamily('views'), {
current: views as unknown as FlatView[],
draft: [],
status: 'up-to-date',
});
}
store.set(metadataVersionState.atom, metadataVersion);
const isStale =
isDefined(localMetadataVersion) && localMetadataVersion < metadataVersion;
return { metadataVersion, isStale };
}, [client, store]);
return { loadMinimalMetadata };
};
packages/twenty-front/src/modules/metadata-store/hooks/useReloadWorkspaceMetadata.ts
+19 -4
View File
@@ -1,7 +1,7 @@
import { useMetadataStore } from '@/metadata-store/hooks/useMetadataStore';
import { splitViewWithRelated } from '@/metadata-store/utils/splitViewWithRelated';
import { useLoadMockedObjectMetadataItems } from '@/object-metadata/hooks/useLoadMockedObjectMetadataItems';
import { useRefreshObjectMetadataItems } from '@/object-metadata/hooks/useRefreshObjectMetadataItems';
import { type View } from '@/views/types/View';
import { coreViewsState } from '@/views/states/coreViewState';
import { useStore } from 'jotai';
import { useCallback } from 'react';
@@ -17,9 +17,24 @@ export const useReloadWorkspaceMetadata = () => {
await refreshObjectMetadataItems();
// TODO: align generated ViewType with app ViewType to remove this cast
const loadedViews = store.get(coreViewsState.atom) as unknown as View[];
updateDraft('views', loadedViews);
const loadedViews = store.get(coreViewsState.atom);
const {
flatViews,
flatViewFields,
flatViewFilters,
flatViewSorts,
flatViewGroups,
flatViewFilterGroups,
flatViewFieldGroups,
} = splitViewWithRelated(loadedViews);
updateDraft('views', flatViews);
updateDraft('viewFields', flatViewFields);
updateDraft('viewFilters', flatViewFilters);
updateDraft('viewSorts', flatViewSorts);
updateDraft('viewGroups', flatViewGroups);
updateDraft('viewFilterGroups', flatViewFilterGroups);
updateDraft('viewFieldGroups', flatViewFieldGroups);
applyChanges();
}, [
resetMetadataStore,
packages/twenty-front/src/modules/metadata-store/states/metadataStoreState.ts
+16
View File
@@ -13,9 +13,23 @@ export const ALL_METADATA_ENTITY_KEYS = [
'viewFields',
'viewFilters',
'viewSorts',
'viewGroups',
'viewFilterGroups',
'viewFieldGroups',
'pageLayouts',
'pageLayoutTabs',
'pageLayoutWidgets',
'logicFunctions',
'navigationMenuItems',
'commandMenuItems',
'frontComponents',
'webhooks',
'roles',
'roleTargets',
'agents',
'skills',
'rowLevelPermissionPredicates',
'rowLevelPermissionPredicateGroups',
] as const;
export type MetadataEntityKey = (typeof ALL_METADATA_ENTITY_KEYS)[number];
@@ -38,4 +52,6 @@ export const metadataStoreState = createAtomFamilyState<
>({
key: 'metadataStoreState',
defaultValue: METADATA_STORE_ITEM_INITIAL_VALUE,
useLocalStorage: true,
localStorageOptions: { getOnInit: true },
});
packages/twenty-front/src/modules/metadata-store/states/metadataVersionState.ts
+8
View File
@@ -0,0 +1,8 @@
import { createAtomState } from '@/ui/utilities/state/jotai/utils/createAtomState';
export const metadataVersionState = createAtomState<number | null>({
key: 'metadataVersionState',
defaultValue: null,
useLocalStorage: true,
localStorageOptions: { getOnInit: true },
});
packages/twenty-front/src/modules/metadata-store/types/FlatAgent.ts
+3
View File
@@ -0,0 +1,3 @@
import { type Agent } from '~/generated-metadata/graphql';
export type FlatAgent = Agent;
packages/twenty-front/src/modules/metadata-store/types/FlatCommandMenuItem.ts
+3
View File
@@ -0,0 +1,3 @@
import { type CommandMenuItem } from '~/generated-metadata/graphql';
export type FlatCommandMenuItem = Omit<CommandMenuItem, 'frontComponent'>;
packages/twenty-front/src/modules/metadata-store/types/FlatFrontComponent.ts
+3
View File
@@ -0,0 +1,3 @@
import { type FrontComponent } from '~/generated-metadata/graphql';
export type FlatFrontComponent = Omit<FrontComponent, 'applicationTokenPair'>;
packages/twenty-front/src/modules/metadata-store/types/FlatLogicFunction.ts
+3
View File
@@ -0,0 +1,3 @@
import { type LogicFunction } from '@/settings/logic-functions/states/logicFunctionsState';
export type FlatLogicFunction = LogicFunction;
packages/twenty-front/src/modules/metadata-store/types/FlatNavigationMenuItem.ts
+3
View File
@@ -0,0 +1,3 @@
import { type NavigationMenuItem } from '~/generated-metadata/graphql';
export type FlatNavigationMenuItem = NavigationMenuItem;
packages/twenty-front/src/modules/metadata-store/types/FlatPageLayout.ts
+3
View File
@@ -0,0 +1,3 @@
import { type PageLayout } from '@/page-layout/types/PageLayout';
export type FlatPageLayout = Omit<PageLayout, 'tabs'>;
packages/twenty-front/src/modules/metadata-store/types/FlatPageLayoutTab.ts
+5
View File
@@ -0,0 +1,5 @@
import { type PageLayoutTab } from '@/page-layout/types/PageLayoutTab';
export type FlatPageLayoutTab = Omit<PageLayoutTab, 'widgets'> & {
pageLayoutId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatPageLayoutWidget.ts
+5
View File
@@ -0,0 +1,5 @@
import { type PageLayoutWidget } from '@/page-layout/types/PageLayoutWidget';
export type FlatPageLayoutWidget = PageLayoutWidget & {
pageLayoutTabId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatRole.ts
+13
View File
@@ -0,0 +1,13 @@
import { type Role } from '~/generated-metadata/graphql';
export type FlatRole = Omit<
Role,
| 'agents'
| 'apiKeys'
| 'workspaceMembers'
| 'fieldPermissions'
| 'objectPermissions'
| 'permissionFlags'
| 'rowLevelPermissionPredicateGroups'
| 'rowLevelPermissionPredicates'
>;
packages/twenty-front/src/modules/metadata-store/types/FlatRoleTarget.ts
+7
View File
@@ -0,0 +1,7 @@
export type FlatRoleTarget = {
id: string;
roleId: string;
userWorkspaceId: string | null;
agentId: string | null;
apiKeyId: string | null;
};
packages/twenty-front/src/modules/metadata-store/types/FlatRowLevelPermissionPredicate.ts
+3
View File
@@ -0,0 +1,3 @@
import { type RowLevelPermissionPredicate } from '~/generated-metadata/graphql';
export type FlatRowLevelPermissionPredicate = RowLevelPermissionPredicate;
packages/twenty-front/src/modules/metadata-store/types/FlatRowLevelPermissionPredicateGroup.ts
+4
View File
@@ -0,0 +1,4 @@
import { type RowLevelPermissionPredicateGroup } from '~/generated-metadata/graphql';
export type FlatRowLevelPermissionPredicateGroup =
RowLevelPermissionPredicateGroup;
packages/twenty-front/src/modules/metadata-store/types/FlatSkill.ts
+3
View File
@@ -0,0 +1,3 @@
import { type Skill } from '~/generated-metadata/graphql';
export type FlatSkill = Skill;
packages/twenty-front/src/modules/metadata-store/types/FlatView.ts
+11
View File
@@ -0,0 +1,11 @@
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
export type FlatView = Omit<
CoreViewWithRelations,
| 'viewFields'
| 'viewFieldGroups'
| 'viewGroups'
| 'viewFilters'
| 'viewFilterGroups'
| 'viewSorts'
>;
packages/twenty-front/src/modules/metadata-store/types/FlatViewField.ts
+5
View File
@@ -0,0 +1,5 @@
import { type CoreViewFieldEssential } from '@/views/types/CoreViewWithRelations';
export type FlatViewField = CoreViewFieldEssential & {
viewId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatViewFieldGroup.ts
+6
View File
@@ -0,0 +1,6 @@
import { type CoreViewFieldGroupEssential } from '@/views/types/CoreViewWithRelations';
export type FlatViewFieldGroup = Omit<
CoreViewFieldGroupEssential,
'viewFields'
>;
packages/twenty-front/src/modules/metadata-store/types/FlatViewFilter.ts
+5
View File
@@ -0,0 +1,5 @@
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
export type FlatViewFilter = CoreViewWithRelations['viewFilters'][number] & {
viewId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatViewFilterGroup.ts
+7
View File
@@ -0,0 +1,7 @@
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
type ViewFilterGroupRelation = NonNullable<
CoreViewWithRelations['viewFilterGroups']
>[number];
export type FlatViewFilterGroup = ViewFilterGroupRelation;
packages/twenty-front/src/modules/metadata-store/types/FlatViewGroup.ts
+5
View File
@@ -0,0 +1,5 @@
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
export type FlatViewGroup = CoreViewWithRelations['viewGroups'][number] & {
viewId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatViewSort.ts
+5
View File
@@ -0,0 +1,5 @@
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
export type FlatViewSort = CoreViewWithRelations['viewSorts'][number] & {
viewId: string;
};
packages/twenty-front/src/modules/metadata-store/types/FlatWebhook.ts
+3
View File
@@ -0,0 +1,3 @@
import { type Webhook } from '~/generated-metadata/graphql';
export type FlatWebhook = Webhook;
packages/twenty-front/src/modules/metadata-store/types/MetadataEntityTypeMap.ts
+42 -14
View File
@@ -1,23 +1,51 @@
import { type FlatAgent } from '@/metadata-store/types/FlatAgent';
import { type FlatCommandMenuItem } from '@/metadata-store/types/FlatCommandMenuItem';
import { type FlatFieldMetadataItem } from '@/metadata-store/types/FlatFieldMetadataItem';
import { type FlatFrontComponent } from '@/metadata-store/types/FlatFrontComponent';
import { type FlatIndexMetadataItem } from '@/metadata-store/types/FlatIndexMetadataItem';
import { type FlatLogicFunction } from '@/metadata-store/types/FlatLogicFunction';
import { type FlatNavigationMenuItem } from '@/metadata-store/types/FlatNavigationMenuItem';
import { type FlatObjectMetadataItem } from '@/metadata-store/types/FlatObjectMetadataItem';
import { type PageLayout } from '@/page-layout/types/PageLayout';
import { type LogicFunction } from '@/settings/logic-functions/states/logicFunctionsState';
import { type View } from '@/views/types/View';
import { type ViewField } from '@/views/types/ViewField';
import { type ViewFilter } from '@/views/types/ViewFilter';
import { type ViewSort } from '@/views/types/ViewSort';
import { type NavigationMenuItem } from '~/generated-metadata/graphql';
import { type FlatPageLayout } from '@/metadata-store/types/FlatPageLayout';
import { type FlatPageLayoutTab } from '@/metadata-store/types/FlatPageLayoutTab';
import { type FlatPageLayoutWidget } from '@/metadata-store/types/FlatPageLayoutWidget';
import { type FlatRole } from '@/metadata-store/types/FlatRole';
import { type FlatRoleTarget } from '@/metadata-store/types/FlatRoleTarget';
import { type FlatRowLevelPermissionPredicate } from '@/metadata-store/types/FlatRowLevelPermissionPredicate';
import { type FlatRowLevelPermissionPredicateGroup } from '@/metadata-store/types/FlatRowLevelPermissionPredicateGroup';
import { type FlatSkill } from '@/metadata-store/types/FlatSkill';
import { type FlatView } from '@/metadata-store/types/FlatView';
import { type FlatViewField } from '@/metadata-store/types/FlatViewField';
import { type FlatViewFieldGroup } from '@/metadata-store/types/FlatViewFieldGroup';
import { type FlatViewFilter } from '@/metadata-store/types/FlatViewFilter';
import { type FlatViewFilterGroup } from '@/metadata-store/types/FlatViewFilterGroup';
import { type FlatViewGroup } from '@/metadata-store/types/FlatViewGroup';
import { type FlatViewSort } from '@/metadata-store/types/FlatViewSort';
import { type FlatWebhook } from '@/metadata-store/types/FlatWebhook';
export type MetadataEntityTypeMap = {
objectMetadataItems: FlatObjectMetadataItem;
fieldMetadataItems: FlatFieldMetadataItem;
indexMetadataItems: FlatIndexMetadataItem;
views: View;
viewFields: ViewField;
viewFilters: ViewFilter;
viewSorts: ViewSort;
pageLayouts: PageLayout;
logicFunctions: LogicFunction;
navigationMenuItems: NavigationMenuItem;
views: FlatView;
viewFields: FlatViewField;
viewFilters: FlatViewFilter;
viewSorts: FlatViewSort;
viewGroups: FlatViewGroup;
viewFilterGroups: FlatViewFilterGroup;
viewFieldGroups: FlatViewFieldGroup;
pageLayouts: FlatPageLayout;
pageLayoutTabs: FlatPageLayoutTab;
pageLayoutWidgets: FlatPageLayoutWidget;
logicFunctions: FlatLogicFunction;
navigationMenuItems: FlatNavigationMenuItem;
commandMenuItems: FlatCommandMenuItem;
frontComponents: FlatFrontComponent;
webhooks: FlatWebhook;
roles: FlatRole;
roleTargets: FlatRoleTarget;
agents: FlatAgent;
skills: FlatSkill;
rowLevelPermissionPredicates: FlatRowLevelPermissionPredicate;
rowLevelPermissionPredicateGroups: FlatRowLevelPermissionPredicateGroup;
};
packages/twenty-front/src/modules/metadata-store/types/MinimalMetadata.ts
+15
View File
@@ -0,0 +1,15 @@
import {
type MinimalMetadata as GeneratedMinimalMetadata,
type MinimalObjectMetadata as GeneratedMinimalObjectMetadata,
type MinimalView as GeneratedMinimalView,
} from '~/generated-metadata/graphql';
export type MinimalObjectMetadata = GeneratedMinimalObjectMetadata;
export type MinimalView = GeneratedMinimalView;
export type MinimalMetadata = GeneratedMinimalMetadata;
export type FindMinimalMetadataQuery = {
minimalMetadata: MinimalMetadata;
};
packages/twenty-front/src/modules/metadata-store/utils/patchMetadataStoreFromSSEEvent.ts
+60
View File
@@ -0,0 +1,60 @@
import {
metadataStoreState,
type MetadataEntityKey,
} from '@/metadata-store/states/metadataStoreState';
import { type createStore } from 'jotai';
type JotaiStore = ReturnType<typeof createStore>;
type SSEEventOperation =
| {
type: 'create';
createdRecord: Record<string, unknown>;
}
| {
type: 'update';
updatedRecord: Record<string, unknown>;
}
| {
type: 'delete';
deletedRecordId: string;
};
export const patchMetadataStoreFromSSEEvent = (
store: JotaiStore,
entityKey: MetadataEntityKey,
operation: SSEEventOperation,
) => {
const entry = store.get(metadataStoreState.atomFamily(entityKey));
const currentItems = entry.current as Array<{ id: string }>;
switch (operation.type) {
case 'create': {
store.set(metadataStoreState.atomFamily(entityKey), {
...entry,
current: [...currentItems, operation.createdRecord],
});
break;
}
case 'update': {
store.set(metadataStoreState.atomFamily(entityKey), {
...entry,
current: currentItems.map((item) =>
item.id === (operation.updatedRecord as { id: string }).id
? { ...item, ...operation.updatedRecord }
: item,
),
});
break;
}
case 'delete': {
store.set(metadataStoreState.atomFamily(entityKey), {
...entry,
current: currentItems.filter(
(item) => item.id !== operation.deletedRecordId,
),
});
break;
}
}
};
packages/twenty-front/src/modules/metadata-store/utils/splitPageLayoutWithRelated.ts
+46
View File
@@ -0,0 +1,46 @@
import { type FlatPageLayout } from '@/metadata-store/types/FlatPageLayout';
import { type FlatPageLayoutTab } from '@/metadata-store/types/FlatPageLayoutTab';
import { type FlatPageLayoutWidget } from '@/metadata-store/types/FlatPageLayoutWidget';
import { type PageLayout } from '@/page-layout/types/PageLayout';
type SplitResult = {
flatPageLayouts: FlatPageLayout[];
flatPageLayoutTabs: FlatPageLayoutTab[];
flatPageLayoutWidgets: FlatPageLayoutWidget[];
};
export const splitPageLayoutWithRelated = (
pageLayouts: PageLayout[],
): SplitResult => {
const flatPageLayouts: FlatPageLayout[] = [];
const flatPageLayoutTabs: FlatPageLayoutTab[] = [];
const flatPageLayoutWidgets: FlatPageLayoutWidget[] = [];
for (const pageLayout of pageLayouts) {
const { tabs = [], ...pageLayoutProperties } = pageLayout;
flatPageLayouts.push(pageLayoutProperties);
for (const tab of tabs) {
const { widgets = [], ...tabProperties } = tab;
flatPageLayoutTabs.push({
...tabProperties,
pageLayoutId: pageLayout.id,
});
for (const widget of widgets) {
flatPageLayoutWidgets.push({
...widget,
pageLayoutTabId: tab.id,
});
}
}
}
return {
flatPageLayouts,
flatPageLayoutTabs,
flatPageLayoutWidgets,
};
};
packages/twenty-front/src/modules/metadata-store/utils/splitViewWithRelated.ts
+93
View File
@@ -0,0 +1,93 @@
import { type FlatView } from '@/metadata-store/types/FlatView';
import { type FlatViewField } from '@/metadata-store/types/FlatViewField';
import { type FlatViewFieldGroup } from '@/metadata-store/types/FlatViewFieldGroup';
import { type FlatViewFilter } from '@/metadata-store/types/FlatViewFilter';
import { type FlatViewFilterGroup } from '@/metadata-store/types/FlatViewFilterGroup';
import { type FlatViewGroup } from '@/metadata-store/types/FlatViewGroup';
import { type FlatViewSort } from '@/metadata-store/types/FlatViewSort';
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
type SplitResult = {
flatViews: FlatView[];
flatViewFields: FlatViewField[];
flatViewFilters: FlatViewFilter[];
flatViewSorts: FlatViewSort[];
flatViewGroups: FlatViewGroup[];
flatViewFilterGroups: FlatViewFilterGroup[];
flatViewFieldGroups: FlatViewFieldGroup[];
};
export const splitViewWithRelated = (
viewsWithRelated: CoreViewWithRelations[],
): SplitResult => {
const flatViews: FlatView[] = [];
const flatViewFields: FlatViewField[] = [];
const flatViewFilters: FlatViewFilter[] = [];
const flatViewSorts: FlatViewSort[] = [];
const flatViewGroups: FlatViewGroup[] = [];
const flatViewFilterGroups: FlatViewFilterGroup[] = [];
const flatViewFieldGroups: FlatViewFieldGroup[] = [];
for (const viewWithRelated of viewsWithRelated) {
const {
viewFields = [],
viewFilters = [],
viewSorts = [],
viewGroups = [],
viewFilterGroups = [],
viewFieldGroups = [],
...viewProperties
} = viewWithRelated;
flatViews.push(viewProperties);
for (const viewField of viewFields) {
flatViewFields.push({
...viewField,
viewId: viewWithRelated.id,
});
}
for (const viewFilter of viewFilters) {
flatViewFilters.push({
...viewFilter,
viewId: viewWithRelated.id,
});
}
for (const viewSort of viewSorts) {
flatViewSorts.push({
...viewSort,
viewId: viewWithRelated.id,
});
}
for (const viewGroup of viewGroups) {
flatViewGroups.push({
...viewGroup,
viewId: viewWithRelated.id,
});
}
for (const viewFilterGroup of viewFilterGroups) {
flatViewFilterGroups.push(viewFilterGroup);
}
for (const viewFieldGroup of viewFieldGroups) {
const { viewFields: _viewFields, ...viewFieldGroupProperties } =
viewFieldGroup;
flatViewFieldGroups.push(viewFieldGroupProperties);
}
}
return {
flatViews,
flatViewFields,
flatViewFilters,
flatViewSorts,
flatViewGroups,
flatViewFilterGroups,
flatViewFieldGroups,
};
};
packages/twenty-front/src/modules/page-layout/hooks/useApplyPageLayouts.ts
+8 -1
View File
@@ -1,4 +1,5 @@
import { useMetadataStore } from '@/metadata-store/hooks/useMetadataStore';
import { splitPageLayoutWithRelated } from '@/metadata-store/utils/splitPageLayoutWithRelated';
import { pageLayoutCurrentLayoutsComponentState } from '@/page-layout/states/pageLayoutCurrentLayoutsComponentState';
import { pageLayoutPersistedComponentState } from '@/page-layout/states/pageLayoutPersistedComponentState';
import { recordPageLayoutsState } from '@/page-layout/states/recordPageLayoutsState';
@@ -32,7 +33,13 @@ export const useApplyPageLayouts = () => {
}
store.set(recordPageLayoutsState.atom, transformedPageLayouts);
updateDraft('pageLayouts', transformedPageLayouts);
const { flatPageLayouts, flatPageLayoutTabs, flatPageLayoutWidgets } =
splitPageLayoutWithRelated(transformedPageLayouts);
updateDraft('pageLayouts', flatPageLayouts);
updateDraft('pageLayoutTabs', flatPageLayoutTabs);
updateDraft('pageLayoutWidgets', flatPageLayoutWidgets);
applyChanges();
},
[store, updateDraft, applyChanges],
packages/twenty-front/src/modules/page-layout/states/pageLayoutsWithRelationsSelector.ts
+52
View File
@@ -0,0 +1,52 @@
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { type FlatPageLayout } from '@/metadata-store/types/FlatPageLayout';
import { type FlatPageLayoutTab } from '@/metadata-store/types/FlatPageLayoutTab';
import { type FlatPageLayoutWidget } from '@/metadata-store/types/FlatPageLayoutWidget';
import { type PageLayout } from '@/page-layout/types/PageLayout';
import { createAtomSelector } from '@/ui/utilities/state/jotai/utils/createAtomSelector';
import { isDefined } from 'twenty-shared/utils';
export const pageLayoutsWithRelationsSelector = createAtomSelector<
PageLayout[]
>({
key: 'pageLayoutsWithRelationsSelector',
get: ({ get }) => {
const flatPageLayouts = get(metadataStoreState, 'pageLayouts')
.current as FlatPageLayout[];
const allFlatTabs = get(metadataStoreState, 'pageLayoutTabs')
.current as FlatPageLayoutTab[];
const allFlatWidgets = get(metadataStoreState, 'pageLayoutWidgets')
.current as FlatPageLayoutWidget[];
const tabsByPageLayoutId = new Map<string, FlatPageLayoutTab[]>();
const widgetsByTabId = new Map<string, FlatPageLayoutWidget[]>();
for (const tab of allFlatTabs) {
const existing = tabsByPageLayoutId.get(tab.pageLayoutId);
if (isDefined(existing)) {
existing.push(tab);
} else {
tabsByPageLayoutId.set(tab.pageLayoutId, [tab]);
}
}
for (const widget of allFlatWidgets) {
const existing = widgetsByTabId.get(widget.pageLayoutTabId);
if (isDefined(existing)) {
existing.push(widget);
} else {
widgetsByTabId.set(widget.pageLayoutTabId, [widget]);
}
}
return flatPageLayouts.map((flatPageLayout) => ({
...flatPageLayout,
tabs: (tabsByPageLayoutId.get(flatPageLayout.id) ?? []).map((tab) => ({
...tab,
widgets: widgetsByTabId.get(tab.id) ?? [],
})),
}));
},
});
packages/twenty-front/src/modules/sse-db-event/components/SSEProvider.tsx
+8 -2
View File
@@ -4,7 +4,10 @@ import { ObjectMetadataItemSSEEffect } from '@/metadata-store/effect-components/
import { PageLayoutSSEEffect } from '@/metadata-store/effect-components/PageLayoutSSEEffect';
import { PageLayoutTabSSEEffect } from '@/metadata-store/effect-components/PageLayoutTabSSEEffect';
import { PageLayoutWidgetSSEEffect } from '@/metadata-store/effect-components/PageLayoutWidgetSSEEffect';
import { ViewRelationsSSEEffect } from '@/metadata-store/effect-components/ViewRelationsSSEEffect';
import { ViewFieldSSEEffect } from '@/metadata-store/effect-components/ViewFieldSSEEffect';
import { ViewFilterGroupSSEEffect } from '@/metadata-store/effect-components/ViewFilterGroupSSEEffect';
import { ViewFilterSSEEffect } from '@/metadata-store/effect-components/ViewFilterSSEEffect';
import { ViewSortSSEEffect } from '@/metadata-store/effect-components/ViewSortSSEEffect';
import { ViewSSEEffect } from '@/metadata-store/effect-components/ViewSSEEffect';
import { SSEClientEffect } from '@/sse-db-event/components/SSEClientEffect';
import { SSEEventStreamEffect } from '@/sse-db-event/components/SSEEventStreamEffect';
@@ -27,8 +30,11 @@ export const SSEProvider = ({ children }: SSEProviderProps) => {
<PageLayoutSSEEffect />
<PageLayoutTabSSEEffect />
<PageLayoutWidgetSSEEffect />
<ViewRelationsSSEEffect />
<ViewSSEEffect />
<ViewFieldSSEEffect />
<ViewFilterSSEEffect />
<ViewSortSSEEffect />
<ViewFilterGroupSSEEffect />
{children}
</>
);
packages/twenty-front/src/modules/ui/utilities/state/jotai/jotaiStore.ts
+7
View File
@@ -3,6 +3,13 @@ import { createStore } from 'jotai';
export let jotaiStore = createStore();
export const resetJotaiStore = () => {
try {
localStorage.clear();
} catch {
// localStorage may be unavailable in some environments
}
jotaiStore = createStore();
return jotaiStore;
};
packages/twenty-front/src/modules/ui/utilities/state/jotai/utils/createAtomFamilyState.ts
+8 -1
View File
@@ -7,10 +7,12 @@ export const createAtomFamilyState = <ValueType, FamilyKey>({
key,
defaultValue,
useLocalStorage = false,
localStorageOptions,
}: {
key: string;
defaultValue: ValueType;
useLocalStorage?: boolean;
localStorageOptions?: { getOnInit?: boolean };
}): FamilyState<ValueType, FamilyKey> => {
const atomCache = new Map<
string,
@@ -31,7 +33,12 @@ export const createAtomFamilyState = <ValueType, FamilyKey>({
const atomKey = `${key}__${cacheKey}`;
const baseAtom = useLocalStorage
? atomWithStorage<ValueType>(atomKey, defaultValue)
? atomWithStorage<ValueType>(
atomKey,
defaultValue,
undefined,
localStorageOptions ?? undefined,
)
: atom(defaultValue);
baseAtom.debugLabel = atomKey;
atomCache.set(cacheKey, baseAtom);
packages/twenty-front/src/modules/users/components/LazyMetadataLoadEffect.tsx
+8 -1
View File
@@ -1,5 +1,6 @@
import { useIsLogged } from '@/auth/hooks/useIsLogged';
import { useMetadataStore } from '@/metadata-store/hooks/useMetadataStore';
import { splitPageLayoutWithRelated } from '@/metadata-store/utils/splitPageLayoutWithRelated';
import { navigationMenuItemsState } from '@/navigation-menu-item/states/navigationMenuItemsState';
import { recordPageLayoutsState } from '@/page-layout/states/recordPageLayoutsState';
import { type PageLayout } from '@/page-layout/types/PageLayout';
@@ -109,7 +110,13 @@ export const LazyMetadataLoadEffect = () => {
queryDataRecordPageLayouts.getPageLayouts.map(transformPageLayout);
setRecordPageLayouts(transformedPageLayouts);
updateDraft('pageLayouts', transformedPageLayouts);
const { flatPageLayouts, flatPageLayoutTabs, flatPageLayoutWidgets } =
splitPageLayoutWithRelated(transformedPageLayouts);
updateDraft('pageLayouts', flatPageLayouts);
updateDraft('pageLayoutTabs', flatPageLayoutTabs);
updateDraft('pageLayoutWidgets', flatPageLayoutWidgets);
applyChanges();
}, [
queryDataRecordPageLayouts?.getPageLayouts,
packages/twenty-front/src/modules/views/states/viewsWithRelationsSelector.ts
+130
View File
@@ -0,0 +1,130 @@
import { metadataStoreState } from '@/metadata-store/states/metadataStoreState';
import { type FlatView } from '@/metadata-store/types/FlatView';
import { type FlatViewField } from '@/metadata-store/types/FlatViewField';
import { type FlatViewFieldGroup } from '@/metadata-store/types/FlatViewFieldGroup';
import { type FlatViewFilter } from '@/metadata-store/types/FlatViewFilter';
import { type FlatViewFilterGroup } from '@/metadata-store/types/FlatViewFilterGroup';
import { type FlatViewGroup } from '@/metadata-store/types/FlatViewGroup';
import { type FlatViewSort } from '@/metadata-store/types/FlatViewSort';
import { createAtomSelector } from '@/ui/utilities/state/jotai/utils/createAtomSelector';
import { type CoreViewWithRelations } from '@/views/types/CoreViewWithRelations';
import { isDefined } from 'twenty-shared/utils';
export const viewsWithRelationsSelector = createAtomSelector<
CoreViewWithRelations[]
>({
key: 'viewsWithRelationsSelector',
get: ({ get }) => {
const flatViews = get(metadataStoreState, 'views').current as FlatView[];
const allFlatViewFields = get(metadataStoreState, 'viewFields')
.current as FlatViewField[];
const allFlatViewFilters = get(metadataStoreState, 'viewFilters')
.current as FlatViewFilter[];
const allFlatViewSorts = get(metadataStoreState, 'viewSorts')
.current as FlatViewSort[];
const allFlatViewGroups = get(metadataStoreState, 'viewGroups')
.current as FlatViewGroup[];
const allFlatViewFilterGroups = get(metadataStoreState, 'viewFilterGroups')
.current as FlatViewFilterGroup[];
const allFlatViewFieldGroups = get(metadataStoreState, 'viewFieldGroups')
.current as FlatViewFieldGroup[];
const viewFieldsByViewId = new Map<string, FlatViewField[]>();
const viewFiltersByViewId = new Map<string, FlatViewFilter[]>();
const viewSortsByViewId = new Map<string, FlatViewSort[]>();
const viewGroupsByViewId = new Map<string, FlatViewGroup[]>();
const viewFilterGroupsByViewId = new Map<string, FlatViewFilterGroup[]>();
const viewFieldGroupsByViewId = new Map<string, FlatViewFieldGroup[]>();
for (const viewField of allFlatViewFields) {
const existing = viewFieldsByViewId.get(viewField.viewId);
if (isDefined(existing)) {
existing.push(viewField);
} else {
viewFieldsByViewId.set(viewField.viewId, [viewField]);
}
}
for (const viewFilter of allFlatViewFilters) {
const existing = viewFiltersByViewId.get(viewFilter.viewId);
if (isDefined(existing)) {
existing.push(viewFilter);
} else {
viewFiltersByViewId.set(viewFilter.viewId, [viewFilter]);
}
}
for (const viewSort of allFlatViewSorts) {
const existing = viewSortsByViewId.get(viewSort.viewId);
if (isDefined(existing)) {
existing.push(viewSort);
} else {
viewSortsByViewId.set(viewSort.viewId, [viewSort]);
}
}
for (const viewGroup of allFlatViewGroups) {
const existing = viewGroupsByViewId.get(viewGroup.viewId);
if (isDefined(existing)) {
existing.push(viewGroup);
} else {
viewGroupsByViewId.set(viewGroup.viewId, [viewGroup]);
}
}
for (const viewFilterGroup of allFlatViewFilterGroups) {
const viewId = (viewFilterGroup as { viewId?: string }).viewId;
if (!isDefined(viewId)) {
continue;
}
const existing = viewFilterGroupsByViewId.get(viewId);
if (isDefined(existing)) {
existing.push(viewFilterGroup);
} else {
viewFilterGroupsByViewId.set(viewId, [viewFilterGroup]);
}
}
for (const viewFieldGroup of allFlatViewFieldGroups) {
const viewId = (viewFieldGroup as { viewId?: string }).viewId;
if (!isDefined(viewId)) {
continue;
}
const existing = viewFieldGroupsByViewId.get(viewId);
if (isDefined(existing)) {
existing.push(viewFieldGroup);
} else {
viewFieldGroupsByViewId.set(viewId, [viewFieldGroup]);
}
}
return flatViews.map((flatView) => ({
...flatView,
viewFields: viewFieldsByViewId.get(flatView.id) ?? [],
viewFilters: viewFiltersByViewId.get(flatView.id) ?? [],
viewSorts: viewSortsByViewId.get(flatView.id) ?? [],
viewGroups: viewGroupsByViewId.get(flatView.id) ?? [],
viewFilterGroups: viewFilterGroupsByViewId.get(flatView.id) ?? [],
viewFieldGroups: (viewFieldGroupsByViewId.get(flatView.id) ?? []).map(
(group) => ({
...group,
viewFields: (viewFieldsByViewId.get(flatView.id) ?? []).filter(
(field) =>
(field as unknown as { viewFieldGroupId?: string })
.viewFieldGroupId === group.id,
),
}),
),
}));
},
});
packages/twenty-front/src/testing/jest/JestObjectMetadataItemSetter.tsx
+7 -2
View File
@@ -12,7 +12,7 @@ export const JestObjectMetadataItemSetter = ({
children: ReactNode;
objectMetadataItems?: ObjectMetadataItem[];
}) => {
const { updateDraft, applyChanges } = useMetadataStore();
const { updateDraft, applyChanges, resetMetadataStore } = useMetadataStore();
const [isLoaded, setIsLoaded] = useState(false);
useEffect(() => {
@@ -20,12 +20,17 @@ export const JestObjectMetadataItemSetter = ({
const { flatObjects, flatFields, flatIndexes } =
splitObjectMetadataItemWithRelated(items);
// Reset first so updateDraft always proceeds and writes to localStorage.
// Without this, atomWithStorage's onMount re-reads from empty localStorage
// and overwrites in-memory values when the store is reused across tests.
resetMetadataStore();
updateDraft('objectMetadataItems', flatObjects);
updateDraft('fieldMetadataItems', flatFields);
updateDraft('indexMetadataItems', flatIndexes);
applyChanges();
setIsLoaded(true);
}, [objectMetadataItems, updateDraft, applyChanges]);
}, [objectMetadataItems, updateDraft, applyChanges, resetMetadataStore]);
return isLoaded ? <>{children}</> : null;
};
packages/twenty-sdk/src/clients/generated/metadata/schema.graphql
+27
View File
@@ -2204,6 +2204,32 @@ type AgentTurn {
createdAt: DateTime!
}
type MinimalObjectMetadata {
id: UUID!
nameSingular: String!
namePlural: String!
labelSingular: String!
labelPlural: String!
icon: String
isCustom: Boolean!
isActive: Boolean!
isSystem: Boolean!
isRemote: Boolean!
}
type MinimalView {
id: UUID!
type: ViewType!
key: ViewKey
objectMetadataId: UUID!
}
type MinimalMetadata {
objectMetadataItems: [MinimalObjectMetadata!]!
views: [MinimalView!]!
metadataVersion: Int!
}
type Webhook {
id: UUID!
targetUrl: String!
@@ -2955,6 +2981,7 @@ type Query {
getSSOIdentityProviders: [FindAvailableSSOIDP!]!
webhooks: [Webhook!]!
webhook(id: UUID!): Webhook
minimalMetadata: MinimalMetadata!
chatThread(id: UUID!): AgentChatThread!
chatMessages(threadId: UUID!): [AgentMessage!]!
getAISystemPromptPreview: AISystemPromptPreview!
packages/twenty-sdk/src/clients/generated/metadata/schema.ts
+87
View File
@@ -1885,6 +1885,35 @@ export interface AgentTurn {
__typename: 'AgentTurn'
}
export interface MinimalObjectMetadata {
id: Scalars['UUID']
nameSingular: Scalars['String']
namePlural: Scalars['String']
labelSingular: Scalars['String']
labelPlural: Scalars['String']
icon?: Scalars['String']
isCustom: Scalars['Boolean']
isActive: Scalars['Boolean']
isSystem: Scalars['Boolean']
isRemote: Scalars['Boolean']
__typename: 'MinimalObjectMetadata'
}
export interface MinimalView {
id: Scalars['UUID']
type: ViewType
key?: ViewKey
objectMetadataId: Scalars['UUID']
__typename: 'MinimalView'
}
export interface MinimalMetadata {
objectMetadataItems: MinimalObjectMetadata[]
views: MinimalView[]
metadataVersion: Scalars['Int']
__typename: 'MinimalMetadata'
}
export interface Webhook {
id: Scalars['UUID']
targetUrl: Scalars['String']
@@ -2595,6 +2624,7 @@ export interface Query {
getSSOIdentityProviders: FindAvailableSSOIDP[]
webhooks: Webhook[]
webhook?: Webhook
minimalMetadata: MinimalMetadata
chatThread: AgentChatThread
chatMessages: AgentMessage[]
getAISystemPromptPreview: AISystemPromptPreview
@@ -4848,6 +4878,38 @@ export interface AgentTurnGenqlSelection{
__scalar?: boolean | number
}
export interface MinimalObjectMetadataGenqlSelection{
id?: boolean | number
nameSingular?: boolean | number
namePlural?: boolean | number
labelSingular?: boolean | number
labelPlural?: boolean | number
icon?: boolean | number
isCustom?: boolean | number
isActive?: boolean | number
isSystem?: boolean | number
isRemote?: boolean | number
__typename?: boolean | number
__scalar?: boolean | number
}
export interface MinimalViewGenqlSelection{
id?: boolean | number
type?: boolean | number
key?: boolean | number
objectMetadataId?: boolean | number
__typename?: boolean | number
__scalar?: boolean | number
}
export interface MinimalMetadataGenqlSelection{
objectMetadataItems?: MinimalObjectMetadataGenqlSelection
views?: MinimalViewGenqlSelection
metadataVersion?: boolean | number
__typename?: boolean | number
__scalar?: boolean | number
}
export interface WebhookGenqlSelection{
id?: boolean | number
targetUrl?: boolean | number
@@ -5618,6 +5680,7 @@ export interface QueryGenqlSelection{
getSSOIdentityProviders?: FindAvailableSSOIDPGenqlSelection
webhooks?: WebhookGenqlSelection
webhook?: (WebhookGenqlSelection & { __args: {id: Scalars['UUID']} })
minimalMetadata?: MinimalMetadataGenqlSelection
chatThread?: (AgentChatThreadGenqlSelection & { __args: {id: Scalars['UUID']} })
chatMessages?: (AgentMessageGenqlSelection & { __args: {threadId: Scalars['UUID']} })
getAISystemPromptPreview?: AISystemPromptPreviewGenqlSelection
@@ -7611,6 +7674,30 @@ export interface LogicFunctionLogsInput {applicationId?: (Scalars['UUID'] | null
const MinimalObjectMetadata_possibleTypes: string[] = ['MinimalObjectMetadata']
export const isMinimalObjectMetadata = (obj?: { __typename?: any } | null): obj is MinimalObjectMetadata => {
if (!obj?.__typename) throw new Error('__typename is missing in "isMinimalObjectMetadata"')
return MinimalObjectMetadata_possibleTypes.includes(obj.__typename)
}
const MinimalView_possibleTypes: string[] = ['MinimalView']
export const isMinimalView = (obj?: { __typename?: any } | null): obj is MinimalView => {
if (!obj?.__typename) throw new Error('__typename is missing in "isMinimalView"')
return MinimalView_possibleTypes.includes(obj.__typename)
}
const MinimalMetadata_possibleTypes: string[] = ['MinimalMetadata']
export const isMinimalMetadata = (obj?: { __typename?: any } | null): obj is MinimalMetadata => {
if (!obj?.__typename) throw new Error('__typename is missing in "isMinimalMetadata"')
return MinimalMetadata_possibleTypes.includes(obj.__typename)
}
const Webhook_possibleTypes: string[] = ['Webhook']
export const isWebhook = (obj?: { __typename?: any } | null): obj is Webhook => {
if (!obj?.__typename) throw new Error('__typename is missing in "isWebhook"')
packages/twenty-sdk/src/clients/generated/metadata/types.ts
+356 -287
View File
File diff suppressed because it is too large Load Diff
packages/twenty-server/src/engine/metadata-modules/metadata-engine.module.ts
+3
View File
@@ -15,6 +15,7 @@ import { LogicFunctionModule } from 'src/engine/metadata-modules/logic-function/
import { NavigationMenuItemModule } from 'src/engine/metadata-modules/navigation-menu-item/navigation-menu-item.module';
import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { MinimalMetadataModule } from 'src/engine/metadata-modules/minimal-metadata/minimal-metadata.module';
import { RoleModule } from 'src/engine/metadata-modules/role/role.module';
import { RouteTriggerModule } from 'src/engine/metadata-modules/route-trigger/route-trigger.module';
import { SearchFieldMetadataModule } from 'src/engine/metadata-modules/search-field-metadata/search-field-metadata.module';
@@ -39,6 +40,7 @@ import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/work
AiAgentMonitorModule,
AiChatModule,
AiGenerateTextModule,
MinimalMetadataModule,
ViewModule,
WorkspaceMetadataVersionModule,
RoleModule,
@@ -64,6 +66,7 @@ import { WorkspaceMetadataVersionModule } from 'src/engine/metadata-modules/work
NavigationMenuItemModule,
AiAgentModule,
AiChatModule,
MinimalMetadataModule,
ViewModule,
RoleModule,
PermissionsModule,
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/dtos/minimal-metadata.dto.ts
+16
View File
@@ -0,0 +1,16 @@
import { Field, Int, ObjectType } from '@nestjs/graphql';
import { MinimalObjectMetadataDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-object-metadata.dto';
import { MinimalViewDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-view.dto';
@ObjectType('MinimalMetadata')
export class MinimalMetadataDTO {
@Field(() => [MinimalObjectMetadataDTO])
objectMetadataItems: MinimalObjectMetadataDTO[];
@Field(() => [MinimalViewDTO])
views: MinimalViewDTO[];
@Field(() => Int)
metadataVersion: number;
}
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/dtos/minimal-object-metadata.dto.ts
+38
View File
@@ -0,0 +1,38 @@
import { Field, ObjectType } from '@nestjs/graphql';
import { IDField } from '@ptc-org/nestjs-query-graphql';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@ObjectType('MinimalObjectMetadata')
export class MinimalObjectMetadataDTO {
@IDField(() => UUIDScalarType)
id: string;
@Field()
nameSingular: string;
@Field()
namePlural: string;
@Field()
labelSingular: string;
@Field()
labelPlural: string;
@Field({ nullable: true })
icon?: string;
@Field()
isCustom: boolean;
@Field()
isActive: boolean;
@Field()
isSystem: boolean;
@Field()
isRemote: boolean;
}
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/dtos/minimal-view.dto.ts
+21
View File
@@ -0,0 +1,21 @@
import { Field, ObjectType } from '@nestjs/graphql';
import { IDField } from '@ptc-org/nestjs-query-graphql';
import { ViewKey, ViewType } from 'twenty-shared/types';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
@ObjectType('MinimalView')
export class MinimalViewDTO {
@IDField(() => UUIDScalarType)
id: string;
@Field(() => ViewType)
type: ViewType;
@Field(() => ViewKey, { nullable: true })
key: ViewKey | null;
@Field(() => UUIDScalarType)
objectMetadataId: string;
}
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/minimal-metadata.module.ts
+17
View File
@@ -0,0 +1,17 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { MinimalMetadataResolver } from 'src/engine/metadata-modules/minimal-metadata/minimal-metadata.resolver';
import { MinimalMetadataService } from 'src/engine/metadata-modules/minimal-metadata/minimal-metadata.service';
@Module({
imports: [
TypeOrmModule.forFeature([WorkspaceEntity]),
WorkspaceManyOrAllFlatEntityMapsCacheModule,
],
providers: [MinimalMetadataResolver, MinimalMetadataService],
exports: [MinimalMetadataService],
})
export class MinimalMetadataModule {}
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/minimal-metadata.resolver.ts
+30
View File
@@ -0,0 +1,30 @@
import { UseGuards } from '@nestjs/common';
import { Query } from '@nestjs/graphql';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthUserWorkspaceId } from 'src/engine/decorators/auth/auth-user-workspace-id.decorator';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { MinimalMetadataDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-metadata.dto';
import { MinimalMetadataService } from 'src/engine/metadata-modules/minimal-metadata/minimal-metadata.service';
@MetadataResolver(() => MinimalMetadataDTO)
@UseGuards(WorkspaceAuthGuard, NoPermissionGuard)
export class MinimalMetadataResolver {
constructor(
private readonly minimalMetadataService: MinimalMetadataService,
) {}
@Query(() => MinimalMetadataDTO)
async minimalMetadata(
@AuthWorkspace() workspace: WorkspaceEntity,
@AuthUserWorkspaceId() userWorkspaceId: string | undefined,
): Promise<MinimalMetadataDTO> {
return this.minimalMetadataService.getMinimalMetadata(
workspace.id,
userWorkspaceId,
);
}
}
packages/twenty-server/src/engine/metadata-modules/minimal-metadata/minimal-metadata.service.ts
+82
View File
@@ -0,0 +1,82 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { ViewVisibility } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { WorkspaceManyOrAllFlatEntityMapsCacheService } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.service';
import { MinimalMetadataDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-metadata.dto';
import { MinimalObjectMetadataDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-object-metadata.dto';
import { MinimalViewDTO } from 'src/engine/metadata-modules/minimal-metadata/dtos/minimal-view.dto';
@Injectable()
export class MinimalMetadataService {
constructor(
@InjectRepository(WorkspaceEntity)
private readonly workspaceRepository: Repository<WorkspaceEntity>,
private readonly flatEntityMapsCacheService: WorkspaceManyOrAllFlatEntityMapsCacheService,
) {}
async getMinimalMetadata(
workspaceId: string,
userWorkspaceId?: string,
): Promise<MinimalMetadataDTO> {
const [workspace, { flatObjectMetadataMaps, flatViewMaps }] =
await Promise.all([
this.workspaceRepository.findOneOrFail({
where: { id: workspaceId },
select: ['metadataVersion'],
}),
this.flatEntityMapsCacheService.getOrRecomputeManyOrAllFlatEntityMaps({
workspaceId,
flatMapsKeys: ['flatObjectMetadataMaps', 'flatViewMaps'],
}),
]);
const objectMetadataItems: MinimalObjectMetadataDTO[] = Object.values(
flatObjectMetadataMaps.byUniversalIdentifier,
)
.filter(isDefined)
.filter((flatObjectMetadata) => flatObjectMetadata.isActive === true)
.map((flatObjectMetadata) => ({
id: flatObjectMetadata.id,
nameSingular: flatObjectMetadata.nameSingular,
namePlural: flatObjectMetadata.namePlural,
labelSingular: flatObjectMetadata.labelSingular,
labelPlural: flatObjectMetadata.labelPlural,
icon: flatObjectMetadata.icon ?? undefined,
isCustom: flatObjectMetadata.isCustom,
isActive: flatObjectMetadata.isActive,
isSystem: flatObjectMetadata.isSystem,
isRemote: flatObjectMetadata.isRemote,
}));
const views: MinimalViewDTO[] = Object.values(
flatViewMaps.byUniversalIdentifier,
)
.filter(isDefined)
.filter((flatView) => flatView.workspaceId === workspaceId)
.filter((flatView) => flatView.deletedAt === null)
.filter(
(flatView) =>
flatView.visibility === ViewVisibility.WORKSPACE ||
(flatView.visibility === ViewVisibility.UNLISTED &&
isDefined(userWorkspaceId) &&
flatView.createdByUserWorkspaceId === userWorkspaceId),
)
.map((flatView) => ({
id: flatView.id,
type: flatView.type,
key: flatView.key,
objectMetadataId: flatView.objectMetadataId,
}));
return {
objectMetadataItems,
views,
metadataVersion: workspace.metadataVersion,
};
}
}