elm-pages 3.0.0-beta.8 → 3.0.0

package/src/Pages/Internal/ResponseSketch.elm

@@ -7,7 +7,7 @@ module Pages.Internal.ResponseSketch exposing (ResponseSketch(..))
 -}
 
 import Pages.Internal.NotFoundReason exposing (NotFoundReason)
-import Path exposing (Path)
+import UrlPath exposing (UrlPath)
 
 
 {-| -}
@@ -15,5 +15,5 @@ type ResponseSketch data action shared
     = RenderPage data (Maybe action)
     | HotUpdate data shared (Maybe action)
     | Redirect String
-    | NotFound { reason : NotFoundReason, path : Path }
+    | NotFound { reason : NotFoundReason, path : UrlPath }
     | Action action

package/src/Pages/Internal/Script.elm

@@ -0,0 +1,17 @@
+module Pages.Internal.Script exposing (Script(..))
+
+import BackendTask exposing (BackendTask)
+import Cli.Program as Program
+import FatalError exposing (FatalError)
+import Html exposing (Html)
+
+
+{-| -}
+type Script
+    = Script
+        ((Maybe { indent : Int, newLines : Bool }
+          -> Html Never
+          -> String
+         )
+         -> Program.Config (BackendTask FatalError ())
+        )

package/src/Pages/Internal/StaticHttpBody.elm

@@ -1,6 +1,9 @@
 module Pages.Internal.StaticHttpBody exposing (Body(..), codec, encode)
 
+import Base64
+import Bytes exposing (Bytes)
 import Codec exposing (Codec)
+import Json.Decode
 import Json.Encode as Encode
 
 
@@ -8,6 +11,7 @@ type Body
     = EmptyBody
     | StringBody String String
     | JsonBody Encode.Value
+    | BytesBody String Bytes
 
 
 encode : Body -> Encode.Value
@@ -26,6 +30,15 @@ encode body =
                 [ ( "content", content )
                 ]
 
+        BytesBody _ content ->
+            encodeWithType "bytes"
+                [ ( "content"
+                  , Base64.fromBytes content
+                        |> Maybe.withDefault ""
+                        |> Encode.string
+                  )
+                ]
+
 
 encodeWithType : String -> List ( String, Encode.Value ) -> Encode.Value
 encodeWithType typeName otherFields =
@@ -37,7 +50,7 @@ encodeWithType typeName otherFields =
 codec : Codec Body
 codec =
     Codec.custom
