feat(runtime): support for CSP nonces #3823

tanner-reits · 2022-11-14T21:11:11Z

Pull request checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)
- Docs/csp guide stencil-site#947
Build (npm run build) was run locally and any changes were pushed
Unit tests (npm test) were run locally and passed
E2E Tests (npm run test.karma.prod) were run locally and passed
Prettier (npm run prettier) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

What is the current behavior?

Currently, any applications that have strict Content Security Policy (CSP) defined run into issues with Stencil's generated styles and scripts not being allowed to execute when Shadow DOM is not enabled for components.

GitHub Issue Number:
#1392

What is the new behavior?

This commit adds support for CSP nonces in the dist, dist-custom-elements, and www (SSR) output targets. By association, nonces can also be used in the framework wrapper output targets as they build on the dist and dist-custom-elements targets.

dist and dist-custom-elements can call an exposed setNonce helper function to ingest a nonce value into the Stencil runtime which will be applied to all script and style tags that are generated at runtime.

Due to the nature of Server-Side Rendering (SSR), exposing a helper method wasn't in the cards for Stencil's implementation. Instead, servers can be configured to set a nonce value on the window object (window.nonce) and the Stencil hydrate app will handle pulling the provided value off the window and setting it on the generated style and script tags.

NOTE: We do not provide a mechanism for nonces when using SSG. This is due to the fact the pre-rendering generates the HTML at build-time and that hydration occurs server-side rather than client-side.

NOTE: dist-custom-elements-bundle was not included as a part of this work as it is marked as deprecated and will be removed in the upcoming V3 release

Does this introduce a breaking change?

Yes
No

Testing

Dist

Build & package this branch and use to build a Stencil project. At least one of the components should have shadow: false set and associated styles.
Install the Stencil project into a consuming application (I used Angular)
In the Angular app's dev-server config, set the CSP to style-src: 'self';
In the Angular app's entry point (main.ts), import/define the Stencil custom elements
Run the application and observe console errors related to CSP and the component styles are not applied
In the Angular app's entry point (main.ts), import the setNonce helper function from the package's dist directory. Call the helper with the nonce value set in the dev-server config from step 3. This value will typically come from the application's host server, but for testing purposes it is statically set.
Run the application and verify the styles are applied.

Custom elements

Build & package this branch and use to build a Stencil project. At least one of the components should have shadow: false set and associated styles.
Install the Stencil project into a consuming application (I used Angular)
In the Angular app's dev-server config, set the CSP to style-src: 'self';
In the Angular app's entry point (main.ts), import/define the Stencil custom elements
Run the application and observe console errors related to CSP and the component styles are not applied
In the Angular app's entry point (main.ts), import the setNonce helper function from the package's dist-custom-elements directory. Call the helper with the nonce value set in the dev-server config from step 3. This value will typically come from the application's host server, but for testing purposes it is statically set.
Run the application and verify the styles are applied.

Wrappers
Depending on whether the wrappers are configured to use dist or dist-custom-elements, simply import the setNonce helper from the appropriate output directory and call it from the app's entrypoint.

SSR

