elm-pages 3.0.0-beta.33 → 3.0.0-beta.34

package/src/Pages/Internal/Platform/CompatibilityKey.elm

@@ -3,4 +3,4 @@ module Pages.Internal.Platform.CompatibilityKey exposing (currentCompatibilityKe
 
 currentCompatibilityKey : Int
 currentCompatibilityKey =
-    13
+    14

package/src/Pages/Internal/Platform/GeneratorApplication.elm

@@ -291,13 +291,9 @@ initLegacy :
     -> ( Model, Effect )
 initLegacy execute =
     let
-        staticResponses : BackendTask FatalError ()
-        staticResponses =
-            StaticResponses.renderApiRequest execute
-
         initialModel : Model
         initialModel =
-            { staticResponses = staticResponses
+            { staticResponses = execute
             , errors = []
             }
     in

package/src/Pages/Internal/Platform.elm

@@ -20,8 +20,7 @@ import BuildError exposing (BuildError)
 import Bytes exposing (Bytes)
 import Bytes.Decode
 import Dict exposing (Dict)
-import Form.FormData exposing (FormData, Method(..))
-import FormDecoder
+import Form
 import Html exposing (Html)
 import Html.Attributes as Attr
 import Http
@@ -30,7 +29,6 @@ import Json.Encode
 import Pages.ContentCache as ContentCache
 import Pages.Fetcher
 import Pages.Flags
-import Pages.FormState
 import Pages.Internal.Msg
 import Pages.Internal.NotFoundReason exposing (NotFoundReason)
 import Pages.Internal.ResponseSketch as ResponseSketch exposing (ResponseSketch)
@@ -311,7 +309,8 @@ type Msg userMsg pageData actionData sharedData errorPage
     | UrlChanged Url
       -- TODO rename to PagesMsg
     | UserMsg (PagesMsg userMsg)
-    | SetField { formId : String, name : String, value : String }
+      --| SetField { formId : String, name : String, value : String }
+    | FormMsg (Form.Msg (Msg userMsg pageData actionData sharedData errorPage))
     | UpdateCacheAndUrlNew Bool Url (Maybe userMsg) (Result Http.Error ( Url, ResponseSketch pageData actionData sharedData ))
     | FetcherComplete Bool String Int (Result Http.Error ( Maybe userMsg, ActionDataOrRedirect actionData ))
     | FetcherStarted String Int FormData Time.Posix
@@ -344,7 +343,7 @@ type alias Model userModel pageData actionData sharedData =
     , transition : Maybe ( Int, Pages.Transition.Transition )
     , nextTransitionKey : Int
     , inFlightFetchers : Dict String ( Int, Pages.Transition.FetcherState actionData )
-    , pageFormState : Pages.FormState.PageFormState
+    , pageFormState : Form.Model
     , pendingRedirect : Bool
     , pendingData : Maybe ( pageData, sharedData, Maybe actionData )
     }
@@ -363,6 +362,7 @@ type Effect userMsg pageData actionData sharedData userEffect errorPage
     | Batch (List (Effect userMsg pageData actionData sharedData userEffect errorPage))
     | UserCmd userEffect
     | CancelRequest Int
+    | RunCmd (Cmd (Msg userMsg pageData actionData sharedData errorPage))
 
 
 {-| -}
@@ -373,6 +373,18 @@ update :
     -> ( Model userModel pageData actionData sharedData, Effect userMsg pageData actionData sharedData userEffect errorPage )
 update config appMsg model =
     case appMsg of
+        FormMsg formMsg ->
+            let
+                -- TODO trigger formCmd
+                ( newModel, formCmd ) =
+                    Form.update formMsg model.pageFormState
+            in
+            ( { model
+                | pageFormState = newModel
+              }
+            , RunCmd formCmd
+            )
+
         LinkClicked urlRequest ->
             case urlRequest of
                 Browser.Internal url ->
@@ -398,11 +410,6 @@ update config appMsg model =
                     , BrowserLoadUrl href
                     )
 
-        SetField info ->
-            ( { model | pageFormState = Pages.FormState.setField info model.pageFormState }
-            , NoEffect
-            )
-
         UrlChanged url ->
             case model.pendingData of
                 Just ( newPageData, newSharedData, newActionData ) ->
@@ -498,74 +505,60 @@ update config appMsg model =
                         |> performUserMsg userMsg config
 
                 Pages.Internal.Msg.Submit fields ->
