elm-pages 3.0.0-beta.17 → 3.0.0-beta.19

package/src/Pages/Generate.elm

@@ -3,6 +3,7 @@ module Pages.Generate exposing
     , Type(..)
     , serverRender
     , preRender, single
+    , addDeclarations
     )
 
 {-| This module provides some functions for scaffolding code for a new Route Module. It uses [`elm-codegen`'s API](https://package.elm-lang.org/packages/mdgriffith/elm-codegen/latest/) for generating code.
@@ -27,6 +28,11 @@ Learn more about [the `elm-pages run` CLI command in its docs page](https://elm-
 
 @docs preRender, single
 
+
+## Including Additional elm-codegen Declarations
+
+@docs addDeclarations
+
 -}
 
 import Elm
@@ -54,12 +60,14 @@ typeToDeclaration name type_ =
 {-| -}
 type Builder
     = ServerRender
+        (List Elm.Declaration)
         { data : ( Type, Elm.Expression -> Elm.Expression )
         , action : ( Type, Elm.Expression -> Elm.Expression )
         , head : Elm.Expression -> Elm.Expression
         , moduleName : List String
         }
     | PreRender
+        (List Elm.Declaration)
         { data : ( Type, Elm.Expression -> Elm.Expression )
         , pages : Maybe Elm.Expression
         , head : Elm.Expression -> Elm.Expression
@@ -76,7 +84,7 @@ serverRender :
     }
     -> Builder
 serverRender =
-    ServerRender
+    ServerRender []
 
 
 {-| -}
@@ -96,7 +104,7 @@ preRender input =
     --            |> Maybe.map RoutePattern.hasRouteParams
     --            |> Maybe.withDefault False
     --in
-    PreRender
+    PreRender []
         { data = input.data
         , pages =
             input.pages
@@ -118,7 +126,7 @@ single :
     }
     -> Builder
 single input =
-    PreRender
+    PreRender []
         { data = ( Tuple.first input.data, \_ -> Tuple.second input.data )
         , pages = Nothing
         , head = input.head
@@ -134,7 +142,7 @@ buildNoState :
     -> Elm.File
 buildNoState definitions builder_ =
     case builder_ of
-        ServerRender builder ->
+        ServerRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel _ app ->
@@ -153,9 +161,10 @@ buildNoState definitions builder_ =
                     , data = builder.data |> Tuple.first
                     , actionData = builder.action |> Tuple.first
                     }
+                , declarations = declarations
                 }
 
-        PreRender builder ->
+        PreRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel _ app ->
@@ -177,9 +186,21 @@ buildNoState definitions builder_ =
                             (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
+                , declarations = declarations
                 }
 
 
+{-| -}
+addDeclarations : List Elm.Declaration -> Builder -> Builder
+addDeclarations declarations builder =
+    case builder of
+        ServerRender existingDeclarations record ->
+            ServerRender (existingDeclarations ++ declarations) record
+
+        PreRender existingDeclarations record ->
+            PreRender (existingDeclarations ++ declarations) record
+
+
 {-| -}
 buildWithLocalState :
     { view :
@@ -213,7 +234,7 @@ buildWithLocalState :
     -> Elm.File
 buildWithLocalState definitions builder_ =
     case builder_ of
-        ServerRender builder ->
+        ServerRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel model app ->
@@ -261,9 +282,10 @@ buildWithLocalState definitions builder_ =
                     , data = builder.data |> Tuple.first
                     , actionData = builder.action |> Tuple.first
                     }
+                , declarations = declarations
                 }
 
-        PreRender builder ->
+        PreRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel model app ->
@@ -314,6 +336,7 @@ buildWithLocalState definitions builder_ =
                             (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
+                , declarations = declarations
                 }
 
 
@@ -350,7 +373,7 @@ buildWithSharedState :
     -> Elm.File
 buildWithSharedState definitions builder_ =
     case builder_ of
-        ServerRender builder ->
+        ServerRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel model app ->
@@ -398,9 +421,10 @@ buildWithSharedState definitions builder_ =
                     , data = builder.data |> Tuple.first
                     , actionData = builder.action |> Tuple.first
                     }
+                , declarations = declarations
                 }
 
-        PreRender builder ->
+        PreRender declarations builder ->
             userFunction builder.moduleName
                 { view =
                     \maybeUrl sharedModel model app ->
@@ -451,6 +475,7 @@ buildWithSharedState definitions builder_ =
                             (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
+                , declarations = declarations
                 }
 
 
@@ -480,6 +505,7 @@ userFunction :
         , action : ActionOrPages
         , head : Elm.Expression -> Elm.Expression
         , types : { model : Type, msg : Type, data : Type, actionData : Type }
+        , declarations : List Elm.Declaration
         }
     -> Elm.File
 userFunction moduleName definitions =
@@ -694,8 +720,8 @@ userFunction moduleName definitions =
                 )
     in
     Elm.file ("Route" :: moduleName)
