@urbicon-ui/shared-types 6.40.4 → 6.43.2
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/README.md +1 -1
- package/dist/component.d.ts +15 -1
- package/dist/component.d.ts.map +1 -1
- package/dist/docs-config.d.ts +0 -6
- package/dist/docs-config.d.ts.map +1 -1
- package/dist/documentation-core.d.ts +0 -79
- package/dist/documentation-core.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/component.ts +15 -1
- package/src/docs-config.ts +0 -6
- package/src/documentation-core.ts +0 -104
package/README.md
CHANGED
|
@@ -23,7 +23,7 @@ Each subpath is consumable on its own so consumers pull in only what they need:
|
|
|
23
23
|
| `.` | Barrel — re-exports everything below except `documentation-core` and `globals`. Includes the component model: `ComponentInfo`, `ComponentStats`, `PropInfo`, `PropSource`, `PropExample`, `VariantInfo`, `VariantExample`, `InheritanceInfo`, `CrossReference`, `PackageInfo` |
|
|
24
24
|
| `./documentation` | `ComponentMetadata`, `DeprecationInfo`, `ComponentBadge`, `SectionOrder`, `LLMConfig` |
|
|
25
25
|
| `./docs-config` | `SvelteDocsConfig`, `DocsPlaygroundConfig`, `VariantsConfig`, `ExamplesConfig`, `ApiConfig`, `OverviewConfig`, `UsageConfig`, `DocsMetadata` |
|
|
26
|
-
| `./documentation-core` | `
|
|
26
|
+
| `./documentation-core` | `ComponentDocumentation`, `ComponentDocumentationFiles`, `DocumentationMetadata`, `LLMSettings` and the section-structure config types (`AutoSectionsConfig`, `CustomSection`, `SectionStructure`, `ParentSectionConfig`) |
|
|
27
27
|
| `./examples` | `ComponentExample`, `UsagePattern`, `ExampleCollection`, `ExampleGroup` |
|
|
28
28
|
| `./playground` | `PlaygroundConfig`, `ControlDefinition`, `ControlType`, `ControlOption`, `ControlCondition`, `CodeGenerator`, `CodeGeneratorConfig`, `ImportStatement`, `PlaygroundExample`, `PlaygroundMetadata`, `PlaygroundFeature` |
|
|
29
29
|
| `./navigation` | `NavigationItem`, `NavigationMetadata`, `NavigationState`, `NavigationBadge`, `TableOfContents`, `TOCItem`, `TOCSettings`, `Breadcrumb`, `BreadcrumbItem`, `BreadcrumbSettings`, `SiteNavigation`, `NavigationContext`, `NavigationSearchResult`, `SearchMatch` |
|
package/dist/component.d.ts
CHANGED
|
@@ -81,8 +81,22 @@ export interface PropInfo {
|
|
|
81
81
|
since?: string;
|
|
82
82
|
/** Values */
|
|
83
83
|
values?: string[];
|
|
84
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
* A **navigable** `@see` target: an absolute URL, a route-relative path
|
|
86
|
+
* (`/blocks/primitives/button#variants`) or a bare fragment (`#type-Foo`).
|
|
87
|
+
* Renderers turn this into a link on the prop's type. Set either from a
|
|
88
|
+
* `@see` tag that carries such a target or by docs-gen's own type-link
|
|
89
|
+
* resolution.
|
|
90
|
+
*/
|
|
85
91
|
seeAlso?: string;
|
|
92
|
+
/**
|
|
93
|
+
* **Prose** `@see` references — bare type or member names such as
|
|
94
|
+
* `HTMLButtonAttributes.value` or `CartesianDatum`, in source order.
|
|
95
|
+
* These have no doc URL, so they are rendered as literal text rather than
|
|
96
|
+
* as a link. Kept separate from {@link PropInfo.seeAlso} precisely so a
|
|
97
|
+
* renderer never has to guess which of the two kinds it holds.
|
|
98
|
+
*/
|
|
99
|
+
seeAlsoRefs?: string[];
|
|
86
100
|
/**
|
|
87
101
|
* When the host type is a discriminated union (e.g.
|
|
88
102
|
* `type Foo = A | B`), this records the variants in which the prop
|
package/dist/component.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../src/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAG7B,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,yBAAyB;IACzB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,8BAA8B;IAC9B,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,2BAA2B;IAC3B,KAAK,EAAE,cAAc,CAAC;IAGtB,8BAA8B;IAC9B,aAAa,CAAC,EAAE,sBAAsB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,uBAAuB;IACvB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,wBAAwB;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB
|
|
1
|
+
{"version":3,"file":"component.d.ts","sourceRoot":"","sources":["../src/component.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAAG,cAAc,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAE5B,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,8BAA8B;IAC9B,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,0BAA0B;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAG7B,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,yBAAyB;IACzB,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,8BAA8B;IAC9B,WAAW,EAAE,eAAe,EAAE,CAAC;IAC/B,2BAA2B;IAC3B,KAAK,EAAE,cAAc,CAAC;IAGtB,8BAA8B;IAC9B,aAAa,CAAC,EAAE,sBAAsB,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,MAAM,EAAE,UAAU,CAAC;IACnB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,uBAAuB;IACvB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,wBAAwB;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,2BAA2B;IAC3B,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,wBAAwB;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,GAAG,MAAM,GAAG,UAAU,CAAC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
|
package/dist/docs-config.d.ts
CHANGED
|
@@ -49,8 +49,6 @@ export interface DocsPlaygroundConfig {
|
|
|
49
49
|
export interface VariantsConfig {
|
|
50
50
|
/** Variants to exclude from showcase */
|
|
51
51
|
exclude?: string[];
|
|
52
|
-
/** How to group variants (by intent, size, etc.) */
|
|
53
|
-
groupBy?: string;
|
|
54
52
|
/** Maximum variants to show per group */
|
|
55
53
|
limit?: number;
|
|
56
54
|
/** Enable/disable variants section */
|
|
@@ -73,10 +71,6 @@ export interface ExamplesConfig {
|
|
|
73
71
|
* API reference configuration
|
|
74
72
|
*/
|
|
75
73
|
export interface ApiConfig {
|
|
76
|
-
/** Show inherited properties */
|
|
77
|
-
showInheritance?: boolean;
|
|
78
|
-
/** Show deprecated properties */
|
|
79
|
-
showDeprecated?: boolean;
|
|
80
74
|
/** Enable/disable API section */
|
|
81
75
|
enabled?: boolean;
|
|
82
76
|
/** Section order */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs-config.d.ts","sourceRoot":"","sources":["../src/docs-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gDAAgD;IAChD,UAAU,CAAC,EAAE;QACX,2CAA2C;QAC3C,UAAU,CAAC,EAAE,oBAAoB,CAAC;QAElC,sCAAsC;QACtC,QAAQ,CAAC,EAAE,cAAc,CAAC;QAE1B,uDAAuD;QACvD,QAAQ,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;QAEpC,kCAAkC;QAClC,GAAG,CAAC,EAAE,SAAS,CAAC;QAEhB,qCAAqC;QACrC,QAAQ,CAAC,EAAE,cAAc,CAAC;QAE1B,gCAAgC;QAChC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;KAC/B,CAAC;IAEF,yDAAyD;IACzD,GAAG,CAAC,EAAE,SAAS,CAAC;IAEhB,mDAAmD;IACnD,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,
|
|
1
|
+
{"version":3,"file":"docs-config.d.ts","sourceRoot":"","sources":["../src/docs-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gDAAgD;IAChD,UAAU,CAAC,EAAE;QACX,2CAA2C;QAC3C,UAAU,CAAC,EAAE,oBAAoB,CAAC;QAElC,sCAAsC;QACtC,QAAQ,CAAC,EAAE,cAAc,CAAC;QAE1B,uDAAuD;QACvD,QAAQ,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;QAEpC,kCAAkC;QAClC,GAAG,CAAC,EAAE,SAAS,CAAC;QAEhB,qCAAqC;QACrC,QAAQ,CAAC,EAAE,cAAc,CAAC;QAE1B,gCAAgC;QAChC,KAAK,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC;KAC/B,CAAC;IAEF,yDAAyD;IACzD,GAAG,CAAC,EAAE,SAAS,CAAC;IAEhB,mDAAmD;IACnD,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC/B,gCAAgC;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iCAAiC;IACjC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2BAA2B;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uBAAuB;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,yCAAyC;IACzC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,OAAO,CAAC,iBAAiB,CAAC;IAC9D,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B"}
|
|
@@ -3,83 +3,6 @@ import type { ComponentBadge, LLMConfig } from './documentation.js';
|
|
|
3
3
|
import type { ComponentExample, UsagePattern } from './examples.js';
|
|
4
4
|
import type { NavigationItem } from './navigation.js';
|
|
5
5
|
import type { PlaygroundConfig } from './playground.js';
|
|
6
|
-
/**
|
|
7
|
-
* Documentation section for generation pipeline
|
|
8
|
-
* Used for rendering and processing documentation sections
|
|
9
|
-
*/
|
|
10
|
-
export interface DocumentationSection {
|
|
11
|
-
/** Unique section ID */
|
|
12
|
-
id: string;
|
|
13
|
-
/** Section title */
|
|
14
|
-
title: string;
|
|
15
|
-
/** Section type - primary categorization */
|
|
16
|
-
type: SectionType;
|
|
17
|
-
/** Display order */
|
|
18
|
-
order: number;
|
|
19
|
-
/** Section content */
|
|
20
|
-
content: SectionContent;
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Available section types
|
|
24
|
-
*/
|
|
25
|
-
export type SectionType = 'overview' | 'playground' | 'examples' | 'variants' | 'api' | 'types' | 'accessibility' | 'custom' | 'text';
|
|
26
|
-
/**
|
|
27
|
-
* Union type for different section content types
|
|
28
|
-
* Content type is inferred from DocumentationSection.type
|
|
29
|
-
*/
|
|
30
|
-
export type SectionContent = ExampleContent | PlaygroundContent | TextContent | ApiContent | VariantsContent | CustomContent;
|
|
31
|
-
/**
|
|
32
|
-
* Example section content
|
|
33
|
-
*/
|
|
34
|
-
export interface ExampleContent {
|
|
35
|
-
examples: ComponentExample[];
|
|
36
|
-
showCategories?: boolean;
|
|
37
|
-
groupByCategory?: boolean;
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Playground section content
|
|
41
|
-
*/
|
|
42
|
-
export interface PlaygroundContent {
|
|
43
|
-
config: PlaygroundConfig;
|
|
44
|
-
showCodePreview?: boolean;
|
|
45
|
-
showInlineControls?: boolean;
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Text/markdown section content
|
|
49
|
-
*/
|
|
50
|
-
export interface TextContent {
|
|
51
|
-
content: string;
|
|
52
|
-
format?: 'markdown' | 'html' | 'plain';
|
|
53
|
-
variables?: Record<string, unknown>;
|
|
54
|
-
}
|
|
55
|
-
/**
|
|
56
|
-
* API reference section content. `props` is typed as `unknown[]` because
|
|
57
|
-
* this base type ships without a runtime dependency on docs-gen's PropInfo.
|
|
58
|
-
*/
|
|
59
|
-
export interface ApiContent {
|
|
60
|
-
props: unknown[];
|
|
61
|
-
showInherited?: boolean;
|
|
62
|
-
groupByCategory?: boolean;
|
|
63
|
-
showExamples?: boolean;
|
|
64
|
-
}
|
|
65
|
-
/**
|
|
66
|
-
* Variants showcase section content. `variants` is typed as `unknown[]`
|
|
67
|
-
* because this base type ships without a runtime dependency on docs-gen's
|
|
68
|
-
* VariantInfo.
|
|
69
|
-
*/
|
|
70
|
-
export interface VariantsContent {
|
|
71
|
-
variants: unknown[];
|
|
72
|
-
showExamples?: boolean;
|
|
73
|
-
showCombinations?: boolean;
|
|
74
|
-
}
|
|
75
|
-
/**
|
|
76
|
-
* Custom section content
|
|
77
|
-
*/
|
|
78
|
-
export interface CustomContent {
|
|
79
|
-
content: string;
|
|
80
|
-
template?: string;
|
|
81
|
-
variables?: Record<string, unknown>;
|
|
82
|
-
}
|
|
83
6
|
/**
|
|
84
7
|
* Complete component documentation structure.
|
|
85
8
|
* Either auto-generated or manually created.
|
|
@@ -105,8 +28,6 @@ export interface ComponentDocumentation {
|
|
|
105
28
|
llmSettings: LLMSettings;
|
|
106
29
|
/** Documentation metadata */
|
|
107
30
|
metadata?: DocumentationMetadata;
|
|
108
|
-
/** Documentation sections (for docs-gen compatibility) */
|
|
109
|
-
sections?: DocumentationSection[];
|
|
110
31
|
}
|
|
111
32
|
/**
|
|
112
33
|
* Configuration for auto-generated sections
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"documentation-core.d.ts","sourceRoot":"","sources":["../src/documentation-core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"documentation-core.d.ts","sourceRoot":"","sources":["../src/documentation-core.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IAEpB,qBAAqB;IACrB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAE1B,4CAA4C;IAC5C,YAAY,EAAE,kBAAkB,CAAC;IAEjC,sBAAsB;IACtB,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC,qCAAqC;IACrC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC,uBAAuB;IACvB,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAE9B,4BAA4B;IAC5B,WAAW,EAAE,WAAW,CAAC;IAEzB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6BAA6B;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,2BAA2B;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,wBAAwB;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,sBAAsB;IACtB,KAAK,EAAE,OAAO,CAAC;IACf,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;IAClC,oBAAoB;IACpB,GAAG,EAAE,OAAO,CAAC;IACb,4BAA4B;IAC5B,aAAa,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,2CAA2C;IAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,iCAAiC;IACjC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,+BAA+B;IAC/B,sBAAsB,EAAE,OAAO,CAAC;IAChC,iCAAiC;IACjC,cAAc,EAAE,OAAO,CAAC;IACxB,mCAAmC;IACnC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,mCAAmC;IACnC,mBAAmB,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,YAAY,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mBAAmB;IACnB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,oBAAoB;IACpB,YAAY,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC/C,yBAAyB;IACzB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,yBAAyB;IACzB,QAAQ,EAAE,gBAAgB,EAAE,CAAC;IAC7B,+BAA+B;IAC/B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,iCAAiC;IACjC,OAAO,EAAE,sBAAsB,CAAC;IAChC,qBAAqB;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;IAC1B,gCAAgC;IAChC,SAAS,CAAC,EAAE,aAAa,CAAC;CAC3B;AAGD,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,CAAC"}
|
package/package.json
CHANGED
package/src/component.ts
CHANGED
|
@@ -89,8 +89,22 @@ export interface PropInfo {
|
|
|
89
89
|
since?: string;
|
|
90
90
|
/** Values */
|
|
91
91
|
values?: string[];
|
|
92
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* A **navigable** `@see` target: an absolute URL, a route-relative path
|
|
94
|
+
* (`/blocks/primitives/button#variants`) or a bare fragment (`#type-Foo`).
|
|
95
|
+
* Renderers turn this into a link on the prop's type. Set either from a
|
|
96
|
+
* `@see` tag that carries such a target or by docs-gen's own type-link
|
|
97
|
+
* resolution.
|
|
98
|
+
*/
|
|
93
99
|
seeAlso?: string;
|
|
100
|
+
/**
|
|
101
|
+
* **Prose** `@see` references — bare type or member names such as
|
|
102
|
+
* `HTMLButtonAttributes.value` or `CartesianDatum`, in source order.
|
|
103
|
+
* These have no doc URL, so they are rendered as literal text rather than
|
|
104
|
+
* as a link. Kept separate from {@link PropInfo.seeAlso} precisely so a
|
|
105
|
+
* renderer never has to guess which of the two kinds it holds.
|
|
106
|
+
*/
|
|
107
|
+
seeAlsoRefs?: string[];
|
|
94
108
|
/**
|
|
95
109
|
* When the host type is a discriminated union (e.g.
|
|
96
110
|
* `type Foo = A | B`), this records the variants in which the prop
|
package/src/docs-config.ts
CHANGED
|
@@ -59,8 +59,6 @@ export interface DocsPlaygroundConfig {
|
|
|
59
59
|
export interface VariantsConfig {
|
|
60
60
|
/** Variants to exclude from showcase */
|
|
61
61
|
exclude?: string[];
|
|
62
|
-
/** How to group variants (by intent, size, etc.) */
|
|
63
|
-
groupBy?: string;
|
|
64
62
|
/** Maximum variants to show per group */
|
|
65
63
|
limit?: number;
|
|
66
64
|
/** Enable/disable variants section */
|
|
@@ -85,10 +83,6 @@ export interface ExamplesConfig {
|
|
|
85
83
|
* API reference configuration
|
|
86
84
|
*/
|
|
87
85
|
export interface ApiConfig {
|
|
88
|
-
/** Show inherited properties */
|
|
89
|
-
showInheritance?: boolean;
|
|
90
|
-
/** Show deprecated properties */
|
|
91
|
-
showDeprecated?: boolean;
|
|
92
86
|
/** Enable/disable API section */
|
|
93
87
|
enabled?: boolean;
|
|
94
88
|
/** Section order */
|
|
@@ -4,107 +4,6 @@ import type { ComponentExample, UsagePattern } from './examples.js';
|
|
|
4
4
|
import type { NavigationItem } from './navigation.js';
|
|
5
5
|
import type { PlaygroundConfig } from './playground.js';
|
|
6
6
|
|
|
7
|
-
/**
|
|
8
|
-
* Documentation section for generation pipeline
|
|
9
|
-
* Used for rendering and processing documentation sections
|
|
10
|
-
*/
|
|
11
|
-
export interface DocumentationSection {
|
|
12
|
-
/** Unique section ID */
|
|
13
|
-
id: string;
|
|
14
|
-
/** Section title */
|
|
15
|
-
title: string;
|
|
16
|
-
/** Section type - primary categorization */
|
|
17
|
-
type: SectionType;
|
|
18
|
-
/** Display order */
|
|
19
|
-
order: number;
|
|
20
|
-
/** Section content */
|
|
21
|
-
content: SectionContent;
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* Available section types
|
|
26
|
-
*/
|
|
27
|
-
export type SectionType =
|
|
28
|
-
| 'overview'
|
|
29
|
-
| 'playground'
|
|
30
|
-
| 'examples'
|
|
31
|
-
| 'variants'
|
|
32
|
-
| 'api'
|
|
33
|
-
| 'types'
|
|
34
|
-
| 'accessibility'
|
|
35
|
-
| 'custom'
|
|
36
|
-
| 'text';
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Union type for different section content types
|
|
40
|
-
* Content type is inferred from DocumentationSection.type
|
|
41
|
-
*/
|
|
42
|
-
export type SectionContent =
|
|
43
|
-
| ExampleContent
|
|
44
|
-
| PlaygroundContent
|
|
45
|
-
| TextContent
|
|
46
|
-
| ApiContent
|
|
47
|
-
| VariantsContent
|
|
48
|
-
| CustomContent;
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Example section content
|
|
52
|
-
*/
|
|
53
|
-
export interface ExampleContent {
|
|
54
|
-
examples: ComponentExample[];
|
|
55
|
-
showCategories?: boolean;
|
|
56
|
-
groupByCategory?: boolean;
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Playground section content
|
|
61
|
-
*/
|
|
62
|
-
export interface PlaygroundContent {
|
|
63
|
-
config: PlaygroundConfig;
|
|
64
|
-
showCodePreview?: boolean;
|
|
65
|
-
showInlineControls?: boolean;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Text/markdown section content
|
|
70
|
-
*/
|
|
71
|
-
export interface TextContent {
|
|
72
|
-
content: string;
|
|
73
|
-
format?: 'markdown' | 'html' | 'plain';
|
|
74
|
-
variables?: Record<string, unknown>;
|
|
75
|
-
}
|
|
76
|
-
|
|
77
|
-
/**
|
|
78
|
-
* API reference section content. `props` is typed as `unknown[]` because
|
|
79
|
-
* this base type ships without a runtime dependency on docs-gen's PropInfo.
|
|
80
|
-
*/
|
|
81
|
-
export interface ApiContent {
|
|
82
|
-
props: unknown[];
|
|
83
|
-
showInherited?: boolean;
|
|
84
|
-
groupByCategory?: boolean;
|
|
85
|
-
showExamples?: boolean;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
/**
|
|
89
|
-
* Variants showcase section content. `variants` is typed as `unknown[]`
|
|
90
|
-
* because this base type ships without a runtime dependency on docs-gen's
|
|
91
|
-
* VariantInfo.
|
|
92
|
-
*/
|
|
93
|
-
export interface VariantsContent {
|
|
94
|
-
variants: unknown[];
|
|
95
|
-
showExamples?: boolean;
|
|
96
|
-
showCombinations?: boolean;
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* Custom section content
|
|
101
|
-
*/
|
|
102
|
-
export interface CustomContent {
|
|
103
|
-
content: string;
|
|
104
|
-
template?: string;
|
|
105
|
-
variables?: Record<string, unknown>;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
7
|
/**
|
|
109
8
|
* Complete component documentation structure.
|
|
110
9
|
* Either auto-generated or manually created.
|
|
@@ -137,9 +36,6 @@ export interface ComponentDocumentation {
|
|
|
137
36
|
|
|
138
37
|
/** Documentation metadata */
|
|
139
38
|
metadata?: DocumentationMetadata;
|
|
140
|
-
|
|
141
|
-
/** Documentation sections (for docs-gen compatibility) */
|
|
142
|
-
sections?: DocumentationSection[];
|
|
143
39
|
}
|
|
144
40
|
|
|
145
41
|
/**
|