-                    ( { model
-                        | transition =
-                            Just
-                                ( -- TODO remove hardcoded number
-                                  -1
-                                , Pages.Transition.Submitting fields
-                                )
-                      }
-                    , Submit fields
-                    )
-
-                Pages.Internal.Msg.SubmitIfValid formId fields isValid maybeUserMsg ->
-                    if isValid then
-                        ( { model
-                            -- TODO should I setSubmitAttempted here, too?
-                            | transition =
-                                Just
-                                    ( -- TODO remove hardcoded number
-                                      -1
-                                    , Pages.Transition.Submitting fields
-                                    )
-                          }
-                        , Submit fields
-                        )
-                            |> (case maybeUserMsg of
-                                    Just justUserMsg ->
-                                        performUserMsg justUserMsg config
-
-                                    Nothing ->
-                                        identity
-                               )
+                    let
+                        payload : { fields : List ( String, String ), method : Form.Method, action : String, id : Maybe String }
+                        payload =
+                            { fields = fields.fields
+                            , method = fields.method
+                            , action = fields.action
+                            , id = Just fields.id
+                            }
+                    in
+                    if fields.valid then
+                        if fields.useFetcher then
+                            ( { model | nextTransitionKey = model.nextTransitionKey + 1 }
+                            , SubmitFetcher fields.id model.nextTransitionKey payload
+                            )
+                                |> (case fields.msg of
+                                        Just justUserMsg ->
+                                            performUserMsg justUserMsg config
 
-                    else
-                        ( { model
-                            | pageFormState =
-                                model.pageFormState
-                                    |> Pages.FormState.setSubmitAttempted formId
-                          }
-                        , NoEffect
-                        )
+                                        Nothing ->
+                                            identity
+                                   )
 
-                Pages.Internal.Msg.SubmitFetcher fetcherKey fields isValid maybeUserMsg ->
-                    if isValid then
-                        -- TODO should I setSubmitAttempted here, too?
-                        ( { model | nextTransitionKey = model.nextTransitionKey + 1 }
-                        , SubmitFetcher fetcherKey model.nextTransitionKey fields
-                        )
-                            |> (case maybeUserMsg of
-                                    Just justUserMsg ->
-                                        performUserMsg justUserMsg config
+                        else
+                            ( { model
+                                -- TODO should I setSubmitAttempted here, too?
+                                | transition =
+                                    Just
+                                        ( -- TODO remove hardcoded number
+                                          -1
+                                        , Pages.Transition.Submitting payload
+                                        )
+                              }
+                            , Submit payload
+                            )
+                                |> (case fields.msg of
+                                        Just justUserMsg ->
+                                            performUserMsg justUserMsg config
 
-                                    Nothing ->
-                                        identity
-                               )
+                                        Nothing ->
+                                            identity
+                                   )
 
                     else
-                        ( { model
-                            | pageFormState =
-                                model.pageFormState
-                                    |> Pages.FormState.setSubmitAttempted fetcherKey
-                          }
-                        , NoEffect
-                        )
+                        -- TODO should the user msg still be run if the form is invalid?
+                        ( model, NoEffect )
 
-                Pages.Internal.Msg.FormFieldEvent value ->
+                Pages.Internal.Msg.FormMsg formMsg ->
                     -- TODO when init is called for a new page, also need to clear out client-side `pageFormState`
-                    ( { model | pageFormState = Pages.FormState.update value model.pageFormState }
-                    , NoEffect
+                    let
+                        ( formModel, formCmd ) =
+                            Form.update formMsg model.pageFormState
+                    in
+                    ( { model | pageFormState = formModel }
+                    , RunCmd (Cmd.map UserMsg formCmd)
                     )
 
                 Pages.Internal.Msg.NoOp ->
@@ -910,6 +903,9 @@ perform config model effect =
         NoEffect ->
             Cmd.none
 
+        RunCmd cmd ->
+            cmd
+
         Batch effects ->
             effects
                 |> List.map (perform config model)
@@ -941,7 +937,7 @@ perform config model effect =
             fetchRouteData transitionKey toMsg config url maybeRequestInfo
 
         Submit fields ->
-            if fields.method == Get then
+            if fields.method == Form.Get then
                 model.key
                     |> Maybe.map (\key -> Browser.Navigation.pushUrl key (appendFormQueryParams fields))
                     |> Maybe.withDefault Cmd.none
@@ -991,7 +987,11 @@ perform config model effect =
                                     startFetcher "TODO" -1 options model
                             , fromPageMsg = Pages.Internal.Msg.UserMsg >> UserMsg
                             , key = key
-                            , setField = \info -> Task.succeed (SetField info) |> Task.perform identity
+                            , setField =
+                                \info ->
+                                    --Task.succeed (SetField info) |> Task.perform identity
+                                    -- TODO
+                                    Cmd.none
                             }
 
                 Nothing ->
