npm - elm-pages - Versions diffs - 3.0.0-beta.9 → 3.0.0 - Mend

elm-pages 3.0.0-beta.9 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (165) hide show

package/README.md +2 -2
package/adapter/netlify.js +207 -0
package/codegen/{elm-pages-codegen.js → elm-pages-codegen.cjs} +2731 -2939
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Review-DeadCodeEliminateData.elmi +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Review-DeadCodeEliminateData.elmo +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Review-DeadCodeEliminateDataTest.elmo +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/d.dat +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/i.dat +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/o.dat +0 -0
package/generator/dead-code-review/elm-stuff/tests-0.19.1/elm.json +1 -1
package/generator/dead-code-review/elm-stuff/tests-0.19.1/js/Reporter.elm.js +1527 -422
package/generator/dead-code-review/elm-stuff/tests-0.19.1/js/Runner.elm.js +16840 -13653
package/generator/dead-code-review/elm-stuff/tests-0.19.1/js/node_runner.js +1 -1
package/generator/dead-code-review/elm-stuff/tests-0.19.1/js/node_supervisor.js +4 -4
package/generator/dead-code-review/elm.json +9 -7
package/generator/dead-code-review/src/Pages/Review/DeadCodeEliminateData.elm +59 -10
package/generator/dead-code-review/tests/Pages/Review/DeadCodeEliminateDataTest.elm +52 -36
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Internal-RoutePattern.elmi +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Internal-RoutePattern.elmo +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Review-NoContractViolations.elmi +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/Pages-Review-NoContractViolations.elmo +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/d.dat +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/i.dat +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm-stuff/0.19.1/o.dat +0 -0
package/generator/review/elm-stuff/tests-0.19.1/elm.json +1 -1
package/generator/review/elm-stuff/tests-0.19.1/js/Reporter.elm.js +1527 -422
package/generator/review/elm-stuff/tests-0.19.1/js/Runner.elm.js +25118 -21832
package/generator/review/elm-stuff/tests-0.19.1/js/node_runner.js +1 -1
package/generator/review/elm-stuff/tests-0.19.1/js/node_supervisor.js +4 -4
package/generator/review/elm.json +10 -10
package/generator/src/RouteBuilder.elm +93 -128
package/generator/src/SharedTemplate.elm +8 -7
package/generator/src/SiteConfig.elm +3 -2
package/generator/src/basepath-middleware.js +3 -3
package/generator/src/build.js +143 -59
package/generator/src/cli.js +292 -88
package/generator/src/codegen.js +29 -27
package/generator/src/compatibility-key.js +3 -0
package/generator/src/compile-elm.js +43 -26
package/generator/src/config.js +2 -4
package/generator/src/copy-dir.js +2 -2
package/generator/src/dev-server.js +160 -102
package/generator/src/dir-helpers.js +9 -26
package/generator/src/elm-codegen.js +5 -4
package/generator/src/elm-file-constants.js +2 -3
package/generator/src/error-formatter.js +12 -11
package/generator/src/file-helpers.js +3 -4
package/generator/src/generate-template-module-connector.js +23 -23
package/generator/src/init.js +9 -8
package/generator/src/pre-render-html.js +10 -13
package/generator/src/render-test.js +109 -0
package/generator/src/render-worker.js +25 -28
package/generator/src/render.js +320 -143
package/generator/src/request-cache.js +265 -162
package/generator/src/resolve-elm-module.js +64 -0
package/generator/src/rewrite-client-elm-json.js +6 -5
package/generator/src/rewrite-elm-json-help.js +56 -0
package/generator/src/rewrite-elm-json.js +17 -7
package/generator/src/route-codegen-helpers.js +16 -31
package/generator/src/seo-renderer.js +1 -3
package/generator/src/vite-utils.js +1 -2
package/generator/static-code/elm-pages.js +10 -0
package/generator/static-code/hmr.js +79 -13
package/generator/template/app/Api.elm +3 -2
package/generator/template/app/Effect.elm +155 -0
package/generator/template/app/ErrorPage.elm +49 -6
package/generator/template/app/Route/Blog/Slug_.elm +86 -0
package/generator/template/app/Route/Greet.elm +107 -0
package/generator/template/app/Route/Hello.elm +119 -0
package/generator/template/app/Route/Index.elm +26 -25
package/generator/template/app/Shared.elm +38 -39
package/generator/template/app/Site.elm +4 -7
package/generator/template/app/View.elm +9 -8
package/generator/template/codegen/elm.codegen.json +18 -0
package/generator/template/custom-backend-task.ts +3 -0
package/generator/template/elm-pages.config.mjs +13 -0
package/generator/template/elm-tooling.json +0 -3
package/generator/template/elm.json +25 -20
package/generator/template/index.ts +1 -2
package/generator/template/netlify.toml +4 -1
package/generator/template/package.json +10 -4
package/generator/template/script/.elm-pages/compiled-ports/custom-backend-task.mjs +7 -0
package/generator/template/script/custom-backend-task.ts +3 -0
package/generator/template/script/elm.json +61 -0
package/generator/template/script/src/AddRoute.elm +312 -0
package/generator/template/script/src/Stars.elm +42 -0
package/package.json +30 -27
package/src/ApiRoute.elm +249 -82
package/src/BackendTask/Custom.elm +325 -0
package/src/BackendTask/Env.elm +90 -0
package/src/{DataSource → BackendTask}/File.elm +171 -56
package/src/{DataSource → BackendTask}/Glob.elm +136 -125
package/src/BackendTask/Http.elm +679 -0
package/src/{DataSource → BackendTask}/Internal/Glob.elm +1 -1
package/src/BackendTask/Internal/Request.elm +69 -0
package/src/BackendTask/Random.elm +79 -0
package/src/BackendTask/Time.elm +47 -0
package/src/BackendTask.elm +531 -0
package/src/FatalError.elm +90 -0
package/src/FormData.elm +21 -18
package/src/Head/Seo.elm +4 -4
package/src/Head.elm +112 -8
package/src/Internal/ApiRoute.elm +7 -5
package/src/Internal/Request.elm +84 -4
package/src/PageServerResponse.elm +6 -1
package/src/Pages/ConcurrentSubmission.elm +127 -0
package/src/Pages/Form.elm +340 -0
package/src/Pages/FormData.elm +19 -0
package/src/Pages/GeneratorProgramConfig.elm +15 -0
package/src/Pages/Internal/FatalError.elm +5 -0
package/src/Pages/Internal/Msg.elm +93 -0
package/src/Pages/Internal/NotFoundReason.elm +4 -4
package/src/Pages/Internal/Platform/Cli.elm +586 -768
package/src/Pages/Internal/Platform/CompatibilityKey.elm +1 -1
package/src/Pages/Internal/Platform/Effect.elm +1 -2
package/src/Pages/Internal/Platform/GeneratorApplication.elm +379 -0
package/src/Pages/Internal/Platform/StaticResponses.elm +65 -276
package/src/Pages/Internal/Platform/ToJsPayload.elm +6 -9
package/src/Pages/Internal/Platform.elm +330 -203
package/src/Pages/Internal/ResponseSketch.elm +2 -2
package/src/Pages/Internal/Script.elm +17 -0
package/src/Pages/Internal/StaticHttpBody.elm +35 -1
package/src/Pages/Manifest.elm +52 -11
package/src/Pages/Navigation.elm +85 -0
package/src/Pages/PageUrl.elm +26 -12
package/src/Pages/ProgramConfig.elm +32 -22
package/src/Pages/Script.elm +166 -0
package/src/Pages/SiteConfig.elm +3 -2
package/src/Pages/StaticHttp/Request.elm +2 -2
package/src/Pages/StaticHttpRequest.elm +23 -99
package/src/Pages/Url.elm +3 -3
package/src/PagesMsg.elm +88 -0
package/src/QueryParams.elm +21 -172
package/src/RenderRequest.elm +7 -7
package/src/RequestsAndPending.elm +37 -20
package/src/Result/Extra.elm +26 -0
package/src/Scaffold/Form.elm +569 -0
package/src/Scaffold/Route.elm +1431 -0
package/src/Server/Request.elm +476 -1001
package/src/Server/Response.elm +130 -36
package/src/Server/Session.elm +181 -111
package/src/Server/SetCookie.elm +80 -32
package/src/Stub.elm +53 -0
package/src/Test/Html/Internal/ElmHtml/ToString.elm +8 -9
package/src/{Path.elm → UrlPath.elm} +33 -36
package/generator/template/public/images/icon-png.png +0 -0
package/src/DataSource/Env.elm +0 -38
package/src/DataSource/Http.elm +0 -446
package/src/DataSource/Internal/Request.elm +0 -20
package/src/DataSource/Port.elm +0 -90
package/src/DataSource.elm +0 -546
package/src/Form/Field.elm +0 -717
package/src/Form/FieldStatus.elm +0 -36
package/src/Form/FieldView.elm +0 -417
package/src/Form/FormData.elm +0 -22
package/src/Form/Validation.elm +0 -391
package/src/Form/Value.elm +0 -118
package/src/Form.elm +0 -1683
package/src/FormDecoder.elm +0 -102
package/src/Pages/FormState.elm +0 -256
package/src/Pages/Generate.elm +0 -1242
package/src/Pages/Internal/Form.elm +0 -17
package/src/Pages/Internal/Platform/Cli.elm.bak +0 -1276
package/src/Pages/Msg.elm +0 -79
package/src/Pages/Transition.elm +0 -70

