FlatObject/FieldMetadata and FlatObjectMetadataMaps mocks (#13691)

# Introduction
As discussed with Charles we will introduce a new command to convert
seeded twenty instance into `flatObjectMetadatas` `flatFieldMetadatas`
mocks but later.
We can think of this PR as a partial freeze of this command result run
even tho the template might not be strictly the same in the end.
For the moment we only extracted few objects with their fields in order
to start testing newly introduced tools

used scripts ( not committed and written on the fly ):
https://gist.github.com/prastoin/bdfae0da1e3e9c66ae21c972afbd0d1e
https://gist.github.com/prastoin/30029989bf57de9303e3f7ec235271ee
This commit is contained in:
Paul Rastoin
2025-08-06 17:10:09 +02:00
committed by GitHub
parent 040fde459a
commit b71e6b0609
26 changed files with 8059 additions and 0 deletions
@@ -0,0 +1,25 @@
import { ATTACHMENT_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/attachment-flat-object.mock';
import { COMPANY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/company-flat-object.mock';
import { NOTE_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/note-flat-object.mock';
import { NOTETARGET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/notetarget-flat-object.mock';
import { OPPORTUNITY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/opportunity-flat-object.mock';
import { PERSON_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/person-flat-object.mock';
import { PET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/pet-flat-object.mock';
import { ROCKET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/rocket-flat-object.mock';
import { TASK_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/task-flat-object.mock';
import { TASKTARGET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/tasktarget-flat-object.mock';
import { TIMELINEACTIVITY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/timelineactivity-flat-object.mock';
export const ALL_FLAT_OBJECT_METADATA_MOCKS = [
TIMELINEACTIVITY_FLAT_OBJECT_MOCK,
NOTETARGET_FLAT_OBJECT_MOCK,
OPPORTUNITY_FLAT_OBJECT_MOCK,
PERSON_FLAT_OBJECT_MOCK,
TASK_FLAT_OBJECT_MOCK,
TASKTARGET_FLAT_OBJECT_MOCK,
PET_FLAT_OBJECT_MOCK,
ROCKET_FLAT_OBJECT_MOCK,
NOTE_FLAT_OBJECT_MOCK,
COMPANY_FLAT_OBJECT_MOCK,
ATTACHMENT_FLAT_OBJECT_MOCK,
] as const;
@@ -0,0 +1,25 @@
import { ATTACHMENT_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/attachment-flat-object.mock';
import { COMPANY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/company-flat-object.mock';
import { NOTE_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/note-flat-object.mock';
import { NOTETARGET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/notetarget-flat-object.mock';
import { OPPORTUNITY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/opportunity-flat-object.mock';
import { PERSON_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/person-flat-object.mock';
import { PET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/pet-flat-object.mock';
import { ROCKET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/rocket-flat-object.mock';
import { TASK_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/task-flat-object.mock';
import { TASKTARGET_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/tasktarget-flat-object.mock';
import { TIMELINEACTIVITY_FLAT_OBJECT_MOCK } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/timelineactivity-flat-object.mock';
export const ALL_FLAT_OBJECT_METADATA_MOCKS = [
TIMELINEACTIVITY_FLAT_OBJECT_MOCK,
NOTETARGET_FLAT_OBJECT_MOCK,
OPPORTUNITY_FLAT_OBJECT_MOCK,
PERSON_FLAT_OBJECT_MOCK,
TASK_FLAT_OBJECT_MOCK,
TASKTARGET_FLAT_OBJECT_MOCK,
PET_FLAT_OBJECT_MOCK,
ROCKET_FLAT_OBJECT_MOCK,
NOTE_FLAT_OBJECT_MOCK,
COMPANY_FLAT_OBJECT_MOCK,
ATTACHMENT_FLAT_OBJECT_MOCK,
] as const;
@@ -0,0 +1,29 @@
import { ATTACHMENT_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/attachment-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const ATTACHMENT_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '819ed5ff-312f-4423-8e95-02a691cf5c27',
standardId: '20202020-bd3d-4c60-8dca-571c71d4447a',
nameSingular: 'attachment',
namePlural: 'attachments',
labelSingular: 'Attachment',
labelPlural: 'Attachments',
description: 'An attachment',
icon: 'IconFileImport',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: true,
isAuditLogged: true,
isSearchable: false,
shortcut: null,
labelIdentifierFieldMetadataId: 'f51cfa5d-7190-48a5-b548-3e542322c144',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-bd3d-4c60-8dca-571c71d4447a',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(ATTACHMENT_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { COMPANY_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/company-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const COMPANY_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '7f5c2c7a-bb23-46fb-b59d-9b7a52a8d1cc',
standardId: '20202020-b374-4779-a561-80086cb2e17f',
nameSingular: 'company',
namePlural: 'companies',
labelSingular: 'Company',
labelPlural: 'Companies',
description: 'A company',
icon: 'IconBuildingSkyscraper',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: 'C',
labelIdentifierFieldMetadataId: '12b304b6-ea97-4dcc-9415-9f7b2ac4b729',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-b374-4779-a561-80086cb2e17f',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(COMPANY_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { NOTE_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/note-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const NOTE_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '1253e3e5-5b00-4a34-93b8-02f3dc6e2b7c',
standardId: '20202020-0b00-45cd-b6f6-6cd806fc6804',
nameSingular: 'note',
namePlural: 'notes',
labelSingular: 'Note',
labelPlural: 'Notes',
description: 'A note',
icon: 'IconNotes',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: 'N',
labelIdentifierFieldMetadataId: '3cb30a3f-31c1-47d3-a61e-e537615390c8',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-0b00-45cd-b6f6-6cd806fc6804',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(NOTE_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { NOTETARGET_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/notetarget-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const NOTETARGET_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '12e3cb51-c3de-4192-b0d5-965d48d001c0',
standardId: '20202020-fff0-4b44-be82-bda313884400',
nameSingular: 'noteTarget',
namePlural: 'noteTargets',
labelSingular: 'Note Target',
labelPlural: 'Note Targets',
description: 'A note target',
icon: 'IconCheckbox',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: true,
isAuditLogged: true,
isSearchable: false,
shortcut: null,
labelIdentifierFieldMetadataId: '3ef6c3df-6569-4d00-b1ae-3893e8e55a7e',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-fff0-4b44-be82-bda313884400',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(NOTETARGET_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { OPPORTUNITY_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/opportunity-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const OPPORTUNITY_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: 'e6996bbf-dd41-423a-9324-8546f5b22fa7',
standardId: '20202020-9549-49dd-b2b2-883999db8938',
nameSingular: 'opportunity',
namePlural: 'opportunities',
labelSingular: 'Opportunity',
labelPlural: 'Opportunities',
description: 'An opportunity',
icon: 'IconTargetArrow',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: 'O',
labelIdentifierFieldMetadataId: '5f510348-58e9-4ded-8dbe-144ae3644bd4',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-9549-49dd-b2b2-883999db8938',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(OPPORTUNITY_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { PERSON_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/person-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const PERSON_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '843e0b67-9619-4628-91c4-2fa62256a611',
standardId: '20202020-e674-48e5-a542-72570eee7213',
nameSingular: 'person',
namePlural: 'people',
labelSingular: 'Person',
labelPlural: 'People',
description: 'A person',
icon: 'IconUser',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: 'P',
labelIdentifierFieldMetadataId: 'f410c1cd-2523-4802-be8e-1acc852b4b1a',
imageIdentifierFieldMetadataId: '05e46775-93e9-46c4-8b6f-94829045b1ad',
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-e674-48e5-a542-72570eee7213',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(PERSON_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { PET_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/pet-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const PET_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: 'd34e0f07-1b8c-4de0-938e-599cf05e1f7f',
standardId: null,
nameSingular: 'pet',
namePlural: 'pets',
labelSingular: 'Pet',
labelPlural: 'Pets',
description: null,
icon: 'IconCat',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: true,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: null,
labelIdentifierFieldMetadataId: '4311d4e0-ce63-479c-a4da-5b244e2348cc',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: 'd34e0f07-1b8c-4de0-938e-599cf05e1f7f',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(PET_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { ROCKET_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/rocket-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const ROCKET_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: 'd78ec657-74a4-4652-a350-1f44ff62970a',
standardId: null,
nameSingular: 'rocket',
namePlural: 'rockets',
labelSingular: 'Rocket',
labelPlural: 'Rockets',
description: 'A rocket',
icon: 'IconRocket',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: true,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: null,
labelIdentifierFieldMetadataId: '9c10de36-1ade-4be1-af78-c4fc55669fbd',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: 'd78ec657-74a4-4652-a350-1f44ff62970a',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(ROCKET_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { TASK_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/task-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const TASK_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '3186920d-2a15-4b5f-96c7-2bf6567024b0',
standardId: '20202020-1ba1-48ba-bc83-ef7e5990ed10',
nameSingular: 'task',
namePlural: 'tasks',
labelSingular: 'Task',
labelPlural: 'Tasks',
description: 'A task',
icon: 'IconCheckbox',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: false,
isAuditLogged: true,
isSearchable: true,
shortcut: 'T',
labelIdentifierFieldMetadataId: '88e4eeac-1d47-4e44-a795-bb5ca93c6557',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-1ba1-48ba-bc83-ef7e5990ed10',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(TASK_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { TASKTARGET_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/tasktarget-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const TASKTARGET_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: 'bb2b29b8-7f46-4106-a8ae-3a32df9c9166',
standardId: '20202020-5a9a-44e8-95df-771cd06d0fb1',
nameSingular: 'taskTarget',
namePlural: 'taskTargets',
labelSingular: 'Task Target',
labelPlural: 'Task Targets',
description: 'A task target',
icon: 'IconCheckbox',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: true,
isAuditLogged: true,
isSearchable: false,
shortcut: null,
labelIdentifierFieldMetadataId: '762d956d-d11a-4fe6-b6c1-182b9f63a56b',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-5a9a-44e8-95df-771cd06d0fb1',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(TASKTARGET_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,29 @@
import { TIMELINEACTIVITY_FLAT_FIELDS_MOCK } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/timelineactivity-flat-fields.mock';
import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';
export const TIMELINEACTIVITY_FLAT_OBJECT_MOCK = getFlatObjectMetadataMock({
id: '3090f830-c4b1-41a1-8e18-815760830bec',
standardId: '20202020-6736-4337-b5c4-8b39fae325a5',
nameSingular: 'timelineActivity',
namePlural: 'timelineActivities',
labelSingular: 'Timeline Activity',
labelPlural: 'Timeline Activities',
description: 'Aggregated / filtered event to be displayed on the timeline',
icon: 'IconTimelineEvent',
standardOverrides: null,
targetTableName: 'DEPRECATED',
isCustom: false,
isRemote: false,
isActive: true,
isSystem: true,
isAuditLogged: false,
isSearchable: false,
shortcut: null,
labelIdentifierFieldMetadataId: 'e78264fa-48bc-46cd-afc1-c5f2b5eb9472',
imageIdentifierFieldMetadataId: null,
isLabelSyncedWithName: false,
workspaceId: '20202020-1c25-4d02-bf25-6aeccf7ea419',
uniqueIdentifier: '20202020-6736-4337-b5c4-8b39fae325a5',
flatIndexMetadatas: [],
flatFieldMetadatas: Object.values(TIMELINEACTIVITY_FLAT_FIELDS_MOCK),
});
@@ -0,0 +1,21 @@
import { FlatObjectMetadataMaps } from 'src/engine/metadata-modules/flat-object-metadata-maps/types/flat-object-metadata-maps.type';
import { addFlatObjectMetadataToFlatObjectMetadataMapsOrThrow } from 'src/engine/metadata-modules/flat-object-metadata-maps/utils/add-flat-object-metadata-to-flat-object-metadata-maps-or-throw.util';
import { FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
export const fromFlatObjectMetadatasToFlatObjectMetadataMaps = (
flatObjectMetadatas: FlatObjectMetadata[],
) => {
const emptyFlatObjectMetadataMaps: FlatObjectMetadataMaps = {
byId: {},
idByNameSingular: {},
};
return flatObjectMetadatas.reduce(
(flatObjectMetadataMaps, flatObjectMetadata) =>
addFlatObjectMetadataToFlatObjectMetadataMapsOrThrow({
flatObjectMetadata,
flatObjectMetadataMaps,
}),
emptyFlatObjectMetadataMaps,
);
};