-        ([ definitions.types.model |> typeToDeclaration "Model"
-         , definitions.types.msg |> typeToDeclaration "Msg"
+        ([ definitions.types.model |> typeToDeclaration "Model" |> Elm.expose
+         , definitions.types.msg |> typeToDeclaration "Msg" |> Elm.expose
          , Elm.alias "RouteParams"
             (Elm.Annotation.record
                 (RoutePattern.fromModuleName moduleName
@@ -704,6 +730,7 @@ userFunction moduleName definitions =
                     |> Maybe.withDefault []
                 )
             )
+            |> Elm.expose
          , Elm.declaration "route"
             ((case definitions.action of
                 Action _ ->
@@ -782,6 +809,7 @@ userFunction moduleName definitions =
                                     )
                    )
             )
+            |> Elm.expose
          ]
             ++ (case localDefinitions of
                     Just local ->
@@ -793,8 +821,8 @@ userFunction moduleName definitions =
                     Nothing ->
                         []
                )
-            ++ [ definitions.types.data |> typeToDeclaration "Data"
-               , definitions.types.actionData |> typeToDeclaration "ActionData"
+            ++ [ definitions.types.data |> typeToDeclaration "Data" |> Elm.expose
+               , definitions.types.actionData |> typeToDeclaration "ActionData" |> Elm.expose
                , dataFn.declaration
                , headFn.declaration
                , viewFn.declaration
@@ -803,6 +831,7 @@ userFunction moduleName definitions =
                 ]
                     |> List.filterMap identity
                )
+            ++ definitions.declarations
         )
 
 

package/src/Pages/Internal/Form.elm

@@ -1,4 +1,4 @@
-module Pages.Internal.Form exposing (Validation(..), ViewField)
+module Pages.Internal.Form exposing (Response(..), Validation(..), ViewField, unwrapResponse)
 
 import Dict exposing (Dict)
 import Form.FieldStatus exposing (FieldStatus)
@@ -15,3 +15,16 @@ type alias ViewField kind =
     , status : FieldStatus
     , kind : ( kind, List ( String, Encode.Value ) )
     }
+
+
+{-| -}
+type Response error
+    = Response
+        { fields : List ( String, String )
+        , errors : Dict String (List error)
+        }
+
+
+unwrapResponse : Response error -> { fields : List ( String, String ), errors : Dict String (List error) }
+unwrapResponse (Response response) =
+    response

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

@@ -209,8 +209,13 @@ perform site renderRequest config effect =
         Effect.Batch list ->
             flatten site renderRequest config list
 
-        Effect.FetchHttp unmasked ->
-            ToJsPayload.DoHttp (Pages.StaticHttp.Request.hash unmasked) unmasked
+        Effect.FetchHttp requests ->
+            requests
+                |> List.map
+                    (\request ->
+                        ( Pages.StaticHttp.Request.hash request, request )
+                    )
+                |> ToJsPayload.DoHttp
                 |> Codec.encoder (ToJsPayload.successCodecNew2 canonicalSiteUrl "")
                 |> config.toJsPort
                 |> Cmd.map never
@@ -817,10 +822,7 @@ nextStepToEffect model nextStep =
             ( { model
                 | staticResponses = updatedStaticResponsesModel
               }
-            , (httpRequests
-                |> List.map Effect.FetchHttp
-              )
-                |> Effect.Batch
+            , Effect.FetchHttp httpRequests
             )
 
         StaticResponses.FinishedWithErrors errors ->

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

@@ -7,7 +7,7 @@ import Pages.StaticHttp.Request as StaticHttp
 
 type Effect
     = NoEffect
-    | FetchHttp StaticHttp.Request
+    | FetchHttp (List StaticHttp.Request)
     | Batch (List Effect)
     | SendSinglePage ToJsSuccessPayloadNewCombined
     | SendSinglePageNew Bytes ToJsSuccessPayloadNewCombined

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

@@ -183,8 +183,13 @@ perform config effect =
         Effect.Batch list ->
             flatten config list
 
-        Effect.FetchHttp unmasked ->
-            ToJsPayload.DoHttp (Pages.StaticHttp.Request.hash unmasked) unmasked
+        Effect.FetchHttp requests ->
+            requests
+                |> List.map
+                    (\request ->
+                        ( Pages.StaticHttp.Request.hash request, request )
+                    )
+                |> ToJsPayload.DoHttp
                 |> Codec.encoder (ToJsPayload.successCodecNew2 canonicalSiteUrl "")
                 |> config.toJsPort
                 |> Cmd.map never
@@ -349,10 +354,7 @@ nextStepToEffect model nextStep =
             ( { model
                 | staticResponses = updatedStaticResponsesModel
               }
-            , (httpRequests
-                |> List.map Effect.FetchHttp
-              )
-                |> Effect.Batch
+            , Effect.FetchHttp httpRequests
             )
 
         StaticResponses.Finish () ->

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

@@ -89,7 +89,7 @@ headCodec canonicalSiteUrl currentPagePath =
 type ToJsSuccessPayloadNewCombined
     = PageProgress ToJsSuccessPayloadNew
     | SendApiResponse { body : Json.Encode.Value, staticHttpCache : Dict String String, statusCode : Int }
