@servicetitan/docs-uikit 31.3.2 → 31.4.0

package/docs/startup/kendo-ui-license.mdx

@@ -4,7 +4,7 @@ title: kendo-ui-license
 
 Activates KendoReact components by installing the license key. The license key is only installed if the project depends on `@progress/kendo` components. Otherwise, this command has no effect.
 
-**Note:** The [build](#build) command automatically detects when a project uses KendoRect components and runs this command.
+**Note:** The [build](./build) command automatically detects when a project uses KendoRect components and runs this command.
 
 Use it to install the license key separately from a build, or to override the default license key.
 

package/docs/startup/startup.mdx

@@ -279,7 +279,7 @@ Or you can use relative path to a file that exports an object with detailed conf
 
 ###### Web component config options
 
-- `cli.web-component.branches` - Set git branch specific configs, used for publishing. See [Branch configs](#branch-configs).
+- `cli.web-component.branches` - Set git branch specific configs, used for publishing. See [Branch configs](./mfe-publish#branch-configs).
 - `cli.web-component.legacyRoot` - Set to opt-out of automatic batching. See [Opting-out of automatic batching](/docs/frontend/react-18#opting-out-of-automatic-batching).
 
 See [MFE configuration](/docs/frontend/micro-frontends/#mfe-configuration) for detailed instructions on configuring MFE applications.

package/docs/web-components/event-bus.mdx

@@ -10,7 +10,7 @@ Use EventBus to exchange messages (aka events) between a host and MFEs, or betwe
 ### Providing EventBus
 
 To use EventBus, provide an instance via `EVENT_BUS_TOKEN`.
-[Loader](../web-components#loader) automatically passes the EventBus through to MFEs.
+[Loader](./loader) automatically passes the EventBus through to MFEs.
 For example,
 
 ```tsx
@@ -458,32 +458,44 @@ It returns an `EVENT_BUS_TOKEN` that resolves to the specified type of EventBus.
 
 #### Examples
 
-This example declares a `CustomEventBus` that only
+This example declares an `EventBus` that only
 allows **"example:click"** and **"example:input"**, and that requires **"example:input"** to be sent with a string value.
 
-`typedEventBusToken` returns a convenient shorthand for using `CustomEventBus`.
+```ts
+import { useDependencies } from '@servicetitan/react-ioc';
+import { EventBus } from '@servicetitan/web-components';
+
+export interface CustomEvents {
+    'example:click': undefined;
+    'example:input': string;
+}
+
+function Test() {
+    // eventBus is typed: emit() and on() allow only keys of CustomEvents and matching data
+    const [eventBus] = useDependencies<[EventBus<CustomEvents>]>(EVENT_BUS_TOKEN);
+}
+```
+
+`typedEventBusToken` is a convenient shorthand that achieves the same result:
 
 ```ts
 import { useDependencies } from '@servicetitan/react-ioc';
-import { EVENT_BUS_TOKEN, typedEventBusToken } from '@servicetitan/web-components';
+import { typedEventBusToken } from '@servicetitan/web-components';
 
-interface CustomEvents {
+export interface CustomEvents {
     'example:click': undefined;
     'example:input': string;
 }
 
-const CUSTOM_EVENT_BUS_TOKEN = typedEventBusToken<CustomEvents>();
+export const CUSTOM_EVENT_BUS_TOKEN = typedEventBusToken<CustomEvents>();
 
 function Test() {
-    // eventBus is not typed: emit() and on() allow any events and data
-    const [eventBus] = useDependencies(EVENT_BUS_TOKEN);
-
     /**
-     * customEventBus is typed: emit() and on() allow only keys of CustomEvents and matching data
+     * eventBus is typed: emit() and on() allow only keys of CustomEvents and matching data
      * Using CUSTOM_EVENT_BUS_TOKEN is equivalent to:
-     *   useDependencies(EVENT_BUS_TOKEN as SymbolToken<CustomEventBus>)
+     *   useDependencies<[EventBus<CustomEvents>]>(EVENT_BUS_TOKEN)
      */
-    const [customEventBus] = useDependencies(CUSTOM_EVENT_BUS_TOKEN);
+    const [eventBus] = useDependencies(CUSTOM_EVENT_BUS_TOKEN);
 }
 ```
 

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

@@ -34,16 +34,16 @@ export const disconnectedCallback: HeadlessCallback = ({ eventBus }) => {
 };
 ```
 
-### `HeadlessCallback<T>`
+### `HeadlessCallback`
 
-The `HeadlessCallback<T>` type is a function that receives an object with the below properties:
+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`   | `EventBus`        | The [EventBus instance](./event-bus) passed from the Host.                                     |
-| `mfeData`    | `Serializable<T>` | The [data passed from the host into `HeadlessLoader`](#headless-loader-props), typed as `T`.   |
+| 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
 
@@ -59,9 +59,9 @@ export const Foo = () => {
 
 ### Props  {#headless-loader-props}
 
-| Name          | Description                                                                                                                                         |
-| :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `src`         | url for the MFE's package                                                                                                                           |
-| `fallbackSrc` | optional alternative url for the MFE's package (if request for src returns error)                                                                   |
+| Name          | Description                                                                                                                                                  |
+| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `src`         | url for the MFE's package                                                                                                                                    |
+| `fallbackSrc` | optional alternative url for the MFE's package (if request for src returns error)                                                                            |
 | `data`        | additional data passed to an MFE as an object, where values are serializable, and preferably memoized ([see Loader](./loader#passing-data-from-host-to-mfe)) |
 | `cache`       | optional cache strategy for the MFE [(see Loader)](./loader#cache-strategy). Defaults to `-1`.                                                               |

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "31.3.2",
+    "version": "31.4.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "c9909c13f221700fe9d3adb043d2faa26472e921"
+    "gitHead": "21360511d426098c7231809ca33b13ecd11f16dd"
 }