Merge develop into 4-lib-improvement

Merge pull request #31 from noordstar/4-transfer-api

.gitignore

@@ -8,3 +8,6 @@ repl-temp-*
 # Elm output
 index.html
 elm.js
+
+# Elm configurations
+elm-*.json

src/Internal/Api/BaseUrl/Api.elm

@@ -87,12 +87,12 @@ coder =
             { fieldName = "m.homeserver"
             , toField = .homeserver
             , coder =
-                Json.object2
+                Json.object1
                     { name = "Homeserver Information"
                     , description =
                         [ "Used by clients to discover homeserver information."
                         ]
-                    , init = \a _ -> { baseUrl = a }
+                    , init = HomeserverInformation
                     }
                     (Json.field.required
                         { fieldName = "base_url"
@@ -103,17 +103,6 @@ coder =
                         , coder = Json.string
                         }
                     )
-                    (Json.field.optional.value
-                        { fieldName = L.field
-                        , toField = always Nothing
-                        , description =
-                            [ "The Elm SDK always expects objects to have at least two fields."
-                            , "Otherwise, what's the point of hiding the value in an object?"
-                            , "For this reason, this empty placeholder key will always be ignored."
-                            ]
-                        , coder = Json.value
-                        }
-                    )
             , description =
                 [ "Used by clients to discover homeserver information."
                 ]
@@ -123,12 +112,12 @@ coder =
             { fieldName = "m.identity_server"
             , toField = .identityServer
             , coder =
-                Json.object2
+                Json.object1
                     { name = "Homeserver Information"
                     , description =
                         [ "Used by clients to discover homeserver information."
                         ]
-                    , init = \a _ -> { baseUrl = a }
+                    , init = IdentityServerInformation
                     }
                     (Json.field.required
                         { fieldName = "base_url"
@@ -139,17 +128,6 @@ coder =
                         , coder = Json.string
                         }
                     )
-                    (Json.field.optional.value
-                        { fieldName = L.field
-                        , toField = always Nothing
-                        , description =
-                            [ "The Elm SDK always expects objects to have at least two fields."
-                            , "Otherwise, what's the point of hiding the value in an object?"
-                            , "For this reason, this empty placeholder key will always be ignored."
-                            ]
-                        , coder = Json.value
-                        }
-                    )
             , description =
                 [ "Used by clients to discover identity server information."
                 ]

src/Internal/Api/LoginWithUsernameAndPassword/Api.elm

@@ -888,12 +888,12 @@ disoveryInformationCoderV1 =
             { fieldName = "m.homeserver"
             , toField = .homeserver
             , coder =
-                Json.object2
+                Json.object1
                     { name = "Homeserver Information"
                     , description =
                         [ "Used by clients to discover homeserver information."
                         ]
-                    , init = \a _ -> { baseUrl = a }
+                    , init = HomeserverInformation
                     }
                     (Json.field.required
                         { fieldName = "base_url"
@@ -904,17 +904,6 @@ disoveryInformationCoderV1 =
                         , coder = Json.string
                         }
                     )
-                    (Json.field.optional.value
-                        { fieldName = L.field
-                        , toField = always Nothing
-                        , description =
-                            [ "The Elm SDK always expects objects to have at least two fields."
-                            , "Otherwise, what's the point of hiding the value in an object?"
-                            , "For this reason, this empty placeholder key will always be ignored."
-                            ]
-                        , coder = Json.value
-                        }
-                    )
             , description =
                 [ "Used by clients to discover homeserver information."
                 ]
@@ -924,12 +913,12 @@ disoveryInformationCoderV1 =
             { fieldName = "m.identity_server"
             , toField = .identityServer
             , coder =
-                Json.object2
+                Json.object1
                     { name = "Homeserver Information"
                     , description =
                         [ "Used by clients to discover homeserver information."
                         ]
-                    , init = \a _ -> { baseUrl = a }
+                    , init = HomeserverInformation
                     }
                     (Json.field.required
                         { fieldName = "base_url"
@@ -940,17 +929,6 @@ disoveryInformationCoderV1 =
                         , coder = Json.string
                         }
                     )
-                    (Json.field.optional.value
-                        { fieldName = L.field
-                        , toField = always Nothing
-                        , description =
-                            [ "The Elm SDK always expects objects to have at least two fields."
-                            , "Otherwise, what's the point of hiding the value in an object?"
-                            , "For this reason, this empty placeholder key will always be ignored."
-                            ]
-                        , coder = Json.value
-                        }
-                    )
             , description =
                 [ "Used by clients to discover identity server information."
                 ]

src/Internal/Api/Main.elm

@@ -1,6 +1,6 @@
 module Internal.Api.Main exposing
     ( Msg
-    , sendMessageEvent
+    , sendMessageEvent, sync
     )
 
 {-|
@@ -18,7 +18,7 @@ This module is used as reference for getting
 
 ## Actions
 
-@docs sendMessageEvent
+@docs sendMessageEvent, sync
 
 -}
 
@@ -57,3 +57,22 @@ sendMessageEvent env data =
             }
         )
         (Context.apiFormat env.context)
+
+
+{-| Sync with the Matrix API to stay up-to-date.
+-}
+sync :
+    E.Envelope a
+    -> { toMsg : Msg -> msg }
+    -> Cmd msg
+sync env data =
+    ITask.run
+        data.toMsg
+        (ITask.sync
+            { fullState = Nothing
+            , presence = env.settings.presence
+            , since = env.context.nextBatch
+            , timeout = Just env.settings.syncTime
+            }
+        )
+        (Context.apiFormat env.context)

src/Internal/Api/SendMessageEvent/Api.elm

@@ -143,26 +143,15 @@ sendMessageEventV3 { content, eventType, roomId, transactionId } =
 
 coderV1 : Json.Coder SendMessageEventOutputV1
 coderV1 =
-    Json.object2
+    Json.object1
         { name = "EventResponse"
         , description =
             [ "This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for \"once-off\" activity in a room."
             , "The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event."
             , "https://spec.matrix.org/legacy/r0.0.0/client_server.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid"
             ]
-        , init = always SendMessageEventOutputV1
+        , init = SendMessageEventOutputV1
         }
-        (Json.field.optional.value
-            { fieldName = L.field
-            , toField = always Nothing
-            , description =
-                [ "The Elm SDK always expects objects to have at least two fields."
-                , "Otherwise, what's the point of hiding the value in an object?"
-                , "For this reason, this empty placeholder key will always be ignored."
-                ]
-            , coder = Json.value
-            }
-        )
         (Json.field.optional.value
             { fieldName = "event_id"
             , toField = .eventId
@@ -174,26 +163,15 @@ coderV1 =
 
 coderV2 : Json.Coder SendMessageEventOutputV2
 coderV2 =
-    Json.object2
+    Json.object1
         { name = "EventResponse"
         , description =
             [ "This endpoint is used to send a message event to a room. Message events allow access to historical events and pagination, making them suited for \"once-off\" activity in a room."
             , "The body of the request should be the content object of the event; the fields in this object will vary depending on the type of event."
             , "https://spec.matrix.org/legacy/client_server/r0.6.1.html#put-matrix-client-r0-rooms-roomid-send-eventtype-txnid"
             ]
-        , init = always SendMessageEventOutputV2
+        , init = SendMessageEventOutputV2
         }
-        (Json.field.optional.value
-            { fieldName = L.field
-            , toField = always Nothing
-            , description =
-                [ "The Elm SDK always expects objects to have at least two fields."
-                , "Otherwise, what's the point of hiding the value in an object?"
-                , "For this reason, this empty placeholder key will always be ignored."
-                ]
-            , coder = Json.value
-            }
-        )
         (Json.field.required
             { fieldName = "event_id"
             , toField = .eventId

src/Internal/Api/Sync/Api.elm

@@ -0,0 +1,176 @@
+module Internal.Api.Sync.Api exposing (sync, Phantom)
+
+{-|
+
+
+# Sync
+
+The sync module might be one of the most crucial parts of the Elm SDK. It offers
+users the guarantee that the `Vault` type remains up-to-date, and it helps
+communicate with the Matrix server about the Vault's needs.
+
+@docs sync, Phantom
+
+-}
+
+import Internal.Api.Api as A
+import Internal.Api.Request as R
+import Internal.Api.Sync.V1 as V1
+import Internal.Api.Sync.V2 as V2
+import Internal.Api.Sync.V3 as V3
+import Internal.Api.Sync.V4 as V4
+import Internal.Filter.Timeline as Filter
+
+
+{-| Sync with the Matrix API.
+-}
+sync : SyncInput -> A.TaskChain (Phantom a) (Phantom a)
+sync =
+    A.startWithVersion "v1.1" syncV1
+        |> A.forVersion "v1.2" syncV2
+        |> A.sameForVersion "v1.3"
+        |> A.forVersion "v1.4" syncV3
+        |> A.sameForVersion "v1.5"
+        |> A.sameForVersion "v1.6"
+        |> A.sameForVersion "v1.7"
+        |> A.sameForVersion "v1.8"
+        |> A.sameForVersion "v1.9"
+        |> A.sameForVersion "v1.10"
+        |> A.forVersion "v1.11" syncV4
+        |> A.versionChain
+
+
+
+-- For simplicity, we will not use a filter for now
+-- and assume that every client always wants to receive all events.
+-- type FilterV1
+--     = FilterV1 Filter
+--     | FilterIdV1 String Filter
+--     | NoFilter
+
+
+type alias Phantom a =
+    { a | accessToken : (), baseUrl : (), versions : () }
+
+
+type alias PhantomV1 a =
+    { a | accessToken : (), baseUrl : () }
+
+
+type alias SyncInput =
+    { -- filter : FilterV1,
+      fullState : Maybe Bool
+    , presence : Maybe String
+    , since : Maybe String
+    , timeout : Maybe Int
+    }
+
+
+type alias SyncInputV1 a =
+    { a
+        | -- filter : FilterV1 ,
+          since : Maybe String
+        , fullState : Maybe Bool
+        , presence : Maybe String
+        , timeout : Maybe Int
+    }
+
+
+presenceFromOptions : List String -> Maybe String -> Maybe String
+presenceFromOptions options =
+    Maybe.andThen
+        (\v ->
+            if List.member v options then
+                Just v
+
+            else
+                Nothing
+        )
+
+
+syncV1 : SyncInputV1 i -> A.TaskChain (PhantomV1 a) (PhantomV1 a)
+syncV1 data =
+    A.request
+        { attributes =
+            [ R.accessToken
+            , R.queryOpString "filter" Nothing -- FILTER HERE
+            , R.queryOpBool "full_state" data.fullState
+            , data.presence
+                |> presenceFromOptions [ "offline", "online", "unavailable" ]
+                |> R.queryOpString "set_presence"
+            , R.queryOpString "since" data.since
+            , R.queryOpInt "timeout" data.timeout
+            ]
+        , coder = V1.coderSyncResponse
+        , contextChange = always identity
+        , method = "GET"
+        , path = [ "_matrix", "client", "v3", "sync" ]
+        , toUpdate =
+            Debug.log "Handling output v1" >> V1.updateSyncResponse { filter = Filter.pass, since = data.since } >> Debug.log "Received"
+        }
+
+
+syncV2 : SyncInputV1 i -> A.TaskChain (PhantomV1 a) (PhantomV1 a)
+syncV2 data =
+    A.request
+        { attributes =
+            [ R.accessToken
+            , R.queryOpString "filter" Nothing
+            , R.queryOpBool "full_state" data.fullState
+            , data.presence
+                |> presenceFromOptions [ "offline", "online", "unavailable" ]
+                |> R.queryOpString "set_presence"
+            , R.queryOpString "since" data.since
+            , R.queryOpInt "timeout" data.timeout
+            ]
+        , coder = V2.coderSyncResponse
+        , contextChange = always identity
+        , method = "GET"
+        , path = [ "_matrix", "client", "v3", "sync" ]
+        , toUpdate =
+            Debug.log "Handling output v2" >> V2.updateSyncResponse { filter = Filter.pass, since = data.since } >> Debug.log "Received"
+        }
+
+
+syncV3 : SyncInputV1 i -> A.TaskChain (PhantomV1 a) (PhantomV1 a)
+syncV3 data =
+    A.request
+        { attributes =
+            [ R.accessToken
+            , R.queryOpString "filter" Nothing
+            , R.queryOpBool "full_state" data.fullState
+            , data.presence
+                |> presenceFromOptions [ "offline", "online", "unavailable" ]
+                |> R.queryOpString "set_presence"
+            , R.queryOpString "since" data.since
+            , R.queryOpInt "timeout" data.timeout
+            ]
+        , coder = V3.coderSyncResponse
+        , contextChange = always identity
+        , method = "GET"
+        , path = [ "_matrix", "client", "v3", "sync" ]
+        , toUpdate =
+            Debug.log "Handling output v3" >> V3.updateSyncResponse { filter = Filter.pass, since = data.since } >> Debug.log "Received"
+        }
+
+
+syncV4 : SyncInputV1 i -> A.TaskChain (PhantomV1 a) (PhantomV1 a)
+syncV4 data =
+    A.request
+        { attributes =
+            [ R.accessToken
+            , R.queryOpString "filter" Nothing
+            , R.queryOpBool "full_state" data.fullState
+            , data.presence
+                |> presenceFromOptions [ "offline", "online", "unavailable" ]
+                |> R.queryOpString "set_presence"
+            , R.queryOpString "since" data.since
+            , R.queryOpInt "timeout" data.timeout
+            ]
+        , coder = V4.coderSyncResponse
+        , contextChange = always identity
+        , method = "GET"
+        , path = [ "_matrix", "client", "v3", "sync" ]
+        , toUpdate =
+            Debug.log "Handling output v4" >> V4.updateSyncResponse { filter = Filter.pass, since = data.since } >> Debug.log "Received"
+        }

src/Internal/Api/Sync/V2.elm

@@ -0,0 +1,797 @@
+module Internal.Api.Sync.V2 exposing (..)
+
+{-|
+
+
+# Sync response
+
+This API module represents the /sync endpoint on Matrix spec version v1.2 and
+v1.3.
+
+<https://spec.matrix.org/v1.2/client-server-api/#syncing>
+<https://spec.matrix.org/v1.3/client-server-api/#syncing>
+
+-}
+
+import FastDict as Dict exposing (Dict)
+import Internal.Api.Sync.V1 as PV
+import Internal.Config.Log exposing (Log, log)
+import Internal.Config.Text as Text
+import Internal.Filter.Timeline exposing (Filter)
+import Internal.Tools.Json as Json
+import Internal.Tools.Timestamp as Timestamp exposing (Timestamp)
+import Internal.Values.Envelope as E
+import Internal.Values.Event as Event
+import Internal.Values.Room as R
+import Internal.Values.User as User exposing (User)
+import Internal.Values.Vault as V
+import Recursion
+
+
+type alias SyncResponse =
+    { accountData : Maybe AccountData
+    , deviceLists : Maybe DeviceLists
+    , deviceOneTimeKeysCount : Maybe (Dict String Int)
+    , deviceUnusedFallbackKeyTypes : List String
+    , nextBatch : String
+    , presence : Maybe Presence
+    , rooms : Maybe Rooms
+    , toDevice : Maybe ToDevice
+    }
+
+
+type alias AccountData =
+    { events : Maybe (List Event) }
+
+
+type alias Event =
+    { content : Json.Value
+    , eventType : String
+    }
+
+
+type alias Presence =
+    { events : Maybe (List Event) }
+
+
+type alias Rooms =
+    { invite : Maybe (Dict String InvitedRoom)
+    , join : Maybe (Dict String JoinedRoom)
+    , knock : Maybe (Dict String KnockedRoom)
+    , leave : Maybe (Dict String LeftRoom)
+    }
+
+
+type alias InvitedRoom =
+    { inviteState : Maybe InviteState }
+
+
+type alias InviteState =
+    { events : Maybe (List StrippedStateEvent) }
+
+
+type alias StrippedStateEvent =
+    { content : Json.Value
+    , sender : User
+    , stateKey : String
+    , eventType : String
+    }
+
+
+type alias JoinedRoom =
+    { accountData : Maybe AccountData
+    , ephemeral : Maybe Ephemeral
+    , state : Maybe State
+    , summary : Maybe RoomSummary
+    , timeline : Maybe Timeline
+    , unreadNotifications : Maybe UnreadNotificationCounts
+    }
+
+
+type alias Ephemeral =
+    { events : Maybe (List Event) }
+
+
+type alias State =
+    { events : Maybe (List ClientEventWithoutRoomID) }
+
+
+type alias ClientEventWithoutRoomID =
+    { content : Json.Value
+    , eventId : String
+    , originServerTs : Timestamp
+    , sender : User
+    , stateKey : Maybe String
+    , eventType : String
+    , unsigned : Maybe UnsignedData
+    }
+
+
+type UnsignedData
+    = UnsignedData
+        { age : Maybe Int
+        , prevContent : Maybe Json.Value
+        , redactedBecause : Maybe ClientEventWithoutRoomID
+        , transactionId : Maybe String
+        }
+
+
+type alias RoomSummary =
+    { mHeroes : Maybe (List String)
+    , mInvitedMemberCount : Maybe Int
+    , mJoinedMemberCount : Maybe Int
+    }
+
+
+type alias Timeline =
+    { events : List ClientEventWithoutRoomID
+    , limited : Maybe Bool
+    , prevBatch : Maybe String
+    }
+
+
+type alias UnreadNotificationCounts =
+    { highlightCount : Maybe Int
+    , notificationCount : Maybe Int
+    }
+
+
+type alias KnockedRoom =
+    { knockState : Maybe KnockState }
+
+
+type alias KnockState =
+    { events : Maybe (List StrippedStateEvent) }
+
+
+type alias LeftRoom =
+    { accountData : Maybe AccountData
+    , state : Maybe State
+    , timeline : Maybe Timeline
+    }
+
+
+type alias DeviceLists =
+    { changed : Maybe (List String)
+    , left : Maybe (List String)
+    }
+
+
+type alias ToDevice =
+    { events : Maybe (List ToDeviceEvent) }
+
+
+type alias ToDeviceEvent =
+    { content : Maybe Json.Value
+    , sender : Maybe User
+    , eventType : Maybe String
+    }
+
+
+coderSyncResponse : Json.Coder SyncResponse
+coderSyncResponse =
+    Json.object8
+        { name = "SyncResponse"
+        , description = [ "An event that is part of a response." ]
+        , init = SyncResponse
+        }
+        (Json.field.optional.value
+            { fieldName = "account_data"
+            , toField = .accountData
+            , description = [ "The global private data created by this user." ]
+            , coder = coderAccountData
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "device_lists"
+            , toField = .deviceLists
+            , description = [ "Information on end-to-end device updates, as specified in End-to-end encryption." ]
+            , coder = coderDeviceLists
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "device_one_time_keys_count"
+            , toField = .deviceOneTimeKeysCount
+            , description = [ "Information on end-to-end encryption keys, as specified in End-to-end encryption." ]
+            , coder = Json.fastDict Json.int
+            }
+        )
+        (Json.field.required
+            { fieldName = "device_unused_fallback_key_types"
+            , toField = .deviceUnusedFallbackKeyTypes
+            , description = [ "The unused fallback key algorithms." ]
+            , coder = Json.list Json.string
+            }
+        )
+        (Json.field.required
+            { fieldName = "next_batch"
+            , toField = .nextBatch
+            , description = [ "Required: The batch token to supply in the since param of the next /sync request." ]
+            , coder = Json.string
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "presence"
+            , toField = .presence
+            , description = [ "The updates to the presence status of other users." ]
+            , coder = coderPresence
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "rooms"
+            , toField = .rooms
+            , description = [ "Updates to rooms." ]
+            , coder = coderRooms
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "to_device"
+            , toField = .toDevice
+            , description = [ "Information on the send-to-device messages for the client device, as defined in Send-to-Device messaging." ]
+            , coder = coderToDevice
+            }
+        )
+
+
+coderAccountData : Json.Coder AccountData
+coderAccountData =
+    PV.coderAccountData
+
+
+coderEvent : Json.Coder Event
+coderEvent =
+    PV.coderEvent
+
+
+coderPresence : Json.Coder Presence
+coderPresence =
+    PV.coderPresence
+
+
+coderRooms : Json.Coder Rooms
+coderRooms =
+    Json.object4
+        { name = "Rooms"
+        , description = [ "Updates to rooms." ]
+        , init = Rooms
+        }
+        (Json.field.optional.value
+            { fieldName = "invite"
+            , toField = .invite
+            , description = [ "The rooms that the user has been invited to, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderInvitedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "join"
+            , toField = .join
+            , description = [ "The rooms that the user has joined, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderJoinedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "knock"
+            , toField = .knock
+            , description = [ "The rooms that the user has knocked upon, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderKnockedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "leave"
+            , toField = .leave
+            , description = [ "The rooms that the user has left or been banned from, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderLeftRoom
+            }
+        )
+
+
+coderInvitedRoom : Json.Coder InvitedRoom
+coderInvitedRoom =
+    PV.coderInvitedRoom
+
+
+coderInviteState : Json.Coder InviteState
+coderInviteState =
+    PV.coderInviteState
+
+
+coderStrippedStateEvent : Json.Coder StrippedStateEvent
+coderStrippedStateEvent =
+    PV.coderStrippedState
+
+
+coderJoinedRoom : Json.Coder JoinedRoom
+coderJoinedRoom =
+    Json.object6
+        { name = "JoinedRoom"
+        , description = [ "The rooms that the user has joined." ]
+        , init = JoinedRoom
+        }
+        (Json.field.optional.value
+            { fieldName = "account_data"
+            , toField = .accountData
+            , description = [ "The private data that this user has attached to this room." ]
+            , coder = coderAccountData
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "ephemeral"
+            , toField = .ephemeral
+            , description = [ "The ephemeral events in the room that aren’t recorded in the timeline or state of the room. e.g. typing." ]
+            , coder = coderEphemeral
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "state"
+            , toField = .state
+            , description = [ "Updates to the state, between the time indicated by the since parameter, and the start of the timeline (or all state up to the start of the timeline, if since is not given, or full_state is true).", "N.B. state updates for m.room.member events will be incomplete if lazy_load_members is enabled in the /sync filter, and only return the member events required to display the senders of the timeline events in this response." ]
+            , coder = coderState
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "summary"
+            , toField = .summary
+            , description = [ "Information about the room which clients may need to correctly render it to users." ]
+            , coder = coderRoomSummary
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "timeline"
+            , toField = .timeline
+            , description = [ "The timeline of messages and state changes in the room." ]
+            , coder = coderTimeline
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "unread_notifications"
+            , toField = .unreadNotifications
+            , description = [ "Counts of unread notifications for this room. See the Receiving notifications section for more information on how these are calculated." ]
+            , coder = coderUnreadNotificationCounts
+            }
+        )
+
+
+coderEphemeral : Json.Coder Ephemeral
+coderEphemeral =
+    PV.coderEphemeral
+
+
+coderState : Json.Coder State
+coderState =
+    Json.object1
+        { name = "State"
+        , description = [ "Updates to the state." ]
+        , init = State
+        }
+        (Json.field.optional.value
+            { fieldName = "events"
+            , toField = .events
+            , description = [ "List of events." ]
+            , coder = Json.list coderClientEventWithoutRoomID
+            }
+        )
+
+
+coderClientEventWithoutRoomID : Json.Coder ClientEventWithoutRoomID
+coderClientEventWithoutRoomID =
+    Json.object7
+        { name = "ClientEventWithoutRoomID"
+        , description = [ "An event without a room ID." ]
+        , init = ClientEventWithoutRoomID
+        }
+        (Json.field.required
+            { fieldName = "content"
+            , toField = .content
+            , description = [ "Required: The body of this event, as created by the client which sent it." ]
+            , coder = Json.value
+            }
+        )
+        (Json.field.required
+            { fieldName = "event_id"
+            , toField = .eventId
+            , description = [ "Required: The globally unique identifier for this event." ]
+            , coder = Json.string
+            }
+        )
+        (Json.field.required
+            { fieldName = "origin_server_ts"
+            , toField = .originServerTs
+            , description = [ "Required: Timestamp (in milliseconds since the unix epoch) on originating homeserver when this event was sent." ]
+            , coder = Timestamp.coder
+            }
+        )
+        (Json.field.required
+            { fieldName = "sender"
+            , toField = .sender
+            , description = [ "Required: Contains the fully-qualified ID of the user who sent this event." ]
+            , coder = User.coder
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "state_key"
+            , toField = .stateKey
+            , description = [ "Present if, and only if, this event is a state event. The key making this piece of state unique in the room. Note that it is often an empty string." ]
+            , coder = Json.string
+            }
+        )
+        (Json.field.required
+            { fieldName = "type"
+            , toField = .eventType
+            , description = [ "Required: The type of the event." ]
+            , coder = Json.string
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "unsigned"
+            , toField = .unsigned
+            , description = [ "Contains optional extra information about the event." ]
+            , coder = coderUnsignedData
+            }
+        )
+
+
+coderUnsignedData : Json.Coder UnsignedData
+coderUnsignedData =
+    Json.object4
+        { name = "UnsignedData"
+        , description = [ "Contains optional extra information about the event." ]
+        , init =
+            \a b c d ->
+                UnsignedData
+                    { age = a
+                    , prevContent = b
+                    , redactedBecause = c
+                    , transactionId = d
+                    }
+        }
+        (Json.field.optional.value
+            { fieldName = "age"
+            , toField = \(UnsignedData u) -> u.age
+            , description = [ "The time in milliseconds that has elapsed since the event was sent. This field is generated by the local homeserver, and may be incorrect if the local time on at least one of the two servers is out of sync, which can cause the age to either be negative or greater than it actually is." ]
+            , coder = Json.int
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "prev_content"
+            , toField = \(UnsignedData u) -> u.prevContent
+            , description = [ "The previous content for this event. This field is generated by the local homeserver, and is only returned if the event is a state event, and the client has permission to see the previous content.", "Changed in v1.2: Previously, this field was specified at the top level of returned events rather than in unsigned (with the exception of the GET .../notifications endpoint), though in practice no known server implementations honoured this." ]
+            , coder = Json.value
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "redacted_because"
+            , toField = \(UnsignedData u) -> u.redactedBecause
+            , description = [ "The event that redacted this event, if any." ]
+            , coder = Json.lazy (\_ -> coderClientEventWithoutRoomID)
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "transaction_id"
+            , toField = \(UnsignedData u) -> u.transactionId
+            , description = [ "The client-supplied transaction ID, for example, provided via PUT /_matrix/client/v3/rooms/{roomId}/send/{eventType}/{txnId}, if the client being given the event is the same one which sent it." ]
+            , coder = Json.string
+            }
+        )
+
+
+coderRoomSummary : Json.Coder RoomSummary
+coderRoomSummary =
+    PV.coderRoomSummary
+
+
+coderTimeline : Json.Coder Timeline
+coderTimeline =
+    Json.object3
+        { name = "Timeline"
+        , description = [ "The timeline of messages and state changes in the room." ]
+        , init = Timeline
+        }
+        (Json.field.required
+            { fieldName = "events"
+            , toField = .events
+            , description = [ "Required: List of events." ]
+            , coder = Json.list coderClientEventWithoutRoomID
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "limited"
+            , toField = .limited
+            , description = [ "True if the number of events returned was limited by the limit on the filter." ]
+            , coder = Json.bool
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "prev_batch"
+            , toField = .prevBatch
+            , description = [ "A token that can be supplied to the from parameter of the /rooms/<room_id>/messages endpoint in order to retrieve earlier events. If no earlier events are available, this property may be omitted from the response." ]
+            , coder = Json.string
+            }
+        )
+
+
+coderUnreadNotificationCounts : Json.Coder UnreadNotificationCounts
+coderUnreadNotificationCounts =
+    PV.coderUnreadNotificationCounts
+
+
+coderKnockedRoom : Json.Coder KnockedRoom
+coderKnockedRoom =
+    PV.coderKnockedRoom
+
+
+coderKnockState : Json.Coder KnockState
+coderKnockState =
+    PV.coderKnockState
+
+
+coderLeftRoom : Json.Coder LeftRoom
+coderLeftRoom =
+    Json.object3
+        { name = "LeftRoom"
+        , description = [ "The rooms that the user has left or been banned from." ]
+        , init = LeftRoom
+        }
+        (Json.field.optional.value
+            { fieldName = "account_data"
+            , toField = .accountData
+            , description = [ "The private data that this user has attached to this room." ]
+            , coder = coderAccountData
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "state"
+            , toField = .state
+            , description = [ "The state updates for the room up to the start of the timeline." ]
+            , coder = coderState
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "timeline"
+            , toField = .timeline
+            , description = [ "The timeline of messages and state changes in the room up to the point when the user left." ]
+            , coder = coderTimeline
+            }
+        )
+
+
+coderDeviceLists : Json.Coder DeviceLists
+coderDeviceLists =
+    PV.coderDeviceLists
+
+
+coderToDevice : Json.Coder ToDevice
+coderToDevice =
+    PV.coderToDevice
+
+
+coderToDeviceEvent : Json.Coder ToDeviceEvent
+coderToDeviceEvent =
+    PV.coderToDeviceEvent
+
+
+updateSyncResponse : { filter : Filter, since : Maybe String } -> SyncResponse -> ( E.EnvelopeUpdate V.VaultUpdate, List Log )
+updateSyncResponse { filter, since } response =
+    -- Account data
+    [ response.accountData
+        |> Maybe.andThen .events
+        |> Maybe.map (List.map (\e -> V.SetAccountData e.eventType e.content))
+        |> Maybe.map
+            (\x ->
+                ( E.ContentUpdate <| V.More x
+                , if List.length x > 0 then
+                    List.length x
+                        |> Text.logs.syncAccountDataFound
+                        |> log.debug
+                        |> List.singleton
+
+                  else
+                    []
+                )
+            )
+
+    -- TODO: Add device lists
+    -- Next batch
+    , Just ( E.SetNextBatch response.nextBatch, [] )
+
+    -- TODO: Add presence
+    -- Rooms
+    , Maybe.map
+        (updateRooms { filter = filter, nextBatch = response.nextBatch, since = since }
+            >> Tuple.mapFirst E.ContentUpdate
+        )
+        response.rooms
+
+    -- TODO: Add to_device
+    ]
+        |> List.filterMap identity
+        |> List.unzip
+        |> Tuple.mapFirst E.More
+        |> Tuple.mapSecond List.concat
+
+
+updateRooms : { filter : Filter, nextBatch : String, since : Maybe String } -> Rooms -> ( V.VaultUpdate, List Log )
+updateRooms { filter, nextBatch, since } rooms =
+    let
+        ( roomUpdate, roomLogs ) =
+            rooms.join
+                |> Maybe.withDefault Dict.empty
+                |> Dict.toList
+                |> List.map
+                    (\( roomId, room ) ->
+                        let
+                            ( u, l ) =
+                                updateJoinedRoom
+                                    { filter = filter
+                                    , nextBatch = nextBatch
+                                    , roomId = roomId
+                                    , since = since
+                                    }
+                                    room
+                        in
+                        ( V.MapRoom roomId u, l )
+                    )
+                |> List.unzip
+                |> Tuple.mapBoth V.More List.concat
+    in
+    ( V.More
+        -- Add rooms
+        [ rooms.join
+            |> Maybe.withDefault Dict.empty
+            |> Dict.keys
+            |> List.map V.CreateRoomIfNotExists
+            |> V.More
+
+        -- Update rooms
+        , roomUpdate
+
+        -- TODO: Add invited rooms
+        -- TODO: Add knocked rooms
+        -- TODO: Add left rooms
+        ]
+    , roomLogs
+    )
+
+
+updateJoinedRoom : { filter : Filter, nextBatch : String, roomId : String, since : Maybe String } -> JoinedRoom -> ( R.RoomUpdate, List Log )
+updateJoinedRoom data room =
+    ( R.More
+        [ room.accountData
+            |> Maybe.andThen .events
+            |> Maybe.map
+                (\events ->
+                    events
+                        |> List.map (\e -> R.SetAccountData e.eventType e.content)
+                        |> R.More
+                )
+            |> R.Optional
+        , room.ephemeral
+            |> Maybe.andThen .events
+            |> Maybe.map R.SetEphemeral
+            |> R.Optional
+
+        -- TODO: Add state
+        -- TODO: Add RoomSummary
+        , room.timeline
+            |> Maybe.map (updateTimeline data)
+            |> R.Optional
+
+        -- TODO: Add unread notifications
+        ]
+    , []
+    )
+
+
+updateTimeline : { filter : Filter, nextBatch : String, roomId : String, since : Maybe String } -> Timeline -> R.RoomUpdate
+updateTimeline { filter, nextBatch, roomId, since } timeline =
+    let
+        limited : Bool
+        limited =
+            Maybe.withDefault False timeline.limited
+
+        newEvents : List Event.Event
+        newEvents =
+            List.map (toEvent roomId) timeline.events
+    in
+    case ( limited, timeline.prevBatch ) of
+        ( False, Just p ) ->
+            if timeline.prevBatch == since then
+                R.AddSync
+                    { events = newEvents
+                    , filter = filter
+                    , start = Just p
+                    , end = nextBatch
+                    }
+
+            else
+                R.More
+                    [ R.AddSync
+                        { events = []
+                        , filter = filter
+                        , start = since
+                        , end = p
+                        }
+                    , R.AddSync
+                        { events = newEvents
+                        , filter = filter
+                        , start = Just p
+                        , end = nextBatch
+                        }
+                    ]
+
+        ( False, Nothing ) ->
+            R.AddSync
+                { events = newEvents
+                , filter = filter
+                , start = since
+                , end = nextBatch
+                }
+
+        ( True, _ ) ->
+            R.AddSync
+                { events = newEvents
+                , filter = filter
+                , start = timeline.prevBatch
+                , end = nextBatch
+                }
+
+
+toEvent : String -> ClientEventWithoutRoomID -> Event.Event
+toEvent roomId event =
+    Recursion.runRecursion
+        (\ev ->
+            case Maybe.andThen (\(UnsignedData u) -> u.redactedBecause) ev.unsigned of
+                Just e ->
+                    Recursion.recurseThen e
+                        (\eo ->
+                            Recursion.base
+                                { content = ev.content
+                                , eventId = ev.eventId
+                                , originServerTs = ev.originServerTs
+                                , roomId = roomId
+                                , sender = ev.sender
+                                , stateKey = ev.stateKey
+                                , eventType = ev.eventType
+                                , unsigned = toUnsigned (Just eo) ev.unsigned
+                                }
+                        )
+
+                Nothing ->
+                    Recursion.base
+                        { content = ev.content
+                        , eventId = ev.eventId
+                        , originServerTs = ev.originServerTs
+                        , roomId = roomId
+                        , sender = ev.sender
+                        , stateKey = ev.stateKey
+                        , eventType = ev.eventType
+                        , unsigned = toUnsigned Nothing ev.unsigned
+                        }
+        )
+        event
+
+
+toUnsigned : Maybe Event.Event -> Maybe UnsignedData -> Maybe Event.UnsignedData
+toUnsigned ev unsigned =
+    case ( ev, unsigned ) of
+        ( Nothing, Nothing ) ->
+            Nothing
+
+        ( Just e, Nothing ) ->
+            { age = Nothing
+            , membership = Nothing
+            , prevContent = Nothing
+            , redactedBecause = Just e
+            , transactionId = Nothing
+            }
+                |> Event.UnsignedData
+                |> Just
+
+        ( _, Just (UnsignedData u) ) ->
+            { age = u.age
+            , membership = Nothing
+            , prevContent = u.prevContent
+            , redactedBecause = ev
+            , transactionId = u.transactionId
+            }
+                |> Event.UnsignedData
+                |> Just

src/Internal/Api/Sync/V3.elm

@@ -0,0 +1,580 @@
+module Internal.Api.Sync.V3 exposing (..)
+
+{-|
+
+
+# Sync response
+
+This API module represents the /sync endpoint on the following Matrix spec
+versions:
+
+<https://spec.matrix.org/v1.4/client-server-api/#syncing>
+<https://spec.matrix.org/v1.5/client-server-api/#syncing>
+<https://spec.matrix.org/v1.6/client-server-api/#syncing>
+<https://spec.matrix.org/v1.7/client-server-api/#syncing>
+<https://spec.matrix.org/v1.8/client-server-api/#syncing>
+<https://spec.matrix.org/v1.9/client-server-api/#syncing>
+<https://spec.matrix.org/v1.10/client-server-api/#syncing>
+
+-}
+
+import FastDict as Dict exposing (Dict)
+import Internal.Api.Sync.V2 as PV
+import Internal.Config.Log exposing (Log, log)
+import Internal.Config.Text as Text
+import Internal.Filter.Timeline exposing (Filter)
+import Internal.Tools.Json as Json
+import Internal.Tools.Timestamp exposing (Timestamp)
+import Internal.Values.Envelope as E
+import Internal.Values.Event as Event
+import Internal.Values.Room as R
+import Internal.Values.User exposing (User)
+import Internal.Values.Vault as V
+
+
+type alias SyncResponse =
+    { accountData : Maybe AccountData
+    , deviceLists : Maybe DeviceLists
+    , deviceOneTimeKeysCount : Maybe (Dict String Int)
+    , deviceUnusedFallbackKeyTypes : List String
+    , nextBatch : String
+    , presence : Maybe Presence
+    , rooms : Maybe Rooms
+    , toDevice : Maybe ToDevice
+    }
+
+
+type alias AccountData =
+    { events : Maybe (List Event) }
+
+
+type alias Event =
+    { content : Json.Value
+    , eventType : String
+    }
+
+
+type alias Presence =
+    { events : Maybe (List Event) }
+
+
+type alias Rooms =
+    { invite : Maybe (Dict String InvitedRoom)
+    , join : Maybe (Dict String JoinedRoom)
+    , knock : Maybe (Dict String KnockedRoom)
+    , leave : Maybe (Dict String LeftRoom)
+    }
+
+
+type alias InvitedRoom =
+    { inviteState : Maybe InviteState }
+
+
+type alias InviteState =
+    { events : Maybe (List StrippedStateEvent) }
+
+
+type alias StrippedStateEvent =
+    { content : Json.Value
+    , sender : User
+    , stateKey : String
+    , eventType : String
+    }
+
+
+type alias JoinedRoom =
+    { accountData : Maybe AccountData
+    , ephemeral : Maybe Ephemeral
+    , state : Maybe State
+    , summary : Maybe RoomSummary
+    , timeline : Maybe Timeline
+    , unreadNotifications : Maybe UnreadNotificationCounts
+    , unreadThreadNotifications : Maybe (Dict String ThreadNotificationCounts)
+    }
+
+
+type alias Ephemeral =
+    { events : Maybe (List Event) }
+
+
+type alias State =
+    { events : Maybe (List ClientEventWithoutRoomID) }
+
+
+type alias ClientEventWithoutRoomID =
+    { content : Json.Value
+    , eventId : String
+    , originServerTs : Timestamp
+    , sender : User
+    , stateKey : Maybe String
+    , eventType : String
+    , unsigned : Maybe UnsignedData
+    }
+
+
+type alias UnsignedData =
+    PV.UnsignedData
+
+
+type alias RoomSummary =
+    { mHeroes : Maybe (List String)
+    , mInvitedMemberCount : Maybe Int
+    , mJoinedMemberCount : Maybe Int
+    }
+
+
+type alias Timeline =
+    { events : List ClientEventWithoutRoomID
+    , limited : Maybe Bool
+    , prevBatch : Maybe String
+    }
+
+
+type alias UnreadNotificationCounts =
+    { highlightCount : Maybe Int
+    , notificationCount : Maybe Int
+    }
+
+
+type alias ThreadNotificationCounts =
+    { highlightCount : Maybe Int
+    , notificationCount : Maybe Int
+    }
+
+
+type alias KnockedRoom =
+    { knockState : Maybe KnockState }
+
+
+type alias KnockState =
+    { events : Maybe (List StrippedStateEvent) }
+
+
+type alias LeftRoom =
+    { accountData : Maybe AccountData
+    , state : Maybe State
+    , timeline : Maybe Timeline
+    }
+
+
+type alias DeviceLists =
+    { changed : Maybe (List String)
+    , left : Maybe (List String)
+    }
+
+
+type alias ToDevice =
+    { events : Maybe (List ToDeviceEvent) }
+
+
+type alias ToDeviceEvent =
+    { content : Maybe Json.Value
+    , sender : Maybe User
+    , eventType : Maybe String
+    }
+
+
+coderSyncResponse : Json.Coder SyncResponse
+coderSyncResponse =
+    Json.object8
+        { name = "SyncResponse"
+        , description = [ "The response for a sync request." ]
+        , init = SyncResponse
+        }
+        (Json.field.optional.value
+            { fieldName = "account_data"
+            , toField = .accountData
+            , description = [ "The global private data created by this user." ]
+            , coder = coderAccountData
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "device_lists"
+            , toField = .deviceLists
+            , description = [ "Information on end-to-end device updates, as specified in End-to-end encryption." ]
+            , coder = coderDeviceLists
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "device_one_time_keys_count"
+            , toField = .deviceOneTimeKeysCount
+            , description = [ "Information on end-to-end encryption keys, as specified in End-to-end encryption." ]
+            , coder = Json.fastDict Json.int
+            }
+        )
+        (Json.field.required
+            { fieldName = "device_unused_fallback_key_types"
+            , toField = .deviceUnusedFallbackKeyTypes
+            , description = [ "The unused fallback key algorithms." ]
+            , coder = Json.list Json.string
+            }
+        )
+        (Json.field.required
+            { fieldName = "next_batch"
+            , toField = .nextBatch
+            , description = [ "The batch token to supply in the since param of the next /sync request." ]
+            , coder = Json.string
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "presence"
+            , toField = .presence
+            , description = [ "The updates to the presence status of other users." ]
+            , coder = coderPresence
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "rooms"
+            , toField = .rooms
+            , description = [ "Updates to rooms." ]
+            , coder = coderRooms
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "to_device"
+            , toField = .toDevice
+            , description = [ "Information on the send-to-device messages for the client device, as defined in Send-to-Device messaging." ]
+            , coder = coderToDevice
+            }
+        )
+
+
+coderAccountData : Json.Coder AccountData
+coderAccountData =
+    PV.coderAccountData
+
+
+coderEvent : Json.Coder Event
+coderEvent =
+    PV.coderEvent
+
+
+coderPresence : Json.Coder Presence
+coderPresence =
+    PV.coderPresence
+
+
+coderRooms : Json.Coder Rooms
+coderRooms =
+    Json.object4
+        { name = "Rooms"
+        , description = [ "Updates to rooms." ]
+        , init = Rooms
+        }
+        (Json.field.optional.value
+            { fieldName = "invite"
+            , toField = .invite
+            , description = [ "The rooms that the user has been invited to, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderInvitedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "join"
+            , toField = .join
+            , description = [ "The rooms that the user has joined, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderJoinedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "knock"
+            , toField = .knock
+            , description = [ "The rooms that the user has knocked upon, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderKnockedRoom
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "leave"
+            , toField = .leave
+            , description = [ "The rooms that the user has left or been banned from, mapped as room ID to room information." ]
+            , coder = Json.fastDict coderLeftRoom
+            }
+        )
+
+
+coderInvitedRoom : Json.Coder InvitedRoom
+coderInvitedRoom =
+    PV.coderInvitedRoom
+
+
+coderInviteState : Json.Coder InviteState
+coderInviteState =
+    PV.coderInviteState
+
+
+coderStrippedStateEvent : Json.Coder StrippedStateEvent
+coderStrippedStateEvent =
+    PV.coderStrippedStateEvent
+
+
+coderJoinedRoom : Json.Coder JoinedRoom
+coderJoinedRoom =
+    Json.object7
+        { name = "JoinedRoom"
+        , description = [ "Information about a room the user has joined." ]
+        , init = JoinedRoom
+        }
+        (Json.field.optional.value
+            { fieldName = "account_data"
+            , toField = .accountData
+            , description = [ "The private data that this user has attached to this room." ]
+            , coder = coderAccountData
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "ephemeral"
+            , toField = .ephemeral
+            , description = [ "The ephemeral events in the room that aren’t recorded in the timeline or state of the room. e.g. typing." ]
+            , coder = coderEphemeral
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "state"
+            , toField = .state
+            , description = [ "Updates to the state, between the time indicated by the since parameter, and the start of the timeline (or all state up to the start of the timeline, if since is not given, or full_state is true).", "N.B. state updates for m.room.member events will be incomplete if lazy_load_members is enabled in the /sync filter, and only return the member events required to display the senders of the timeline events in this response." ]
+            , coder = coderState
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "summary"
+            , toField = .summary
+            , description = [ "Information about the room which clients may need to correctly render it to users." ]
+            , coder = coderRoomSummary
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "timeline"
+            , toField = .timeline
+            , description = [ "The timeline of messages and state changes in the room." ]
+            , coder = coderTimeline
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "unread_notifications"
+            , toField = .unreadNotifications
+            , description = [ "Counts of unread notifications for this room. See the Receiving notifications section for more information on how these are calculated.", "If unread_thread_notifications was specified as true on the RoomEventFilter, these counts will only be for the main timeline rather than all events in the room. See the threading module for more information.", "Changed in v1.4: Updated to reflect behaviour of having unread_thread_notifications as true in the RoomEventFilter for /sync." ]
+            , coder = coderUnreadNotificationCounts
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "unread_thread_notifications"
+            , toField = .unreadThreadNotifications
+            , description = [ "If unread_thread_notifications was specified as true on the RoomEventFilter, the notification counts for each thread in this room. The object is keyed by thread root ID, with values matching unread_notifications.", "If a thread does not have any notifications it can be omitted from this object. If no threads have notification counts, this whole object can be omitted.", "Added in v1.4" ]
+            , coder = Json.fastDict coderThreadNotificationCounts
+            }
+        )
+
+
+coderEphemeral : Json.Coder Ephemeral
+coderEphemeral =
+    PV.coderEphemeral
+
+
+coderState : Json.Coder State
+coderState =
+    PV.coderState
+
+
+coderClientEventWithoutRoomID : Json.Coder ClientEventWithoutRoomID
+coderClientEventWithoutRoomID =
+    PV.coderClientEventWithoutRoomID
+
+
+coderUnsignedData : Json.Coder UnsignedData
+coderUnsignedData =
+    PV.coderUnsignedData
+
+
+coderRoomSummary : Json.Coder RoomSummary
+coderRoomSummary =
+    PV.coderRoomSummary
+
+
+coderTimeline : Json.Coder Timeline
+coderTimeline =
+    PV.coderTimeline
+
+
+coderUnreadNotificationCounts : Json.Coder UnreadNotificationCounts
+coderUnreadNotificationCounts =
+    PV.coderUnreadNotificationCounts
+
+
+coderThreadNotificationCounts : Json.Coder ThreadNotificationCounts
+coderThreadNotificationCounts =
+    Json.object2
+        { name = "ThreadNotificationCounts"
+        , description = [ "The notification counts for each thread in this room." ]
+        , init = ThreadNotificationCounts
+        }
+        (Json.field.optional.value
+            { fieldName = "highlight_count"
+            , toField = .highlightCount
+            , description = [ "The number of unread notifications for this thread with the highlight flag set." ]
+            , coder = Json.int
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "notification_count"
+            , toField = .notificationCount
+            , description = [ "The total number of unread notifications for this thread." ]
+            , coder = Json.int
+            }
+        )
+
+
+coderKnockedRoom : Json.Coder KnockedRoom
+coderKnockedRoom =
+    PV.coderKnockedRoom
+
+
+coderKnockState : Json.Coder KnockState
+coderKnockState =
+    PV.coderKnockState
+
+
+coderLeftRoom : Json.Coder LeftRoom
+coderLeftRoom =
+    PV.coderLeftRoom
+
+
+coderDeviceLists : Json.Coder DeviceLists
+coderDeviceLists =
+    PV.coderDeviceLists
+
+
+coderToDevice : Json.Coder ToDevice
+coderToDevice =
+    PV.coderToDevice
+
+
+coderToDeviceEvent : Json.Coder ToDeviceEvent
+coderToDeviceEvent =
+    PV.coderToDeviceEvent
+
+
+updateSyncResponse : { filter : Filter, since : Maybe String } -> SyncResponse -> ( E.EnvelopeUpdate V.VaultUpdate, List Log )
+updateSyncResponse { filter, since } response =
+    -- Account data
+    [ response.accountData
+        |> Maybe.andThen .events
+        |> Maybe.map (List.map (\e -> V.SetAccountData e.eventType e.content))
+        |> Maybe.map
+            (\x ->
+                ( E.ContentUpdate <| V.More x
+                , if List.length x > 0 then
+                    List.length x
+                        |> Text.logs.syncAccountDataFound
+                        |> log.debug
+                        |> List.singleton
+
+                  else
+                    []
+                )
+            )
+
+    -- TODO: Add device lists
+    -- Next batch
+    , Just ( E.SetNextBatch response.nextBatch, [] )
+
+    -- TODO: Add presence
+    -- Rooms
+    , Maybe.map
+        (updateRooms { filter = filter, nextBatch = response.nextBatch, since = since }
+            >> Tuple.mapFirst E.ContentUpdate
+        )
+        response.rooms
+
+    -- TODO: Add to_device
+    ]
+        |> List.filterMap identity
+        |> List.unzip
+        |> Tuple.mapFirst E.More
+        |> Tuple.mapSecond List.concat
+
+
+updateRooms : { filter : Filter, nextBatch : String, since : Maybe String } -> Rooms -> ( V.VaultUpdate, List Log )
+updateRooms { filter, nextBatch, since } rooms =
+    let
+        ( roomUpdate, roomLogs ) =
+            rooms.join
+                |> Maybe.withDefault Dict.empty
+                |> Dict.toList
+                |> List.map
+                    (\( roomId, room ) ->
+                        let
+                            ( u, l ) =
+                                updateJoinedRoom
+                                    { filter = filter
+                                    , nextBatch = nextBatch
+                                    , roomId = roomId
+                                    , since = since
+                                    }
+                                    room
+                        in
+                        ( V.MapRoom roomId u, l )
+                    )
+                |> List.unzip
+                |> Tuple.mapBoth V.More List.concat
+    in
+    ( V.More
+        -- Add rooms
+        [ rooms.join
+            |> Maybe.withDefault Dict.empty
+            |> Dict.keys
+            |> List.map V.CreateRoomIfNotExists
+            |> V.More
+
+        -- Update rooms
+        , roomUpdate
+
+        -- TODO: Add invited rooms
+        -- TODO: Add knocked rooms
+        -- TODO: Add left rooms
+        ]
+    , roomLogs
+    )
+
+
+updateJoinedRoom : { filter : Filter, nextBatch : String, roomId : String, since : Maybe String } -> JoinedRoom -> ( R.RoomUpdate, List Log )
+updateJoinedRoom data room =
+    ( R.More
+        [ room.accountData
+            |> Maybe.andThen .events
+            |> Maybe.map
+                (\events ->
+                    events
+                        |> List.map (\e -> R.SetAccountData e.eventType e.content)
+                        |> R.More
+                )
+            |> R.Optional
+        , room.ephemeral
+            |> Maybe.andThen .events
+            |> Maybe.map R.SetEphemeral
+            |> R.Optional
+
+        -- TODO: Add state
+        -- TODO: Add RoomSummary
+        , room.timeline
+            |> Maybe.map (updateTimeline data)
+            |> R.Optional
+
+        -- TODO: Add unread notifications
+        -- TODO: Add unread thread notifications
+        ]
+    , []
+    )
+
+
+updateTimeline : { filter : Filter, nextBatch : String, roomId : String, since : Maybe String } -> Timeline -> R.RoomUpdate
+updateTimeline =
+    PV.updateTimeline
+
+
+toEvent : String -> ClientEventWithoutRoomID -> Event.Event
+toEvent =
+    PV.toEvent
+
+
+toUnsigned : Maybe Event.Event -> Maybe UnsignedData -> Maybe Event.UnsignedData
+toUnsigned =
+    PV.toUnsigned

src/Internal/Api/Task.elm

@@ -1,6 +1,6 @@
 module Internal.Api.Task exposing
     ( Task, run, Backpack
-    , sendMessageEvent
+    , sendMessageEvent, sync
     )
 
 {-|
@@ -23,7 +23,7 @@ up-to-date.
 
 ## Tasks
 
-@docs sendMessageEvent
+@docs sendMessageEvent, sync
 
 -}
 
@@ -33,6 +33,7 @@ import Internal.Api.LoginWithUsernameAndPassword.Api
 import Internal.Api.Now.Api
 import Internal.Api.Request as Request
 import Internal.Api.SendMessageEvent.Api
+import Internal.Api.Sync.Api
 import Internal.Api.Versions.Api
 import Internal.Config.Log exposing (Log, log)
 import Internal.Config.Text as Text
@@ -231,6 +232,15 @@ sendMessageEvent input =
         |> finishTask
 
 
+{-| Sync with the Matrix API to stay up-to-date.
+-}
+sync : { fullState : Maybe Bool, presence : Maybe String, since : Maybe String, timeout : Maybe Int } -> Task
+sync input =
+    makeVBA
+        |> C.andThen (Internal.Api.Sync.Api.sync input)
+        |> finishTask
+
+
 {-| Transform a completed task into a Cmd.
 -}
 run : (Backpack -> msg) -> Task -> APIContext {} -> Cmd msg

src/Internal/Api/Versions/Api.elm

@@ -86,6 +86,5 @@ versionsCoder =
                                 Set.empty
                         }
             , default = ( Set.empty, [] )
-            , defaultToString = always "{}"
             }
         )

src/Internal/Config/Text.elm

@@ -123,6 +123,7 @@ docs :
     , room : TypeDocs
     , settings : TypeDocs
     , stateManager : TypeDocs
+    , strippedEvent : TypeDocs
     , timeline : TypeDocs
     , timelineFilter : TypeDocs
     , unsigned : TypeDocs
@@ -199,6 +200,12 @@ docs =
             , "Instead of making the user loop through the room's timeline of events, the StateManager offers the user a dictionary-like experience to navigate through the Matrix room state."
             ]
         }
+    , strippedEvent =
+        { name = "StrippedEvent"
+        , description =
+            [ "The StrippedEvent is a simplified Matrix event that contains no metadata."
+            ]
+        }
     , timeline =
         { name = "Timeline"
         , description =
@@ -263,6 +270,7 @@ fields :
         , baseUrl : Desc
         , deviceId : Desc
         , experimental : Desc
+        , nextBatch : Desc
         , now : Desc
         , password : Desc
         , refreshToken : Desc
@@ -306,6 +314,7 @@ fields :
         }
     , room :
         { accountData : Desc
+        , ephemeral : Desc
         , events : Desc
         , roomId : Desc
         , state : Desc
@@ -314,6 +323,7 @@ fields :
     , settings :
         { currentVersion : Desc
         , deviceName : Desc
+        , presence : Desc
         , removePasswordOnLogin : Desc
         , syncTime : Desc
         }
@@ -332,12 +342,14 @@ fields :
         }
     , unsigned :
         { age : Desc
+        , membership : Desc
         , prevContent : Desc
         , redactedBecause : Desc
         , transactionId : Desc
         }
     , vault :
         { accountData : Desc
+        , nextBatch : Desc
         , rooms : Desc
         , user : Desc
         }
@@ -372,6 +384,9 @@ fields =
         , experimental =
             [ "Experimental features supported by the homeserver."
             ]
+        , nextBatch =
+            [ "The batch token to supply in the since param of the next /sync request."
+            ]
         , now =
             [ "The most recently found timestamp."
             ]
@@ -479,6 +494,9 @@ fields =
     , room =
         { accountData =
             [ "Room account data tracking the user's private storage about this room." ]
+        , ephemeral =
+            [ "Ephemeral events that were sent recently in this room."
+            ]
         , events =
             [ "Database containing events that were sent in this room." ]
         , roomId =
@@ -495,6 +513,9 @@ fields =
         , deviceName =
             [ "Indicates the device name that is communicated to the Matrix API."
             ]
+        , presence =
+            [ "Controls whether the client is automatically marked as online. The value is passed on to the Matrix API."
+            ]
         , removePasswordOnLogin =
             [ "Remove the password as soon as a valid access token has been received."
             ]
@@ -540,6 +561,9 @@ fields =
         { age =
             [ "The time in milliseconds that has elapsed since the event was sent. This field is generated by the local homeserver, and may be incorrect if the local time on at least one of the two servers is out of sync, which can cause the age to either be negative or greater than it actually is."
             ]
+        , membership =
+            [ "The room membership of the user making the request, at the time of the event."
+            ]
         , prevContent =
             [ "The previous content for this event. This field is generated by the local homeserver, and is only returned if the event is a state event, and the client has permission to see the previous content."
             ]
@@ -554,6 +578,9 @@ fields =
         { accountData =
             [ "The account's global private data."
             ]
+        , nextBatch =
+            [ "The next batch that can be used to sync with the Matrix API."
+            ]
         , rooms =
             [ "Directory of joined rooms that the user is a member of."
             ]
@@ -613,6 +640,7 @@ logs :
     , sendEvent : Maybe String -> String
     , serverReturnedInvalidJSON : String -> String
     , serverReturnedUnknownJSON : String -> String
+    , syncAccountDataFound : Int -> String
     }
 logs =
     { baseUrlFailed =
@@ -652,6 +680,8 @@ logs =
                     "Sent event, event id not known - make sure to check transaction id"
     , serverReturnedInvalidJSON = (++) "The server returned invalid JSON: "
     , serverReturnedUnknownJSON = (++) "The server returned JSON that doesn't seem to live up to spec rules: "
+    , syncAccountDataFound =
+        \n -> String.concat [ "Found ", String.fromInt n, " account data updates" ]
     }
 
 

src/Internal/Filter/Timeline.elm

@@ -183,7 +183,6 @@ coder =
             , description = Text.fields.timelineFilter.senders
             , coder = Json.set Json.string
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
         (Json.field.required
@@ -199,7 +198,6 @@ coder =
             , description = Text.fields.timelineFilter.types
             , coder = Json.set Json.string
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
         (Json.field.required

src/Internal/Tools/DecodeExtra.elm

@@ -1,6 +1,6 @@
 module Internal.Tools.DecodeExtra exposing
     ( opField, opFieldWithDefault
-    , map9, map10, map11
+    , map9, map10, map11, map12
     )
 
 {-|
@@ -18,7 +18,7 @@ This module contains helper functions that help decode JSON.
 
 ## Extended map functions
 
-@docs map9, map10, map11
+@docs map9, map10, map11, map12
 
 -}
 
@@ -153,3 +153,35 @@ map11 func da db dc dd de df dg dh di dj dk =
         (D.map2 Tuple.pair df dg)
         (D.map2 Tuple.pair dh di)
         (D.map2 Tuple.pair dj dk)
+
+
+{-| Try 12 decoders and combine the result.
+-}
+map12 :
+    (a -> b -> c -> d -> e -> f -> g -> h -> i -> j -> k -> l -> value)
+    -> D.Decoder a
+    -> D.Decoder b
+    -> D.Decoder c
+    -> D.Decoder d
+    -> D.Decoder e
+    -> D.Decoder f
+    -> D.Decoder g
+    -> D.Decoder h
+    -> D.Decoder i
+    -> D.Decoder j
+    -> D.Decoder k
+    -> D.Decoder l
+    -> D.Decoder value
+map12 func da db dc dd de df dg dh di dj dk dl =
+    D.map8
+        (\a b c d ( e, f ) ( g, h ) ( i, j ) ( k, l ) ->
+            func a b c d e f g h i j k l
+        )
+        da
+        db
+        dc
+        dd
+        (D.map2 Tuple.pair de df)
+        (D.map2 Tuple.pair dg dh)
+        (D.map2 Tuple.pair di dj)
+        (D.map2 Tuple.pair dk dl)

src/Internal/Tools/Json.elm

@@ -5,7 +5,7 @@ module Internal.Tools.Json exposing
     , Docs(..), RequiredField(..), toDocs
     , list, listWithOne, slowDict, fastDict, fastIntDict, set, iddict, maybe
     , Field, field, parser
-    , object2, object3, object4, object5, object6, object7, object8, object9, object10, object11
+    , object1, object2, object3, object4, object5, object6, object7, object8, object9, object10, object11, object12
     )
 
 {-|
@@ -62,7 +62,7 @@ first.
 
 Once all fields are constructed, the user can create JSON objects.
 
-@docs object2, object3, object4, object5, object6, object7, object8, object9, object10, object11
+@docs object1, object2, object3, object4, object5, object6, object7, object8, object9, object10, object11, object12
 
 -}
 
@@ -364,7 +364,7 @@ then the following field type would be used:
         , coder = string
         }
 
-Suppose the JSO isn't obligated to provide a list of hobbies, and the list would
+Suppose the JSON isn't obligated to provide a list of hobbies, and the list would
 by default be overriden with an empty list, then we would use the following
 field type:
 
@@ -375,8 +375,7 @@ field type:
             [ "The hobbies of the person. Can be omitted."
             ]
         , coder = list string
-        , default = ( [], [] ) -- The `List Log` can be inserted in case you wish to insert a message when relying on a default
+        , default = ( [ "football" ], [] ) -- The `List Log` can be inserted in case you wish to insert a message when relying on a default
-        , defaultToString = always "[]" -- Default converted to a string
         }
 
 -}
@@ -384,7 +383,7 @@ field :
     { required : { fieldName : String, toField : object -> a, description : List String, coder : Coder a } -> Field a object
     , optional :
         { value : { fieldName : String, toField : object -> Maybe a, description : List String, coder : Coder a } -> Field (Maybe a) object
-        , withDefault : { fieldName : String, toField : object -> a, description : List String, coder : Coder a, default : ( a, List Log ), defaultToString : a -> String } -> Field a object
+        , withDefault : { fieldName : String, toField : object -> a, description : List String, coder : Coder a, default : ( a, List Log ) } -> Field a object
         }
     }
 field =
@@ -427,7 +426,7 @@ field =
                             , requiredness = OptionalField
                             }
         , withDefault =
-            \{ fieldName, toField, description, coder, default, defaultToString } ->
+            \{ fieldName, toField, description, coder, default } ->
                 case coder of
                     Coder { encoder, decoder, docs } ->
                         Field
@@ -451,7 +450,8 @@ field =
                             , requiredness =
                                 default
                                     |> Tuple.first
-                                    |> defaultToString
+                                    |> encoder
+                                    |> E.encode 0
                                     |> OptionalFieldWithDefault
                             }
         }
@@ -617,6 +617,23 @@ objectEncoder items object =
         |> E.maybeObject
 
 
+object1 :
+    Descriptive { init : a -> object }
+    -> Field a object
+    -> Coder object
+object1 { name, description, init } fa =
+    Coder
+        { encoder = objectEncoder [ toEncodeField fa ]
+        , decoder = D.map (Tuple.mapFirst init) (toDecoderField fa)
+        , docs =
+            DocsObject
+                { name = name
+                , description = description
+                , keys = [ toDocsField fa ]
+                }
+        }
+
+
 {-| Define an object with 2 keys
 
     type alias Human =
@@ -1179,6 +1196,81 @@ object11 { name, description, init } fa fb fc fd fe ff fg fh fi fj fk =
         }
 
 
+{-| Define an object with 12 keys
+-}
+object12 :
+    Descriptive { init : a -> b -> c -> d -> e -> f -> g -> h -> i -> j -> k -> l -> object }
+    -> Field a object
+    -> Field b object
+    -> Field c object
+    -> Field d object
+    -> Field e object
+    -> Field f object
+    -> Field g object
+    -> Field h object
+    -> Field i object
+    -> Field j object
+    -> Field k object
+    -> Field l object
+    -> Coder object
+object12 { name, description, init } fa fb fc fd fe ff fg fh fi fj fk fl =
+    Coder
+        { encoder =
+            objectEncoder
+                [ toEncodeField fa
+                , toEncodeField fb
+                , toEncodeField fc
+                , toEncodeField fd
+                , toEncodeField fe
+                , toEncodeField ff
+                , toEncodeField fg
+                , toEncodeField fh
+                , toEncodeField fi
+                , toEncodeField fj
+                , toEncodeField fk
+                , toEncodeField fl
+                ]
+        , decoder =
+            D.map12
+                (\( a, la ) ( b, lb ) ( c, lc ) ( d, ld ) ( e, le ) ( f, lf ) ( g, lg ) ( h, lh ) ( i, li ) ( j, lj ) ( k, lk ) ( l, ll ) ->
+                    ( init a b c d e f g h i j k l
+                    , List.concat [ la, lb, lc, ld, le, lf, lg, lh, li, lj, lk, ll ]
+                    )
+                )
+                (toDecoderField fa)
+                (toDecoderField fb)
+                (toDecoderField fc)
+                (toDecoderField fd)
+                (toDecoderField fe)
+                (toDecoderField ff)
+                (toDecoderField fg)
+                (toDecoderField fh)
+                (toDecoderField fi)
+                (toDecoderField fj)
+                (toDecoderField fk)
+                (toDecoderField fl)
+        , docs =
+            DocsObject
+                { name = name
+                , description = description
+                , keys =
+                    [ toDocsField fa
+                    , toDocsField fb
+                    , toDocsField fc
+                    , toDocsField fd
+                    , toDocsField fe
+                    , toDocsField ff
+                    , toDocsField fg
+                    , toDocsField fh
+                    , toDocsField fi
+                    , toDocsField fj
+                    , toDocsField fk
+                    , toDocsField fl
+                    ]
+                }
+        }
+
+
 {-| Define a parser that converts a string into a custom Elm type.
 -}
 parser : { name : String, p : P.Parser ( a, List Log ), toString : a -> String } -> Coder a

src/Internal/Tools/StrippedEvent.elm

@@ -0,0 +1,51 @@
+module Internal.Tools.StrippedEvent exposing (StrippedEvent, coder, strip)
+
+{-|
+
+
+# Stripped event
+
+The stripped event is a simple Matrix event that does not contain any metadata.
+
+@docs StrippedEvent, coder, strip
+
+-}
+
+import Internal.Config.Text as Text
+import Internal.Tools.Json as Json
+
+
+type alias StrippedEvent =
+    { content : Json.Value, eventType : String }
+
+
+coder : Json.Coder StrippedEvent
+coder =
+    Json.object2
+        { name = Text.docs.strippedEvent.name
+        , description = Text.docs.strippedEvent.description
+        , init = StrippedEvent
+        }
+        (Json.field.required
+            { fieldName = "content"
+            , toField = .content
+            , description =
+                [ "Event content"
+                ]
+            , coder = Json.value
+            }
+        )
+        (Json.field.required
+            { fieldName = "type"
+            , toField = .eventType
+            , description =
+                [ "Event type, generally namespaced using the Java package naming convention."
+                ]
+            , coder = Json.string
+            }
+        )
+
+
+strip : { a | content : Json.Value, eventType : String } -> StrippedEvent
+strip { content, eventType } =
+    { content = content, eventType = eventType }

src/Internal/Values/Context.elm

@@ -95,6 +95,7 @@ type alias Context =
     { accessTokens : Hashdict AccessToken
     , baseUrl : Maybe String
     , deviceId : Maybe String
+    , nextBatch : Maybe String
     , now : Maybe Timestamp
     , password : Maybe String
     , refreshToken : Maybe String
@@ -152,7 +153,7 @@ fromApiFormat (APIContext c) =
 -}
 coder : Json.Coder Context
 coder =
-    Json.object11
+    Json.object12
         { name = Text.docs.context.name
         , description = Text.docs.context.description
         , init = Context
@@ -178,6 +179,13 @@ coder =
             , coder = Json.string
             }
         )
+        (Json.field.optional.value
+            { fieldName = "nextBatch"
+            , toField = .nextBatch
+            , description = Text.fields.context.nextBatch
+            , coder = Json.string
+            }
+        )
         (Json.field.optional.value
             { fieldName = "now"
             , toField = .now
@@ -303,6 +311,7 @@ init sn =
     { accessTokens = Hashdict.empty .value
     , baseUrl = Nothing
     , deviceId = Nothing
+    , nextBatch = Nothing
     , now = Nothing
     , refreshToken = Nothing
     , password = Nothing
@@ -439,6 +448,5 @@ versionsCoder =
             , description = Text.fields.versions.unstableFeatures
             , coder = Json.set Json.string
             , default = ( Set.empty, [] )
-            , defaultToString = Json.encode (Json.set Json.string) >> E.encode 0
             }
         )

src/Internal/Values/Envelope.elm

@@ -82,6 +82,7 @@ type EnvelopeUpdate a
     | SetAccessToken AccessToken
     | SetBaseUrl String
     | SetDeviceId String
+    | SetNextBatch String
     | SetNow Timestamp
     | SetRefreshToken String
     | SetVersions Versions
@@ -124,7 +125,6 @@ coder c1 =
             , description = Text.fields.envelope.settings
             , coder = Settings.coder
             , default = Tuple.pair Settings.init []
-            , defaultToString = always "<Default settings>"
             }
         )
 
@@ -328,6 +328,9 @@ update updateContent eu ({ context } as data) =
         SetDeviceId d ->
             { data | context = { context | deviceId = Just d } }
 
+        SetNextBatch nextBatch ->
+            { data | context = { context | nextBatch = Just nextBatch } }
+
         SetNow n ->
             { data | context = { context | now = Just n } }
 

src/Internal/Values/Event.elm

@@ -59,6 +59,7 @@ helper functions.
 type UnsignedData
     = UnsignedData
         { age : Maybe Int
+        , membership : Maybe String
         , prevContent : Maybe Json.Value
         , redactedBecause : Maybe Event
         , transactionId : Maybe String
@@ -242,10 +243,10 @@ transactionId event =
 
 unsignedCoder : Json.Coder UnsignedData
 unsignedCoder =
-    Json.object4
+    Json.object5
         { name = Text.docs.unsigned.name
         , description = Text.docs.unsigned.description
-        , init = \a b c d -> UnsignedData { age = a, prevContent = b, redactedBecause = c, transactionId = d }
+        , init = \a b c d e -> UnsignedData { age = a, membership = b, prevContent = c, redactedBecause = d, transactionId = e }
         }
         (Json.field.optional.value
             { fieldName = "age"
@@ -254,6 +255,13 @@ unsignedCoder =
             , coder = Json.int
             }
         )
+        (Json.field.optional.value
+            { fieldName = "membership"
+            , toField = \(UnsignedData data) -> data.membership
+            , description = Text.fields.unsigned.membership
+            , coder = Json.string
+            }
+        )
         (Json.field.optional.value
             { fieldName = "prevContent"
             , toField = \(UnsignedData data) -> data.prevContent

src/Internal/Values/Room.elm

@@ -53,6 +53,7 @@ import Internal.Config.Text as Text
 import Internal.Filter.Timeline as Filter exposing (Filter)
 import Internal.Tools.Hashdict as Hashdict exposing (Hashdict)
 import Internal.Tools.Json as Json
+import Internal.Tools.StrippedEvent as StrippedEvent exposing (StrippedEvent)
 import Internal.Values.Event as Event exposing (Event)
 import Internal.Values.StateManager as StateManager exposing (StateManager)
 import Internal.Values.Timeline as Timeline exposing (Timeline)
@@ -71,6 +72,7 @@ homeserver.
 -}
 type alias Room =
     { accountData : Dict String Json.Value
+    , ephemeral : List StrippedEvent
     , events : Hashdict Event
     , roomId : String
     , state : StateManager
@@ -86,7 +88,9 @@ type RoomUpdate
     | AddSync Batch
     | Invite User
     | More (List RoomUpdate)
+    | Optional (Maybe RoomUpdate)
     | SetAccountData String Json.Value
+    | SetEphemeral (List { eventType : String, content : Json.Value })
 
 
 {-| Add new events to the Room's event directory + Room's timeline.
@@ -140,7 +144,7 @@ addSync =
 -}
 coder : Json.Coder Room
 coder =
-    Json.object5
+    Json.object6
         { name = Text.docs.room.name
         , description = Text.docs.room.description
         , init = Room
@@ -151,7 +155,14 @@ coder =
             , description = Text.fields.room.accountData
             , coder = Json.fastDict Json.value
             , default = ( Dict.empty, [] )
-            , defaultToString = Json.encode (Json.fastDict Json.value) >> E.encode 0
+            }
+        )
+        (Json.field.optional.withDefault
+            { fieldName = "ephemeral"
+            , toField = .ephemeral
+            , description = Text.fields.room.ephemeral
+            , coder = Json.list StrippedEvent.coder
+            , default = ( [], [] )
             }
         )
         (Json.field.optional.withDefault
@@ -160,7 +171,6 @@ coder =
             , description = Text.fields.room.events
             , coder = Hashdict.coder .eventId Event.coder
             , default = ( Hashdict.empty .eventId, [ log.warn "Found a room with no known events! Is it empty?" ] )
-            , defaultToString = Json.encode (Hashdict.coder .eventId Event.coder) >> E.encode 0
             }
         )
         (Json.field.required
@@ -176,7 +186,6 @@ coder =
             , description = Text.fields.room.state
             , coder = StateManager.coder
             , default = ( StateManager.empty, [] )
-            , defaultToString = Json.encode StateManager.coder >> E.encode 0
             }
         )
         (Json.field.optional.withDefault
@@ -185,7 +194,6 @@ coder =
             , description = Text.fields.room.timeline
             , coder = Timeline.coder
             , default = ( Timeline.empty, [] )
-            , defaultToString = Json.encode Timeline.coder >> E.encode 0
             }
         )
 
@@ -216,6 +224,7 @@ getAccountData key room =
 init : String -> Room
 init roomId =
     { accountData = Dict.empty
+    , ephemeral = []
     , events = Hashdict.empty .eventId
     , roomId = roomId
     , state = StateManager.empty
@@ -262,5 +271,14 @@ update ru room =
         More items ->
             List.foldl update room items
 
+        Optional (Just u) ->
+            update u room
+
+        Optional Nothing ->
+            room
+
         SetAccountData key value ->
             setAccountData key value room
+
+        SetEphemeral eph ->
+            { room | ephemeral = eph }

src/Internal/Values/Settings.elm

@@ -35,6 +35,7 @@ behave under the user's preferred settings.
 type alias Settings =
     { currentVersion : String
     , deviceName : String
+    , presence : Maybe String
     , removePasswordOnLogin : Bool
     , syncTime : Int
     }
@@ -44,7 +45,7 @@ type alias Settings =
 -}
 coder : Json.Coder Settings
 coder =
-    Json.object4
+    Json.object5
         { name = Text.docs.settings.name
         , description = Text.docs.settings.description
         , init = Settings
@@ -55,7 +56,6 @@ coder =
             , description = Text.fields.settings.currentVersion
             , coder = Json.string
             , default = Tuple.pair Default.currentVersion []
-            , defaultToString = identity
             }
         )
         (Json.field.optional.withDefault
@@ -64,7 +64,13 @@ coder =
             , description = Text.fields.settings.deviceName
             , coder = Json.string
             , default = Tuple.pair Default.deviceName []
-            , defaultToString = identity
+            }
+        )
+        (Json.field.optional.value
+            { fieldName = "presence"
+            , toField = .presence
+            , description = Text.fields.settings.presence
+            , coder = Json.string
             }
         )
         (Json.field.optional.withDefault
@@ -73,13 +79,6 @@ coder =
             , description = Text.fields.settings.removePasswordOnLogin
             , coder = Json.bool
             , default = Tuple.pair Default.removePasswordOnLogin []
-            , defaultToString =
-                \b ->
-                    if b then
-                        "true"
-
-                    else
-                        "false"
             }
         )
         (Json.field.optional.withDefault
@@ -88,7 +87,6 @@ coder =
             , description = Text.fields.settings.syncTime
             , coder = Json.int
             , default = Tuple.pair Default.syncTime []
-            , defaultToString = String.fromInt
             }
         )
 