Create a new Stencil component library and setup a small Express server. I followed this repo (it's a bit outdated, but simple enough to spin up a server to serve the HTML)
In the server config/entrypoint (server.js) add a header to each response for the CSP

app.use(function (req, res, next) {
    res.setHeader('Content-Security-Policy', "style-src 'nonce-<static-nonce-value>'; script-src 'nonce-<static-nonce-value>';");
    next();
});

Startup the server and open the local instance. observe console errors related to CSP and the component styles are not applied
In the head of the served HTML, add a script to set the nonce value on the window object that matches the static value defined in step 2.

<script>
  window.nonce = 'my-nonce';
</script>

Re-start the server and observe the component styles are applied as expected.

Additional testing
An additional test of this work can be found in this demo repo. This test showcases how to use Stencil's CSP functionality in an Angular application served via an Express server. Documentation and reproduction steps can be round in the root readme.

Other information

This may be a starting point for future CSP enhancements as we understand their use cases and needs of the community moving forward.

Consumers will still need to correctly configure their servers for generating and passing the nonce value on to their applications in order for Stencil to correctly ingest and set the nonce values where appropriate.

This commit adds the ability to set a `nonce` value on the runtime platform object. This also introduces the consumption of this value and setting of the `nonce` attribute for generated `style` tags in `dist-custom-elements`.

This commit adds the `setNonce` definition to the generated output for the `dist` output target. This also sets the `nonce` attribute on the style tag responsible for invisible pre-hydration styles.

This commit adds some comments to the internal and generated helper function code for apply nonce attributes.

tanner-reits · 2022-11-14T21:12:09Z

Once we're feeling good about this work, I'll create the PR in the Stencil site repo that adds a page to the "guides" section for this feature.

github-actions · 2022-11-14T21:13:19Z

`--strictNullChecks` error report

Typechecking with --strictNullChecks resulted in 2125 errors on this branch.

Unfortunately, it looks like that's an increase of 1 over main 😞.

Violations Not on `main` (may be more than the count above)

Path	Location	Error	Message
src/compiler/output-targets/dist-custom-elements/custom-elements-types.ts	(103, 33)	TS2345	Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'.
src/runtime/bootstrap-lazy.ts	(50, 21)	TS2345	Argument of type 'string \| null' is not assignable to parameter of type 'string'. Type 'null' is not assignable to type 'string'.
src/runtime/bootstrap-lazy.ts	(124, 45)	TS2345	Argument of type 'this' is not assignable to parameter of type 'HostElement'. Type 'HostElement' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/declarations/stencil-private").HostElement'. The types returned by 'componentOnReady()' are incompatible between these types. Type 'Promise \| undefined' is not assignable to type 'Promise'. Type 'undefined' is not assignable to type 'Promise'.
src/runtime/bootstrap-lazy.ts	(129, 46)	TS2345	Argument of type 'this' is not assignable to parameter of type 'HostElement'.
src/runtime/bootstrap-lazy.ts	(133, 18)	TS2532	Object is possibly 'undefined'.
src/runtime/styles.ts	(110, 42)	TS18048	'elm' is possibly 'undefined'.
src/runtime/styles.ts	(110, 59)	TS18048	'elm' is possibly 'undefined'.
src/runtime/styles.ts	(110, 76)	TS18048	'elm' is possibly 'undefined'.
src/runtime/styles.ts	(124, 5)	TS18048	'elm' is possibly 'undefined'.
src/runtime/styles.ts	(125, 5)	TS18048	'elm' is possibly 'undefined'.
src/runtime/styles.ts	(128, 7)	TS18048	'elm' is possibly 'undefined'.
src/utils/test/query-nonce-meta-tag-content.spec.ts	(23, 5)	TS18047	'head' is possibly 'null'.

reports and statistics

Our most error-prone files

Path	Error Count
src/compiler/config/test/validate-dev-server.spec.ts	49
src/compiler/config/test/validate-output-www.spec.ts	40
src/screenshot/connector-base.ts	40
src/dev-server/index.ts	38
src/mock-doc/serialize-node.ts	36
src/compiler/sys/tests/in-memory-fs.spec.ts	34
src/screenshot/screenshot-compare.ts	33
src/compiler/transformers/test/parse-props.spec.ts	32
src/dev-server/server-process.ts	32
src/runtime/vdom/vdom-render.ts	31
src/compiler/sys/typescript/typescript-config.ts	28
src/compiler/build/build-stats.ts	27
src/compiler/output-targets/dist-lazy/generate-lazy-module.ts	26
src/compiler/prerender/prerender-main.ts	25
src/sys/node/test/worker-manager.spec.ts	24
src/compiler/style/test/optimize-css.spec.ts	23
src/runtime/update-component.ts	23
src/compiler/config/test/validate-paths.spec.ts	22
src/utils/test/message-utils.spec.ts	21
src/compiler/plugin/plugin.ts	20

Our most common errors

Typescript Error Code	Count	Error messages
TS2345	610	Error messages Argument of type 'CompilerSystem \| undefined' is not assignable to parameter of type 'CompilerSystem'. Type 'undefined' is not assignable to type 'CompilerSystem'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'Promise<(() => void) \| null>' is not assignable to parameter of type 'Promise<() => void>'. Argument of type 'null' is not assignable to parameter of type 'BuildResultsComponentGraph'. Argument of type 'DevServerConfig \| undefined' is not assignable to parameter of type 'StencilDevServerConfig'. Type 'undefined' is not assignable to type 'StencilDevServerConfig'. Argument of type 'Promise<(() => void) \| null>' is not assignable to parameter of type 'Promise<() => void>'. Type '(() => void) \| null' is not assignable to type '() => void'. Type 'null' is not assignable to type '() => void'. Argument of type 'ComponentRuntimeHostListener[] \| undefined' is not assignable to parameter of type 'ComponentRuntimeHostListener[]'. Type 'undefined' is not assignable to type 'ComponentRuntimeHostListener[]'. Argument of type 'HTMLScriptElement \| null \| undefined' is not assignable to parameter of type 'HTMLScriptElement'. Type 'undefined' is not assignable to type 'HTMLScriptElement'. Argument of type 'string \| null' is not assignable to parameter of type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'Logger \| undefined' is not assignable to parameter of type 'Logger'. Type 'undefined' is not assignable to type 'Logger'. Argument of type 'string[] \| undefined' is not assignable to parameter of type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Argument of type 'string' is not assignable to parameter of type 'never'. Argument of type 'Diagnostic[] \| undefined' is not assignable to parameter of type 'readonly Diagnostic[]'. Type 'undefined' is not assignable to type 'readonly Diagnostic[]'. Argument of type 'boolean \| undefined' is not assignable to parameter of type 'boolean'. Argument of type 'BuildConditionals \| undefined' is not assignable to parameter of type 'BuildConditionals'. Type 'undefined' is not assignable to type 'BuildConditionals'. Argument of type 'Diagnostic[] \| undefined' is not assignable to parameter of type 'Diagnostic[]'. Type 'undefined' is not assignable to type 'Diagnostic[]'. Argument of type '{ styleText: string; output: string; map: null; diagnostics: never[]; imports: never[]; defaultVarName: string; styleDocs: never[]; }' is not assignable to parameter of type 'never'. Argument of type 'WorkerMeta \| undefined' is not assignable to parameter of type 'WorkerMeta'. Type 'undefined' is not assignable to type 'WorkerMeta'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'Set<string \| null>' is not assignable to parameter of type 'Set'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'Set<string \| null>' is not assignable to parameter of type 'Set'. Argument of type 'RollupConfig \| undefined' is not assignable to parameter of type 'RollupConfig'. Type 'undefined' is not assignable to type 'RollupConfig'. Argument of type '(string[] \| undefined)[]' is not assignable to parameter of type 'string[][]'. Type 'string[] \| undefined' is not assignable to type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Argument of type 'ComponentCompilerMeta \| undefined' is not assignable to parameter of type 'ComponentCompilerMeta'. Type 'undefined' is not assignable to type 'ComponentCompilerMeta'. Argument of type 'true \| Object \| undefined' is not assignable to parameter of type 'boolean \| Object \| null'. Type 'undefined' is not assignable to type 'boolean \| Object \| null'. Argument of type 'SourceTarget \| undefined' is not assignable to parameter of type 'SourceTarget'. Type 'undefined' is not assignable to type 'SourceTarget'. Argument of type 'boolean \| undefined' is not assignable to parameter of type 'boolean'. Type 'undefined' is not assignable to type 'boolean'. Argument of type '(string \| undefined)[]' is not assignable to parameter of type 'string[]'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type '(string \| undefined)[]' is not assignable to parameter of type 'string[]'. Argument of type 'RollupSourceMap \| undefined' is not assignable to parameter of type 'SourceMap'. Type 'undefined' is not assignable to type 'SourceMap'. Argument of type 'EntryModule \| undefined' is not assignable to parameter of type 'EntryModule'. Type 'undefined' is not assignable to type 'EntryModule'. Argument of type '(Module \| undefined)[]' is not assignable to parameter of type 'Module[]'. Type 'Module \| undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'Module'. Argument of type 'Document \| null' is not assignable to parameter of type 'Document'. Type 'null' is not assignable to type 'Document'. Argument of type 'Document \| null' is not assignable to parameter of type 'Node \| MockNode'. Type 'null' is not assignable to type 'Node \| MockNode'. Argument of type 'HydrateAnchorElement' is not assignable to parameter of type '{ [attrName: string]: string; }'. 'string' index signatures are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'URL \| null' is not assignable to parameter of type 'URL'. Type 'null' is not assignable to type 'URL'. Argument of type 'number \| undefined' is not assignable to parameter of type 'number'. Type 'undefined' is not assignable to type 'number'. Argument of type 'SitemapXmpResults \| null' is not assignable to parameter of type 'SitemapXmpResults'. Type 'null' is not assignable to type 'SitemapXmpResults'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| URL'. Argument of type 'Map<string, string[]> \| undefined' is not assignable to parameter of type 'Map<string, string[]>'. Type 'undefined' is not assignable to type 'Map<string, string[]>'. Argument of type 'undefined' is not assignable to parameter of type 'string'. Argument of type 'ServiceWorkerConfig \| undefined' is not assignable to parameter of type 'ServiceWorkerConfig'. Type 'undefined' is not assignable to type 'ServiceWorkerConfig'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| URL'. Type 'undefined' is not assignable to type 'string \| URL'. Argument of type 'CssNode[] \| null \| undefined' is not assignable to parameter of type 'void \| CssNode[]'. Argument of type 'CssNode[] \| null \| undefined' is not assignable to parameter of type 'void \| CssNode[]'. Type 'null' is not assignable to type 'void \| CssNode[]'. Argument of type 'null' is not assignable to parameter of type 'string'. Argument of type 'CompilerSystemCreateDirectoryOptions \| undefined' is not assignable to parameter of type 'CompilerSystemCreateDirectoryOptions'. Type 'undefined' is not assignable to type 'CompilerSystemCreateDirectoryOptions'. Argument of type 'null' is not assignable to parameter of type 'CompilerFileWatcherEvent'. Argument of type 'null' is not assignable to parameter of type '{ access: (filePath: string) => Promise; accessSync: (filePath: string) => boolean; cancelDeleteDirectoriesFromDisk: (dirPaths: string[]) => void; cancelDeleteFilesFromDisk: (filePaths: string[]) => void; ... 17 more ...; writeFiles: (files: { ...; } \| Map<...>, opts?: FsWriteOptions \| undefined) => Promise...'. Argument of type 'undefined' is not assignable to parameter of type 'TypeChecker'. Argument of type 'CollectionBundleManifest[] \| undefined' is not assignable to parameter of type 'any[]'. Type 'undefined' is not assignable to type 'any[]'. Argument of type 'Module \| undefined' is not assignable to parameter of type 'Module'. Type 'undefined' is not assignable to type 'Module'. Argument of type 'NodeArray \| undefined' is not assignable to parameter of type 'NodeArray \| HeritageClause[]'. Type 'undefined' is not assignable to type 'NodeArray \| HeritageClause[]'. Argument of type 'Block \| undefined' is not assignable to parameter of type 'Block'. Type 'undefined' is not assignable to type 'Block'. Argument of type 'Expression \| undefined' is not assignable to parameter of type 'Expression'. Type 'undefined' is not assignable to type 'Expression'. Argument of type 'Symbol \| undefined' is not assignable to parameter of type 'Symbol'. Type 'undefined' is not assignable to type 'Symbol'. Argument of type 'TypeNode \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type '(PropertyAssignment \| null)[]' is not assignable to parameter of type 'readonly ObjectLiteralElementLike[]'. Type 'PropertyAssignment \| null' is not assignable to type 'ObjectLiteralElementLike'. Type 'null' is not assignable to type 'ObjectLiteralElementLike'. Argument of type 'Signature \| undefined' is not assignable to parameter of type 'Signature'. Type 'undefined' is not assignable to type 'Signature'. Argument of type 'Identifier \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'Config \| null \| undefined' is not assignable to parameter of type 'Config'. Type 'undefined' is not assignable to type 'Config'. Argument of type 'null' is not assignable to parameter of type 'CollectionCompilerMeta'. Argument of type 'PropertyName \| undefined' is not assignable to parameter of type 'PropertyName'. Type 'undefined' is not assignable to type 'PropertyName'. Argument of type 'NamedExportBindings \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'Declaration \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'Identifier \| undefined' is not assignable to parameter of type 'string \| BindingName'. Type 'undefined' is not assignable to type 'string \| BindingName'. Argument of type 'ScriptTarget \| undefined' is not assignable to parameter of type 'ScriptTarget \| CreateSourceFileOptions'. Type 'undefined' is not assignable to type 'ScriptTarget \| CreateSourceFileOptions'. Argument of type 'Diagnostic' is not assignable to parameter of type 'DiagnosticWithLocation'. Types of property 'file' are incompatible. Type 'SourceFile \| undefined' is not assignable to type 'SourceFile'. Type 'undefined' is not assignable to type 'SourceFile'. Argument of type '(...pathSegments: string[]) => string \| undefined' is not assignable to parameter of type '(...args: string[]) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'OpenInEditorCallback \| undefined' is not assignable to parameter of type 'OpenInEditorCallback'. Type 'undefined' is not assignable to type 'OpenInEditorCallback'. Argument of type 'CompilerWatcher \| undefined' is not assignable to parameter of type 'CompilerWatcher'. Type 'undefined' is not assignable to type 'CompilerWatcher'. Argument of type '{ editor: string \| undefined; }' is not assignable to parameter of type 'OpenInEditorOptions'. Types of property 'editor' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Argument of type 'string \| undefined' is not assignable to parameter of type 'PathLike'. Argument of type 'DevServerConfig \| undefined' is not assignable to parameter of type 'DevServerConfig'. Type 'undefined' is not assignable to type 'DevServerConfig'. Argument of type 'CompilerBuildResults \| undefined' is not assignable to parameter of type 'CompilerBuildResults'. Type 'undefined' is not assignable to type 'CompilerBuildResults'. Argument of type 'Window \| undefined' is not assignable to parameter of type 'Window'. Type 'undefined' is not assignable to type 'Window'. Argument of type 'SerializeDocumentOptions \| undefined' is not assignable to parameter of type 'HydrateDocumentOptions'. Type 'undefined' is not assignable to type 'HydrateDocumentOptions'. Argument of type 'HydrateDocumentOptions \| undefined' is not assignable to parameter of type 'HydrateDocumentOptions'. Type 'undefined' is not assignable to type 'HydrateDocumentOptions'. Argument of type 'MockNode \| null' is not assignable to parameter of type 'MockNode'. Type 'null' is not assignable to type 'MockNode'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| null'. Type 'undefined' is not assignable to type 'string \| null'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| null'. Argument of type 'ShadowRoot \| null' is not assignable to parameter of type 'Node'. Type 'null' is not assignable to type 'Node'. Argument of type 'MockElement' is not assignable to parameter of type 'MockHTMLElement'. Types of property 'namespaceURI' are incompatible. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Argument of type 'null' is not assignable to parameter of type 'string \| Node'. Argument of type 'null' is not assignable to parameter of type 'string \| boolean \| undefined'. Argument of type '(Window & typeof globalThis) \| null' is not assignable to parameter of type 'Window'. Type 'null' is not assignable to type 'Window'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'string \| undefined'. Argument of type 'HostRef \| undefined' is not assignable to parameter of type 'HostRef'. Type 'undefined' is not assignable to type 'HostRef'. Argument of type 'this' is not assignable to parameter of type 'HostElement'. Type 'HostElement' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/declarations/stencil-private").HostElement'. The types returned by 'componentOnReady()' are incompatible between these types. Type 'Promise \| undefined' is not assignable to type 'Promise'. Type 'undefined' is not assignable to type 'Promise'. Argument of type 'this' is not assignable to parameter of type 'HostElement'. Argument of type 'string \| null' is not assignable to parameter of type 'string \| undefined'. Argument of type 'PropertyDescriptor \| undefined' is not assignable to parameter of type 'PropertyDescriptor & ThisType'. Type 'undefined' is not assignable to type 'PropertyDescriptor & ThisType'. Type 'undefined' is not assignable to type 'PropertyDescriptor'. Argument of type 'HTMLElement \| undefined' is not assignable to parameter of type 'HTMLElement'. Type 'undefined' is not assignable to type 'HTMLElement'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'HostElement'. Type 'undefined' is not assignable to type 'HostElement'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'EventTarget'. Type 'undefined' is not assignable to type 'EventTarget'. Argument of type 'HostElement \| undefined' is not assignable to parameter of type 'Element'. Type 'undefined' is not assignable to type 'Element'. Argument of type 'VNode[] \| undefined' is not assignable to parameter of type 'VNode[]'. Type 'undefined' is not assignable to type 'VNode[]'. Argument of type 'null \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'VNode \| null' is not assignable to parameter of type 'ChildType'. Type 'null' is not assignable to type 'ChildType'. Argument of type 'VNode \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'VNode \| null \| undefined' is not assignable to parameter of type 'ChildType'. Type 'undefined' is not assignable to type 'ChildType'. Argument of type 'null \| undefined' is not assignable to parameter of type 'ChildType'. Argument of type 'RenderNode \| undefined' is not assignable to parameter of type 'Node \| null'. Type 'undefined' is not assignable to type 'Node \| null'. Argument of type 'VNode \| undefined' is not assignable to parameter of type 'VNode'. Type 'undefined' is not assignable to type 'VNode'. Argument of type 'null' is not assignable to parameter of type 'VNode'. Argument of type 'RenderNode \| undefined' is not assignable to parameter of type 'Node'. Type 'undefined' is not assignable to type 'Node'. Argument of type 'null' is not assignable to parameter of type 'RenderNode'. Argument of type 'ScreenshotDiff \| undefined' is not assignable to parameter of type 'ScreenshotDiff'. Type 'undefined' is not assignable to type 'ScreenshotDiff'. Argument of type 'string \| undefined' is not assignable to parameter of type 'PathLike'. Type 'undefined' is not assignable to type 'PathLike'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| SemVer'. Type 'undefined' is not assignable to type 'string \| SemVer'. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| SemVer'. Argument of type 'null' is not assignable to parameter of type 'number \| undefined'. Argument of type 'null' is not assignable to parameter of type 'number \| PromiseLike'. Argument of type 'CompilerWorkerTask \| undefined' is not assignable to parameter of type 'CompilerWorkerTask'. Type 'undefined' is not assignable to type 'CompilerWorkerTask'. Argument of type 'null' is not assignable to parameter of type 'CompilerWorkerTask'. Argument of type 'undefined' is not assignable to parameter of type 'ErrorHandler'. Argument of type 'string \| undefined' is not assignable to parameter of type 'MockRequestInfo'. Type 'undefined' is not assignable to type 'MockRequestInfo'. Argument of type 'string \| undefined' is not assignable to parameter of type 'MockRequestInfo'. Argument of type 'MockResponse \| undefined' is not assignable to parameter of type 'MockResponse'. Type 'undefined' is not assignable to type 'MockResponse'. Argument of type 'RuntimeRef \| undefined' is not assignable to parameter of type 'RuntimeRef'. Type 'undefined' is not assignable to type 'RuntimeRef'. Argument of type 'this' is not assignable to parameter of type 'E2EElementInternal'. Type 'E2EElement' is not assignable to type 'E2EElementInternal'. Types of property 'find' are incompatible. Type '(selector: string) => Promise<E2EElement \| null>' is not assignable to type '(selector: FindSelector) => Promise'. Argument of type 'string \| null \| undefined' is not assignable to parameter of type 'SerializableOrJSHandle'. Type 'undefined' is not assignable to type 'SerializableOrJSHandle'. Argument of type 'this' is not assignable to parameter of type 'E2EElementInternal'. Argument of type 'ElementHandle \| null' is not assignable to parameter of type 'ElementHandle'. Type 'null' is not assignable to type 'ElementHandle'. Argument of type '{ viewport: EmulateViewport \| undefined; userAgent: string \| undefined; }' is not assignable to parameter of type '{ viewport: Viewport; userAgent: string; }'. Types of property 'viewport' are incompatible. Type 'EmulateViewport \| undefined' is not assignable to type 'Viewport'. Type 'undefined' is not assignable to type 'Viewport'. Argument of type 'null' is not assignable to parameter of type 'SourceMap \| undefined'. Argument of type '{ tags: never[]; text: string; } \| null \| undefined' is not assignable to parameter of type 'CompilerJsDoc \| undefined'. Type 'null' is not assignable to type 'CompilerJsDoc \| undefined'.
TS18048	584	Error messages 'config.sys' is possibly 'undefined'. 'sys.details' is possibly 'undefined'. 'details' is possibly 'undefined'. 'config.devServer' is possibly 'undefined'. 'config.sys.getDevServerExecutingPath' is possibly 'undefined'. 'config.sys.lazyRequire' is possibly 'undefined'. 'sys.parseYarnLockFile' is possibly 'undefined'. 'scope.styleEl' is possibly 'undefined'. 'moduleFile' is possibly 'undefined'. 'config.extras' is possibly 'undefined'. 'config.logger' is possibly 'undefined'. 'hmr' is possibly 'undefined'. 'config.outputTargets' is possibly 'undefined'. 'c.moduleFiles' is possibly 'undefined'. 'a.name' is possibly 'undefined'. 'b.name' is possibly 'undefined'. 'orgNodeResolveId' is possibly 'undefined'. 'config.rollupPlugins' is possibly 'undefined'. 'config.rollupConfig' is possibly 'undefined'. 'config.rollupConfig.inputOptions' is possibly 'undefined'. 'compilerCtx.worker' is possibly 'undefined'. 'pluginTransforms.dependencies' is possibly 'undefined'. 'lastModified' is possibly 'undefined'. 'config.devServer.historyApiFallback' is possibly 'undefined'. 'inputConfig.devServer' is possibly 'undefined'. 'inputConfig.flags' is possibly 'undefined'. 'userConfig.flags' is possibly 'undefined'. 'www' is possibly 'undefined'. 'outputTarget' is possibly 'undefined'. 'o' is possibly 'undefined'. 'cmp' is possibly 'undefined'. 'deps' is possibly 'undefined'. 'cmp.directDependents' is possibly 'undefined'. 'cmp.dependents' is possibly 'undefined'. 'config.bundles' is possibly 'undefined'. 'c.dependencies' is possibly 'undefined'. 'c.directDependencies' is possibly 'undefined'. 'outputTargets' is possibly 'undefined'. 'opts' is possibly 'undefined'. 'errorLine.text' is possibly 'undefined'. 'errorLine.errorLength' is possibly 'undefined'. 'd.lines' is possibly 'undefined'. 'opts.format' is possibly 'undefined'. 'entryModule' is possibly 'undefined'. 'a.directDependents' is possibly 'undefined'. 'b.directDependents' is possibly 'undefined'. 'a.directDependencies' is possibly 'undefined'. 'b.directDependencies' is possibly 'undefined'. 'a.dependents' is possibly 'undefined'. 'b.dependents' is possibly 'undefined'. 'a.dependencies' is possibly 'undefined'. 'b.dependencies' is possibly 'undefined'. 'bundleOptions.loader' is possibly 'undefined'. 'pluginCtx.config.plugins' is possibly 'undefined'. 'transformResults.id' is possibly 'undefined'. 'transformResults.dependencies' is possibly 'undefined'. 'transformResults.diagnostics' is possibly 'undefined'. 'config.maxConcurrentWorkers' is possibly 'undefined'. 'hydrateOpts.staticComponents' is possibly 'undefined'. 'sys.generateFileHash' is possibly 'undefined'. 'manager.config.logger' is possibly 'undefined'. 'manager.config.sys' is possibly 'undefined'. 'serviceWorker' is possibly 'undefined'. 'node.comment' is possibly 'undefined'. 'node.selectors' is possibly 'undefined'. 'node.values' is possibly 'undefined'. 'moduleId' is possibly 'undefined'. 'sys' is possibly 'undefined'. 'tsResults.diagnostics' is possibly 'undefined'. 'r.resolvedModule' is possibly 'undefined'. 'results' is possibly 'undefined'. 'compilerSystem.watchDirectory' is possibly 'undefined'. 'compilerSystem.watchFile' is possibly 'undefined'. 'collectionManifest.bundles' is possibly 'undefined'. 'cstrMethod.body' is possibly 'undefined'. 'cmp.dependencies' is possibly 'undefined'. 'foundDep' is possibly 'undefined'. 'connectedCallback.body' is possibly 'undefined'. 'cmpNode.name' is possibly 'undefined'. 'symbol.declarations' is possibly 'undefined'. 'signature' is possibly 'undefined'. 'collection.moduleFiles' is possibly 'undefined'. 'tsSourceFiles' is possibly 'undefined'. 'results.data' is possibly 'undefined'. 'results.imports' is possibly 'undefined'. 'msg.requestLog' is possibly 'undefined'. 'msg.error' is possibly 'undefined'. 'msg.buildResults' is possibly 'undefined'. 'a.priority' is possibly 'undefined'. 'b.priority' is possibly 'undefined'. 'devServerConfig.historyApiFallback' is possibly 'undefined'. 'devServerConfig.basePath' is possibly 'undefined'. 'req.pathname' is possibly 'undefined'. 'req.stats' is possibly 'undefined'. 'devServerConfig' is possibly 'undefined'. 'res.$content' is possibly 'undefined'. 'opts.maxHydrateCount' is possibly 'undefined'. 'ref' is possibly 'undefined'. 'opts.excludeComponents' is possibly 'undefined'. 'hostRef' is possibly 'undefined'. 'hostRef.$instanceValues$' is possibly 'undefined'. 'ref.$onInstancePromise$' is possibly 'undefined'. 'ref.$lazyInstance$' is possibly 'undefined'. 'opts.indentSpaces' is possibly 'undefined'. 'opts.approximateLineWidth' is possibly 'undefined'. 'plt.$orgLocNodes$' is possibly 'undefined'. 'hostRef.$lazyInstance$' is possibly 'undefined'. 'cmpMeta.$attrsToReflect$' is possibly 'undefined'. 'cmpMeta.$members$' is possibly 'undefined'. 'elm' is possibly 'undefined'. 'hostRef.$renderCount$' is possibly 'undefined'. 'childrenPromises' is possibly 'undefined'. 'hostRef.$hostElement$' is possibly 'undefined'. 'nodeRef' is possibly 'undefined'. 'hostElm' is possibly 'undefined'. 'screenshot.diff' is possibly 'undefined'. 'screenshotCache.items' is possibly 'undefined'. 'a.width' is possibly 'undefined'. 'b.width' is possibly 'undefined'. 'a.height' is possibly 'undefined'. 'b.height' is possibly 'undefined'. 'a.id' is possibly 'undefined'. 'b.id' is possibly 'undefined'. 'emulateConfig.viewport' is possibly 'undefined'. 'emulateConfig.viewport.deviceScaleFactor' is possibly 'undefined'. 'res.statusCode' is possibly 'undefined'. 'tsSysWatchDirectory' is possibly 'undefined'. 'tsSysWatchFile' is possibly 'undefined'. 'sys.events' is possibly 'undefined'. 't.retries' is possibly 'undefined'. 'testing.emulate' is possibly 'undefined'. 'parsedConfig.collectCoverageFrom' is possibly 'undefined'. 'compare.width' is possibly 'undefined'. 'compare.deviceScaleFactor' is possibly 'undefined'. 'compare.height' is possibly 'undefined'. 'config' is possibly 'undefined'. 'screenshotEmulate.viewport' is possibly 'undefined'. 'diagnostic.lines' is possibly 'undefined'. 'd.absFilePath' is possibly 'undefined'. 'd.code' is possibly 'undefined'. 'err.lines' is possibly 'undefined'.
TS2322	508	Error messages Type 'string \| null \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'DevServerConfig \| undefined'. Type 'boolean \| null \| undefined' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'DevServer'. Type 'undefined' is not assignable to type 'ComponentConstructor \| Promise'. Type 'HTMLElement \| null' is not assignable to type 'HTMLElement'. Type 'null' is not assignable to type 'HTMLElement'. Type '({ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; } \| { ...; })[]' is not assignable to type 'RollupResult[]'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; } \| { ...; }' is not assignable to type 'RollupResult'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; }' is not assignable to type 'RollupResult'. Type '{ type: "chunk"; fileName: string; map: SourceMap \| undefined; code: string; moduleFormat: ModuleFormat \| undefined; entryKey: string; imports: string[]; isEntry: boolean; ... 4 more ...; content?: undefined; }' is not assignable to type 'RollupChunkResult'. Types of property 'moduleFormat' are incompatible. Type 'ModuleFormat \| undefined' is not assignable to type 'ModuleFormat'. Type 'undefined' is not assignable to type 'ModuleFormat'. Type 'null' is not assignable to type 'CompilerBuildResults'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'Document'. Type 'null' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'LoggerTimeSpan'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'number \| undefined' is not assignable to type 'number'. Type 'undefined' is not assignable to type 'number'. Type 'boolean \| "prod" \| undefined' is not assignable to type 'boolean \| "prod"'. Type 'undefined' is not assignable to type 'boolean \| "prod"'. Type 'BuildResultsComponentGraph \| undefined' is not assignable to type 'BuildResultsComponentGraph'. Type 'undefined' is not assignable to type 'BuildResultsComponentGraph'. Type 'RollupResults \| undefined' is not assignable to type 'RollupResults'. Type 'undefined' is not assignable to type 'RollupResults'. Type '{ name: string \| undefined; source: string; tags: any[]; }[]' is not assignable to type '{ name: string; source: string; tags: string[]; }[]'. Type '{ name: string \| undefined; source: string; tags: any[]; }' is not assignable to type '{ name: string; source: string; tags: string[]; }'. Types of property 'name' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'null' is not assignable to type 'CompilerWorkerContext'. Type 'null' is not assignable to type 'WatchOfConfigFile'. Type 'null' is not assignable to type 'Promise<(void \| void[])[]>'. Type 'Promise<(void \| void[] \| null)[]>' is not assignable to type 'Promise<(void \| void[])[]>'. Type '(void \| void[] \| null)[]' is not assignable to type '(void \| void[])[]'. Type 'void \| void[] \| null' is not assignable to type 'void \| void[]'. Type 'null' is not assignable to type 'void \| void[]'. Type 'null' is not assignable to type '{ program: WatchOfConfigFile; rebuild: () => void; }'. Type '(this: PluginContext, importee: string, importer: string) => Promise' is not assignable to type 'ResolveIdHook'. Types of parameters 'importer' and 'importer' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '(this: PluginContext, importee: string, importer: string) => Promise' is not assignable to type 'ResolveIdHook'. Types of parameters 'importer' and 'importer' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string \| undefined'. Type '{ code: string; exports: string[]; workerMsgId: string; dependencies: string[]; } \| null' is not assignable to type 'WorkerMeta \| undefined'. Type 'null' is not assignable to type 'WorkerMeta \| undefined'. Type 'WorkerMeta \| undefined' is not assignable to type 'WorkerMeta'. Type 'undefined' is not assignable to type 'WorkerMeta'. Type 'CompilerSystem \| undefined' is not assignable to type 'CompilerSystem'. Type 'undefined' is not assignable to type 'CompilerSystem'. Type 'Logger \| undefined' is not assignable to type 'Logger'. Type 'undefined' is not assignable to type 'Logger'. Type 'import("/home/runner/work/stencil/stencil/src/compiler/cache").Cache' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/declarations/stencil-private").Cache'. The types returned by 'get(...)' are incompatible between these types. Type 'Promise<string \| null>' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'ValidatedConfig'. Type 'null' is not assignable to type 'Config'. Type 'null' is not assignable to type 'string[]'. Type '{ dir: string; buildDir: string; collectionDir: string \| null; typesDir: string; esmLoaderPath: string; copy: d.CopyTask[]; polyfills: boolean \| undefined; empty: boolean; transformAliasedImportPathsInCollection: boolean; type: "dist"; }' is not assignable to type 'Required'. Types of property 'polyfills' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'number \| undefined'. Type 'null' is not assignable to type 'HistoryApiFallback \| undefined'. Type 'null' is not assignable to type 'CopyTask[] \| undefined'. Type '{ dirPath: string; filePath: string; fileName: string; readmePath: string; usagesDir: string; tag: string; readme: string \| undefined; overview: string; usage: JsonDocsUsage; ... 13 more ...; listeners: JsonDocsListener[]; }[]' is not assignable to type 'JsonDocsComponent[]'. Type '{ dirPath: string; filePath: string; fileName: string; readmePath: string; usagesDir: string; tag: string; readme: string \| undefined; overview: string; usage: d.JsonDocsUsage; docs: string; ... 12 more ...; listeners: d.JsonDocsListener[]; }' is not assignable to type 'JsonDocsComponent'. Types of property 'readme' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string[] \| undefined' is not assignable to type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. Type '{ name: string; type: string; mutable: boolean; attr: string \| undefined; reflectToAttr: boolean; docs: string; docsTags: CompilerJsDocTagInfo[]; default: string \| undefined; deprecation: string \| undefined; values: JsonDocsValue[]; optional: boolean; required: boolean; }[]' is not assignable to type 'JsonDocsProp[]'. Type '{ name: string; type: string; mutable: boolean; attr: string \| undefined; reflectToAttr: boolean; docs: string; docsTags: d.CompilerJsDocTagInfo[]; default: string \| undefined; deprecation: string \| undefined; values: d.JsonDocsValue[]; optional: boolean; required: boolean; }' is not assignable to type 'JsonDocsProp'. Types of property 'default' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '{ name: string; type: string; mutable: false; attr: string; reflectToAttr: false; docs: string; docsTags: never[]; default: undefined; deprecation: undefined; values: JsonDocsValue[]; optional: true; required: false; }[]' is not assignable to type 'JsonDocsProp[]'. Type '{ name: string; type: string; mutable: false; attr: string; reflectToAttr: false; docs: string; docsTags: never[]; default: undefined; deprecation: undefined; values: d.JsonDocsValue[]; optional: true; required: false; }' is not assignable to type 'JsonDocsProp'. Types of property 'default' are incompatible. Type 'undefined' is not assignable to type 'string'. Type '(ComponentCompilerMeta \| undefined)[]' is not assignable to type 'ComponentCompilerMeta[]'. Type 'ComponentCompilerMeta \| undefined' is not assignable to type 'ComponentCompilerMeta'. Type 'undefined' is not assignable to type 'ComponentCompilerMeta'. Type '(ComponentCompilerMeta \| undefined)[][]' is not assignable to type 'readonly ComponentCompilerMeta[][]'. Type '(ComponentCompilerMeta \| undefined)[]' is not assignable to type 'ComponentCompilerMeta[]'. Type 'null' is not assignable to type 'boolean \| SourceMapOptions \| undefined'. Type 'null' is not assignable to type 'SourceMap \| undefined'. Type '{ name: string \| undefined; tags: string[]; }[]' is not assignable to type 'CollectionDependencyData[]'. Type '{ name: string \| undefined; tags: string[]; }' is not assignable to type 'CollectionDependencyData'. Types of property 'name' are incompatible. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'string \| undefined' is not assignable to type 'string \| number'. Type 'undefined' is not assignable to type 'string \| number'. Type 'SourceMap \| undefined' is not assignable to type 'SourceMap'. Type 'undefined' is not assignable to type 'SourceMap'. Type 'string \| null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Function'. Type 'null' is not assignable to type 'Map<string, string[]>'. Type 'null' is not assignable to type 'PrerenderConfig'. Type 'null' is not assignable to type 'Set'. Type 'null' is not assignable to type 'HydrateAnchorElement[]'. Type 'null' is not assignable to type '(prerenderRequest: PrerenderUrlRequest) => Promise'. Type 'CssNode \| null' is not assignable to type 'void \| CssNode'. Type 'null' is not assignable to type 'void \| CssNode'. Type 'CssNode \| null' is not assignable to type 'CssNode'. Type 'null' is not assignable to type 'CssNode'. Type 'CssNode \| null' is not assignable to type 'void \| CssNode'. Type 'RegExpExecArray \| null' is not assignable to type 'RegExpExecArray'. Type 'null' is not assignable to type 'RegExpExecArray'. Type 'null' is not assignable to type '() => string'. Type 'null' is not assignable to type 'number'. Type 'null' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'boolean \| undefined'. Type 'FsItem \| undefined' is not assignable to type 'FsItem'. Type 'undefined' is not assignable to type 'FsItem'. Type 'null' is not assignable to type 'CompilerFileWatcherCallback[]'. Type '(key: string) => string \| undefined' is not assignable to type '(key: string) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '(p: string) => Promise<string \| undefined>' is not assignable to type '{ (p: string): Promise; (p: string, encoding: "utf8"): Promise; (p: string, encoding: "binary"): Promise; }'. Type 'Promise<string \| undefined>' is not assignable to type 'Promise'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '(p: string) => string \| undefined' is not assignable to type '(p: string, encoding?: string \| undefined) => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type '((maxConcurrentWorkers: number) => WorkerMainController) \| null' is not assignable to type '((maxConcurrentWorkers: number) => WorkerMainController) \| undefined'. Type 'null' is not assignable to type '((maxConcurrentWorkers: number) => WorkerMainController) \| undefined'. Type 'null' is not assignable to type 'ResolvedModuleWithFailedLookupLocations'. Type 'null' is not assignable to type 'Worker'. Type 'CollectionCompilerMeta \| undefined' is not assignable to type 'CollectionCompilerMeta'. Type 'undefined' is not assignable to type 'CollectionCompilerMeta'. Type 'DeclarationName \| undefined' is not assignable to type 'DeclarationName'. Type 'undefined' is not assignable to type 'DeclarationName'. Type 'boolean \| null' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'boolean'. Type 'undefined' is not assignable to type 'ComponentCompilerVirtualProperty'. Type '{ name: string; method: string; bubbles: boolean; cancelable: boolean; composed: boolean; docs: CompilerJsDoc; complexType: ComponentCompilerEventComplexType; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerEvent[]'. Type '{ name: string; method: string; bubbles: boolean; cancelable: boolean; composed: boolean; docs: d.CompilerJsDoc; complexType: d.ComponentCompilerEventComplexType; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerEvent'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type '{ name: string; docs: CompilerJsDoc; complexType: ComponentCompilerMethodComplexType; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerMethod[]'. Type '{ name: string; docs: d.CompilerJsDoc; complexType: d.ComponentCompilerMethodComplexType; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerMethod'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type '{ name: string; type: ComponentCompilerPropertyType; attribute: string \| undefined; reflect: boolean; mutable: boolean; required: boolean; optional: boolean; defaultValue: string \| undefined; complexType: ComponentCompilerPropertyComplexType; docs: CompilerJsDoc; internal: boolean \| undefined; }[]' is not assignable to type 'ComponentCompilerProperty[]'. Type '{ name: string; type: d.ComponentCompilerPropertyType; attribute: string \| undefined; reflect: boolean; mutable: boolean; required: boolean; optional: boolean; defaultValue: string \| undefined; complexType: d.ComponentCompilerPropertyComplexType; docs: d.CompilerJsDoc; internal: boolean \| undefined; }' is not assignable to type 'ComponentCompilerProperty'. Types of property 'internal' are incompatible. Type 'boolean \| undefined' is not assignable to type 'boolean'. Type 'null' is not assignable to type 'ImportData'. Type 'undefined' is not assignable to type '"queryparams" \| null'. Type 'null' is not assignable to type 'WeakSet'. Type 'null' is not assignable to type 'Module'. Type 'Module \| undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'Module'. Type 'undefined' is not assignable to type 'CompilerJsDoc'. Type '{ [x: string]: d.TypesMemberNameData[] \| undefined; }' is not assignable to type 'TypesImportData'. 'string' index signatures are incompatible. Type 'TypesMemberNameData[] \| undefined' is not assignable to type 'TypesMemberNameData[]'. Type 'undefined' is not assignable to type 'TypesMemberNameData[]'. Type 'string \| undefined' is not assignable to type 'string \| null'. Type '((data: { file: string; line: number; column: number; }) => void) \| null' is not assignable to type 'OpenInEditorCallback \| undefined'. Type 'null' is not assignable to type 'OpenInEditorCallback \| undefined'. Type 'null' is not assignable to type 'WebSocket'. Type 'null' is not assignable to type 'BuildOnEventRemove'. Type 'null' is not assignable to type '() => void'. Type 'null' is not assignable to type '(msg: DevServerMessage) => void'. Type 'DevServerConfig \| undefined' is not assignable to type 'DevServerConfig'. Type 'undefined' is not assignable to type 'DevServerConfig'. Type 'null' is not assignable to type '{ open(openId: string): Promise; }'. Type 'string \| null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Promise<DevServerEditor[]>'. Type 'null' is not assignable to type '(req: IncomingMessage, res: ServerResponse, next: () => void) => void'. Type 'null' is not assignable to type 'URL'. Type 'null' is not assignable to type 'URLSearchParams'. Type 'PageReloadStrategy \| undefined' is not assignable to type 'PageReloadStrategy'. Type 'undefined' is not assignable to type 'PageReloadStrategy'. Type 'null' is not assignable to type 'Server<typeof IncomingMessage, typeof ServerResponse>'. Type 'null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'DevServerContext'. Type 'DevWebSocket \| null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'DevWebSocket'. Type 'null' is not assignable to type 'ChildProcess'. Type 'null' is not assignable to type 'HydrateApp'. Type '() => undefined' is not assignable to type '{ (cb?: (() => void) \| undefined): TestServerResponse; (chunk: any, cb?: (() => void) \| undefined): TestServerResponse; (chunk: any, encoding: BufferEncoding, cb?: (() => void) \| undefined): TestServerResponse; }'. Type 'undefined' is not assignable to type 'TestServerResponse'. Type 'null' is not assignable to type 'ComponentConstructor'. Type '(this: HostElement) => Promise \| undefined' is not assignable to type '() => Promise'. Type 'Promise \| undefined' is not assignable to type 'Promise'. Type 'undefined' is not assignable to type 'Promise'. Type 'null' is not assignable to type 'Window & typeof globalThis'. Type 'null' is not assignable to type 'Window'. Type 'null' is not assignable to type 'Window & typeof globalThis'. Type 'null' is not assignable to type 'MockCSSStyleSheet'. Type 'null' is not assignable to type 'string \| boolean'. Type 'null' is not assignable to type 'Location'. Type 'null' is not assignable to type 'MockElement'. Type 'null' is not assignable to type 'SVGSVGElement'. Type 'null' is not assignable to type 'SVGElement'. Type 'null' is not assignable to type 'EventTarget'. Type 'null' is not assignable to type 'MockEventListener[]'. Type 'null' is not assignable to type 'MockDocument'. Type '{ name: string; value: string; namespace: string \| null; prefix: null; }[]' is not assignable to type 'Attribute[]'. Type '{ name: string; value: string; namespace: string \| null; prefix: null; }' is not assignable to type 'Attribute'. Types of property 'namespace' are incompatible. Type 'string \| null' is not assignable to type 'string \| undefined'. Type '(element: MockElement) => string \| null' is not assignable to type '(element: unknown) => string'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Type 'ParentNode \| null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Document'. Type 'string \| null \| undefined' is not assignable to type 'string \| undefined'. Type 'never[] \| null' is not assignable to type 'RenderNode[]'. Type 'null' is not assignable to type 'RenderNode[]'. Type 'null' is not assignable to type 'VNode[]'. Type 'null' is not assignable to type 'string \| number \| undefined'. Type 'null' is not assignable to type 'string \| number \| Function'. Type 'RenderNode \| null' is not assignable to type 'RenderNode'. Type 'null' is not assignable to type 'RenderNode'. Type 'HTMLElement \| null' is not assignable to type 'EventTarget'. Type 'null' is not assignable to type 'EventTarget'. Type 'string \| null \| undefined' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'string \| undefined'. Type 'null' is not assignable to type 'Set \| undefined'. Type 'null' is not assignable to type '[string, any][] \| undefined'. Type 'VNode[] \| undefined' is not assignable to type 'VNode[]'. Type 'undefined' is not assignable to type 'VNode[]'. Type '(props: {}, children: VNode[], utils: FunctionalUtilities) => null' is not assignable to type 'FunctionalComponent<{}>'. Type 'null' is not assignable to type 'VNode \| VNode[]'. Type '() => null' is not assignable to type 'FunctionalComponent<{}>'. Type 'null' is not assignable to type 'VNode \| VNode[]'. Type 'null' is not assignable to type 'VNode'. Type 'undefined' is not assignable to type 'VNode'. Type 'RenderNode \| undefined' is not assignable to type 'RenderNode'. Type 'undefined' is not assignable to type 'RenderNode'. Type 'RelocateNodeData \| undefined' is not assignable to type 'RelocateNodeData'. Type 'undefined' is not assignable to type 'RelocateNodeData'. Type 'ChildNode \| null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'Node'. Type 'null' is not assignable to type 'ScreenshotBuild'. Type 'null' is not assignable to type 'ScreenshotCache'. Type 'null' is not assignable to type 'Buffer'. Type 'null' is not assignable to type 'Screenshot'. Type '(() => void) \| undefined' is not assignable to type '() => any'. Type 'undefined' is not assignable to type '() => any'. Type '() => null' is not assignable to type '(opts: { rootDir: string; moduleId: string; path: string; }) => string'. Type 'null' is not assignable to type 'string'. Type '() => null' is not assignable to type '(opts: { moduleId: string; path?: string \| undefined; version?: string \| undefined; }) => string'. Type 'null' is not assignable to type 'string'. Type '() => string \| undefined' is not assignable to type '() => string'. Type 'string \| undefined' is not assignable to type 'string'. Type 'undefined' is not assignable to type 'string'. Type 'number \| null' is not assignable to type 'number'. Type 'null' is not assignable to type 'number'. Type 'any[] \| undefined' is not assignable to type 'any[]'. Type 'undefined' is not assignable to type 'any[]'. Type 'boolean \| null \| undefined' is not assignable to type 'boolean \| undefined'. Type 'null' is not assignable to type 'ConfigBundle[] \| undefined'. Type 'null' is not assignable to type 'OutputTarget[] \| undefined'. Type 'null' is not assignable to type 'TestingConfig \| undefined'. Type 'null' is not assignable to type 'Cache'. Type 'null' is not assignable to type '{ access: (filePath: string) => Promise; accessSync: (filePath: string) => boolean; cancelDeleteDirectoriesFromDisk: (dirPaths: string[]) => void; cancelDeleteFilesFromDisk: (filePaths: string[]) => void; ... 17 more ...; writeFiles: (files: { ...; } \| Map<...>, opts?: FsWriteOptions \| undefined) => Promise...'. Type 'HostRef \| undefined' is not assignable to type 'HostRef'. Type 'undefined' is not assignable to type 'HostRef'. Type 'Function \| undefined' is not assignable to type 'Function'. Type 'undefined' is not assignable to type 'Function'. Type 'RafCallback \| undefined' is not assignable to type 'Function'. Type 'undefined' is not assignable to type 'Function'. Type 'QueuedLoadModule \| undefined' is not assignable to type 'QueuedLoadModule'. Type 'undefined' is not assignable to type 'QueuedLoadModule'. Type 'null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'E2EPageInternal'. Type 'ElementHandle \| null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'ElementHandle'. Type 'null' is not assignable to type 'Promise<JSHandle>'. Type '(a?: any, b?: any) => Promise<ScreenshotDiff \| undefined>' is not assignable to type '{ (): Promise; (description: string): Promise; (opts: ScreenshotOptions): Promise<...>; (description: string, opts: ScreenshotOptions): Promise<...>; }'. Type 'Promise<ScreenshotDiff \| undefined>' is not assignable to type 'Promise'. Type 'ScreenshotDiff \| undefined' is not assignable to type 'ScreenshotDiff'. Type 'undefined' is not assignable to type 'ScreenshotDiff'. Type 'null' is not assignable to type 'CompilerWatcher'. Type 'null' is not assignable to type 'Promise'. Type 'Browser \| null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'ValidatedConfig'. Type 'null' is not assignable to type 'Browser'. Type 'null' is not assignable to type 'SourceMap'. Type 'null' is not assignable to type 'PackageJsonData'. Type 'null' is not assignable to type '{ [moduleId: string]: string; } \| undefined'.
TS18047	167	Error messages 'var1' is possibly 'null'. 'configFileData' is possibly 'null'. 'canonicalLinkElm.parentNode' is possibly 'null'. 'link.parentNode' is possibly 'null'. 'href' is possibly 'null'. 'stencilScriptElm.parentNode' is possibly 'null'. 'attr' is possibly 'null'. 't.cmp' is possibly 'null'. 't.event' is possibly 'null'. 't.property' is possibly 'null'. 'appErrorElm.parentNode' is possibly 'null'. 'progressBar.parentNode' is possibly 'null'. 'serverProcess.stdout' is possibly 'null'. 'serverProcess.stderr' is possibly 'null'. 'node.nodeName' is possibly 'null'. 'element.nodeName' is possibly 'null'. 'nodeValue' is possibly 'null'. 'cloned' is possibly 'null'. 'clonedDiv' is possibly 'null'. 'clonedTemplate' is possibly 'null'. 'clonedTemplate.content.firstChild' is possibly 'null'. 'clonedTemplate.content.firstChild.textContent' is possibly 'null'. 'clonedWin' is possibly 'null'. 'titleElm' is possibly 'null'. 'doc.body.firstElementChild' is possibly 'null'. 'doc.body.firstElementChild.firstElementChild' is possibly 'null'. 'tmplElm.content.firstChild' is possibly 'null'. 'doc.firstElementChild' is possibly 'null'. 'doc.lastChild' is possibly 'null'. 'dstWin' is possibly 'null'. 'orgLocationNode.parentNode' is possibly 'null'. 'node.nodeValue' is possibly 'null'. 'node.parentNode' is possibly 'null'. 'appendAfter.parentNode' is possibly 'null'. 'hostElm.firstElementChild' is possibly 'null'. 'hostElm.lastElementChild' is possibly 'null'. 'nodeRef.nodeValue' is possibly 'null'. 'nodeRef.parentNode' is possibly 'null'. 'parentNode' is possibly 'null'. 'defaultHolder.parentNode' is possibly 'null'. 'nodeToRelocate.parentNode' is possibly 'null'. 'w' is possibly 'null'. 'elm.textContent' is possibly 'null'. 'rsp' is possibly 'null'. 'p.params' is possibly 'null'. 'head' is possibly 'null'.
TS2532	61	Error messages Object is possibly 'undefined'.
TS2454	46	Error messages Variable 'pkgJsonData' is used before being assigned. Variable 'minifyOpts' is used before being assigned. Variable 'workerCtrl' is used before being assigned. Variable 'timespan' is used before being assigned. Variable 'content' is used before being assigned. Variable 'compilerExe' is used before being assigned. Variable 'outputText' is used before being assigned. Variable 'importResolvedFile' is used before being assigned. Variable 'win' is used before being assigned. Variable 'attrName' is used before being assigned. Variable 'oldValue' is used before being assigned. Variable 'newValue' is used before being assigned. Variable 'hostId' is used before being assigned. Variable 'promise' is used before being assigned. Variable 'textContent' is used before being assigned. Variable 'resolve' is used before being assigned. Variable 'opts' is used before being assigned.
TS2722	41	Error messages Cannot invoke an object which is possibly 'undefined'.
TS2531	37	Error messages Object is possibly 'null'.
TS2352	19	Error messages Conversion of type 'null' to type 'CompilerSystem' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type 'null' to type 'string' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type 'null' to type 'string[]' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Conversion of type '{ cmps: never[]; }' to type 'Module' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. Type '{ cmps: never[]; }' is missing the following properties from type 'Module': coreRuntimeApis, collectionName, dtsFilePath, excludeFromCollection, and 27 more. Conversion of type 'null' to type 'ScreenshotCache' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
TS2769	12	Error messages No overload matches this call. Overload 1 of 2, '(type: keyof DocumentEventMap, listener: (this: Document, ev: PointerEvent \| MouseEvent \| UIEvent \| Event \| ErrorEvent \| ... 13 more ... \| WheelEvent) => any, options?: boolean \| ... 1 more ... \| undefined): void', gave the following error. Argument of type '"e"' is not assignable to parameter of type 'keyof DocumentEventMap'. Overload 2 of 2, '(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions \| undefined): void', gave the following error. Argument of type 'null' is not assignable to parameter of type 'EventListenerOrEventListenerObject'. No overload matches this call. Overload 1 of 2, '(o: {}): string[]', gave the following error. Argument of type 'BuildResultsComponentGraph \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. Overload 2 of 2, '(o: object): string[]', gave the following error. Argument of type 'BuildResultsComponentGraph \| undefined' is not assignable to parameter of type 'object'. Type 'undefined' is not assignable to type 'object'. No overload matches this call. Overload 1 of 4, '(object: {}, method: never): SpyInstance<never, never>', gave the following error. Argument of type 'CompilerWorkerContext \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. Overload 2 of 4, '(object: {}, method: never): SpyInstance<never, never>', gave the following error. Argument of type 'CompilerWorkerContext \| undefined' is not assignable to parameter of type '{}'. Type 'undefined' is not assignable to type '{}'. No overload matches this call. The last overload gave the following error. Argument of type 'string \| null' is not assignable to parameter of type '(substring: string, ...args: any[]) => string'. Type 'null' is not assignable to type '(substring: string, ...args: any[]) => string'. No overload matches this call. The last overload gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string \| RegExp'. Type 'undefined' is not assignable to type 'string \| RegExp'. No overload matches this call. Overload 1 of 2, '(configFileName: string, optionsToExtend: CompilerOptions \| undefined, system: System, createProgram?: CreateProgram \| undefined, reportDiagnostic?: DiagnosticReporter \| undefined, reportWatchStatus?: WatchStatusReporter \| undefined, watchOptionsToExtend?: WatchOptions \| undefined, extraFileExtensions?: readonly FileExtensionInfo[] \| undefined): WatchCompilerHostOfConfigFile<...>', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Overload 2 of 2, '(rootFiles: string[], options: CompilerOptions, system: System, createProgram?: CreateProgram \| undefined, reportDiagnostic?: DiagnosticReporter \| undefined, reportWatchStatus?: WatchStatusReporter \| undefined, projectReferences?: readonly ProjectReference[] \| undefined, watchOptions?: WatchOptions \| undefined): WatchCompilerHostOfFilesAndCompilerOptions<...>', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string[]'. Type 'undefined' is not assignable to type 'string[]'. No overload matches this call. Overload 1 of 2, '(timeoutId: string \| number \| Timeout \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'string \| number \| Timeout \| undefined'. Type 'null' is not assignable to type 'string \| number \| Timeout \| undefined'. Overload 2 of 2, '(id: number \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'number \| undefined'. Type 'null' is not assignable to type 'number \| undefined'. No overload matches this call. Overload 1 of 2, '(timeoutId: string \| number \| Timeout \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'string \| number \| Timeout \| undefined'. Overload 2 of 2, '(id: number \| undefined): void', gave the following error. Argument of type 'Timeout \| null' is not assignable to parameter of type 'number \| undefined'. No overload matches this call. Overload 1 of 3, '(p: string, encoding: "utf8"): Promise', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. Overload 2 of 3, '(p: string, encoding: "binary"): Promise', gave the following error. Argument of type 'string \| undefined' is not assignable to parameter of type 'string'. Type 'undefined' is not assignable to type 'string'. No overload matches this call. Overload 1 of 2, '(values: [] \| readonly unknown[]): Promise<unknown[] \| []>', gave the following error. Argument of type 'Promise[] \| undefined' is not assignable to parameter of type '[] \| readonly unknown[]'. Type 'undefined' is not assignable to type '[] \| readonly unknown[]'. Overload 2 of 2, '(values: Iterable<void \| PromiseLike>): Promise<void[]>', gave the following error. Argument of type 'Promise[] \| undefined' is not assignable to parameter of type 'Iterable<void \| PromiseLike>'. Type 'undefined' is not assignable to type 'Iterable<void \| PromiseLike>'.
TS2790	10	Error messages The operand of a 'delete' operator must be optional.
TS2538	8	Error messages Type 'undefined' cannot be used as an index type. Type 'null' cannot be used as an index type.
TS2344	5	Error messages Type 'T' does not satisfy the constraint 'Answers'.
TS2416	4	Error messages Property 'get' in type 'Cache' is not assignable to the same property in base type 'Cache'. Type '(key: string) => Promise<string \| null>' is not assignable to type '(key: string) => Promise'. Type 'Promise<string \| null>' is not assignable to type 'Promise'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Property 'getMemoryStats' in type 'Cache' is not assignable to the same property in base type 'Cache'. Type '() => string \| null' is not assignable to type '() => string'. Type 'string \| null' is not assignable to type 'string'. Type 'null' is not assignable to type 'string'. Property 'find' in type 'E2EElement' is not assignable to the same property in base type 'E2EElementInternal'. Type '(selector: string) => Promise<E2EElement \| null>' is not assignable to type '(selector: FindSelector) => Promise'. Type 'Promise<E2EElement \| null>' is not assignable to type 'Promise'. Type 'E2EElement \| null' is not assignable to type 'E2EElement'. Type 'null' is not assignable to type 'E2EElement'. Property 'findAll' in type 'E2EElement' is not assignable to the same property in base type 'E2EElementInternal'. Type '(selector: string) => Promise<E2EElement[]>' is not assignable to type '(selector: FindSelector) => Promise<E2EElement[]>'. Type 'Promise<import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement[]>' is not assignable to type 'Promise<import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement[]>'. Type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement[]' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement[]'. Type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-element").E2EElement' is not assignable to type 'import("/home/runner/work/stencil/stencil/src/testing/puppeteer/puppeteer-declarations").E2EElement'. The types returned by 'find(...)' are incompatible between these types. Type 'Promise<E2EElement \| null>' is not assignable to type 'Promise'.
TS18049	3	Error messages 'scriptElm' is possibly 'null' or 'undefined'.
TS2493	3	Error messages Tuple type '[]' of length '0' has no element at index '0'.
TS2488	2	Error messages Type 'Diagnostic[] \| undefined' must have a 'Symbol.iterator' method that returns an iterator. Type 'string[] \| undefined' must have a 'Symbol.iterator' method that returns an iterator.
TS2774	2	Error messages This condition will always return true since this function is always defined. Did you mean to call it instead?
TS2684	1	Error messages The 'this' context of type 'ResolveIdHook \| undefined' is not assignable to method's 'this' of type 'Function'. Type 'undefined' is not assignable to type 'Function'.
TS2464	1	Error messages A computed property name must be of type 'string', 'number', 'symbol', or 'any'.
TS2430	1	Error messages Interface 'SerializeOpts' incorrectly extends interface 'SerializeCssOptions'. Types of property 'usedSelectors' are incompatible. Type 'UsedSelectors \| null' is not assignable to type 'UsedSelectors \| undefined'. Type 'null' is not assignable to type 'UsedSelectors \| undefined'.

Unused exports report

There are 10 unused exports on this PR. Unfortunately, it looks like that's an increase of 1 over main 😞.

Unused exports

File	Line	Identifier
src/runtime/bootstrap-lazy.ts	15	setNonce
src/screenshot/screenshot-fs.ts	18	readScreenshotData
src/testing/testing-utils.ts	186	withSilentWarn
src/compiler/app-core/app-data.ts	3	BUILD
src/compiler/app-core/app-data.ts	88	Env
src/compiler/app-core/app-data.ts	90	NAMESPACE
src/compiler/fs-watch/fs-watch-rebuild.ts	111	updateCacheFromRebuild
src/testing/platform/testing-platform.ts	29	cssVarShim
src/testing/puppeteer/puppeteer-declarations.ts	513	WaitForEventOptions
src/client/polyfills/css-shim/utils.ts	1	GLOBAL_SCOPE

src/declarations/stencil-public-runtime.ts

rwaskiewicz · 2022-12-05T14:41:31Z

src/declarations/stencil-public-runtime.ts

+ * will result in the same behavior.
+ * @param nonce The value to be used for the nonce attribute.
+ */
+export declare function setNonce(nonce: string): void;


Is there a format that a nonce should be in? I don't see any guidance in the JSDoc as to what I should pass in if I'm a user and looking at the documentation provided by my IDE 🤔

I wonder if there's anything we should do from a type perspective to enforce a certain format 🤔

We can definitely link out to guidelines around nonce generation, but it didn't seem like Stencil's responsibility to enforce a "correct" nonce. I found these guidelines on one of the pages I was using for reference during development/testing:

The nonce should be generated using a cryptographically secure random generator

The nonce should have sufficient length, aim for at least 128 bits of entropy (32 hex characters, or about 24 base64 characters).

The characters that can be used in the nonce string are limited to the characters found in base64 encoding.

Yeah, perhaps this lives in the documentation to point to best practices around using a nonce

I have a guide drafted up that will go on our docs. I'll add a section for this topic and link out to that resource I was using. I'll get a PR up for that tomorrow.

src/declarations/stencil-private.ts

src/client/polyfills/css-shim/custom-style.ts

rwaskiewicz · 2022-12-06T14:29:47Z

src/client/client-patch-browser.ts

@@ -104,6 +104,13 @@ const patchDynamicImport = (base: string, orgScriptElm: HTMLScriptElement) => {
            type: 'application/javascript',
          })
        );
