Repository navigation
Fix the return value of SwitchBotOpenAPI.getDeviceStatus() method - #290
Merged
donavanbecker merged 1 commit intoFeb 6, 2025
Conversation
donavanbecker
pushed a commit
that referenced
this pull request
Feb 6, 2025
…290) ## ♻️ Current situation *Describe the current situation. Explain current problems, if there are any. Be as descriptive as possible (e.g., including examples or code snippets).* `SwitchBotOpenAPI.getDeviceStatus()` method returns an object like below: ``` { response: { statusCode: 100, body: { version: 'V2.9', battery: 41, lockState: 'locked', doorState: 'closed', calibrate: true, deviceId: 'XXXXXXXX', deviceType: 'XXXXXXXX', hubDeviceId: 'XXXXXXXX' }, message: 'success' }, statusCode: 200 } ``` But `SwitchBotOpenAPI.getDeviceStatus()` expects to return `{ response: deviceStatus, statusCode: deviceStatusRequest['statusCode'] }` type. ## 💡 Proposed solution *Describe the proposed solution and changes. How does it affect the project? How does it affect the internal structure (e.g., refactorings)?* [This line](https://github.com/OpenWonderLabs/node-switchbot/blob/ca9e2255e7a50bdb709058c259f2581dc3ee7467/src/switchbot-openapi.ts#L201) does not return `deviceStatus` type but `deviceStatusRequest` type. So this PR fix the internal type in the `getDeviceStatus()` method so that it returns an expected object. ## ⚙️ Release Notes *Provide a summary of the changes or features from a user's point of view. If there are breaking changes, provide migration guides using code examples of the affected features.* ## ➕ Additional Information *If applicable, provide additional context in this section.* ### Testing *Which tests were added? Which existing tests were adapted/changed? Which situations are covered, and what edge cases are missing?* ### Reviewer Nudging *Where should the reviewer start? what is a good entry point?*
donavanbecker
added a commit
that referenced
this pull request
Mar 5, 2025
## [3.5.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v3.5.0) (2025-03-04) ### What's Changed - Fix the return value of SwitchBotOpenAPI.getDeviceStatus() method [#290](#290), Thanks [@kemuridama](https://github.com/kemuridama) - Fix circular dependencies - Housekeeping and update dependencies **Full Changelog**: v3.4.0...v3.5.0
Merged
donavanbecker
added a commit
that referenced
this pull request
Mar 5, 2025
## [3.5.0](https://github.com/OpenWonderLabs/node-switchbot/releases/tag/v3.5.0) (2025-03-04) ### What's Changed - Fix the return value of SwitchBotOpenAPI.getDeviceStatus() method [#290](#290), Thanks [@kemuridama](https://github.com/kemuridama) - Fix circular dependencies - Housekeeping and update dependencies **Full Changelog**: v3.4.0...v3.5.0
donavanbecker
added a commit
that referenced
this pull request
Mar 5, 2025
- Fix the return value of SwitchBotOpenAPI.getDeviceStatus() method [#290](#290), Thanks [@kemuridama](https://github.com/kemuridama) - Fix circular dependencies - Housekeeping and update dependencies **Full Changelog**: v3.4.0...v3.5.0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
♻️ Current situation
Describe the current situation. Explain current problems, if there are any. Be as descriptive as possible (e.g., including examples or code snippets).
SwitchBotOpenAPI.getDeviceStatus()method returns an object like below:But
SwitchBotOpenAPI.getDeviceStatus()expects to return{ response: deviceStatus, statusCode: deviceStatusRequest['statusCode'] }type.💡 Proposed solution
Describe the proposed solution and changes. How does it affect the project? How does it affect the internal structure (e.g., refactorings)?
This line does not return
deviceStatustype butdeviceStatusRequesttype. So this PR fix the internal type in thegetDeviceStatus()method so that it returns an expected object.⚙️ Release Notes
Provide a summary of the changes or features from a user's point of view. If there are breaking changes, provide migration guides using code examples of the affected features.
➕ Additional Information
If applicable, provide additional context in this section.
Testing
Which tests were added? Which existing tests were adapted/changed? Which situations are covered, and what edge cases are missing?
Reviewer Nudging
Where should the reviewer start? what is a good entry point?