@servicetitan/startup-utils 27.4.0-canary.0 → 27.4.0-canary.1

package/dist/get-exposed-dependencies.d.ts

@@ -1,3 +1,3 @@
 import { ExposedDependencies } from './types';
-export declare function getExposedDependencies(sharedDependencies: Record<string, string>, getVersion: (dependency: string) => string): ExposedDependencies;
+export declare function getExposedDependencies(sharedDependencies: Record<string, string>, dependenciesOrCallback: Record<string, string> | ((dependency: string) => string)): ExposedDependencies;
 //# sourceMappingURL=get-exposed-dependencies.d.ts.map

package/dist/get-exposed-dependencies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-exposed-dependencies.d.ts","sourceRoot":"","sources":["../src/get-exposed-dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAgB,sBAAsB,CAClC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1C,UAAU,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,uBAS7C"}
+{"version":3,"file":"get-exposed-dependencies.d.ts","sourceRoot":"","sources":["../src/get-exposed-dependencies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C,wBAAgB,sBAAsB,CAClC,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1C,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAC,uBAcpF"}

package/dist/get-exposed-dependencies.js

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getExposedDependencies = getExposedDependencies;
-function getExposedDependencies(sharedDependencies, getVersion) {
+function getExposedDependencies(sharedDependencies, dependenciesOrCallback) {
+    const getVersion = typeof dependenciesOrCallback === 'function'
+        ? dependenciesOrCallback
+        : (dependency) => dependenciesOrCallback[dependency];
     return Object.entries(sharedDependencies).reduce((result, [dependency, variable]) => ({
         ...result,
         [dependency]: { version: getVersion(dependency), variable },

package/dist/get-exposed-dependencies.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-exposed-dependencies.js","sourceRoot":"","sources":["../src/get-exposed-dependencies.ts"],"names":[],"mappings":";;AAEA,wDAWC;AAXD,SAAgB,sBAAsB,CAClC,kBAA0C,EAC1C,UAA0C;IAE1C,OAAO,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAC5C,CAAC,MAAM,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QACjC,GAAG,MAAM;QACT,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE;KAC9D,CAAC,EACF,EAAyB,CAC5B,CAAC;AACN,CAAC"}
+{"version":3,"file":"get-exposed-dependencies.js","sourceRoot":"","sources":["../src/get-exposed-dependencies.ts"],"names":[],"mappings":";;AAEA,wDAgBC;AAhBD,SAAgB,sBAAsB,CAClC,kBAA0C,EAC1C,sBAAiF;IAEjF,MAAM,UAAU,GACZ,OAAO,sBAAsB,KAAK,UAAU;QACxC,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,CAAC,UAAkB,EAAE,EAAE,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAErE,OAAO,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAC5C,CAAC,MAAM,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;QACjC,GAAG,MAAM;QACT,CAAC,UAAU,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE;KAC9D,CAAC,EACF,EAAyB,CAC5B,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/startup-utils",
-    "version": "27.4.0-canary.0",
+    "version": "27.4.0-canary.1",
     "description": "",
     "repository": {
         "type": "git",

package/src/__tests__/get-exposed-dependencies.test.ts

@@ -0,0 +1,39 @@
+import { getExposedDependencies } from '../get-exposed-dependencies';
+
+describe(`[startup-utils] ${getExposedDependencies.name}`, () => {
+    let sharedDependencies: Record<string, string>;
+    let dependencies: Record<string, string>;
+    let callback: ((dependency: string) => string) | undefined;
+
+    beforeEach(() => {
+        sharedDependencies = {
+            foo: 'SharedDependencies.Foo',
+            bar: 'SharedDependencies.Bar',
+        };
+        dependencies = {
+            foo: '1.0.0',
+            bar: '2.0.0',
+        };
+        callback = undefined;
+    });
+
+    const subject = () => getExposedDependencies(sharedDependencies, callback ?? dependencies);
+
+    test('returns exposed dependencies', () => {
+        expect(subject()).toEqual({
+            foo: { version: '1.0.0', variable: 'SharedDependencies.Foo' },
+            bar: { version: '2.0.0', variable: 'SharedDependencies.Bar' },
+        });
+    });
+
+    describe('when passed a callback', () => {
+        beforeEach(() => (callback = name => `callback(${name})`));
+
+        test('uses version returned by callback', () => {
+            expect(subject()).toEqual({
+                foo: { version: 'callback(foo)', variable: 'SharedDependencies.Foo' },
+                bar: { version: 'callback(bar)', variable: 'SharedDependencies.Bar' },
+            });
+        });
+    });
+});

package/src/__tests__/get-version-mismatches.test.ts

@@ -1,7 +1,7 @@
 import { getVersionMismatches } from '../get-version-mismatches';
 import { ExposedDependencies } from '../types';
 
-describe(`[web-components] ${getVersionMismatches.name}`, () => {
+describe(`[startup-utils] ${getVersionMismatches.name}`, () => {
     let sharedDependencies: Record<string, string> = {};
     let dependencies: Record<string, string> = {};
     let exposedDependencies: ExposedDependencies = {};

package/src/__tests__/is-compatible.test.ts

@@ -1,6 +1,6 @@
 import { isCompatible } from '../is-compatible';
 
-describe(`[web-components] ${isCompatible.name}`, () => {
+describe(`[startup-utils] ${isCompatible.name}`, () => {
     let hostVersion: string;
     let packageVersion: string;
 

package/src/__tests__/load-shared-dependencies.test.ts

@@ -1,10 +1,25 @@
 import { loadSharedDependencies } from '../load-shared-dependencies';
 
-describe('[Startup] utils:loadSharedDependencies', () => {
-    const getPackageDependencies = (...excluded: string[]) =>
-        Object.entries({
-            '@servicetitan/confirm': '^0.0.0',
+describe(`[startup-utils] ${loadSharedDependencies.name}`, () => {
+    const defaultSharedDependencies = {
+        '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
+        '@servicetitan/anvil2': 'SharedDependencies.ServiceTitan.Anvil2',
+        'classnames': 'SharedDependencies.ClassNames',
+        'formstate': 'SharedDependencies.FormState',
+        'mobx': 'SharedDependencies.MobX',
+        'mobx-react': 'SharedDependencies.MobXReact',
+        'mobx-utils': 'SharedDependencies.MobXUtils',
+        'react': 'SharedDependencies.React',
+        'react-dom': 'SharedDependencies.ReactDOM',
+    };
+    let packageDependencies: Record<string, string> | undefined;
+    let sharedDependencies: Record<string, string> | undefined;
+
+    beforeEach(() => {
+        packageDependencies = {
+            // Default shared dependencies
             '@servicetitan/design-system': '^0.0.0',
+            '@servicetitan/anvil2': '^0.0.0',
             'classnames': '^0.0.0',
             'formstate': '^0.0.0',
             'mobx': '^0.0.0',
@@ -12,103 +27,82 @@ describe('[Startup] utils:loadSharedDependencies', () => {
             'mobx-utils': '^0.0.0',
             'react': '^0.0.0',
             'react-dom': '^0.0.0',
+            // Other dependencies
+            '@servicetitan/confirm': '^0.0.0',
             'react-input-mask': '^0.0.0',
-        }).reduce(
-            (out, [d, v]) => ({
-                ...out,
-                ...(excluded.includes(d) ? {} : { [d]: v }),
-            }),
-            {}
-        );
-
-    test('return default dependencies when manual are not configured', () => {
-        expect(loadSharedDependencies(getPackageDependencies(), undefined)).toEqual({
-            '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
-            'classnames': 'SharedDependencies.ClassNames',
-            'formstate': 'SharedDependencies.FormState',
-            'mobx': 'SharedDependencies.MobX',
-            'mobx-react': 'SharedDependencies.MobXReact',
-            'mobx-utils': 'SharedDependencies.MobXUtils',
-            'react': 'SharedDependencies.React',
-            'react-dom': 'SharedDependencies.ReactDOM',
-        });
+        };
+        sharedDependencies = undefined;
     });
 
-    test('return default dependencies except not used when manual are not configured', () => {
-        expect(loadSharedDependencies(getPackageDependencies('mobx-utils'), undefined)).toEqual({
-            '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
-            'classnames': 'SharedDependencies.ClassNames',
-            'formstate': 'SharedDependencies.FormState',
-            'mobx': 'SharedDependencies.MobX',
-            'mobx-react': 'SharedDependencies.MobXReact',
-            'react': 'SharedDependencies.React',
-            'react-dom': 'SharedDependencies.ReactDOM',
-        });
+    const subject = () => loadSharedDependencies(packageDependencies, sharedDependencies);
+
+    function omit(obj: Record<string, string>, ...exclude: string[]) {
+        return Object.fromEntries(Object.entries(obj).filter(([key]) => !exclude.includes(key)));
+    }
+
+    test('returns default shared dependencies', () => {
+        expect(subject()).toEqual(defaultSharedDependencies);
     });
 
-    test('return manual dependencies if set', () => {
-        expect(
-            loadSharedDependencies(getPackageDependencies(), {
-                '@servicetitan/confirm': 'SharedDependencies.ServiceTitan.Confirm',
-                'react-input-mask': 'SharedDependencies.ReactInputMask',
-            })
-        ).toEqual({
-            '@servicetitan/confirm': 'SharedDependencies.ServiceTitan.Confirm',
-            'react-input-mask': 'SharedDependencies.ReactInputMask',
+    describe('when package does not depend on default shared dependency', () => {
+        beforeEach(() => delete packageDependencies!['@servicetitan/design-system']);
+
+        test('omits the default shared dependency', () => {
+            expect(subject()).toEqual(
+                omit(defaultSharedDependencies, '@servicetitan/design-system')
+            );
         });
     });
 
-    test('return default dependencies within manual', () => {
-        expect(
-            loadSharedDependencies(getPackageDependencies(), {
-                defaults: '',
-            })
-        ).toEqual({
-            '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
-            'classnames': 'SharedDependencies.ClassNames',
-            'formstate': 'SharedDependencies.FormState',
-            'mobx': 'SharedDependencies.MobX',
-            'mobx-react': 'SharedDependencies.MobXReact',
-            'mobx-utils': 'SharedDependencies.MobXUtils',
-            'react': 'SharedDependencies.React',
-            'react-dom': 'SharedDependencies.ReactDOM',
+    describe('with explicit shared dependencies', () => {
+        beforeEach(() => (sharedDependencies = {}));
+
+        test('returns specified dependencies', () => {
+            expect(subject()).toEqual(sharedDependencies);
         });
-    });
 
-    test('clear default dependencies when configured', () => {
-        expect(
-            loadSharedDependencies(getPackageDependencies(), {
-                'defaults': '',
-                'mobx-utils': '',
-            })
-        ).toEqual({
-            '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
-            'classnames': 'SharedDependencies.ClassNames',
-            'formstate': 'SharedDependencies.FormState',
-            'mobx': 'SharedDependencies.MobX',
-            'mobx-react': 'SharedDependencies.MobXReact',
-            'react': 'SharedDependencies.React',
-            'react-dom': 'SharedDependencies.ReactDOM',
+        describe('when explicit shared dependencies includes "defaults"', () => {
+            beforeEach(() => (sharedDependencies!.defaults = ''));
+
+            test('returns default shared dependencies', () => {
+                expect(subject()).toEqual(defaultSharedDependencies);
+            });
+
+            describe('when explicit shared dependency has falsy value', () => {
+                beforeEach(() => {
+                    Object.assign(sharedDependencies!, { 'classnames': false, 'mobx-utils': '' });
+                });
+
+                test('omits the falsy dependency', () => {
+                    expect(subject()).toEqual(
+                        omit(defaultSharedDependencies, 'classnames', 'mobx-utils')
+                    );
+                });
+            });
+
+            describe('when explicit shared dependency has non-default packages', () => {
+                beforeEach(() => {
+                    Object.assign(sharedDependencies!, {
+                        '@servicetitan/confirm': 'SharedDependencies.ServiceTitan.Confirm',
+                        'react-input-mask': 'SharedDependencies.ReactInputMask',
+                    });
+                });
+
+                test('adds the non-default packages', () => {
+                    expect(subject()).toEqual({
+                        ...defaultSharedDependencies,
+                        ...omit(sharedDependencies!, 'defaults'),
+                    });
+                });
+            });
         });
     });
 
-    test('mixes default dependencies and configured', () => {
-        expect(
-            loadSharedDependencies(getPackageDependencies(), {
-                'defaults': '',
-                'mobx-utils': '',
-                'react-input-mask': 'SharedDependencies.ReactInputMask',
-                'react-something': 'SharedDependencies.ReactSomething',
-            })
-        ).toEqual({
-            '@servicetitan/design-system': 'SharedDependencies.ServiceTitan.DesignSystem',
-            'classnames': 'SharedDependencies.ClassNames',
-            'formstate': 'SharedDependencies.FormState',
-            'mobx': 'SharedDependencies.MobX',
-            'mobx-react': 'SharedDependencies.MobXReact',
-            'react': 'SharedDependencies.React',
-            'react-dom': 'SharedDependencies.ReactDOM',
-            'react-input-mask': 'SharedDependencies.ReactInputMask',
+    describe('with no package dependencies', () => {
+        beforeEach(() => (packageDependencies = undefined));
+
+        test('returns empty object', () => {
+            expect(subject()).toEqual({});
         });
     });
 });

package/src/get-exposed-dependencies.ts

@@ -2,8 +2,13 @@ import { ExposedDependencies } from './types';
 
 export function getExposedDependencies(
     sharedDependencies: Record<string, string>,
-    getVersion: (dependency: string) => string
+    dependenciesOrCallback: Record<string, string> | ((dependency: string) => string)
 ) {
+    const getVersion =
+        typeof dependenciesOrCallback === 'function'
+            ? dependenciesOrCallback
+            : (dependency: string) => dependenciesOrCallback[dependency];
+
     return Object.entries(sharedDependencies).reduce(
         (result, [dependency, variable]) => ({
             ...result,