+
+        // Apply CSP nonce to the script tag if it exists
+        const nonce = plt.$nonce$ ?? (window as any).nonce;


I wonder if grabbing a field called nonce on window is the right thing to do... 🤔

On one hand, the chances of it getting overwritten by other scripts is probably higher with a name of just 'nonce'. On the other, it would probably seem weird to see a server configure a stencil_nonce field.

I suppose this is probably fine. Leaving it here in case anyone else wants to comment on

Passing thought - instead of pulling this value off window, could we instead pull it as an attribute off the html root element?

To me, it seems the usage pattern here is currently:

<script nonce="value"> - for a single script

window.nonce - for everything in the DOM

Whereas it could be:

<html nonce="value"> - for everything in the DOM

<script nonce="value"> - for a single script

Consistent DX with less brittleness tied to the window object.

Do we have access to the root element in the execution context here?

The way that Rails handles this is by adding a meta tag in the header which subsequent scripts can read from before injecting their content:

<meta name="csp-nonce" content="nonce_inserted_here">

I think this is preferable to setting on the main html tag (though I agree the DX is better to do that than window).

@sean-perkins @cscorley Thanks for the feedback and suggestions! I like the idea of using the meta tag. I'll check it out and see the feasibility to replace the window approach!

rwaskiewicz · 2022-12-06T16:19:09Z

