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

package/dist/__generated__/component-props.js

@@ -605,6 +605,17 @@ export const componentPropsReader = createAnalyzeResultReader({
                     ]
                 }
             },
+            {
+                "kind": "export",
+                "exportName": "EmptyProps",
+                "declarationKind": "type",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
+                    "typeString": "EmptyProps"
+                }
+            },
             {
                 "kind": "export",
                 "exportName": "EmptyStateProps",
@@ -1167,6 +1178,20 @@ export const componentPropsReader = createAnalyzeResultReader({
                     ]
                 }
             },
+            {
+                "kind": "export",
+                "exportName": "ReactFragmentProps",
+                "declarationKind": "interface",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "ReactFragmentProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
+                    "typeString": "ReactFragmentProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for a React fragment component."
+                }
+            },
             {
                 "kind": "export",
                 "exportName": "ScoreProps",
@@ -1178,7 +1203,7 @@ export const componentPropsReader = createAnalyzeResultReader({
                     "typeString": "ScoreProps"
                 },
                 "jsdoc": {
-                    "text": "The props type for {@link !components.ScoreCircle}.",
+                    "text": "The props type for [ScoreCircle](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/scorecircle)",
                     "tags": [
                         {
                             "name": "category",
@@ -1913,6 +1938,112 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             }
         ],
+        "./experimental/pages": [
+            {
+                "kind": "export",
+                "exportName": "AnyRouteProps",
+                "declarationKind": "type",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
+                    "typeString": "BaseRouteProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for [PageRoutes.AnyRoute](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-anyroute)."
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "IndexRouteProps",
+                "declarationKind": "type",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
+                    "typeString": "BaseRouteProps"
+                },
+                "jsdoc": {
+                    "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)."
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "PageLinkProps",
+                "declarationKind": "interface",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts",
+                    "typeString": "PageLinkProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for [PageLink](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-link).",
+                    "tags": [
+                        {
+                            "name": "category",
+                            "text": "Component Props"
+                        }
+                    ]
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "PageRouterProps",
+                "declarationKind": "type",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "PageRouterProps:@hubspot/ui-extensions:dist/shared/types/pages/app-pages-types.d.ts",
+                    "typeString": "PageRouterProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for a PageRouter component."
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "PageRoutesLayoutProps",
+                "declarationKind": "interface",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
+                    "typeString": "PageRoutesLayoutProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for the layout component of [PageRoutes](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes)."
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "PageRoutesProps",
+                "declarationKind": "interface",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "PageRoutesProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
+                    "typeString": "PageRoutesProps"
+                },
+                "jsdoc": {
+                    "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)."
+                }
+            },
+            {
+                "kind": "export",
+                "exportName": "RouteProps",
+                "declarationKind": "interface",
+                "isType": true,
+                "type": {
+                    "kind": "type-reference",
+                    "typeId": "RouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts",
+                    "typeString": "RouteProps"
+                },
+                "jsdoc": {
+                    "text": "The props type for [PageRoutes.Route](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/app-page-components/page-routes#pageroutes-route)."
+                }
+            }
+        ],
         "./pages/home": [],
         "./experimental": [
             {
@@ -3520,6 +3651,42 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "BaseRouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "component",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ComponentType:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ComponentType<EmptyProps>",
+                        "typeArguments": [
+                            {
+                                "kind": "type-reference",
+                                "typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
+                                "typeString": "EmptyProps"
+                            }
+                        ]
+                    },
+                    "jsdoc": {
+                        "text": "The component to render when the route is matched."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "id",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "text": "A unique identifier for the route."
+                    }
+                }
+            ]
+        },
         "BaseSelectProps:@hubspot/ui-extensions:dist/shared/types/components/selects.d.ts": {
             "kind": "object",
             "properties": [
@@ -5827,6 +5994,27 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "ComponentClass:@types/react@18.3.26:index.d.ts": {
+            "kind": "external-type-reference",
+            "typeName": "ComponentClass",
+            "typeString": "ComponentClass",
+            "packageName": "@types/react",
+            "packageVersion": "18.3.26"
+        },
+        "ComponentType:@types/react@18.3.26:index.d.ts": {
+            "kind": "external-type-reference",
+            "typeName": "ComponentType",
+            "typeString": "ComponentType<EmptyProps>",
+            "packageName": "@types/react",
+            "packageVersion": "18.3.26",
+            "typeArguments": [
+                {
+                    "kind": "type-reference",
+                    "typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
+                    "typeString": "EmptyProps"
+                }
+            ]
+        },
         "CrmActionButtonProps:@hubspot/ui-extensions:dist/shared/types/crm.d.ts": {
             "kind": "object",
             "properties": [
@@ -8676,6 +8864,20 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts": {
+            "kind": "built-in-type-reference",
+            "name": "Record",
+            "typeArguments": [
+                {
+                    "kind": "primitive",
+                    "name": "string"
+                },
+                {
+                    "kind": "unknown",
+                    "type": "never"
+                }
+            ]
+        },
         "EmptyStateProps:@hubspot/ui-extensions:dist/shared/types/components/empty-state.d.ts": {
             "kind": "object",
             "properties": [
@@ -9842,6 +10044,13 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "FunctionComponent:@types/react@18.3.26:index.d.ts": {
+            "kind": "external-type-reference",
+            "typeName": "FunctionComponent",
+            "typeString": "FunctionComponent",
+            "packageName": "@types/react",
+            "packageVersion": "18.3.26"
+        },
         "Gradient:@hubspot/ui-extensions:dist/shared/types/crm.d.ts": {
             "kind": "object",
             "properties": [
@@ -10331,7 +10540,7 @@ export const componentPropsReader = createAnalyzeResultReader({
                     },
                     "isOptional": true,
                     "jsdoc": {
-                        "text": "The color of the icon.",
+                        "text": "The color of the icon. See the [colors section](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/icon#colors) for details.",
                         "tags": [
                             {
                                 "name": "defaultValue",
@@ -11109,7 +11318,7 @@ export const componentPropsReader = createAnalyzeResultReader({
                         ]
                     },
                     "jsdoc": {
-                        "text": "Sets the icon to display."
+                        "text": "Sets the icon to display. See [all available icons](https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/ui-components/standard-components/icon#available-icons)."
                     }
                 },
                 {
@@ -14814,6 +15023,147 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "PageLinkProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-link.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "to",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "jsdoc": {
+                        "text": "The path to navigate to when the link is clicked. Supports path parameters (e.g. `/view-contact/:contactId`)."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "params",
+                    "type": {
+                        "kind": "built-in-type-reference",
+                        "name": "Record",
+                        "typeArguments": [
+                            {
+                                "kind": "primitive",
+                                "name": "string"
+                            },
+                            {
+                                "kind": "primitive",
+                                "name": "string"
+                            }
+                        ]
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "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."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "children",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ReactNode"
+                    },
+                    "jsdoc": {
+                        "text": "The content to render inside the link."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "testId",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "text": "Used by `findByTestId()` to locate this component in tests.",
+                        "tags": [
+                            {
+                                "name": "see",
+                                "text": "{@link https://developers.hubspot.com/docs/apps/developer-platform/add-features/ui-extensibility/testing/reference#findbytestid Testing utilities reference}"
+                            }
+                        ]
+                    }
+                }
+            ]
+        },
+        "PageRouterProps:@hubspot/ui-extensions:dist/shared/types/pages/app-pages-types.d.ts": {
+            "kind": "mapped-type",
+            "declarationText": "EmptyProps"
+        },
+        "PageRoutesLayoutProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "children",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ReactNode"
+                    },
+                    "jsdoc": {
+                        "text": "The content to render inside the layout."
+                    }
+                }
+            ]
+        },
+        "PageRoutesProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "path",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "text": "The path pattern of the route to include with all nested routes."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "layoutComponent",
+                    "type": {
+                        "kind": "union",
+                        "types": [
+                            {
+                                "kind": "type-reference",
+                                "typeId": "ComponentClass:@types/react@18.3.26:index.d.ts",
+                                "typeString": "ComponentClass"
+                            },
+                            {
+                                "kind": "type-reference",
+                                "typeId": "FunctionComponent:@types/react@18.3.26:index.d.ts",
+                                "typeString": "FunctionComponent"
+                            }
+                        ]
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "text": "The component to render for the layout of the page routes."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "children",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ReactNode"
+                    },
+                    "jsdoc": {
+                        "text": "The nested route definitions."
+                    }
+                }
+            ]
+        },
         "PanelAction:@hubspot/ui-extensions:dist/shared/types/reactions.d.ts": {
             "kind": "function",
             "functionKind": "arrow",
@@ -16193,6 +16543,21 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "ReactFragmentProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "children",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ReactNode:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ReactNode"
+                    },
+                    "isOptional": true
+                }
+            ]
+        },
         "ReactNode:@types/react@18.3.26:index.d.ts": {
             "kind": "external-type-reference",
             "typeName": "ReactNode",
@@ -16323,6 +16688,53 @@ export const componentPropsReader = createAnalyzeResultReader({
                 }
             ]
         },
