@hubspot/ui-extensions 0.11.4 → 0.11.6

package/dist/{experimental/testing → testing}/internal/types-internal.d.ts

@@ -1,7 +1,9 @@
 import type { RemoteComponent, RemoteFragment, RemoteRoot, RemoteText } from '@remote-ui/core';
-import { ExtensionPointApi, ExtensionPointLocation } from '../../../shared/types/extension-points.ts';
-import { HubSpotReactComponent, UnknownComponentProps } from '../../../shared/types/shared.ts';
-import { useAssociations, useCrmProperties } from '../../../crm/index.ts';
+import { ExtensionPointApi, ExtensionPointLocation } from '../../shared/types/extension-points.ts';
+import { HubSpotReactComponent, UnknownComponentProps } from '../../shared/types/shared.ts';
+import { useAssociations, useCrmProperties } from '../../crm/index.ts';
+import { useExtensionContext } from '../../hooks/useExtensionContext.tsx';
+import { useExtensionActions } from '../../hooks/useExtensionActions.tsx';
 import type { ElementMatcher, RenderedElementNode, RenderedFragmentNode, RenderedNode, RenderedParentNode, RenderedRootNode, RenderedTextNode } from '../types.ts';
 export type RemoteChildNode = RemoteComponent<any, RemoteRoot> | RemoteText<RemoteRoot>;
 export type RemoteParentNode = RemoteRoot | RemoteComponent<any, RemoteRoot> | RemoteFragment;
@@ -59,6 +61,8 @@ export type RenderedNodeInternal = RenderedElementNodeInternal | RenderedTextNod
 export interface RendererMockHooksInternal {
     useCrmProperties: typeof useCrmProperties;
     useAssociations: typeof useAssociations;
+    useExtensionContext: typeof useExtensionContext;
+    useExtensionActions: typeof useExtensionActions;
 }
 export type RendererMocksInternal<TExtensionPointLocationName extends ExtensionPointLocation = ExtensionPointLocation> = RendererMockHooksInternal & ExtensionPointApi<TExtensionPointLocationName>;
 export type AnyFunction = (...args: any[]) => any;

package/dist/testing/internal/types-internal.js

@@ -0,0 +1 @@
+export {};

package/dist/{experimental/testing → testing}/render.d.ts

@@ -1,4 +1,4 @@
-import { ExtensionPointLocation } from '../../shared/types/extension-points.ts';
+import { ExtensionPointLocation } from '../shared/types/extension-points.ts';
 import { Renderer } from './types.ts';
 /**
  * Creates a renderer object with methods for rendering and testing UI extension components.

package/dist/{experimental/testing → testing}/render.js

@@ -4,8 +4,8 @@ import { createRoot as createReactRoot } from '@remote-ui/react';
 import { convertRemoteRoot } from "./internal/convert.js";
 import { createDocument } from "./internal/document.js";
 import { InvalidComponentsError, InvalidExtensionPointLocationError, WaitForTimeoutError, } from "./internal/errors.js";
-import { EXTENSION_POINT_LOCATIONS, } from "../../shared/types/extension-points.js";
-import { MocksContextProvider } from "../../internal/hook-utils.js";
+import { EXTENSION_POINT_LOCATIONS, } from "../shared/types/extension-points.js";
+import { MocksContextProvider } from "../internal/hook-utils.js";
 import { createMocksWithSpies } from "./internal/mocks/index.js";
 import { find, findAll, findAllChildren, findByTestId, findChild, maybeFind, maybeFindByTestId, maybeFindChild, } from "./internal/query.js";
 import { createRootNode } from "./internal/root.js";
@@ -21,7 +21,7 @@ const DEFAULT_WAIT_FOR_OPTIONS = {
  * @param node The React node to render.
  * @returns A render result object
  */