src/runtime/nonce.ts

+ * @param nonce The value to be assigned to the platform nonce property.
+ * @returns void
+ */
+export const setNonce = (nonce: string) => (plt.$nonce$ = nonce);


This is probably going to be covered by the docs, but is the assumption that users will have to change the nonce server-side for every request that's served?

Sorta. I'm not sure the best way to phrase it, but the idea is that a nonce should be unique "per page view". So, for SPA like an Angular app, you can just generate a nonce at initial bootstrap and use that for the page's lifetime

deleonio · 2022-12-06T19:21:14Z

Hi together,

we wrote a trailing script that calculates the hashes of the CSS strings and puts them into the index.html. So it works even with activated content security and without nonces.

CSP nonces aren't supported by IE so there is no reason to add support in the polyfills

alicewriteswrongs

this all looks good to me, and based on my (admittedly limited) knowledge of the CSP business I think the code looks good!

Just had one suggestion for wording a comment

src/compiler/output-targets/dist-custom-elements/custom-elements-types.ts

src/compiler/output-targets/output-lazy-loader.ts

src/compiler/output-targets/test/custom-elements-types.spec.ts

rwaskiewicz · 2022-12-12T13:45:34Z

FYI @tanner-reits I assigned this back to you, let us know if/when it's ready for another round of review!

