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

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

@@ -0,0 +1,399 @@
+/**
+ * Lookup table for component type sources.
+ *
+ * FUTURE: We should use code generation to generate this lookup table.
+ */
+const componentSourceLookup = {
+    Accordion: {
+        exportName: 'AccordionProps',
+        exportPath: '.',
+    },
+    Alert: {
+        exportName: 'AlertProps',
+        exportPath: '.',
+    },
+    AutoGrid: {
+        exportName: 'AutoGridProps',
+        exportPath: '.',
+    },
+    BarChart: {
+        exportName: 'BarChartProps',
+        exportPath: '.',
+    },
+    Box: {
+        exportName: 'BoxProps',
+        exportPath: '.',
+    },
+    Button: {
+        exportName: 'ButtonProps',
+        exportPath: '.',
+    },
+    ButtonRow: {
+        exportName: 'ButtonRowProps',
+        exportPath: '.',
+    },
+    Card: {
+        exportName: 'CardProps',
+        exportPath: '.',
+    },
+    Center: {
+        exportName: 'CenterProps',
+        exportPath: './experimental',
+    },
+    Checkbox: {
+        exportName: 'CheckboxProps',
+        exportPath: '.',
+    },
+    CrmActionButton: {
+        exportName: 'CrmActionButtonProps',
+        exportPath: './crm',
+    },
+    CrmActionLink: {
+        exportName: 'CrmActionLinkProps',
+        exportPath: './crm',
+    },
+    CrmAssociationPivot: {
+        exportName: 'CrmAssociationPivotProps',
+        exportPath: './crm',
+    },
+    CrmAssociationPropertyList: {
+        exportName: 'CrmAssociationPropertyListProps',
+        exportPath: './crm',
+    },
+    CrmAssociationStageTracker: {
+        exportName: 'CrmAssociationStageTrackerProps',
+        exportPath: './crm',
+    },
+    CrmAssociationTable: {
+        exportName: 'CrmAssociationTableProps',
+        exportPath: './crm',
+    },
+    CrmCardActions: {
+        exportName: 'CrmCardActionsProps',
+        exportPath: './crm',
+    },
+    CrmDataHighlight: {
+        exportName: 'CrmDataHighlightProps',
+        exportPath: './crm',
+    },
+    CrmPropertyList: {
+        exportName: 'CrmPropertyListProps',
+        exportPath: './crm',
+    },
+    CrmReport: {
+        exportName: 'CrmReportProps',
+        exportPath: './crm',
+    },
+    CrmSimpleDeadline: {
+        exportName: 'CrmSimpleDeadlineProps',
+        exportPath: './crm',
+    },
+    CrmStageTracker: {
+        exportName: 'CrmStageTrackerProps',
+        exportPath: './crm',
+    },
+    CrmStatistics: {
+        exportName: 'CrmStatisticsProps',
+        exportPath: './crm',
+    },
+    CurrencyInput: {
+        exportName: 'CurrencyInputProps',
+        exportPath: '.',
+    },
+    DateInput: {
+        exportName: 'DateInputProps',
+        exportPath: '.',
+    },
+    DescriptionList: {
+        exportName: 'DescriptionListProps',
+        exportPath: '.',
+    },
+    DescriptionListItem: {
+        exportName: 'DescriptionListItemProps',
+        exportPath: '.',
+    },
+    Divider: {
+        exportName: 'DividerProps',
+        exportPath: '.',
+    },
+    Dropdown: {
+        exportName: 'DropdownProps',
+        exportPath: '.',
+    },
+    DropdownButtonItem: {
+        exportName: 'DropdownButtonItemProps',
+        exportPath: '.',
+    },
+    EmptyState: {
+        exportName: 'EmptyStateProps',
+        exportPath: '.',
+    },
+    ErrorState: {
+        exportName: 'ErrorStateProps',
+        exportPath: '.',
+    },
+    ExpandableText: {
+        exportName: 'ExpandableTextProps',
+        exportPath: './experimental',
+    },
+    FileInput: {
+        exportName: 'FileInputProps',
+        exportPath: './experimental',
+    },
+    Flex: {
+        exportName: 'FlexProps',
+        exportPath: '.',
+    },
+    Form: {
+        exportName: 'FormProps',
+        exportPath: '.',
+    },
+    Grid: {
+        exportName: 'GridProps',
+        exportPath: './experimental',
+    },
+    GridItem: {
+        exportName: 'GridItemProps',
+        exportPath: './experimental',
+    },
+    HeaderActions: {
+        exportName: 'HeaderActionsProps',
+        exportPath: '.',
+    },
+    Heading: {
+        exportName: 'HeadingProps',
+        exportPath: '.',
+    },
+    Icon: {
+        exportName: 'IconProps',
+        exportPath: '.',
+    },
+    Iframe: {
+        exportName: 'IframeProps',
+        exportPath: '.',
+    },
+    Illustration: {
+        exportName: 'IllustrationProps',
+        exportPath: '.',
+    },
+    Image: {
+        exportName: 'ImageProps',
+        exportPath: '.',
+    },
+    Inline: {
+        exportName: 'InlineProps',
+        exportPath: '.',
+    },
+    Input: {
+        exportName: 'InputProps',
+        exportPath: '.',
+    },
+    LineChart: {
+        exportName: 'LineChartProps',
+        exportPath: '.',
+    },
+    Link: {
+        exportName: 'LinkProps',
+        exportPath: '.',
+    },
+    List: {
+        exportName: 'ListProps',
+        exportPath: '.',
+    },
+    LoadingButton: {
+        exportName: 'LoadingButtonProps',
+        exportPath: '.',
+    },
+    LoadingSpinner: {
+        exportName: 'LoadingSpinnerProps',
+        exportPath: '.',
+    },
+    MediaObject: {
+        exportName: 'MediaObjectProps',
+        exportPath: './experimental',
+    },
+    Modal: {
+        exportName: 'ModalProps',
+        exportPath: '.',
+    },
+    ModalBody: {
+        exportName: 'ModalBodyProps',
+        exportPath: '.',
+    },
+    ModalFooter: {
+        exportName: 'ModalFooterProps',
+        exportPath: '.',
+    },
+    MultiSelect: {
+        exportName: 'MultiSelectProps',
+        exportPath: '.',
+    },
+    NumberInput: {
+        exportName: 'NumberInputProps',
+        exportPath: '.',
+    },
+    Panel: {
+        exportName: 'PanelProps',
+        exportPath: '.',
+    },
+    PanelBody: {
+        exportName: 'PanelBodyProps',
+        exportPath: '.',
+    },
+    PanelFooter: {
+        exportName: 'PanelFooterProps',
+        exportPath: '.',
+    },
+    PanelSection: {
+        exportName: 'PanelSectionProps',
+        exportPath: '.',
+    },
+    Popover: {
+        exportName: 'PopoverProps',
+        exportPath: './experimental',
+    },
+    PrimaryHeaderActionButton: {
+        exportName: 'HeaderActionButtonProps',
+        exportPath: '.',
+    },
+    ProgressBar: {
+        exportName: 'ProgressBarProps',
+        exportPath: '.',
+    },
+    RadioButton: {
+        exportName: 'RadioButtonProps',
+        exportPath: '.',
+    },
+    ScoreCircle: {
+        exportName: 'ScoreProps',
+        exportPath: '.',
+    },
+    SearchInput: {
+        exportName: 'SearchInputProps',
+        exportPath: '.',
+    },
+    SecondaryHeaderActionButton: {
+        exportName: 'HeaderActionButtonProps',
+        exportPath: '.',
+    },
+    Select: {
+        exportName: 'SelectProps',
+        exportPath: '.',
+    },
+    SettingsView: {
+        exportName: 'SettingsViewProps',
+        exportPath: './experimental',
+    },
+    Stack2: {
+        exportName: 'Stack2Props',
+        exportPath: './experimental',
+    },
+    Statistics: {
+        exportName: 'StatisticsProps',
+        exportPath: '.',
+    },
+    StatisticsItem: {
+        exportName: 'StatisticsItemProps',
+        exportPath: '.',
+    },
+    StatisticsTrend: {
+        exportName: 'StatisticsTrendProps',
+        exportPath: '.',
+    },
+    StatusTag: {
+        exportName: 'StatusTagProps',
+        exportPath: '.',
+    },
+    StepIndicator: {
+        exportName: 'StepIndicatorProps',
+        exportPath: '.',
+    },
+    StepperInput: {
+        exportName: 'StepperInputProps',
+        exportPath: '.',
+    },
+    Tab: {
+        exportName: 'TabProps',
+        exportPath: '.',
+    },
+    Table: {
+        exportName: 'TableProps',
+        exportPath: '.',
+    },
+    TableBody: {
+        exportName: 'TableElementProps',
+        exportPath: '.',
+    },
+    TableCell: {
+        exportName: 'TableCellProps',
+        exportPath: '.',
+    },
+    TableFooter: {
+        exportName: 'TableElementProps',
+        exportPath: '.',
+    },
+    TableHead: {
+        exportName: 'TableElementProps',
+        exportPath: '.',
+    },
+    TableHeader: {
+        exportName: 'TableHeaderProps',
+        exportPath: '.',
+    },
+    TableRow: {
+        exportName: 'TableElementProps',
+        exportPath: '.',
+    },
+    Tabs: {
+        exportName: 'TabsProps',
+        exportPath: '.',
+    },
+    Tag: {
+        exportName: 'TagProps',
+        exportPath: '.',
+    },
+    Text: {
+        exportName: 'TextProps',
+        exportPath: '.',
+    },
+    TextArea: {
+        exportName: 'TextAreaProps',
+        exportPath: '.',
+    },
+    Tile: {
+        exportName: 'TileProps',
+        exportPath: '.',
+    },
+    TimeInput: {
+        exportName: 'TimeInputProps',
+        exportPath: '.',
+    },
+    Toggle: {
+        exportName: 'ToggleProps',
+        exportPath: '.',
+    },
+    ToggleGroup: {
+        exportName: 'ToggleGroupProps',
+        exportPath: '.',
+    },
+    Tooltip: {
+        exportName: 'TooltipProps',
+        exportPath: '.',
+    },
+};
+/**
+ * Gets the type source for a component.
+ *
+ * The component type source is the name of the export and the path the
+ * export is exported from for the `@hubspot/ui-extensions` package.
+ *
+ * @param componentName - The name of the component to get the type source for
+ * @returns The type source for the component
+ */
+export const getComponentTypeSource = (componentName) => {
+    const componentSource = componentSourceLookup[componentName];
+    if (!componentSource) {
+        throw new Error(`Invalid component name: ${componentName}`);
+    }
+    return componentSource;
+};

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