package/src/Head.elm CHANGED Viewed

@@ -9,14 +9,118 @@ module Head exposing
     , toJson, canonicalLink
     )
-{-| This module contains low-level functions for building up
-values that will be rendered into the page's `<head>` tag
-when you run `elm-pages build`. Most likely the `Head.Seo` module
-will do everything you need out of the box, and you will just need to import `Head`
-so you can use the `Tag` type in your type annotations.
-But this module might be useful if you have a special use case, or if you are
-writing a plugin package to extend `elm-pages`.
+{-| This module contains functions for building up
+tags with metadata that will be rendered into the page's `<head>` tag
+when your page is pre-rendered (or server-rendered, in the case of your server-rendered Route Modules). See also [`Head.Seo`](Head-Seo),
+which has some helper functions for defining OpenGraph and Twitter tags.
+One of the unique benefits of using `elm-pages` is that all of your routes (both pre-rendered and server-rendered) fully
+render the HTML of your page. That includes the full initial `view` (with the BackendTask resolved, and the `Model` from `init`).
+The HTML response also includes all of the `Head` tags, which are defined in two places:
+1.  `app/Site.elm` - there is a `head` definition in `Site.elm` where you define global head tags that will be included on every rendered page.
+2.  In each Route Module - there is a `head` function where you have access to both the resolved `BackendTask` and the `RouteParams` for the page and can return head tags based on that.
+Here is a common set of global head tags that we can define in `Site.elm`:
+    module Site exposing (canonicalUrl, config)
+    import BackendTask exposing (BackendTask)
+    import Head
+    import MimeType
+    import SiteConfig exposing (SiteConfig)
+    config : SiteConfig
+    config =
+    { canonicalUrl = "<https://elm-pages.com">
+    , head = head
+    }
+    head : BackendTask (List Head.Tag)
+    head =
+    [ Head.metaName "viewport" (Head.raw "width=device-width,initial-scale=1")
+    , Head.metaName "mobile-web-app-capable" (Head.raw "yes")
+    , Head.metaName "theme-color" (Head.raw "#ffffff")
+    , Head.metaName "apple-mobile-web-app-capable" (Head.raw "yes")
+    , Head.metaName "apple-mobile-web-app-status-bar-style" (Head.raw "black-translucent")
+    , Head.icon [ ( 32, 32 ) ] MimeType.Png (cloudinaryIcon MimeType.Png 32)
+    , Head.icon [ ( 16, 16 ) ] MimeType.Png (cloudinaryIcon MimeType.Png 16)
+    , Head.appleTouchIcon (Just 180) (cloudinaryIcon MimeType.Png 180)
+    , Head.appleTouchIcon (Just 192) (cloudinaryIcon MimeType.Png 192)
+    ]
+    |> BackendTask.succeed
+And here is a `head` function for a Route Module for a blog post. Note that we have access to our `BackendTask` Data and
+are using it to populate article metadata like the article's image, publish date, etc.
+    import Article
+    import BackendTask
+    import Date
+    import Head
+    import Head.Seo
+    import Path
+    import Route exposing (Route)
+    import RouteBuilder exposing (App, StatelessRoute)
+    type alias RouteParams =
+        { slug : String }
+    type alias Data =
+        { metadata : ArticleMetadata
+        , body : List Markdown.Block.Block
+        }
+    route : StatelessRoute RouteParams Data ActionData
+    route =
+        RouteBuilder.preRender
+            { data = data
+            , head = head
+            , pages = pages
+            }
+            |> RouteBuilder.buildNoState { view = view }
+    head :
+        App Data ActionData RouteParams
+        -> List Head.Tag
+    head static =
+        let
+            metadata =
+                static.data.metadata
+        in
+        Head.Seo.summaryLarge
+            { canonicalUrlOverride = Nothing
+            , siteName = "elm-pages"
+            , image =
+                { url = metadata.image
+                , alt = metadata.description
+                , dimensions = Nothing
+                , mimeType = Nothing
+                }
+            , description = metadata.description
+            , locale = Nothing
+            , title = metadata.title
+            }
+            |> Head.Seo.article
+                { tags = []
+                , section = Nothing
+                , publishedTime = Just (DateOrDateTime.Date metadata.published)
+                , modifiedTime = Nothing
+                , expirationTime = Nothing
+                }
+## Why is pre-rendered HTML important? Does it still matter for SEO?
+Many search engines are able to execute JavaScript now. However, not all are, and even with crawlers like Google, there
+is a longer lead time for your pages to be indexed when you have HTML with a blank page that is only visible after the JavaScript executes.
+But most importantly, many tools that unfurl links will not execute JavaScript at all, but rather simply do a simple pass to parse your `<head>` tags.
+It is not viable or reliable to add `<head>` tags for metadata on the client-side, it must be present in the initial HTML payload. Otherwise you may not
+get unfurling preview content when you share a link to your site on Slack, Twitter, etc.
+## Building up Head Tags
 @docs Tag, metaName, metaProperty, metaRedirect
 @docs rssLink, sitemapLink, rootLanguage, manifestLink

package/src/Internal/ApiRoute.elm CHANGED Viewed

@@ -8,8 +8,10 @@ module Internal.ApiRoute exposing
     , withRoutes
     )
-import DataSource exposing (DataSource)
+import BackendTask exposing (BackendTask)
+import FatalError exposing (FatalError)
 import Head
+import Json.Decode
 import Pattern exposing (Pattern)
 import Regex exposing (Regex)
@@ -44,12 +46,12 @@ tryMatchDone path (ApiRoute handler) =
 type ApiRoute response
     = ApiRoute
         { regex : Regex
-        , matchesToResponse : String -> DataSource (Maybe response)
-        , buildTimeRoutes : DataSource (List String)
-        , handleRoute : String -> DataSource Bool
+        , matchesToResponse : Json.Decode.Value -> String -> BackendTask FatalError (Maybe response)
+        , buildTimeRoutes : BackendTask FatalError (List String)
+        , handleRoute : String -> BackendTask FatalError Bool
         , pattern : Pattern
         , kind : String
-        , globalHeadTags : Maybe (DataSource (List Head.Tag))
+        , globalHeadTags : Maybe (BackendTask FatalError (List Head.Tag))
         }

package/src/Internal/Request.elm CHANGED Viewed

@@ -1,7 +1,87 @@
-module Internal.Request exposing (Parser(..))
+module Internal.Request exposing (Request(..), RequestRecord, fakeRequest, toRequest)
-import Json.Decode
+import CookieParser
+import Dict exposing (Dict)
+import Json.Decode as Decode
+import Time
-type Parser decodesTo validationError
-    = Parser (Json.Decode.Decoder ( Result validationError decodesTo, List validationError ))
+type Request
+    = Request RequestRecord
+type alias RequestRecord =
+    { time : Time.Posix
+    , method : String
+    , body : Maybe String
+    , rawUrl : String
+    , rawHeaders : Dict String String
+    , cookies : Dict String String
+    }
+toRequest : Decode.Value -> Request
+toRequest value =
+    Decode.decodeValue requestDecoder value
+        |> Result.map Request
+        |> Result.withDefault fakeRequest
+fakeRequest : Request
+fakeRequest =
+    Request
+        { time = Time.millisToPosix 0
+        , method = "ERROR"
+        , body = Just "ERROR"
+        , rawUrl = "ERROR"
+        , rawHeaders = Dict.empty
+        , cookies = Dict.empty
+        }
+requestDecoder : Decode.Decoder RequestRecord
+requestDecoder =
+    Decode.succeed RequestRecord
+        |> andMap
+            (Decode.field "requestTime"
+                (Decode.int |> Decode.map Time.millisToPosix)
+            )
+        |> andMap (Decode.field "method" Decode.string)
+        |> andMap (Decode.field "body" (Decode.nullable Decode.string))
+        |> andMap
+            (Decode.string
+                |> Decode.field "rawUrl"
+            )
+        |> andMap (Decode.field "headers" (Decode.dict Decode.string))
+        |> andMap
+            (Decode.field "headers"
+                (optionalField "cookie" Decode.string
+                    |> Decode.map
+                        (Maybe.map CookieParser.parse
+                            >> Maybe.withDefault Dict.empty
+                        )
+                )
+            )
+andMap : Decode.Decoder a -> Decode.Decoder (a -> b) -> Decode.Decoder b
+andMap =
+    Decode.map2 (|>)
+optionalField : String -> Decode.Decoder a -> Decode.Decoder (Maybe a)
+optionalField fieldName decoder_ =
+    let
+        finishDecoding : Decode.Value -> Decode.Decoder (Maybe a)
+        finishDecoding json =
+            case Decode.decodeValue (Decode.field fieldName Decode.value) json of
+                Ok _ ->
+                    -- The field is present, so run the decoder on it.
+                    Decode.map Just (Decode.field fieldName decoder_)
+                Err _ ->
+                    -- The field was missing, which is fine!
+                    Decode.succeed Nothing
+    in
+    Decode.value
+        |> Decode.andThen finishDecoding

package/src/PageServerResponse.elm CHANGED Viewed

@@ -15,7 +15,12 @@ type PageServerResponse data error
     | ErrorPage error { headers : List ( String, String ) }
-toRedirect : Response -> Maybe { statusCode : Int, location : String }
+toRedirect :
+    { response
+        | statusCode : Int
+        , headers : List ( String, String )
+    }
+    -> Maybe { statusCode : Int, location : String }
 toRedirect response =
     response.headers
         |> Dict.fromList

package/src/Pages/ConcurrentSubmission.elm ADDED Viewed

@@ -0,0 +1,127 @@
+module Pages.ConcurrentSubmission exposing
+    ( ConcurrentSubmission, Status(..)
+    , map
+    )
+{-| When you render a `Form` with the [`Pages.Form.withConcurrent`](Pages-Form#withConcurrent) `Option`, the state of in-flight and completed submissions will be available
+from your `Route` module through `app.concurrentSubmissions` as a `Dict String (ConcurrentSubmission (Maybe Action))`.
+You can use this state to declaratively derive Pending UI or Optimistic UI from your pending submissions (without managing the state in your `Model`, since `elm-pages`
+manages form submission state for you).
+You can [see the full-stack TodoMVC example](https://github.com/dillonkearns/elm-pages/blob/master/examples/todos/app/Route/Visibility__.elm) for a complete example of deriving Pending UI state from `app.concurrentSubmissions`.
+For example, this how the TodoMVC example derives the list of new items that are being created (but are still pending).
+    view :
+        App Data ActionData RouteParams
+        -> Shared.Model
+        -> Model
+        -> View (PagesMsg Msg)
+    view app shared model =
+        let
+            pendingActions : List Action
+            pendingActions =
+                app.concurrentSubmissions
+                    |> Dict.values
+                    |> List.filterMap
+                        (\{ status, payload } ->
+                            case status of
+                                Pages.ConcurrentSubmission.Complete _ ->
+                                    Nothing
+                                _ ->
+                                    allForms
+                                        |> Form.Handler.run payload.fields
+                                        |> Form.toResult
+                                        |> Result.toMaybe
+                        )
+            newPendingItems : List Entry
+            newPendingItems =
+                pendingActions
+                    |> List.filterMap
+                        (\submission ->
+                            case submission of
+                                Add description ->
+                                    Just
+                                        { description = description
+                                        , completed = False
+                                        , id = ""
+                                        , isPending = True
+                                        }
+                                _ ->
+                                -- `newPendingItems` only cares about pending Add actions. Other values will use
+                                -- pending submissions for other types of Actions.
+                                    Nothing
+                        )
+        in
+        itemsView app newPendingItems
+        allForms : Form.Handler.Handler String Action
+        allForms =
+                |> Form.Handler.init Add addItemForm
+                -- |> Form.Handler.with ...
+        type Action
+            = UpdateEntry ( String, String )
+            | Add String
+            | Delete String
+            | DeleteComplete
+            | Check ( Bool, String )
+            | CheckAll Bool
+@docs ConcurrentSubmission, Status
+@docs map
+-}
+import Pages.FormData exposing (FormData)
+import Time
+{-| -}
+type alias ConcurrentSubmission actionData =
+    { status : Status actionData
+    , payload : FormData
+    , initiatedAt : Time.Posix
+    }
+{-| The status of a `ConcurrentSubmission`.
+  - `Submitting` - The submission is in-flight.
+  - `Reloading` - The submission has completed, and the page is now reloading the `Route`'s `data` to reflect the new state. The `actionData` holds any data returned from the `Route`'s `action`.
+  - `Complete` - The submission has completed, and the `Route`'s `data` has since reloaded so the state reflects the refreshed state after completing this specific form submission. The `actionData` holds any data returned from the `Route`'s `action`.
+-}
+type Status actionData
+    = Submitting
+    | Reloading actionData
+    | Complete actionData
+{-| `map` a `ConcurrentSubmission`. Not needed for most high-level cases since this state is managed by the `elm-pages` framework for you.
+-}
+map : (a -> b) -> ConcurrentSubmission a -> ConcurrentSubmission b
+map mapFn fetcherState =
+    { status = mapStatus mapFn fetcherState.status
+    , payload = fetcherState.payload
+    , initiatedAt = fetcherState.initiatedAt
+    }
+mapStatus : (a -> b) -> Status a -> Status b
+mapStatus mapFn fetcherSubmitStatus =
+    case fetcherSubmitStatus of
+        Submitting ->
+            Submitting
+        Reloading value ->
+            Reloading (mapFn value)
+        Complete value ->
+            Complete (mapFn value)