Fix broken links in docs (#416)

Update the versions of `tsup`, `api-extractor`, and `api-documenter` to generate `d.ts` files that can be used to get docs with links. J=TECHOPS-10771 TEST=manual Go to the docs on this branch and see that props now have links again. For example, in the SearchBar docs: https://github.com/yext/search-ui-react/blob/dev/doc-links/docs/search-ui-react.searchbar.md
yext · Dec 18, 2023 · b6bb9b5 · b6bb9b5
1 parent e41adc6
commit b6bb9b5
Show file tree

Hide file tree

Showing 414 changed files with 2,710 additions and 2,235 deletions.
diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES
diff --git a/api-extractor.json b/api-extractor.json
@@ -45,7 +45,7 @@
    *
    * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
    */
-  "mainEntryPointFilePath": "<projectFolder>/lib/commonjs/index.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
 
   /**
    * A list of NPM package names whose exports should be treated as part of this package.
@@ -221,7 +221,7 @@
      * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
      * DEFAULT VALUE: ""
      */
-    "publicTrimmedFilePath": "<projectFolder>/lib/esm/index.d.ts"
+    "publicTrimmedFilePath": "<projectFolder>/dist/index.d.ts"
 
     /**
      * When a declaration is trimmed, by default it will be replaced by a code comment such as

diff --git a/docs/search-ui-react.alternativeverticals.md b/docs/search-ui-react.alternativeverticals.md
@@ -6,7 +6,7 @@
 
 A component that displays the alternative verticals that have results if a search returns none on the current vertical.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 declare function AlternativeVerticals({ currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses }: AlternativeVerticalsProps): JSX.Element | null;
@@ -16,9 +16,9 @@ declare function AlternativeVerticals({ currentVerticalLabel, verticalConfigMap,
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses } | AlternativeVerticalsProps |  |
+|  { currentVerticalLabel, verticalConfigMap, displayAllOnNoResults, customCssClasses } | [AlternativeVerticalsProps](./search-ui-react.alternativeverticalsprops.md) |  |
 
-<b>Returns:</b>
+**Returns:**
 
 JSX.Element \| null
 

diff --git a/...search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md b/...search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.alternativeVerticalsContainer property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 alternativeVerticalsContainer?: string;

diff --git a/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md b/docs/search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.alternativeVerticalsLoading property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 alternativeVerticalsLoading?: string;

diff --git a/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md b/docs/search-ui-react.alternativeverticalscssclasses.categoriestext.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.categoriesText property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 categoriesText?: string;

diff --git a/docs/search-ui-react.alternativeverticalscssclasses.md b/docs/search-ui-react.alternativeverticalscssclasses.md
@@ -6,20 +6,20 @@
 
 The CSS class interface used for [AlternativeVerticals()](./search-ui-react.alternativeverticals.md)<!-- -->.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 interface AlternativeVerticalsCssClasses 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [alternativeVerticalsContainer?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md) | string | <i>(Optional)</i> |
-|  [alternativeVerticalsLoading?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md) | string | <i>(Optional)</i> |
-|  [categoriesText?](./search-ui-react.alternativeverticalscssclasses.categoriestext.md) | string | <i>(Optional)</i> |
-|  [noResultsText?](./search-ui-react.alternativeverticalscssclasses.noresultstext.md) | string | <i>(Optional)</i> |
-|  [suggestion?](./search-ui-react.alternativeverticalscssclasses.suggestion.md) | string | <i>(Optional)</i> |
-|  [verticalIcon?](./search-ui-react.alternativeverticalscssclasses.verticalicon.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [alternativeVerticalsContainer?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalscontainer.md) |  | string | _(Optional)_ |
+|  [alternativeVerticalsLoading?](./search-ui-react.alternativeverticalscssclasses.alternativeverticalsloading.md) |  | string | _(Optional)_ |
+|  [categoriesText?](./search-ui-react.alternativeverticalscssclasses.categoriestext.md) |  | string | _(Optional)_ |
+|  [noResultsText?](./search-ui-react.alternativeverticalscssclasses.noresultstext.md) |  | string | _(Optional)_ |
+|  [suggestion?](./search-ui-react.alternativeverticalscssclasses.suggestion.md) |  | string | _(Optional)_ |
+|  [verticalIcon?](./search-ui-react.alternativeverticalscssclasses.verticalicon.md) |  | string | _(Optional)_ |
 
diff --git a/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md b/docs/search-ui-react.alternativeverticalscssclasses.noresultstext.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.noResultsText property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 noResultsText?: string;

diff --git a/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md b/docs/search-ui-react.alternativeverticalscssclasses.suggestion.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.suggestion property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 suggestion?: string;

diff --git a/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md b/docs/search-ui-react.alternativeverticalscssclasses.verticalicon.md
@@ -4,7 +4,7 @@
 
 ## AlternativeVerticalsCssClasses.verticalIcon property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 verticalIcon?: string;

diff --git a/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md b/docs/search-ui-react.alternativeverticalsprops.currentverticallabel.md
@@ -6,7 +6,7 @@
 
 The label for the current vertical.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 currentVerticalLabel: string;

diff --git a/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md b/docs/search-ui-react.alternativeverticalsprops.customcssclasses.md
@@ -6,7 +6,7 @@
 
 CSS classes for customizing the component styling.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 customCssClasses?: AlternativeVerticalsCssClasses;

diff --git a/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md b/docs/search-ui-react.alternativeverticalsprops.displayallonnoresults.md
@@ -6,7 +6,7 @@
 
 Whether or not all results should be displayed when there are none returned from the search. Defaults to true.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 displayAllOnNoResults?: boolean;

diff --git a/docs/search-ui-react.alternativeverticalsprops.md b/docs/search-ui-react.alternativeverticalsprops.md
@@ -6,18 +6,18 @@
 
 Props for [AlternativeVerticals()](./search-ui-react.alternativeverticals.md)<!-- -->.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 interface AlternativeVerticalsProps 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [currentVerticalLabel](./search-ui-react.alternativeverticalsprops.currentverticallabel.md) | string | The label for the current vertical. |
-|  [customCssClasses?](./search-ui-react.alternativeverticalsprops.customcssclasses.md) | AlternativeVerticalsCssClasses | <i>(Optional)</i> CSS classes for customizing the component styling. |
-|  [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) | boolean | <i>(Optional)</i> Whether or not all results should be displayed when there are none returned from the search. Defaults to true. |
-|  [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) | VerticalLabelMap | A map of verticalKeys to the display label for that vertical. |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [currentVerticalLabel](./search-ui-react.alternativeverticalsprops.currentverticallabel.md) |  | string | The label for the current vertical. |
+|  [customCssClasses?](./search-ui-react.alternativeverticalsprops.customcssclasses.md) |  | [AlternativeVerticalsCssClasses](./search-ui-react.alternativeverticalscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. |
+|  [displayAllOnNoResults?](./search-ui-react.alternativeverticalsprops.displayallonnoresults.md) |  | boolean | _(Optional)_ Whether or not all results should be displayed when there are none returned from the search. Defaults to true. |
+|  [verticalConfigMap](./search-ui-react.alternativeverticalsprops.verticalconfigmap.md) |  | [VerticalLabelMap](./search-ui-react.verticallabelmap.md) | A map of verticalKeys to the display label for that vertical. |
 
diff --git a/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md b/docs/search-ui-react.alternativeverticalsprops.verticalconfigmap.md
@@ -6,7 +6,7 @@
 
 A map of verticalKeys to the display label for that vertical.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 verticalConfigMap: VerticalLabelMap;

diff --git a/docs/search-ui-react.analyticsprovider.md b/docs/search-ui-react.analyticsprovider.md
@@ -6,7 +6,7 @@
 
 A higher-order component which provides analytics for its children.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 declare function AnalyticsProvider(props: PropsWithChildren<AnalyticsConfig>): JSX.Element;
@@ -18,7 +18,7 @@ declare function AnalyticsProvider(props: PropsWithChildren<AnalyticsConfig>): J
 |  --- | --- | --- |
 |  props | PropsWithChildren&lt;AnalyticsConfig&gt; | The configuration for the analytics service |
 
-<b>Returns:</b>
+**Returns:**
 
 JSX.Element
 

diff --git a/docs/search-ui-react.appliedfilters.md b/docs/search-ui-react.appliedfilters.md
@@ -6,7 +6,7 @@
 
 A component that displays a list of filters applied to the current vertical search, which may include any selected options from facets, NLP filters, and field value static filters.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 declare function AppliedFilters(props: AppliedFiltersProps): JSX.Element;
@@ -16,9 +16,9 @@ declare function AppliedFilters(props: AppliedFiltersProps): JSX.Element;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  props | AppliedFiltersProps | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) |
+|  props | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) | [AppliedFiltersProps](./search-ui-react.appliedfiltersprops.md) |
 
-<b>Returns:</b>
+**Returns:**
 
 JSX.Element
 

diff --git a/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md b/docs/search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.appliedFiltersContainer property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 appliedFiltersContainer?: string;

diff --git a/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md b/docs/search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.appliedFiltersLoading property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 appliedFiltersLoading?: string;

diff --git a/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md b/docs/search-ui-react.appliedfilterscssclasses.clearallbutton.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.clearAllButton property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 clearAllButton?: string;

diff --git a/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md b/docs/search-ui-react.appliedfilterscssclasses.filterlabel.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.filterLabel property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 filterLabel?: string;

diff --git a/docs/search-ui-react.appliedfilterscssclasses.md b/docs/search-ui-react.appliedfilterscssclasses.md
@@ -6,20 +6,20 @@
 
 The CSS class interface used for [AppliedFilters()](./search-ui-react.appliedfilters.md)<!-- -->.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 interface AppliedFiltersCssClasses 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [appliedFiltersContainer?](./search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md) | string | <i>(Optional)</i> |
-|  [appliedFiltersLoading?](./search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md) | string | <i>(Optional)</i> |
-|  [clearAllButton?](./search-ui-react.appliedfilterscssclasses.clearallbutton.md) | string | <i>(Optional)</i> |
-|  [filterLabel?](./search-ui-react.appliedfilterscssclasses.filterlabel.md) | string | <i>(Optional)</i> |
-|  [nlpFilter?](./search-ui-react.appliedfilterscssclasses.nlpfilter.md) | string | <i>(Optional)</i> |
-|  [removableFilter?](./search-ui-react.appliedfilterscssclasses.removablefilter.md) | string | <i>(Optional)</i> |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [appliedFiltersContainer?](./search-ui-react.appliedfilterscssclasses.appliedfilterscontainer.md) |  | string | _(Optional)_ |
+|  [appliedFiltersLoading?](./search-ui-react.appliedfilterscssclasses.appliedfiltersloading.md) |  | string | _(Optional)_ |
+|  [clearAllButton?](./search-ui-react.appliedfilterscssclasses.clearallbutton.md) |  | string | _(Optional)_ |
+|  [filterLabel?](./search-ui-react.appliedfilterscssclasses.filterlabel.md) |  | string | _(Optional)_ |
+|  [nlpFilter?](./search-ui-react.appliedfilterscssclasses.nlpfilter.md) |  | string | _(Optional)_ |
+|  [removableFilter?](./search-ui-react.appliedfilterscssclasses.removablefilter.md) |  | string | _(Optional)_ |
 
diff --git a/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md b/docs/search-ui-react.appliedfilterscssclasses.nlpfilter.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.nlpFilter property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 nlpFilter?: string;

diff --git a/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md b/docs/search-ui-react.appliedfilterscssclasses.removablefilter.md
@@ -4,7 +4,7 @@
 
 ## AppliedFiltersCssClasses.removableFilter property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 removableFilter?: string;

diff --git a/docs/search-ui-react.appliedfiltersprops.customcssclasses.md b/docs/search-ui-react.appliedfiltersprops.customcssclasses.md
@@ -6,7 +6,7 @@
 
 CSS classes for customizing the component styling.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 customCssClasses?: AppliedFiltersCssClasses;

diff --git a/docs/search-ui-react.appliedfiltersprops.hiddenfields.md b/docs/search-ui-react.appliedfiltersprops.hiddenfields.md
@@ -6,7 +6,7 @@
 
 List of filters that should not be displayed. By default, builtin.entityType will be hidden.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 hiddenFields?: string[];

diff --git a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md
@@ -6,7 +6,7 @@
 
 The delimiter for determining facet hierarchies, defaults to "<!-- -->&gt;<!-- -->".
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 hierarchicalFacetsDelimiter?: string;

diff --git a/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md b/docs/search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md
@@ -6,7 +6,7 @@
 
 A set of facet fieldIds that should be interpreted as "hierarchical".
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 hierarchicalFacetsFieldIds?: string[];

diff --git a/docs/search-ui-react.appliedfiltersprops.md b/docs/search-ui-react.appliedfiltersprops.md
@@ -6,18 +6,18 @@
 
 Properties for [AppliedFilters()](./search-ui-react.appliedfilters.md)<!-- -->.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 interface AppliedFiltersProps 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [customCssClasses?](./search-ui-react.appliedfiltersprops.customcssclasses.md) | AppliedFiltersCssClasses | <i>(Optional)</i> CSS classes for customizing the component styling. |
-|  [hiddenFields?](./search-ui-react.appliedfiltersprops.hiddenfields.md) | string\[\] | <i>(Optional)</i> List of filters that should not be displayed. By default, builtin.entityType will be hidden. |
-|  [hierarchicalFacetsDelimiter?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md) | string | <i>(Optional)</i> The delimiter for determining facet hierarchies, defaults to "<!-- -->&gt;<!-- -->". |
-|  [hierarchicalFacetsFieldIds?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md) | string\[\] | <i>(Optional)</i> A set of facet fieldIds that should be interpreted as "hierarchical". |
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [customCssClasses?](./search-ui-react.appliedfiltersprops.customcssclasses.md) |  | [AppliedFiltersCssClasses](./search-ui-react.appliedfilterscssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. |
+|  [hiddenFields?](./search-ui-react.appliedfiltersprops.hiddenfields.md) |  | string\[\] | _(Optional)_ List of filters that should not be displayed. By default, builtin.entityType will be hidden. |
+|  [hierarchicalFacetsDelimiter?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsdelimiter.md) |  | string | _(Optional)_ The delimiter for determining facet hierarchies, defaults to "<!-- -->&gt;<!-- -->". |
+|  [hierarchicalFacetsFieldIds?](./search-ui-react.appliedfiltersprops.hierarchicalfacetsfieldids.md) |  | string\[\] | _(Optional)_ A set of facet fieldIds that should be interpreted as "hierarchical". |
 
diff --git a/docs/search-ui-react.applyfiltersbutton.md b/docs/search-ui-react.applyfiltersbutton.md
@@ -6,7 +6,7 @@
 
 Runs a vertical search. By default has `position: sticky` styling that anchors it to the bottom of the page.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 declare function ApplyFiltersButton({ customCssClasses, label }: ApplyFiltersButtonProps): JSX.Element;
@@ -16,9 +16,9 @@ declare function ApplyFiltersButton({ customCssClasses, label }: ApplyFiltersBut
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { customCssClasses, label } | ApplyFiltersButtonProps |  |
+|  { customCssClasses, label } | [ApplyFiltersButtonProps](./search-ui-react.applyfiltersbuttonprops.md) |  |
 
-<b>Returns:</b>
+**Returns:**
 
 JSX.Element
 

diff --git a/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md b/docs/search-ui-react.applyfiltersbuttoncssclasses.button.md
@@ -4,7 +4,7 @@
 
 ## ApplyFiltersButtonCssClasses.button property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 button?: string;