-    | DoHttp String Pages.StaticHttp.Request.Request
+    | DoHttp (List ( String, Pages.StaticHttp.Request.Request ))
     | Port String
     | Errors (List BuildError)
     | ApiResponse
@@ -109,8 +109,8 @@ successCodecNew2 canonicalSiteUrl currentPagePath =
                 PageProgress payload ->
                     success payload
 
-                DoHttp hash requestUrl ->
-                    vDoHttp hash requestUrl
+                DoHttp hashRequestPairs ->
+                    vDoHttp hashRequestPairs
 
                 SendApiResponse record ->
                     vSendApiResponse record
@@ -121,10 +121,7 @@ successCodecNew2 canonicalSiteUrl currentPagePath =
         |> Codec.variant1 "Errors" Errors errorCodec
         |> Codec.variant0 "ApiResponse" ApiResponse
         |> Codec.variant1 "PageProgress" PageProgress (successCodecNew canonicalSiteUrl currentPagePath)
-        |> Codec.variant2 "DoHttp"
-            DoHttp
-            Codec.string
-            Pages.StaticHttp.Request.codec
+        |> Codec.variant1 "DoHttp" DoHttp (Codec.list (Codec.tuple Codec.string Pages.StaticHttp.Request.codec))
         |> Codec.variant1 "ApiResponse"
             SendApiResponse
             (Codec.object (\body staticHttpCache statusCode -> { body = body, staticHttpCache = staticHttpCache, statusCode = statusCode })

package/src/Pages/Script.elm

@@ -34,7 +34,7 @@ import BackendTask.Http
 import BackendTask.Internal.Request
 import Cli.OptionsParser as OptionsParser
 import Cli.Program as Program
-import FatalError exposing (FatalError, Recoverable)
+import FatalError exposing (FatalError)
 import Json.Decode as Decode
 import Json.Encode as Encode
 import Pages.Internal.Script
@@ -52,7 +52,7 @@ type Error
 
 
 {-| -}
-writeFile : { path : String, body : String } -> BackendTask (Recoverable Error) ()
+writeFile : { path : String, body : String } -> BackendTask { fatal : FatalError, recoverable : Error } ()
 writeFile { path, body } =
     BackendTask.Internal.Request.request
         { name = "write-file"

package/src/Server/Request.elm

@@ -903,7 +903,7 @@ formDataWithServerValidation formParsers =
                                         case ( maybeParsed, errors2 |> Dict.toList |> List.filter (\( _, value ) -> value |> List.isEmpty |> not) |> List.NonEmpty.fromList ) of
                                             ( Just decodedFinal, Nothing ) ->
                                                 Ok
-                                                    ( Form.Response
+                                                    ( Pages.Internal.Form.Response
                                                         { fields = rawFormData_
                                                         , errors = Dict.empty
                                                         }
@@ -912,7 +912,7 @@ formDataWithServerValidation formParsers =
 
                                             ( _, maybeErrors ) ->
                                                 Err
-                                                    (Form.Response
+                                                    (Pages.Internal.Form.Response
                                                         { fields = rawFormData_
                                                         , errors =
                                                             maybeErrors
@@ -926,7 +926,7 @@ formDataWithServerValidation formParsers =
 
                     ( _, maybeErrors ) ->
                         Err
-                            (Form.Response
+                            (Pages.Internal.Form.Response
                                 { fields = rawFormData_
                                 , errors =
                                     maybeErrors
@@ -943,7 +943,7 @@ formDataWithServerValidation formParsers =
 {-| -}
 formData :
     Form.ServerForms error combined
-    -> Parser (Result { fields : List ( String, String ), errors : Dict String (List error) } combined)
+    -> Parser ( Form.Response error, Result { fields : List ( String, String ), errors : Dict String (List error) } combined )
 formData formParsers =
     rawFormData
         |> andThen
@@ -956,18 +956,26 @@ formData formParsers =
                 in
                 case ( maybeDecoded, errors |> Dict.toList |> List.filter (\( _, value ) -> value |> List.isEmpty |> not) |> List.NonEmpty.fromList ) of
                     ( Just decoded, Nothing ) ->
-                        Ok decoded
+                        ( Pages.Internal.Form.Response { fields = [], errors = Dict.empty }
+                        , Ok decoded
+                        )
                             |> succeed
 
                     ( _, maybeErrors ) ->
-                        Err
-                            { fields = rawFormData_
-                            , errors =
-                                maybeErrors
-                                    |> Maybe.map List.NonEmpty.toList
-                                    |> Maybe.withDefault []
-                                    |> Dict.fromList
-                            }
+                        let
+                            record : { fields : List ( String, String ), errors : Dict String (List error) }
+                            record =
+                                { fields = rawFormData_
+                                , errors =
+                                    maybeErrors
+                                        |> Maybe.map List.NonEmpty.toList
+                                        |> Maybe.withDefault []
+                                        |> Dict.fromList
+                                }
+                        in
+                        ( Pages.Internal.Form.Response record
+                        , Err record
+                        )
                             |> succeed
             )