refactor setup.js to ts

[ShinichiShi]

Fixes #661

Describe the changes you have made in this PR -

modified setup.js to typescript while maintaining the logic

Summary by CodeRabbit

• Refactor

  • Improved startup stability via stronger type safety, stricter element validation, and safer environment handling (display scale, embed/light mode).

• Bug Fixes

  • More reliable project loading with guarded data handling and clearer routing when version info is missing.
  • Safer layout, canvas sizing and redraw flows to prevent rendering or empty-screen issues.
  • More robust tutorial/tour visibility and error handling during setup.

[coderabbitai[bot]]

Walkthrough

Converted JavaScript setup logic in src/simulator/src/setup.ts to TypeScript with explicit return types, stricter DOM and window property guards, and safer data/loading flows. Added global Window augmentation and a ProjectData interface in src/simulator/src/types/setup.types.ts.

Changes

Cohort / File(s)	Summary
Setup logic (conversion + stricter guards) src/simulator/src/setup.ts	Added explicit type annotations and return types (void, Promise<void>) to setup-related functions (resetup, setupEnvironment, fetchProjectData, loadProjectData, showTour, setup). Introduced a local PlotArea interface and imported ProjectData. Replaced direct global accesses with window-prefixed properties and added existence checks for critical DOM elements. Refactored layout/canvas sizing, guarded DOM manipulations, adjusted drawing/resize flow, expanded environment setup call signature, and added error handling around data loading and localStorage usage.
Type definitions (globals + ProjectData) src/simulator/src/types/setup.types.ts	Added global Window augmentation with properties: projectId, data, logixProjectId, isUserLoggedIn, DPR, width, height, embed, lightMode. Exported ProjectData interface with optional timePeriod, optional simulatorVersion, optional name, and an index signature for additional keys.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

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 "refactor setup.js to ts" directly and clearly summarizes the main change in the changeset, which is the conversion of the setup.js file from JavaScript to TypeScript. The title is concise, specific, and accurately reflects the primary objective of the PR. It avoids vague terminology and provides a teammate scanning the history with clear understanding of what was changed.
Linked Issues Check	✅ Passed	The code changes align with the requirements specified in linked issue #661. The PR successfully converts setup.js to TypeScript by adding explicit return types to functions, introducing type annotations for parameters, and creating a new types file (setup.types.ts) with proper TypeScript interfaces and Window augmentation. The changes preserve existing runtime logic while improving type safety through proper type definitions, null/existence checks, and type guards—all core objectives of the JavaScript-to-TypeScript conversion feature request. The PR description confirms that existing functionality is maintained and only interfaces, data types, and type safety have been improved.
Out of Scope Changes Check	✅ Passed	All code changes in this PR are directly related to the TypeScript conversion objectives outlined in issue #661. The modifications to setup.ts include type annotations, return type declarations, interface definitions, and type-safety improvements—all integral to the conversion process and explicitly permitted by the feature request. The new setup.types.ts file introduces TypeScript type definitions and Window augmentation, which directly support the goal of improving type safety. No unrelated refactoring, logic changes, or new features have been introduced beyond what is necessary for the JavaScript-to-TypeScript conversion.
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.}

[netlify[bot]]

✅ Deploy Preview for circuitverse ready!

Name	Link
🔨 Latest commit	e8decbe79da8bf9bfbca319624b48136b5238766
🔍 Latest deploy log	https://app.netlify.com/projects/circuitverse/deploys/68f6928582d186000869e99a
😎 Deploy Preview	https://deploy-preview-666--circuitverse.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 46 (🟢 up 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.