+        "RouteProps:@hubspot/ui-extensions:dist/shared/types/pages/components/page-routes.d.ts": {
+            "kind": "object",
+            "properties": [
+                {
+                    "kind": "property",
+                    "name": "path",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "jsdoc": {
+                        "text": "The path pattern of the route to match."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "component",
+                    "type": {
+                        "kind": "type-reference",
+                        "typeId": "ComponentType:@types/react@18.3.26:index.d.ts",
+                        "typeString": "ComponentType<EmptyProps>",
+                        "typeArguments": [
+                            {
+                                "kind": "type-reference",
+                                "typeId": "EmptyProps:@hubspot/ui-extensions:dist/shared/types/shared.d.ts",
+                                "typeString": "EmptyProps"
+                            }
+                        ]
+                    },
+                    "jsdoc": {
+                        "text": "The component to render when the route is matched."
+                    }
+                },
+                {
+                    "kind": "property",
+                    "name": "id",
+                    "type": {
+                        "kind": "primitive",
+                        "name": "string"
+                    },
+                    "isOptional": true,
+                    "jsdoc": {
+                        "text": "A unique identifier for the route."
+                    }
+                }
+            ]
+        },
         "ScoreProps:@hubspot/ui-extensions:dist/shared/types/components/score.d.ts": {
             "kind": "object",
             "properties": [

package/dist/__tests__/component-props-docs.spec.js

@@ -217,6 +217,9 @@ describe('getComponentPropsDocumentation', () => {
     it('should return the correct component prop documentation for the SettingsView component', async () => {
         await runComponentPropsSnapshotTest(ComponentName.SettingsView);
     });
+    it('should return the correct component prop documentation for the Spacer component', async () => {
+        await runComponentPropsSnapshotTest(ComponentName.Spacer);
+    });
     it('should return the correct component prop documentation for the Stack2 component', async () => {
         await runComponentPropsSnapshotTest(ComponentName.Stack2);
     });

package/dist/component-props-docs.d.ts

@@ -1,4 +1,4 @@
-import { ComponentName, ComponentPropDocumentation } from './types.ts';
+import type { ComponentName, ComponentPropDocumentation } from './types.ts';
 /**
  * Gets the documentation for the props of a component.
  *

package/dist/component-props-docs.js

@@ -1,9 +1,9 @@
 import { isObjectNode, isTypeReferenceNode, } from '@hubspot/ts-export-types-reader';
 import { componentPropsReader } from "./__generated__/component-props.js";
-import { renderPropTypeToJsx, } from "./internal/render-prop-type.js";
+import { getComponentTypeSource } from "./internal/get-type-source.js";
+import { renderPropTypeToJsx } from "./internal/render-prop-type.js";
 import { getDefaultValueFromJsdocTags, getSeeTagsFromJsdocTags, hasDeprecatedJsdocTag, } from "./internal/utils/jsdoc-utils.js";
 import { renderMarkdownToJsx } from "./internal/utils/markdown-utils.js";
-import { getComponentTypeSource } from "./internal/get-type-source.js";
 /**
  * Recursively resolves an API node to an ObjectNode if possible.
  *

package/dist/internal/get-type-source.d.ts

@@ -1,4 +1,4 @@
-import { ComponentName } from '../types.ts';
+import type { ComponentName } from '../types.ts';
 export interface ComponentSource {
     exportName: string;
     exportPath: string;

package/dist/internal/get-type-source.js

@@ -284,6 +284,10 @@ const componentSourceLookup = {
         exportName: 'SettingsViewProps',
         exportPath: './experimental',
     },
+    Spacer: {
+        exportName: 'SpacerProps',
+        exportPath: '.',
+    },
     Stack2: {
         exportName: 'Stack2Props',
         exportPath: './experimental',

package/dist/internal/render-prop-type.d.ts

@@ -1,4 +1,4 @@
-import { AnalyzeResultReader, ApiNode } from '@hubspot/ts-export-types-reader';
+import type { AnalyzeResultReader, ApiNode } from '@hubspot/ts-export-types-reader';
 /**
  * Context object passed through the type rendering functions.
  *

package/dist/internal/utils/jsdoc-utils.d.ts

@@ -4,7 +4,7 @@
  * This module provides helper functions for parsing and extracting information
  * from JSDoc comments associated with component props, such as default values.
  */
-import { JsdocTag } from '@hubspot/ts-export-types-reader';
+import type { JsdocTag } from '@hubspot/ts-export-types-reader';
 /**
  * Extracts the default value from JSDoc tags.
  *

package/dist/internal/utils/jsx-utils.js

@@ -1,5 +1,5 @@
-import { parseDocument, DomUtils } from 'htmlparser2';
 import serialize from 'dom-serializer';
+import { DomUtils, parseDocument } from 'htmlparser2';
 const escapeJsxExpressions = (jsx) => {
     return jsx.replaceAll('{', '{').replaceAll('}', '}');
 };

package/dist/types.d.ts

@@ -105,6 +105,7 @@ export declare enum ComponentName {
     SecondaryHeaderActionButton = "SecondaryHeaderActionButton",
     Select = "Select",
     SettingsView = "SettingsView",
+    Spacer = "Spacer",
     Stack2 = "Stack2",
     Statistics = "Statistics",
     StatisticsItem = "StatisticsItem",

package/dist/types.js

@@ -75,6 +75,7 @@ export var ComponentName;
     ComponentName["SecondaryHeaderActionButton"] = "SecondaryHeaderActionButton";
     ComponentName["Select"] = "Select";
     ComponentName["SettingsView"] = "SettingsView";
+    ComponentName["Spacer"] = "Spacer";
     ComponentName["Stack2"] = "Stack2";
     ComponentName["Statistics"] = "Statistics";
     ComponentName["StatisticsItem"] = "StatisticsItem";

package/package.json

@@ -1,19 +1,9 @@
 {
   "name": "@hubspot/ui-extensions-sdk-api-metadata",
-  "version": "0.12.2",
+  "version": "0.12.3",
   "description": "UI Extensions SDK API Metadata",
   "type": "module",
-  "scripts": {
-    "clean": "rm -rf dist/ src/__generated__/",
-    "build": "npm run clean && npm run generate && tsc",
-    "check:tsc": "tsc",
-    "generate": "npm run generate:sdk-api-metadata",
-    "generate:sdk-api-metadata": "(cd ../ui-extensions-components && npm run build) && ts-export-types analyze --config ts-export-types.component-props.config.js",
-    "test": "vitest run",
-    "watch": "npm run clean && tsc --watch",
-    "prepublishOnly": "npm run build",
-    "lint": "echo 'No linter configured for @hubspot/ui-extensions-sdk-api-metadata'"
-  },
+  "prettier": "@private/prettier-config",
   "files": [
     "dist"
   ],
@@ -26,18 +16,36 @@
   "license": "MIT",
   "dependencies": {
     "@hubspot/ts-export-types-reader": "1.1.0",
-    "dom-serializer": "^2.0.0",
-    "htmlparser2": "^9.1.0",
+    "dom-serializer": "2.0.0",
+    "htmlparser2": "9.1.0",
     "marked": "17.0.1"
   },
   "devDependencies": {
     "@hubspot/ts-export-types": "1.1.0",
+    "@types/node": "22.19.7",
     "@vitest/coverage-v8": "4.0.18",
+    "@vitest/eslint-plugin": "1.6.6",
+    "eslint": "9.39.2",
+    "prettier": "3.8.1",
     "typescript": "5.9.3",
-    "vitest": "4.0.18"
+    "vitest": "4.0.18",
+    "@private/eslint-config": "1.0.0",
+    "@private/prettier-config": "1.0.0",
+    "@hubspot/ui-extensions": "0.12.3"
   },
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "b8c8170048a28b28112833cb552be43d4587c2ed"
-}
+  "scripts": {
+    "clean": "rm -rf dist/ *.tsbuildinfo .turbo src/__generated__/",
+    "format": "prettier --write . --ignore-path ../../.prettierignore",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore",
+    "generate": "pnpm run generate:sdk-api-metadata",
+    "generate:sdk-api-metadata": "ts-export-types analyze --config ts-export-types.component-props.config.js",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "test": "vitest run",
+    "tsc": "tsc",
+    "tsc:watch": "tsc --watch"
+  }
+}