[REFACTOR] twenty-shared multi barrel and CJS/ESM build with preconstruct (#11083)

# Introduction

In this PR we've migrated `twenty-shared` from a `vite` app
[libary-mode](https://vite.dev/guide/build#library-mode) to a
[preconstruct](https://preconstruct.tools/) "atomic" application ( in
the future would like to introduce preconstruct to handle of all our
atomic dependencies such as `twenty-emails` `twenty-ui` etc it will be
integrated at the monorepo's root directly, would be to invasive in the
first, starting incremental via `twenty-shared`)

For more information regarding the motivations please refer to nor:
- https://github.com/twentyhq/core-team-issues/issues/587
-
https://github.com/twentyhq/core-team-issues/issues/281#issuecomment-2630949682

close https://github.com/twentyhq/core-team-issues/issues/589
close https://github.com/twentyhq/core-team-issues/issues/590

## How to test
In order to ease the review this PR will ship all the codegen at the
very end, the actual meaning full diff is `+2,411 −114`
In order to migrate existing dependent packages to `twenty-shared` multi
barrel new arch you need to run in local:
```sh
yarn tsx packages/twenty-shared/scripts/migrateFromSingleToMultiBarrelImport.ts && \
npx nx run-many -t lint --fix -p twenty-front twenty-ui twenty-server twenty-emails twenty-shared twenty-zapier
```
Note that `migrateFromSingleToMultiBarrelImport` is idempotent, it's atm
included in the PR but should not be merged. ( such as codegen will be
added before merging this script will be removed )

## Misc
- related opened issue preconstruct
https://github.com/preconstruct/preconstruct/issues/617

## Closed related PR
- https://github.com/twentyhq/twenty/pull/11028
- https://github.com/twentyhq/twenty/pull/10993
- https://github.com/twentyhq/twenty/pull/10960

## Upcoming enhancement: ( in others dedicated PRs )
- 1/ refactor generate barrel to export atomic module instead of `*`
- 2/ generate barrel own package with several files and tests
- 3/ Migration twenty-ui the same way
- 4/ Use `preconstruct` at monorepo global level

## Conclusion
As always any suggestions are welcomed !
This commit is contained in:
Paul Rastoin
2025-03-22 19:16:06 +01:00
committed by GitHub
parent 8a21c19f03
commit 9ad8287dbc
1091 changed files with 3611 additions and 1297 deletions

View File

@ -17,7 +17,7 @@ import {
import { createListingCustomObject } from 'test/integration/metadata/suites/object-metadata/utils/create-test-object-metadata.util';
import { deleteOneObjectMetadataItem } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { findManyObjectsMetadataItems } from 'test/integration/metadata/suites/object-metadata/utils/find-many-objects-metadata-items.util';
import { EachTestingContext } from 'twenty-shared';
import { EachTestingContext } from 'twenty-shared/testing';
import { GlobalSearchRecordDTO } from 'src/engine/core-modules/global-search/dtos/global-search-record-dto';

View File

@ -10,7 +10,7 @@ import { deleteOneObjectMetadataItemFactory } from 'test/integration/metadata/su
import { deleteOneObjectMetadataItem } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { updateOneObjectMetadataItemFactory } from 'test/integration/metadata/suites/object-metadata/utils/update-one-object-metadata-factory.util';
import { makeMetadataAPIRequestWithMemberRole } from 'test/integration/metadata/suites/utils/make-metadata-api-request-with-member-role.util';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
import { SEED_APPLE_WORKSPACE_ID } from 'src/database/typeorm-seeds/core/workspaces';
import { ErrorCode } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type CreateManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type CreateOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type DeleteManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type DeleteOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type DestroyManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type DestroyOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type FindManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type FindOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -2,7 +2,7 @@ import { randomUUID } from 'crypto';
import { createManyOperationFactory } from 'test/integration/graphql/utils/create-many-operation-factory.util';
import { makeGraphqlAPIRequest } from 'test/integration/graphql/utils/make-graphql-api-request.util';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
export const performCreateManyOperation = async (
objectMetadataSingularName: string,

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type RestoreManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type RestoreOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type UpdateManyOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -1,5 +1,5 @@
import gql from 'graphql-tag';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
type UpdateOneOperationFactoryParams = {
objectMetadataSingularName: string;

View File

@ -2,7 +2,7 @@ import { createOneFieldMetadataFactory } from 'test/integration/metadata/suites/
import { createListingCustomObject } from 'test/integration/metadata/suites/object-metadata/utils/create-test-object-metadata.util';
import { deleteOneObjectMetadataItem } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('createOne', () => {
describe('FieldMetadataService name/label sync', () => {

View File

@ -1,6 +1,6 @@
import { createOneFieldMetadataFactory } from 'test/integration/metadata/suites/field-metadata/utils/create-one-field-metadata-factory.util';
import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
const FIELD_NAME = 'testName';

View File

@ -1,6 +1,6 @@
import { getMockCreateObjectInput } from 'test/integration/utils/object-metadata/generate-mock-create-object-metadata-input';
import { performFailingObjectMetadataCreation } from 'test/integration/utils/object-metadata/perform-failing-object-metadata-creation';
import { EachTestingContext } from 'twenty-shared';
import { EachTestingContext } from 'twenty-shared/testing';
import { ErrorCode } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';

View File

@ -7,9 +7,10 @@ import { createOneRelationMetadataFactory } from 'test/integration/metadata/suit
import { deleteOneRelationMetadataItemFactory } from 'test/integration/metadata/suites/utils/delete-one-relation-metadata-factory.util';
import { fieldsMetadataFactory } from 'test/integration/metadata/suites/utils/fields-metadata-factory.util';
import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
import { RelationMetadataType } from 'src/engine/metadata-modules/relation-metadata/relation-metadata.entity';
const LISTING_NAME_SINGULAR = 'listing';
describe('Custom object renaming', () => {

View File

@ -1,7 +1,7 @@
import { deleteOneObjectMetadataItem } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { getMockCreateObjectInput } from 'test/integration/utils/object-metadata/generate-mock-create-object-metadata-input';
import { performObjectMetadataCreation } from 'test/integration/utils/object-metadata/perform-object-metadata-creation';
import { EachTestingContext } from 'twenty-shared';
import { EachTestingContext } from 'twenty-shared/testing';
import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';

View File

@ -1,6 +1,6 @@
import { deleteOneObjectMetadataItem } from 'test/integration/metadata/suites/object-metadata/utils/delete-one-object-metadata.util';
import { performObjectMetadataCreation } from 'test/integration/utils/object-metadata/perform-object-metadata-creation';
import { isDefined } from 'twenty-shared';
import { isDefined } from 'twenty-shared/utils';
import { CreateObjectInput } from 'src/engine/metadata-modules/object-metadata/dtos/create-object.input';