Re: backupCircuit.js to ts

[ShinichiShi]

Fixes #661

Describe the changes you have made in this PR -

Migrated backupCircuit.js to Typescript

Summary by CodeRabbit

• Refactor
  • Internal improvements to backup and save operations with enhanced data handling
  • Strengthened type definitions for circuit scope management and subcircuit operations

[netlify]

✅ Deploy Preview for circuitverse ready!

Name	Link
🔨 Latest commit	f0df91c
🔍 Latest deploy log	https://app.netlify.com/projects/circuitverse/deploys/68f64fc45542a60007799eae
😎 Deploy Preview	https://deploy-preview-667--circuitverse.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 44 (🔴 down 1 from production) Accessibility: 73 (no change from production) Best Practices: 92 (no change from production) SEO: 82 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

Walkthrough

This PR adds TypeScript type definitions to the backup circuit functionality and introduces new Scope/SubCircuit interfaces. It introduces BackupData and Saveable types, updates function signatures with explicit typing, and replaces dynamic objects with typed structures. No logic changes, only type safety improvements supporting the JS-to-TS migration.

Changes

Cohort / File(s)	Summary
Type Definitions src/simulator/src/types/scope.types.ts	New file introducing SubCircuit and Scope interfaces; defines comprehensive circuit scope model with identifiers, metadata, element collections, and spatial properties
Strong Typing src/simulator/src/data/backupCircuit.ts	Adds BackupData and Saveable types; updates function signatures (checkIfBackup, backUp, scheduleBackup) with explicit typing; replaces var with const; adds JSDoc comments

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Type-safety improvements with straightforward structural changes and no complex logic modifications. Changes are homogeneous (type additions and signature updates) across a small file set, making review effort minimal.

Possibly related PRs

• refactor: typescript integration : src/simulator/src/wire.ts #442 — Modifies Scope type and updates code to use new Scope typings in wire.ts alongside this PR's scope type definitions.
• JS to TS : simulator/src/data/undo.ts #421 — Updates undo.ts to accept typed Scope and operate on backups, directly related to backupCircuit.ts backup flow changes in this PR.

Suggested reviewers

• Arnabdaz

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Re: backupCircuit.js to ts" clearly conveys that this is a conversion of backupCircuit from JavaScript to TypeScript. While the "Re:" prefix is unconventional for PR titles (typically used in email threads), the core message is concise and specific enough that a teammate scanning the repository history would immediately understand the primary change. The title directly maps to the file being converted and the objective of the PR.
Linked Issues Check	✅ Passed	The changes in this pull request directly address the objectives specified in linked issue #661. The backupCircuit.js to TypeScript conversion focuses on introducing strong-typed data structures, adding type-safe interfaces, and improving type safety through explicit type annotations on functions and variables. The summary indicates that no application logic was altered, only the implementation was refactored to use TypeScript features such as the new Scope and SubCircuit interfaces in scope.types.ts, typed function parameters and return types, and JSDoc documentation. The migration also replaced runtime patterns (like dynamic data objects) with typed alternatives, which aligns with the stated objective of improving type safety without changing behavior.
Out of Scope Changes Check	✅ Passed	All changes in this pull request are directly in scope for the JavaScript to TypeScript conversion objective. The primary change to backupCircuit.ts represents a straightforward migration of the file to TypeScript with type safety improvements. The introduction of scope.types.ts with SubCircuit and Scope interface definitions is a supporting change necessary to provide proper typing for the backupCircuit functionality. No unrelated refactoring, feature additions, or behavioral modifications are present in the changeset; all updates serve the stated goal of converting to TypeScript while maintaining existing application logic.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 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 (3)

src/simulator/src/data/backupCircuit.ts (2)

9-30: LGTM! Well-structured backup interface.

The BackupData interface correctly models the backup structure with appropriate property types. The index signature on line 29 is necessary for dynamically added module properties from moduleList.

For future improvements, consider more specific types for:

• Line 23: allNodes: any[] could be typed as the saved node format
• Line 24: testbenchData: any could be typed if the structure is known
• Line 28: restrictedCircuitElementsUsed: any[] could be more specific

These refinements can be deferred to follow-up work focused on tightening type definitions across the codebase.

---

57-109: LGTM! Correctly typed backup function.

The function is well-typed with proper JSDoc documentation. Line 69's type assertion ({} as BackupData) is acceptable here since the function immediately populates all required fields before returning. The migration preserves the original logic while adding type safety.

If you want to avoid the type assertion pattern in the future, consider using Partial<BackupData> for the initial object:

const data: Partial<BackupData> = {}

Then cast only at return: return data as BackupData. However, the current approach is perfectly acceptable for this migration.

src/simulator/src/types/scope.types.ts (1)

9-42: LGTM! Comprehensive scope interface.

The Scope interface thoroughly models the circuit scope structure with all necessary properties for backup operations. The index signature on line 41 appropriately handles dynamic circuit element collections (like wires, module types from moduleList, etc.).

For future refinements, consider more specific types for:

• Line 29: restrictedCircuitElementsUsed: any[]
• Line 30: CircuitElement: any[]
• Line 34: testbenchData: any
• Line 38: stack: any[]

These improvements can be deferred to focused type-tightening efforts across the simulator codebase.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0921d26 and f0df91c.

📒 Files selected for processing (2)

• src/simulator/src/data/backupCircuit.ts (2 hunks)
• src/simulator/src/types/scope.types.ts (1 hunks)

🧰 Additional context used

🧬 Code graph analysis (2)

src/simulator/src/data/backupCircuit.ts (3)

src/simulator/src/restrictedElementDiv.js (1)

• globalScope (4-4)

src/simulator/src/types/scope.types.ts (1)

• Scope (9-42)

src/simulator/src/metadata.ts (1)

• updateOrder (67-72)

src/simulator/src/types/scope.types.ts (2)

src/simulator/src/circuitElement.js (1)

• CircuitElement (27-993)

src/simulator/src/node.js (1)

• Node (150-1034)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Redirect rules - circuitverse
• GitHub Check: Header rules - circuitverse
• GitHub Check: Pages changed - circuitverse

🔇 Additional comments (7)

src/simulator/src/data/backupCircuit.ts (5)

1-3: LGTM! Clean imports.

The import of the Scope type is correctly placed and follows the existing import structure.

---

5-7: LGTM! Appropriate internal interface.

The Saveable interface correctly types objects with a saveObject method. The any return type is reasonable given that different circuit elements have different save formats.

---

32-41: LGTM! Correct ambient declaration and typed helper.

Line 32 correctly uses declare const to type the global globalScope variable without defining it. The extract helper function is appropriately typed to work with any Saveable object.

---

44-55: LGTM! Properly typed backup check.

The function signature correctly adds the Scope type parameter and explicit boolean return type, maintaining the original logic while improving type safety.

---

111-130: LGTM! Well-typed with improved variable declaration.

The function signature correctly adds type annotations, and line 117 appropriately uses const instead of var for the immutable backup variable. The explicit string return type accurately reflects that the function returns the JSON-stringified backup.

src/simulator/src/types/scope.types.ts (2)

1-2: LGTM! Correct imports for type definitions.

The imports of CircuitElement and Node are properly placed and necessary for the Scope interface definition below.

---

4-7: LGTM! Appropriately minimal interface.

The SubCircuit interface correctly defines the two methods (removeConnections and makeConnections) that are used in the backup functionality (lines 66 and 105 of backupCircuit.ts). Keeping the interface minimal is good practice for this migration.