Skip to content

Commit

Permalink
Prepare version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dsrees committed Nov 5, 2021
1 parent 8a4fcb5 commit 05b0108
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@ All notable changes to this project will be documented in this file. The format

This product uses [Semantic Versioning](https://semver.org/).

## 2.2.0
* **BREAKING**: Properly handle a `phx_reply` response by hiding the nested payload from the client and only returning the `response` for `Message.payload`. For convenince, `Message.rawPayload` has been provided which will behave the same as `Message.payload` in earlier versions.


## 3.0.0
This ia a **BREAKING** release. The following has changed to properly matched the phoenix.js library
* `message.payload.response` is now automatically unwrapped and returned as `message.payload` for `phx_reply` events.
* The client now, be default, uses the JSON V2 Serializer which was added in phoenix 1.3. If you are still running 1.2 or earlier, then you will need to
continue using SwiftPhoenixClient 2.1.0, or provide your own custom `vsn`, `encoder` and `decoder` to the `Socket` class.

## 2.1.1
* Fixed HeartbeatTimer to add thread safety and fix crash reported in #188
Expand Down
2 changes: 1 addition & 1 deletion Sources/SwiftPhoenixClient/Message.swift
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class Message {

/// The raw payload from the Message, including a nested response from
/// phx_reply events. It is recommended to use `payload` instead.
public let rawPayload: Payload
internal let rawPayload: Payload

/// Message payload
public var payload: Payload {
Expand Down
2 changes: 1 addition & 1 deletion SwiftPhoenixClient.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Pod::Spec.new do |s|
s.name = "SwiftPhoenixClient"
s.version = "2.2.0"
s.version = "3.0.0"
s.summary = "Connect your Phoenix and iOS applications through WebSockets!"
s.swift_version = "5.0"
s.description = <<-EOS
Expand Down

0 comments on commit 05b0108

Please sign in to comment.