110 lines (65 loc) · 5.56 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.6.1] - 2025-10-13

Fixed

Correctly send response within the request process for interruptible shapes (#111)
Pin electric to only supported versions (#111)
Correctly fetch query params within the Plug adapter (#111)

[0.6.0] - 2025-09-15

Added

Add new phoenix_sync.install task to simplify installation and configuration via igniter #93
Allow for transforming the sync stream returned by Phoenix.Sync.Router.sync/3 using a transform function #99
Add new phx.sync.tanstack_db.setup task to convert a new Phoenix app to use Tanstack DB and Vite igniter #102

Changed

Bump electric to version 1.1.9 #103

Fixed

Remove Ecto requirement from Phoenix.Sync.LiveView.sync_stream/4 by allowing keyword-based shape definitions #95
Ensure Electric stack is ready before calling the embedded API #104
Forward HTTP request headers onto sync backend #107

[0.5.1] - 2025-08-18

Changed

Update electric to ~> 1.1 including new faster storage engine.
Update electric_client to ~> 0.7.0 which includes txid headers in sync messages.

Fixed

Use 32-bit txid to ensure consistency with Electric sync messages (#71)
Only enable sandbox if both Ecto.SQL and Electric are installed (#86)
Fix liveview startup #87 (#88)
Fix occasional compilation error when Electric installed (#89)
Include jason dependency if Elixir doesn't have built in JSON support (#90)

[0.5.0] - 2025-08-13

Added

A new Phoenix.Sync.Shape that maintains an live, in-memory representation of the current state of the database (#77)
Integration with Ecto.Adapters.SQL.Sandbox via Phoenix.Sync.Sandbox to enable simulating updates to shapes within a test transaction (#73)
Interruptible shape endpoints using Phoenix.Sync.Controller.sync_render/3 (#65)
Support for defining shapes via a changeset/1 function (#70)

Fixed

Improve error messages caused by invalid module names (#74)
Fix compilation errors when included with no :ecto dependency (#79)

[0.4.4] - 2025-06-30

Added

Both controller- and router-based shapes now return CORS headers for all requests requests (#62)

Changed

Updated electric_client to support Ecto.ULID, :map and :array types (v0.6.3)
Updated electric to latest version (v1.0.21)

Fixed

Phoenix.Sync will now emit a warning if the configuration is missing the env setting (#60)

[0.4.3] - 2025-05-20

Changed

Updated to support latest Electric version (v1.0.13)

[0.4.2] - 2025-05-14

Fixed

Correctly resolve sync macro Plug within aliased Phoenix.Router scope (#40).

[0.4.1] - 2025-05-14

Fixed

Embedded client includes correct content-type headers (#35).
Server errors are now propagated to the Liveview so they are not obscured by errors due to missing resume message (#37).
Credentials and other configured params are now correctly included in the Electric.Client configuration (#38).

[0.4.0] - 2025-05-13

Added

Phoenix.Sync.Writer for handling optimistic writes in the client

[0.3.4] - 2025-03-25

Changed

Updated to support Electric v1.0.1