feat: add useBusbarIdAsContingencyNameForPolygonCreation to Metadata

[flomillot]

Summary

• Add optional useBusbarIdAsContingencyNameForPolygonCreation property to Metadata type to support using equipment IDs instead of names as contingency identifiers during polygon creation

[coderabbitai]

📝 Walkthrough

Walkthrough

Added an optional boolean property useBusbarIdAsContingencyNameForPolygonCreation to the exported Metadata type, which now flows into StudyMetadata and ExploreMetadata via their intersection with Metadata.

Changes

Cohort / File(s)	Summary
Type Definition Update src/utils/types/metadata.ts	Added optional boolean useBusbarIdAsContingencyNameForPolygonCreation to the exported Metadata type, updating the effective shape of StudyMetadata and ExploreMetadata.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title accurately describes the main change: adding the useBusbarIdAsContingencyNameForPolygonCreation property to the Metadata type, which is the sole modification in this PR.
Description check	✅ Passed	The pull request description clearly relates to the changeset, describing the addition of a new optional property to the Metadata type for contingency naming during polygon creation.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/utils/types/metadata.ts`:
- Line 20: The new public Metadata property
useEquipmentIdAsContingencyNameForPolygonCreation is missing JSDoc; add a
concise JSDoc comment immediately above the property explaining its purpose
(controls whether equipmentId is used as the contingency polygon name), when to
set it (for services that want polygon names derived from equipment IDs), and
how undefined is interpreted (default false), and mark the type as boolean |
undefined if applicable; optionally offer a shorter alias/name (e.g.,
useEquipmentIdForContingency or useIdForPolygonContingency) in the comment or
consider renaming the property in Metadata to improve readability.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e734038-3f51-438b-81e2-ab9303d39e5d

📥 Commits

Reviewing files that changed from the base of the PR and between ac2c4a2 and d0bde9a.

📒 Files selected for processing (1)

• src/utils/types/metadata.ts

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud