PLAT 10072: web-worker type export #1951 by sb-gaurava · Pull Request #2715 · bugsnag/bugsnag-js

sb-gaurava · 2026-04-05T09:54:51Z

Goal

Fix the TypeScript type export in @bugsnag/web-worker to support projects using the --isolatedModules flag (e.g., Vite, modern React setups). This prevents TS1205 errors and ensures type-only exports are compatible with single-file transpilers.

Design

The fix uses the export type { WorkerConfig } syntax, which is required by TypeScript when re-exporting types with --isolatedModules. This is the recommended and future-proof way to export types, ensuring compatibility with all TypeScript build modes.

Changeset

Changed export { WorkerConfig } to export type { WorkerConfig } in notifier.ts.
Added/updated a unit test (notifier.test.ts) to verify correct type export and required properties in WorkerConfig.
Note: test-repro.ts was used for local verification only and is not included in this PR.

Testing

Verified locally with a temporary test file that the TS1205 error is resolved and type checking works as expected.
Added a unit test to ensure WorkerConfig requires apiKey and allows custom fields.
Confirmed that omitting apiKey triggers a type error as expected.

github-actions · 2026-04-05T09:58:35Z

`@bugsnag/browser` bundle size diff

	Minified	Minfied + Gzipped
Before	`51.65 kB`	`15.26 kB`
After	`51.65 kB`	`15.26 kB`
±	No change	No change

code coverage diff

Coverage values did not change👌.

Total:

Lines	Branches	Functions	Statements
0%(+0%)	0%(+0%)	0%(+0%)	0%(+0%)

Generated by 🚫 dangerJS against 3f4a31d

Copilot

Pull request overview

Updates the @bugsnag/web-worker published type entrypoint to use a type-only export for WorkerConfig, avoiding TS1205 when consumers compile with --isolatedModules (e.g. Vite / single-file transpilers).

Changes:

Switch WorkerConfig export in packages/web-worker/types/notifier.ts to export type { WorkerConfig }.
Add a new Jest test file intended to validate WorkerConfig typing expectations.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
packages/web-worker/types/notifier.ts	Uses a type-only export for `WorkerConfig` to support `--isolatedModules`.
packages/web-worker/types/notifier.test.ts	Adds a test intended to enforce `WorkerConfig` type behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-05T09:59:40Z

+describe('WorkerConfig type', () => {
+  it('should allow apiKey and custom fields', () => {
+    // This should type-check without error
+    const config: WorkerConfig = {
+      apiKey: '123',
+      collectUserIp: true,
+      generateAnonymousId: false
+    };
+    expect(config.apiKey).toBe('123');
+    expect(config.collectUserIp).toBe(true);
+    expect(config.generateAnonymousId).toBe(false);
+  });
+
+  it('should error if apiKey is missing', () => {
+    // @ts-expect-error: apiKey is required
+    const config: WorkerConfig = {
+      collectUserIp: true,
+      generateAnonymousId: false
+    };
+    expect(config).toBeDefined();
+  });
+});


This test file lives under packages/web-worker/types/, and packages/web-worker/package.json publishes the entire types directory ("files": ["dist", "types"]). That means this *.test.ts will be shipped to consumers. Consider moving this test into packages/web-worker/test/ (or excluding **/*.test.* from the published files list) so the published package only contains actual type entrypoints.

Suggested change

describe('WorkerConfig type', () => {

it('should allow apiKey and custom fields', () => {

// This should type-check without error

const config: WorkerConfig = {

apiKey: '123',

collectUserIp: true,

generateAnonymousId: false

};

expect(config.apiKey).toBe('123');

expect(config.collectUserIp).toBe(true);

expect(config.generateAnonymousId).toBe(false);

});

it('should error if apiKey is missing', () => {

// @ts-expect-error: apiKey is required

const config: WorkerConfig = {

collectUserIp: true,

generateAnonymousId: false

};

expect(config).toBeDefined();

});

});

// This file intentionally performs compile-time validation for the public type.

// It avoids runtime test constructs so it can safely live alongside published

// type entrypoints without depending on a test framework.

const config: WorkerConfig = {

apiKey: '123',

collectUserIp: true,

generateAnonymousId: false

};

const apiKey: string = config.apiKey;

const collectUserIp: boolean = config.collectUserIp;

const generateAnonymousId: boolean = config.generateAnonymousId;

void apiKey;

void collectUserIp;

void generateAnonymousId;

// @ts-expect-error: apiKey is required

const invalidConfig: WorkerConfig = {

collectUserIp: true,

generateAnonymousId: false

};

void invalidConfig;

export {};

Copilot · 2026-04-05T09:59:41Z

+
+  it('should error if apiKey is missing', () => {
+    // @ts-expect-error: apiKey is required
+    const config: WorkerConfig = {
+      collectUserIp: true,
+      generateAnonymousId: false
+    };
+    expect(config).toBeDefined();


This test intends to assert type behavior (including @ts-expect-error), but Jest + Babel compilation won’t fail on TypeScript type errors. Also, packages/web-worker is not included in the root tsconfig.json that’s compiled by npm run test:types, so this file likely won’t be type-checked in CI. To make this meaningful, add a type-check step that includes packages/web-worker/types (e.g. a package-level test:types that runs tsc --noEmit over these files, or include this directory in an existing type-test project).

Copilot · 2026-04-05T09:59:41Z

+import type { WorkerConfig } from './notifier';
+
+describe('WorkerConfig type', () => {
+  it('should allow apiKey and custom fields', () => {
+    // This should type-check without error
+    const config: WorkerConfig = {
+      apiKey: '123',
+      collectUserIp: true,
+      generateAnonymousId: false
+    };
+    expect(config.apiKey).toBe('123');
+    expect(config.collectUserIp).toBe(true);
+    expect(config.generateAnonymousId).toBe(false);
+  });


This file’s formatting (semicolons, etc.) doesn’t match the repo’s ESLint config (standard-with-typescript), which enforces a no-semicolons style for *.ts/*.test.ts. Running npm run test:lint will likely fail on this file; please align it with the existing test style in packages/web-worker/test/*.ts.

Copilot · 2026-04-05T09:59:41Z

+describe('WorkerConfig type', () => {
+  it('should allow apiKey and custom fields', () => {
+    // This should type-check without error
+    const config: WorkerConfig = {
+      apiKey: '123',
+      collectUserIp: true,
+      generateAnonymousId: false
+    };


The test name says it "should allow apiKey and custom fields", but the object literal only uses declared WorkerConfig fields (apiKey, collectUserIp, generateAnonymousId). Either add an actual extra property to demonstrate custom fields (if intended/supported), or rename the test to reflect what it’s asserting.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-21T07:33:04Z

+  it('should allow apiKey and custom fields', () => {
+    // This should type-check without error
+    const config: WorkerConfig = {
+      apiKey: '123',
+      collectUserIp: true,
+      generateAnonymousId: false
+    };


The test name/comment says “custom fields”, but the object literal only uses known properties (apiKey, collectUserIp, generateAnonymousId). Also, WorkerConfig (via Config) doesn’t appear to allow arbitrary extra keys, so this wording is misleading. Please rename the test to reflect what’s actually being exercised, or add a true “extra property allowed” case if that’s intended behavior.

Copilot · 2026-04-21T07:33:04Z

+import type { WorkerConfig } from './notifier';
+
+describe('WorkerConfig type', () => {
+  it('should allow apiKey and custom fields', () => {
+    // This should type-check without error


This test file uses semicolons, which will violate the repo’s Standard/standard-with-typescript lint rules (existing *.test.ts files in this repo omit semicolons). Please align formatting with the project style (remove semicolons, trailing punctuation) to avoid CI lint failures.

PLAT 10072: web-worker type export #1951

3f4a31d

sb-gaurava requested a review from Copilot April 5, 2026 09:56

Copilot started reviewing on behalf of sb-gaurava April 5, 2026 09:56 View session

Copilot AI reviewed Apr 5, 2026

View reviewed changes

sb-gaurava requested review from SB-gulshans, SB-priyankap and Copilot April 21, 2026 07:27

Copilot started reviewing on behalf of sb-gaurava April 21, 2026 07:27 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PLAT 10072: web-worker type export #1951#2715

PLAT 10072: web-worker type export #1951#2715
sb-gaurava wants to merge 1 commit intonextfrom
PLAT-10072/fix-web-worker-type

sb-gaurava commented Apr 5, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 5, 2026

Uh oh!

Copilot AI Apr 5, 2026

Uh oh!

Copilot AI Apr 5, 2026

Uh oh!

Copilot AI Apr 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

sb-gaurava commented Apr 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 5, 2026

@bugsnag/browser bundle size diff

code coverage diff

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sb-gaurava commented Apr 5, 2026 •

edited

Loading

`@bugsnag/browser` bundle size diff