fix(telemetry): support TypeScript exactOptionalPropertyTypes compiler option

[wizzfi1]

Summary

This PR makes the telemetry module compatible with the TypeScript compiler option exactOptionalPropertyTypes.

When --exactOptionalPropertyTypes is enabled, TypeScript requires optional properties to explicitly allow undefined. Some telemetry-related type definitions did not conform, causing compilation errors for downstream users.

Changes

Updated telemetry configuration types to include | undefined where appropriate.

Verified that the SDK builds successfully with --exactOptionalPropertyTypes.

Confirmed that all telemetry tests pass (npm run test telemetry).

Why

This change improves SDK compatibility with strict TypeScript projects and ensures the SDK can compile cleanly with modern compiler settings.

Validation

✅ Ran npm run build successfully

✅ Verified telemetry test suite passes

✅ Confirmed no behavioral regressions

Changelog

fix(telemetry): support TypeScript exactOptionalPropertyTypes compiler option

Summary by CodeRabbit

• Bug Fixes

  • Fixed telemetry compatibility with TypeScript's exactOptionalPropertyTypes compiler option

• Chores

  • Added development workspace configuration
  • Updated changelog with new bug fix entry

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: SoulPancake / name: Anurag Bandyopadhyay (f2401f5)

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

The pull request introduces a new Nix development environment configuration file (.idx/dev.nix) for workspace setup, updates the CHANGELOG with a bug fix entry for TypeScript exactOptionalPropertyTypes support, and modifies the TelemetryConfig interface to explicitly allow undefined on the metrics property.

Changes

Cohort / File(s)	Summary
Development Environment Configuration .idx/dev.nix	New Nix workspace configuration file defining dev environment with channel, packages, environment variables, extensions, previews, and lifecycle hooks (onCreate, onStart) with commented examples for dependency installation and development workflows
Telemetry Type Definition & Documentation telemetry/configuration.ts, CHANGELOG.md	Updated TelemetryConfig.metrics property type from Partial<Record<TelemetryMetric, TelemetryMetricConfig>> to explicitly include undefined, and added changelog entry documenting fix for TypeScript exactOptionalPropertyTypes compiler option support

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

The changes are straightforward: a new configuration file with guided scaffolding, a documentation entry, and a minimal type definition update. No complex logic, behavioral changes, or multi-file refactoring patterns present.

Possibly related issues

• Can't use exactOptionalPropertyTypes because of: error TS2420: Class 'TelemetryConfiguration' incorrectly implements interface 'TelemetryConfig' #194: The explicit | undefined addition to TelemetryConfig.metrics directly resolves the TypeScript exactOptionalPropertyTypes compiler option incompatibility reported in this issue.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "fix(telemetry): support TypeScript exactOptionalPropertyTypes compiler option" clearly and specifically describes the main change in the changeset. The primary modification in telemetry/configuration.ts explicitly adds | undefined to the metrics property type, which directly addresses the stated purpose of supporting TypeScript's exactOptionalPropertyTypes compiler option. The title is appropriately scoped to the telemetry module, remains concise and readable, and avoids vague or generic language. The CHANGELOG entry confirms that this title accurately represents the fix being introduced.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

telemetry/configuration.ts (2)

25-25: Consider adding | undefined for consistency.

The attributes property in TelemetryMetricConfig is also optional. For complete exactOptionalPropertyTypes support and consistency with the TelemetryConfig.metrics update, consider adding | undefined here as well.

Apply this diff:

-  attributes?: Set<TelemetryAttribute>;
+  attributes?: Set<TelemetryAttribute> | undefined;

---

110-111: Update constructor parameter signature for consistency.

The constructor parameter metrics should also include | undefined to match the interface property type on line 35. This ensures full consistency and proper support for the exactOptionalPropertyTypes compiler option.

Apply this diff:

   constructor(
-    public metrics?: Partial<Record<TelemetryMetric, TelemetryMetricConfig>>,
+    public metrics?: Partial<Record<TelemetryMetric, TelemetryMetricConfig>> | undefined,
   ) {

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3fe33ac and 9f75c31.

📒 Files selected for processing (3)

• .idx/dev.nix (1 hunks)
• CHANGELOG.md (1 hunks)
• telemetry/configuration.ts (1 hunks)

🔇 Additional comments (3)

CHANGELOG.md (1)

6-9: LGTM! Documentation correctly reflects the bug fix.

The changelog entry accurately documents the TypeScript compiler option compatibility fix.

.idx/dev.nix (1)

1-55: Clarify the inclusion of this unrelated development environment file.

This Nix configuration file appears unrelated to the PR's stated objective of supporting TypeScript's exactOptionalPropertyTypes compiler option. Consider moving this to a separate PR focused on development environment setup.

telemetry/configuration.ts (1)

35-35: LGTM! Correctly supports exactOptionalPropertyTypes.

The addition of | undefined to the metrics property ensures compatibility with TypeScript's --exactOptionalPropertyTypes compiler option.

[wizzfi1]

Hi team

I’ve verified that this change builds successfully and passes all telemetry-related tests (npm run build and npm run test telemetry).

This update ensures that the SDK compiles cleanly when using the --exactOptionalPropertyTypes TypeScript compiler option.

Thank you for reviewing — I appreciate your time and feedback!

[Copilot]

Pull request overview

Updates telemetry type definitions to be compatible with TypeScript’s --exactOptionalPropertyTypes setting, so downstream strict TS projects can compile cleanly.

Changes:

• Adjust TelemetryConfig.metrics to explicitly permit undefined under exactOptionalPropertyTypes.
• Add a changelog entry for the telemetry fix.
• Add a .idx/dev.nix workspace configuration file.

Reviewed changes

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

File	Description
telemetry/configuration.ts	Updates exported telemetry config typings for exactOptionalPropertyTypes.
CHANGELOG.md	Adds a changelog entry documenting the telemetry typing fix.
.idx/dev.nix	Adds an IDX/Nix dev workspace configuration.

---

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

[Copilot]

This file is marked as auto-generated ("DO NOT EDIT"). If telemetry/configuration.ts is regenerated as part of the build/release process, this manual type tweak is likely to be overwritten. Consider applying the change in the OpenAPI Generator input/templates (or whatever generation step produces this file) so the fix persists across regenerations.

Suggested change

	metrics?: Partial<Record<TelemetryMetric, TelemetryMetricConfig>> | undefined;
	metrics?: Partial<Record<TelemetryMetric, TelemetryMetricConfig>>;

[Copilot]

The JSDoc for TelemetryConfig.metrics says it is a required Record<TelemetryMetric, TelemetryMetricConfig>, but the actual type is optional and Partial<...> (and now explicitly allows undefined). Please update the doc comment so it accurately reflects the public type contract.

Suggested change

	* @property {Record<TelemetryMetric, TelemetryMetricConfig>} metrics - A record mapping telemetry metrics to their configurations.
	* @property {Partial<Record<TelemetryMetric, TelemetryMetricConfig>> | undefined} metrics - An optional record mapping telemetry metrics to their configurations.

[Copilot]

This changelog entry is currently placed under the v0.9.1 section (after the v0.9.1 bullets). If this telemetry fix is intended for a future release, it should go under the Unreleased section (or the correct version section), otherwise it will read as if it shipped in v0.9.1.

[Copilot]

There are multiple extra blank lines introduced around this new changelog section (e.g., between the entry and the next version header). Please trim the redundant empty lines to keep the changelog formatting consistent and readable.