@@ -113,6 +111,7 @@ init : Settings
 init =
     { currentVersion = Default.currentVersion
     , deviceName = Default.deviceName
+    , presence = Nothing
     , removePasswordOnLogin = Default.removePasswordOnLogin
     , syncTime = Default.syncTime
     }

src/Internal/Values/Timeline.elm

@@ -226,7 +226,6 @@ coder =
             , description = Text.fields.timeline.filledBatches
             , coder = Json.int
             , default = ( 0, [] )
-            , defaultToString = String.fromInt
             }
         )
         (Json.field.required
@@ -326,7 +325,6 @@ coderIToken =
             , description = Text.fields.itoken.starts
             , coder = Json.set coderIBatchPTRValue
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
         (Json.field.optional.withDefault
@@ -335,7 +333,6 @@ coderIToken =
             , description = Text.fields.itoken.ends
             , coder = Json.set coderIBatchPTRValue
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
         (Json.field.optional.withDefault
@@ -344,7 +341,6 @@ coderIToken =
             , description = Text.fields.itoken.inFrontOf
             , coder = Json.set coderITokenPTRValue
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
         (Json.field.optional.withDefault
@@ -353,7 +349,6 @@ coderIToken =
             , description = Text.fields.itoken.behind
             , coder = Json.set coderITokenPTRValue
             , default = ( Set.empty, [] )
-            , defaultToString = always "[]"
             }
         )
 

src/Internal/Values/Vault.elm

@@ -44,6 +44,7 @@ import Internal.Values.User as User exposing (User)
 -}
 type alias Vault =
     { accountData : Dict String Json.Value
+    , nextBatch : Maybe String
     , rooms : Hashdict Room
     , user : Maybe User
     }
@@ -56,13 +57,15 @@ type VaultUpdate
     = CreateRoomIfNotExists String
     | MapRoom String Room.RoomUpdate
     | More (List VaultUpdate)
+    | Optional (Maybe VaultUpdate)
     | SetAccountData String Json.Value
+    | SetNextBatch String
     | SetUser User
 
 
 coder : Json.Coder Vault
 coder =
-    Json.object3
+    Json.object4
         { name = Text.docs.vault.name
         , description = Text.docs.vault.description
         , init = Vault
@@ -74,6 +77,13 @@ coder =
             , coder = Json.fastDict Json.value
             }
         )
