@hubspot/ui-extensions 0.12.1 → 0.12.3

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

@@ -1,6 +1,5 @@
-import { ReactNode } from 'react';
-import { TShirtSizes, BaseComponentProps } from './shared.ts';
-/** @ignore */
+import type { ReactNode } from 'react';
+import type { BaseComponentProps, TShirtSizes } from './shared.ts';
 export interface CrmDataHighlightProps extends BaseComponentProps {
     /**
      * The properties to display, up to four. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props.
@@ -15,7 +14,6 @@ export interface CrmDataHighlightProps extends BaseComponentProps {
      */
     objectId?: number;
 }
-/** @ignore */
 export interface CrmReportProps extends BaseComponentProps {
     /**
      * The numeric ID of the single object report, which can be found in the URL when viewing the report in HubSpot.
@@ -31,7 +29,6 @@ export interface CrmReportProps extends BaseComponentProps {
      */
     use?: 'associations' | 'subject' | 'unfiltered';
 }
-/** @ignore */
 export interface CrmPropertyListProps extends BaseComponentProps {
     /**
      * The properties to display, up to 24. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props.
@@ -52,12 +49,10 @@ export interface CrmPropertyListProps extends BaseComponentProps {
      */
     objectId?: number;
 }
-/** @ignore */
 type CrmSortDescriptor = {
     columnName: string;
     direction: 1 | -1;
 };
-/** @ignore */
 interface CrmSearchFilter {
     operator: 'EQ' | 'NEQ' | 'LT' | 'LTE' | 'GT' | 'GTE' | 'BETWEEN' | 'IN' | 'NOT_IN' | 'HAS_PROPERTY' | 'NOT_HAS_PROPERTY';
     value?: string | number;
@@ -65,56 +60,132 @@ interface CrmSearchFilter {
     highValue?: string | number;
     property: string;
 }
-/** @ignore */
 export interface CrmAssociationTableProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs.
+     */
     objectTypeId: string;
+    /**
+     * The properties to display as table columns.
+     */
     propertyColumns: Array<string>;
+    /**
+     * The properties that appear as filters above the table. When included, the "Association label" quick filter will always display. See note below for more details on this prop.
+     */
     quickFilterProperties?: Array<string>;
+    /**
+     * When set to `false`, hides the search bar above the table.
+     */
     searchable?: boolean;
+    /**
+     * When set to `false`, hides the pagination navigation below the table.
+     */
     pagination?: boolean;
+    /**
+     * When set to `false`, hides the "Association label" quick filter above the table.
+     */
     associationLabelFilter?: boolean;
+    /**
+     * The number of rows to include per page of results. Include the `pagination` property to enable users to navigate through returned results.
+     */
     pageSize?: number;
+    /**
+     * Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information.
+     */
     preFilters?: Array<CrmSearchFilter>;
+    /**
+     * The default sorting behavior for the table. In each sort object in the array, you'll specify the following:
+     * - `columnName`: the column to sort by.
+     * - `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending.
+     */
     sort?: Array<CrmSortDescriptor>;
 }
-/** @ignore */
 export interface CrmAssociationPivotProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs.
+     */
     objectTypeId: string;
+    /**
+     * Filters results by specific association labels. By default, all association labels will appear.
+     */
     associationLabels?: Array<string>;
+    /**
+     * The number of items to return in each association label group before displaying a "Show more" button.
+     */
     maxAssociations?: number;
+    /**
+     * Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information.
+     */
     preFilters?: Array<CrmSearchFilter>;
+    /**
+     * The default sorting behavior for the table. In the array, you'll include an object for the column you want to sort by, which specifies:
+     * - `columnName`: the column to sort by.
+     * - `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending.
+     */
     sort?: Array<CrmSortDescriptor>;
 }
-/** @ignore */
 export interface CrmAssociationStageTrackerProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the type of associated object to display data from (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs.
+     */
     objectTypeId: string;
+    /**
+     * The properties of the associated records to display, up to four.
+     */
     properties: Array<string>;
+    /**
+     * If provided, will only request a list of associated records with the specified label (case sensitive).
+     */
     associationLabels?: Array<string>;
+    /**
+     * If provided, the component will request a list of associated records that match the specified criteria. Learn more about [filtering in CRM data components](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data).
+     */
     filters?: Array<CrmSearchFilter>;
+    /**
+     * Whether to display the properties below the progress indicator. When set to `false`, properties will not display.
+     */
     showProperties?: boolean;
+    /**
+     * If provided, overrides the default sorting rules used in the search query. In the array, you'll include an object for the column you want to sort by, which specifies:
+     * - `columnName`: the column to sort by.
+     * - `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending.
+     */
     sort?: Array<CrmSortDescriptor>;
 }
