@servicetitan/docs-uikit 32.1.0 → 32.2.0

package/docs/web-components/headless-loader.mdx

@@ -2,52 +2,7 @@
 title: HeadlessLoader
 ---
 
-The headless bundle is a tiny bundle that allows a host to preload configuration or setup information without having to load the entire MFE. The headless bundle does not utilize React, and cannot use any modules that require React.
-
-## Generating headless bundle
-
-To generate a headless bundle, create a file named `headless.ts` in the root directory of the MFE's source folder. When this file is present, startup generates a `headless` bundle alongside the `light` and `full` bundles. Only what is imported in `headless.ts` will be included in the bundle.
-
-`headless.ts` should contain exported functions named `connectedCallback` and/or `disconnectedCallback`.
-
-### `connectedCallback`
-
-`connectedCallback` will be called when the bundle is loaded in the host. It should be typed as `HeadlessCallback<T>`.
-
-```ts title="src/headless.ts"
-import type { HeadlessCallback } from '@servicetitan/web-components';
-export const connectedCallback: HeadlessCallback<ExampleData> = ({ mfeData, eventBus }) => {
-    doSomethingWithMfeData(mfeData);
-    eventBus?.emit('example-module:status', { status: 'connected', timestamp: Date.now() });
-};
-```
-
-
-### `disconnectedCallback`
-
-`disconnectedCallback` will be called when the headless MFE is unmounted. It should be typed as `HeadlessCallback<T>`.
-
-```ts title="src/headless.ts"
-import type { HeadlessCallback } from '@servicetitan/web-components';
-export const disconnectedCallback: HeadlessCallback = ({ eventBus }) => {
-    eventBus?.emit('example-module:status', { status: 'disconnected', timestamp: Date.now() });
-};
-```
-
-### `HeadlessCallback`
-
-The `HeadlessCallback<TMfeData = any, TEventBus extends EventBus = EventBus>` type is a function that receives an object with the below properties:
-
-| Parameter    | Type                     | Description                                                                                         |
-| ------------ | ------------------------ | --------------------------------------------------------------------------------------------------- |
-| `ldService`  | `LDService`              | The [LaunchDarkly LDService instance](../launchdarkly-service#ldservice) passed from the Host.      |
-| `logService` | `Log`                    | The [Log instance](../log-service#log) passed from the Host.                                        |
-| `eventBus`   | `TEventBus`              | The [EventBus instance](./event-bus) passed from the Host, typed as `TEventBus`.                    |
-| `mfeData`    | `Serializable<TMfeData>` | The [data passed from the host into `HeadlessLoader`](#headless-loader-props), typed as `TMfeData`. |
-
-## HeadlessLoader
-
-Use the `HeadlessLoader` component to load this bundle from within a host application.
+Use `HeadlessLoader` to load a [headless bundle](../microfrontends/developing/headless-bundle) in a host application.
 
 ```tsx
 import { HeadlessLoader } from '@servicetitan/web-components';
@@ -57,7 +12,7 @@ export const Foo = () => {
 };
 ```
 
-### Props  {#headless-loader-props}
+## Props {#headless-loader-props}
 
 | Name          | Description                                                                                                                                                  |
 | :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |

package/docs/web-components/loader.mdx

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
 
 ## Loader
 
-The `Loader` component is used to load an MFE into a host application. See [Microfrontends (MFEs)](/docs/frontend/micro-frontends) for more information about how MFEs are injected.
+Use `Loader` to load an MFE into a host application.
 
 ### Usage
 
@@ -31,7 +31,7 @@ export const Foo = () => {
 | `loadingFallbackDelayed` | controls whether to render the loading fallback immediately, or after a short delay [(see below)](#fallback-delay)                                  |
 | `errorFallback`          | optional ReactNode to render when the MFE fails to load                                                                                             |
 | `className`              | additional CSS classes for the MFE web component element                                                                                            |
-| `cache`                  | optional cache strategy for the MFE [(see below)](#cache-strategy). Defaults to `-1`.                                                              |
+| `cache`                  | optional cache strategy for the MFE [(see below)](#cache-strategy). Defaults to `-1`.                                                               |
 
 ### Loading fallback delay {#fallback-delay}
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "32.1.0",
+    "version": "32.2.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "5686f75473bd25104356c3fc6e7c8ffe478ca125"
+    "gitHead": "76a83fea33e04809b97c72720751878b1e3002d7"
 }

package/docs/startup/test.mdx

@@ -1,205 +0,0 @@
----
-title: test
----
-
-Runs your project's tests.
-
-- Supports both Jest and Vitest.
-- Automatically selects the test runner based on your workspace configuration or the `--runner` option.
-- Handles runner-specific arguments and passes them through to the underlying test tool.
-
-## Usage
-
-Run all tests with Jest (default):
-
-```sh
-npx startup test
-```
-
-Run all tests with Vitest:
-
-```sh
-npx startup test --runner vitest
-```
-
-:::tip
-Use the double-dash (--) separator to pass arguments to an `npm` script.
-This separator indicates that any arguments following it should be passed directly to the script being executed, rather than being interpreted by `npm` itself.
-For example, given the standard `startup test` script:
-
-```json
-{
-    "test": "npx startup test"
-}
-```
-
-Running,
-
-```sh
-npm run test -- --runner vitest
-```
-
-Executes,
-
-```sh
-npx startup test --runner vitest
-```
-
-:::
-
-## Running Specific Tests
-
-To run specific tests, pass their file names or paths as additional arguments.
-This works just like running Jest and Vitest directly, simply specify the file(s) you want to test:
-
-### Examples
-
-Run a specific test with Jest (default):
-
-```sh
-npx startup test app.test.tsx
-```
-
-Run a specific test with Vitest:
-
-```sh
-npx startup test --runner vitest app.test.tsx
-```
-
-## Using Jest
-
-The `startup test` command uses the Jest test runner by default.
-
-### Configuration
-
-The Jest runner provides a default, built-in configuration optimized for ServiceTitan workspaces.
-
-You can override the defaults by specifying [Jest options](https://jestjs.io/docs/configuration) in your workspace `package.json` under the `"cli.jest"` key (the `"cli.test"` key also works, for backward compatibility). You can also use a standard Jest config file (such as `jest.config.js`) to override defaults.
-
-Any options passed directly via the command line (e.g., `npx startup test --coverage`) take the highest precedence.
-
-:::caution
-If your project includes a standard Jest config file and also specifies Jest options in the workspace `package.json`, ensure that the configurations are mutually exclusive.
-To avoid confusing or unexpected behavior, do not specify the same setting in both locations.
-:::
-
-### Examples
-
-Use the workspace `package.json` to set up code that runs before each test file is executed:
-
-```json title="package.json"
-{
-    "cli": {
-        "jest": {
-            "setupFilesAfterEnv": ["<rootDir>/jest.setup.ts"]
-        }
-    }
-}
-```
-
-:::note
-For backward compatibility, you may also use the `ci.test` key:
-:::
-
----
-
-Use `jest.config.js` to increase Jest's `testTimeout` on Windows:
-
-```js title="jest.config.js"
-module.exports = {
-    testTimeout: process.platform === 'win32' ? 60 * 1000 : undefined, // increase timeout on Windows
-};
-```
-
----
-
-Use the command line to collect test coverage:
-
-```sh
-npx startup test --coverage
-```
-
-Use the command line to enable Jest's watch mode:
-
-```sh
-npx startup test --watch
-```
-
-## Using Vitest
-
-✨ New in **v31.6.0** ✨
-
-You can change the default test runner to `vitest` in your workspace's `package.json`:
-
-```json title="package.json"
-{
-    "cli": {
-        "testRunner": "vitest"
-    }
-}
-```
-
-Or override it per invocation with the `--runner` option.
-
-### Configuration
-
-The Vitest runner uses a layered configuration approach to provide sensible defaults while allowing full customization.
-
-- Uses the default, built-in configuration as a base.
-- Merges workspace settings from `package.json`.
-- Merges settings from your Vitest config file.
-- Merges command line options last.
-
-1. **Default Configuration:**  
-   The runner starts with a built-in default configuration optimized for ServiceTitan workspaces. This includes sensible coverage settings, the environment (`jsdom`), file exclusions, and more.
-
-2. **Workspace Configuration:**  
-   You can customize the configuration by specifying [Vitest options](https://vitest.dev/config) in your workspace `package.json` under the `"cli.vitest"` key.
-
-3. **Vitest Config File:**  
-   If your project includes a standard Vitest config file (such as `vitest.config.ts` or `vite.config.ts`), its settings will merged with the defaults and workspace configuration.
-
-4. **Command Line Arguments:**  
-   Any options passed directly via the command line (e.g., `npx startup test --runner vitest --coverage`) take highest precedence over previous configuration layers.
-
-### Examples
-
-Use workspace `package.json` to make `vitest` APIs available [globally](https://vitest.dev/config/#globals) like Jest:
-
-```json title="package.json"
-{
-    "cli": {
-        "vitest": {
-            "globals": true
-        }
-    }
-}
-```
-
----
-
-Use Vitest config file to disable watch mode:
-
-```ts title="vitest.config.mts"
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-    test: {
-        watch: false,
-    },
-});
-```
-
----
-
-Use the command line to disable watch mode:
-
-```sh
-npx startup test --runner vitest --run
-```
-
-Use the command line to collect code coverage:
-
-```sh
-npx startup test --runner vitest --coverage
-```