@@ -1006,21 +1006,12 @@ startFetcher fetcherKey transitionId options model =
     let
         encodedBody : String
         encodedBody =
-            FormDecoder.encodeFormData
-                { fields = options.fields
-
-                -- TODO remove hardcoding
-                , action = ""
+            encodeFormData options.fields
 
-                -- TODO remove hardcoding
-                , method = Post
-                , id = Nothing
-                }
-
-        formData : { method : Method, action : String, fields : List ( String, String ), id : Maybe String }
+        formData : { method : Form.Method, action : String, fields : List ( String, String ), id : Maybe String }
         formData =
             { -- TODO remove hardcoding
-              method = Get
+              method = Form.Get
 
             -- TODO pass FormData directly
             , action = options.url |> Maybe.withDefault model.url.path
@@ -1078,7 +1069,7 @@ startFetcher2 config fromPageReload fetcherKey transitionId formData model =
     let
         encodedBody : String
         encodedBody =
-            FormDecoder.encodeFormData formData
+            encodeFormData formData.fields
     in
     -- TODO make sure that `actionData` isn't updated in Model for fetchers
     Cmd.batch
@@ -1139,7 +1130,7 @@ startFetcher2 config fromPageReload fetcherKey transitionId formData model =
 
             -- TODO use formData.method to do either query params or POST body
             , url = formData.action |> Url.fromString |> Maybe.map (\{ path } -> Path.join [ path, "content.dat" ] |> Path.toAbsolute) |> Maybe.withDefault "/"
-            , method = formData.method |> FormDecoder.methodToString
+            , method = formData.method |> methodToString
             , timeout = Nothing
             }
         ]
@@ -1173,10 +1164,10 @@ appendFormQueryParams fields =
         |> Maybe.withDefault "/"
     )
         ++ (case fields.method of
-                Get ->
-                    "?" ++ FormDecoder.encodeFormData fields
+                Form.Get ->
+                    "?" ++ encodeFormData fields.fields
 
-                Post ->
+                Form.Post ->
                     ""
            )
 
@@ -1291,14 +1282,14 @@ fetchRouteData transitionKey toMsg config url details =
 
     -}
     let
-        formMethod : Method
+        formMethod : Form.Method
         formMethod =
             details
                 |> Maybe.map .method
-                |> Maybe.withDefault Get
+                |> Maybe.withDefault Form.Get
     in
     Http.request
