@hubspot/ui-extensions-sdk-api-metadata 0.12.2 → 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.
- package/dist/__generated__/component-props.js +1181 -139
- package/dist/__tests__/component-props-docs.spec.js +3 -0
- package/dist/component-props-docs.d.ts +1 -1
- package/dist/component-props-docs.js +2 -2
- package/dist/internal/get-type-source.d.ts +1 -1
- package/dist/internal/get-type-source.js +60 -0
- package/dist/internal/render-prop-type.d.ts +1 -1
- package/dist/internal/utils/jsdoc-utils.d.ts +1 -1
- package/dist/internal/utils/jsx-utils.js +1 -1
- package/dist/types.d.ts +15 -0
- package/dist/types.js +15 -0
- package/package.json +25 -17
|
@@ -217,6 +217,9 @@ describe('getComponentPropsDocumentation', () => {
|
|
|
217
217
|
it('should return the correct component prop documentation for the SettingsView component', async () => {
|
|
218
218
|
await runComponentPropsSnapshotTest(ComponentName.SettingsView);
|
|
219
219
|
});
|
|
220
|
+
it('should return the correct component prop documentation for the Spacer component', async () => {
|
|
221
|
+
await runComponentPropsSnapshotTest(ComponentName.Spacer);
|
|
222
|
+
});
|
|
220
223
|
it('should return the correct component prop documentation for the Stack2 component', async () => {
|
|
221
224
|
await runComponentPropsSnapshotTest(ComponentName.Stack2);
|
|
222
225
|
});
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { isObjectNode, isTypeReferenceNode, } from '@hubspot/ts-export-types-reader';
|
|
2
2
|
import { componentPropsReader } from "./__generated__/component-props.js";
|
|
3
|
-
import {
|
|
3
|
+
import { getComponentTypeSource } from "./internal/get-type-source.js";
|
|
4
|
+
import { renderPropTypeToJsx } from "./internal/render-prop-type.js";
|
|
4
5
|
import { getDefaultValueFromJsdocTags, getSeeTagsFromJsdocTags, hasDeprecatedJsdocTag, } from "./internal/utils/jsdoc-utils.js";
|
|
5
6
|
import { renderMarkdownToJsx } from "./internal/utils/markdown-utils.js";
|
|
6
|
-
import { getComponentTypeSource } from "./internal/get-type-source.js";
|
|
7
7
|
/**
|
|
8
8
|
* Recursively resolves an API node to an ObjectNode if possible.
|
|
9
9
|
*
|
|
@@ -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: '.',
|
|
@@ -284,6 +340,10 @@ const componentSourceLookup = {
|
|
|
284
340
|
exportName: 'SettingsViewProps',
|
|
285
341
|
exportPath: './experimental',
|
|
286
342
|
},
|
|
343
|
+
Spacer: {
|
|
344
|
+
exportName: 'SpacerProps',
|
|
345
|
+
exportPath: '.',
|
|
346
|
+
},
|
|
287
347
|
Stack2: {
|
|
288
348
|
exportName: 'Stack2Props',
|
|
289
349
|
exportPath: './experimental',
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* This module provides helper functions for parsing and extracting information
|
|
5
5
|
* from JSDoc comments associated with component props, such as default values.
|
|
6
6
|
*/
|
|
7
|
-
import { JsdocTag } from '@hubspot/ts-export-types-reader';
|
|
7
|
+
import type { JsdocTag } from '@hubspot/ts-export-types-reader';
|
|
8
8
|
/**
|
|
9
9
|
* Extracts the default value from JSDoc tags.
|
|
10
10
|
*
|
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",
|
|
@@ -105,6 +119,7 @@ export declare enum ComponentName {
|
|
|
105
119
|
SecondaryHeaderActionButton = "SecondaryHeaderActionButton",
|
|
106
120
|
Select = "Select",
|
|
107
121
|
SettingsView = "SettingsView",
|
|
122
|
+
Spacer = "Spacer",
|
|
108
123
|
Stack2 = "Stack2",
|
|
109
124
|
Statistics = "Statistics",
|
|
110
125
|
StatisticsItem = "StatisticsItem",
|
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";
|
|
@@ -75,6 +89,7 @@ export var ComponentName;
|
|
|
75
89
|
ComponentName["SecondaryHeaderActionButton"] = "SecondaryHeaderActionButton";
|
|
76
90
|
ComponentName["Select"] = "Select";
|
|
77
91
|
ComponentName["SettingsView"] = "SettingsView";
|
|
92
|
+
ComponentName["Spacer"] = "Spacer";
|
|
78
93
|
ComponentName["Stack2"] = "Stack2";
|
|
79
94
|
ComponentName["Statistics"] = "Statistics";
|
|
80
95
|
ComponentName["StatisticsItem"] = "StatisticsItem";
|
package/package.json
CHANGED
|
@@ -1,19 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hubspot/ui-extensions-sdk-api-metadata",
|
|
3
|
-
"version": "0.12.
|
|
3
|
+
"version": "0.12.4",
|
|
4
4
|
"description": "UI Extensions SDK API Metadata",
|
|
5
5
|
"type": "module",
|
|
6
|
-
"
|
|
7
|
-
"clean": "rm -rf dist/ src/__generated__/",
|
|
8
|
-
"build": "npm run clean && npm run generate && tsc",
|
|
9
|
-
"check:tsc": "tsc",
|
|
10
|
-
"generate": "npm run generate:sdk-api-metadata",
|
|
11
|
-
"generate:sdk-api-metadata": "(cd ../ui-extensions-components && npm run build) && ts-export-types analyze --config ts-export-types.component-props.config.js",
|
|
12
|
-
"test": "vitest run",
|
|
13
|
-
"watch": "npm run clean && tsc --watch",
|
|
14
|
-
"prepublishOnly": "npm run build",
|
|
15
|
-
"lint": "echo 'No linter configured for @hubspot/ui-extensions-sdk-api-metadata'"
|
|
16
|
-
},
|
|
6
|
+
"prettier": "@private/prettier-config",
|
|
17
7
|
"files": [
|
|
18
8
|
"dist"
|
|
19
9
|
],
|
|
@@ -26,18 +16,36 @@
|
|
|
26
16
|
"license": "MIT",
|
|
27
17
|
"dependencies": {
|
|
28
18
|
"@hubspot/ts-export-types-reader": "1.1.0",
|
|
29
|
-
"dom-serializer": "
|
|
30
|
-
"htmlparser2": "
|
|
19
|
+
"dom-serializer": "2.0.0",
|
|
20
|
+
"htmlparser2": "9.1.0",
|
|
31
21
|
"marked": "17.0.1"
|
|
32
22
|
},
|
|
33
23
|
"devDependencies": {
|
|
34
24
|
"@hubspot/ts-export-types": "1.1.0",
|
|
25
|
+
"@types/node": "22.19.7",
|
|
35
26
|
"@vitest/coverage-v8": "4.0.18",
|
|
27
|
+
"@vitest/eslint-plugin": "1.6.6",
|
|
28
|
+
"eslint": "9.39.2",
|
|
29
|
+
"prettier": "3.8.1",
|
|
36
30
|
"typescript": "5.9.3",
|
|
37
|
-
"vitest": "4.0.18"
|
|
31
|
+
"vitest": "4.0.18",
|
|
32
|
+
"@private/prettier-config": "1.0.0",
|
|
33
|
+
"@hubspot/ui-extensions": "0.12.4",
|
|
34
|
+
"@private/eslint-config": "1.0.0"
|
|
38
35
|
},
|
|
39
36
|
"engines": {
|
|
40
37
|
"node": ">=16"
|
|
41
38
|
},
|
|
42
|
-
"
|
|
43
|
-
|
|
39
|
+
"scripts": {
|
|
40
|
+
"clean": "rm -rf dist/ *.tsbuildinfo .turbo src/__generated__/",
|
|
41
|
+
"format": "prettier --write . --ignore-path ../../.prettierignore",
|
|
42
|
+
"format:check": "prettier --check . --ignore-path ../../.prettierignore",
|
|
43
|
+
"generate": "pnpm run generate:sdk-api-metadata",
|
|
44
|
+
"generate:sdk-api-metadata": "ts-export-types analyze --config ts-export-types.component-props.config.js",
|
|
45
|
+
"lint": "eslint src/",
|
|
46
|
+
"lint:fix": "eslint src/ --fix",
|
|
47
|
+
"test": "vitest run",
|
|
48
|
+
"tsc": "tsc",
|
|
49
|
+
"tsc:watch": "tsc --watch"
|
|
50
|
+
}
|
|
51
|
+
}
|