-const render = (node, mocks) => {
+const render = (node, mocksWithSpies) => {
     let dirty = true;
     let waitForChecksQueued = false;
     let waitForList = [];
@@ -75,7 +75,7 @@ const render = (node, mocks) => {
     };
     const remoteRoot = createRemoteRoot(remoteChannel);
     const reactRoot = createReactRoot(remoteRoot);
-    reactRoot.render(_jsx(MocksContextProvider, { value: mocks, children: node }));
+    reactRoot.render(_jsx(MocksContextProvider, { value: mocksWithSpies, children: node }));
     remoteRoot.mount();
     let maybeRenderedRootNode;
     /**
@@ -175,13 +175,13 @@ export const createRenderer = (extensionPointLocation) => {
         return renderResult;
     };
     const getLatestRootNode = () => getRenderResult().getLatestRootNode();
-    const { mocks, spies } = createMocksWithSpies(extensionPointLocation);
+    const { spies: mocksWithSpies } = createMocksWithSpies(extensionPointLocation);
     return {
         render: (node) => {
-            renderResult = render(node, mocks);
+            renderResult = render(node, mocksWithSpies);
             return asRenderedRootNode(renderResult.getLatestRootNode());
         },
-        mocks: spies,
+        mocks: mocksWithSpies,
         find: (component, matcher) => {
             return find(getLatestRootNode(), component, matcher);
         },

package/dist/{experimental/testing → testing}/types.d.ts

@@ -1,9 +1,11 @@
-import { ExtensionPointApi, ExtensionPointApiActions, ExtensionPointLocation } from '../../shared/types/extension-points.ts';
-import { ServerlessFuncRunner } from '../../shared/types/http-requests.ts';
+import { ExtensionPointApi, ExtensionPointApiActions, ExtensionPointLocation } from '../shared/types/extension-points.ts';
+import { ServerlessFuncRunner } from '../shared/types/http-requests.ts';
 import { SpyImpl } from 'tinyspy';
-import { HubSpotReactComponent, HubSpotReactFragmentProp, UnknownComponentProps } from '../../shared/types/shared.ts';
-import { useAssociations, useCrmProperties } from '../../crm/index.ts';
+import { HubSpotReactComponent, HubSpotReactFragmentProp, UnknownComponentProps } from '../shared/types/shared.ts';
+import { useAssociations, useCrmProperties } from '../crm/index.ts';
+import { useExtensionContext } from '../hooks/useExtensionContext.tsx';
 import { AnyFunction } from './internal/types-internal.ts';
+import { useExtensionActions } from '../hooks/useExtensionActions.tsx';
 /**
  * The type of a rendered node.
  */
@@ -258,7 +260,7 @@ export type ExtensionPointApiActionSpies<TExtensionPointLocation extends Extensi
 /**
  * An object containing the spies for the various functions.
  */
-export interface RendererSpies<TExtensionPointLocation extends ExtensionPointLocation> {
+export interface RendererSpies<TExtensionPointLocation extends ExtensionPointLocation = ExtensionPointLocation> {
     /**
      * A spy for the `useCrmProperties` hook function.
      * The spy can be used to track the calls to the hook function and also control the
@@ -277,6 +279,24 @@ export interface RendererSpies<TExtensionPointLocation extends ExtensionPointLoc
      * information about spies and the supported API.
      */
     useAssociations: FunctionSpy<typeof useAssociations>;
+    /**
+     * A spy for the `useExtensionContext` hook function.
+     * The spy can be used to track the calls to the hook function and also control the
+     * return result of the hook function.
+     *
+     * See the [tinyspy](https://github.com/tiny-spy/tinyspy) library for more
+     * information about spies and the supported API.
+     */
+    useExtensionContext: FunctionSpy<typeof useExtensionContext>;
+    /**
+     * A spy for the `useExtensionActions` hook function.
+     * The spy can be used to track the calls to the hook function and also control the
+     * return result of the hook function.
+     *
+     * See the [tinyspy](https://github.com/tiny-spy/tinyspy) library for more
+     * information about spies and the supported API.
+     */
+    useExtensionActions: FunctionSpy<typeof useExtensionActions>;
     /**
      * Mock context object that contains fake context data for the extension point API.
      */

package/dist/{experimental/testing → testing}/utils.d.ts

@@ -1,4 +1,4 @@
-import { type HubSpotReactComponent, type UnknownComponentProps } from '../../shared/types/shared.ts';
+import { type HubSpotReactComponent, type UnknownComponentProps } from '../shared/types/shared.ts';
 import { type ElementMatcher, type RenderedElementNode, type RenderedNode } from './types.ts';
 /**
  * Checks if the node matches the component and matcher.

package/dist/{experimental/testing → testing}/utils.js

@@ -1,5 +1,5 @@
 import { RenderedNodeType, } from "./types.js";
-import { __hubSpotComponentRegistry } from "../../shared/remoteComponents.js";
+import { __hubSpotComponentRegistry } from "../shared/remoteComponents.js";
 import { checkElementMatches } from "./internal/match.js";
 /**
  * Checks if the node matches the component and matcher.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions",
-  "version": "0.11.4",
+  "version": "0.11.6",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -28,7 +28,7 @@
     "./crm": "./dist/crm/index.js",
     "./pages/home": "./dist/pages/home/index.js",
     "./experimental": "./dist/experimental/index.js",
-    "./experimental/testing": "./dist/experimental/testing/index.js"
+    "./testing": "./dist/testing/index.js"
   },
   "license": "MIT",
   "dependencies": {
@@ -74,5 +74,5 @@
   "tsd": {
     "directory": "src/__tests__/test-d"
   },
-  "gitHead": "87edb81155e7376caa159611e6f2fd8e8c3dfdec"
+  "gitHead": "12a14abf6ad776b12204dc37467a7c665a806adb"
 }

package/dist/experimental/testing/__tests__/mocks.useAssociations.spec.js

@@ -1,47 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { describe, expect, it } from 'vitest';
-import { Text } from "../../../index.js";
-import { createRenderer } from "../index.js";
-import { useAssociations } from "../../../crm/index.js";
-function MyComponent() {
-    const { results, isLoading, error } = useAssociations({
-        toObjectType: '0-1',
-        properties: ['firstname', 'lastname'],
-        pageLength: 10,
-    });
-    if (isLoading) {
-        return _jsx(Text, { children: "Loading..." });
-    }
-    if (error) {
-        return _jsx(Text, { children: "Something went wrong!" });
-    }
-    return (_jsx(_Fragment, { children: results.map((result) => (_jsxs(Text, { children: [result.properties.firstname, " ", result.properties.lastname] }, result.toObjectId))) }));
-}
-describe('mock useAssociations', () => {
-    it('should provide a default mock implementation', () => {
-        const { render } = createRenderer('crm.record.tab');
-        const { findAll } = render(_jsx(MyComponent, {}));
-        const textNodes = findAll(Text);
-        expect(textNodes.length).toEqual(1);
-        expect(textNodes[0].text).toEqual('fake_firstname fake_lastname');
-    });
-    it('should allow mocking the next function result', () => {
-        const { render, mocks } = createRenderer('crm.record.tab');
-        mocks.useAssociations.nextResult({
-            results: [],
-            error: new Error('Something went wrong!'),
-            isLoading: false,
-            pagination: {
-                hasNextPage: false,
-                hasPreviousPage: false,
-                currentPage: 1,
-                pageSize: 10,
-                nextPage: () => { },
-                previousPage: () => { },
-                reset: () => { },
-            },
-        });
-        const { find } = render(_jsx(MyComponent, {}));
-        expect(find(Text).text).toEqual('Something went wrong!');
-    });
-});

package/dist/experimental/testing/__tests__/mocks.useCrmProperties.spec.js

@@ -1,58 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { describe, expect, it } from 'vitest';
-import { Text } from "../../../index.js";
-import { createRenderer } from "../index.js";
-import { useCrmProperties } from "../../../crm/index.js";
-function MyComponent() {
-    const { properties, isLoading, error } = useCrmProperties([
-        'firstname',
-        'lastname',
-    ]);
-    if (isLoading) {
-        return _jsx(Text, { children: "Loading..." });
-    }
-    if (error) {
-        return _jsx(Text, { children: "Something went wrong!" });
-    }
-    return (_jsxs(_Fragment, { children: [_jsxs(Text, { children: ["First name: ", properties.firstname] }), _jsxs(Text, { children: ["Last name: ", properties.lastname] })] }));
-}
-describe('mock useCrmProperties', () => {
-    it('should provide a default mock implementation', () => {
-        const { render } = createRenderer('crm.record.tab');
-        const { findAll } = render(_jsx(MyComponent, {}));
-        const textNodes = findAll(Text);
-        expect(textNodes.length).toEqual(2);
-        expect(textNodes[0].text).toEqual('First name: fake_firstname');
-        expect(textNodes[1].text).toEqual('Last name: fake_lastname');
-    });
-    it('should allow mocking the next function result', () => {
-        const { render, mocks } = createRenderer('crm.record.tab');
-        mocks.useCrmProperties.nextResult({
-            properties: {},
-            error: new Error('Something went wrong!'),
-            isLoading: false,
-        });
-        const { find } = render(_jsx(MyComponent, {}));
-        expect(find(Text).text).toEqual('Something went wrong!');
-    });
-    it('should allow providing a custom mock function', () => {
-        const { render, mocks, findAll } = createRenderer('crm.record.tab');
-        mocks.useCrmProperties.willCall((propertyNames) => {
-            const properties = propertyNames.reduce((acc, propertyName) => {
-                acc[propertyName] = propertyName.toUpperCase();
-                return acc;
-            }, {});
-            return {
-                properties,
-                error: null,
-                isLoading: false,
-            };
-        });
-        render(_jsx(MyComponent, {}));
-        const textNodes = findAll(Text);
-        const firstNameText = textNodes[0];
-        const lastNameText = textNodes[1];
-        expect(firstNameText.isMatch(Text) && firstNameText.text).toEqual('First name: FIRSTNAME');
-        expect(lastNameText.isMatch(Text) && lastNameText.text).toEqual('Last name: LASTNAME');
-    });
-});

package/dist/experimental/testing/internal/mocks/mock-hooks.d.ts

@@ -1,2 +0,0 @@
-import { RendererMockHooksInternal } from '../types-internal.ts';
-export declare const createMockHooks: () => RendererMockHooksInternal;