elm-pages 3.0.0-beta.8 → 3.0.0-beta.9

package/src/Pages/Generate.elm

@@ -1,5 +1,5 @@
 module Pages.Generate exposing
-    ( buildWithLocalState, buildNoState, Builder
+    ( buildWithLocalState, buildWithSharedState, buildNoState, Builder
     , Type(..)
     , serverRender
     , preRender, single
@@ -10,7 +10,7 @@ module Pages.Generate exposing
 
 ## Initializing the Generator Builder
 
-@docs buildWithLocalState, buildNoState, Builder
+@docs buildWithLocalState, buildWithSharedState, buildNoState, Builder
 
 @docs Type
 
@@ -190,6 +190,7 @@ buildWithLocalState definitions builder_ =
                         { update = definitions.update
                         , init = definitions.init
                         , subscriptions = definitions.subscriptions
+                        , state = LocalState
                         }
                 , data = builder.data |> Tuple.second
                 , action = builder.action |> Tuple.second |> Action
@@ -210,6 +211,7 @@ buildWithLocalState definitions builder_ =
                         { update = definitions.update
                         , init = definitions.init
                         , subscriptions = definitions.subscriptions
+                        , state = LocalState
                         }
                 , data = builder.data |> Tuple.second
                 , action = builder.pages |> Pages
@@ -228,6 +230,72 @@ buildWithLocalState definitions builder_ =
                 }
 
 
+{-| -}
+buildWithSharedState :
+    { view : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
+    , update : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
+    , init : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
+    , subscriptions : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
+    , msg : Type
+    , model : Type
+    }
+    -> Builder
+    -> Elm.File
+buildWithSharedState definitions builder_ =
+    case builder_ of
+        ServerRender builder ->
+            userFunction builder.moduleName
+                { view = definitions.view
+                , localState =
+                    Just
+                        { update = definitions.update
+                        , init = definitions.init
+                        , subscriptions = definitions.subscriptions
+                        , state = SharedState
+                        }
+                , data = builder.data |> Tuple.second
+                , action = builder.action |> Tuple.second |> Action
+                , head = builder.head
+                , types =
+                    { model = definitions.model
+                    , msg = definitions.msg
+                    , data = builder.data |> Tuple.first
+                    , actionData = builder.action |> Tuple.first
+                    }
+                }
+
+        PreRender builder ->
+            userFunction builder.moduleName
+                { view = definitions.view
+                , localState =
+                    Just
+                        { update = definitions.update
+                        , init = definitions.init
+                        , subscriptions = definitions.subscriptions
+                        , state = SharedState
+                        }
+                , data = builder.data |> Tuple.second
+                , action = builder.pages |> Pages
+                , head = builder.head
+                , types =
+                    { model = definitions.model
+                    , msg = definitions.msg
+                    , data = builder.data |> Tuple.first
+                    , actionData =
+                        Elm.Annotation.namedWith [ "DataSource" ]
+                            "DataSource"
+                            [ Elm.Annotation.list (Elm.Annotation.named [] "RouteParams")
+                            ]
+                            |> Alias
+                    }
+                }
+
+
+type State
+    = SharedState
+    | LocalState
+
+
 type ActionOrPages
     = Action (Elm.Expression -> Elm.Expression)
     | Pages (Maybe Elm.Expression)
@@ -243,6 +311,7 @@ userFunction :
                 { update : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
                 , init : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
                 , subscriptions : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression
+                , state : State
                 }
         , data : Elm.Expression -> Elm.Expression
         , action : ActionOrPages
@@ -309,6 +378,7 @@ userFunction moduleName definitions =
                     }
                 , initFn : { declaration : Elm.Declaration, call : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression, callFrom : List String -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression }
                 , subscriptionsFn : { declaration : Elm.Declaration, call : Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression, callFrom : List String -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression -> Elm.Expression }
+                , state : State
                 }
         localDefinitions =
             definitions.localState
@@ -351,6 +421,7 @@ userFunction moduleName definitions =
                                 ( "sharedModel", Nothing )
                                 ( "model", Nothing )
                                 localState.subscriptions
+                        , state = localState.state
                         }
                     )
 
@@ -512,6 +583,7 @@ userFunction moduleName definitions =
                                         , update = local.updateFn.call
                                         , init = local.initFn.call
                                         , subscriptions = local.subscriptionsFn.call
+                                        , state = local.state
                                         }
                                         >> Elm.withType
                                             (Elm.Annotation.namedWith [ "RouteBuilder" ]
@@ -837,6 +909,7 @@ buildWithLocalState_ :
         -> Elm.Expression
         -> Elm.Expression
         -> Elm.Expression
+    , state : State
     }
     -> Elm.Expression
     -> Elm.Expression
