@servicetitan/docs-anvil-uikit-contrib 28.5.1 → 29.0.0

package/docs/notifications-center.mdx

@@ -22,13 +22,13 @@ import { CodeDemo, DemoCodeBlock } from '@site/src/components/code-demo';
 
 There're a lot of cases when a user should be notified in the result of various events. It could be from a simple one-time notification about the result of the network request to informing about the state of a complex long-running process launched on the worker.
 
-Notification Center was created to simplify and generalize everything related to user notifications. It provides few touchpoints: `NotificationCenter` to send various notification types from the backend, `NotificationsService` to show messages on the frontend, and `register` function to configure rendering of notifications arrived from the backend.
+Notification Center was created to simplify and generalize everything related to user notifications. It provides few touchpoints: `NotificationCenter` to send various notification types from the backend, `NotificationsService` to show messages on the frontend, and `intercept` function to pre-process notifications received from the backend.
 
 ## Examples
 
 ### Client-side notifications
 
-To initiate notifications from the client side it's enough to call one of the `NotificationsService` methods. They accept `options` - a configuration of the visible part of notification which should cover most of the use cases and `preventDuplicates` flag used to avoid rendering of notifications that are already visible to a user.
+To initiate notifications from the client side it's enough to call one of the `NotificationsService` methods. They accept `options` - a configuration of the visible part of notification which should cover most of the use cases and `preventDuplicates` flag used to avoid rerendering a notification that is already visible.
 
 #### Basic
 
@@ -146,9 +146,7 @@ export const defaultServerCode = `
 
 #### Custom notification component
 
-But if you need to show something more specific, then you can create a custom notification type and register renderer for it, which should determine what would be shown to a user depending on a notification status.
-
-**_It's required to register all your custom renderers in the `custom-notifications.ts` file on the module level, which should be imported in your module file._**
+But if you need to show something more specific, then you can create a custom notification type and [intercept](#intercept) it, which should determine what would be shown to the user.
 
 export const customServerCode = `
     public class CustomPayload : INotificationPayload
@@ -162,7 +160,7 @@ export const customServerCode = `
         "CustomServerNotification",
         initialPayload: new CustomPayload {
            Username = "Jane",
-           Message = "Hello, your order completed."
+           Message = "Your order is completed."
         }
     );
 `
@@ -303,17 +301,21 @@ interface FunctionAction {
 }
 ```
 
-### register
+### intercept
 
-```ts
-register(type: string, mapper: NotificationMapper): void;
+Use `intercept` to suppress or transform a server-side notification.
 
-type NotificationMapper = React.ComponentType<{
-    notification: Notification;
-    onClose(): void;
-}>;
+```ts
+intercept(type: string, fn?: NotificationInterceptor): void;
 ```
 
+#### Parameters
+
+| Name   | Type                                                                | Description                                                                                                                                                                                                                                                                                                                                                    |
+| :----- | :------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `type` | `string`                                                            | The notification to intercept.                                                                                                                                                                                                                                                                                                                                 |
+| `fn`   | `(notification: Notification, dismiss: () => void) => Notification` | Function that transforms or suppresses the notification. It is passed the notification and a callback you can save and use later to dismiss the notification.<br/><br/>To transform a notification, return a new `Notification` object that replaces the original. To suppress it, return `undefined`. To stop intercepting, set this argument to `undefined`. |
+
 ## FAQ
 
 ### What is the delivery logic, what happens if user has several windows open?
@@ -326,4 +328,4 @@ Unclosed notifications will be shown again on application reopen.
 
 ### How will be displayed a large number of notifications?
 
-Only 5 notifications will be shown at a time, the rest will appear after displayed ones closing.
+Only a few notifications are shown at a time. The remainder are revealed when the user closes visible ones.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-anvil-uikit-contrib",
-    "version": "28.5.1",
+    "version": "29.0.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "1820e5b017bb456161b9342d57a7a48efb362ccb"
+    "gitHead": "a7bd8d2fe17dbd2ee6499c8623cc777a6abd4dcc"
 }