@servicetitan/docs-anvil-uikit-contrib 34.0.0 → 35.0.0

package/docs/notifications-center.mdx

@@ -82,7 +82,7 @@ Sometimes it can be redundant to show equal notifications to the user, in that c
 
 #### Multiline Message
 
-Notification message supports the newline control character, so if you need to show something list like just add `\r\n` between rows.
+Notification message supports the newline control character, so if you need to show something list like just add `\n` between rows.
 
 <CodeDemo
     example={MultilineMessageExample}

package/docs/testing-library/01-api.mdx

@@ -2,10 +2,25 @@
 title: API
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 ## MockApiCalls
 
 When it isn't practical to [mock the API service classes](/docs/frontend/testing/miscellaneous/migrating-from-autogenerated-mocks), use `MockApiCalls` to configure responses for API endpoints.
 
+### Examples
+
+<Tabs
+defaultValue="jest"
+values={[
+{ label: 'Jest (default)', value: 'jest' },
+{ label: 'Vitest', value: 'vitest' },
+{ label: 'Storybook', value: 'storybook' },
+]}
+>
+<TabItem value="jest">
+
 ```ts
 describe('[admin] AppRoutes', () => {
     // Create helper to mock API calls
@@ -24,11 +39,80 @@ describe('[admin] AppRoutes', () => {
 });
 ```
 
+</TabItem>
+<TabItem value="vitest">
+
+For Vitest tests, import from the `/vitest` entry point:
+
+```ts
+import { MockApiCalls } from '@servicetitan/testing-library/vitest';
+import { describe, it, expect, beforeEach } from 'vitest';
+
+describe('[admin] AppRoutes', () => {
+    // Create helper to mock API calls
+    const apiResponses = new MockApiCalls();
+
+    beforeEach(() => {
+        apiResponses.reset();
+        // Configure /Admin/isGoEnvironment to return false
+        apiResponses.add(/Admin\/isGoEnvironment/, { body: () => false });
+    });
+
+    it('should handle unauthorized users', () => {
+        // Configure /Admin/GetClientData to return 401 Unauthorized
+        apiResponses.add(/Admin\/GetClientData/, { status: 401 });
+        // ... test logic
+    });
+});
+```
+
+</TabItem>
+<TabItem value="storybook">
+
+For use in Storybook stories or other contexts without Jest or Vitest, import from the `/mock-api-calls` entry point:
+
+```ts
+import { MockApiCalls } from '@servicetitan/testing-library/mock-api-calls';
+import type { Meta, StoryObj } from '@storybook/react';
+
+const meta: Meta<typeof MyComponent> = {
+    component: MyComponent,
+    beforeEach: () => {
+        const mockApi = new MockApiCalls();
+        mockApi.reset();
+        mockApi.add('/api/users', {
+            body: () => [
+                { id: 1, name: 'John Doe' },
+                { id: 2, name: 'Jane Smith' },
+            ],
+        });
+
+        return () => {
+            mockApi.reset();
+        };
+    },
+};
+
+export default meta;
+type Story = StoryObj<typeof MyComponent>;
+
+export const Default: Story = {
+    render: () => <MyComponent />,
+};
+```
+
+:::caution
+When using the `/mock-api-calls` entry point, jQuery mocking has limited functionality since no spy function is provided.
+:::
+
+</TabItem>
+</Tabs>
+
 It exposes the following methods:
 
--   [add](#add): Configure an API response
--   [replace](#replace): Replace a previously configured response
--   [reset](#reset): Remove all previously configured responses
+- [add](#add): Configure an API response
+- [replace](#replace): Replace a previously configured response
+- [reset](#reset): Remove all previously configured responses
 
 ### add
 
@@ -44,9 +128,9 @@ add(
 )
 ```
 
--   `path`: regular expression to match against GET request URLs, or string value that must equal GET request URL. If a URL matches more than one path, the first one wins.
--   `body`: function that returns the API response. If omitted, or if it returns `undefined`, the mock returns an empty object (`{}`).
--   `status`: HTTP status code for API response. Defaults to 200.
+- `path`: regular expression to match against GET request URLs, or string value that must equal GET request URL. If a URL matches more than one path, the first one wins.
+- `body`: function that returns the API response. If omitted, or if it returns `undefined`, the mock returns an empty object (`{}`).
+- `status`: HTTP status code for API response. Defaults to 200.
 
 ```ts
 // Configure GET /desktop/version.json to return test clientVersion
@@ -80,8 +164,8 @@ replace(
 )
 ```
 
--   `path`: the exact regular expression to replace or exact string value to replace.
--   `response`: see [add](#add)
+- `path`: the exact regular expression to replace or exact string value to replace.
+- `response`: see [add](#add)
 
 The `path` must exactly match a previously configured API response. Otherwise, the function does nothing.
 
@@ -116,9 +200,9 @@ mockComponent(
 )
 ```
 
--   `renderChildren`: Set to `true` to render both the component and it's children Defaults to `false`.
--   `renderProps`: Set to `true` to render the component's props. Defaults to `true`.
--   `forwardRef`: Set to `true` when mocking a component that is wrapped within `React.forwardRef`. Defaults to `false`.
+- `renderChildren`: Set to `true` to render both the component and it's children Defaults to `false`.
+- `renderProps`: Set to `true` to render the component's props. Defaults to `true`.
+- `forwardRef`: Set to `true` when mocking a component that is wrapped within `React.forwardRef`. Defaults to `false`.
 
 ```ts
 // Replace <BillingNewAdmin> component with placeholder
@@ -147,8 +231,8 @@ When called with a string, it sets `location.pathname`.
 
 Use the object signature to change either or both `location.origin` and `location.pathname`.
 
--   `origin`: new `location.origin`. Defaults to preserving previous value.
--   `pathname`: new `location.pathname`. Defaults to preserving previous value.
+- `origin`: new `location.origin`. Defaults to preserving previous value.
+- `pathname`: new `location.pathname`. Defaults to preserving previous value.
 
 To mock `window.location` without changing the value, pass an empty object.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-anvil-uikit-contrib",
-    "version": "34.0.0",
+    "version": "35.0.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "39c8bee0e01ce314dbdd07049e1d0851a03225ab"
+    "gitHead": "2d0ca381a54385f88a17412ea7382bc31da86696"
 }