@servicetitan/docs-uikit 22.21.0 → 23.1.0

package/docs/eslint-config.mdx

@@ -2,8 +2,21 @@
 title: ESLint & Stylelint configurations
 ---
 
+import Admonition from '@theme/Admonition';
+import { VersionHistory, Changes } from '@site/src/components/version-history';
+
 `@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/react-ioc.mdx

@@ -4,6 +4,28 @@ 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.
 
+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>
+
 ## Features
 
 -   Supports hierarchical Dependency Injection
@@ -159,3 +181,45 @@ const App = provide({ singletons: [{ provide: LOGGER_TOKEN, useClass: Logger }]
     </ErrorBoundary>
 ));
 ```
+
+#### Reusing a service
+
+You can use the inherit option to reuse existing services that are already provided. In this case, service is only created if it is not already provided in a parent container.
+
+```tsx
+class SomeStore {}
+
+class SomeOtherStore {}
+
+const App = provide({
+    singletons: [
+        { provide: SomeStore, useClass: SomeOtherStore, inherit: true },
+        { provide: SomeOtherStore, inherit: true },
+    ],
+})(() => <div />);
+```
+
+#### Service initialization
+
+If a service inherits from Store, react-ioc calls the optional `initialize` method before rendering content and calls `dispose` after unbind. Also, you can pass a loading fallback that will be rendered during initialization.
+
+```tsx
+import { Spinner } from '@servicetitan/design-system';
+import { Store } from '@servicetitan/react-ioc';
+
+class SomeStore extends Store {
+    constructor() {
+        super();
+    }
+
+    async initialize() {
+        // do some initialization
+    }
+
+    dispose() {
+        // implement disposal
+    }
+}
+
+const App = provide({ singletons: [SomeStore] }, { loadingFallback: <Spinner /> })(() => <div />);
+```

package/docs/startup.mdx

@@ -5,7 +5,19 @@ title: Startup
 import Admonition from '@theme/Admonition';
 import { VersionHistory, Changes } from '@site/src/components/version-history';
 
+[@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="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>
@@ -20,13 +32,13 @@ import { VersionHistory, Changes } from '@site/src/components/version-history';
     </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 an possible.
+            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 an possible.
+            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>
@@ -75,8 +87,6 @@ import { VersionHistory, Changes } from '@site/src/components/version-history';
 
 </VersionHistory>
 
-[@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.
-
 ## Why use this package?
 
 #### Less to learn
@@ -121,6 +131,7 @@ Runs package in the development mode. Applications will be hosted on sequential
 -   `--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
 
 ### build
 
@@ -134,6 +145,7 @@ Build packages for production to the `dist/bundle` folders. It bundles them in p
 -   `--stat` - Generate bundle report with [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer). Starting `v22.3.0` works for [MFEs](/docs/frontend/micro-frontends) too.
 -   `--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
 
 ### test
 

package/docs/web-components.mdx

@@ -2,10 +2,18 @@
 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">

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "22.21.0",
+    "version": "23.1.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "729b7ca4eb38c323ac538a73573cadd54a4ff839"
+    "gitHead": "7267270e54cdb3a2926f61feb4939d057e82adb3"
 }