@servicetitan/startup 34.2.0 → 34.3.0-beta.0

package/src/{webpack/configs/plugins/ignore-plugin → core/check-resource}/__tests__/check-resource.test.ts

@@ -1,4 +1,4 @@
-import { Context } from '../../../types';
+import { BuildContext } from '../../types';
 import { checkResource } from '../check-resource';
 import { isOptionalPeerDependency } from '../is-optional-peer-dependency';
 import { isOptionalReactDomPeerDependency } from '../is-optional-react-dom-peer-dependency';
@@ -8,7 +8,7 @@ jest.mock('../is-optional-react-dom-peer-dependency');
 
 describe(`${checkResource.name}`, () => {
     const context = 'node_modules/web-components/dist';
-    let packageContext: Partial<Context>;
+    let packageContext: BuildContext;
     let resource: string;
 
     beforeEach(() => {
@@ -16,15 +16,28 @@ describe(`${checkResource.name}`, () => {
 
         resource = '@servicetitan/foo';
         packageContext = {
-            packageData: {
+            build: {
+                name: 'application',
+                isProduction: false,
+            },
+            package: {
                 name: 'application',
                 version: '1.0.0',
+                destination: 'dist',
+                source: 'src',
                 dependencies: {},
+                sharedDependencies: {},
+                isWebComponent: false,
+                isLegacyRoot: false,
+                isExposeSharedDependencies: false,
+            },
+            options: {
+                bundlerConfig: {},
             },
         };
     });
 
-    const subject = () => checkResource(packageContext as any)(resource, context);
+    const subject = () => checkResource(packageContext)(resource, context);
 
     function itReturns(value: boolean) {
         test(`returns ${value}`, () => expect(subject()).toBe(value));
@@ -38,7 +51,7 @@ describe(`${checkResource.name}`, () => {
         itReturns(true);
 
         describe('when resource is package dependency', () => {
-            beforeEach(() => (packageContext.packageData!.dependencies[resource] = '*'));
+            beforeEach(() => (packageContext.package.dependencies[resource] = '*'));
 
             itReturns(false);
         });

package/src/{webpack/configs/plugins/ignore-plugin → core/check-resource}/check-resource.ts

@@ -1,12 +1,12 @@
-import { log } from '../../../../utils';
-import { Context } from '../../types';
+import { log } from '../../utils';
+import { BuildContext } from '../types';
 import { isOptionalPeerDependency } from './is-optional-peer-dependency';
 import { isOptionalReactDomPeerDependency } from './is-optional-react-dom-peer-dependency';
 
-export function checkResource(packageContext: Context) {
+export function checkResource(packageContext: BuildContext) {
     return function (resource: string, context: string) {
         if (
-            !packageContext.packageData.dependencies[resource] &&
+            !packageContext.package.dependencies[resource] &&
             isOptionalPeerDependency(resource, context)
         ) {
             log.debug('check-resource', `${JSON.stringify({ resource, context })} => true`);

package/src/{webpack/configs/plugins/ignore-plugin → core/check-resource}/get-package-json.ts

@@ -1,8 +1,8 @@
 import fs from 'fs';
 import path from 'path';
-import { log, readJson } from '../../../../utils';
+import { log, readJson } from '../../utils';
 
-const containsNodeModules = /[\\/](node_modules|\.yalc)[\\/]/;
+const containsNodeModules = /[\\/](node_modules|\.yalc|uikit)[\\/]/;
 const isNodeModules = /(node_modules|\.yalc)/;
 
 export function getPackageJson(context: string) {

package/src/core/check-resource/index.ts

@@ -0,0 +1 @@
+export { checkResource } from './check-resource';

package/src/core/context.ts

@@ -0,0 +1,65 @@
+import crypto from 'crypto';
+import {
+    getFolders,
+    getPackageData,
+    getPackageName,
+    isExposeSharedDependencies,
+    isLegacyRoot,
+    isWebComponent,
+    loadSharedDependencies,
+} from '../utils';
+import { BuildContext, BundlerConfig } from './types';
+export type { BuildContext } from './types';
+
+export interface CreateBuildContextInput {
+    name: string;
+    isProduction: boolean;
+    light?: boolean;
+    headless?: boolean;
+    codeCoverage?: boolean;
+    buildStat?: boolean;
+    bundlerConfig?: BundlerConfig;
+}
+
+export function getName() {
+    const packageName = getPackageName()
+        .replace(/\//g, '-')
+        .replace(/[^\w-]/g, '');
+    const hash = crypto.randomBytes(4).toString('hex');
+
+    return `${packageName}-${hash}`;
+}
+
+export function createBuildContext(input: CreateBuildContextInput): BuildContext {
+    const { source, destination } = getFolders();
+    const packageData = getPackageData();
+    const sharedDependencies = loadSharedDependencies(
+        packageData.dependencies,
+        packageData.sharedDependencies
+    );
+
+    return {
+        package: {
+            name: packageData.name,
+            version: packageData.version,
+            destination,
+            source,
+            dependencies: packageData.dependencies,
+            sharedDependencies,
+            isWebComponent: isWebComponent(),
+            isLegacyRoot: isLegacyRoot(),
+            isExposeSharedDependencies: isExposeSharedDependencies(),
+        },
+        build: {
+            name: input.name,
+            isProduction: input.isProduction,
+            light: input.light,
+            headless: input.headless,
+        },
+        options: {
+            codeCoverage: input.codeCoverage,
+            buildStat: input.buildStat,
+            bundlerConfig: input.bundlerConfig ?? {},
+        },
+    };
+}

package/src/core/defines/exposed-dependencies.ts

@@ -0,0 +1,21 @@
+import { getPackageDependencyVersion } from '../../utils';
+import { BuildContext } from '../types';
+import { getExposedDependencies } from '../utils/get-exposed-dependencies';
+
+export function defineExposedDependencies(context: BuildContext) {
+    const { isExposeSharedDependencies, sharedDependencies, dependencies } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+
+    if (!isExposeSharedDependencies || emitExposedDependencies) {
+        return;
+    }
+
+    const exposedDependencies = getExposedDependencies(sharedDependencies, dependency =>
+        getPackageDependencyVersion(dependency, dependencies?.[dependency])
+    );
+
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        EXPOSED_DEPENDENCIES: JSON.stringify(exposedDependencies),
+    };
+}

package/src/core/defines/exposed-instance-dependencies.ts

@@ -0,0 +1,19 @@
+import { BuildContext } from '../types';
+import { getLaunchDarklySdkVersion } from '../utils/get-launchdarkly-sdk-version';
+
+export function defineExposedInstanceDependencies(context: BuildContext) {
+    const { isExposeSharedDependencies } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+    if (!isExposeSharedDependencies || emitExposedDependencies) {
+        return;
+    }
+
+    const instanceDependencies = {
+        launchDarkly: { version: getLaunchDarklySdkVersion() },
+    };
+
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        EXPOSED_INSTANCE_DEPENDENCIES: JSON.stringify(instanceDependencies),
+    };
+}

package/src/core/defines/index.ts

@@ -0,0 +1,3 @@
+export { defineExposedDependencies } from './exposed-dependencies';
+export { defineExposedInstanceDependencies } from './exposed-instance-dependencies';
+export { defineWebComponentName } from './web-component-name';

package/src/core/defines/web-component-name.ts

@@ -0,0 +1,15 @@
+import { BuildContext } from '../types';
+
+export function defineWebComponentName(context: BuildContext) {
+    const { isWebComponent } = context.package;
+    const { name } = context.build;
+
+    if (!isWebComponent) {
+        return;
+    }
+
+    return {
+        // eslint-disable-next-line @typescript-eslint/naming-convention
+        WEB_COMPONENT_NAME: JSON.stringify(name),
+    };
+}

package/src/core/externals.ts

@@ -0,0 +1,23 @@
+import { BuildContext } from './types';
+
+export function getExternalsMapping(context: BuildContext): Record<string, string> | undefined {
+    if (!needsExternals(context)) {
+        return;
+    }
+
+    const { sharedDependencies, isWebComponent } = context.package;
+    const name = isWebComponent ? context.build.name : context.package.name;
+    return Object.fromEntries(
+        Object.entries(sharedDependencies).map(([dependency, variable]) => [
+            dependency,
+            `${variable}['${name}']`,
+        ])
+    );
+}
+
+function needsExternals(context: BuildContext) {
+    const { light } = context.build;
+    const { isExposeSharedDependencies } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+    return !!light || (isExposeSharedDependencies && !emitExposedDependencies);
+}

package/src/core/get-exposed-dependencies-entry-points.ts

@@ -0,0 +1,59 @@
+import fs from 'fs';
+import path from 'path';
+import { readJsonSafe } from '../utils';
+import { BuildContext } from './types';
+import { getBundleType } from './utils';
+
+interface ExposedDepsMetadata {
+    entryPointsPath: string;
+}
+
+interface EntryPoints {
+    css: string[];
+    js: string[];
+}
+
+export function getExposedDependenciesEntryPoints(context: BuildContext) {
+    const metadataPath = getExposedDependenciesMetadataPath(context);
+    const metadata = readJsonSafe<ExposedDepsMetadata>(metadataPath);
+    if (metadata?.entryPointsPath) {
+        return readJsonSafe<EntryPoints>(metadata.entryPointsPath);
+    }
+}
+
+export function getExposedDependenciesMetadataPath(context: BuildContext) {
+    return path.join(context.package.destination, 'exposed-dependencies-metadata.json');
+}
+
+export function getSharedEntryPoints(context: BuildContext): EntryPoints {
+    const dirname = getBundleType({
+        ...context,
+        options: {
+            ...context.options,
+            bundlerConfig: { ...context.options.bundlerConfig, emitExposedDependencies: true },
+        },
+    });
+    if (!dirname) {
+        return { css: [], js: [] };
+    }
+
+    const { css = [], js = [] } = getExposedDependenciesEntryPoints(context) ?? {};
+    return {
+        css: css.map(name => `${dirname}/${name}`),
+        js: js.map(name => `${dirname}/${name}`),
+    };
+}
+
+export function generateExposedDependenciesMetadata(
+    context: BuildContext,
+    getOutputPath: () => string
+) {
+    const { destination } = context.package;
+    if (!fs.existsSync(destination)) {
+        fs.mkdirSync(destination, { recursive: true });
+    }
+
+    const metadataPath = getExposedDependenciesMetadataPath(context);
+    const metadata: ExposedDepsMetadata = { entryPointsPath: getOutputPath() };
+    fs.writeFileSync(metadataPath, JSON.stringify(metadata, null, 2), 'utf-8');
+}

package/src/core/index.ts

@@ -0,0 +1,8 @@
+export * from './check-resource';
+export * from './context';
+export * from './defines';
+export * from './externals';
+export * from './get-exposed-dependencies-entry-points';
+export type * from './types';
+export * from './utils';
+export * from './virtual-modules';

package/src/core/types.ts

@@ -0,0 +1,59 @@
+import { MinifyOptions } from '../utils';
+
+export interface BuildContext {
+    package: PackageContext;
+    build: BuildIdentity;
+    options: BuildOptions;
+}
+
+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;
+}
+
+export interface BuildIdentity {
+    name: string;
+    isProduction: boolean;
+    light?: boolean;
+    headless?: boolean;
+}
+
+export interface BuildOptions {
+    codeCoverage?: boolean;
+    buildStat?: boolean;
+    bundlerConfig: BundlerConfig;
+}
+
+export interface BundlerConfig {
+    isCustomStyleRules?: boolean;
+    minify?: MinifyOptions;
+    emitExposedDependencies?: boolean | { output?: { path?: string } };
+}
+
+// Re-export types that were on the old Context and are used by both bundlers
+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/{webpack/configs → core}/utils/__tests__/build-metadata.test.ts

@@ -1,11 +1,11 @@
 import { fs, vol } from 'memfs';
-import { getStartupVersion } from '../../../../utils/get-startup-version';
+import { getStartupVersion } from '../../../utils/get-startup-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('../../../utils/get-startup-version');
 jest.mock('../get-launchdarkly-sdk-version');
 jest.mock('../get-web-components-version');
 

package/src/{webpack/configs → core}/utils/__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,30 @@ 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: {
+                bundlerConfig: {},
+            },
         };
     });
 
     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 +74,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 +86,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 → core}/utils/build-metadata.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { getStartupVersion, readJsonSafe } from '../../../utils';
+import { getStartupVersion, readJsonSafe } from '../../utils';
 import { EntryPoints, Metadata } from '../types';
 import { getLaunchDarklySdkVersion } from './get-launchdarkly-sdk-version';
 import { getWebComponentsVersion } from './get-web-components-version';

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

@@ -1,11 +1,12 @@
 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, sharedDependencies } = context;
+export function generateMetadata(context: BuildContext) {
+    const { destination, sharedDependencies, version, dependencies } = context.package;
+    const { name } = context.build;
 
     if (!fs.existsSync(destination)) {
         fs.mkdirSync(destination, { recursive: true });
@@ -14,8 +15,8 @@ export function generateMetadata(context: Context) {
     const metadata = buildMetadata({
         destination,
         name,
-        version: packageData.version,
-        dependencies: packageData.dependencies,
+        version,
+        dependencies,
         sharedDependencies,
     });
 

package/src/core/utils/get-bundle-type.ts

@@ -0,0 +1,20 @@
+import { BuildContext } from '../types';
+
+export function getBundleType(context: BuildContext) {
+    const { light, headless } = context.build;
+    const { isExposeSharedDependencies, isWebComponent } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+
+    if (isExposeSharedDependencies && emitExposedDependencies) {
+        return 'shared';
+    }
+
+    if (isWebComponent) {
+        if (headless) {
+            return 'headless';
+        }
+        return light ? 'light' : 'full';
+    }
+
+    return undefined;
+}

package/src/{webpack/configs → core}/utils/get-launchdarkly-sdk-version.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { readJson } from '../../../utils';
+import { readJson } from '../../utils';
 
 export function getLaunchDarklySdkVersion() {
     try {

package/src/core/utils/get-output-path.ts

@@ -0,0 +1,18 @@
+import path from 'path';
+import { BuildContext } from '../types';
+import { getBundleType } from './get-bundle-type';
+
+export function getOutputPath(context: BuildContext) {
+    const { destination } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+
+    const subdir = getBundleType(context) ?? '';
+    if (typeof emitExposedDependencies === 'object') {
+        const { output } = emitExposedDependencies;
+        if (output?.path) {
+            return path.join(output.path, subdir);
+        }
+    }
+
+    return path.join(process.cwd(), destination, 'bundle', subdir);
+}

package/src/{webpack/configs → core}/utils/get-web-components-version.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { readJson } from '../../../utils';
+import { readJson } from '../../utils';
 
 export function getWebComponentsVersion() {
     return readJson<{ version: string }>(

package/src/core/utils/index.ts

@@ -0,0 +1,8 @@
+export * from './build-metadata';
+export * from './generate-metadata';
+export * from './get-bundle-type';
+export * from './get-exposed-dependencies';
+export * from './get-launchdarkly-sdk-version';
+export * from './get-output-path';
+export * from './get-web-components-version';
+export * from './stringify-config';

package/src/core/virtual-modules.ts

@@ -0,0 +1,76 @@
+import fs from 'fs';
+import path from 'path';
+import { BuildContext } from './types';
+
+export function virtualModules(context: BuildContext) {
+    const modules: { [key: string]: string | undefined; 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 } = context.build;
+    const { isWebComponent, dependencies, sharedDependencies } = context.package;
+    const { emitExposedDependencies } = context.options.bundlerConfig;
+
+    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';",
+        "import { connectedCallback, disconnectedCallback } from './headless';",
+        'registerHeadless(connectedCallback, disconnectedCallback);',
+    ].join('\n');
+}

package/src/index.ts

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