Followup https://github.com/twentyhq/twenty/pull/19010 ## Dependency diagram ``` ┌─────────────────────┐ │ twenty-front │ │ (React frontend) │ └─────────┬───────────┘ │ imports runtime: │ FrontComponentRenderer │ FrontComponentRendererWithSdkClient │ useFrontComponentExecutionContext ▼ ┌──────────────────────────────────┐ ┌─────────────────────────┐ │ twenty-front-component-renderer │────────▶│ twenty-sdk │ │ (remote-dom host + worker) │ │ (app developer SDK) │ │ │ │ │ │ imports from twenty-sdk: │ │ Public API: │ │ • types only: │ │ defineFrontComponent │ │ FrontComponentExecutionContext│ │ navigate, closeSide… │ │ NavigateFunction │ │ useFrontComponent… │ │ CloseSidePanelFunction │ │ Command components │ │ CommandConfirmation… │ │ conditional avail. │ │ OpenCommandConfirmation… │ │ │ │ EnqueueSnackbarFunction │ │ Internal only: │ │ etc. │ │ frontComponentHost… │ │ │ │ front-component-build │ │ owns locally: │ │ esbuild plugins │ │ • ALLOWED_HTML_ELEMENTS │ │ │ │ • EVENT_TO_REACT │ └────────────┬────────────┘ │ • HTML_TAG_TO_CUSTOM_ELEMENT… │ │ │ • SerializedEventData │ │ types │ • PropertySchema │ ▼ │ • frontComponentHostComm… │ ┌─────────────────────────┐ │ (local ref to globalThis) │ │ twenty-shared │ │ • setFrontComponentExecution… │ │ (common types/utils) │ │ (local impl, same keys) │ │ AppPath, SidePanelP… │ │ │ │ EnqueueSnackbarParams │ └──────────────────────────────────┘ │ isDefined, … │ │ └─────────────────────────┘ │ also depends on ▼ twenty-shared (types) @remote-dom/* (runtime) @quilted/threads (runtime) react (runtime) ``` **Key points:** - **`twenty-front`** depends on the renderer, **not** on `twenty-sdk` directly (for rendering) - **`twenty-front-component-renderer`** depends on `twenty-sdk` for **types only** (function signatures, `FrontComponentExecutionContext`). The runtime bridge (`frontComponentHostCommunicationApi`) is shared via `globalThis` keys, not module imports - **`twenty-sdk`** has no dependency on the renderer — clean one-way dependency - The renderer owns all remote-dom infrastructure (element schemas, event mappings, custom element tags) that was previously leaking through the SDK's public API - The SDK's `./build` entry point was removed entirely (unused)
173 lines
4.6 KiB
TypeScript
173 lines
4.6 KiB
TypeScript
import * as esbuild from 'esbuild';
|
|
import * as fs from 'node:fs';
|
|
import * as path from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
import { getFrontComponentBuildPlugins } from 'twenty-sdk/front-component-renderer/build';
|
|
|
|
const dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
const exampleSourcesDir = path.resolve(
|
|
dirname,
|
|
'../../src/__stories__/example-sources',
|
|
);
|
|
const exampleSourcesBuiltDir = path.resolve(
|
|
dirname,
|
|
'../../src/__stories__/example-sources-built',
|
|
);
|
|
const exampleSourcesBuiltPreactDir = path.resolve(
|
|
dirname,
|
|
'../../src/__stories__/example-sources-built-preact',
|
|
);
|
|
|
|
const rootNodeModules = path.resolve(dirname, '../../../../node_modules');
|
|
|
|
const twentyUiIndividualIndex = path.resolve(
|
|
dirname,
|
|
'../../../twenty-ui/dist/individual/individual-entry.js',
|
|
);
|
|
|
|
const sdkIndividualIndex = path.resolve(
|
|
dirname,
|
|
'../../../twenty-sdk/dist/sdk/index.js',
|
|
);
|
|
|
|
const twentySharedIndividualDir = path.resolve(
|
|
dirname,
|
|
'../../../twenty-shared/dist/individual',
|
|
);
|
|
|
|
const TWENTY_SHARED_SUBMODULES = [
|
|
'ai',
|
|
'application',
|
|
'constants',
|
|
'database-events',
|
|
'metadata',
|
|
'testing',
|
|
'translations',
|
|
'types',
|
|
'utils',
|
|
'workflow',
|
|
'workspace',
|
|
];
|
|
|
|
const twentySharedAliases = Object.fromEntries(
|
|
TWENTY_SHARED_SUBMODULES.map((submodule) => [
|
|
`twenty-shared/${submodule}`,
|
|
path.join(twentySharedIndividualDir, submodule, 'index.js'),
|
|
]),
|
|
);
|
|
|
|
const storyAlias = {
|
|
react: path.join(rootNodeModules, 'react'),
|
|
'react-dom': path.join(rootNodeModules, 'react-dom'),
|
|
'@/sdk': sdkIndividualIndex,
|
|
'twenty-sdk/ui': twentyUiIndividualIndex,
|
|
...twentySharedAliases,
|
|
};
|
|
|
|
const STORY_COMPONENTS = [
|
|
'static.front-component',
|
|
'interactive.front-component',
|
|
'lifecycle.front-component',
|
|
'chakra-example.front-component',
|
|
'tailwind-example.front-component',
|
|
'emotion-example.front-component',
|
|
'styled-components-example.front-component',
|
|
'shadcn-example.front-component',
|
|
'mui-example.front-component',
|
|
'twenty-ui-example.front-component',
|
|
'sdk-context-example.front-component',
|
|
];
|
|
|
|
const resolveEntryPoints = (): Record<string, string> => {
|
|
const entryPoints: Record<string, string> = {};
|
|
|
|
for (const name of STORY_COMPONENTS) {
|
|
const filePath = path.join(exampleSourcesDir, `${name}.tsx`);
|
|
|
|
if (!fs.existsSync(filePath)) {
|
|
throw new Error(
|
|
`Story component source file not found: ${filePath}\n` +
|
|
`Ensure the file exists in ${exampleSourcesDir} and the name in STORY_COMPONENTS is correct.`,
|
|
);
|
|
}
|
|
|
|
entryPoints[name] = filePath;
|
|
}
|
|
|
|
return entryPoints;
|
|
};
|
|
|
|
type BundleSizeEntry = {
|
|
name: string;
|
|
reactBytes: number;
|
|
preactBytes: number;
|
|
};
|
|
|
|
const collectBundleSizes = (): BundleSizeEntry[] =>
|
|
STORY_COMPONENTS.map((name) => {
|
|
const reactFile = path.join(exampleSourcesBuiltDir, `${name}.mjs`);
|
|
const preactFile = path.join(exampleSourcesBuiltPreactDir, `${name}.mjs`);
|
|
|
|
return {
|
|
name,
|
|
reactBytes: fs.existsSync(reactFile) ? fs.statSync(reactFile).size : 0,
|
|
preactBytes: fs.existsSync(preactFile) ? fs.statSync(preactFile).size : 0,
|
|
};
|
|
});
|
|
|
|
const buildSourceExamples = async (): Promise<void> => {
|
|
const entryPoints = resolveEntryPoints();
|
|
const tsconfigPath = path.join(dirname, '../../tsconfig.json');
|
|
|
|
const commonOptions: esbuild.BuildOptions = {
|
|
entryPoints,
|
|
bundle: true,
|
|
splitting: false,
|
|
format: 'esm',
|
|
outExtension: { '.js': '.mjs' },
|
|
tsconfig: tsconfigPath,
|
|
jsx: 'automatic',
|
|
sourcemap: true,
|
|
metafile: true,
|
|
logLevel: 'silent',
|
|
minify: true,
|
|
alias: storyAlias,
|
|
};
|
|
|
|
fs.mkdirSync(exampleSourcesBuiltDir, { recursive: true });
|
|
|
|
await esbuild.build({
|
|
...commonOptions,
|
|
outdir: exampleSourcesBuiltDir,
|
|
plugins: getFrontComponentBuildPlugins(),
|
|
});
|
|
|
|
console.log(
|
|
`Built ${STORY_COMPONENTS.length} React story components to ${exampleSourcesBuiltDir}`,
|
|
);
|
|
|
|
fs.mkdirSync(exampleSourcesBuiltPreactDir, { recursive: true });
|
|
|
|
await esbuild.build({
|
|
...commonOptions,
|
|
outdir: exampleSourcesBuiltPreactDir,
|
|
plugins: getFrontComponentBuildPlugins({ usePreact: true }),
|
|
});
|
|
|
|
console.log(
|
|
`Built ${STORY_COMPONENTS.length} Preact story components to ${exampleSourcesBuiltPreactDir}`,
|
|
);
|
|
|
|
const sizes = collectBundleSizes();
|
|
const manifestPath = path.join(exampleSourcesBuiltDir, 'bundle-sizes.json');
|
|
|
|
fs.writeFileSync(manifestPath, JSON.stringify(sizes, null, 2));
|
|
console.log(`Wrote bundle size manifest to ${manifestPath}`);
|
|
};
|
|
|
|
buildSourceExamples().catch((error) => {
|
|
console.error('Failed to build mock components:', error);
|
|
process.exit(1);
|
|
});
|