[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

@ -1,5 +1,5 @@
import { EachTestingContext } from 'twenty-shared';
import { buildRecordFromKeysWithSameValue } from '~/utils/array/buildRecordFromKeysWithSameValue';
import { EachTestingContext } from 'twenty-shared/testing';
type BuildRecordFromKeysWithSameValueTestContext = EachTestingContext<{
array: string[];

View File

@ -1,6 +1,6 @@
import { isFunction } from '@sniptt/guards';
import { MutableRefObject, Ref } from 'react';
import { isDefined } from 'twenty-shared';
import { isDefined } from 'twenty-shared/utils';
export const combineRefs = <T>(...refs: (Ref<T> | undefined)[]) => {
return (node: T) => {

View File

@ -1,5 +1,5 @@
import { isDefined } from 'twenty-shared';
import { Nullable } from 'twenty-ui';
import { isDefined } from 'twenty-shared/utils';
// TODO: we should create a custom eslint rule that enforces the use of this function
// instead of using the `===` operator where a and b are | undefined | null

View File

@ -4,9 +4,8 @@ import { differenceInCalendarDays, formatDistanceToNow } from 'date-fns';
import { DateTime } from 'luxon';
import moize from 'moize';
import { isDefined } from 'twenty-shared';
import { logError } from './logError';
import { isDefined } from 'twenty-shared/utils';
export const DEFAULT_DATE_LOCALE = 'en-EN';

View File

@ -1,5 +1,5 @@
import { isDefined } from 'twenty-shared';
import { LinkType } from 'twenty-ui';
import { isDefined } from 'twenty-shared/utils';
type getUrlDisplayValueByUrlTypeProps = {
type: LinkType;

View File

@ -1,5 +1,5 @@
import { i18n } from '@lingui/core';
import { APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared';
import { APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
export const dynamicActivate = async (locale: keyof typeof APP_LOCALES) => {
if (!Object.values(APP_LOCALES).includes(locale)) {

View File

@ -1,11 +1,7 @@
import { fromNavigator, fromStorage, fromUrl } from '@lingui/detect-locale';
import {
APP_LOCALES,
isDefined,
isValidLocale,
SOURCE_LOCALE,
} from 'twenty-shared';
import { dynamicActivate } from '~/utils/i18n/dynamicActivate';
import { APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
import { isDefined, isValidLocale } from 'twenty-shared/utils';
export const initialI18nActivate = () => {
const urlLocale = fromUrl('locale');

View File

@ -1,7 +1,7 @@
import { AppPath } from '@/types/AppPath';
import qs from 'qs';
import { generatePath, PathParam } from 'react-router-dom';
import { isDefined } from 'twenty-shared';
import { isDefined } from 'twenty-shared/utils';
export const getAppPath = <T extends AppPath>(
to: T,

View File

@ -2,7 +2,7 @@ import { AppPath } from '@/types/AppPath';
import { SettingsPath } from '@/types/SettingsPath';
import qs from 'qs';
import { generatePath, PathParam } from 'react-router-dom';
import { isDefined } from 'twenty-shared';
import { isDefined } from 'twenty-shared/utils';
export const getSettingsPath = <T extends SettingsPath>(
to: T,

View File

@ -1,5 +1,4 @@
import { isDefined } from 'twenty-shared';
import { isDefined } from 'twenty-shared/utils';
export const parseJson = <T>(json: string | undefined | null) => {
if (!isDefined(json)) {
return null;

View File

@ -1,9 +1,8 @@
import omit from 'lodash.omit';
import { AtomEffect } from 'recoil';
import { z } from 'zod';
import { isDefined } from 'twenty-shared';
import { cookieStorage } from '~/utils/cookie-storage';
import { isDefined } from 'twenty-shared/utils';
export const localStorageEffect =
<T>(key?: string): AtomEffect<T> =>

View File

@ -1,5 +1,4 @@
import camelCase from 'lodash.camelcase';
import { capitalize } from 'twenty-shared';
import { capitalize } from 'twenty-shared/utils';
export const pascalCase = (str: string) => capitalize(camelCase(str));