[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

@ -4,8 +4,8 @@ import {
Fields,
SpreadsheetImportDialogOptions,
} from '@/spreadsheet-import/types';
import { FieldMetadataType } from 'twenty-shared';
import { sleep } from '~/utils/sleep';
import { FieldMetadataType } from 'twenty-shared/types';
const fields = [
{

View File

@ -3,9 +3,8 @@ import { IconForbid } from 'twenty-ui';
import { MatchColumnSelect } from '@/spreadsheet-import/components/MatchColumnSelect';
import { useSpreadsheetImportInternal } from '@/spreadsheet-import/hooks/useSpreadsheetImportInternal';
import { FieldMetadataType } from 'twenty-shared';
import { Columns, ColumnType } from '../MatchColumnsStep';
import { FieldMetadataType } from 'twenty-shared/types';
const StyledContainer = styled.div`
display: flex;

View File

@ -5,8 +5,8 @@ import { Column } from '@/spreadsheet-import/steps/components/MatchColumnsStep/M
import { Fields } from '@/spreadsheet-import/types';
import styled from '@emotion/styled';
import { useState } from 'react';
import { isDefined } from 'twenty-shared';
import { AnimatedExpandableContainer } from 'twenty-ui';
import { isDefined } from 'twenty-shared/utils';
const getExpandableContainerTitle = <T extends string>(
fields: Fields<T>,

View File

@ -1,9 +1,9 @@
import styled from '@emotion/styled';
import { ImportedRow } from '@/spreadsheet-import/types';
import { isDefined } from 'twenty-shared';
import { Column } from '../MatchColumnsStep';
import { isDefined } from 'twenty-shared/utils';
const StyledContainer = styled.div`
display: flex;

View File

@ -25,10 +25,10 @@ import {
} from 'react';
// @ts-expect-error Todo: remove usage of react-data-grid`
import { RowsChangeData } from 'react-data-grid';
import { isDefined } from 'twenty-shared';
import { Button, IconTrash, Toggle } from 'twenty-ui';
import { generateColumns } from './components/columns';
import { ImportedStructuredRowMetadata } from './types';
import { isDefined } from 'twenty-shared/utils';
const StyledContent = styled(Modal.Content)`
padding-left: ${({ theme }) => theme.spacing(6)};

View File

@ -7,9 +7,9 @@ import { AppTooltip, Checkbox, CheckboxVariant, Toggle } from 'twenty-ui';
import { MatchColumnSelect } from '@/spreadsheet-import/components/MatchColumnSelect';
import { Fields, ImportedStructuredRow } from '@/spreadsheet-import/types';
import { TextInput } from '@/ui/input/components/TextInput';
import { isDefined } from 'twenty-shared';
import { ImportedStructuredRowMetadata } from '../types';
import { isDefined } from 'twenty-shared/utils';
const StyledHeaderContainer = styled.div`
align-items: center;

View File

@ -4,7 +4,7 @@ import { ReadonlyDeep } from 'type-fest';
import { Columns } from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { ImportedStructuredRowMetadata } from '@/spreadsheet-import/steps/components/ValidationStep/types';
import { SpreadsheetImportStep } from '@/spreadsheet-import/steps/types/SpreadsheetImportStep';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
export type SpreadsheetImportDialogOptions<FieldNames extends string> = {
// Is modal visible.

View File

@ -6,7 +6,7 @@ import {
TableHook,
} from '@/spreadsheet-import/types';
import { addErrorsAndRunHooks } from '@/spreadsheet-import/utils/dataMutations';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('addErrorsAndRunHooks', () => {
type FullData = ImportedStructuredRow<'name' | 'age' | 'country'>;

View File

@ -1,6 +1,7 @@
import { Field } from '@/spreadsheet-import/types';
import { findMatch } from '@/spreadsheet-import/utils/findMatch';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('findMatch', () => {
const defaultField: Field<'defaultField'> = {
key: 'defaultField',

View File

@ -4,7 +4,7 @@ import {
} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { Field, FieldValidationDefinition } from '@/spreadsheet-import/types';
import { findUnmatchedRequiredFields } from '@/spreadsheet-import/utils/findUnmatchedRequiredFields';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
const nameField: Field<'Name'> = {
key: 'Name',

View File

@ -1,6 +1,6 @@
import { Field } from '@/spreadsheet-import/types';
import { generateExampleRow } from '@/spreadsheet-import/utils/generateExampleRow';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('generateExampleRow', () => {
const defaultField: Field<'defaultField'> = {

View File

@ -1,6 +1,6 @@
import { Field } from '@/spreadsheet-import/types';
import { getFieldOptions } from '@/spreadsheet-import/utils/getFieldOptions';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('getFieldOptions', () => {
const optionsArray = [

View File

@ -4,7 +4,7 @@ import {
} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { Field } from '@/spreadsheet-import/types';
import { getMatchedColumns } from '@/spreadsheet-import/utils/getMatchedColumns';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('getMatchedColumns', () => {
const columns: Column<string>[] = [

View File

@ -4,7 +4,7 @@ import {
} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { Field } from '@/spreadsheet-import/types';
import { normalizeTableData } from '@/spreadsheet-import/utils/normalizeTableData';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('normalizeTableData', () => {
const columns: Column<string>[] = [

View File

@ -4,7 +4,7 @@ import {
} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { Field } from '@/spreadsheet-import/types';
import { setColumn } from '@/spreadsheet-import/utils/setColumn';
import { FieldMetadataType } from 'twenty-shared';
import { FieldMetadataType } from 'twenty-shared/types';
describe('setColumn', () => {
const defaultField: Field<'Name'> = {

View File

@ -12,8 +12,8 @@ import {
RowHook,
TableHook,
} from '@/spreadsheet-import/types';
import { isDefined } from 'twenty-shared';
import { isUndefinedOrNull } from '~/utils/isUndefinedOrNull';
import { isDefined } from 'twenty-shared/utils';
export const addErrorsAndRunHooks = <T extends string>(
data: (ImportedStructuredRow<T> & Partial<ImportedStructuredRowMetadata>)[],

View File

@ -6,10 +6,10 @@ import {
MatchColumnsStepProps,
} from '@/spreadsheet-import/steps/components/MatchColumnsStep/MatchColumnsStep';
import { Field, Fields } from '@/spreadsheet-import/types';
import { isDefined } from 'twenty-shared';
import { findMatch } from './findMatch';
import { setColumn } from './setColumn';
import { isDefined } from 'twenty-shared/utils';
export const getMatchedColumns = <T extends string>(
columns: Columns<T>,

View File

@ -7,10 +7,9 @@ import {
ImportedRow,
ImportedStructuredRow,
} from '@/spreadsheet-import/types';
import { isDefined } from 'twenty-shared';
import { z } from 'zod';
import { normalizeCheckboxValue } from './normalizeCheckboxValue';
import { isDefined } from 'twenty-shared/utils';
export const normalizeTableData = <T extends string>(
columns: Columns<T>,