@hubspot/ui-extensions-sdk-api-metadata 0.11.6 → 0.12.0

package/README.md

@@ -3,7 +3,7 @@
 [![npm version](https://img.shields.io/npm/v/@hubspot/ui-extensions-sdk-api-metadata.svg)](https://www.npmjs.com/package/@hubspot/ui-extensions-sdk-api-metadata)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
-This package provides machine-readable API metadata for the [HubSpot UI Extensions SDK](https://www.npmjs.com/package/@hubspot/ui-extensions). It contains extracted TypeScript type information for component props and other exported types from the SDK.
+This package provides structured component props documentation for the [HubSpot UI Extensions SDK](https://www.npmjs.com/package/@hubspot/ui-extensions). It extracts TypeScript type information from SDK components and converts it into a documentation-friendly format with rendered HTML suitable for embedding in documentation sites.
 
 ## ⚠️ Internal Use Only
 
@@ -11,7 +11,7 @@ This package provides machine-readable API metadata for the [HubSpot UI Extensio
 
 ## Purpose
 
-This package currently serves as a data source for documentation generation tools. In the future, it may be used by other tools that need programmatic access to SDK type information.
+This package serves as a data source for documentation generation tools, providing structured documentation for component props including type information, descriptions, default values, and related links.
 
 ## Installation
 
@@ -22,27 +22,54 @@ npm install @hubspot/ui-extensions-sdk-api-metadata
 ## Usage
 
 ```typescript
-import { componentPropsReader } from '@hubspot/ui-extensions-sdk-api-metadata/component-props';
-
-// Find a specific component's props by export name
-const buttonProps = componentPropsReader.findExportByName({
-  exportName: 'ButtonProps',
+import {
+  getComponentPropsDocumentation,
+  ComponentName,
+} from '@hubspot/ui-extensions-sdk-api-metadata';
+
+// Get documentation for a specific component's props
+const accordionPropsDocs = getComponentPropsDocumentation(
+  ComponentName.Accordion
+);
+
+// Each prop documentation includes:
+accordionPropsDocs.forEach((propDoc) => {
+  console.log(propDoc.name); // Prop name (e.g., "open")
+  console.log(propDoc.required); // Whether the prop is required
+  console.log(propDoc.typeJsx); // Type as JSX string (e.g., "<><code>boolean</code></>")
+  console.log(propDoc.descriptionJsx); // Description as JSX string
+  console.log(propDoc.defaultValueJsx); // Optional default value as JSX string
+  console.log(propDoc.seeJsxItems); // Optional array of related links as JSX strings
 });
-
-// Look up a referenced type by its ID
-const referencedType = componentPropsReader.findReferencedTypeById(typeId);
 ```
 
 ## API
 
-The package exports a `componentPropsReader` object implementing the `AnalyzeResultReader` interface:
+### `getComponentPropsDocumentation(componentName: ComponentName): ComponentPropDocumentation[]`
+
+Retrieves structured documentation for all props of the specified component.
+
+**Parameters:**
+- `componentName` - The component to get documentation for (from the `ComponentName` enum)
+
+**Returns:** An array of `ComponentPropDocumentation` objects, sorted with required props first, then alphabetically by name.
+
+### `ComponentPropDocumentation`
+
+Interface for component prop documentation:
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `name` | `string` | The name of the prop |
+| `required` | `boolean` | Whether the prop is required |
+| `typeJsx` | `string` | The type rendered as JSX-embeddable HTML |
+| `descriptionJsx` | `string` | The description rendered as JSX-embeddable HTML |
+| `defaultValueJsx?` | `string` | Optional default value rendered as JSX-embeddable HTML |
+| `seeJsxItems?` | `string[]` | Optional array of related links rendered as JSX-embeddable HTML |
 
-| Method | Description |
-|--------|-------------|
-| `findExportByName(options)` | Finds an export by its name and path |
-| `findReferencedTypeById(typeId)` | Finds a referenced type by its unique identifier |
+### `ComponentName`
 
-See [`@hubspot/ts-export-types-reader`](https://www.npmjs.com/package/@hubspot/ts-export-types-reader) for more details.
+Enum of available component names in the SDK (e.g., `ComponentName.Accordion`).
 
 ## Related Packages