elm-pages 3.0.0-beta.20 → 3.0.0-beta.21

package/generator/template/app/Shared.elm

@@ -1,9 +1,9 @@
 module Shared exposing (Data, Model, Msg(..), SharedMsg(..), template)
 
-import Browser.Navigation
-import BackendTask
+import BackendTask exposing (BackendTask)
+import Effect exposing (Effect)
+import FatalError exposing (FatalError)
 import Html exposing (Html)
-import Html.Events
 import Pages.Flags
 import Pages.PageUrl exposing (PageUrl)
 import Path exposing (Path)
@@ -19,13 +19,16 @@ template =
     , view = view
     , data = data
     , subscriptions = subscriptions
-    , onPageChange = Nothing
+    , onPageChange = Just OnPageChange
     }
 
 
 type Msg
-    = SharedMsg SharedMsg
-    | MenuClicked
+    = OnPageChange
+        { path : Path
+        , query : Maybe String
+        , fragment : Maybe String
+        }
 
 
 type alias Data =
@@ -37,13 +40,12 @@ type SharedMsg
 
 
 type alias Model =
-    { showMenu : Bool
+    { showMobileMenu : Bool
     }
 
 
 init :
-    Maybe Browser.Navigation.Key
-    -> Pages.Flags.Flags
+    Pages.Flags.Flags
     ->
         Maybe
             { path :
@@ -54,21 +56,18 @@ init :
             , metadata : route
             , pageUrl : Maybe PageUrl
             }
-    -> ( Model, Cmd Msg )
-init navigationKey flags maybePagePath =
-    ( { showMenu = False }
-    , Cmd.none
+    -> ( Model, Effect Msg )
+init flags maybePagePath =
+    ( { showMobileMenu = False }
+    , Effect.none
     )
 
 
-update : Msg -> Model -> ( Model, Cmd Msg )
+update : Msg -> Model -> ( Model, Effect Msg )
 update msg model =
     case msg of
-        SharedMsg globalMsg ->
-            ( model, Cmd.none )
-
-        MenuClicked ->
-            ( { model | showMenu = not model.showMenu }, Cmd.none )
+        OnPageChange _ ->
+            ( { model | showMobileMenu = False }, Effect.none )
 
 
 subscriptions : Path -> Model -> Sub Msg
@@ -76,7 +75,7 @@ subscriptions _ _ =
     Sub.none
 
 
-data : BackendTask.BackendTask Data
+data : BackendTask FatalError Data
 data =
     BackendTask.succeed ()
 
@@ -90,32 +89,10 @@ view :
     -> Model
     -> (Msg -> msg)
     -> View msg
-    -> { body : Html msg, title : String }
-view sharedData page model toMsg pageView =
+    -> { body : List (Html msg), title : String }
+view stars page model toMsg pageView =
     { body =
-        Html.div []
-            [ Html.nav []
-                [ Html.button
-                    [ Html.Events.onClick MenuClicked ]
-                    [ Html.text
-                        (if model.showMenu then
-                            "Close Menu"
-
-                         else
-                            "Open Menu"
-                        )
-                    ]
-                , if model.showMenu then
-                    Html.ul []
-                        [ Html.li [] [ Html.text "Menu item 1" ]
-                        , Html.li [] [ Html.text "Menu item 2" ]
-                        ]
-
-                  else
-                    Html.text ""
-                ]
-                |> Html.map toMsg
-            , Html.main_ [] pageView.body
-            ]
+        [ Html.div [] pageView.body
+        ]
     , title = pageView.title
     }

package/generator/template/app/Site.elm

@@ -1,18 +1,21 @@
-module Site exposing (config)
+module Site exposing (canonicalUrl, config)
 
 import BackendTask exposing (BackendTask)
+import FatalError exposing (FatalError)
 import Head
+import MimeType
+import Pages.Url
 import SiteConfig exposing (SiteConfig)
 
 
 config : SiteConfig
 config =
-    { canonicalUrl = "https://elm-pages.com"
+    { canonicalUrl = canonicalUrl
     , head = head
     }
 
 
-head : BackendTask (List Head.Tag)
+head : BackendTask FatalError (List Head.Tag)
 head =
     [ Head.metaName "viewport" (Head.raw "width=device-width,initial-scale=1")
     , Head.metaName "mobile-web-app-capable" (Head.raw "yes")
@@ -22,3 +25,8 @@ head =
     , Head.sitemapLink "/sitemap.xml"
     ]
         |> BackendTask.succeed
+
+
+canonicalUrl : String
+canonicalUrl =
+    "https://elm-pages.com"

package/generator/template/app/View.elm

@@ -1,4 +1,4 @@
-module View exposing (View, map, placeholder)
+module View exposing (View, map)
 
 import Html exposing (Html)
 
@@ -14,10 +14,3 @@ map fn doc =
     { title = doc.title
     , body = List.map (Html.map fn) doc.body
     }
-
-
-placeholder : String -> View msg
-placeholder moduleName =
-    { title = "Placeholder - " ++ moduleName
-    , body = [ Html.text moduleName ]
-    }

package/generator/template/elm-tooling.json

@@ -1,7 +1,4 @@
 {
-    "entrypoints": [
-        "./src/Main.elm"
-    ],
     "tools": {
         "elm": "0.19.1",
         "elm-format": "0.8.5"

package/generator/template/elm.json

@@ -8,49 +8,58 @@
     "elm-version": "0.19.1",
     "dependencies": {
         "direct": {
-            "dillonkearns/elm-pages": "9.0.0",
-            "elm/browser": "1.0.2",
-            "elm/core": "1.0.5",
-            "elm/html": "1.0.0",
-            "elm/json": "1.1.3",
-            "elm/url": "1.0.0"
-        },
-        "indirect": {
-            "MartinSStewart/elm-serialize": "1.2.6",
             "avh4/elm-color": "1.0.0",
-            "bburdette/toop": "1.2.0",
             "danfishgold/base64-bytes": "1.1.0",
             "danyx23/elm-mimetype": "4.0.1",
             "dillonkearns/elm-bcp47-language-tag": "1.0.1",
+            "dillonkearns/elm-markdown": "7.0.1",
+            "dillonkearns/elm-pages-v3-beta": "12.0.0",
+            "elm/browser": "1.0.2",
             "elm/bytes": "1.0.8",
-            "elm/file": "1.0.5",
+            "elm/core": "1.0.5",
+            "elm/html": "1.0.0",
             "elm/http": "2.0.0",
+            "elm/json": "1.1.3",
             "elm/parser": "1.1.0",
-            "elm/project-metadata-utils": "1.0.2",
-            "elm/random": "1.0.0",
             "elm/regex": "1.0.0",
             "elm/time": "1.0.0",
-            "elm/virtual-dom": "1.0.2",
+            "elm/url": "1.0.0",
+            "elm/virtual-dom": "1.0.3",
             "elm-community/dict-extra": "2.4.0",
-            "elm-community/list-extra": "8.5.1",
-            "elm-explorations/test": "1.2.2",
-            "fredcy/elm-parseint": "2.0.1",
-            "jfmengels/elm-review": "2.6.1",
-            "mgold/elm-nonempty-list": "4.2.0",
+            "elm-community/list-extra": "8.7.0",
+            "elm-community/result-extra": "2.4.0",
+            "jluckyiv/elm-utc-date-strings": "1.0.0",
+            "justinmimbs/date": "4.0.1",
+            "lamdera/codecs": "1.0.0",
+            "mdgriffith/elm-codegen": "2.0.0",
             "miniBill/elm-codec": "2.0.0",
-            "miniBill/elm-unicode": "1.0.2",
             "noahzgordon/elm-color-extra": "1.0.2",
+            "robinheghan/fnv1a": "1.0.0",
+            "rtfeldman/elm-css": "18.0.0",
+            "the-sett/elm-syntax-dsl": "6.0.2",
+            "turboMaCk/non-empty-list-alias": "1.3.1",
+            "vito/elm-ansi": "10.0.1"
+        },
+        "indirect": {
+            "Chadtech/elm-bool-extra": "2.4.2",
+            "dillonkearns/elm-cli-options-parser": "3.2.0",
+            "dillonkearns/elm-date-or-date-time": "2.0.0",
+            "elm/file": "1.0.5",
+            "elm/random": "1.0.0",
+            "elm-community/basics-extra": "4.1.0",
+            "elm-community/maybe-extra": "5.3.0",
+            "fredcy/elm-parseint": "2.0.1",
+            "miniBill/elm-unicode": "1.0.3",
             "robinheghan/murmur3": "1.0.0",
             "rtfeldman/elm-hex": "1.0.0",
-            "stil4m/elm-syntax": "7.2.8",
+            "rtfeldman/elm-iso8601-date-strings": "1.1.4",
+            "stil4m/elm-syntax": "7.2.9",
             "stil4m/structured-writer": "1.0.3",
-            "tripokey/elm-fuzzy": "5.2.1",
-            "vito/elm-ansi": "10.0.1",
-            "zwilias/json-decode-exploration": "6.0.0"
+            "the-sett/elm-pretty-printer": "3.0.0"
         }
     },
     "test-dependencies": {
         "direct": {},
         "indirect": {}
     }
-}
+}

package/generator/template/package.json

@@ -1,14 +1,20 @@
 {
   "name": "elm-pages-app",
+  "type": "module",
   "scripts": {
     "postinstall": "elm-tooling install",
     "start": "elm-pages dev",
     "build": "elm-pages build"
   },
   "devDependencies": {
-    "elm-optimize-level-2": "0.3.4",
-    "elm-pages": "2.1.10",
-    "elm-review": "^2.7.0",
-    "elm-tooling": "^1.7.0"
+    "elm-codegen": "^0.2.0",
+    "elm-optimize-level-2": "^0.3.5",
+    "elm-pages": "^3.0.0-beta.20",
+    "elm-review": "2.8.5",
+    "elm-tooling": "^1.10.0",
+    "vite": "^3.1.8"
+  },
+  "dependencies": {
+    "@netlify/functions": "^1.2.0"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "elm-pages",
   "type": "module",
-  "version": "3.0.0-beta.20",
+  "version": "3.0.0-beta.21",
   "homepage": "https://elm-pages.com",
   "moduleResolution": "node",
   "description": "Type-safe static sites, written in pure elm with your own custom elm-markup syntax.",

package/src/BackendTask/Custom.elm

@@ -1,6 +1,7 @@
 module BackendTask.Custom exposing
     ( run
     , Error(..)
+    , timeDecoder, dateDecoder
     )
 
 {-| In a vanilla Elm application, ports let you either send or receive JSON data between your Elm application and the JavaScript context in the user's browser at runtime.
@@ -73,15 +74,25 @@ There are a few different things that can go wrong when running a custom-backend
 Any time you throw a JavaScript exception from a BackendTask.Custom definition, it will give you a `CustomBackendTaskException`. It's usually easier to add a `try`/`catch` in your JavaScript code in `custom-backend-task.js`
 to handle possible errors, but you can throw a JSON value and handle it in Elm in the `CustomBackendTaskException` call error.
 
+
+## Decoding JS Date Objects
+
+These decoders are for use with decoding JS values of type `Date`. If you have control over the format, it may be better to
+be more explicit with a [Rata Die](https://en.wikipedia.org/wiki/Rata_Die) number value or an ISO-8601 formatted date string instead.
+But often JavaScript libraries and core APIs will give you JS Date objects, so this can be useful for working with those.
+
+@docs timeDecoder, dateDecoder
+
 -}
 
-import BackendTask
+import BackendTask exposing (BackendTask)
 import BackendTask.Http
-import BackendTask.Internal.Request
+import Date
 import FatalError exposing (FatalError)
 import Json.Decode as Decode exposing (Decoder)
 import Json.Encode as Encode
 import TerminalText
+import Time
 
 
 {-| -}
@@ -89,11 +100,10 @@ run :
     String
     -> Encode.Value
     -> Decoder b
-    -> BackendTask.BackendTask { fatal : FatalError, recoverable : Error } b
+    -> BackendTask { fatal : FatalError, recoverable : Error } b
 run portName input decoder =
-    BackendTask.Internal.Request.request
-        { name = "port"
-        , body =
+    request
+        { body =
             Encode.object
                 [ ( "input", input )
                 , ( "portName", Encode.string portName )
@@ -183,6 +193,24 @@ run portName input decoder =
                                                 (CustomBackendTaskException portCallError)
                                         )
 
+                            else if errorKind == "NonJsonException" then
+                                Decode.map2
+                                    (\exceptionMessage stackTrace ->
+                                        FatalError.recoverable
+                                            { title = "Custom BackendTask Error"
+                                            , body =
+                                                [ TerminalText.text "Something went wrong in a call to BackendTask.Custom.run. I was able to import the port definitions file, but when running it I encountered this exception:\n\n"
+                                                , TerminalText.red exceptionMessage
+                                                , TerminalText.text ("\n\n" ++ (stackTrace |> Maybe.withDefault "\n"))
+                                                , TerminalText.text "\n\nYou could add a `try`/`catch` in your `custom-backend-task` JavaScript code to handle that error."
+                                                ]
+                                                    |> TerminalText.toString
+                                            }
+                                            (NonJsonException exceptionMessage)
+                                    )
+                                    (Decode.field "error" Decode.string)
+                                    (Decode.field "stack" (Decode.nullable Decode.string))
+
                             else
                                 FatalError.recoverable
                                     { title = "Custom BackendTask Error"
@@ -211,4 +239,80 @@ type Error
     | MissingCustomBackendTaskFile
     | CustomBackendTaskNotDefined { name : String }
     | CustomBackendTaskException Decode.Value
+    | NonJsonException String
     | ExportIsNotFunction
+    | DecodeError Decode.Error
+
+
+{-| -}
+timeDecoder : Decoder Time.Posix
+timeDecoder =
+    Decode.field "__elm-pages-normalized__"
+        (Decode.field "kind" Decode.string
+            |> Decode.andThen
+                (\kind ->
+                    if kind == "Date" then
+                        Decode.field "value"
+                            (Decode.int |> Decode.map Time.millisToPosix)
+
+                    else
+                        Decode.fail <| "I was running BackendTask.Custom.timeDecoder and expecting an elm-pages normalized Object with kind \"Date\", but got kind \"" ++ kind ++ "\"."
+                )
+        )
+
+
+{-| The same as `timeDecoder`, but it converts the decoded `Time.Posix` value into a `Date` with `Date.fromPosix Time.utc`.
+
+JavaScript `Date` objects don't distinguish between values with only a date vs. values with both a date and a time. So be sure
+to use this decoder when you know the semantics represent a date with no associated time (or you're sure you don't care about the time).
+
+-}
+dateDecoder : Decoder Date.Date
+dateDecoder =
+    Decode.field "__elm-pages-normalized__"
+        (Decode.field "kind" Decode.string
+            |> Decode.andThen
+                (\kind ->
+                    if kind == "Date" then
+                        Decode.field "value"
+                            (Decode.int |> Decode.map (Time.millisToPosix >> Date.fromPosix Time.utc))
+
+                    else
+                        Decode.fail <| "I was running BackendTask.Custom.dateDecoder and expecting an elm-pages normalized Object with kind \"Date\", but got kind \"" ++ kind ++ "\"."
+                )
+        )
+
+
+request :
+    { body : BackendTask.Http.Body
+    , expect : BackendTask.Http.Expect a
+    }
+    -> BackendTask { fatal : FatalError, recoverable : Error } a
+request { body, expect } =
+    -- elm-review: known-unoptimized-recursion
+    BackendTask.Http.request
+        { url = "elm-pages-internal://port"
+        , method = "GET"
+        , headers = []
+        , body = body
+        , timeoutInMs = Nothing
+        , retries = Nothing
+        }
+        expect
+        |> BackendTask.onError
+            (\error ->
+                -- TODO avoid crash here, this should be handled as an internal error
+                --request params
+                case error.recoverable of
+                    BackendTask.Http.BadBody (Just jsonError) _ ->
+                        { recoverable = DecodeError jsonError
+                        , fatal = error.fatal
+                        }
+                            |> BackendTask.fail
+
+                    _ ->
+                        { recoverable = Error
+                        , fatal = error.fatal
+                        }
+                            |> BackendTask.fail
+            )

package/src/Form/Field.elm

@@ -3,7 +3,7 @@ module Form.Field exposing
     , select, range, OutsideRange(..)
     , date, time, TimeOfDay
     , Field(..), FieldInfo, exactValue
-    , required, withClientValidation, withInitialValue, map
+    , required, withClientValidation, withInitialValue, withOptionalInitialValue, map
     , email, password, search, telephone, url, textarea
     , withMax, withMin, withStep, withMinLength, withMaxLength
     , No, Yes
@@ -34,7 +34,7 @@ module Form.Field exposing
 
 ## Field Configuration
 
-@docs required, withClientValidation, withInitialValue, map
+@docs required, withClientValidation, withInitialValue, withOptionalInitialValue, map
 
 
 ## Text Field Display Options
@@ -67,7 +67,7 @@ type Field error parsed data kind constraints
 
 {-| -}
 type alias FieldInfo error parsed data =
-    { initialValue : Maybe (data -> String)
+    { initialValue : Maybe (data -> Maybe String)
     , decode : Maybe String -> ( Maybe parsed, List error )
     , properties : List ( String, Encode.Value )
     }
@@ -327,7 +327,7 @@ exactValue :
             }
 exactValue initialValue error =
     Field
-        { initialValue = Just (\_ -> initialValue)
+        { initialValue = Just (\_ -> Just initialValue)
         , decode =
             \rawValue ->
                 if rawValue == Just initialValue then
@@ -490,10 +490,11 @@ url (Field field _) =
 
 {-| -}
 textarea :
-    Field error parsed data Input { constraints | plainText : () }
+    { rows : Maybe Int, cols : Maybe Int }
+    -> Field error parsed data Input { constraints | plainText : () }
     -> Field error parsed data Input constraints
-textarea (Field field _) =
-    Field field (FieldView.Input FieldView.Textarea)
+textarea options (Field field _) =
+    Field field (FieldView.Input (FieldView.Textarea options))
 
 
 {-| -}
@@ -535,7 +536,7 @@ range info field =
         |> required info.missing
         |> withMin info.min (info.invalid BelowRange)
         |> withMax info.max (info.invalid AboveRange)
-        |> (\(Field innerField _) -> Field { innerField | initialValue = Just (info.initial >> Form.Value.toString) } (FieldView.Input FieldView.Range))
+        |> (\(Field innerField _) -> Field { innerField | initialValue = Just (info.initial >> Form.Value.toString >> Just) } (FieldView.Input FieldView.Range))
 
 
 {-| -}
@@ -576,7 +577,18 @@ withInitialValue toInitialValue (Field field kind) =
     Field
         { field
             | initialValue =
-                Just (toInitialValue >> Form.Value.toString)
+                Just (toInitialValue >> Form.Value.toString >> Just)
+        }
+        kind
+
+
+{-| -}
+withOptionalInitialValue : (data -> Maybe (Form.Value.Value valueType)) -> Field error value data kind { constraints | initial : valueType } -> Field error value data kind constraints
+withOptionalInitialValue toInitialValue (Field field kind) =
+    Field
+        { field
+            | initialValue =
+                Just (toInitialValue >> Maybe.map Form.Value.toString)
         }
         kind
 

package/src/Form/FieldView.elm

@@ -40,7 +40,7 @@ type InputType
     | Password
     | Email
     | Url
-    | Textarea
+    | Textarea { rows : Maybe Int, cols : Maybe Int }
 
 
 {-| -}
@@ -50,7 +50,7 @@ inputTypeToString inputType =
         Text ->
             "text"
 
-        Textarea ->
+        Textarea _ ->
             "text"
 
         Number ->
@@ -122,10 +122,15 @@ input attrs (Validation viewField fieldName _) =
             }
     in
     case rawField.kind of
-        ( Input Textarea, properties ) ->
+        ( Input (Textarea { rows, cols }), properties ) ->
             Html.textarea
                 (attrs
                     ++ toHtmlProperties properties
+                    ++ ([ rows |> Maybe.map Attr.rows
+                        , cols |> Maybe.map Attr.cols
+                        ]
+                            |> List.filterMap identity
+                       )
                     ++ [ Attr.value (rawField.value |> Maybe.withDefault "")
                        , Attr.name rawField.name
                        ]
@@ -170,10 +175,15 @@ inputStyled attrs (Validation viewField fieldName _) =
             }
     in
     case rawField.kind of
-        ( Input Textarea, properties ) ->
+        ( Input (Textarea { rows, cols }), properties ) ->
             Html.Styled.textarea
                 (attrs
                     ++ (toHtmlProperties properties |> List.map StyledAttr.fromUnstyled)
+                    ++ ([ rows |> Maybe.map StyledAttr.rows
+                        , cols |> Maybe.map StyledAttr.cols
+                        ]
+                            |> List.filterMap identity
+                       )
                     ++ ([ Attr.value (rawField.value |> Maybe.withDefault "")
                         , Attr.name rawField.name
                         ]