From 77984131090fb311bce3ff9ea543c59524ef228a Mon Sep 17 00:00:00 2001 From: John Kreitlow Date: Thu, 3 Mar 2022 13:37:25 -0800 Subject: [PATCH 1/2] fix d.ts errors generated by api-extractor --- packages/web-components/docs/api-report.md | 46 +++++++++---------- .../web-components/src/custom-elements.ts | 43 +++++++++++++++++ 2 files changed, 66 insertions(+), 23 deletions(-) diff --git a/packages/web-components/docs/api-report.md b/packages/web-components/docs/api-report.md index f91aaca6910be6..3177be61df4ad0 100644 --- a/packages/web-components/docs/api-report.md +++ b/packages/web-components/docs/api-report.md @@ -178,19 +178,19 @@ export const accordionStyles: (context: ElementDefinitionContext, definition: Fo // @public export const allComponents: { - fluentAccordion: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentAccordion: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentAccordionItem: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentAnchor: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; - fluentAnchoredRegion: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentAnchoredRegion: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentBadge: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; - fluentBreadcrumb: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentBreadcrumb: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentBreadcrumbItem: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentButton: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentCalendar: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentCard: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentCheckbox: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentCombobox: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; - fluentDataGrid: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentDataGrid: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentDataGridCell: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentDataGridRow: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentDesignSystemProvider: (overrideDefinition?: OverrideFoundationElementDefinition< { @@ -202,31 +202,31 @@ export const allComponents: { template: ViewTemplate; styles: ElementStyles; }, DesignSystemProvider>; - fluentDialog: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; - fluentDivider: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentDialog: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentDivider: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentFlipper: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentHorizontalScroll: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentListbox: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; - fluentOption: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentOption: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentMenu: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentMenuItem: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentNumberField: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentProgress: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentProgressRing: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentRadio: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; - fluentRadioGroup: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentRadioGroup: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentSearch: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; fluentSelect: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; - fluentSkeleton: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentSkeleton: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentSlider: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; - fluentSliderLabel: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentSliderLabel: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentSwitch: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; - fluentTabs: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentTabs: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentTab: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentTabPanel: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentTextArea: (overrideDefinition?: OverrideFoundationElementDefinition< { baseName: string; - baseClass: TextArea_2; + baseClass: typeof TextArea_2; template: FoundationElementTemplate, FoundationElementDefinition>; styles: (context: any, definition: any) => ElementStyles; shadowOptions: { @@ -234,7 +234,7 @@ export const allComponents: { }; }> | undefined) => FoundationElementRegistry< { baseName: string; - baseClass: TextArea_2; + baseClass: typeof TextArea_2; template: FoundationElementTemplate, FoundationElementDefinition>; styles: (context: any, definition: any) => ElementStyles; shadowOptions: { @@ -243,7 +243,7 @@ export const allComponents: { }, TextArea>; fluentTextField: (overrideDefinition?: OverrideFoundationElementDefinition< { baseName: string; - baseClass: TextField_2; + baseClass: typeof TextField_2; template: FoundationElementTemplate, TextFieldOptions>; styles: (context: any, definition: any) => ElementStyles; shadowOptions: { @@ -251,7 +251,7 @@ export const allComponents: { }; }> | undefined) => FoundationElementRegistry< { baseName: string; - baseClass: TextField_2; + baseClass: typeof TextField_2; template: FoundationElementTemplate, TextFieldOptions>; styles: (context: any, definition: any) => ElementStyles; shadowOptions: { @@ -260,7 +260,7 @@ export const allComponents: { }, TextField>; fluentToolbar: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentTooltip: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; - fluentTreeView: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; + fluentTreeView: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry; fluentTreeItem: (overrideDefinition?: OverrideFoundationElementDefinition | undefined) => FoundationElementRegistry>; register(container?: Container | undefined, ...rest: any[]): void; }; @@ -1719,13 +1719,13 @@ export const typeRampPlus6LineHeight: CSSDesignToken; // // dist/dts/color/palette.d.ts:70:5 - (ae-forgotten-export) The symbol "create" needs to be exported by the entry point index.d.ts // dist/dts/color/palette.d.ts:71:5 - (ae-forgotten-export) The symbol "from" needs to be exported by the entry point index.d.ts -// dist/dts/custom-elements.d.ts:51:5 - (ae-incompatible-release-tags) The symbol "fluentAnchor" is marked as @public, but its signature references "Anchor" which is marked as @internal -// dist/dts/custom-elements.d.ts:53:5 - (ae-incompatible-release-tags) The symbol "fluentBadge" is marked as @public, but its signature references "Badge" which is marked as @internal -// dist/dts/custom-elements.d.ts:56:5 - (ae-incompatible-release-tags) The symbol "fluentButton" is marked as @public, but its signature references "Button" which is marked as @internal -// dist/dts/custom-elements.d.ts:95:5 - (ae-incompatible-release-tags) The symbol "fluentTextArea" is marked as @public, but its signature references "TextArea" which is marked as @internal -// dist/dts/custom-elements.d.ts:112:5 - (ae-incompatible-release-tags) The symbol "fluentTextField" is marked as @public, but its signature references "TextField" which is marked as @internal -// dist/dts/custom-elements.d.ts:129:5 - (ae-incompatible-release-tags) The symbol "fluentToolbar" is marked as @public, but its signature references "Toolbar" which is marked as @internal -// dist/dts/custom-elements.d.ts:130:5 - (ae-incompatible-release-tags) The symbol "fluentTooltip" is marked as @public, but its signature references "Tooltip" which is marked as @internal +// dist/dts/custom-elements.d.ts:52:5 - (ae-incompatible-release-tags) The symbol "fluentAnchor" is marked as @public, but its signature references "Anchor" which is marked as @internal +// dist/dts/custom-elements.d.ts:54:5 - (ae-incompatible-release-tags) The symbol "fluentBadge" is marked as @public, but its signature references "Badge" which is marked as @internal +// dist/dts/custom-elements.d.ts:57:5 - (ae-incompatible-release-tags) The symbol "fluentButton" is marked as @public, but its signature references "Button" which is marked as @internal +// dist/dts/custom-elements.d.ts:96:5 - (ae-incompatible-release-tags) The symbol "fluentTextArea" is marked as @public, but its signature references "TextArea" which is marked as @internal +// dist/dts/custom-elements.d.ts:113:5 - (ae-incompatible-release-tags) The symbol "fluentTextField" is marked as @public, but its signature references "TextField" which is marked as @internal +// dist/dts/custom-elements.d.ts:130:5 - (ae-incompatible-release-tags) The symbol "fluentToolbar" is marked as @public, but its signature references "Toolbar" which is marked as @internal +// dist/dts/custom-elements.d.ts:131:5 - (ae-incompatible-release-tags) The symbol "fluentTooltip" is marked as @public, but its signature references "Tooltip" which is marked as @internal // (No @packageDocumentation comment for this package) diff --git a/packages/web-components/src/custom-elements.ts b/packages/web-components/src/custom-elements.ts index 669d5808d2a06c..687c7951093af7 100644 --- a/packages/web-components/src/custom-elements.ts +++ b/packages/web-components/src/custom-elements.ts @@ -1,3 +1,46 @@ +// These type imports are needed so that API-extractor doesn't add import types with improper pathing. +/* eslint-disable @typescript-eslint/no-unused-vars */ +import type { + Accordion, + AccordionItem, + Anchor, + AnchoredRegion, + Badge, + Breadcrumb, + BreadcrumbItem, + Button, + Calendar, + Card, + Checkbox, + Combobox, + DataGrid, + Dialog, + Divider, + Flipper, + HorizontalScroll, + Listbox, + ListboxOption, + Menu, + MenuItem, + NumberField, + Radio, + RadioGroup, + Search, + Select, + Skeleton, + Slider, + SliderLabel, + Switch, + Tabs, + TextArea, + TextField, + Toolbar, + Tooltip, + TreeItem, + TreeView, +} from '@microsoft/fast-foundation'; +/* eslint-disable @typescript-eslint/no-unused-vars */ + /** * Export all custom element definitions */ From 99ab560cea3d3e558512ba9146b41a794338a92f Mon Sep 17 00:00:00 2001 From: John Kreitlow Date: Thu, 3 Mar 2022 13:37:42 -0800 Subject: [PATCH 2/2] Change files --- ...eb-components-68bd4a97-2cae-454a-a28e-0aba641a066a.json | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 change/@fluentui-web-components-68bd4a97-2cae-454a-a28e-0aba641a066a.json diff --git a/change/@fluentui-web-components-68bd4a97-2cae-454a-a28e-0aba641a066a.json b/change/@fluentui-web-components-68bd4a97-2cae-454a-a28e-0aba641a066a.json new file mode 100644 index 00000000000000..23afafe6ea15d6 --- /dev/null +++ b/change/@fluentui-web-components-68bd4a97-2cae-454a-a28e-0aba641a066a.json @@ -0,0 +1,7 @@ +{ + "type": "patch", + "comment": "fix d.ts errors generated by api-extractor", + "packageName": "@fluentui/web-components", + "email": "john.kreitlow@microsoft.com", + "dependentChangeType": "patch" +}