-/** @ignore */
 export interface CrmSimpleDeadlineProps extends BaseComponentProps {
+    /**
+     * The name of the property that contains the deadline date.
+     */
     endDatePropertyName: string;
+    /**
+     * The properties to display below the progress bar.
+     */
     properties: Array<string>;
+    /**
+     * The theme to apply to the progress bar.
+     */
     progressTheme?: ProgressTheme;
+    /**
+     * Whether to show provided properties below the progress bar.
+     */
     showProperties?: boolean;
+    /**
+     * The name of the property that contains the start date.
+     */
     startDatePropertyName: string;
 }
-/** @ignore */
 export interface CrmRelativeTimelineProps {
+    /**
+     * The names of the properties to display.
+     */
     properties: Array<string>;
 }
-/** @ignore */
 interface BaseCrmStatisticItem {
     label: string;
 }
-/** @ignore */
 interface FilterGroup {
     filters: Array<CrmSearchFilter>;
 }
-/** @ignore */
 interface ProgressTheme {
     backgroundColor?: string;
     completedColor?: string;
@@ -124,16 +195,13 @@ interface ProgressTheme {
     completedGradient?: Gradient;
     upcomingGradient?: Gradient;
 }
-/** @ignore */
 interface PercentileMetricItem extends BaseCrmStatisticItem {
     statisticType: 'PERCENTILES';
     propertyName: string;
     percentile: number;
     filterGroups?: Array<FilterGroup>;
 }
-/** @ignore */
 type CrmStatisticItem = BasicMetricItem | PercentileMetricItem;
-/** @ignore */
 export interface CrmStatisticsProps extends BaseComponentProps {
     /**
      * The numeric ID of the type of object to fetch statistics about (e.g., `0-1` for contacts).
@@ -144,50 +212,61 @@ export interface CrmStatisticsProps extends BaseComponentProps {
      */
     statistics: Array<CrmStatisticItem>;
 }
-/** @ignore */
 interface BasicMetricItem extends BaseCrmStatisticItem {
     statisticType: 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'DISTINCT_APPROX' | 'COUNT';
     propertyName: string;
     filterGroups?: Array<FilterGroup>;
 }
-/** @ignore */
 interface Gradient {
     startColor: string;
     endColor: string;
 }
-/** @ignore */
 export interface CrmStageTrackerProps extends BaseComponentProps {
     /**
      * The ID of the CRM record to display property data from.
      */
     objectId?: number;
     /**
-     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts).
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs.
      */
     objectTypeId?: string;
     /**
-     * The properties to display, up to four. By default, will display property data from the currently displaying record.
+     * The properties to display, up to four. By default, will display property data from the currently displaying record. To pull data from a specific record, include the `objectTypeId` and `objectId` props.
      */
     properties: Array<string>;
     /**
-     * Whether to display the properties below the progress indicator.
+     * Whether to display the properties below the progress indicator. When set to `false`, properties will not display.
      */
     showProperties?: boolean;
 }
-/** @ignore */
 export interface CrmAssociationPropertyListProps extends BaseComponentProps {
+    /**
+     * The numeric ID of the type of associated object to display (e.g., `0-1` for contacts). See [complete list](https://developers.hubspot.com/guides/crm/understanding-the-crm#object-type-ids) of object IDs.
+     */
     objectTypeId: string;
+    /**
+     * The list of properties to display from the associated record, up to 24.
+     */
     properties: Array<string>;
+    /**
+     * When provided, returns associated records that have all the specified labels.
+     */
     associationLabels?: Array<string>;
+    /**
+     * Filters the data by specific values of the associated records. Review the [CRM data filter options](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-data-components/overview#filtering-data) for more information.
+     */
     filters?: Array<CrmSearchFilter>;
+    /**
+     * The default sorting behavior for the table. In each sort object in the array, you'll specify the following:
+     * - `columnName`: the column to sort by.
+     * - `direction`: the direction to sort by. Can be either `1` (ascending) or `-1` (descending). By default, order is ascending.
+     */
     sort?: Array<CrmSortDescriptor>;
 }
-/** @ignore */
 interface ObjectCoordinates {
     objectTypeId: string;
     objectId: number;
 }
-/** @ignore */
 interface OpenRecordAssociationFormArgs {
     objectTypeId: string;
     association: {
@@ -195,7 +274,6 @@ interface OpenRecordAssociationFormArgs {
         objectId: number;
     };
 }
-/** @ignore */
 interface ActivityCreatorActionArgs {
     objectTypeId: string;
     objectId: number;
@@ -203,34 +281,28 @@ interface ActivityCreatorActionArgs {
     initialEmailBody?: string;
     initialEmailSubject?: string;
 }
-/** @ignore */
 interface EngagementAppLinkArgs {
     objectId: number | string;
     objectTypeId: string;
     engagementId: number | string;
     external?: boolean;
 }
-/** @ignore */
 interface RecordAppLinkArgs {
     includeEschref?: boolean;
     objectId: number;
     objectTypeId: string;
     external?: boolean;
 }
-/** @ignore */
 interface PageAppLinkArgs {
     path: string;
     external?: boolean;
 }
-/** @ignore */
 interface ExternalUrlArgs {
     href: string;
 }
-/** @ignore */
 interface OpenRecordCreatorFormArgs {
     objectTypeId: string;
 }
-/** @ignore */
 interface ActionArgs {
     PREVIEW_OBJECT: ObjectCoordinates;
     ADD_NOTE: ActivityCreatorActionArgs;
@@ -245,56 +317,128 @@ interface ActionArgs {
     EXTERNAL_URL: ExternalUrlArgs;
     OPEN_WORKFLOW_ENROLLMENT_MODAL: ObjectCoordinates;
 }
-/** @ignore */
 export type ArgsFor<SpecificActionType extends ActionType> = ActionArgs[SpecificActionType];
 export type ActionType = 'PREVIEW_OBJECT' | 'ADD_NOTE' | 'ADD_TASK' | 'SEND_EMAIL' | 'SCHEDULE_MEETING' | 'OPEN_RECORD_CREATOR_FORM' | 'OPEN_RECORD_ASSOCIATION_FORM' | 'ENGAGEMENT_APP_LINK' | 'RECORD_APP_LINK' | 'PAGE_APP_LINK' | 'EXTERNAL_URL' | 'OPEN_WORKFLOW_ENROLLMENT_MODAL';
-/** @ignore */
 interface BaseActionComponent extends BaseComponentProps {
+    /**
+     * The content that will render inside the component.
+     */
     children: ReactNode;
+    /**
+     * The type of action to perform. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for more information.
+     */
     actionType: ActionType;
+    /**
+     * An object containing the CRM object and record context for performing the action. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for required context values.
+     */
     actionContext: ArgsFor<ActionType>;
+    /**
+     * An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action.
+     */
     onError?: (errors: string[]) => void;
 }
-/** @ignore */
 export interface CrmActionButtonProps extends BaseActionComponent {
+    /**
+     * The color variation of the button.
+     *
+     * @defaultValue `"secondary"`
+     */
     variant?: 'primary' | 'secondary' | 'destructive';
+    /**
+     * The button's HTML `role` attribute.
+     *
+     * @defaultValue `"button"`
+     */
     type?: 'button' | 'reset' | 'submit';
+    /**
+     * The size of the button.
+     *
+     * @defaultValue `"medium"`
+     */
     size?: TShirtSizes['xs'] | TShirtSizes['sm'] | TShirtSizes['md'];
+    /**
+     * A function that will be invoked when the button is clicked. It receives no arguments and its return value is ignored.
+     */
     onClick?: () => void;
+    /**
+     * When set to `true`, button renders in a disabled, greyed-out state and cannot be clicked.
+     */
+    disabled?: boolean;
 }
-/** @ignore */
 export interface CrmActionLinkProps extends BaseActionComponent {
+    /**
+     * The color variation of the link. See the [variants section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/crm-action-link#variants) for more information.
+     *
+     * @defaultValue `"primary"`
+     */
     variant?: 'primary' | 'light' | 'dark' | 'destructive';
 }
-/** @ignore */
 export interface ActionLibraryButtonCardActionConfig<SpecificActionType extends ActionType = ActionType> {
+    /**
+     * The type of button to render:
+     * - `action-library-button`: a standalone button that can perform one action.
+     * - `dropdown`: a dropdown menu button containing multiple `'action-library-button'` actions. When using this type, you'll need to include an `options` array containing each action.
+     */
     type: 'action-library-button';
+    /**
+     * The type of action to perform. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for more information.
+     */
     actionType: SpecificActionType;
+    /**
+     * An object containing the CRM object and record context for performing the action. See [list of available actions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/crm-action-components/overview#available-actions) for required context values.
+     */
     actionContext: ArgsFor<SpecificActionType>;
+    /**
+     * The button's label text.
+     */
     label?: string;
+    /**
+     * When set to `true`, the button or dropdown menu option will render in a disabled, greyed-out state and can't be clicked.
+     */
     disabled?: boolean;
+    /**
+     * Tooltip text that appears when hovering over the button or dropdown menu option.
+     */
     tooltipText?: string;
 }
-/** @ignore */
 export type DropdownCardActionConfigOptions = [
     ActionLibraryButtonCardActionConfig,
     ...ActionLibraryButtonCardActionConfig[]
 ];
-/** @ignore */
 export interface DropdownCardActionConfig {
+    /**
+     * The type of button to render:
+     * - `action-library-button`: a standalone button that can perform one action.
+     * - `dropdown`: a dropdown menu button containing multiple `'action-library-button'` actions. When using this type, you'll need to include an `options` array containing each action.
+     */
     type: 'dropdown';
+    /**
+     * For `dropdown` type buttons, this array stores objects for each action in the dropdown menu. Each action should be set to the `'action-library-button'` type.
+     */
     options: DropdownCardActionConfigOptions;
+    /**
+     * The button's label text.
+     */
     label?: string;
+    /**
+     * When set to `true`, the button or dropdown menu option will render in a disabled, greyed-out state and can't be clicked.
+     */
     disabled?: boolean;
+    /**
+     * Tooltip text that appears when hovering over the button or dropdown menu option.
+     */
     tooltipText?: string;
 }
-/** @ignore */
 type ErrorHandler = (errors: string[]) => void;
-/** @ignore */
 type CardActionConfig = ActionLibraryButtonCardActionConfig | DropdownCardActionConfig;
-/** @ignore */
 export type CrmCardActionsProps = BaseComponentProps & {
+    /**
+     * An array that stores fields for configuration button actions. See below for list of supported fields.
+     */
     actionConfigs: Array<CardActionConfig>;
+    /**
+     * An optional callback that will pass any error messages that were generated. Common errors include missing required context values or the user not having sufficient permissions to perform an action.
+     */
     onError?: ErrorHandler;
 };
 export {};

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

@@ -1,6 +1,6 @@
 import type { ReactNode } from 'react';
 import type { ReactionsHandler } from './reactions.ts';
-import type { AllDistances, ExtensionEvent, BaseComponentProps } from './shared.ts';
+import type { AllDistances, BaseComponentProps, ExtensionEvent } from './shared.ts';
 /**
  * @ignore
  * @experimental do not use in production

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

@@ -1,4 +1,4 @@
-import { ReactElement } from 'react';
-import { ExtensionPointApi, ExtensionPoints } from './extension-points.ts';
+import type { ReactElement } from 'react';
+import type { ExtensionPointApi, ExtensionPoints } from './extension-points.ts';
 export type RenderExtensionCallback<TExtensionPointName extends keyof ExtensionPoints> = (api: ExtensionPointApi<TExtensionPointName>) => ReactElement<any>;
 export type HubspotExtendFunction = <TExtensionPointName extends keyof ExtensionPoints>(renderExtensionCallback: RenderExtensionCallback<TExtensionPointName>) => void;

package/dist/shared/types/extension-points.d.ts

@@ -1,10 +1,9 @@
-import { ComponentType } from 'react';
-import { TypesOfReadOnlyArray } from './shared.ts';
-import type { AppHomeContext, BaseContext, CrmContext } from './context.ts';
+import type { ComponentType } from 'react';
 import type { AppHomeActions, CrmHostActions, SettingsActions, UiePlatformActions } from './actions.ts';
-import type { CrmPropertyListProps, CrmAssociationTableProps, CrmDataHighlightProps, CrmReportProps, CrmAssociationPivotProps, CrmAssociationPropertyListProps, CrmAssociationStageTrackerProps, CrmSimpleDeadlineProps, CrmRelativeTimelineProps, CrmStageTrackerProps, CrmStatisticsProps, CrmActionButtonProps, CrmActionLinkProps, CrmCardActionsProps } from './crm.ts';
-import type { SettingsContext, GenericContext } from './context.ts';
+import type { AppHomeContext, BaseContext, CrmContext, GenericContext, SettingsContext } from './context.ts';
+import type { CrmActionButtonProps, CrmActionLinkProps, CrmAssociationPivotProps, CrmAssociationPropertyListProps, CrmAssociationStageTrackerProps, CrmAssociationTableProps, CrmCardActionsProps, CrmDataHighlightProps, CrmPropertyListProps, CrmRelativeTimelineProps, CrmReportProps, CrmSimpleDeadlineProps, CrmStageTrackerProps, CrmStatisticsProps } from './crm.ts';
 import type { ServerlessFuncRunner } from './http-requests.ts';
+import type { TypesOfReadOnlyArray } from './shared.ts';
 /** @ignore */
 export type ExtensionPointAction = (...args: any[]) => Promise<any> | void;
 /** @ignore */

package/dist/shared/types/pages/app-pages-types.d.ts

@@ -0,0 +1,75 @@
+import type { ComponentType, ReactElement } from 'react';
+import type { EmptyProps, ReactFragmentProps } from '../shared.ts';
+import type { PageRoutesProps } from './components/page-routes.ts';
+/**
+ * The props type for a PageRouter component.
+ */
+export type PageRouterProps = EmptyProps;
+/**
+ * Represents the current page route that has been matched by the page router.
+ */
+export interface MatchedPageRoute {
+    /**
+     * The id of the route that has been matched.
+     */
+    routeId?: string;
+    /**
+     * The path of the route that has been matched.
+     */
+    path: string;
+    /**
+     * The parameters of the route that has been matched.
+     */
+    params: Record<string, string>;
+}
+/**
+ * The component type for the page router that handles rendering matched routes.
+ *
+ * @experimental This component is experimental. Avoid using it in production due to potential breaking changes. Your feedback is valuable for improvements. Stay tuned for updates.
+ */
+export type PageRouterComponent = ComponentType<PageRouterProps>;
+/**
+ * The function type for [createPageRouter](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/app-pages/reference#createpagerouter).
+ *
+ * Example usage:
+ *
+ * ```tsx
+ * const PageRouter = createPageRouter(
+ *   <PageRoutes layoutComponent={AppLayout}>
+ *     <PageRoutes.IndexRoute component={HomePage} id="home" />
+ *     <PageRoutes.Route path="/docs" component={DocsPage} />
+ *     <PageRoutes path="/customers" layoutComponent={CustomersLayout}>
+ *       <PageRoutes.IndexRoute component={ListCustomersPage} />
+ *       <PageRoutes.Route path="/:customerId" component={ViewCustomerPage} />
+ *     </PageRoutes>
+ *     <PageRoutes.AnyRoute component={NotFoundPage} />
+ *   </PageRoutes>
+ * );
+ *
+ * function AppPages() {
+ *   return <PageRouter />;
+ * }
+ *
+ * hubspot.extend<"pages">(() => <AppPages />);
+ * ```
+ *
+ * @param routes The routes to render.
+ * @returns The page router component.
+ *
+ * @experimental This function is experimental. Avoid using it in production due to potential breaking changes. Your feedback is valuable for improvements. Stay tuned for updates.
+ */
+export type CreatePageRouterFunction = (reactPageRoutesElement: ReactElement<PageRoutesProps> | ReactElement<ReactFragmentProps>) => PageRouterComponent;
+/**
+ * The function type for [usePageRoute](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/app-pages/reference#usepageroute).
+ *
+ * Example usage:
+ *
+ * ```tsx
+ * const pageRoute = usePageRoute();
+ * ```
+ *
+ * @returns The current page route.
+ *
+ * @experimental This hook is experimental. Avoid using it in production due to potential breaking changes. Your feedback is valuable for improvements. Stay tuned for updates.
+ */
+export type UsePageRouteHook = () => MatchedPageRoute;

package/dist/shared/types/pages/app-pages-types.js

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

package/dist/shared/types/pages/components/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './page-link.ts';
+export type * from './page-routes.ts';

package/dist/shared/types/pages/components/index.js

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

package/dist/shared/types/pages/components/page-link.d.ts

@@ -0,0 +1,23 @@
+import type { ReactNode } from 'react';
+import type { BaseComponentProps } from '../../shared.ts';
+/**
+ * The props type for [PageLink](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-link).
+ *
+ * @category Component Props
+ */
+export interface PageLinkProps extends BaseComponentProps {
+    /**
+     * The path to navigate to when the link is clicked. Supports path parameters (e.g. `/view-contact/:contactId`).
+     */
+    to: string;
+    /**
+     * Values for path parameters and query string entries.
+     * Parameters matching `:paramName` tokens in `to` are substituted into the path.
+     * Any remaining parameters are appended as query string entries.
+     */
+    params?: Record<string, string>;
+    /**
+     * The content to render inside the link.
+     */
+    children: ReactNode;
+}

package/dist/shared/types/pages/components/page-link.js

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