@hubspot/ui-extensions-sdk-api-metadata 0.12.3 → 0.12.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/__generated__/component-props.js +676 -46
  2. package/dist/internal/get-type-source.js +56 -0
  3. package/dist/types.d.ts +14 -0
  4. package/dist/types.js +14 -0
  5. package/package.json +3 -3
package/dist/__generated__/component-props.js CHANGED
@@ -1946,7 +1946,7 @@ export const componentPropsReader = createAnalyzeResultReader({
1946
1946
  "isType": true,
1947
1947
  "type": {
1948
1948
  "kind": "type-reference",
1949
- "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
1949
+ "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
1950
1950
  "typeString": "BaseRouteProps"
1951
1951
  },
1952
1952
  "jsdoc": {
@@ -1960,13 +1960,149 @@ export const componentPropsReader = createAnalyzeResultReader({
1960
1960
  "isType": true,
1961
1961
  "type": {
1962
1962
  "kind": "type-reference",
1963
- "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
1963
+ "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
1964
1964
  "typeString": "BaseRouteProps"
1965
1965
  },
1966
1966
  "jsdoc": {
1967
1967
  "text": "The props type for [PageRoutes.IndexRoute](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-indexroute)."
1968
1968
  }
1969
1969
  },
1970
+ {
1971
+ "kind": "export",
1972
+ "exportName": "PageBreadcrumbsCurrentProps",
1973
+ "declarationKind": "interface",
1974
+ "isType": true,
1975
+ "type": {
1976
+ "kind": "type-reference",
1977
+ "typeId": "PageBreadcrumbsCurrentProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
1978
+ "typeString": "PageBreadcrumbsCurrentProps"
1979
+ }
1980
+ },
1981
+ {
1982
+ "kind": "export",
1983
+ "exportName": "PageBreadcrumbsPageLinkProps",
1984
+ "declarationKind": "interface",
1985
+ "isType": true,
1986
+ "type": {
1987
+ "kind": "type-reference",
1988
+ "typeId": "PageBreadcrumbsPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
1989
+ "typeString": "PageBreadcrumbsPageLinkProps"
1990
+ }
1991
+ },
1992
+ {
1993
+ "kind": "export",
1994
+ "exportName": "PageBreadcrumbsProps",
1995
+ "declarationKind": "interface",
1996
+ "isType": true,
1997
+ "type": {
1998
+ "kind": "type-reference",
1999
+ "typeId": "PageBreadcrumbsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts",
2000
+ "typeString": "PageBreadcrumbsProps"
2001
+ },
2002
+ "jsdoc": {
2003
+ "text": "The props type for [PageBreadcrumbs](https://developers.hubspot.com/docs/reference/ui-components/app-page-components/page-breadcrumbs)"
2004
+ }
2005
+ },
2006
+ {
2007
+ "kind": "export",
2008
+ "exportName": "PageHeaderLinkProps",
2009
+ "declarationKind": "interface",
2010
+ "isType": true,
2011
+ "type": {
2012
+ "kind": "type-reference",
2013
+ "typeId": "PageHeaderLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
2014
+ "typeString": "PageHeaderLinkProps"
2015
+ },
2016
+ "jsdoc": {
2017
+ "text": "The props type for [PageHeader.Link](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-link).",
2018
+ "tags": [
2019
+ {
2020
+ "name": "category",
2021
+ "text": "Component Props"
2022
+ }
2023
+ ]
2024
+ }
2025
+ },
2026
+ {
2027
+ "kind": "export",
2028
+ "exportName": "PageHeaderPageLinkProps",
2029
+ "declarationKind": "interface",
2030
+ "isType": true,
2031
+ "type": {
2032
+ "kind": "type-reference",
2033
+ "typeId": "PageHeaderPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
2034
+ "typeString": "PageHeaderPageLinkProps"
2035
+ },
2036
+ "jsdoc": {
2037
+ "text": "The props type for [PageHeader.PageLink](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-pagelink).",
2038
+ "tags": [
2039
+ {
2040
+ "name": "category",
2041
+ "text": "Component Props"
2042
+ }
2043
+ ]
2044
+ }
2045
+ },
2046
+ {
2047
+ "kind": "export",
2048
+ "exportName": "PageHeaderPrimaryActionProps",
2049
+ "declarationKind": "interface",
2050
+ "isType": true,
2051
+ "type": {
2052
+ "kind": "type-reference",
2053
+ "typeId": "PageHeaderPrimaryActionProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
2054
+ "typeString": "PageHeaderPrimaryActionProps"
2055
+ },
2056
+ "jsdoc": {
2057
+ "text": "The props type for [PageHeader.PrimaryAction](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-primaryaction).",
2058
+ "tags": [
2059
+ {
2060
+ "name": "category",
2061
+ "text": "Component Props"
2062
+ }
2063
+ ]
2064
+ }
2065
+ },
2066
+ {
2067
+ "kind": "export",
2068
+ "exportName": "PageHeaderProps",
2069
+ "declarationKind": "interface",
2070
+ "isType": true,
2071
+ "type": {
2072
+ "kind": "type-reference",
2073
+ "typeId": "PageHeaderProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
2074
+ "typeString": "PageHeaderProps"
2075
+ },
2076
+ "jsdoc": {
2077
+ "text": "The props type for [PageHeader](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header).",
2078
+ "tags": [
2079
+ {
2080
+ "name": "category",
2081
+ "text": "Component Props"
2082
+ }
2083
+ ]
2084
+ }
2085
+ },
2086
+ {
2087
+ "kind": "export",
2088
+ "exportName": "PageHeaderSecondaryActionsProps",
2089
+ "declarationKind": "interface",
2090
+ "isType": true,
2091
+ "type": {
2092
+ "kind": "type-reference",
2093
+ "typeId": "PageHeaderSecondaryActionsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts",
2094
+ "typeString": "PageHeaderSecondaryActionsProps"
2095
+ },
2096
+ "jsdoc": {
2097
+ "text": "The props type for [PageHeader.SecondaryActions](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-header#pageheader-secondaryactions).",
2098
+ "tags": [
2099
+ {
2100
+ "name": "category",
2101
+ "text": "Component Props"
2102
+ }
2103
+ ]
2104
+ }
2105
+ },
1970
2106
  {
1971
2107
  "kind": "export",
1972
2108
  "exportName": "PageLinkProps",
@@ -1994,7 +2130,7 @@ export const componentPropsReader = createAnalyzeResultReader({
1994
2130
  "isType": true,
1995
2131
  "type": {
1996
2132
  "kind": "type-reference",
1997
- "typeId": "PageRouterProps:@hubspot/ui-extensions:dist/shared/types/pages/app-pages-types.d.ts",
2133
+ "typeId": "PageRouterProps:@hubspot/ui-extensions:dist/experimental/pages/types.d.ts",
1998
2134
  "typeString": "PageRouterProps"
1999
2135
  },
2000
2136
  "jsdoc": {
@@ -2008,7 +2144,7 @@ export const componentPropsReader = createAnalyzeResultReader({
2008
2144
  "isType": true,
2009
2145
  "type": {
2010
2146
  "kind": "type-reference",
2011
- "typeId": "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
2147
+ "typeId": "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
2012
2148
  "typeString": "PageRoutesLayoutProps"
2013
2149
  },
2014
2150
  "jsdoc": {
@@ -2022,13 +2158,33 @@ export const componentPropsReader = createAnalyzeResultReader({
2022
2158
  "isType": true,
2023
2159
  "type": {
2024
2160
  "kind": "type-reference",
2025
- "typeId": "PageRoutesProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
2161
+ "typeId": "PageRoutesProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
2026
2162
  "typeString": "PageRoutesProps"
2027
2163
  },
2028
2164
  "jsdoc": {
2029
2165
  "text": "The props type for [PageRoutes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes)."
2030
2166
  }
2031
2167
  },
2168
+ {
2169
+ "kind": "export",
2170
+ "exportName": "PageTitleProps",
2171
+ "declarationKind": "interface",
2172
+ "isType": true,
2173
+ "type": {
2174
+ "kind": "type-reference",
2175
+ "typeId": "PageTitleProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-title.d.ts",
2176
+ "typeString": "PageTitleProps"
2177
+ },
2178
+ "jsdoc": {
2179
+ "text": "The props type for [PageTitle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-title).",
2180
+ "tags": [
2181
+ {
2182
+ "name": "category",
2183
+ "text": "Component Props"
2184
+ }
2185
+ ]
2186
+ }
2187
+ },
2032
2188
  {
2033
2189
  "kind": "export",
2034
2190
  "exportName": "RouteProps",
@@ -2036,7 +2192,7 @@ export const componentPropsReader = createAnalyzeResultReader({
2036
2192
  "isType": true,
2037
2193
  "type": {
2038
2194
  "kind": "type-reference",
2039
- "typeId": "RouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
2195
+ "typeId": "RouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts",
2040
2196
  "typeString": "RouteProps"
2041
2197
  },
2042
2198
  "jsdoc": {
@@ -3111,7 +3267,7 @@ export const componentPropsReader = createAnalyzeResultReader({
3111
3267
  },
3112
3268
  "isOptional": true,
3113
3269
  "jsdoc": {
3114
- "text": "Include this prop to open a URL on click. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
3270
+ "text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
3115
3271
  }
3116
3272
  },
3117
3273
  {
@@ -3651,7 +3807,7 @@ export const componentPropsReader = createAnalyzeResultReader({
3651
3807
  }
3652
3808
  ]
3653
3809
  },
3654
- "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
3810
+ "BaseRouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
3655
3811
  "kind": "object",
3656
3812
  "properties": [
3657
3813
  {
@@ -4204,7 +4360,7 @@ export const componentPropsReader = createAnalyzeResultReader({
4204
4360
  },
4205
4361
  "isOptional": true,
4206
4362
  "jsdoc": {
4207
- "text": "Include this prop to open a URL on click. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
4363
+ "text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
4208
4364
  }
4209
4365
  },
4210
4366
  {
@@ -11727,7 +11883,7 @@ export const componentPropsReader = createAnalyzeResultReader({
11727
11883
  },
11728
11884
  "isOptional": true,
11729
11885
  "jsdoc": {
11730
- "text": "When provided, sets the URL that will open when the image is clicked. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab. By default:\n - Links to HubSpot app pages will open in the same tab.\n - Links to non-HubSpot app pages will open in a new tab.\n\nWhen an image includes both `href` and an `onClick` action, both will be executed on button click."
11886
+ "text": "When provided, sets the URL that will open when the image is clicked. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab. By default:\n - Links to HubSpot app pages will open in the same tab.\n - Links to non-HubSpot app pages will open in a new tab.\n\nWhen an image includes both `href` and an `onClick` action, both will be executed on button click."
11731
11887
  }
11732
11888
  },
11733
11889
  {
@@ -12446,7 +12602,7 @@ export const componentPropsReader = createAnalyzeResultReader({
12446
12602
  "typeString": "HrefProp"
12447
12603
  },
12448
12604
  "jsdoc": {
12449
- "text": "Sets the link's URL and open behavior. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon."
12605
+ "text": "Sets the link's URL and open behavior. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon."
12450
12606
  }
12451
12607
  },
12452
12608
  {
@@ -13560,7 +13716,7 @@ export const componentPropsReader = createAnalyzeResultReader({
13560
13716
  },
13561
13717
  "isOptional": true,
13562
13718
  "jsdoc": {
13563
- "text": "Include this prop to open a URL on click. Contains the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
13719
+ "text": "Include this prop to open a URL on click. Can be set to a URL string or an object with the following fields:\n- `url` (string): the URL that will open on click.\n- `external` (boolean, optional): set to `true` to open the URL in a new tab and display an external link icon. By default:\n - Links to HubSpot app pages will open in the same tab and will not include an icon.\n - Links to non-HubSpot app pages will open in a new tab and include the icon.\n\nWhen a button includes both `href` and an `onClick` action, both will be executed on button click."
13564
13720
  }
13565
13721
  },
13566
13722
  {
@@ -14647,6 +14803,33 @@ export const componentPropsReader = createAnalyzeResultReader({
14647
14803
  ]
14648
14804
  }
14649
14805
  },
14806
+ {
14807
+ "kind": "property",
14808
+ "name": "textAlign",
14809
+ "type": {
14810
+ "kind": "union",
14811
+ "types": [
14812
+ {
14813
+ "kind": "literal",
14814
+ "value": "left"
14815
+ },
14816
+ {
14817
+ "kind": "literal",
14818
+ "value": "right"
14819
+ }
14820
+ ]
14821
+ },
14822
+ "isOptional": true,
14823
+ "jsdoc": {
14824
+ "text": "Sets the horizontal alignment of the text in the input.",
14825
+ "tags": [
14826
+ {
14827
+ "name": "defaultValue",
14828
+ "text": "`\"left\"`"
14829
+ }
14830
+ ]
14831
+ }
14832
+ },
14650
14833
  {
14651
14834
  "kind": "property",
14652
14835
  "name": "error",
@@ -15023,7 +15206,42 @@ export const componentPropsReader = createAnalyzeResultReader({
15023
15206
  }
15024
15207
  ]
15025
15208
  },
15026
- "PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts": {
15209
+ "PageBreadcrumbsCurrentProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
15210
+ "kind": "object",
15211
+ "properties": [
15212
+ {
15213
+ "kind": "property",
15214
+ "name": "children",
15215
+ "type": {
15216
+ "kind": "type-reference",
15217
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15218
+ "typeString": "ReactNode"
15219
+ },
15220
+ "jsdoc": {
15221
+ "text": "Label for the current location."
15222
+ }
15223
+ },
15224
+ {
15225
+ "kind": "property",
15226
+ "name": "testId",
15227
+ "type": {
15228
+ "kind": "primitive",
15229
+ "name": "string"
15230
+ },
15231
+ "isOptional": true,
15232
+ "jsdoc": {
15233
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15234
+ "tags": [
15235
+ {
15236
+ "name": "see",
15237
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15238
+ }
15239
+ ]
15240
+ }
15241
+ }
15242
+ ]
15243
+ },
15244
+ "PageBreadcrumbsPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
15027
15245
  "kind": "object",
15028
15246
  "properties": [
15029
15247
  {
@@ -15068,7 +15286,7 @@ export const componentPropsReader = createAnalyzeResultReader({
15068
15286
  "typeString": "ReactNode"
15069
15287
  },
15070
15288
  "jsdoc": {
15071
- "text": "The content to render inside the link."
15289
+ "text": "The visible text of the breadcrumb link."
15072
15290
  }
15073
15291
  },
15074
15292
  {
@@ -15091,11 +15309,7 @@ export const componentPropsReader = createAnalyzeResultReader({
15091
15309
  }
15092
15310
  ]
15093
15311
  },
15094
- "PageRouterProps:@hubspot/ui-extensions:dist/shared/types/pages/app-pages-types.d.ts": {
15095
- "kind": "mapped-type",
15096
- "declarationText": "EmptyProps"
15097
- },
15098
- "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
15312
+ "PageBreadcrumbsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-breadcrumbs.d.ts": {
15099
15313
  "kind": "object",
15100
15314
  "properties": [
15101
15315
  {
@@ -15107,47 +15321,80 @@ export const componentPropsReader = createAnalyzeResultReader({
15107
15321
  "typeString": "ReactNode"
15108
15322
  },
15109
15323
  "jsdoc": {
15110
- "text": "The content to render inside the layout."
15324
+ "text": "The links and text to render as breadcrumbs.\nUse `PageBreadcrumbs.PageLink` for navigable crumbs and `PageBreadcrumbs.Current` for the current page."
15325
+ }
15326
+ },
15327
+ {
15328
+ "kind": "property",
15329
+ "name": "testId",
15330
+ "type": {
15331
+ "kind": "primitive",
15332
+ "name": "string"
15333
+ },
15334
+ "isOptional": true,
15335
+ "jsdoc": {
15336
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15337
+ "tags": [
15338
+ {
15339
+ "name": "see",
15340
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15341
+ }
15342
+ ]
15111
15343
  }
15112
15344
  }
15113
15345
  ]
15114
15346
  },
15115
- "PageRoutesProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
15347
+ "PageHeaderLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
15116
15348
  "kind": "object",
15117
15349
  "properties": [
15118
15350
  {
15119
15351
  "kind": "property",
15120
- "name": "path",
15352
+ "name": "href",
15121
15353
  "type": {
15122
15354
  "kind": "primitive",
15123
15355
  "name": "string"
15124
15356
  },
15125
15357
  "isOptional": true,
15126
15358
  "jsdoc": {
15127
- "text": "The path pattern of the route to include with all nested routes."
15359
+ "text": "A URL that will be opened when the button is clicked. If the value is a URL external to `hubspot.com` it will be opened in a new tab."
15128
15360
  }
15129
15361
  },
15130
15362
  {
15131
15363
  "kind": "property",
15132
- "name": "layoutComponent",
15364
+ "name": "onClick",
15133
15365
  "type": {
15134
- "kind": "union",
15135
- "types": [
15366
+ "kind": "type-reference",
15367
+ "typeId": "ReactionsHandler:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts",
15368
+ "typeString": "ReactionsHandler<ExtensionEvent>",
15369
+ "typeArguments": [
15136
15370
  {
15137
15371
  "kind": "type-reference",
15138
- "typeId": "ComponentClass:@types/react@18.3.26:index.d.ts",
15139
- "typeString": "ComponentClass"
15140
- },
15372
+ "typeId": "ExtensionEvent:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
15373
+ "typeString": "ExtensionEvent"
15374
+ }
15375
+ ]
15376
+ },
15377
+ "isOptional": true,
15378
+ "jsdoc": {
15379
+ "text": "A function that will be invoked when the button is clicked. Do not use this function for submitting a form; use Form's `onSubmit` function instead.",
15380
+ "tags": [
15141
15381
  {
15142
- "kind": "type-reference",
15143
- "typeId": "FunctionComponent:@types/react@18.3.26:index.d.ts",
15144
- "typeString": "FunctionComponent"
15382
+ "name": "event",
15383
+ "text": ""
15145
15384
  }
15146
15385
  ]
15386
+ }
15387
+ },
15388
+ {
15389
+ "kind": "property",
15390
+ "name": "disabled",
15391
+ "type": {
15392
+ "kind": "primitive",
15393
+ "name": "boolean"
15147
15394
  },
15148
15395
  "isOptional": true,
15149
15396
  "jsdoc": {
15150
- "text": "The component to render for the layout of the page routes."
15397
+ "text": "Determines whether or not the button should be disabled."
15151
15398
  }
15152
15399
  },
15153
15400
  {
@@ -15159,23 +15406,399 @@ export const componentPropsReader = createAnalyzeResultReader({
15159
15406
  "typeString": "ReactNode"
15160
15407
  },
15161
15408
  "jsdoc": {
15162
- "text": "The nested route definitions."
15409
+ "text": "The visible label of the link button. This prop is passed implicitly by providing sub-components."
15163
15410
  }
15164
- }
15165
- ]
15166
- },
15167
- "PanelAction:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts": {
15168
- "kind": "function",
15169
- "functionKind": "arrow",
15170
- "parameters": [
15411
+ },
15171
15412
  {
15172
- "kind": "parameter",
15173
- "name": "panelId",
15413
+ "kind": "property",
15414
+ "name": "testId",
15174
15415
  "type": {
15175
15416
  "kind": "primitive",
15176
15417
  "name": "string"
15177
- }
15178
- }
15418
+ },
15419
+ "isOptional": true,
15420
+ "jsdoc": {
15421
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15422
+ "tags": [
15423
+ {
15424
+ "name": "see",
15425
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15426
+ }
15427
+ ]
15428
+ }
15429
+ }
15430
+ ]
15431
+ },
15432
+ "PageHeaderPageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
15433
+ "kind": "object",
15434
+ "properties": [
15435
+ {
15436
+ "kind": "property",
15437
+ "name": "to",
15438
+ "type": {
15439
+ "kind": "primitive",
15440
+ "name": "string"
15441
+ },
15442
+ "jsdoc": {
15443
+ "text": "The path to navigate to when the link is clicked. Supports path parameters (e.g. `/view-contact/:contactId`)."
15444
+ }
15445
+ },
15446
+ {
15447
+ "kind": "property",
15448
+ "name": "params",
15449
+ "type": {
15450
+ "kind": "built-in-type-reference",
15451
+ "name": "Record",
15452
+ "typeArguments": [
15453
+ {
15454
+ "kind": "primitive",
15455
+ "name": "string"
15456
+ },
15457
+ {
15458
+ "kind": "primitive",
15459
+ "name": "string"
15460
+ }
15461
+ ]
15462
+ },
15463
+ "isOptional": true,
15464
+ "jsdoc": {
15465
+ "text": "Values for path parameters and query string entries.\nParameters matching `:paramName` tokens in `to` are substituted into the path.\nAny remaining parameters are appended as query string entries."
15466
+ }
15467
+ },
15468
+ {
15469
+ "kind": "property",
15470
+ "name": "children",
15471
+ "type": {
15472
+ "kind": "type-reference",
15473
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15474
+ "typeString": "ReactNode"
15475
+ },
15476
+ "jsdoc": {
15477
+ "text": "The visible label of the link button. This prop is passed implicitly by providing sub-components."
15478
+ }
15479
+ },
15480
+ {
15481
+ "kind": "property",
15482
+ "name": "testId",
15483
+ "type": {
15484
+ "kind": "primitive",
15485
+ "name": "string"
15486
+ },
15487
+ "isOptional": true,
15488
+ "jsdoc": {
15489
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15490
+ "tags": [
15491
+ {
15492
+ "name": "see",
15493
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15494
+ }
15495
+ ]
15496
+ }
15497
+ }
15498
+ ]
15499
+ },
15500
+ "PageHeaderPrimaryActionProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
15501
+ "kind": "object",
15502
+ "properties": [
15503
+ {
15504
+ "kind": "property",
15505
+ "name": "children",
15506
+ "type": {
15507
+ "kind": "type-reference",
15508
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15509
+ "typeString": "ReactNode"
15510
+ },
15511
+ "jsdoc": {
15512
+ "text": "Must be a <code>PageHeader.PageLink</code> component (for internal app pages) or a <code>PageHeader.Link</code> component (for URLs outside your app). No other component types are supported."
15513
+ }
15514
+ },
15515
+ {
15516
+ "kind": "property",
15517
+ "name": "testId",
15518
+ "type": {
15519
+ "kind": "primitive",
15520
+ "name": "string"
15521
+ },
15522
+ "isOptional": true,
15523
+ "jsdoc": {
15524
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15525
+ "tags": [
15526
+ {
15527
+ "name": "see",
15528
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15529
+ }
15530
+ ]
15531
+ }
15532
+ }
15533
+ ]
15534
+ },
15535
+ "PageHeaderProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
15536
+ "kind": "object",
15537
+ "properties": [
15538
+ {
15539
+ "kind": "property",
15540
+ "name": "children",
15541
+ "type": {
15542
+ "kind": "union",
15543
+ "types": [
15544
+ {
15545
+ "kind": "type-reference",
15546
+ "typeId": "ReactElement:@types/react@18.3.26:index.d.ts",
15547
+ "typeString": "ReactElement"
15548
+ },
15549
+ {
15550
+ "kind": "type-reference",
15551
+ "typeId": "ReactElement:@types/react@18.3.26:index.d.ts",
15552
+ "typeString": "ReactElement"
15553
+ }
15554
+ ]
15555
+ },
15556
+ "jsdoc": {
15557
+ "text": "Sets the content that will render inside the component. Can contain only <code>PageHeader.PrimaryAction</code> and/or <code>PageHeader.SecondaryActions</code> components."
15558
+ }
15559
+ },
15560
+ {
15561
+ "kind": "property",
15562
+ "name": "testId",
15563
+ "type": {
15564
+ "kind": "primitive",
15565
+ "name": "string"
15566
+ },
15567
+ "isOptional": true,
15568
+ "jsdoc": {
15569
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15570
+ "tags": [
15571
+ {
15572
+ "name": "see",
15573
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15574
+ }
15575
+ ]
15576
+ }
15577
+ }
15578
+ ]
15579
+ },
15580
+ "PageHeaderSecondaryActionsProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-header.d.ts": {
15581
+ "kind": "object",
15582
+ "properties": [
15583
+ {
15584
+ "kind": "property",
15585
+ "name": "children",
15586
+ "type": {
15587
+ "kind": "type-reference",
15588
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15589
+ "typeString": "ReactNode"
15590
+ },
15591
+ "jsdoc": {
15592
+ "text": "Must contain one or more <code>PageHeader.PageLink</code> component (for internal app pages) or a <code>PageHeader.Link</code> component (for URLs outside your app). No other component types are supported."
15593
+ }
15594
+ },
15595
+ {
15596
+ "kind": "property",
15597
+ "name": "testId",
15598
+ "type": {
15599
+ "kind": "primitive",
15600
+ "name": "string"
15601
+ },
15602
+ "isOptional": true,
15603
+ "jsdoc": {
15604
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15605
+ "tags": [
15606
+ {
15607
+ "name": "see",
15608
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15609
+ }
15610
+ ]
15611
+ }
15612
+ }
15613
+ ]
15614
+ },
15615
+ "PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts": {
15616
+ "kind": "object",
15617
+ "properties": [
15618
+ {
15619
+ "kind": "property",
15620
+ "name": "to",
15621
+ "type": {
15622
+ "kind": "primitive",
15623
+ "name": "string"
15624
+ },
15625
+ "jsdoc": {
15626
+ "text": "The path to navigate to. Can be a simple path (e.g., <code>\"/docs\"</code>) or a path with parameters\n(e.g., <code>\"/view-contact/:contactId\"</code>). When using path parameters, provide the parameter\nvalues in the <code>params</code> prop."
15627
+ }
15628
+ },
15629
+ {
15630
+ "kind": "property",
15631
+ "name": "params",
15632
+ "type": {
15633
+ "kind": "built-in-type-reference",
15634
+ "name": "Record",
15635
+ "typeArguments": [
15636
+ {
15637
+ "kind": "primitive",
15638
+ "name": "string"
15639
+ },
15640
+ {
15641
+ "kind": "primitive",
15642
+ "name": "string"
15643
+ }
15644
+ ]
15645
+ },
15646
+ "isOptional": true,
15647
+ "jsdoc": {
15648
+ "text": "Values for path parameters and query string entries.\nParameters matching `:paramName` tokens in `to` are substituted into the path.\nAny remaining parameters are appended as query string entries."
15649
+ }
15650
+ },
15651
+ {
15652
+ "kind": "property",
15653
+ "name": "children",
15654
+ "type": {
15655
+ "kind": "type-reference",
15656
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15657
+ "typeString": "ReactNode"
15658
+ },
15659
+ "jsdoc": {
15660
+ "text": "The content to display inside the link."
15661
+ }
15662
+ },
15663
+ {
15664
+ "kind": "property",
15665
+ "name": "testId",
15666
+ "type": {
15667
+ "kind": "primitive",
15668
+ "name": "string"
15669
+ },
15670
+ "isOptional": true,
15671
+ "jsdoc": {
15672
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15673
+ "tags": [
15674
+ {
15675
+ "name": "see",
15676
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15677
+ }
15678
+ ]
15679
+ }
15680
+ }
15681
+ ]
15682
+ },
15683
+ "PageRouterProps:@hubspot/ui-extensions:dist/experimental/pages/types.d.ts": {
15684
+ "kind": "mapped-type",
15685
+ "declarationText": "EmptyProps"
15686
+ },
15687
+ "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
15688
+ "kind": "object",
15689
+ "properties": [
15690
+ {
15691
+ "kind": "property",
15692
+ "name": "children",
15693
+ "type": {
15694
+ "kind": "type-reference",
15695
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15696
+ "typeString": "ReactNode"
15697
+ },
15698
+ "jsdoc": {
15699
+ "text": "The content to render inside the layout."
15700
+ }
15701
+ }
15702
+ ]
15703
+ },
15704
+ "PageRoutesProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
15705
+ "kind": "object",
15706
+ "properties": [
15707
+ {
15708
+ "kind": "property",
15709
+ "name": "path",
15710
+ "type": {
15711
+ "kind": "primitive",
15712
+ "name": "string"
15713
+ },
15714
+ "isOptional": true,
15715
+ "jsdoc": {
15716
+ "text": "The path pattern of the route to include with all nested routes."
15717
+ }
15718
+ },
15719
+ {
15720
+ "kind": "property",
15721
+ "name": "layoutComponent",
15722
+ "type": {
15723
+ "kind": "union",
15724
+ "types": [
15725
+ {
15726
+ "kind": "type-reference",
15727
+ "typeId": "ComponentClass:@types/react@18.3.26:index.d.ts",
15728
+ "typeString": "ComponentClass"
15729
+ },
15730
+ {
15731
+ "kind": "type-reference",
15732
+ "typeId": "FunctionComponent:@types/react@18.3.26:index.d.ts",
15733
+ "typeString": "FunctionComponent"
15734
+ }
15735
+ ]
15736
+ },
15737
+ "isOptional": true,
15738
+ "jsdoc": {
15739
+ "text": "The component to render for the layout of the page routes."
15740
+ }
15741
+ },
15742
+ {
15743
+ "kind": "property",
15744
+ "name": "children",
15745
+ "type": {
15746
+ "kind": "type-reference",
15747
+ "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
15748
+ "typeString": "ReactNode"
15749
+ },
15750
+ "jsdoc": {
15751
+ "text": "The nested route definitions."
15752
+ }
15753
+ }
15754
+ ]
15755
+ },
15756
+ "PageTitleProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-title.d.ts": {
15757
+ "kind": "object",
15758
+ "properties": [
15759
+ {
15760
+ "kind": "property",
15761
+ "name": "children",
15762
+ "type": {
15763
+ "kind": "primitive",
15764
+ "name": "string"
15765
+ },
15766
+ "jsdoc": {
15767
+ "text": "The text to display as the page heading. Also sets the browser tab title."
15768
+ }
15769
+ },
15770
+ {
15771
+ "kind": "property",
15772
+ "name": "testId",
15773
+ "type": {
15774
+ "kind": "primitive",
15775
+ "name": "string"
15776
+ },
15777
+ "isOptional": true,
15778
+ "jsdoc": {
15779
+ "text": "Used by `findByTestId()` to locate this component in tests.",
15780
+ "tags": [
15781
+ {
15782
+ "name": "see",
15783
+ "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
15784
+ }
15785
+ ]
15786
+ }
15787
+ }
15788
+ ]
15789
+ },
15790
+ "PanelAction:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts": {
15791
+ "kind": "function",
15792
+ "functionKind": "arrow",
15793
+ "parameters": [
15794
+ {
15795
+ "kind": "parameter",
15796
+ "name": "panelId",
15797
+ "type": {
15798
+ "kind": "primitive",
15799
+ "name": "string"
15800
+ }
15801
+ }
15179
15802
  ],
15180
15803
  "returnType": {
15181
15804
  "kind": "primitive",
@@ -16543,6 +17166,13 @@ export const componentPropsReader = createAnalyzeResultReader({
16543
17166
  }
16544
17167
  ]
16545
17168
  },
17169
+ "ReactElement:@types/react@18.3.26:index.d.ts": {
17170
+ "kind": "external-type-reference",
17171
+ "typeName": "ReactElement",
17172
+ "typeString": "ReactElement",
17173
+ "packageName": "@types/react",
17174
+ "packageVersion": "18.3.26"
17175
+ },
16546
17176
  "ReactFragmentProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts": {
16547
17177
  "kind": "object",
16548
17178
  "properties": [
@@ -16688,7 +17318,7 @@ export const componentPropsReader = createAnalyzeResultReader({
16688
17318
  }
16689
17319
  ]
16690
17320
  },
16691
- "RouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
17321
+ "RouteProps:@hubspot/ui-extensions:dist/experimental/pages/components/page-routes.d.ts": {
16692
17322
  "kind": "object",
16693
17323
  "properties": [
16694
17324
  {
package/dist/internal/get-type-source.js CHANGED
@@ -232,6 +232,62 @@ const componentSourceLookup = {
232
232
  exportName: 'NumberInputProps',
233
233
  exportPath: '.',
234
234
  },
235
+ PageBreadcrumbs: {
236
+ exportName: 'PageBreadcrumbsProps',
237
+ exportPath: './experimental/pages',
238
+ },
239
+ PageBreadcrumbsCurrent: {
240
+ exportName: 'PageBreadcrumbsCurrentProps',
241
+ exportPath: './experimental/pages',
242
+ },
243
+ PageBreadcrumbsPageLink: {
244
+ exportName: 'PageBreadcrumbsPageLinkProps',
245
+ exportPath: './experimental/pages',
246
+ },
247
+ PageHeader: {
248
+ exportName: 'PageHeaderProps',
249
+ exportPath: './experimental/pages',
250
+ },
251
+ PageHeaderLink: {
252
+ exportName: 'PageHeaderLinkProps',
253
+ exportPath: './experimental/pages',
254
+ },
255
+ PageHeaderPageLink: {
256
+ exportName: 'PageHeaderPageLinkProps',
257
+ exportPath: './experimental/pages',
258
+ },
259
+ PageHeaderPrimaryAction: {
260
+ exportName: 'PageHeaderPrimaryActionProps',
261
+ exportPath: './experimental/pages',
262
+ },
263
+ PageHeaderSecondaryActions: {
264
+ exportName: 'PageHeaderSecondaryActionsProps',
265
+ exportPath: './experimental/pages',
266
+ },
267
+ PageLink: {
268
+ exportName: 'PageLinkProps',
269
+ exportPath: './experimental/pages',
270
+ },
271
+ PageRoutes: {
272
+ exportName: 'PageRoutesProps',
273
+ exportPath: './experimental/pages',
274
+ },
275
+ PageRoutesAnyRoute: {
276
+ exportName: 'PageRoutesAnyRouteProps',
277
+ exportPath: './experimental/pages',
278
+ },
279
+ PageRoutesIndexRoute: {
280
+ exportName: 'PageRoutesIndexRouteProps',
281
+ exportPath: './experimental/pages',
282
+ },
283
+ PageRoutesRoute: {
284
+ exportName: 'PageRoutesRouteProps',
285
+ exportPath: './experimental/pages',
286
+ },
287
+ PageTitle: {
288
+ exportName: 'PageTitleProps',
289
+ exportPath: './experimental/pages',
290
+ },
235
291
  Panel: {
236
292
  exportName: 'PanelProps',
237
293
  exportPath: '.',
package/dist/types.d.ts CHANGED
@@ -92,6 +92,20 @@ export declare enum ComponentName {
92
92
  ModalFooter = "ModalFooter",
93
93
  MultiSelect = "MultiSelect",
94
94
  NumberInput = "NumberInput",
95
+ PageBreadcrumbs = "PageBreadcrumbs",
96
+ PageBreadcrumbsCurrent = "PageBreadcrumbsCurrent",
97
+ PageBreadcrumbsPageLink = "PageBreadcrumbsPageLink",
98
+ PageHeader = "PageHeader",
99
+ PageHeaderLink = "PageHeaderLink",
100
+ PageHeaderPageLink = "PageHeaderPageLink",
101
+ PageHeaderPrimaryAction = "PageHeaderPrimaryAction",
102
+ PageHeaderSecondaryActions = "PageHeaderSecondaryActions",
103
+ PageLink = "PageLink",
104
+ PageRoutes = "PageRoutes",
105
+ PageRoutesAnyRoute = "PageRoutesAnyRoute",
106
+ PageRoutesIndexRoute = "PageRoutesIndexRoute",
107
+ PageRoutesRoute = "PageRoutesRoute",
108
+ PageTitle = "PageTitle",
95
109
  Panel = "Panel",
96
110
  PanelBody = "PanelBody",
97
111
  PanelFooter = "PanelFooter",
package/dist/types.js CHANGED
@@ -62,6 +62,20 @@ export var ComponentName;
62
62
  ComponentName["ModalFooter"] = "ModalFooter";
63
63
  ComponentName["MultiSelect"] = "MultiSelect";
64
64
  ComponentName["NumberInput"] = "NumberInput";
65
+ ComponentName["PageBreadcrumbs"] = "PageBreadcrumbs";
66
+ ComponentName["PageBreadcrumbsCurrent"] = "PageBreadcrumbsCurrent";
67
+ ComponentName["PageBreadcrumbsPageLink"] = "PageBreadcrumbsPageLink";
68
+ ComponentName["PageHeader"] = "PageHeader";
69
+ ComponentName["PageHeaderLink"] = "PageHeaderLink";
70
+ ComponentName["PageHeaderPageLink"] = "PageHeaderPageLink";
71
+ ComponentName["PageHeaderPrimaryAction"] = "PageHeaderPrimaryAction";
72
+ ComponentName["PageHeaderSecondaryActions"] = "PageHeaderSecondaryActions";
73
+ ComponentName["PageLink"] = "PageLink";
74
+ ComponentName["PageRoutes"] = "PageRoutes";
75
+ ComponentName["PageRoutesAnyRoute"] = "PageRoutesAnyRoute";
76
+ ComponentName["PageRoutesIndexRoute"] = "PageRoutesIndexRoute";
77
+ ComponentName["PageRoutesRoute"] = "PageRoutesRoute";
78
+ ComponentName["PageTitle"] = "PageTitle";
65
79
  ComponentName["Panel"] = "Panel";
66
80
  ComponentName["PanelBody"] = "PanelBody";
67
81
  ComponentName["PanelFooter"] = "PanelFooter";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hubspot/ui-extensions-sdk-api-metadata",
3
- "version": "0.12.3",
3
+ "version": "0.12.4",
4
4
  "description": "UI Extensions SDK API Metadata",
5
5
  "type": "module",
6
6
  "prettier": "@private/prettier-config",
@@ -29,9 +29,9 @@
29
29
  "prettier": "3.8.1",
30
30
  "typescript": "5.9.3",
31
31
  "vitest": "4.0.18",
32
- "@private/eslint-config": "1.0.0",
33
32
  "@private/prettier-config": "1.0.0",
34
- "@hubspot/ui-extensions": "0.12.3"
33
+ "@hubspot/ui-extensions": "0.12.4",
34
+ "@private/eslint-config": "1.0.0"
35
35
  },
36
36
  "engines": {
37
37
  "node": ">=16"