alicewriteswrongs

lgtm! 👍

…ow (#3955) * feat(runtime): updates nonce fallback to use meta tag instead of window This commit updates our CSP nonce support logic to allow implementers to leverage a meta tag in the DOM head for setting nonce values during the Stencil runtime rather than pulling the value off of the global window object * fix(): PR feedback * feat(utils): update return type fallback to `undefined` only

tanner-reits added 5 commits October 27, 2022 14:18

wip(compiler/runtime): setNonce behavior for dist target

81b099a

This commit adds the `setNonce` definition to the generated output for the `dist` output target. This also sets the `nonce` attribute on the style tag responsible for invisible pre-hydration styles.

feat(runtime): extra check for nonce on window

2af9abc

chore(): nonce function/declaration code comments

9b2eeea

This commit adds some comments to the internal and generated helper function code for apply nonce attributes.

test(): test various nonce application functions

545f359

tanner-reits requested a review from a team as a code owner November 14, 2022 21:11

tanner-reits assigned rwaskiewicz and alicewriteswrongs Nov 14, 2022

tanner-reits changed the title ~~Feat/csp nonce~~ feat(runtime): support for CSP nonces Nov 14, 2022

rwaskiewicz assigned tanner-reits and unassigned rwaskiewicz and alicewriteswrongs Nov 22, 2022

tanner-reits and others added 5 commits November 22, 2022 11:08

Merge branch 'main' into feat/csp-nonce

ea0db1b

chore(): run prettier

ee06584

fix(): update unit tests

70b0fab

fix(tests): remove platform reference in CSS shim polyfill

c6f9a01

fix(tests): update CSS shim unit tests

7891b60

danielleroux mentioned this pull request Nov 24, 2022

Tree control triggers errors with CSP siemens/ix#171

Closed

tanner-reits assigned rwaskiewicz and alicewriteswrongs and unassigned tanner-reits Nov 28, 2022

rwaskiewicz suggested changes Dec 6, 2022

View reviewed changes

tanner-reits added 2 commits December 8, 2022 20:44

chore(): remove CSP from IE polyfills

93dfedd

CSP nonces aren't supported by IE so there is no reason to add support in the polyfills

chore(): add JSdoc comments

0d9ffbd

alicewriteswrongs suggested changes Dec 9, 2022

View reviewed changes

src/compiler/output-targets/dist-custom-elements/custom-elements-types.ts Outdated Show resolved Hide resolved

src/compiler/output-targets/output-lazy-loader.ts Show resolved Hide resolved

src/compiler/output-targets/test/custom-elements-types.spec.ts Show resolved Hide resolved

rwaskiewicz unassigned rwaskiewicz and alicewriteswrongs Dec 12, 2022

rwaskiewicz assigned tanner-reits Dec 12, 2022

tanner-reits and others added 2 commits December 12, 2022 10:41

chore(): update setNonce JSdoc

56a673f

Merge branch 'main' into feat/csp-nonce

c3a8da8

tanner-reits requested review from rwaskiewicz and alicewriteswrongs December 12, 2022 15:42

tanner-reits assigned rwaskiewicz and alicewriteswrongs and unassigned tanner-reits Dec 12, 2022

alicewriteswrongs approved these changes Dec 12, 2022

View reviewed changes

rwaskiewicz approved these changes Dec 16, 2022

View reviewed changes

rwaskiewicz assigned tanner-reits and unassigned rwaskiewicz and alicewriteswrongs Jan 3, 2023

tanner-reits enabled auto-merge (squash) January 10, 2023 21:26

Merge branch 'main' into feat/csp-nonce

810c30f

tanner-reits merged commit c91ed48 into main Jan 10, 2023

tanner-reits deleted the feat/csp-nonce branch January 10, 2023 21:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(runtime): support for CSP nonces #3823

feat(runtime): support for CSP nonces #3823

tanner-reits commented Nov 14, 2022 •

edited by rwaskiewicz

tanner-reits commented Nov 14, 2022

github-actions bot commented Nov 14, 2022 •

edited

rwaskiewicz Dec 5, 2022

tanner-reits Dec 6, 2022 •

edited

rwaskiewicz Dec 7, 2022

tanner-reits Dec 9, 2022

rwaskiewicz Dec 6, 2022

sean-perkins Dec 21, 2022

cscorley Dec 22, 2022

tanner-reits Jan 4, 2023

rwaskiewicz Dec 6, 2022

tanner-reits Dec 6, 2022

deleonio commented Dec 6, 2022

alicewriteswrongs left a comment

rwaskiewicz commented Dec 12, 2022

alicewriteswrongs left a comment

feat(runtime): support for CSP nonces #3823

feat(runtime): support for CSP nonces #3823

Conversation

tanner-reits commented Nov 14, 2022 • edited by rwaskiewicz

Pull request checklist

Pull request type

What is the current behavior?

What is the new behavior?

Does this introduce a breaking change?

Testing

Other information

tanner-reits commented Nov 14, 2022

github-actions bot commented Nov 14, 2022 • edited

--strictNullChecks error report

reports and statistics

Unused exports report

Choose a reason for hiding this comment

tanner-reits Dec 6, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

deleonio commented Dec 6, 2022

alicewriteswrongs left a comment

Choose a reason for hiding this comment

rwaskiewicz commented Dec 12, 2022

alicewriteswrongs left a comment

Choose a reason for hiding this comment

tanner-reits commented Nov 14, 2022 •

edited by rwaskiewicz

github-actions bot commented Nov 14, 2022 •

edited

`--strictNullChecks` error report

tanner-reits Dec 6, 2022 •

edited