@@ -844,7 +917,13 @@ buildWithLocalState_ buildWithLocalStateArg buildWithLocalStateArg0 =
     Elm.apply
         (Elm.value
             { importFrom = [ "RouteBuilder" ]
-            , name = "buildWithLocalState"
+            , name =
+                case buildWithLocalStateArg.state of
+                    LocalState ->
+                        "buildWithLocalState"
+
+                    SharedState ->
+                        "buildWithSharedState"
             , annotation =
                 Just
                     (Elm.Annotation.function
@@ -920,13 +999,25 @@ buildWithLocalState_ buildWithLocalStateArg buildWithLocalStateArg0 =
                                     , Elm.Annotation.var "msg"
                                     , Elm.Annotation.var "model"
                                     ]
-                                    (Elm.Annotation.tuple
-                                        (Elm.Annotation.var "model")
-                                        (Elm.Annotation.namedWith
-                                            [ "Effect" ]
-                                            "Effect"
-                                            [ Elm.Annotation.var "msg" ]
-                                        )
+                                    (case buildWithLocalStateArg.state of
+                                        LocalState ->
+                                            Elm.Annotation.tuple
+                                                (Elm.Annotation.var "model")
+                                                (Elm.Annotation.namedWith
+                                                    [ "Effect" ]
+                                                    "Effect"
+                                                    [ Elm.Annotation.var "msg" ]
+                                                )
+
+                                        SharedState ->
+                                            Elm.Annotation.triple
+                                                (Elm.Annotation.var "model")
+                                                (Elm.Annotation.namedWith
+                                                    [ "Effect" ]
+                                                    "Effect"
+                                                    [ Elm.Annotation.var "msg" ]
+                                                )
+                                                (Elm.Annotation.maybe (Elm.Annotation.named [ "Shared" ] "Msg"))
                                     )
                               )
                             , ( "subscriptions"

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

@@ -1,8 +1,8 @@
-module Pages.Internal.Platform.Cli exposing (Flags, Model, Msg(..), Program, cliApplication, init, requestDecoder, update)
+module Pages.Internal.Platform.Cli exposing (Flags, Model, Msg(..), Program, cliApplication, init, requestDecoder, update, currentCompatibilityKey)
 
 {-| Exposed for internal use only (used in generated code).
 
-@docs Flags, Model, Msg, Program, cliApplication, init, requestDecoder, update
+@docs Flags, Model, Msg, Program, cliApplication, init, requestDecoder, update, currentCompatibilityKey
 
 -}
 
@@ -23,6 +23,7 @@ import PageServerResponse exposing (PageServerResponse)
 import Pages.Flags
 import Pages.Http
 import Pages.Internal.NotFoundReason as NotFoundReason exposing (NotFoundReason)
+import Pages.Internal.Platform.CompatibilityKey
 import Pages.Internal.Platform.Effect as Effect exposing (Effect)
 import Pages.Internal.Platform.StaticResponses as StaticResponses exposing (StaticResponses)
 import Pages.Internal.Platform.ToJsPayload as ToJsPayload
@@ -46,6 +47,12 @@ type alias Flags =
     Decode.Value
 
 
+{-| -}
+currentCompatibilityKey : Int
+currentCompatibilityKey =
+    Pages.Internal.Platform.CompatibilityKey.currentCompatibilityKey
+
+
 {-| -}
 type alias Model route =
     { staticResponses : StaticResponses
@@ -336,12 +343,14 @@ flagsDecoder :
     Decode.Decoder
         { staticHttpCache : RequestsAndPending
         , isDevServer : Bool
+        , compatibilityKey : Int
         }
 flagsDecoder =
-    Decode.map2
-        (\staticHttpCache isDevServer ->
+    Decode.map3
+        (\staticHttpCache isDevServer compatibilityKey ->
             { staticHttpCache = staticHttpCache
             , isDevServer = isDevServer
+            , compatibilityKey = compatibilityKey
             }
         )
         --(Decode.field "staticHttpCache"
@@ -354,6 +363,7 @@ flagsDecoder =
         -- TODO remove hardcoding and decode staticHttpCache here
         (Decode.succeed Dict.empty)
         (Decode.field "mode" Decode.string |> Decode.map (\mode -> mode == "dev-server"))
+        (Decode.field "compatibilityKey" Decode.int)
 
 
 {-| -}
@@ -365,8 +375,42 @@ init :
     -> ( Model route, Effect )
 init site renderRequest config flags =
     case Decode.decodeValue flagsDecoder flags of
-        Ok { staticHttpCache, isDevServer } ->
-            initLegacy site renderRequest { staticHttpCache = staticHttpCache, isDevServer = isDevServer } config
+        Ok { staticHttpCache, isDevServer, compatibilityKey } ->
+            if compatibilityKey == currentCompatibilityKey then
+                initLegacy site renderRequest { staticHttpCache = staticHttpCache, isDevServer = isDevServer } config
+
+            else
+                let
+                    elmPackageAheadOfNpmPackage : Bool
+                    elmPackageAheadOfNpmPackage =
+                        currentCompatibilityKey > compatibilityKey
+
+                    message : String
+                    message =
+                        "The NPM package and Elm package you have installed are incompatible. If you are updating versions, be sure to update both the elm-pages Elm and NPM package.\n\n"
+                            ++ (if elmPackageAheadOfNpmPackage then
+                                    "The elm-pages Elm package is ahead of the elm-pages NPM package. Try updating the elm-pages NPM package?"
+
+                                else
+                                    "The elm-pages NPM package is ahead of the elm-pages Elm package. Try updating the elm-pages Elm package?"
+                               )
+                in
+                updateAndSendPortIfDone
+                    site
+                    config
+                    { staticResponses = StaticResponses.empty
+                    , errors =
+                        [ { title = "Incompatible NPM and Elm package versions"
+                          , message = [ Terminal.text <| message ]
+                          , fatal = True
+                          , path = ""
+                          }
+                        ]
+                    , allRawResponses = Dict.empty
+                    , unprocessedPages = []
+                    , maybeRequestJson = renderRequest
+                    , isDevServer = False
+                    }
 
         Err error ->
             updateAndSendPortIfDone