@hubspot/ui-extensions 0.11.5 → 0.12.0

package/dist/shared/types/shared.js

@@ -18,151 +18,196 @@ export class FormSubmitExtensionEvent extends ExtensionEvent {
     }
 }
 export const iconNames = {
-    success: 'success',
-    remove: 'remove',
     add: 'add',
+    appointment: 'appointment',
+    approvals: 'approvals',
+    artificialIntelligence: 'artificialIntelligence',
+    artificialIntelligenceEnhanced: 'artificialIntelligenceEnhanced',
     attach: 'attach',
-    date: 'date',
+    bank: 'bank',
+    block: 'block',
+    book: 'knowledgeBase',
+    bulb: 'bulb',
+    callTranscript: 'callTranscript',
+    calling: 'calling',
+    callingHangup: 'callingHangup',
+    callingMade: 'callingMade',
+    callingMissed: 'callingMissed',
+    callingVoicemail: 'callingVoicemail',
+    campaigns: 'campaigns',
+    cap: 'cap',
+    checkCircle: 'checkCircle',
+    circleFilled: 'circleFilled',
+    circleHollow: 'circleHollow',
+    clock: 'time',
+    comment: 'comments',
+    contact: 'contacts',
     copy: 'duplicate',
+    crm: 'crm',
+    dataSync: 'dataSync',
+    date: 'date',
+    delay: 'delay',
     delete: 'delete',
+    description: 'description',
+    developerProjects: 'developerProjects',
+    documents: 'documents',
+    downCarat: 'downCarat',
+    download: 'download',
     edit: 'edit',
+    ellipses: 'ellipses',
     email: 'email',
+    emailOpen: 'emailOpen',
+    emailThreadedReplies: 'emailThreadedReplies',
+    enrichment: 'enrichment',
+    enroll: 'enroll',
     exclamation: 'exclamation',
-    question: 'question',
-    home: 'home',
-    location: 'location',
-    upCarat: 'upCarat',
-    downCarat: 'downCarat',
-    warning: 'warning',
-    shoppingCart: 'cart',
-    clock: 'time',
-    comment: 'comments',
-    contact: 'contacts',
-    star: 'favorite',
-    file: 'file',
-    reports: 'reports',
-    video: 'video',
-    robot: 'simpleBot',
-    refresh: 'refresh',
+    exclamationCircle: 'exclamationCircle',
     faceHappy: 'emoji',
+    faceHappyFilled: 'emojiFillHappy',
     faceNeutral: 'emojiLineNeutral',
+    faceNeutralFilled: 'emojiFillNeutral',
     faceSad: 'emojiLineSad',
-    upload: 'upload',
-    download: 'download',
-    left: 'left',
-    right: 'right',
-    dataSync: 'dataSync',
-    imageGallery: 'imageGallery',
-    search: 'search',
-    save: 'saveEditableView',
-    notification: 'notification',
-    bulb: 'bulb',
-    settings: 'settings',
+    faceSadFilled: 'emojiFillSad',
+    facebook: 'socialBlockFacebook',
+    favoriteHollow: 'favoriteHollow',
+    file: 'file',
+    filledXCircleIcon: 'filledXCircleIcon',
     filter: 'filter',
+    flame: 'highlyEngagedLead',
+    folder: 'folder',
+    folderOpen: 'folderOpen',
+    forward: 'forward',
     gauge: 'gauge',
-    enroll: 'enroll',
     generateChart: 'generateChart',
     gift: 'gift',
-    flame: 'highlyEngagedLead',
-    inbox: 'inbox',
+    globe: 'language',
+    globeLine: 'globe',
+    goal: 'goal',
+    googlePlus: 'socialBlockGoogleplus',
+    guidedActions: 'guidedActions',
+    hash: 'numericDataType',
+    hide: 'hide',
+    home: 'home',
+    hubDB: 'hubDB',
     image: 'insertImage',
-    quote: 'insertQuote',
+    imageGallery: 'imageGallery',
+    inbox: 'inbox',
+    info: 'info',
+    infoNoCircle: 'infoNoCircle',
     insertVideo: 'insertVideo',
+    instagram: 'socialBlockInstagram',
+    integrations: 'integrations',
     invoice: 'invoice',
     key: 'key',
-    book: 'knowledgeBase',
-    globe: 'language',
+    language: 'language',
+    left: 'left',
+    lessCircle: 'lessCircle',
     lesson: 'lesson',
+    light: 'light',
     link: 'link',
+    linkedin: 'socialBlockLinkedin',
     listView: 'listView',
+    location: 'location',
     locked: 'locked',
     mention: 'mention',
     messages: 'messages',
     mobile: 'mobile',
+    moreCircle: 'moreCircle',
+    notEditable: 'notEditable',
+    notification: 'notification',
     notificationOff: 'notificationOff',
-    hash: 'numericDataType',
     objectAssociations: 'objectAssociations',
     objectAssociationsManyToMany: 'objectAssociationsManyToMany',
     objectAssociationsManyToOne: 'objectAssociationsManyToOne',
     office365: 'office365',
     order: 'order',
     paymentSubscriptions: 'paymentSubscriptions',
-    product: 'product',
+    pin: 'pin',
+    pinterest: 'socialBlockPinterest',
     powerPointFile: 'powerPointFile',
     presentation: 'presentation',
+    product: 'product',
     publish: 'publish',
+    question: 'question',
     questionAnswer: 'questionAnswer',
+    questionCircle: 'questionCircle',
     quickbooks: 'quickbooks',
+    quote: 'insertQuote',
     readMore: 'readMore',
-    realEstateListing: 'realEstateListing',
     readOnlyView: 'readOnlyView',
+    realEstateListing: 'realEstateListing',
     recentlySelected: 'recentlySelected',
     record: 'record',
     redo: 'redo',
-    undo: 'undo',
+    refresh: 'refresh',
     registration: 'registration',
+    remove: 'remove',
     replace: 'replace',
+    reports: 'reports',
+    right: 'right',
+    robot: 'simpleBot',
     rotate: 'rotate',
+    rss: 'socialBlockRss',
     salesQuote: 'salesQuote',
     salesTemplates: 'salesTemplates',
+    save: 'saveEditableView',
+    search: 'search',
+    send: 'send',
     sequences: 'sequences',
+    settings: 'settings',
+    shoppingCart: 'cart',
+    signal: 'signal',
+    signalPoor: 'signalPoor',
+    signature: 'signature',
+    snooze: 'snooze',
+    sortAlpAsc: 'sortAlpAsc',
+    sortAlpDesc: 'sortAlpDesc',
+    sortAmtAsc: 'sortAmtAsc',
+    sortAmtDesc: 'sortAmtDesc',
+    sortNumAsc: 'sortNumAsc',
+    sortNumDesc: 'sortNumDesc',
+    sortTableAsc: 'sortTableAsc',
+    sortTableDesc: 'sortTableDesc',
     spellCheck: 'spellCheck',
+    sprocket: 'sprocket',
+    star: 'favorite',
+    stopRecord: 'stopRecord',
     strike: 'strike',
+    styles: 'styles',
+    success: 'success',
     tablet: 'tablet',
     tag: 'tag',
     tasks: 'tasks',
     test: 'test',
-    ticket: 'ticket',
-    thumbsUp: 'thumbsUp',
+    text: 'text',
+    textBodyExpanded: 'textBodyExpanded',
+    textColor: 'textColor',
+    textDataType: 'textDataType',
+    textSnippet: 'textSnippet',
     thumbsDown: 'thumbsDown',
+    thumbsUp: 'thumbsUp',
+    ticket: 'ticket',
     translate: 'translate',
     trophy: 'trophy',
+    twitter: 'socialBlockTwitter',
+    undo: 'undo',
+    upCarat: 'upCarat',
+    upload: 'upload',
+    video: 'video',
     videoFile: 'videoFile',
     videoPlayerSubtitles: 'videoPlayerSubtitles',
     view: 'view',
     viewDetails: 'viewDetails',
+    warning: 'warning',
     website: 'website',
     workflows: 'workflows',
-    zoomIn: 'zoomIn',
-    zoomOut: 'zoomOut',
-    goal: 'goal',
-    campaigns: 'campaigns',
-    cap: 'cap',
-    block: 'block',
-    bank: 'bank',
-    approvals: 'approvals',
-    appointment: 'appointment',
-    facebook: 'socialBlockFacebook',
-    googlePlus: 'socialBlockGoogleplus',
-    instagram: 'socialBlockInstagram',
-    linkedin: 'socialBlockLinkedin',
-    pinterest: 'socialBlockPinterest',
-    rss: 'socialBlockRss',
-    twitter: 'socialBlockTwitter',
     x: 'socialBlockX',
+    xCircle: 'xCircle',
     xing: 'socialBlockXing',
     youtube: 'socialBlockYoutube',
     youtubePlay: 'socialBlockYoutubeplay',
-    sortAlpAsc: 'sortAlpAsc',
-    sortAlpDesc: 'sortAlpDesc',
-    sortAmtAsc: 'sortAmtAsc',
-    sortAmtDesc: 'sortAmtDesc',
-    sortNumAsc: 'sortNumAsc',
-    sortNumDesc: 'sortNumDesc',
-    sortTableAsc: 'sortTableAsc',
-    sortTableDesc: 'sortTableDesc',
-    text: 'text',
-    textColor: 'textColor',
-    textDataType: 'textDataType',
-    textSnippet: 'textSnippet',
-    calling: 'calling',
-    callingHangup: 'callingHangup',
-    callingMade: 'callingMade',
-    callingMissed: 'callingMissed',
-    callingVoicemail: 'callingVoicemail',
-    faceHappyFilled: 'emojiFillHappy',
-    faceNeutralFilled: 'emojiFillNeutral',
-    faceSadFilled: 'emojiFillSad',
+    zoomIn: 'zoomIn',
+    zoomOut: 'zoomOut',
 };
 /** @deprecated use ExtensionEvent/FormSubmitExtensionEvent instead */
 export class RemoteEvent {

package/dist/shared/types/worker-globals.d.ts

@@ -1,6 +1,16 @@
 import { Logger } from './logger.ts';
 import { HubspotExtendFunction } from './extend.ts';
 import type { ExtensionPoints, ExtensionPointApiContext, ExtensionPointApiActions } from './extension-points.ts';
+export interface WorkersApi {
+    /**
+     * Hook added to worker globals so customer code can access extension context at runtime.
+     */
+    useExtensionContext: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiContext<ExtensionPoint>;
+    /**
+     * Hook added to worker globals so customer code can access extension actions at runtime.
+     */
+    useExtensionActions: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiActions<ExtensionPoint>;
+}
 export interface WorkerGlobalsInternal {
     /**
      * A marker that the current global is a HubSpot extension worker.
@@ -19,14 +29,5 @@ export interface WorkerGlobalsInternal {
      * Namespace where all HubSpot APIs that go on the worker should live.
      * This avoids polluting the global and reduces the possibility of customer code having collisions with our code.
      */
-    hsWorkerAPI: {
-        /**
-         * Hook added to worker globals so customer code can access extension context at runtime.
-         */
-        useExtensionContext: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiContext<ExtensionPoint>;
-        /**
-         * Hook added to worker globals so customer code can access extension actions at runtime.
-         */
-        useExtensionActions: <ExtensionPoint extends keyof ExtensionPoints>() => ExtensionPointApiActions<ExtensionPoint>;
-    };
+    hsWorkerAPI: WorkersApi;
 }

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

@@ -1,10 +1,10 @@
 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 { describe, expect, it, vi } from 'vitest';
+import { Text, Button } from "../../index.js";
 import { createRenderer } from "../index.js";
 import { useAssociations } from "../../crm/index.js";
 function MyComponent() {
-    const { results, isLoading, error } = useAssociations({
+    const { results, isLoading, isRefetching, error, refetch } = useAssociations({
         toObjectType: '0-1',
         properties: ['firstname', 'lastname'],
         pageLength: 10,
@@ -12,10 +12,13 @@ function MyComponent() {
     if (isLoading) {
         return _jsx(Text, { children: "Loading..." });
     }
+    if (isRefetching) {
+        return _jsx(Text, { children: "Refetching..." });
+    }
     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))) }));
+    return (_jsxs(_Fragment, { children: [results.map((result) => (_jsxs(Text, { children: [result.properties.firstname, " ", result.properties.lastname] }, result.toObjectId))), _jsx(Button, { testId: "refetchButton", onClick: () => refetch(), children: "Refetch" })] }));
 }
 describe('mock useAssociations', () => {
     it('should provide a default mock implementation', () => {
@@ -31,6 +34,8 @@ describe('mock useAssociations', () => {
             results: [],
             error: new Error('Something went wrong!'),
             isLoading: false,
+            isRefetching: false,
+            refetch: async () => { },
             pagination: {
                 hasNextPage: false,
                 hasPreviousPage: false,
@@ -44,4 +49,87 @@ describe('mock useAssociations', () => {
         const { find } = render(_jsx(MyComponent, {}));
         expect(find(Text).text).toEqual('Something went wrong!');
     });
+    it('should allow tracking refetch calls with a custom spy', () => {
+        const { render, mocks, findByTestId } = createRenderer('crm.record.tab');
+        const refetchSpy = vi.fn().mockResolvedValue(undefined);
+        mocks.useAssociations.nextResult({
+            results: [
+                {
+                    toObjectId: 1,
+                    associationTypes: [],
+                    properties: { firstname: 'John', lastname: 'Doe' },
+                },
+            ],
+            error: null,
+            isLoading: false,
+            isRefetching: false,
+            refetch: refetchSpy,
+            pagination: {
+                hasNextPage: false,
+                hasPreviousPage: false,
+                currentPage: 1,
+                pageSize: 10,
+                nextPage: () => { },
+                previousPage: () => { },
+                reset: () => { },
+            },
+        });
+        render(_jsx(MyComponent, {}));
+        findByTestId(Button, 'refetchButton').trigger('onClick');
+        expect(refetchSpy).toHaveBeenCalledTimes(1);
+    });
+    it('should allow mocking isRefetching state during refetch', () => {
+        const { render, mocks } = createRenderer('crm.record.tab');
+        mocks.useAssociations.nextResult({
+            results: [],
+            error: null,
+            isLoading: false,
+            isRefetching: true,
+            refetch: async () => { },
+            pagination: {
+                hasNextPage: false,
+                hasPreviousPage: false,
+                currentPage: 1,
+                pageSize: 10,
+                nextPage: () => { },
+                previousPage: () => { },
+                reset: () => { },
+            },
+        });
+        const { find } = render(_jsx(MyComponent, {}));
+        expect(find(Text).text).toEqual('Refetching...');
+    });
+    it('should allow providing a custom refetch implementation', () => {
+        const { render, mocks, findByTestId } = createRenderer('crm.record.tab');
+        const refetchSpy = vi.fn().mockResolvedValue(undefined);
+        const customData = { customKey: 'customValue' };
+        mocks.useAssociations.nextResult({
+            results: [
+                {
+                    toObjectId: 1,
+                    associationTypes: [],
+                    properties: { firstname: 'Test', lastname: 'User' },
+                },
+            ],
+            error: null,
+            isLoading: false,
+            isRefetching: false,
+            refetch: async () => {
+                await refetchSpy(customData);
+            },
+            pagination: {
+                hasNextPage: false,
+                hasPreviousPage: false,
+                currentPage: 1,
+                pageSize: 10,
+                nextPage: () => { },
+                previousPage: () => { },
+                reset: () => { },
+            },
+        });
+        render(_jsx(MyComponent, {}));
+        findByTestId(Button, 'refetchButton').trigger('onClick');
+        expect(refetchSpy).toHaveBeenCalledTimes(1);
+        expect(refetchSpy).toHaveBeenCalledWith(customData);
+    });
 });

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

@@ -1,20 +1,20 @@
 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 { describe, expect, it, vi } from 'vitest';
+import { Text, Button } from "../../index.js";
 import { createRenderer } from "../index.js";
 import { useCrmProperties } from "../../crm/index.js";
 function MyComponent() {
-    const { properties, isLoading, error } = useCrmProperties([
-        'firstname',
-        'lastname',
-    ]);
+    const { properties, isLoading, isRefetching, error, refetch } = useCrmProperties(['firstname', 'lastname']);
     if (isLoading) {
         return _jsx(Text, { children: "Loading..." });
     }
+    if (isRefetching) {
+        return _jsx(Text, { children: "Refetching..." });
+    }
     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] })] }));