-        { method = details |> Maybe.map (.method >> FormDecoder.methodToString) |> Maybe.withDefault "GET"
+        { method = details |> Maybe.map (.method >> methodToString) |> Maybe.withDefault "GET"
         , headers = []
         , url =
             "/"
@@ -1316,34 +1307,34 @@ fetchRouteData transitionKey toMsg config url details =
                         |> String.join "/"
                    )
                 ++ (case formMethod of
-                        Post ->
+                        Form.Post ->
                             "/"
 
-                        Get ->
+                        Form.Get ->
                             details
-                                |> Maybe.map FormDecoder.encodeFormData
+                                |> Maybe.map (.fields >> encodeFormData)
                                 |> Maybe.map (\encoded -> "?" ++ encoded)
                                 |> Maybe.withDefault ""
                    )
                 ++ (case formMethod of
                         -- TODO extract this to something unit testable
                         -- TODO make states mutually exclusive for submissions and direct URL requests (shouldn't be possible to append two query param strings)
-                        Post ->
+                        Form.Post ->
                             ""
 
-                        Get ->
+                        Form.Get ->
                             url.query
                                 |> Maybe.map (\encoded -> "?" ++ encoded)
                                 |> Maybe.withDefault ""
                    )
         , body =
             case formMethod of
-                Post ->
+                Form.Post ->
                     let
                         urlEncodedFields : Maybe String
                         urlEncodedFields =
                             details
-                                |> Maybe.map FormDecoder.encodeFormData
+                                |> Maybe.map (.fields >> encodeFormData)
                     in
                     urlEncodedFields
                         |> Maybe.map (\encoded -> Http.stringBody "application/x-www-form-urlencoded" encoded)
@@ -1597,3 +1588,31 @@ loadDataAndUpdateUrl ( newPageData, newSharedData, newActionData ) maybeUserMsg
                 |> Url.toString
                 |> BrowserLoadUrl
             )
+
+
+methodToString : Form.Method -> String
+methodToString method =
+    case method of
+        Form.Get ->
+            "GET"
+
+        Form.Post ->
+            "POST"
+
+
+encodeFormData : List ( String, String ) -> String
+encodeFormData fields =
+    fields
+        |> List.map
+            (\( name, value ) ->
+                Url.percentEncode name ++ "=" ++ Url.percentEncode value
+            )
+        |> String.join "&"
+
+
+type alias FormData =
+    { fields : List ( String, String )
+    , method : Form.Method
+    , action : String
+    , id : Maybe String
+    }

package/src/Pages/ProgramConfig.elm

@@ -1,4 +1,4 @@
-module Pages.ProgramConfig exposing (ProgramConfig)
+module Pages.ProgramConfig exposing (FormData, ProgramConfig)
 
 import ApiRoute
 import BackendTask exposing (BackendTask)
@@ -8,7 +8,7 @@ import Bytes.Decode
 import Bytes.Encode
 import Dict exposing (Dict)
 import FatalError exposing (FatalError)
-import Form.FormData exposing (FormData)
+import Form
 import Head
 import Html exposing (Html)
 import Http
@@ -17,7 +17,6 @@ import Json.Encode
 import PageServerResponse exposing (PageServerResponse)
 import Pages.Fetcher
 import Pages.Flags
-import Pages.FormState
 import Pages.Internal.NotFoundReason exposing (NotFoundReason)
 import Pages.Internal.Platform.ToJsPayload
 import Pages.Internal.ResponseSketch exposing (ResponseSketch)
@@ -47,14 +46,14 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
                 , pageUrl : Maybe PageUrl
                 }
         -> ( userModel, effect )
-    , update : Pages.FormState.PageFormState -> Dict String (Pages.Transition.FetcherState actionData) -> Maybe Pages.Transition.Transition -> sharedData -> pageData -> Maybe Browser.Navigation.Key -> userMsg -> userModel -> ( userModel, effect )
+    , update : Form.Model -> Dict String (Pages.Transition.FetcherState actionData) -> Maybe Pages.Transition.Transition -> sharedData -> pageData -> Maybe Browser.Navigation.Key -> userMsg -> userModel -> ( userModel, effect )
     , subscriptions : route -> Path -> userModel -> Sub userMsg
     , sharedData : BackendTask FatalError sharedData
     , data : Decode.Value -> route -> BackendTask FatalError (PageServerResponse pageData errorPage)
     , action : Decode.Value -> route -> BackendTask FatalError (PageServerResponse actionData errorPage)
     , onActionData : actionData -> Maybe userMsg
     , view :
-        Pages.FormState.PageFormState
+        Form.Model
         -> Dict String (Pages.Transition.FetcherState actionData)
         -> Maybe Pages.Transition.Transition
         ->
@@ -128,3 +127,11 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
     , errorPageToData : errorPage -> pageData
     , notFoundRoute : route
     }
+
+
+type alias FormData =
+    { fields : List ( String, String )
+    , method : Form.Method
+    , action : String
+    , id : Maybe String
+    }

package/src/Pages/StaticHttpRequest.elm

@@ -1,7 +1,6 @@
 module Pages.StaticHttpRequest exposing (Error(..), MockResolver, RawRequest(..), Status(..), cacheRequestResolution, mockResolve, toBuildError)
 
 import BuildError exposing (BuildError)
-import Dict
 import Json.Encode
 import Pages.StaticHttp.Request
 import RequestsAndPending exposing (RequestsAndPending)

package/src/Pages/Transition.elm

@@ -14,11 +14,19 @@ module Pages.Transition exposing
 
 -}
 
-import Form.FormData exposing (FormData)
+import Form
 import Path exposing (Path)
 import Time
 
 
+type alias FormData =
+    { fields : List ( String, String )
+    , method : Form.Method
+    , action : String
+    , id : Maybe String
+    }
+
+
 {-| -}
 type Transition
     = Submitting FormData

