@servicetitan/docs-uikit 26.0.2 → 26.2.0

package/docs/BREAKING_CHANGES.mdx

@@ -0,0 +1,52 @@
+---
+title: BREAKING CHANGES
+---
+
+## v26.0.0
+
+### [@servicetitan/startup](./startup)
+
+- Upgraded **webpack-dev-server** from v3 to v5, which introduces many breaking changes to the configuration settings.
+For a complete list see [v4 migration guide](https://github.com/webpack/webpack-dev-server/blob/master/migration-v4.md) and [v5 migration guide](https://github.com/webpack/webpack-dev-server/blob/master/migration-v5.md). Some common issues are:
+  - **contentBase** and **watchContentBase** were removed; use **static**
+  - **disableHostCheck** was removed; use `allowedHosts: 'all'`
+  - **hotOnly** was removed; use `hot: 'only'`
+  - **http2** and **https** were removed; use **server**
+  - **injectClient** and **injectHot** were removed in favor of manual setup entries
+  - **inline** was removed without replacement
+  - **proxy** only accepts an array
+  - **publicPath**, **stats** and **writeToDisk** were moved to **devMiddleware**
+
+
+## v25.0.0
+
+### [@servicetitan/ajax-handlers](./ajax-handlers)
+
+- Changed [**withMicroservice**](./ajax-handlers#parameters) arguments to a single options object.
+
+## v24.0.0
+
+### [@servicetitan/startup](./startup)
+
+- Upgraded **Typescript** from v4 to v5, which adds correctness improvements that will reveal previously undetected ambiguities. In particular,
+  - Type checks for enums are stricter because all **enum** values get their own type
+  - **string** and **boolean** values aren't implicitly converted to numbers. Use the `+` operator to explicitly convert values to numbers in mathematical expressions. (e.g., `return +str > 42;`)
+  
+  See [this blogpost](https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/) for the complete list of changes.
+
+
+## v23.0.0
+
+### [@servicetitan/eslint-config](./eslint-config)
+
+- Upgraded **@typescript-eslint/eslint-plugin** from version v5.x to v6. Because every new major version includes improvements and changes to existing rules, expect to see new lint errors in your project.
+
+### [@servicetitan/react-ioc](./react-ioc/)
+
+- Changed second argument of **provide** method to an object with **loadingFallback** and **errorFallback** properties.
+- Renamed the **fallback** property of the **Provider** component to **loadingFallback** and added **errorFallback** property.
+- Removed ability to use **useValue** with **instances**.
+
+### [@servicetitan/startup](./startup)
+
+- Upgraded **Jest** from version v27 to v29. The largest breaking change is that v29 changed the default snapshot format.<br/>To update old snapshots, run `npm run test -- --updateSnapshot`. See [Upgrading from v27 to v28](https://jest-archive-august-2023.netlify.app/docs/28.x/upgrading-to-jest28) and [Upgrading from v28 to v29](https://jestjs.io/docs/upgrading-to-jest29) for detailed lists of all breaking changes.

package/docs/ajax-handlers.mdx

@@ -2,16 +2,7 @@
 title: AJAX Handlers
 ---
 
-import Admonition from '@theme/Admonition';
-import { VersionHistory, Changes } from '@site/src/components/version-history';
-
-<VersionHistory>
-    <Changes forVersion="v25.0.0">
-        <Admonition type="caution" title="Breaking changes">
-            Changed <code>withMicroservice</code> to accept a single options argument.
-        </Admonition>
-    </Changes>
-</VersionHistory>
+#### [CHANGELOG (@servicetitan/ajax-handlers)](https://github.com/servicetitan/uikit/blob/master/packages/ajax-handlers/CHANGELOG.md)
 
 ## withMicroservice
 

package/docs/component-usage.mdx

@@ -2,6 +2,8 @@
 title: Component Usage
 ---
 
+#### [CHANGELOG (@servicetitan/component-usage)](https://github.com/servicetitan/uikit/blob/master/packages/component-usage/CHANGELOG.md)
+
 `@servicetitan/component-usage` will calculate and publish metrics on the app's component usage. The packages which we report on are currently hard-coded to [this list](https://github.com/servicetitan/uikit/blob/master/packages/component-usage/src/index.ts#L40-L64)
 
 ## Usage

package/docs/error-boundary.mdx

@@ -2,6 +2,8 @@
 title: Error Boundary
 ---
 
+#### [CHANGELOG (@servicetitan/error-boundary)](https://github.com/servicetitan/uikit/blob/master/packages/error-boundary/CHANGELOG.md)
+
 `@servicetitan/error-boundary` is an implementation of React error boundary mechanism. More info about error boundaries can be found in React [docs](https://reactjs.org/docs/error-boundaries.html).
 
 ## Usage

package/docs/eslint-config.mdx

@@ -2,21 +2,18 @@
 title: ESLint & Stylelint configurations
 ---
 
-import Admonition from '@theme/Admonition';
-import { VersionHistory, Changes } from '@site/src/components/version-history';
+<h4>
+    <a href="https://github.com/servicetitan/uikit/blob/master/packages/eslint-config/CHANGELOG.md">
+        CHANGELOG (@servicetitan/eslint-config)
+    </a>
+    <br />
+    <a href="https://github.com/servicetitan/uikit/blob/master/packages/stylelint-config/CHANGELOG.md">
+        CHANGELOG (@servicetitan/stylelint-config)
+    </a>
+</h4>
 
 `@servicetitan/eslint-config` and `@servicetitan/stylelint-config` packages contain core lint rule sets which should be used in ServiceTitan web projects.
 
-<VersionHistory>
-    <Changes forVersion="23.0.0">
-        <Admonition type="caution">
-            Upgrades <code>@typescript-eslint/eslint-plugin</code> from version v5.x to v6. Because
-            every new major version of <code>typescript-eslint</code> includes improvements and
-            changes to existing rules, expect to see new lint errors in your project.
-        </Admonition>
-    </Changes>
-</VersionHistory>
-
 ## Usage
 
 ### ESLint

package/docs/folder-schema.mdx

@@ -2,6 +2,16 @@
 title: Folder Schema
 ---
 
+<h4>
+    <a href="https://github.com/servicetitan/uikit/blob/master/packages/eslint-plugin-folder-schema/CHANGELOG.md">
+        CHANGELOG (@servicetitan/eslint-plugin-folder-schema)
+    </a>
+    <br />
+    <a href="https://github.com/servicetitan/uikit/blob/master/packages/folder-lint/CHANGELOG.md">
+        CHANGELOG (@servicetitan/folder-lint)
+    </a>
+</h4>
+
 Folder schema is a flexible tool to configure a strict hierarchy of files in your project with verification by `eslint`. It consists of `@servicetitan/eslint-plugin-folder-schema` and `@servicetitan/folder-lint` packages.
 
 ## @servicetitan/eslint-plugin-folder-schema

package/docs/ko-bridge.mdx

@@ -2,6 +2,8 @@
 title: React-Knockout Bridge
 ---
 
+#### [CHANGELOG (@servicetitan/ko-bridge)](https://github.com/servicetitan/uikit/blob/master/packages/ko-bridge/CHANGELOG.md)
+
 `@servicetitan/ko-bridge` is a collection of components and utils to connect `Knockout` and `React` codebase.
 
 ## When to use?

package/docs/lazy-module.mdx

@@ -2,6 +2,8 @@
 title: Lazy Module
 ---
 
+#### [CHANGELOG (@servicetitan/lazy-module)](https://github.com/servicetitan/uikit/blob/master/packages/lazy-module/CHANGELOG.md)
+
 In the terminology of our desktop frontend "module" is an independent business area of the application with ownership by some squad, for example, we have accounting, memberships, reporting, dispatch and other very important modules that desktop SPA consists of. Clearly, when ST users are opening desktop app they don't need all those modules loaded right away because typically they use a subset of app functionality to perform their job duties.
 
 `@servicetitan/lazy-module` is a wrapper around React Suspense mechanism to enable module-level code splitting for better web page loading performance.

package/docs/log-service.mdx

@@ -2,6 +2,8 @@
 title: Log Service
 ---
 
+#### [CHANGELOG (@servicetitan/log-service)](https://github.com/servicetitan/uikit/blob/master/packages/log-service/CHANGELOG.md)
+
 `@servicetitan/log-service` is used in the Monolith to send events to Kibana logs via the backend log service.
 
 ## Usage

package/docs/react-ioc.mdx

@@ -2,29 +2,9 @@
 title: React IoC
 ---
 
-`@servicetitan/react-ioc` is an implementation of [InversifyJS](https://github.com/inversify/InversifyJS) for react applications, it uses Context API of React 16 to manage containers.
+#### [CHANGELOG (@servicetitan/react-ioc)](https://github.com/servicetitan/uikit/blob/master/packages/react-ioc/CHANGELOG.md)
 
-import Admonition from '@theme/Admonition';
-import { VersionHistory, Changes } from '@site/src/components/version-history';
-
-<VersionHistory>
-    <Changes forVersion="v23.0.0">
-        <Admonition type="caution" title="Breaking changes">
-            <p>
-                Changed second argument of <code>provide</code> method to an object with
-                <code>loadingFallback</code> and <code>errorFallback</code> properties.
-            </p>
-            <p>
-                Renamed <code>fallback</code> property of the <code>Provider</code> component to{' '}
-                <code>loadingFallback</code> and added <code>errorFallback</code> property.
-            </p>
-            <p>
-                Removed ability to use <code>useValue</code> with <code>instances</code>.
-            </p>
-        </Admonition>
-        See <a href="https://github.com/servicetitan/uikit/releases/tag/v23.0.0">Release Notes</a>
-    </Changes>
-</VersionHistory>
+`@servicetitan/react-ioc` is an implementation of [InversifyJS](https://github.com/inversify/InversifyJS) for react applications, it uses Context API of React 16 to manage containers.
 
 ## Features
 

package/docs/startup.mdx

@@ -2,129 +2,10 @@
 title: Startup
 ---
 
-import Admonition from '@theme/Admonition';
-import { VersionHistory, Changes } from '@site/src/components/version-history';
+#### [CHANGELOG (@servicetitan/startup)](https://github.com/servicetitan/uikit/blob/master/packages/startup/CHANGELOG.md)
 
 [@servicetitan/startup](https://github.com/servicetitan/uikit/tree/master/packages/startup) is a command-line interface (CLI) to create multi-package Lerna projects with the support of TypeScript Project References and React. It offers a modern build setup with no configuration.
 
-<VersionHistory>
-    <Changes forVersion="26.0.0">
-        <Admonition type="caution">
-            Upgraded <code>webpack-dev-server</code> from v3 to v5.
-            Version 5 introduces many breaking changes to the <code>webpack-dev-server</code> configuration.
-            For a complete list see the <a href="https://github.com/webpack/webpack-dev-server/blob/master/migration-v4.md">v4</a> and <a href="https://github.com/webpack/webpack-dev-server/blob/master/migration-v5.md">v5</a> migration guides.
-            Some common issues are:
-            <ul>
-            <li><strong>contentBase</strong> and <strong>watchContentBase</strong> were removed; use <strong>static</strong></li>
-            <li><strong>disableHostCheck</strong> was removed; use <code>allowedHosts: 'all'</code></li>
-            <li><strong>hotOnly</strong> was removed; use <code>hot: 'only'</code></li>
-            <li><strong>http2</strong> and <strong>https</strong> were removed; use <strong>server</strong></li>
-            <li><strong>injectClient</strong> and <strong>injectHot</strong> were removed in favor of manual setup entries</li>
-            <li><strong>inline</strong> was removed without replacement</li>
-            <li><strong>proxy</strong> only accepts an array</li>
-            <li><strong>publicPath</strong>, <strong>stats</strong> and <strong>writeToDisk</strong> were moved to <strong>devMiddleware</strong></li>
-            </ul>
-        </Admonition>
-    </Changes>
-    <Changes forVersion="24.1.0">
-        Changed <code>init</code> command to generate React 18 project by default
-        and added <code>--react17</code> switch to generate React 17 project.
-    </Changes>
-    <Changes forVersion="24.0.0">
-        <Admonition type="caution">
-            <p>
-            Upgraded <code>Typescript</code> from v4 to v5.
-            Version 5 adds correctness improvements that will reveal
-            previously undetected ambiguities. In particular,
-            </p>
-            <ul>
-            <li>Type checks for enums are stricter because all enum values get their own type</li>
-            <li>String and boolean values aren't implicitly converted to numbers.
-            Use the <code>+</code> operator to explicitly convert values to numbers in mathematical expressions.
-            (e.g., <code>return +str &gt; 42;</code>)</li>
-            </ul>
-            <p>See <a href="https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/">this blogpost</a> for the complete list of changes.</p>
-        </Admonition>
-    </Changes>
-    <Changes forVersion="23.0.0">
-        <Admonition type="caution">
-            Upgraded <code>Jest</code> from version v27.x to v29.
-            The largest breaking change is that v29 changed the default snapshot format.
-            To update old snapshots, run <code>npm run test -- --updateSnapshot</code>.
-            <br/>
-            See <a href="https://jest-archive-august-2023.netlify.app/docs/28.x/upgrading-to-jest28">Upgrading from v27 to v28</a> and <a href="https://jestjs.io/docs/upgrading-to-jest29">Upgrading from v28 to v29</a> for a list changes.
-        </Admonition>
-        Added <code>--code-coverage</code> option to <code>build</code> command
-    </Changes>
-    <Changes forVersion="22.20.0">
-        Added <code>--experimental-bundlers</code> option to <code>build</code> command
-    </Changes>
-    <Changes forVersion="22.19.0">
-        Added <code>--registry</code> option to <code>mfe-publish</code> command
-    </Changes>
-    <Changes forVersion="22.18.0">
-        Fixed issue where <code>startup init</code> failed to create new project
-    </Changes>
-    <Changes forVersion="22.17.0">
-        Fixed issue where <code>startup</code> exits with success code when command fails
-    </Changes>
-    <Changes forVersion="v22.16.0">
-        <Admonition type="warning" title="Deprecated">
-            This version contains a critical bug that was introduced in v22.15.0 and fixed in v22.17.0. Update to v22.17.0 or later as soon as possible.
-        </Admonition>
-        Added @servicetitan/testing-library to the <code>startup init</code> template
-    </Changes>
-    <Changes forVersion="v22.15.0">
-        <Admonition type="warning" title="Deprecated">
-            This version contains a critical bug that was introduced in v22.15.0 and fixed in v22.17.0. Update to v22.17.0 or later as soon as possible.
-        </Admonition>
-        Runs all commands with 8GB of memory by default.
-    </Changes>
-    <Changes forVersion="v22.11.0">
-        Added <code>install</code> command that replaces legacy bootstrap.js
-        and changed <code>init</code> template to use it.
-    </Changes>
-    <Changes forVersion="v22.9.0">
-        Changed <code>build</code> command to automatically register Kendo UI licence
-        and added <code>kendo-ui-license</code> command to manually register Kendo UI license.
-    </Changes>
-    <Changes forVersion="v22.7.0">
-        <p>MFEs now support providing custom webpack configuration too! Create <code>webpack.dev.config.js</code> and/or <code>webpack.prod.config.js</code> for development and production modes respectively.
-        Put these config files at the level of your app folder (usually, <code>packages/application</code>) instead of the root directory of your repo.</p>
-        <Admonition type="caution" title="Caution">
-            You cannot use the <code>createWebpackConfig</code> function in an MFE custom webpack config file at the time of writing. You'll get an error.
-        </Admonition>
-    </Changes>
-    <Changes forVersion="v22.3.0">
-        The <code>--stat</code> argument of the <code>build</code> command now works for MFEs too.
-    </Changes>
-    <Changes forVersion="v22.2.1">
-        <p>
-            <code>mfe-publish</code> command is added with 2 arguments to clean up (unpublish)
-            published MFE packages and 7 more arguments to publish MFEs.
-        </p>
-        <Admonition type="note" title="Note">
-            The <code>noTag</code> argument is not used at the moment of writing.
-        </Admonition>
-        <span>
-            Two more auxiliary commands (shortcuts) are also added: <code>mfe-package-clean</code>{' '}
-            and <code>mfe-package-publish</code>.
-        </span>
-    </Changes>
-    <Changes forVersion="v22.0.4">
-        <code>stat</code> argument is added for the <code>build</code> command. It enables
-        webpack-bundle-analyzer and generates a bundle report. Examples of usage:{' '}
-        <code>startup build --stat</code>
-    </Changes>
-    <Changes forVersion="v21.3.1">
-        Both <code>start</code> and <code>build</code> commands accept <code>esbuild</code> argument
-        to enable the esbuild loader. Starting this version it works both for development and
-        production. Examples of usage: <code>startup start --esbuild</code>,{' '}
-        <code>startup build --esbuild</code>
-    </Changes>
-
-</VersionHistory>
-
 ## Why use this package?
 
 #### Less to learn
@@ -285,12 +166,12 @@ This project supports [CSS Modules](https://github.com/css-modules/css-modules)
 
 ## SVG Transformation
 
-<Admonition type="note">
-    Type definitions are provided for the various ways of importing SVGs via the base tsconfig's{' '}
-    <code>"files"</code> property within <code>startup</code>. If you override the{' '}
-    <code>"files"</code> property within your tsconfig, you may lose access to these type
-    definitions, and will need to add them manually.
-</Admonition>
+:::caution
+Type definitions are provided for the various ways of importing SVGs via the base tsconfig's
+`"files"` property within `startup`. If you override the `"files"` property
+within your tsconfig, you may lose access to these type definitions, and will need to add them
+manually.
+:::
 
 By default, SVGs are loaded as assets. Depending on the file size, the asset is converted to a base64 URI string, or emitted as separate file.
 
@@ -422,6 +303,32 @@ Set `web-component` to `true` to create the support files and `light` and `full`
 
 See [MFE configuration](/docs/frontend/micro-frontends/#mfe-configuration) for detailed instructions on configuring MFE applications.
 
+##### Minification
+
+By default `startup` configures webpack to minify production bundles conservatively,
+so that projects gain the benefits of reduced bundle sizes while retaining the highest
+fidelity for source map debugging.
+
+Set `minify.js` to `false` to prevent webpack from minifying a package.
+
+To override the default [Terser](https://github.com/terser/terser) plugin configuration,
+set `minify.js` to an object containing [`terserOptions`](https://webpack.js.org/plugins/terser-webpack-plugin/#terseroptions).
+E.g.,
+
+```json title="package.json"
+{
+    "cli": {
+        "webpack": {
+            "minify": {
+                "js": {
+                    // terser-webpack-plugin options
+                }
+            }
+        }
+    }
+}
+```
+
 ##### Application Port
 
 Use `port` to set the port that `webpack-dev-server` uses for the application. E.g.,

package/docs/web-components.mdx

@@ -2,31 +2,7 @@
 title: Web Components
 ---
 
-import Admonition from '@theme/Admonition';
-import { VersionHistory, Changes } from '@site/src/components/version-history';
-
-<VersionHistory>
-    <Changes forVersion="v22.21.1">
-        Fixed a bug where the `Loader` component would error if an MFE's metadata.json contains a
-        dependency of `web-components` with a version that is a semver range.
-    </Changes>
-    <Changes forVersion="v22.21.0">
-        <Admonition type="warning" title="Deprecated">
-            This version contains a critical bug that was introduced in v22.21.0 and fixed in
-            v22.21.1. Update to v22.21.1 or later as soon as possible.
-        </Admonition>
-        Provided a more guaranteed check for an MFE's ability to re-render when passed MFE data changes.
-        Added context for MFEMetadata, which includes the shadowDom and portalShadowDom.
-    </Changes>
-    <Changes forVersion="v22.16.0">Fixed Loader memory leaks.</Changes>
-    <Changes forVersion="v22.12.0">
-        Support updating props passed to MFE via Loader. Added context for accessing MFEData.
-    </Changes>
-    <Changes forVersion="v22.7.0">
-        Fixed disposing MFE when parent element has moved in DOM.
-    </Changes>
-    <Changes forVersion="v22.1.0">Added EventBus support for sending payload with events.</Changes>
-</VersionHistory>
+#### [CHANGELOG (@servicetitan/web-components)](https://github.com/servicetitan/uikit/blob/master/packages/web-components/CHANGELOG.md)
 
 `@servicetitan/web-components` is used to build, register, and load Microfrontends (MFEs) into host applications.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "26.0.2",
+    "version": "26.2.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "64dcb81cade9e43a01e074c86e98584486b1e317"
+    "gitHead": "db962a72024497a2c475d3bbf9aab5f9c7aae223"
 }