@servicetitan/docs-uikit 29.0.0 → 30.0.0

package/docs/BREAKING_CHANGES.mdx

@@ -2,6 +2,16 @@
 title: BREAKING CHANGES
 ---
 
+## v30.0.0
+
+### [@servicetitan/startup](./startup)
+
+-   Upgraded ESLint to v9.x and dropped support for legacy "eslintrc" configuration. See [Upgrading to ESLint v9.x](/docs/frontend/upgrading-to-eslint-v9) for guidance.
+
+### [@servicetitan/eslint-config](./eslint-config)
+
+-   Dropped support for legacy "eslintrc" configuration
+
 ## v29.0.0
 
 ### [@servicetitan/startup](./startup)

package/docs/ajax-handlers.mdx

@@ -86,7 +86,7 @@ See [Authentication Adapters](#authentication-adapters) for more information.
 
 The authentication endpoint for protected resources.
 
--   For **Bearer** authentication, this is the endpoint that returns the bearer token to send in **Authorization** headers. Defaults to `${baseURL}/bff/silent-login`.
+-   For **Bearer** authentication, this is the endpoint that returns the bearer token to send in **Authorization** headers. Defaults to `${baseURL}/auth`.
 
 -   For **Token server** authentication, this is the "silent login" endpoint. Defaults to `${baseURL}/bff/silent-login`.
 

package/docs/eslint-config.mdx

@@ -20,18 +20,20 @@ title: ESLint & Stylelint configurations
 
 #### In the Lerna project
 
-```json title=".eslintrc.json"
-{
-    "extends": ["@servicetitan/eslint-config/mono"]
-}
+```js title="eslint.config.js"
+import { defineConfig } from 'eslint/config';
+import mono from '@servicetitan/eslint-config/mono';
+
+export default defineConfig(mono);
 ```
 
 #### Without Lerna
 
-```json title=".eslintrc.json"
-{
-    "extends": ["@servicetitan/eslint-config/single"]
-}
+```js title="eslint.config.js"
+import { defineConfig } from 'eslint/config';
+import single from '@servicetitan/eslint-config/single';
+
+export default defineConfig(single);
 ```
 
 ### Stylelint

package/docs/folder-schema.mdx

@@ -18,9 +18,22 @@ Folder schema is a flexible tool to configure a strict hierarchy of files in you
 
 Contains `@servicetitan/folder-schema/check` rule with the next options:
 
--   `root` - entry point to start recursive checking
--   `config` - object with a configuration of files hierarchy
--   `docLink?` - link to a document describing a required files hierarchy
+| Name       | Description                                                                                                                     |
+| :--------- | :------------------------------------------------------------------------------------------------------------------------------ |
+| `config`   | Object with a configuration of files hierarchy                                                                                  |
+| `root?`    | Optional entry point to start recursive checking. Defaults to the current working directory.                                    |
+| `docLink?` | Optional link to a document describing a required files hierarchy. Defaults to https://docs.st.dev/docs/frontend/file-structure |
+
+### Configuration
+
+Use the `eslint.config.{js,cjs,mjs}` file to configure rules using the [flag config](https://eslint.org/docs/latest/use/configure/configuration-files) style.
+
+```js title="eslint.config.js"
+import folderSchemaPlugin from '@servicetitan/eslint-plugin-folder-schema';
+
+// Call configs.recommended with desired options
+export = [...folderSchemaPlugin.configs.recommended({ config: require.resolve('./config') })];
+```
 
 ## @servicetitan/folder-lint
 

package/docs/startup.mdx

@@ -26,31 +26,22 @@ Updating build tooling is typically a daunting and time-consuming task. When new
 Experimental flags don't follow semver. There might be breaking changes in minor versions of `@servicetitan/startup` when you opt-in to experimental flags.
 :::
 
-### init
+### convert-eslint-config
 
-Generates initial project structure. This command should be run via `npx` in an empty folder.
+Convert an ESLint v8 configuration to v9 format.
 
 ```sh
-$ npx -y @servicetitan/startup@latest init
+$ npx startup convert-eslint-config
 ```
 
-### install
-
-Installs the package dependencies. This command should be run via `npx` before the build.
+Use this command when upgrading from ESLint v8 to v9, to convert a v8 `.eslintrc.json` to the equivalent `eslint.config.mjs`. See [Upgrading to ESLint v9.x](/docs/frontend/upgrading-to-eslint-v9) for guidance on upgrading to ESLint v9.
 
-See [package.json in the example project](https://github.com/search?q=repo%3Aservicetitan%2Ffrontend-example+path%3A**%2Fpackage.json+%22startup+install%22&type=code).
+The command takes no arguments. Simply run it from a directory with `.eslintrc.json` and it creates `eslint.config.mjs` in the same location.
 
-### start
-
-Runs package in the development mode. Applications will be hosted on sequential free ports starting from 8080. Pages will automatically reload on changes to the code.
-
-#### Arguments
-
-- `--scope <glob>` - Include only packages with names matching the given glob.
-- `--ignore <glob>` - Exclude packages with names matching the given glob.
-- `--esbuild` - Use [esbuild-loader](https://github.com/privatenumber/esbuild-loader) to process TypeScript files instead of ts-loader.
-- `--experimental-bundlers` - Use experimental build optimizations (alternative loaders and bundlers)
-- `--code-coverage` - Add [instrumentation](https://github.com/JS-DevTools/coverage-istanbul-loader) to bundled code in order to collect code coverage
+:::caution
+Comments are not copied from the source `.eslintrc.json` to the output file.
+If the source file contains important comments, copy them manually to the output file.
+:::
 
 ### build
 
@@ -66,14 +57,37 @@ Build packages for production to the `dist/bundle` folders. It bundles them in p
 - `--experimental-bundlers` - Use experimental build optimizations (alternative loaders and bundlers)
 - `--code-coverage` - Add [instrumentation](https://github.com/JS-DevTools/coverage-istanbul-loader) to bundled code in order to collect code coverage
 
-### test
+### init
 
-Runs all existing tests in all packages.
+Generates initial project structure. This command should be run via `npx` in an empty folder.
 
-To run tests a subset of tests is possible to pass paths to specific directories or test files as positional parameters.
+```sh
+$ npx -y @servicetitan/startup@latest init
+```
+
+### install
+
+Installs the package dependencies. This command should be run via `npx` before the build.
+
+See [package.json in the example project](https://github.com/search?q=repo%3Aservicetitan%2Ffrontend-example+path%3A**%2Fpackage.json+%22startup+install%22&type=code).
+
+### 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.
+
+Use it to install the license key separately from a build, or to override the default license key.
 
 ```sh
-$ npx startup test -- packages/desktop/app/modules/inventory/
+$ npx startup kendo-ui-license
+```
+
+To install a different license, set the KENDO_UI_LICENSE environment variable to the key to use.
+
+```sh
+$ export KENDO_UI_LICENSE=<license-key>
+$ npx startup kendo-ui-license
 ```
 
 ### lint
@@ -143,23 +157,26 @@ To customize the recognized branches for an MFE set `cli.web-component.branches`
 
 - `publishTag: string` - Tag used when publishing package.
 
-### kendo-ui-license
+### start
 
-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.
+Runs package in the development mode. Applications will be hosted on sequential free ports starting from 8080. Pages will automatically reload on changes to the code.
 
-**Note:** The [build](#build) command automatically detects when a project uses KendoRect components and runs this command.
+#### Arguments
 
-Use it to install the license key separately from a build, or to override the default license key.
+- `--scope <glob>` - Include only packages with names matching the given glob.
+- `--ignore <glob>` - Exclude packages with names matching the given glob.
+- `--esbuild` - Use [esbuild-loader](https://github.com/privatenumber/esbuild-loader) to process TypeScript files instead of ts-loader.
+- `--experimental-bundlers` - Use experimental build optimizations (alternative loaders and bundlers)
+- `--code-coverage` - Add [instrumentation](https://github.com/JS-DevTools/coverage-istanbul-loader) to bundled code in order to collect code coverage
 
-```sh
-$ npx startup kendo-ui-license
-```
+### test
 
-To install a different license, set the KENDO_UI_LICENSE environment variable to the key to use.
+Runs all existing tests in all packages.
+
+To run tests a subset of tests is possible to pass paths to specific directories or test files as positional parameters.
 
 ```sh
-$ export KENDO_UI_LICENSE=<license-key>
-$ npx startup kendo-ui-license
+$ npx startup test -- packages/desktop/app/modules/inventory/
 ```
 
 ## Build Steps

package/docs/web-components.mdx

@@ -155,7 +155,7 @@ The following metadata about an MFE is available from `useMFEMetadataContext` ho
 
 ### getValueForEnvironment
 
-`getValueForEnvironment` detects the Monolith environment and returns a corresponding value.
+`getValueForEnvironment` detects the host environment and returns a corresponding value.
 
 :::caution
 When no value is provided for the detected environment, `getValueForEnvironment` returns `undefined`.
@@ -163,22 +163,36 @@ When no value is provided for the detected environment, `getValueForEnvironment`
 
 #### Props
 
-| Name                 | Type                           | Description                                                                                |
-| :------------------- | :----------------------------- | :----------------------------------------------------------------------------------------- |
-| `values`             | `Record<Environment,  string>` | Object that maps each environment to a value (see below).                                  |
-| `defaultEnvironment` | `Environment`                  | The environment to use when the current environment is not recognized. Defaults to `"qa"`. |
-| `hostname`           | `string`                       | The hostname of the current environment. Defaults to `window.location.hostname`            |
+| Name                 | Type                     | Description                                                                                                               |
+| :------------------- | :----------------------- | :------------------------------------------------------------------------------------------------------------------------ |
+| `values`             | `Record<string, string>` | Object that maps each environment to a value (see below).                                                                 |
+| `defaultEnvironment` | `keyof typeof values`    | The environment to use when the current environment is not recognized or is not included in `values`. Defaults to `"qa"`. |
+| `hostname`           | `string`                 | The hostname of the current environment. Defaults to `window.location.hostname`                                           |
 
 The recognized environments are:
 
-| Environment | Description                                                     |
-| :---------- | :-------------------------------------------------------------- |
-| **dev**     | Development environment (e.g., `localhost`)                     |
-| **go**      | Production environment                                          |
-| **qa**      | QA environment                                                  |
-| **next**    | Next environment                                                |
-| **stage**   | Staging environment                                             |
-| **test**    | Unit test environment (i.e., `process.env.NODE_ENV === 'test'`) |
+| Environment       | Description                                                        |
+| :---------------- | :----------------------------------------------------------------- |
+| **dev**           | Development environment (i.e., `localhost`, `127.0.0.1`)           |
+| **go**            | Production environment                                             |
+| **qa**            | QA environment                                                     |
+| **next**          | Next environment                                                   |
+| **stage**         | Staging environment                                                |
+| **test**          | Unit test environment (i.e., `process.env.NODE_ENV === 'test'`)    |
+| `<string>`        | Custom environment that matches against`<string>.servicetitan.com` |
+| `<string>.st.dev` | Custom environment that matches against `<string>.st.dev`          |
+
+#### Custom environments
+
+Custom environments are for applications and services that run separately from the Monolith.
+For example, to associate **prod** with `my-service.servicetitan.com` and **stage** with `my-service-stage.st.dev`:
+
+```json
+{
+    "my-service": "prod", // Matches my-service.servicetitan.com
+    "stage.st.dev": "stage" // Matches *stage.st.dev
+}
+```
 
 #### Examples
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "29.0.0",
+    "version": "30.0.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "67b2763ad7c21532ea47c920974f87e8de433d32"
+    "gitHead": "e182cbb85cf66d62f235a9ca172fc04dc705fd0a"
 }