-        (\vEmpty vString vJson value ->
+        (\vEmpty vString vJson vBytes value ->
             case value of
                 EmptyBody ->
                     vEmpty
@@ -47,8 +60,29 @@ codec =
 
                 JsonBody body ->
                     vJson body
+
+                BytesBody contentType body ->
+                    vBytes contentType body
         )
         |> Codec.variant0 "EmptyBody" EmptyBody
         |> Codec.variant2 "StringBody" StringBody Codec.string Codec.string
         |> Codec.variant1 "JsonBody" JsonBody Codec.value
+        |> Codec.variant2 "BytesBody" BytesBody Codec.string bytesCodec
         |> Codec.buildCustom
+
+
+bytesCodec : Codec Bytes
+bytesCodec =
+    Codec.build (Base64.fromBytes >> Maybe.withDefault "" >> Encode.string)
+        (Json.Decode.string
+            |> Json.Decode.map Base64.toBytes
+            |> Json.Decode.andThen
+                (\decodedBytes ->
+                    case decodedBytes of
+                        Just bytes ->
+                            Json.Decode.succeed bytes
+
+                        Nothing ->
+                            Json.Decode.fail "Couldn't parse bytes."
+                )
+        )

package/src/Pages/Manifest.elm

@@ -2,6 +2,7 @@ module Pages.Manifest exposing
     ( Config, Icon
     , init
     , withBackgroundColor, withCategories, withDisplayMode, withIarcRatingId, withLang, withOrientation, withShortName, withThemeColor
+    , withField
     , DisplayMode(..), Orientation(..), IconPurpose(..)
     , generator
     , toJson
@@ -10,8 +11,8 @@ module Pages.Manifest exposing
 {-| Represents the configuration of a
 [web manifest file](https://developer.mozilla.org/en-US/docs/Web/Manifest).
 
-You pass your `Pages.Manifest.Config` record into the `Pages.application` function
-(from your generated `Pages.elm` file).
+You pass your `Pages.Manifest.Config` record into the `Pages.Manifest.generator`
+in your `app/Api.elm` module to define a file generator that will build a `manifest.json` file as part of your build.
 
     import Pages.Manifest as Manifest
     import Pages.Manifest.Category
@@ -41,6 +42,11 @@ You pass your `Pages.Manifest.Config` record into the `Pages.application` functi
 @docs withBackgroundColor, withCategories, withDisplayMode, withIarcRatingId, withLang, withOrientation, withShortName, withThemeColor
 
 
+## Arbitrary Fields Escape Hatch
+
+@docs withField
+
+
 ## Config options
 
 @docs DisplayMode, Orientation, IconPurpose
@@ -58,9 +64,11 @@ You pass your `Pages.Manifest.Config` record into the `Pages.application` functi
 -}
 
 import ApiRoute
+import BackendTask exposing (BackendTask)
 import Color exposing (Color)
 import Color.Convert
-import DataSource exposing (DataSource)
+import Dict exposing (Dict)
+import FatalError exposing (FatalError)
 import Head
 import Json.Encode as Encode
 import LanguageTag exposing (LanguageTag, emptySubtags)
@@ -69,7 +77,7 @@ import LanguageTag.Language
 import MimeType
 import Pages.Manifest.Category as Category exposing (Category)
 import Pages.Url
-import Path exposing (Path)
+import UrlPath exposing (UrlPath)
 
 
 
@@ -106,7 +114,7 @@ type Orientation
 init :
     { description : String
     , name : String
-    , startUrl : Path
+    , startUrl : UrlPath
     , icons : List Icon
     }
     -> Config
@@ -123,6 +131,7 @@ init options =
     , shortName = Nothing
     , icons = options.icons
     , lang = usEnglish
+    , otherFields = Dict.empty
     }
 
 
@@ -191,6 +200,17 @@ withLang languageTag config =
     { config | lang = languageTag }
 
 
+{-| Escape hatch for specifying fields that aren't exposed through this module otherwise. The possible supported properties
+in a manifest file can change over time, so see [MDN manifest.json docs](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json)
+for a full listing of the current supported properties.
+-}
+withField : String -> Encode.Value -> Config -> Config
+withField name value config =
+    { config
+        | otherFields = config.otherFields |> Dict.insert name value
+    }
+
+
 orientationToString : Orientation -> String
 orientationToString orientation =
     case orientation of
@@ -233,12 +253,13 @@ type alias Config =
     , themeColor : Maybe Color
 
     -- https://developer.mozilla.org/en-US/docs/Web/Manifest/start_url
-    , startUrl : Path
+    , startUrl : UrlPath
 
     -- https://developer.mozilla.org/en-US/docs/Web/Manifest/short_name
     , shortName : Maybe String
     , icons : List Icon
     , lang : LanguageTag
+    , otherFields : Dict String Encode.Value
     }
 
 
@@ -322,18 +343,34 @@ nonEmptyList list =
         Just list
 
 
-{-| A generator for Api.elm to include a manifest.json.
+{-| A generator for `Api.elm` to include a manifest.json. The String argument is the canonical URL of the site.
+
+    module Api exposing (routes)
+
+    import ApiRoute
+    import Pages.Manifest
+
+    routes :
+        BackendTask FatalError (List Route)
+        -> (Maybe { indent : Int, newLines : Bool } -> Html Never -> String)
+        -> List (ApiRoute.ApiRoute ApiRoute.Response)
+    routes getStaticRoutes htmlToString =
+        [ Pages.Manifest.generator
+            Site.canonicalUrl
+            Manifest.config
+        ]
+
 -}
-generator : String -> DataSource Config -> ApiRoute.ApiRoute ApiRoute.Response
+generator : String -> BackendTask FatalError Config -> ApiRoute.ApiRoute ApiRoute.Response
 generator canonicalSiteUrl config =
     ApiRoute.succeed
         (config
-            |> DataSource.map (toJson canonicalSiteUrl >> Encode.encode 0)
+            |> BackendTask.map (toJson canonicalSiteUrl >> Encode.encode 0)
         )
         |> ApiRoute.literal "manifest.json"
         |> ApiRoute.single
         |> ApiRoute.withGlobalHeadTags
-            (DataSource.succeed
+            (BackendTask.succeed
                 [ Head.manifestLink "/manifest.json"
                 ]
             )
@@ -409,7 +446,7 @@ toJson canonicalSiteUrl config =
             |> Maybe.map Encode.string
       )
     , ( "start_url"
-      , Path.toAbsolute config.startUrl
+      , UrlPath.toAbsolute config.startUrl
             |> Encode.string
             |> Just
       )
@@ -420,6 +457,10 @@ toJson canonicalSiteUrl config =
       , Encode.string "/" |> Just
       )
     ]
+        ++ (config.otherFields
+                |> Dict.toList
+                |> List.map (Tuple.mapSecond Just)
+           )
         |> encodeMaybeObject
 
 

package/src/Pages/Navigation.elm

