Skip to content

Conversation

@donavanbecker
Copy link
Collaborator

@donavanbecker donavanbecker commented Mar 5, 2025

3.5.0 (2025-03-04)

What's Changed

  • Fix the return value of SwitchBotOpenAPI.getDeviceStatus() method #290, Thanks @kemuridama
  • Fix circular dependencies
  • Housekeeping and update dependencies

Full Changelog: v3.4.0...v3.5.0

donavanbecker and others added 5 commits February 2, 2025 00:21
…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?*
@github-actions github-actions bot added enhancement New feature or request dependencies Pull requests that update a dependency file workflow latest labels 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
@github-actions github-actions bot added the docs label Mar 5, 2025
@donavanbecker donavanbecker merged commit e826f26 into latest Mar 5, 2025
5 of 13 checks passed
@donavanbecker donavanbecker deleted the beta-3.5.0 branch March 5, 2025 05:22
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file docs enhancement New feature or request latest workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants