[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
@ -1,3 +1,12 @@
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './FieldForTotalCountAggregateOperation';
|
||||
export * from './PermissionsOnAllObjectRecords';
|
||||
export * from './StandardObjectRecordsUnderObjectRecordsPermissions';
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
export * from './constants/AppLocales';
|
||||
export * from './constants/SourceLocale';
|
||||
@ -1,6 +1,10 @@
|
||||
export * from './constants';
|
||||
export * from './i18n';
|
||||
export * from './testing';
|
||||
export * from './types';
|
||||
export * from './utils';
|
||||
export * from './workspace';
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-genreated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edition to this will be override
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export default {};
|
||||
|
||||
@ -1 +1,10 @@
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './types/EachTestingContext.type';
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { SOURCE_LOCALE } from 'src/i18n/constants/SourceLocale';
|
||||
import { SOURCE_LOCALE } from '@/translations/constants/SourceLocale';
|
||||
|
||||
export const APP_LOCALES = {
|
||||
[SOURCE_LOCALE]: SOURCE_LOCALE,
|
||||
11
packages/twenty-shared/src/translations/index.ts
Normal file
11
packages/twenty-shared/src/translations/index.ts
Normal file
@ -0,0 +1,11 @@
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './constants/AppLocales';
|
||||
export * from './constants/SourceLocale';
|
||||
@ -1,3 +1,12 @@
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './ConnectedAccountProvider';
|
||||
export * from './FieldMetadataType';
|
||||
export * from './IsExactly';
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { FieldMetadataType } from 'src/types/FieldMetadataType';
|
||||
import { FieldMetadataType } from '@/types';
|
||||
|
||||
export const isFieldMetadataDateKind = (
|
||||
fieldMetadataType?: FieldMetadataType,
|
||||
|
||||
@ -1,5 +1,4 @@
|
||||
import { getImageAbsoluteURI } from '../getImageAbsoluteURI';
|
||||
|
||||
import { getImageAbsoluteURI } from '@/utils/image/getImageAbsoluteURI';
|
||||
describe('getImageAbsoluteURI', () => {
|
||||
it('should return baseUrl if imageUrl is empty string', () => {
|
||||
const imageUrl = '';
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
import {
|
||||
getLogoUrlFromDomainName,
|
||||
sanitizeURL,
|
||||
} from '../getLogoUrlFromDomainName';
|
||||
} from '@/utils/image/getLogoUrlFromDomainName';
|
||||
|
||||
describe('sanitizeURL', () => {
|
||||
test('should sanitize the URL correctly', () => {
|
||||
|
||||
@ -1,6 +1,22 @@
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './assertUnreachable';
|
||||
export * from './fieldMetadata';
|
||||
export * from './image';
|
||||
export * from './strings';
|
||||
export * from './url';
|
||||
export * from './validation';
|
||||
export * from './fieldMetadata/isFieldMetadataDateKind';
|
||||
export * from './image/getImageAbsoluteURI';
|
||||
export * from './image/getLogoUrlFromDomainName';
|
||||
export * from './strings/capitalize';
|
||||
export * from './url/absoluteUrlSchema';
|
||||
export * from './url/getAbsoluteUrlOrThrow';
|
||||
export * from './url/getUrlHostnameOrThrow';
|
||||
export * from './url/isValidHostname';
|
||||
export * from './url/isValidUrl';
|
||||
export * from './validation/isDefined';
|
||||
export * from './validation/isValidLocale';
|
||||
export * from './validation/isValidUuid';
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { capitalize } from '../capitalize';
|
||||
import { capitalize } from '@/utils/strings/capitalize';
|
||||
describe('capitalize', () => {
|
||||
it('should capitalize a string', () => {
|
||||
expect(capitalize('test')).toBe('Test');
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { absoluteUrlSchema } from '../absoluteUrlSchema';
|
||||
import { absoluteUrlSchema } from '@/utils/url/absoluteUrlSchema';
|
||||
|
||||
describe('absoluteUrlSchema', () => {
|
||||
it('validates an absolute url', () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { getAbsoluteUrlOrThrow } from 'src/utils/url/getAbsoluteUrlOrThrow';
|
||||
import { getAbsoluteUrlOrThrow } from '@/utils/url/getAbsoluteUrlOrThrow';
|
||||
|
||||
describe('getAbsoluteUrlOrThrow', () => {
|
||||
it("returns the URL's hostname", () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { getUrlHostnameOrThrow } from 'src/utils/url/getUrlHostnameOrThrow';
|
||||
import { getUrlHostnameOrThrow } from '@/utils/url/getUrlHostnameOrThrow';
|
||||
|
||||
describe('getUrlHostnameOrThrow', () => {
|
||||
it("returns the URL's hostname", () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { isValidHostname } from 'src/utils/url/isValidHostname';
|
||||
import { isValidHostname } from '@/utils/url/isValidHostname';
|
||||
|
||||
describe('isValidHostname', () => {
|
||||
it(`should return true if string google`, () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { isValidUrl } from '../isValidUrl';
|
||||
import { isValidUrl } from '@/utils/url/isValidUrl';
|
||||
|
||||
describe('isValidUrl', () => {
|
||||
it('test cases', () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { isValidHostname } from 'src/utils/url/isValidHostname';
|
||||
import { isValidHostname } from '@/utils/url/isValidHostname';
|
||||
import { z } from 'zod';
|
||||
|
||||
const getAbsoluteUrl = (value: string): string => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { absoluteUrlSchema } from 'src/utils/url/absoluteUrlSchema';
|
||||
import { absoluteUrlSchema } from '@/utils/url/absoluteUrlSchema';
|
||||
|
||||
export const getAbsoluteUrlOrThrow = (url: string): string => {
|
||||
try {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { absoluteUrlSchema } from 'src/utils/url/absoluteUrlSchema';
|
||||
import { absoluteUrlSchema } from '@/utils/url/absoluteUrlSchema';
|
||||
|
||||
export const getUrlHostnameOrThrow = (url: string): string => {
|
||||
const result = absoluteUrlSchema.safeParse(url);
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { absoluteUrlSchema } from 'src/utils/url/absoluteUrlSchema';
|
||||
import { absoluteUrlSchema } from '@/utils/url/absoluteUrlSchema';
|
||||
|
||||
export const isValidUrl = (url: string): boolean => {
|
||||
const result = absoluteUrlSchema.safeParse(url);
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { isDefined } from '../isDefined';
|
||||
import { isDefined } from '@/utils/validation/isDefined';
|
||||
describe('isDefined', () => {
|
||||
it('returns true if value is not undefined nor null', () => {
|
||||
expect(isDefined('')).toBe(true);
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { isValidUuid } from '../isValidUuid';
|
||||
import { isValidUuid } from '@/utils/validation/isValidUuid';
|
||||
|
||||
describe('isValidUuid', () => {
|
||||
it('should return true for a valid UUID', () => {
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
import { APP_LOCALES } from 'src/i18n/constants/AppLocales';
|
||||
import { isValidLocale } from '../isValidLocale';
|
||||
|
||||
import { APP_LOCALES } from '@/translations';
|
||||
import { isValidLocale } from '@/utils/validation/isValidLocale';
|
||||
describe('isValidLocale', () => {
|
||||
it('should return true for valid locales', () => {
|
||||
Object.keys(APP_LOCALES).forEach((locale) => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { APP_LOCALES } from 'src/i18n/constants/AppLocales';
|
||||
import { APP_LOCALES } from '@/translations';
|
||||
|
||||
export const isValidLocale = (
|
||||
value: string | null,
|
||||
|
||||
@ -1,2 +1,11 @@
|
||||
export * from './types';
|
||||
export * from './utils';
|
||||
/*
|
||||
* _____ _
|
||||
*|_ _|_ _____ _ __ | |_ _ _
|
||||
* | | \ \ /\ / / _ \ '_ \| __| | | | Auto-generated file
|
||||
* | | \ V V / __/ | | | |_| |_| | Any edits to this will be overridden
|
||||
* |_| \_/\_/ \___|_| |_|\__|\__, |
|
||||
* |___/
|
||||
*/
|
||||
|
||||
export * from './types/WorkspaceActivationStatus';
|
||||
export * from './utils/isWorkspaceActiveOrSuspended';
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import { WorkspaceActivationStatus } from '../../types/WorkspaceActivationStatus';
|
||||
import { isWorkspaceActiveOrSuspended } from '../isWorkspaceActiveOrSuspended';
|
||||
import { WorkspaceActivationStatus } from '@/workspace/types/WorkspaceActivationStatus';
|
||||
import { isWorkspaceActiveOrSuspended } from '@/workspace/utils/isWorkspaceActiveOrSuspended';
|
||||
|
||||
describe('isWorkspaceActiveOrSuspended', () => {
|
||||
it('should return true for Active workspace', () => {
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import { WorkspaceActivationStatus } from '../types/WorkspaceActivationStatus';
|
||||
import { WorkspaceActivationStatus } from '@/workspace/types/WorkspaceActivationStatus';
|
||||
|
||||
export const isWorkspaceActiveOrSuspended = (
|
||||
workspace?: {
|
||||
|
||||
Reference in New Issue
Block a user