@hubspot/ui-extensions 0.13.0 → 0.13.1

package/dist/shared/types/hooks.d.ts

@@ -0,0 +1,72 @@
+export interface PaginationResult {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    currentPage: number;
+    pageSize: number;
+    nextPage: () => void;
+    previousPage: () => void;
+    reset: () => void;
+}
+export type FormattingOptions = {
+    date?: {
+        format?: string;
+        relative?: boolean;
+    };
+    dateTime?: {
+        format?: string;
+        relative?: boolean;
+    };
+    currency?: {
+        addSymbol?: boolean;
+    };
+};
+export type FetchHookOptions = {
+    propertiesToFormat?: string[] | 'all';
+    formattingOptions?: FormattingOptions;
+};
+export type CrmSearchFilter = {
+    propertyName: string;
+    operator: string;
+    value?: string | number | boolean;
+    values?: (string | number | boolean)[];
+    highValue?: string | number | boolean;
+};
+export type CrmSearchFilterGroup = {
+    filters: CrmSearchFilter[];
+};
+export type CrmSearchSort = {
+    propertyName: string;
+    direction: 'ASCENDING' | 'DESCENDING';
+};
+export type FetchCrmSearchRequest = {
+    objectType: string;
+    properties?: string[];
+    query?: string;
+    filterGroups?: CrmSearchFilterGroup[];
+    sorts?: CrmSearchSort[];
+    pageSize?: number;
+    after?: string;
+};
+export type CrmSearchResultItem = {
+    objectId: number;
+    properties: Record<string, string | null>;
+};
+export type CrmSearchResponse = {
+    results: CrmSearchResultItem[];
+    total: number;
+    hasMore: boolean;
+    after?: string;
+};
+export type UseCrmSearchOptions = {
+    propertiesToFormat?: 'all' | string[];
+    formattingOptions?: FetchHookOptions['formattingOptions'];
+};
+export interface UseCrmSearchResult {
+    results: CrmSearchResultItem[];
+    total: number;
+    error: Error | null;
+    isLoading: boolean;
+    isRefetching: boolean;
+    pagination: PaginationResult;
+    refetch: () => Promise<void>;
+}

package/dist/shared/types/hooks.js

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

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

@@ -1,5 +1,6 @@
 import type { HubspotExtendFunction } from './extend.ts';
 import type { ExtensionPointApiActions, ExtensionPointApiContext, ExtensionPointFullApi, ExtensionPoints } from './extension-points.ts';
+import type { FetchCrmSearchRequest, FetchHookOptions } from './hooks.ts';
 import type { Logger } from './logger.ts';
 import type { AppPageLocation } from './shared.ts';
 export interface WorkersApi {
@@ -19,6 +20,10 @@ export interface WorkersApi {
      * Hook added to worker globals so page router can access the current app page location at runtime.
      */
     useAppPageLocation: () => AppPageLocation;
+    /**
+     * Runner for the CRM search hook, proxies search requests to the host.
+     */
+    fetchCrmSearch: (request: FetchCrmSearchRequest, options?: FetchHookOptions) => Promise<Response>;
 }
 export interface WorkerGlobalsInternal {
     /**

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

@@ -67,6 +67,32 @@ export const createMockHooks = () => {
                 },
             };
         },
+        useCrmSearch: (config) => {
+            const { properties: propertyNames } = config;
+            const properties = createFakeProperties(propertyNames);
+            return {
+                results: [
+                    {
+                        objectId: 456,
+                        properties,
+                    },
+                ],
+                total: 1,
+                error: null,
+                isLoading: false,
+                isRefetching: false,
+                refetch: async () => { },
+                pagination: {
+                    hasNextPage: false,
+                    hasPreviousPage: false,
+                    currentPage: 1,
+                    pageSize: 10,
+                    nextPage: () => { },
+                    previousPage: () => { },
+                    reset: () => { },
+                },
+            };
+        },
         useExtensionContext: () => {
             const { mocks } = useRequiredMocksContext();
             return mocks.context;

package/dist/testing/internal/types-internal.d.ts

@@ -1,5 +1,6 @@
 import type { RemoteComponent, RemoteFragment, RemoteRoot, RemoteText } from '@remote-ui/core';
 import type { useAssociations, useCrmProperties } from '../../crm/index.ts';
+import type { useCrmSearch } from '../../experimental/hooks/useCrmSearch.ts';
 import type { useExtensionActions } from '../../hooks/useExtensionActions.tsx';
 import type { useExtensionApi } from '../../hooks/useExtensionApi.tsx';
 import type { useExtensionContext } from '../../hooks/useExtensionContext.tsx';
@@ -62,6 +63,7 @@ export type RenderedNodeInternal = RenderedElementNodeInternal | RenderedTextNod
 export interface RendererMockHooksInternal {
     useCrmProperties: typeof useCrmProperties;
     useAssociations: typeof useAssociations;
+    useCrmSearch: typeof useCrmSearch;
     useExtensionContext: typeof useExtensionContext;
     useExtensionActions: typeof useExtensionActions;
     useExtensionApi: typeof useExtensionApi;

package/dist/testing/types.d.ts

@@ -1,5 +1,6 @@
 import type { SpyImpl } from 'tinyspy';
 import type { useAssociations, useCrmProperties } from '../crm/index.ts';
+import type { useCrmSearch } from '../experimental/hooks/useCrmSearch.ts';
 import type { useExtensionActions } from '../hooks/useExtensionActions.tsx';
 import type { useExtensionApi } from '../hooks/useExtensionApi.tsx';
 import type { useExtensionContext } from '../hooks/useExtensionContext.tsx';
@@ -281,6 +282,15 @@ export interface RendererMocks<TExtensionPointLocation extends ExtensionPointLoc
      * information about spies and the supported API.
      */
     useAssociations: FunctionSpy<typeof useAssociations>;
+    /**
+     * A spy for the `useCrmSearch` 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.
+     */
+    useCrmSearch: FunctionSpy<typeof useCrmSearch>;
     /**
      * A spy for the `useExtensionContext` hook function.
      * The spy can be used to track the calls to the hook function and also control the

package/dist/utils/pagination.d.ts

@@ -1,12 +1,3 @@
-export interface PaginationResult {
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-    currentPage: number;
-    pageSize: number;
-    nextPage: () => void;
-    previousPage: () => void;
-    reset: () => void;
-}
 export declare const DEFAULT_PAGE_SIZE = 10;
 /**
  * Calculate pagination flags based on current page and API hasMore flag

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hubspot/ui-extensions",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "description": "",
   "type": "module",
   "main": "dist/index.js",
@@ -77,6 +77,7 @@
     "format:check": "prettier --check . --ignore-path ../../.prettierignore",
     "lint": "eslint src/",
     "lint:fix": "eslint src/ --fix",
+    "generate": "node scripts/generate-version.js",
     "tsc": "tsc",
     "test": "vitest run && tsd",
     "test:coverage": "vitest run --coverage",