[PLAT-8122] React19, Stencil4, & other framework tooling upgrades by aeischeid · Pull Request #763 · Vertexvis/vertex-web-sdk

aeischeid · 2026-04-28T16:01:40Z

Summary

Modernization of dependencies and peer dependencies. Specifically to target official React 19 support, but along for the ride is TS 4 -> 5, Stencil 2 -> 4, Jest 27 -> 29, and few smaller bumps for things like ts-lib

Packaging / Module Format

This release updates the SDK’s packaging to prefer ESM and align package resolution with modern Node/bundler behavior. CommonJS remains supported, so most users should not need to change anything. The main cases to watch for are custom deep imports into dist/ or other package internals, and any hard-coded CDN/file-path references to emitted bundle filenames, which may need to be updated. Viewer packages were also adjusted to be safer to import in SSR/Node contexts.

@stencil/react-output-target v0.5 → v1.4.2: The new major version generates React wrappers using createComponent from @stencil/react-output-target/runtime instead of the old class-based proxy approach. The old react-component-lib/ directory is removed.
The rollup.config.js for viewer-react is updated to preserve the generated 'use client' directive for React Server Components compatibility.
TypeScript v4 → v5: Fixed several incompatibilities introduced by stricter TS5 checking:

Notes

This PR replaces #729 as that one needed significant merge conflict resolution and was getting out of hand

Test Plan

unit tests should pass
builds and link checks pass

will have -testing releases to test against nextjs starter with react 19. Vertexvis/vertex-nextjs-starter#224
nuxtjs-starter also tested with built packages: Vertexvis/vertex-nuxtjs-starter#8 to ensure vue wrappers remain functional and compatible

testing locally with yarn link
use yarn examples:start in this repo to test new stencil components

connect app with testing builds or yarn linking should also look good

Release Notes

New major version.
Drop support for React < 17

Possible Regressions

Beyond old React versions no known regressions, but anything noted in stencil breaking changes could apply https://github.com/stenciljs/core/blob/main/BREAKING_CHANGES.md
applyPollyfils has been removed

Dependencies

nextjs and nuxtjs starter apps
Vertexvis/vertex-nextjs-starter#224
Vertexvis/vertex-nuxtjs-starter#6

aeischeid · 2026-04-28T20:55:57Z