@@ -0,0 +1,85 @@
+module Pages.Navigation exposing (Navigation(..), LoadingState(..))
+
+{-| `elm-pages` maintains a single `Maybe Navigation` state which is accessible from your `Route` modules through `app.navigation`.
+
+You can use it to show a loading indicator while a page is loading:
+
+    import Pages.Navigation as Navigation
+
+    pageLoadingIndicator app =
+        case app.navigation of
+            Just (Navigation.Loading path _) ->
+                Spinner.view
+
+            Nothing ->
+                emptyView
+
+    emptyView : Html msg
+    emptyView =
+        Html.text ""
+
+You can also use it to derive Pending UI or Optimistic UI from a pending form submission:
+
+    import Form
+    import Form.Handler
+    import Pages.Navigation as Navigation
+
+    view app =
+        let
+            optimisticProduct : Maybe Product
+            optimisticProduct =
+                case app.navigation of
+                    Just (Navigation.Submitting formData) ->
+                        formHandler
+                            |> Form.Handler.run formData
+                            |> Form.toResult
+                            |> Result.toMaybe
+
+                    Just (Navigation.LoadAfterSubmit formData path _) ->
+                        formHandler
+                            |> Form.Handler.run formData
+                            |> Form.toResult
+                            |> Result.toMaybe
+
+                    Nothing ->
+                        Nothing
+        in
+        -- our `productsView` function could show a loading spinner (Pending UI),
+        -- or it could assume the product will be created successfully (Optimistic UI) and
+        -- display it as a regular product in the list
+        productsView optimisticProduct app.data.products
+
+    allForms : Form.Handler.Handler String Product
+    allForms =
+        Form.Handler.init identity productForm
+
+    editItemForm : Form.HtmlForm String Product input msg
+    editItemForm =
+        Debug.todo "Form definition here"
+
+@docs Navigation, LoadingState
+
+-}
+
+import Pages.FormData exposing (FormData)
+import UrlPath exposing (UrlPath)
+
+
+{-| Represents the global page navigation state of the app.
+
+  - `Loading` - navigating to a page, for example from a link click, or from a programmatic navigation with `Browser.Navigation.pushUrl`.
+  - `Submitting` - submitting a form using the default submission strategy (note that Forms rendered with the [`Pages.Form.withConcurrent`](Pages-Form#withConcurrent) Option have their state managed in `app.concurrentSubmissions` instead of `app.navigation`).
+  - `LoadAfterSubmit` - the state immediately after `Submitting` - allows you to continue using the `FormData` from a submission while a data reload or redirect is occurring.
+
+-}
+type Navigation
+    = Submitting FormData
+    | LoadAfterSubmit FormData UrlPath LoadingState
+    | Loading UrlPath LoadingState
+
+
+{-| -}
+type LoadingState
+    = Redirecting
+    | Load
+    | ActionRedirect

package/src/Pages/PageUrl.elm

@@ -1,18 +1,21 @@
-module Pages.PageUrl exposing (PageUrl, toUrl)
+module Pages.PageUrl exposing
+    ( PageUrl, toUrl
+    , parseQueryParams
+    )
 
-{-| Same as a Url in `elm/url`, but slightly more structured. The path portion of the URL is parsed into a [`Path`](Path) type, and
-the query params use the [`QueryParams`](QueryParams) type which allows you to parse just the query params or access them into a Dict.
-
-Because `elm-pages` takes care of the main routing for pages in your app, the standard Elm URL parser API isn't suited
-to parsing query params individually, which is why the structure of these types is different.
+{-| Same as a Url in `elm/url`, but slightly more structured. The path portion of the URL is parsed into a `List String` representing each segment, and
+the query params are parsed into a `Dict String (List String)`.
 
 @docs PageUrl, toUrl
 
+@docs parseQueryParams
+
 -}
 
-import Path exposing (Path)
-import QueryParams exposing (QueryParams)
+import Dict exposing (Dict)
+import QueryParams
 import Url
+import UrlPath exposing (UrlPath)
 
 
 {-| -}
@@ -20,8 +23,8 @@ type alias PageUrl =
     { protocol : Url.Protocol
     , host : String
     , port_ : Maybe Int
-    , path : Path
-    , query : Maybe QueryParams
+    , path : UrlPath
+    , query : Dict String (List String)
     , fragment : Maybe String
     }
 
@@ -32,7 +35,18 @@ toUrl url =
     { protocol = url.protocol
     , host = url.host
     , port_ = url.port_
-    , path = url.path |> Path.toRelative
-    , query = url.query |> Maybe.map QueryParams.toString
+    , path = url.path |> UrlPath.toRelative
+    , query =
+        if url.query |> Dict.isEmpty then
+            Nothing
+
+        else
+            url.query |> QueryParams.toString |> Just
     , fragment = url.fragment
     }
+
+
+{-| -}
+parseQueryParams : String -> Dict String (List String)
+parseQueryParams =
+    QueryParams.fromString

package/src/Pages/ProgramConfig.elm

@@ -1,32 +1,34 @@
-module Pages.ProgramConfig exposing (ProgramConfig)
+module Pages.ProgramConfig exposing (FormData, ProgramConfig)
 
 import ApiRoute
+import BackendTask exposing (BackendTask)
 import Browser.Navigation
 import Bytes exposing (Bytes)
 import Bytes.Decode
 import Bytes.Encode
-import DataSource exposing (DataSource)
 import Dict exposing (Dict)
-import Form.FormData exposing (FormData)
+import FatalError exposing (FatalError)
+import Form
 import Head
 import Html exposing (Html)
 import Http
 import Json.Decode as Decode
 import Json.Encode
 import PageServerResponse exposing (PageServerResponse)
+import Pages.ConcurrentSubmission
 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)
 import Pages.Internal.RoutePattern exposing (RoutePattern)
-import Pages.Msg
+import Pages.Navigation
 import Pages.PageUrl exposing (PageUrl)
 import Pages.SiteConfig exposing (SiteConfig)
-import Pages.Transition
-import Path exposing (Path)
+import PagesMsg exposing (PagesMsg)
+import Server.Request
 import Url exposing (Url)
+import UrlPath exposing (UrlPath)
 
 
 type alias ProgramConfig userMsg userModel route pageData actionData sharedData effect mappedMsg errorPage =
@@ -38,7 +40,7 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
         ->
             Maybe
                 { path :
-                    { path : Path
+                    { path : UrlPath
                     , query : Maybe String
                     , fragment : Maybe String
                     }
@@ -46,18 +48,18 @@ 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 )
-    , subscriptions : route -> Path -> userModel -> Sub userMsg
-    , sharedData : DataSource sharedData
-    , data : route -> DataSource (PageServerResponse pageData errorPage)
-    , action : route -> DataSource (PageServerResponse actionData errorPage)
+    , update : Form.Model -> Dict String (Pages.ConcurrentSubmission.ConcurrentSubmission actionData) -> Maybe Pages.Navigation.Navigation -> sharedData -> pageData -> Maybe Browser.Navigation.Key -> userMsg -> userModel -> ( userModel, effect )
+    , subscriptions : route -> UrlPath -> userModel -> Sub userMsg
+    , sharedData : BackendTask FatalError sharedData
+    , data : Server.Request.Request -> route -> BackendTask FatalError (PageServerResponse pageData errorPage)
+    , action : Server.Request.Request -> route -> BackendTask FatalError (PageServerResponse actionData errorPage)
     , onActionData : actionData -> Maybe userMsg
     , view :
-        Pages.FormState.PageFormState
-        -> Dict String (Pages.Transition.FetcherState actionData)
-        -> Maybe Pages.Transition.Transition
+        Form.Model
+        -> Dict String (Pages.ConcurrentSubmission.ConcurrentSubmission actionData)
+        -> Maybe Pages.Navigation.Navigation
         ->
-            { path : Path
+            { path : UrlPath
             , route : route
             }
         -> Maybe PageUrl
@@ -65,11 +67,11 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
         -> pageData
         -> Maybe actionData
         ->
-            { view : userModel -> { title : String, body : List (Html (Pages.Msg.Msg userMsg)) }
+            { view : userModel -> { title : String, body : List (Html (PagesMsg userMsg)) }
             , head : List Head.Tag
             }
-    , handleRoute : route -> DataSource (Maybe NotFoundReason)
-    , getStaticRoutes : DataSource (List route)
+    , handleRoute : route -> BackendTask FatalError (Maybe NotFoundReason)
+    , getStaticRoutes : BackendTask FatalError (List route)
     , urlToRoute : Url -> route
     , routeToPath : route -> List String
     , site : Maybe SiteConfig
@@ -81,7 +83,7 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
         { protocol : Url.Protocol
         , host : String
         , port_ : Maybe Int
-        , path : Path
+        , path : UrlPath
         , query : Maybe String
         , fragment : Maybe String
         , metadata : route
@@ -101,7 +103,7 @@ type alias ProgramConfig userMsg userModel route pageData actionData sharedData
     , encodeResponse : ResponseSketch pageData actionData sharedData -> Bytes.Encode.Encoder
     , encodeAction : actionData -> Bytes.Encode.Encoder
     , decodeResponse : Bytes.Decode.Decoder (ResponseSketch pageData actionData sharedData)
-    , globalHeadTags : Maybe ((Maybe { indent : Int, newLines : Bool } -> Html Never -> String) -> DataSource (List Head.Tag))
+    , globalHeadTags : Maybe ((Maybe { indent : Int, newLines : Bool } -> Html Never -> String) -> BackendTask FatalError (List Head.Tag))
     , cmdToEffect : Cmd userMsg -> effect
     , perform :
         { fetchRouteData :
@@ -127,3 +129,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
+    }