@servicetitan/startup 36.3.1 → 36.4.0

package/src/core/index.ts

@@ -0,0 +1,16 @@
+export * from './check-resource';
+export * from './constants';
+export * from './create-build-context';
+export * from './defines';
+export * from './externals';
+export * from './get-build-name';
+export * from './get-bundle-type';
+export * from './get-cdn-path';
+export * from './get-exposed-dependencies';
+export * from './get-output-path';
+export * from './get-shared-entry-points';
+export * from './get-version';
+export * from './metadata';
+export * from './stringify-config';
+export type * from './types';
+export * from './virtual-modules';

package/src/{webpack/configs/utils → core/metadata}/__tests__/build-metadata.test.ts

@@ -1,13 +1,17 @@
 import { fs, vol } from 'memfs';
-import { getStartupVersion } from '../../../../utils/get-startup-version';
+import {
+    getLaunchDarklySdkVersion,
+    getStartupVersion,
+    getWebComponentsVersion,
+} from '../../get-version';
 import { buildMetadata, BuildMetadataParams } from '../build-metadata';
-import { getLaunchDarklySdkVersion } from '../get-launchdarkly-sdk-version';
-import { getWebComponentsVersion } from '../get-web-components-version';
 
 jest.mock('fs', () => fs);
-jest.mock('../../../../utils/get-startup-version');
-jest.mock('../get-launchdarkly-sdk-version');
-jest.mock('../get-web-components-version');
+jest.mock('../../get-version', () => ({
+    getLaunchDarklySdkVersion: jest.fn(),
+    getStartupVersion: jest.fn(),
+    getWebComponentsVersion: jest.fn(),
+}));
 
 describe(`[startup] ${buildMetadata.name}`, () => {
     const destination = 'dist';

package/src/{webpack/configs/utils → core/metadata}/__tests__/generate-metadata.test.ts

@@ -1,8 +1,8 @@
 import { fs, vol } from 'memfs';
 
 import * as mockedFs from 'fs';
-import { createPackage } from '../../../../__mocks__';
-import { Context } from '../../types';
+import { createPackage } from '../../../__mocks__';
+import { BuildContext } from '../../types';
 import { buildMetadata } from '../build-metadata';
 import { generateMetadata } from '../generate-metadata';
 
@@ -16,7 +16,7 @@ function generatedMetadata(dest: string) {
 describe(`[startup] ${generateMetadata.name}`, () => {
     const pkg = createPackage({});
     const destination = 'dist';
-    let context: Partial<Context>;
+    let context: BuildContext;
 
     const mockMetadata = {
         name: pkg.name,
@@ -36,16 +36,28 @@ describe(`[startup] ${generateMetadata.name}`, () => {
         jest.mocked(buildMetadata).mockReturnValue(mockMetadata);
 
         context = {
-            destination,
-            name: pkg.name,
-            packageData: { name: pkg.name, version: pkg.version, dependencies: { foo: '1.0.1' } },
-            sharedDependencies: { react: 'SharedDependencies.React' },
+            build: {
+                name: pkg.name,
+                isProduction: false,
+            },
+            package: {
+                name: pkg.name,
+                version: pkg.version,
+                destination,
+                source: 'src',
+                dependencies: { foo: '1.0.1' },
+                sharedDependencies: { react: 'SharedDependencies.React' },
+                isWebComponent: false,
+                isLegacyRoot: false,
+                isExposeSharedDependencies: false,
+            },
+            options: {},
         };
     });
 
     afterEach(() => vol.reset());
 
-    const subject = () => generateMetadata(context as any);
+    const subject = () => generateMetadata(context);
 
     function itWritesMetadataToDestination(destination: string) {
         test('writes metadata to output file', () => {
@@ -60,10 +72,10 @@ describe(`[startup] ${generateMetadata.name}`, () => {
 
         expect(buildMetadata).toHaveBeenCalledWith({
             destination,
-            name: context.name,
-            version: context.packageData!.version,
-            dependencies: context.packageData!.dependencies,
-            sharedDependencies: context.sharedDependencies,
+            name: context.build.name,
+            version: context.package.version,
+            dependencies: context.package.dependencies,
+            sharedDependencies: context.package.sharedDependencies,
         });
     });
 
@@ -72,7 +84,7 @@ describe(`[startup] ${generateMetadata.name}`, () => {
     describe('when destination directory does not exist', () => {
         const nestedDestination = 'nested/path/dist';
 
-        beforeEach(() => (context.destination = nestedDestination));
+        beforeEach(() => (context.package.destination = nestedDestination));
 
         test('creates destination directory', () => {
             subject();

package/src/{webpack/configs/utils → core/metadata}/build-metadata.ts

@@ -1,9 +1,12 @@
 import type { PackageManager } from '@servicetitan/install';
 import path from 'path';
-import { getStartupVersion, readJsonSafe } from '../../../utils';
+import { readJsonSafe } from '../../utils';
+import {
+    getLaunchDarklySdkVersion,
+    getStartupVersion,
+    getWebComponentsVersion,
+} from '../get-version';
 import { EntryPoints, Metadata } from '../types';
-import { getLaunchDarklySdkVersion } from './get-launchdarkly-sdk-version';
-import { getWebComponentsVersion } from './get-web-components-version';
 
 export interface BuildMetadataParams {
     destination: string;

package/src/core/metadata/generate-exposed-dependencies-metadata.ts

@@ -0,0 +1,20 @@
+import fs from 'fs';
+import path from 'path';
+import { ExposedDepsMetadata } from '../get-shared-entry-points';
+
+export function getExposedDependenciesMetadataPath(destination: string) {
+    return path.join(destination, 'exposed-dependencies-metadata.json');
+}
+
+export function generateExposedDependenciesMetadata(
+    destination: string,
+    getOutputPath: () => string
+) {
+    if (!fs.existsSync(destination)) {
+        fs.mkdirSync(destination, { recursive: true });
+    }
+
+    const metadataPath = getExposedDependenciesMetadataPath(destination);
+    const metadata: ExposedDepsMetadata = { entryPointsPath: getOutputPath() };
+    fs.writeFileSync(metadataPath, JSON.stringify(metadata, null, 2), 'utf-8');
+}

package/src/{webpack/configs/utils → core/metadata}/generate-metadata.ts

@@ -1,11 +1,13 @@
 import fs from 'fs';
 import path from 'path';
-import { log } from '../../../utils';
-import { Context } from '../types';
+import { log } from '../../utils';
+import { BuildContext } from '../types';
 import { buildMetadata } from './build-metadata';
 
-export function generateMetadata(context: Context) {
-    const { destination, name, packageData, packageManager, sharedDependencies } = context;
+export function generateMetadata(context: BuildContext) {
+    const { destination, sharedDependencies, version, dependencies, packageManager } =
+        context.package;
+    const { name } = context.build;
 
     if (!fs.existsSync(destination)) {
         fs.mkdirSync(destination, { recursive: true });
@@ -14,8 +16,8 @@ export function generateMetadata(context: Context) {
     const metadata = buildMetadata({
         destination,
         name,
-        version: packageData.version,
-        dependencies: packageData.dependencies,
+        version,
+        dependencies,
         sharedDependencies,
         packageManager,
     });

package/src/core/metadata/index.ts

@@ -0,0 +1,3 @@
+export * from './build-metadata';
+export * from './generate-exposed-dependencies-metadata';
+export * from './generate-metadata';

package/src/core/types.ts

@@ -0,0 +1,54 @@
+import { getPackageManager } from '@servicetitan/install';
+
+export type BuildContext<T = unknown> = {
+    package: PackageContext;
+    build: BuildIdentity;
+    options: BuildOptions;
+} & (unknown extends T ? {} : { bundlerConfig: T });
+
+export interface PackageContext {
+    name: string;
+    version: string;
+    destination: string;
+    source: string;
+    dependencies: Record<string, string>;
+    sharedDependencies: Record<string, string>;
+    isWebComponent: boolean;
+    isLegacyRoot: boolean;
+    isExposeSharedDependencies: boolean;
+    packageManager: ReturnType<typeof getPackageManager>;
+}
+
+export interface BuildIdentity {
+    name: string;
+    isProduction: boolean;
+    light?: boolean;
+    headless?: boolean;
+    emitExposedDependencies?: boolean;
+    outputBasePath?: string;
+}
+
+export interface BuildOptions {
+    codeCoverage?: boolean;
+    buildStat?: boolean;
+}
+
+export interface EntryPoint {
+    css?: string[];
+    js?: string[];
+}
+
+export interface EntryPoints {
+    full?: EntryPoint;
+    light?: EntryPoint;
+    headless?: EntryPoint;
+}
+
+export interface Metadata {
+    name: string;
+    version: string;
+    bundledWith: Record<string, string | undefined>;
+    sharedDependencies: Record<string, string>;
+    dependencies: Record<string, string>;
+    entrypoints: EntryPoints;
+}

package/src/core/virtual-modules.ts

@@ -0,0 +1,74 @@
+import fs from 'fs';
+import path from 'path';
+import { BuildContext } from './types';
+
+export function virtualModules(context: BuildContext) {
+    const modules: { index?: string; designSystem?: string } = {};
+
+    if (context.package.isWebComponent) {
+        modules.index = indexCode(context);
+    }
+
+    if (needsToIncludeDesignSystem(context)) {
+        const designSystemPath = getDesignSystemPath(context);
+        if (!fs.existsSync(designSystemPath)) {
+            modules.designSystem = designSystemCode();
+        }
+    }
+
+    return modules;
+}
+
+export function getDesignSystemPath(context: BuildContext) {
+    return path.join(process.cwd(), context.package.destination, 'design-system.css');
+}
+
+function designSystemCode() {
+    return [
+        `@import '@servicetitan/tokens/core/tokens.css';`,
+        `@import '@servicetitan/anvil-fonts/dist/css/anvil-fonts.css';`,
+        `@import '@servicetitan/design-system/dist/system.min.css';`,
+    ].join('\n');
+}
+
+function indexCode(context: BuildContext) {
+    const { light = false, headless } = context.build;
+    const { isLegacyRoot, sharedDependencies } = context.package;
+    if (headless) {
+        return headlessIndex();
+    }
+
+    const options = `{ legacyRoot: ${isLegacyRoot}, sharedDependenciesNames: ${JSON.stringify(
+        Object.keys(sharedDependencies)
+    )} }`;
+
+    return [
+        ...(needsToIncludeDesignSystem(context) ? [`import './design-system.css';`] : []),
+        `import { register } from '@servicetitan/web-components';`,
+        `import { App } from './app';`,
+        `register(App, ${light}, ${options});`,
+    ].join('\n');
+}
+
+export function needsToIncludeDesignSystem(context: BuildContext) {
+    const { light, headless, emitExposedDependencies } = context.build;
+    const { isWebComponent, dependencies, sharedDependencies } = context.package;
+
+    return (
+        (!!emitExposedDependencies && !!sharedDependencies['@servicetitan/design-system']) ||
+        (isWebComponent &&
+            !headless &&
+            // Depends on design system
+            !!dependencies['@servicetitan/design-system'] &&
+            // ... and is not light bundle with private copy of design system
+            !(light && !!sharedDependencies['@servicetitan/design-system']))
+    );
+}
+
+function headlessIndex() {
+    return [
+        "import { registerHeadless } from '@servicetitan/web-components/register-headless';",
+        "import { connectedCallback, disconnectedCallback } from './headless';",
+        'registerHeadless(connectedCallback, disconnectedCallback);',
+    ].join('\n');
+}

package/src/cypress/config/__tests__/webpack-config.test.ts

@@ -2,7 +2,8 @@ import { fs, vol } from 'memfs';
 import { getSwcOptions } from '../../../cli/tasks';
 import { TSConfig } from '../../../cli/utils';
 import { getBaseTsConfig } from '../../../utils';
-import { JS_RULE_EXCLUDE, Overrides, rulesConfig } from '../../../webpack/configs';
+import { JS_RULE_EXCLUDE, rulesConfig } from '../../../webpack/configs';
+import { Overrides } from '../../../webpack/types';
 import { webpackConfig } from '../webpack-config';
 
 jest.mock('@servicetitan/install');
@@ -41,7 +42,7 @@ describe(`[startup/cypress-config] ${webpackConfig.name}`, () => {
         subject();
 
         expect(rulesConfig).toHaveBeenCalledWith(
-            expect.objectContaining({ isProduction: false }),
+            expect.objectContaining({ build: expect.objectContaining({ isProduction: false }) }),
             expect.anything()
         );
     });
@@ -50,7 +51,7 @@ describe(`[startup/cypress-config] ${webpackConfig.name}`, () => {
         subject();
 
         expect(rulesConfig).toHaveBeenCalledWith(
-            expect.objectContaining({ codeCoverage: true }),
+            expect.objectContaining({ options: { codeCoverage: true } }),
             expect.anything()
         );
     });

package/src/cypress/config/webpack-config.ts

@@ -5,7 +5,8 @@ import merge from 'webpack-merge';
 import { getSwcOptions } from '../../cli/tasks';
 import { TSConfig } from '../../cli/utils';
 import { getTsConfigWithFallback, log } from '../../utils';
-import { Context, JS_RULE_EXCLUDE, Overrides, rulesConfig } from '../../webpack/configs';
+import { JS_RULE_EXCLUDE, rulesConfig } from '../../webpack/configs';
+import { Overrides, WebpackBuildContext } from '../../webpack/types';
 
 export function webpackConfig(overrides?: Overrides): Configuration {
     const context = getContext();
@@ -26,20 +27,32 @@ export function webpackConfig(overrides?: Overrides): Configuration {
     return merge(config, overrides?.configuration ?? {});
 }
 
-function getContext(): Context {
+function getContext(): WebpackBuildContext {
     return {
-        codeCoverage: true,
-        destination: '',
-        isProduction: false,
-        name: '',
-        packageData: {} as any,
-        packageManager: getPackageManager(),
-        sharedDependencies: {},
-        source: '',
+        package: {
+            name: '',
+            version: '',
+            destination: '',
+            source: '',
+            dependencies: {},
+            sharedDependencies: {},
+            isWebComponent: false,
+            isLegacyRoot: false,
+            isExposeSharedDependencies: false,
+            packageManager: getPackageManager(),
+        },
+        build: {
+            name: '',
+            isProduction: false,
+        },
+        options: {
+            codeCoverage: true,
+        },
+        bundlerConfig: {},
     };
 }
 
-function getRules(context: Context, overrides: Overrides) {
+function getRules(context: WebpackBuildContext, overrides: Overrides) {
     const { rules } = rulesConfig(context, overrides);
 
     return [getSwcLoaderRule(), getSwcIstanbulRule(), ...rules];

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './utils/get-packages';
+
 export * from './webpack';

package/src/storybook-config/__tests__/webpack-final.test.ts

@@ -1,6 +1,7 @@
 import type { Configuration } from 'webpack';
-import { Overrides, rulesConfig } from '../../webpack/configs';
+import { rulesConfig } from '../../webpack/configs';
 import { miniCssExtractPlugin } from '../../webpack/configs/plugins';
+import { Overrides } from '../../webpack/types';
 import { webpackFinal } from '../webpack-final';
 
 jest.mock('@servicetitan/install');
@@ -50,31 +51,6 @@ describe(`[startup/storybook-config] ${webpackFinal.name}`, () => {
         );
     });
 
-    describe('when config has optimization settings', () => {
-        beforeEach(() => {
-            config.optimization = { sideEffects: true, splitChunks: { chunks: 'all' } };
-        });
-
-        describe('when mode is development', () => {
-            beforeEach(() => (config.mode = 'development'));
-
-            test('disables sideEffects to preserve CSS imports from barrel files', () => {
-                expect(subject().optimization).toEqual({
-                    ...config.optimization,
-                    sideEffects: false,
-                });
-            });
-        });
-
-        describe('when mode is production', () => {
-            beforeEach(() => (config.mode = 'production'));
-
-            test('does not change sideEffects', () => {
-                expect(subject().optimization).toEqual(config.optimization);
-            });
-        });
-    });
-
     test('adds MiniCssExtractPlugin to config', () => {
         expect(subject().plugins).toEqual([mockMiniCssExtractPlugin]);
     });
@@ -117,7 +93,9 @@ describe(`[startup/storybook-config] ${webpackFinal.name}`, () => {
             subject();
 
             expect(rulesConfig).toHaveBeenCalledWith(
-                expect.objectContaining({ isProduction: true }),
+                expect.objectContaining({
+                    build: expect.objectContaining({ isProduction: true }),
+                }),
                 expect.anything()
             );
         });

package/src/storybook-config/webpack-final.ts

@@ -2,8 +2,9 @@ import { getPackageManager } from '@servicetitan/install';
 import { inspect } from 'node:util';
 import type { Configuration } from 'webpack';
 import { log } from '../utils';
-import { Context, Overrides, rulesConfig } from '../webpack/configs';
+import { rulesConfig } from '../webpack/configs';
 import { miniCssExtractPlugin } from '../webpack/configs/plugins';
+import { Overrides, WebpackBuildContext } from '../webpack/types';
 
 export function webpackFinal(config: Configuration, overrides: Overrides = {}): Configuration {
     const context = getContext(config);
@@ -15,10 +16,6 @@ export function webpackFinal(config: Configuration, overrides: Overrides = {}):
 
     return {
         ...config,
-        optimization: {
-            ...config.optimization,
-            ...(config.mode !== 'production' ? { sideEffects: false } : {}),
-        },
         module: {
             ...config.module,
             rules: [...transformDefaultRules(config.module?.rules), ...rules],
@@ -27,23 +24,34 @@ export function webpackFinal(config: Configuration, overrides: Overrides = {}):
     };
 }
 
-function getContext(config: Configuration): Context {
+function getContext(config: Configuration): WebpackBuildContext {
     return {
-        destination: '',
-        isProduction: config.mode === 'production',
-        name: '',
-        packageData: {} as any,
-        packageManager: getPackageManager(),
-        sharedDependencies: {},
-        source: '',
+        package: {
+            name: '',
+            version: '',
+            destination: '',
+            source: '',
+            dependencies: {},
+            sharedDependencies: {},
+            isWebComponent: false,
+            isLegacyRoot: false,
+            isExposeSharedDependencies: false,
+            packageManager: getPackageManager(),
+        },
+        build: {
+            name: '',
+            isProduction: config.mode === 'production',
+        },
+        options: {},
+        bundlerConfig: {},
     };
 }
 
-function getPlugins(context: Context, overrides: Overrides) {
+function getPlugins(context: WebpackBuildContext, overrides: Overrides) {
     return [miniCssExtractPlugin(context, overrides)].filter(plugin => !!plugin);
 }
 
-function getRules(context: Context, overrides: Overrides) {
+function getRules(context: WebpackBuildContext, overrides: Overrides) {
     const include = ['.module.css', '.module.less', '.less', '.module.scss', '.scss', '.svg'];
     const exclude = ['.css'];
 

package/src/utils/__tests__/get-configuration.test.ts

@@ -7,12 +7,12 @@ import {
     getJestConfiguration,
     getReviewConfiguration,
     getStylelintConfiguration,
+    getViteConfiguration,
     getVitestConfiguration,
     getWebComponentBranchConfigs,
     getWebComponentConfiguration,
     hasHeadlessBundle,
     isBundle,
-    isCustomStyleRules,
     isDevServerDisabled,
     isExposeSharedDependencies,
     isLegacy,
@@ -225,6 +225,29 @@ describe('[startup] Utils', () => {
         });
     });
 
+    describe(getViteConfiguration.name, () => {
+        const subject = () => getViteConfiguration();
+
+        itReturns(subject, {});
+
+        describe('with "cli.vite"', () => {
+            const content = {
+                cli: {
+                    vite: {
+                        omitDefault: ['plugins.svgr'],
+                        config: { server: { port: 9000 }, build: { minify: false } },
+                    },
+                },
+            };
+
+            beforeEach(() => mockPackageJson(content));
+
+            test('returns "cli.vite"', () => {
+                expect(subject()).toEqual(content.cli.vite);
+            });
+        });
+    });
+
     describe(getVitestConfiguration.name, () => {
         const subject = () => getVitestConfiguration();
 
@@ -394,11 +417,6 @@ describe('[startup] Utils', () => {
             defaultValue: true,
             trigger: { cli: { webpack: false } },
         },
-        {
-            fn: isCustomStyleRules,
-            defaultValue: false,
-            trigger: { cli: { webpack: { 'custom-style-rules': true } } },
-        },
         {
             fn: isDevServerDisabled,
             defaultValue: false,
@@ -407,7 +425,10 @@ describe('[startup] Utils', () => {
         {
             fn: isExposeSharedDependencies,
             defaultValue: false,
-            trigger: { cli: { webpack: { 'expose-shared-dependencies': true } } },
+            trigger: [
+                { cli: { 'expose-shared-dependencies': true } },
+                { cli: { webpack: { 'expose-shared-dependencies': true } } },
+            ],
         },
         {
             fn: isLegacy,

package/src/utils/__tests__/get-package-data.test.ts

@@ -32,7 +32,7 @@ describe(`[startup] Utils`, () => {
             });
         });
 
-        describe(`when ${packageJson} contains sharedDependencies`, () => {
+        describe(`when ${packageJson} contains cli.webpack.sharedDependencies`, () => {
             const sharedDependencies = { react: 'SharedDependencies.React' };
 
             beforeEach(() => {
@@ -45,5 +45,39 @@ describe(`[startup] Utils`, () => {
                 expect(subject()).toEqual(expect.objectContaining({ sharedDependencies }));
             });
         });
+
+        describe(`when ${packageJson} contains cli.sharedDependencies`, () => {
+            const sharedDependencies = { mobx: 'SharedDependencies.MobX' };
+
+            beforeEach(() => {
+                Object.assign(packages[packageJson], {
+                    cli: { 'shared-dependencies': sharedDependencies },
+                });
+            });
+
+            test('returns sharedDependencies', () => {
+                expect(subject()).toEqual(expect.objectContaining({ sharedDependencies }));
+            });
+        });
+
+        describe(`when ${packageJson} contains cli.sharedDependencies and cli.webpack.sharedDependencies`, () => {
+            const topLevel = { react: 'SharedDependencies.React' };
+            const webpack = { mobx: 'SharedDependencies.MobX' };
+
+            beforeEach(() => {
+                Object.assign(packages[packageJson], {
+                    cli: {
+                        'shared-dependencies': topLevel,
+                        'webpack': { 'shared-dependencies': webpack },
+                    },
+                });
+            });
+
+            test('returns cli.sharedDependencies', () => {
+                expect(subject()).toEqual(
+                    expect.objectContaining({ sharedDependencies: topLevel })
+                );
+            });
+        });
     });
 });