@@ -0,0 +1,31 @@
+import { AnalyzeResultReader, ApiNode } from '@hubspot/ts-export-types-reader';
+/**
+ * Context object passed through the type rendering functions.
+ *
+ * This context maintains state needed for rendering types correctly:
+ * - typesReader: The reader for looking up referenced types
+ * - typePath: An array tracking the current path of type nodes being rendered,
+ *             used to detect actual circular references (not just repeated types)
+ */
+export interface RenderTypeContext {
+    typesReader: AnalyzeResultReader;
+    typePath: ApiNode[];
+}
+/**
+ * Renders a prop's type as an HTML string.
+ *
+ * This function handles the special case of union types in props, which need
+ * to be rendered recursively. All types are wrapped in HTML code tags for
+ * proper HTML rendering.
+ *
+ * @param context - The rendering context containing the types reader
+ * @param propType - The API node representing the prop's type
+ * @returns An HTML string representation of the type (wrapped in code tags)
+ *
+ * @example
+ * ```typescript
+ * renderPropTypeToHtml(context, stringNode) // Returns: "<code>string</code>"
+ * renderPropTypeToHtml(context, unionNode) // Returns: "<code>boolean</code> | <code>number</code> | <code>string</code>"
+ * ```
+ */
+export declare const renderPropTypeToJsx: (context: RenderTypeContext, propType: ApiNode) => string;