Skip to content

fix(web-components): use lib replacement for web types #32129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
radium-v wants to merge 9 commits into from
Closed

fix(web-components): use lib replacement for web types #32129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f3ea704
use lib replacement for web types in web-components
radium-v Jul 26, 2024
28d03fb
remove types configurations from web-components and vr-tests-web-comp…
radium-v Jul 26, 2024
3dca125
update module resolution and targets for web-components packages
radium-v Jul 26, 2024
d7b45b9
fix interface error
radium-v Jul 26, 2024
dd87e5e
generate api-report
radium-v Jul 26, 2024
8cfd191
add changefile
radium-v Jul 26, 2024
67203b4
restore ES2019 config
radium-v Jul 26, 2024
8fee256
restore moduleResolution
radium-v Aug 2, 2024
1d6e88d
reduce changes down to the minimum required scope
radium-v Aug 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions apps/vr-tests-web-components/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@
"type-check": "tsc -p . --baseUrl . --noEmit",
Comment thread
radium-v marked this conversation as resolved.
"test-vr": "storywright --browsers chromium --url dist/storybook --destpath dist/screenshots --waitTimeScreenshot 500 --concurrency 4 --headless true"
},
"devDependencies": {
"@types/web": "^0.0.142"
},
Comment thread
radium-v marked this conversation as resolved.
"dependencies": {
"react": "17.0.2",
"react-dom": "17.0.2",
Expand Down
2 changes: 1 addition & 1 deletion apps/vr-tests-web-components/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"resolveJsonModule": true,
"allowJs": true,
"jsx": "react",
"types": ["jest", "node", "web"]
Comment thread
radium-v marked this conversation as resolved.
"types": ["jest", "node"]
},
"include": ["./src", "./.storybook/*"],
"files": ["./typings/html-react-parser/index.d.ts"]
Expand Down
7 changes: 7 additions & 0 deletions change/@fluentui-web-components-f75526c9-d290-411b-b5e5-e77dbf315e1f.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "Use lib replacement to avoid delivering web types overrides",
"packageName": "@fluentui/web-components",
"email": "863023+radium-v@users.noreply.github.com",
"dependentChangeType": "none"
}
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,8 @@
"typings"
],
"nohoist": [
"@fluentui/web-components/@storybook/html"
"@fluentui/web-components/@storybook/html",
"@fluentui/web-components/@typescript/lib-dom"
Comment on lines -370 to +371

@radium-v radium-v Aug 2, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The @typescript/lib-dom package is included in nohoist, since @types/web breaks in packages which target ES5. This ensures that this types override is scoped only to the web components package.

https://github.com/microsoft/TypeScript-DOM-Lib-Generator?tab=readme-ov-file#typeslib-minimum-target
image

@chrisdholt chrisdholt Aug 7, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this - makes sense!

]
},
"resolutions": {
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/.storybook/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"allowJs": true,
"checkJs": true,
"noEmit": true,
"types": ["node", "web"]
"types": ["node"]
},
"include": ["*", "../public", "../src/**/*.stories.*"]
}
3 changes: 0 additions & 3 deletions packages/web-components/docs/api-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

```ts

/// <reference types="web" />

import { CaptureType } from '@microsoft/fast-element';
import { CSSDirective } from '@microsoft/fast-element';
import { Direction } from '@microsoft/fast-web-utilities';
Expand Down Expand Up @@ -2500,7 +2498,6 @@ export abstract class MatchMediaBehavior implements HostBehavior {
export class MatchMediaStyleSheetBehavior extends MatchMediaBehavior {
constructor(query: MediaQueryList, styles: ElementStyles);
protected constructListener(controller: HostController): MediaQueryListListener;
readonly query: MediaQueryList;
// @internal
removedCallback(controller: HostController<any>): void;
readonly styles: ElementStyles;
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@
"devDependencies": {
"@microsoft/fast-element": "2.0.0-beta.26",
"@tensile-perf/web-components": "~0.2.0",
"@types/web": "^0.0.142",
"@typescript/lib-dom": "npm:@types/web@^0.0.142",
"@storybook/html": "6.5.15",
"chromedriver": "^125.0.0"
},
Expand Down
5 changes: 0 additions & 5 deletions packages/web-components/src/utils/behaviors/match-media-stylesheet-behavior.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@ export abstract class MatchMediaBehavior implements HostBehavior {
* @public
*/
export class MatchMediaStyleSheetBehavior extends MatchMediaBehavior {
/**
* The media query that the behavior operates on.
*/
public readonly query!: MediaQueryList;

/**
* The styles object to be managed by the behavior.
*/
Expand Down
3 changes: 1 addition & 2 deletions packages/web-components/tsconfig.lib.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
"declaration": true,
"declarationDir": "dist/dts",
"outDir": "dist/esm",
"importHelpers": true,
"types": ["web"]
"importHelpers": true
},
"include": ["src"],
"exclude": ["**/*.stories.*", "**/*.test.*", "**/*.spec.*"]
Expand Down
2 changes: 1 addition & 1 deletion packages/web-components/tsconfig.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"compilerOptions": {
"module": "ESNext",
"outDir": "dist/esm",
"types": ["web", "node", "webpack-env"]
"types": ["node", "webpack-env"]
},
"include": ["src/**/*.test.*", "src/**/*.spec.*"]
}
2 changes: 1 addition & 1 deletion yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5731,7 +5731,7 @@
"@types/expect" "^1.20.4"
"@types/node" "*"

"@types/web@^0.0.142":
"@typescript/lib-dom@npm:@types/web@^0.0.142":
version "0.0.142"
resolved "https://registry.yarnpkg.com/@types/web/-/web-0.0.142.tgz#62eff3c6b24e2429d084a5a9d4061021cfe7c648"
integrity sha512-QWDvMW+P3sdq8rhiw3dNyBR64O5adSY80gBjRd2xI3BADGsAFpAglblWucsGUjKVKyPm4EbYZkvFs7BRxPsBOg==
Expand Down