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

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/__tests__/jsx-utils.spec.js

@@ -5,39 +5,39 @@ describe('convertHtmlToJsx', () => {
         it('should convert <br> to self-closing tag', () => {
             const input = '<strong>Hello<br>World</strong>';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><strong>Hello<br/>World</strong></>');
+            expect(output).toBe('<><strong>Hello<br />World</strong></>');
         });
         it('should convert <hr> to self-closing tag', () => {
             const input = '<div>Section 1<hr>Section 2</div>';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><div>Section 1<hr/>Section 2</div></>');
+            expect(output).toBe('<><div>Section 1<hr />Section 2</div></>');
         });
         it('should convert <img> to self-closing tag', () => {
             const input = '<img src="test.png">';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><img src="test.png"/></>');
+            expect(output).toBe('<><img src="test.png" /></>');
         });
         it('should convert <input> to self-closing tag', () => {
             const input = '<input type="text" name="field">';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><input type="text" name="field"/></>');
+            expect(output).toBe('<><input type="text" name="field" /></>');
         });
         it('should handle multiple void elements', () => {
             const input = '<div><img src="a.png"><br><img src="b.png"></div>';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><div><img src="a.png"/><br/><img src="b.png"/></div></>');
+            expect(output).toBe('<><div><img src="a.png" /><br /><img src="b.png" /></div></>');
         });
         it('should preserve already self-closing tags', () => {
             const input = '<strong>Hello<br/>World</strong>';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><strong>Hello<br/>World</strong></>');
+            expect(output).toBe('<><strong>Hello<br />World</strong></>');
         });
     });
     describe('attributes', () => {
         it('should preserve attributes on void elements', () => {
             const input = '<img src="test.png" alt="Test Image" width="100">';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><img src="test.png" alt="Test Image" width="100"/></>');
+            expect(output).toBe('<><img src="test.png" alt="Test Image" width="100" /></>');
         });
         it('should preserve attributes on regular elements', () => {
             const input = '<div class="container" id="main">Content</div>';
@@ -59,7 +59,7 @@ describe('convertHtmlToJsx', () => {
         it('should handle void elements within nested structures', () => {
             const input = '<div><p>Line 1<br>Line 2</p><hr><p>Line 3</p></div>';
             const output = convertHtmlToJsx(input);
-            expect(output).toBe('<><div><p>Line 1<br/>Line 2</p><hr/><p>Line 3</p></div></>');
+            expect(output).toBe('<><div><p>Line 1<br />Line 2</p><hr /><p>Line 3</p></div></>');
         });
     });
     describe('text content', () => {
@@ -100,8 +100,8 @@ describe('convertHtmlToJsx', () => {
         it('should handle empty elements', () => {
             const input = '<strong></strong>';
             const output = convertHtmlToJsx(input);
-            // Empty elements are converted to self-closing tags in XHTML
-            expect(output).toBe('<><strong/></>');
+            // Empty non-void elements remain as open/close tags (not self-closing)
+            expect(output).toBe('<><strong></strong></>');
         });
         it('should handle plain text without tags', () => {
             const input = 'Just plain text';

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 { getDefaultValueFromJsdocTags, getSeeTagsFromJsdocTags, } from "./internal/utils/jsdoc-utils.js";
-import { renderMarkdownToJsx } from "./internal/utils/markdown-utils.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";
 /**
  * Recursively resolves an API node to an ObjectNode if possible.
  *
@@ -73,8 +73,10 @@ export const getComponentPropsDocumentation = (componentName) => {
     if (!propsObject) {
         throw new Error(`Props object not found for component "${componentName}" (${exportName} in ${exportPath})`);
     }
-    // Sort properties first by required status, then alphabetically by name for consistent output
-    const props = [...propsObject.properties].sort((a, b) => {
+    // Filter out deprecated properties, then sort by required status and alphabetically by name for consistent output
+    const props = [...propsObject.properties]
+        .filter((prop) => !hasDeprecatedJsdocTag(prop.jsdoc?.tags))
+        .sort((a, b) => {
         const aRequired = a.isOptional !== true;
         const bRequired = b.isOptional !== true;
         if (aRequired !== bRequired) {

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.
  *
@@ -27,3 +27,14 @@ export declare const getDefaultValueFromJsdocTags: (tags: JsdocTag[] | undefined
  * @returns An array of see tag text values, or an empty array if none found
  */
 export declare const getSeeTagsFromJsdocTags: (tags: JsdocTag[] | undefined) => string[];
+/**
+ * Checks if a property is deprecated based on JSDoc tags.
+ *
+ * Searches through an array of JSDoc tags to determine if a 'deprecated'
+ * tag exists. Properties marked as deprecated should be filtered out from
+ * documentation.
+ *
+ * @param tags - An array of JSDoc tags, or undefined if no tags exist
+ * @returns True if a deprecated tag is found, false otherwise
+ */
+export declare const hasDeprecatedJsdocTag: (tags: JsdocTag[] | undefined) => boolean;

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

@@ -50,3 +50,21 @@ export const getSeeTagsFromJsdocTags = (tags) => {
         .filter((tag) => tag.name === 'see' && tag.text)
         .map((tag) => tag.text);
 };
+/**
+ * Checks if a property is deprecated based on JSDoc tags.
+ *
+ * Searches through an array of JSDoc tags to determine if a 'deprecated'
+ * tag exists. Properties marked as deprecated should be filtered out from
+ * documentation.
+ *
+ * @param tags - An array of JSDoc tags, or undefined if no tags exist
+ * @returns True if a deprecated tag is found, false otherwise
+ */
+export const hasDeprecatedJsdocTag = (tags) => {
+    // Return false if there are no tags
+    if (!tags) {
+        return false;
+    }
+    // Check if any tag is named 'deprecated'
+    return tags.some((tag) => tag.name === 'deprecated');
+};

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('}', '}');
 };
@@ -70,8 +70,18 @@ export const convertHtmlToJsx = (html) => {
     stripOutermostParagraphNode(dom);
     // Serialize back to string with XML rules (self-closing tags, etc.)
     const xhtml = serialize(dom, {
-        xmlMode: true, // Use XML/XHTML serialization rules
-        selfClosingTags: true, // Ensure void elements are self-closing
+        // xmlMode defaults to true which is more aggressive and unnecessary encoding of element text so we turn it off.
+        // We still output XHTML (well-formed XML) by enabling emptyAttrs and selfClosingTags.
+        xmlMode: false,
+        // Print empty attribute values as attr="" (e.g., <input checked=""/>)
+        emptyAttrs: true,
+        // Self-close HTML void elements (br, img, etc.) as <br /> for JSX compatibility.
+        // Note: Non-void empty elements render as <span></span> (not <span/>), but this is fine for JSX.
+        selfClosingTags: true,
+        // encodeEntities controls how element text is encoded. We use utf8 to ensure all
+        // special characters are encoded in addition to the characters that are already encoded by default (&, <, >)
+        // but results in quotes not being encoded for better readability.
+        encodeEntities: 'utf8',
     });
     return `<>${escapeJsxExpressions(xhtml)}</>`;
 };

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.1",
+  "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,17 +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",
-    "@vitest/coverage-v8": "2.1.8",
+    "@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": "2.1.9"
+    "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"
+  },
+  "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"
   }
-}
+}