+    return (_jsxs(_Fragment, { children: [_jsxs(Text, { children: ["First name: ", properties.firstname] }), _jsxs(Text, { children: ["Last name: ", properties.lastname] }), _jsx(Button, { testId: "refetchButton", onClick: () => refetch(), children: "Refetch" })] }));
 }
 describe('mock useCrmProperties', () => {
     it('should provide a default mock implementation', () => {
@@ -31,6 +31,8 @@ describe('mock useCrmProperties', () => {
             properties: {},
             error: new Error('Something went wrong!'),
             isLoading: false,
+            isRefetching: false,
+            refetch: () => Promise.resolve(),
         });
         const { find } = render(_jsx(MyComponent, {}));
         expect(find(Text).text).toEqual('Something went wrong!');
@@ -46,6 +48,8 @@ describe('mock useCrmProperties', () => {
                 properties,
                 error: null,
                 isLoading: false,
+                isRefetching: false,
+                refetch: async () => { },
             };
         });
         render(_jsx(MyComponent, {}));
@@ -55,4 +59,48 @@ describe('mock useCrmProperties', () => {
         expect(firstNameText.isMatch(Text) && firstNameText.text).toEqual('First name: FIRSTNAME');
         expect(lastNameText.isMatch(Text) && lastNameText.text).toEqual('Last name: LASTNAME');
     });
+    it('should allow tracking refetch calls with a custom spy', () => {
+        const { render, mocks, findByTestId } = createRenderer('crm.record.tab');
+        const refetchSpy = vi.fn().mockResolvedValue(undefined);
+        mocks.useCrmProperties.nextResult({
+            properties: { firstname: 'John', lastname: 'Doe' },
+            error: null,
+            isLoading: false,
+            isRefetching: false,
+            refetch: refetchSpy,
+        });
+        render(_jsx(MyComponent, {}));
+        findByTestId(Button, 'refetchButton').trigger('onClick');
+        expect(refetchSpy).toHaveBeenCalledTimes(1);
+    });
+    it('should allow mocking isRefetching state during refetch', () => {
+        const { render, mocks } = createRenderer('crm.record.tab');
+        mocks.useCrmProperties.nextResult({
+            properties: {},
+            error: null,
+            isLoading: false,
+            isRefetching: true,
+            refetch: async () => { },
+        });
+        const { find } = render(_jsx(MyComponent, {}));
+        expect(find(Text).text).toEqual('Refetching...');
+    });
+    it('should allow providing a custom refetch implementation', () => {
+        const { render, mocks, findByTestId } = createRenderer('crm.record.tab');
+        const refetchSpy = vi.fn().mockResolvedValue(undefined);
+        const customData = { customKey: 'customValue' };
+        mocks.useCrmProperties.nextResult({
+            properties: { firstname: 'Test Value', lastname: 'Test' },
+            error: null,
+            isLoading: false,
+            isRefetching: false,
+            refetch: async () => {
+                await refetchSpy(customData);
+            },
+        });
+        render(_jsx(MyComponent, {}));
+        findByTestId(Button, 'refetchButton').trigger('onClick');
+        expect(refetchSpy).toHaveBeenCalledTimes(1);
+        expect(refetchSpy).toHaveBeenCalledWith(customData);
+    });
 });

package/dist/testing/internal/mocks/mock-hooks.js

@@ -24,6 +24,8 @@ export const createMockHooks = () => {
                 properties,
                 error: null,
                 isLoading: false,
+                isRefetching: false,
+                refetch: async () => { },
             };
         },
         useAssociations: (config) => {
@@ -45,6 +47,8 @@ export const createMockHooks = () => {
                 ],
                 error: null,
                 isLoading: false,
+                isRefetching: false,
+                refetch: async () => { },
                 pagination: {
                     hasNextPage: false,
                     hasPreviousPage: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions",
-  "version": "0.11.5",
+  "version": "0.12.0",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -28,7 +28,8 @@
     "./crm": "./dist/crm/index.js",
     "./pages/home": "./dist/pages/home/index.js",
     "./experimental": "./dist/experimental/index.js",
-    "./testing": "./dist/testing/index.js"
+    "./testing": "./dist/testing/index.js",
+    "./hs-internal": "./dist/hs-internal/index.js"
   },
   "license": "MIT",
   "dependencies": {
@@ -74,5 +75,5 @@
   "tsd": {
     "directory": "src/__tests__/test-d"
   },
-  "gitHead": "e262c2b6780bb1f65bd09b1df4a2e724cd627c19"
+  "gitHead": "c5b66da065a341df3afd98ce6641bb3e6317aeb4"
 }