package/src/PagesMsg.elm

@@ -2,7 +2,6 @@ module PagesMsg exposing
     ( PagesMsg
     , fromMsg
     , map, noOp
-    , onSubmit
     )
 
 {-| In `elm-pages`, Route modules have their own `Msg` type which can be used like a normal TEA (The Elm Architecture) app.
@@ -16,11 +15,8 @@ You can wrap your Route Module's `Msg` using `fromMsg`.
 
 @docs map, noOp
 
-@docs onSubmit
-
 -}
 
-import Html exposing (Attribute)
 import Pages.Internal.Msg
 
 
@@ -84,9 +80,3 @@ noOp =
 map : (a -> b) -> PagesMsg a -> PagesMsg b
 map mapFn msg =
     Pages.Internal.Msg.map mapFn msg
-
-
-{-| -}
-onSubmit : Attribute (PagesMsg userMsg)
-onSubmit =
-    Pages.Internal.Msg.onSubmit

package/src/Scaffold/Form.elm

@@ -37,14 +37,14 @@ type Kind
 {-| -}
 type alias Context =
     { errors : Elm.Expression
-    , isTransitioning : Elm.Expression
+    , submitting : Elm.Expression
     , submitAttempted : Elm.Expression
     , data : Elm.Expression
     , expression : Elm.Expression
     }
 
 
-formWithFields : Bool -> List ( String, Kind ) -> ({ formState : { errors : Elm.Expression, isTransitioning : Elm.Expression, submitAttempted : Elm.Expression, data : Elm.Expression, expression : Elm.Expression }, params : List { name : String, kind : Kind, param : Elm.Expression } } -> Elm.Expression) -> { declaration : Elm.Declaration, call : List Elm.Expression -> Elm.Expression, callFrom : List String -> List Elm.Expression -> Elm.Expression, value : List String -> Elm.Expression }
+formWithFields : Bool -> List ( String, Kind ) -> ({ formState : { errors : Elm.Expression, submitting : Elm.Expression, submitAttempted : Elm.Expression, data : Elm.Expression, expression : Elm.Expression }, params : List { name : String, kind : Kind, param : Elm.Expression } } -> Elm.Expression) -> { declaration : Elm.Declaration, call : List Elm.Expression -> Elm.Expression, callFrom : List String -> List Elm.Expression -> Elm.Expression, value : List String -> Elm.Expression }
 formWithFields elmCssView fields viewFn =
     Elm.Declare.function "form"
         []
@@ -124,7 +124,7 @@ formWithFields elmCssView fields viewFn =
                                             viewFn
                                                 { formState =
                                                     { errors = formState |> Elm.get "errors"
-                                                    , isTransitioning = formState |> Elm.get "isTransitioning"
+                                                    , submitting = formState |> Elm.get "submitting"
                                                     , submitAttempted = formState |> Elm.get "submitAttempted"
                                                     , data = formState |> Elm.get "data"
                                                     , expression = formState
@@ -148,7 +148,7 @@ formWithFields elmCssView fields viewFn =
                         [ Type.string
                         , Type.named [] "ParsedForm"
                         , Type.var "input"
-                        , Type.named [] "Msg"
+                        , Type.namedWith [ "PagesMsg" ] "PagesMsg" [ Type.named [] "Msg" ]
                         ]
                     )
         )
@@ -237,8 +237,8 @@ provide { fields, view, elmCssView } =
                     (\_ ->
                         initCombined (Elm.val "Action") (form.call [])
                             |> Elm.withType
-                                (Type.namedWith [ "Form" ]
-                                    "ServerForms"
+                                (Type.namedWith [ "Form", "Handler" ]
+                                    "Handler"
                                     [ Type.string
                                     , Type.named [] "Action"
                                     ]
@@ -444,7 +444,7 @@ formInit : Elm.Expression
 formInit =
     Elm.value
         { importFrom = [ "Form" ]
-        , name = "init"
+        , name = "form"
         , annotation = Nothing
         }
         |> Elm.Op.pipe
@@ -465,8 +465,8 @@ initCombined : Elm.Expression -> Elm.Expression -> Elm.Expression
 initCombined initCombinedArg initCombinedArg0 =
     Elm.apply
         (Elm.value
-            { importFrom = [ "Form" ]
-            , name = "initCombined"
+            { importFrom = [ "Form", "Handler" ]
+            , name = "init"
             , annotation = Nothing
             }
         )