## Summary - Renames `ObjectMetadataItem` to `EnrichedObjectMetadataItem` across the entire frontend (~440 files) to clarify that this type includes derived fields (`readableFields`, `updatableFields`, nested `fields[]`, `indexMetadatas[]`) computed at read time from the metadata store - Creates `splitObjectMetadataGqlResponse` that goes directly from a GraphQL `ObjectMetadataItemsQuery` response to flat store items (combining the old `mapPaginatedObjectMetadataItemsToObjectMetadataItems` + `splitObjectMetadataItemWithRelated` two-step flow into one call) - Removes `ObjectMetadataItemWithRelated` type and all "WithRelated" naming - Renames `generatedMockObjectMetadataItems` to `generateTestEnrichedObjectMetadataItemsMock` to make it clear this is test-only enriched data - Deletes `useLoadMockedObjectMetadataItems` hook (consolidated into `useLoadMockedMinimalMetadata`) - Ensures nothing destined for the metadata store computes `readableFields`/`updatableFields` (preventing the localStorage bloat from #18809) ## Type hierarchy (before → after) **Before:** ``` ObjectMetadataItemsQuery → mapPaginated → ObjectMetadataItemWithRelated → enrich → ObjectMetadataItem → split → FlatObjectMetadataItem (store) ``` **After:** ``` ObjectMetadataItemsQuery → splitObjectMetadataGqlResponse → FlatObjectMetadataItem (store) → mapPaginated + enrich (tests only) → EnrichedObjectMetadataItem ``` ## Test plan - [x] `npx nx typecheck twenty-front` passes - [x] `npx nx test twenty-front` passes (767 suites, 4505 tests) - [x] `npx nx lint twenty-front` passes - [ ] CI checks pass Made with [Cursor](https://cursor.com)
114 lines
3.5 KiB
TypeScript
114 lines
3.5 KiB
TypeScript
/* oxlint-disable no-console, lingui/no-unlocalized-strings */
|
|
import { print } from 'graphql';
|
|
|
|
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
|
|
import { generateDepthRecordGqlFieldsFromObject } from '@/object-record/graphql/record-gql-fields/utils/generateDepthRecordGqlFieldsFromObject';
|
|
import { generateFindManyRecordsQuery } from '@/object-record/utils/generateFindManyRecordsQuery';
|
|
|
|
import { graphqlRequest, writeGeneratedFile } from './utils.js';
|
|
|
|
const RECORDS_LIMIT = 10;
|
|
|
|
const OBJECTS_TO_GENERATE = [
|
|
'company',
|
|
'person',
|
|
'task',
|
|
'note',
|
|
'timelineActivity',
|
|
'workspaceMember',
|
|
'favorite',
|
|
'favoriteFolder',
|
|
'connectedAccount',
|
|
'calendarEvent',
|
|
];
|
|
|
|
// Production query builders omit __typename on connection/edge wrappers
|
|
// since Apollo Client injects them automatically. Raw fetch needs them explicit.
|
|
const addTypenamesToSelections = (query: string): string =>
|
|
query.replace(/\{(?!\s*__typename\b)/g, '{\n__typename');
|
|
|
|
const toObjectMetadataItems = (rawMetadata: {
|
|
objects: { edges: { node: Record<string, unknown> }[] };
|
|
}): EnrichedObjectMetadataItem[] =>
|
|
rawMetadata.objects.edges.map((edge) => {
|
|
const { fieldsList, indexMetadataList, ...rest } = edge.node;
|
|
|
|
return {
|
|
...rest,
|
|
fields: fieldsList,
|
|
readableFields: fieldsList,
|
|
updatableFields: fieldsList,
|
|
indexMetadatas: ((indexMetadataList as unknown[]) ?? []).map(
|
|
(index: any) => ({
|
|
...index,
|
|
indexFieldMetadatas: index.indexFieldMetadataList ?? [],
|
|
}),
|
|
),
|
|
} as unknown as EnrichedObjectMetadataItem;
|
|
});
|
|
|
|
const generateForObject = async (
|
|
token: string,
|
|
objectMetadataItems: EnrichedObjectMetadataItem[],
|
|
objectNameSingular: string,
|
|
) => {
|
|
const objectMetadataItem = objectMetadataItems.find(
|
|
(item) => item.nameSingular === objectNameSingular,
|
|
);
|
|
|
|
if (!objectMetadataItem) {
|
|
throw new Error(`${objectNameSingular} object metadata not found`);
|
|
}
|
|
|
|
const recordGqlFields = generateDepthRecordGqlFieldsFromObject({
|
|
objectMetadataItems,
|
|
objectMetadataItem,
|
|
depth: 1,
|
|
});
|
|
|
|
const queryDocument = generateFindManyRecordsQuery({
|
|
objectMetadataItem,
|
|
objectMetadataItems,
|
|
recordGqlFields,
|
|
objectPermissionsByObjectMetadataId: {},
|
|
});
|
|
|
|
const query = addTypenamesToSelections(print(queryDocument));
|
|
|
|
console.log(
|
|
`Fetching ${objectMetadataItem.namePlural} (limit: ${RECORDS_LIMIT}) from /graphql ...`,
|
|
);
|
|
|
|
const data = (await graphqlRequest('/graphql', query, token, {
|
|
limit: RECORDS_LIMIT,
|
|
})) as Record<string, { edges: { node: Record<string, unknown> }[] }>;
|
|
|
|
const records = data[objectMetadataItem.namePlural].edges.map(
|
|
(edge) => edge.node,
|
|
);
|
|
|
|
console.log(` Got ${records.length} ${objectMetadataItem.namePlural}.`);
|
|
|
|
const pascalName =
|
|
objectNameSingular.charAt(0).toUpperCase() + objectNameSingular.slice(1);
|
|
|
|
writeGeneratedFile(
|
|
`data/${objectMetadataItem.namePlural}/mock-${objectMetadataItem.namePlural}-data.ts`,
|
|
`mocked${pascalName}Records`,
|
|
'ObjectRecord[]',
|
|
"import { type ObjectRecord } from '@/object-record/types/ObjectRecord';",
|
|
records,
|
|
);
|
|
};
|
|
|
|
export const generateRecordData = async (
|
|
token: string,
|
|
rawMetadata: { objects: { edges: { node: Record<string, unknown> }[] } },
|
|
) => {
|
|
const objectMetadataItems = toObjectMetadataItems(rawMetadata);
|
|
|
|
for (const objectNameSingular of OBJECTS_TO_GENERATE) {
|
|
await generateForObject(token, objectMetadataItems, objectNameSingular);
|
|
}
|
|
};
|