+        (Json.field.optional.value
+            { fieldName = "nextBatch"
+            , toField = .nextBatch
+            , description = Text.fields.vault.nextBatch
+            , coder = Json.string
+            }
+        )
         (Json.field.required
             { fieldName = "rooms"
             , toField = .rooms
@@ -109,6 +119,7 @@ getAccountData key vault =
 init : Maybe User -> Vault
 init mUser =
     { accountData = Dict.empty
+    , nextBatch = Nothing
     , rooms = Hashdict.empty .roomId
     , user = mUser
     }
@@ -159,8 +170,17 @@ update vu vault =
         More items ->
             List.foldl update vault items
 
+        Optional (Just u) ->
+            update u vault
+
+        Optional Nothing ->
+            vault
+
         SetAccountData key value ->
             setAccountData key value vault
 
+        SetNextBatch nb ->
+            { vault | nextBatch = Just nb }
+
         SetUser user ->
             { vault | user = Just user }

src/Matrix.elm

@@ -1,6 +1,6 @@
 module Matrix exposing
     ( Vault, fromUserId, fromUsername
-    , VaultUpdate, update
+    , VaultUpdate, update, sync, logs
     , rooms, fromRoomId
     , addAccessToken, sendMessageEvent
     )
@@ -25,7 +25,7 @@ support a monolithic public registry. (:
 
 ## Keeping the Vault up-to-date
 
-@docs VaultUpdate, update
+@docs VaultUpdate, update, sync, logs
 
 
 ## Exploring the Vault
@@ -134,6 +134,28 @@ rooms (Vault vault) =
         |> List.map Types.Room
 
 
+{-| The VaultUpdate is a complex type that helps update the Vault. However,
+it also contains a human output!
+
+Using this function, you can get a human output that describes everything that
+the VaultUpdate has to tell the Vault.
+
+The `channel` field describes the context of the log, allowing you to filter
+further. For example:
+
+  - `debug` is a comprehensive channel describing everything the Elm runtime has
+    executed.
+  - `warn` contains warnings that aren't breaking, but relevant.
+  - `securityWarn` warns about potential security issues or potential attacks.
+  - `error` has errors that were encountered.
+  - `caughtError` has errors that were dealt with successfully.
+
+-}
+logs : VaultUpdate -> List { channel : String, content : String }
+logs (VaultUpdate vu) =
+    vu.logs
+
+
 {-| Send a message event to a room.
 
 This function can be used in a scenario where the user does not want to sync
@@ -141,6 +163,18 @@ the client, or is unable to. This function doesn't check whether the given room
 exists and the user is able to send a message to, and instead just sends the
 request to the Matrix API.
 
+The fields stand for the following:
+
+  - `content` is the JSON object that is sent to the Matrix room.
+  - `eventType` is the event type that is sent to the Matrix room.
+  - `roomId` is the Matrix room ID.
+  - `toMsg` is the `msg` type that is returned after the message has been sent.
+  - `transactionId` is a unique identifier that helps the Matrix server
+    distringuish messages. If you send the same message with the same transactionId,
+    the server promises to register it only once.
+  - `vault` is the Matrix Vault that contains all the latest and most relevant
+    information.
+
 -}
 sendMessageEvent :
     { content : E.Value
@@ -163,6 +197,17 @@ sendMessageEvent data =
                 }
 
 
+{-| Synchronize the Vault with the Matrix API.
+
+Effectively, this task asks the Matrix API to provide the latest information,
+which will be returned as your VaultUpdate.
+
+-}
+sync : (VaultUpdate -> msg) -> Vault -> Cmd msg
+sync toMsg (Vault vault) =
+    Api.sync vault { toMsg = Types.VaultUpdate >> toMsg }
+
+
 {-| Using new VaultUpdate information, update the Vault accordingly.
 
 This allows us to change our perception of the Matrix environment: has anyone

tests/Test/Tools/Json.elm

@@ -100,7 +100,6 @@ gridField =
         , description = []
         , coder = Json.list (Json.list Json.int)
         , default = ( [], [] )
-        , defaultToString = always "[]"
         }
 
 
@@ -132,7 +131,6 @@ hobbiesField =
         , description = []
         , coder = Json.list Json.string
         , default = ( [], [] )
-        , defaultToString = always "[]"
         }
 
 
@@ -149,13 +147,6 @@ invitedToPartyField =
         , description = []
         , coder = Json.bool
         , default = ( False, [] )
-        , defaultToString =
-            \b ->
-                if b then
-                    "True"
-
-                else
-                    "False"
         }
 
 

tests/Test/Values/Vault.elm

@@ -12,11 +12,12 @@ import Test.Values.User as TestUser
 
 vault : Fuzzer Vault
 vault =
-    Fuzz.map3 Vault
+    Fuzz.map4 Vault
         (Fuzz.string
             |> Fuzz.map (\k -> ( k, Json.encode Json.int 0 ))
             |> Fuzz.list
             |> Fuzz.map Dict.fromList
         )
+        (Fuzz.maybe Fuzz.string)
         (TestHashdict.fuzzer .roomId TestRoom.fuzzer)
         (Fuzz.maybe TestUser.fuzzer)