-export default config(
-  input('src/index.ts'),
-  typescript(),
-  output({ enableInlineDynamicImports: true })


The common build-tool config was abandoned for this package. This was somewhat a decision I inherited from the initial draft PR ( #729 ). I have tried to understand if I could update build-tools instead, but haven't had too much success with that so far. Maybe for now there is a way to just incorporate this enableInlineDynamicImports bit into this custom config? But, also at a bit at a loss on how exactly to accomplish that, or how to test if it is done correctly. Looking for feedback on the later part from @amvertex since that was added recently by them.

think I figured this out, not how to test it, but should be ready to test

add TODO: realted to build-tools

amvertex · 2026-04-29T14:09:54Z

-  public stencilBuffer: StencilBufferManager = new StencilBufferManager(
-    this.hostElement
-  );
+  public stencilBuffer!: StencilBufferManager;


What was the reason behind this change?

Related to something in the Stencil 4 upgrade. this could be undefined, so this.hostElement would error. Setting it inside of connectedCallback avoided that

amvertex · 2026-04-29T14:11:07Z

-        if (drawnFrame != null) {
+        if (
+          drawnFrame != null &&
+          frameRenderVersion === this.frameRenderVersion


What was the reason behind this change?

IIRC this one was around trying to solve memory leak issue. Short story was in tests many viewers get started but teardown was not always cleaning them up or cleaning them up well. so would end up in SIGSEGV type errors where things were just running out of memory. This seemed like it improved the situation though it didn't ultimately solve it. Felt worth keeping, though in practice I don't imagine many users of the component would bump into cases where it would make much difference

amvertex · 2026-04-29T14:14:24Z

  "name": "root",
  "private": true,
-  "nextVersionBump": "patch",
+  "nextVersionBump": "major",


@jdm717 what do you think about releasing v1.0.0 on our next release?

I didn't really mean to do this, sort of just wasn't connecting dots. I was thinking 'major' in the current semver context where minor == major. Well, pushed this to publish-testing branch before I put that together, so now we have a 1.0.0-testing build on NPM 😬

Eh, gotta go 1.0 at some point right?! 😅

I think I'd be on board with shipping a v1.0.0 with our next release to signal the significant changes being introduced! Plus we're probably a bit overdue to release v1.0.0 - we've been on v0.x.x for just a few years 🙂

aeischeid · 2026-04-29T15:01:27Z

@@ -0,0 +1 @@
+jest.spyOn(console, 'debug').mockImplementation(() => {});


there was quite a bit of console noise in tests. The way I set this up it makes it pretty easy to mute and unmute that. just comment out this line and get all the debugging messages back.

eslint will be explicitly cjs until upgrade to v9

previous build structure

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

haven't existed for a while anyway

aeischeid · 2026-05-01T17:17:14Z

+        before enabling this block.
+    -->
+
+    <!--


@jdm717 sonar doesn't like these commented out bits, but IMO they are quite handy. Is there a way to tell Sonar to ignore these examples/**/index.html files ?

It looks like I'm not able to change any of the rules there - I'll take a look at getting the correct permissions to do so next week, but in the meantime if you want to get these to stop showing up on the PR, you can always open the link and click the dropdown where it says Open and choose Accept in the cases where we're not going to take the action Sonar suggests, which should at least cause the Sonar check to pass. It does look like Sonar supports path exclusions though, so it should be possible to get the examples directory omitted later!

I got around this. Ended up just putting this comment in the examples dir readme. Easy enough to grab it from there if doing local testing

aeischeid · 2026-05-01T17:19:36Z

these move to .cjs files for now. Longer term goal would be to move to the new eslint v9 config files.

amvertex · 2026-05-01T18:12:30Z

@@ -1,7 +1,26 @@
-const jestConfig = require('@vertexvis/jest-config-vertexvis/jest.config');
+// import jestConfig from '@vertexvis/jest-config-vertexvis/jest.config';
+// TODO: return to using build-tool jest-config once supports ESM


Do we have a ticket for this?

Not yet, but certainly a good idea. I have multiple followup type tasks I have noted locally. Think I just need to set aside some time for getting those onto a proper backlog

Sounds good! I think it would be worthwhile to create the different tickets for future improvements.

amvertex · 2026-05-01T18:24:15Z

@@ -0,0 +1,9 @@
+const modulePath = new URL('../dist/components/vertex-document-viewer.js', import.meta.url);


Do you want to merge this file?

Mixed thoughts. There is no inclusion in build or CI, and I don't think that would be necessary, but is it useful enough to stick around for occasional testing if a developer happens to be working on something that would have a chance to have a dependency on browser specific API?

doc-viewer-react and -vue

amvertex

Looks great!

sonarqubecloud · 2026-05-04T19:30:35Z

Quality Gate passed

Issues
20 New issues
1 Accepted issue

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

aeischeid added 13 commits April 27, 2026 17:44

prep for yarn 4 in gitignore

8587feb

basic version bump and config changes for stencil4, TS 5, & React19

48b1ecb

formating or prettier type changes

3b17207

TS tightening & stencil upgrade specific changes

5850586

muted console.debug in jest setup

f824a25

fix missing hasGeometry attr

e179ee1

remove @aee getMarkupElement from viewr-markup

9924829

Moxks and type tightening around png-decoder

a3f9a32

clearLoadingTimer and terminate on webWorker mock

cfea7c6

runInBand for jest limit concurancy for stencil

45c10d2

fix png-decoder import issue

3f6860e

update stencil config for new TS plugin

8e4072c

Merge branch 'master' into newReact19Stencil4

afa7ca8

aeischeid commented Apr 28, 2026

View reviewed changes

Update yarn.lock

dd52889

aeischeid changed the title ~~New react19 stencil4~~ [PLAT-8122] React19, Stencil4, & other framework tooling upgrades Apr 28, 2026

Update rollup.config to pass inlineDynamicImports: true

a527d05

add TODO: realted to build-tools

amvertex reviewed Apr 29, 2026

View reviewed changes

aeischeid commented Apr 29, 2026

View reviewed changes

aeischeid added 6 commits April 29, 2026 10:24

Merge branch 'master' into newReact19Stencil4

59f27b4

revert doc-viewer packages to private for now

a21f413

add back working version of @see for viewer documentation

8b0939b

add stencilPackageName for reactOutputTarget in viewer

14d94b3

update interval type to NodeJS.Timeout per feedback

81803f2

add some readonly specifiers per sonarQube suggestions

691e1af

aeischeid marked this pull request as ready for review April 29, 2026 16:32

aeischeid requested a review from a team as a code owner April 29, 2026 16:32

aeischeid added 3 commits April 29, 2026 14:13

remove applyPolyfills from the viewer-vue too

1a7586c

remove obsolete requestidlecallback polyfill

56ba9c1

new lock file after removing polyfill

f7afa72

aeischeid added 5 commits April 30, 2026 09:18

defensive wrappers around window object to avoid SSR issues

7bda5d3

basic test for SSR safety / via node import try

46f1a5a

make builder and viewer-react module first bundles

e29999f

big push to move builds to type:module

e8313d3

eslint will be explicitly cjs until upgrade to v9

fix postbuild script - which exists to maintain backwards compat with

2d301bf

previous build structure

github-advanced-security AI found potential problems May 1, 2026

View reviewed changes

Comment thread packages/viewer/scripts/format-examples.js Fixed

aeischeid and others added 7 commits May 1, 2026 00:07

Potential fix for pull request finding in formate-example.js

867de4d

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

more backwards compatible exports map for viewer

466bab6

address sonar complaints in short term way so i can test builds

55bb5ef

use explict prettier deb more directly

6cb4499

minor update to lockfile for prettier

7e92766

Merge branch 'master' into newReact19Stencil4

b8c96b1

remove nomodule fallbacks in examples that pointed to artifacts that

9e26ec1

haven't existed for a while anyway

aeischeid commented May 1, 2026

View reviewed changes

amvertex reviewed May 1, 2026

View reviewed changes

aeischeid added 5 commits May 1, 2026 15:38

have doc-viewer exports/bundles match viewer

b446dfa

will do withouth html comment lines and have examples in readme instead

d181168

had to rename lint config files after changing to type module in

2ae52f1

doc-viewer-react and -vue

Merge branch 'master' into newReact19Stencil4

8bcc23b

new yarn.lock after merge main

3a394f9

amvertex approved these changes May 4, 2026

View reviewed changes

aeischeid added 4 commits May 4, 2026 13:48

Merge branch 'master' into newReact19Stencil4

525b825

fix botched conflict resolve done via GH ui

76857ad

fix another unresolved merge

4235cf0

newly generated lock

72d3efd

aeischeid merged commit a6f14e5 into master May 4, 2026
8 checks passed

aeischeid deleted the newReact19Stencil4 branch May 4, 2026 22:01

aeischeid mentioned this pull request May 5, 2026

[PLAT-8122] remove obsolete deps on uuid & is-plain-object #770

Merged

		@@ -0,0 +1 @@
		jest.spyOn(console, 'debug').mockImplementation(() => {});

		@@ -0,0 +1,9 @@
		const modulePath = new URL('../dist/components/vertex-document-viewer.js', import.meta.url);

Conversation

aeischeid commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Packaging / Module Format

Notes

Test Plan

Release Notes

Possible Regressions

Dependencies

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amvertex left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented May 4, 2026

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aeischeid commented Apr 28, 2026 •

edited

Loading