Skip to content

v1.2.0

Choose a tag to compare

@github-actions github-actions released this 12 Sep 04:12
· 6 commits to master since this release

OverkizClient v1.2.0

This minor release introduces dedicated internal response models, stronger response validation and opt-in local API integration tests. Targets remain .NET Framework 4.7.2 and .NET 10, with unchanged public method signatures and existing public domain models.

Response handling

  • Model login, Somfy and CozyTouch OAuth, event-listener registration, execution/scheduling IDs, local-token generation/activation and API errors explicitly.
  • Accept optional device-state wrappers through states, deviceStates or values, choosing the first non-null collection in that order. Unknown fields are ignored, and open-ended state values, command parameters and pairing data remain flexible.
  • Reject blank required response IDs with OverkizException and incompatible known-field JSON types with JsonException. These checks intentionally tighten the previously permissive response handling.
  • Validate OAuth token fields before storing state or requesting a CozyTouch JWT. Invalid Somfy refresh responses preserve previously stored token state; a missing Somfy refresh token remains allowed.
  • Avoid deserializing successful response bodies that the operation does not consume, while preserving HTTP error mapping.

Tests and console

  • Expand the offline suite from 154 to 233 NUnit cases per framework, including response-model and live-configuration regression checks.
  • Add six opt-in live local API checks for authentication, gateways, setup, devices, states and event listeners. They reuse an existing token, do not operate devices or generate/revoke tokens, and unregister their listener.
  • Share the console's local gateway credentials through %LOCALAPPDATA%/OverkizClient/LiveTestSettings.json, importing legacy saved console credentials when needed. Live tests are disabled by default and require the local flag or an explicit per-run override.
  • Keep real credentials and live settings outside tracked source and distributed packages. CI explicitly excludes live tests.

All 233 offline cases passed on both target frameworks. All six live local API checks also passed against the configured gateway; these results do not establish compatibility with every supported vendor service. Nexity Cognito authentication remains unimplemented.

Install or update

dotnet add package OverkizClient --version 1.2.0

NUnit, the test adapter and live-test configuration are not dependencies of the library NuGet package. Review the stricter invalid-response behavior if callers depend on malformed server responses being accepted.

See the test guide, changelog and changes since v1.1.5.