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

package/generator/src/route-codegen-helpers.js

@@ -1,7 +1,7 @@
 /**
  * @param {string[]} name
  */
-function routeParams(name) {
+export function routeParams(name) {
   return name
     .map((section) => {
       const routeParamMatch = section.match(/([A-Z][A-Za-z0-9]*)__?$/);
@@ -17,7 +17,7 @@ function routeParams(name) {
  * @param {string[]} name
  * @returns {Segment[]}
  */
-function parseRouteParams(name) {
+export function parseRouteParams(name) {
   return name.flatMap((section) => {
     const routeParamMatch = section.match(/([A-Z][A-Za-z0-9]*)(_?_?)$/);
     const maybeParam = (routeParamMatch && routeParamMatch[1]) || "TODO";
@@ -68,7 +68,7 @@ function parseRouteParams(name) {
  * @param {string[]} name
  * @returns {( Segment | {kind: 'static'; name: string})[]}
  */
-function parseRouteParamsWithStatic(name) {
+export function parseRouteParamsWithStatic(name) {
   return name.flatMap((section) => {
     const routeParamMatch = section.match(/([A-Z][A-Za-z0-9]*)(_?_?)$/);
     const maybeParam = (routeParamMatch && routeParamMatch[1]) || "TODO";
@@ -123,7 +123,7 @@ function parseRouteParamsWithStatic(name) {
  * @param {string[]} name
  * @returns {string}
  */
-function routeVariantDefinition(name) {
+export function routeVariantDefinition(name) {
   const newLocal = parseRouteParams(name);
   if (newLocal.length == 0) {
     return routeVariant(name);
@@ -151,7 +151,7 @@ function routeVariantDefinition(name) {
  * @param {string[]} name
  * @returns {string}
  */
-function toPathPattern(name) {
+export function toPathPattern(name) {
   return (
     "/" +
     parseRouteParamsWithStatic(name)
@@ -181,7 +181,7 @@ function toPathPattern(name) {
  * @param {string[]} name
  * @returns {string[]}
  */
-function toPathPatterns(name) {
+export function toPathPatterns(name) {
   const segments = parseRouteParamsWithStatic(name);
 
   const lastSegment = segments[segments.length - 1];
@@ -199,7 +199,7 @@ function toPathPatterns(name) {
 /**
  * @param {string[]} segments
  */
-function joinPath(segments) {
+export function joinPath(segments) {
   const joined = segments.join("/");
   if (joined.startsWith("/")) {
     return joined;
@@ -211,7 +211,7 @@ function joinPath(segments) {
 /**
  * @return {string[]}
  */
-function newHelper(segments) {
+export function newHelper(segments) {
   return segments.map((param) => {
     switch (param.kind) {
       case "static": {
@@ -238,7 +238,7 @@ function newHelper(segments) {
  * @param {string[]} name
  * @returns {string}
  */
-function toElmPathPattern(name) {
+export function toElmPathPattern(name) {
   const parsedSegments = parseRouteParamsWithStatic(name);
 
   const foundEndings = parsedSegments.flatMap((segment) => {
@@ -297,14 +297,14 @@ function toElmPathPattern(name) {
  * @param {string} input
  * @returns {string}
  */
-function camelToKebab(input) {
+export function camelToKebab(input) {
   return input.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
 }
 
 /**
  * @param {string[]} name
  */
-function paramsRecord(name) {
+export function paramsRecord(name) {
   return `{ ${parseRouteParams(name).map((param) => {
     switch (param.kind) {
       case "dynamic": {
@@ -326,7 +326,7 @@ function paramsRecord(name) {
 /**
  * @param {string[]} name
  */
-function routeVariant(name) {
+export function routeVariant(name) {
   return `${name.join("__")}`;
 }
 
@@ -334,44 +334,29 @@ function routeVariant(name) {
  * @param {string[]} name
  * @param {string} paramsName
  */
-function destructureRoute(name, paramsName) {
+export function destructureRoute(name, paramsName) {
   return emptyRouteParams(name)
     ? `Route.${routeVariant(name)}`
     : `(Route.${routeVariant(name)} ${paramsName})`;
 }
 
-function referenceRouteParams(name, paramsName) {
+export function referenceRouteParams(name, paramsName) {
   return emptyRouteParams(name) ? `{}` : paramsName;
 }
 /**
  * @param {string[]} name
  */
-function emptyRouteParams(name) {
+export function emptyRouteParams(name) {
   return parseRouteParams(name).length === 0;
 }
 
 /**
  * @param {string} name
  */
-function toFieldName(name) {
+export function toFieldName(name) {
   if (name === "SPLAT") {
     return "splat";
   } else {
     return name.charAt(0).toLowerCase() + name.slice(1);
   }
 }
-
-module.exports = {
-  routeParams,
-  routeVariantDefinition,
-  routeVariant,
-  toFieldName,
-  paramsRecord,
-  toPathPattern,
-  toPathPatterns,
-  parseRouteParams,
-  parseRouteParamsWithStatic,
-  toElmPathPattern,
-  destructureRoute,
-  referenceRouteParams,
-};

package/generator/src/seo-renderer.js

@@ -1,11 +1,9 @@
-module.exports = { gather };
-
 /** @typedef { { type: 'root'; keyValuePair: [string, string] } } RootTagModifier */
 
 /**
  * @param {( SeoTag | RootTagModifier )[]} tags
  */
-function gather(tags) {
+export function gather(tags) {
   const withoutRootModifiers = tags.flatMap((value) => {
     if (value.type === "root") {
       return [];

package/generator/src/vite-utils.js

@@ -4,7 +4,7 @@
  * @param {...import('vite').UserConfig} configs
  * @returns {import('vite').UserConfig}
  */
-function merge_vite_configs(...configs) {
+export function merge_vite_configs(...configs) {
   return deep_merge(
     ...configs.map((config) => ({
       ...config,
@@ -75,4 +75,3 @@ function merge_into(a, b) {
     }
   }
 }
-module.exports = { merge_vite_configs };

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "elm-pages",
-  "version": "3.0.0-beta.18",
+  "type": "module",
+  "version": "3.0.0-beta.19",
   "homepage": "https://elm-pages.com",
   "moduleResolution": "node",
   "description": "Type-safe static sites, written in pure elm with your own custom elm-markup syntax.",
@@ -10,7 +11,7 @@
     "test": "./test.sh",
     "test:snapshot": "(cd examples/escaping && npm install && npm test) && (cd examples/base-path && npm install && npm test)",
     "cypress": "npm start & cypress run",
-    "build:generator": "elm-codegen install && (cd codegen && lamdera make Generate.elm --output elm-pages-codegen.js)",
+    "build:generator": "elm-codegen install && (cd codegen && lamdera make Generate.elm --output elm-pages-codegen.js && mv elm-pages-codegen.js elm-pages-codegen.cjs)",
     "review": "elm-review"
   },
   "repository": "https://github.com/dillonkearns/elm-pages",
@@ -26,7 +27,7 @@
   "dependencies": {
     "busboy": "^1.0.0",
     "chokidar": "^3.5.3",
-    "commander": "^9.5.0",
+    "commander": "^10.0.0",
     "connect": "^3.7.0",
     "cookie-signature": "^1.1.0",
     "cross-spawn": "7.0.3",
@@ -34,8 +35,8 @@
     "elm-doc-preview": "^5.0.5",
     "elm-hot": "^1.1.6",
     "esbuild": "^0.16.15",
-    "fs-extra": "^10.1.0",
-    "globby": "11.0.4",
+    "fs-extra": "^11.1.0",
+    "globby": "^13.1.3",
     "gray-matter": "^4.0.3",
     "jsesc": "^3.0.2",
     "kleur": "^4.1.5",
@@ -45,7 +46,7 @@
     "serve-static": "^1.15.0",
     "terser": "^5.16.1",
     "vite": "^4.0.4",
-    "which": "^2.0.2"
+    "which": "^3.0.0"
   },
   "devDependencies": {
     "@types/cross-spawn": "^6.0.2",
@@ -54,7 +55,7 @@
     "@types/micromatch": "^4.0.2",
     "@types/node": "^18.11.9",
     "@types/serve-static": "^1.15.0",
-    "cypress": "^12.3.0",
+    "cypress": "^12.4.0",
     "elm-codegen": "^0.2.0",
     "elm-optimize-level-2": "^0.3.5",
     "elm-review": "^2.8.2",
@@ -70,7 +71,7 @@
     "generator/review/",
     "generator/dead-code-review/",
     "src/",
-    "codegen/elm-pages-codegen.js",
+    "codegen/elm-pages-codegen.cjs",
     "generator/template/",
     "generator/static-code/"
   ],

package/src/BackendTask/File.elm

@@ -42,7 +42,7 @@ plain old JSON in Elm.
 @docs jsonFile, rawFile
 
 
-## Exceptions
+## FatalErrors
 
 @docs FileReadError
 

package/src/Form.elm

@@ -1,6 +1,6 @@
 module Form exposing
     ( Form, HtmlForm, StyledHtmlForm, DoneForm
-    , Response(..)
+    , Response
     , init
     , field, hiddenField, hiddenKind
     , Context
@@ -281,7 +281,7 @@ import Html.Styled
 import Html.Styled.Attributes as StyledAttr
 import Html.Styled.Lazy
 import Pages.FormState as Form exposing (FormState)
-import Pages.Internal.Form exposing (Validation(..))
+import Pages.Internal.Form exposing (Validation(..), unwrapResponse)
 import Pages.Msg
 import Pages.Transition exposing (Transition(..))
 import Path exposing (Path)
@@ -798,13 +798,13 @@ type alias AppContext app actionData =
         | --, sharedData : Shared.Data
           --, routeParams : routeParams
           path : Path
+        , action : Maybe actionData
 
-        --, action : Maybe action
         --, submit :
         --    { fields : List ( String, String ), headers : List ( String, String ) }
         --    -> Pages.Fetcher.Fetcher (Result Http.Error action)
         , transition : Maybe Transition
-        , fetchers : Dict String (Pages.Transition.FetcherState actionData)
+        , fetchers : Dict String (Pages.Transition.FetcherState (Maybe actionData))
         , pageFormState :
             Dict String { fields : Dict String { value : String, status : FieldStatus }, submitAttempted : Bool }
     }
@@ -980,11 +980,7 @@ runOneOfServerSideHelp rawFormData firstFoundErrors (ServerForms parsers) =
 {-| -}
 renderHtml :
     List (Html.Attribute (Pages.Msg.Msg msg))
-    ->
-        Maybe
-            { fields : List ( String, String )
-            , errors : Dict String (List error)
-            }
+    -> (actionData -> Maybe (Response error))
     -> AppContext app actionData
     -> data
     ->
@@ -997,8 +993,8 @@ renderHtml :
             )
             msg
     -> Html (Pages.Msg.Msg msg)
-renderHtml attrs maybe app data (FinalForm options a b c) =
-    Html.Lazy.lazy6 renderHelper attrs maybe options app data (FormInternal a b c)
+renderHtml attrs accessResponse app data (FinalForm options a b c) =
+    Html.Lazy.lazy6 renderHelper attrs accessResponse options app data (FormInternal a b c)
 
 
 {-| -}
@@ -1181,11 +1177,7 @@ withOnSubmit onSubmit (FinalForm options a b c) =
 {-| -}
 renderStyledHtml :
     List (Html.Styled.Attribute (Pages.Msg.Msg msg))
-    ->
-        Maybe
-            { fields : List ( String, String )
-            , errors : Dict String (List error)
-            }
+    -> (actionData -> Maybe (Response error))
     -> AppContext app actionData
     -> data
     ->
@@ -1198,36 +1190,29 @@ renderStyledHtml :
             )
             msg
     -> Html.Styled.Html (Pages.Msg.Msg msg)
-renderStyledHtml attrs maybe app data (FinalForm options a b c) =
-    Html.Styled.Lazy.lazy6 renderStyledHelper attrs maybe options app data (FormInternal a b c)
+renderStyledHtml attrs accessResponse app data (FinalForm options a b c) =
+    Html.Styled.Lazy.lazy6 renderStyledHelper attrs accessResponse options app data (FormInternal a b c)
 
 
 {-| -}
-type Response error
-    = Response
-        { fields : List ( String, String )
-        , errors : Dict String (List error)
-        }
+type alias Response error =
+    Pages.Internal.Form.Response error
 
 
 renderHelper :
     List (Html.Attribute (Pages.Msg.Msg msg))
-    ->
-        Maybe
-            { fields : List ( String, String )
-            , errors : Dict String (List error)
-            }
+    -> (actionData -> Maybe (Response error))
     -> RenderOptions msg
     -> AppContext app actionData
     -> data
     -> FormInternal error (Validation.Validation error parsed named constraints) data (Context error data -> List (Html (Pages.Msg.Msg msg)))
     -> Html (Pages.Msg.Msg msg)
-renderHelper attrs maybe options formState data form =
+renderHelper attrs accessResponse options formState data form =
     -- TODO Get transition context from `app` so you can check if the current form is being submitted
     -- TODO either as a transition or a fetcher? Should be easy enough to check for the `id` on either of those?
     let
         { formId, hiddenInputs, children, isValid } =
-            helperValues toHiddenInput maybe options formState data form
+            helperValues toHiddenInput accessResponse options formState data form
 
         toHiddenInput : List (Html.Attribute (Pages.Msg.Msg msg)) -> Html (Pages.Msg.Msg msg)
         toHiddenInput hiddenAttrs =
@@ -1254,22 +1239,18 @@ renderHelper attrs maybe options formState data form =
 
 renderStyledHelper :
     List (Html.Styled.Attribute (Pages.Msg.Msg msg))
-    ->
-        Maybe
-            { fields : List ( String, String )
-            , errors : Dict String (List error)
-            }
+    -> (actionData -> Maybe (Response error))
     -> RenderOptions msg
     -> AppContext app actionData
     -> data
     -> FormInternal error (Validation.Validation error parsed named constraints) data (Context error data -> List (Html.Styled.Html (Pages.Msg.Msg msg)))
     -> Html.Styled.Html (Pages.Msg.Msg msg)
-renderStyledHelper attrs maybe options formState data form =
+renderStyledHelper attrs accessResponse options formState data form =
     -- TODO Get transition context from `app` so you can check if the current form is being submitted
     -- TODO either as a transition or a fetcher? Should be easy enough to check for the `id` on either of those?
     let
         { formId, hiddenInputs, children, isValid } =
-            helperValues toHiddenInput maybe options formState data form
+            helperValues toHiddenInput accessResponse options formState data form
 
         toHiddenInput : List (Html.Attribute (Pages.Msg.Msg msg)) -> Html.Styled.Html (Pages.Msg.Msg msg)
         toHiddenInput hiddenAttrs =
@@ -1296,18 +1277,14 @@ renderStyledHelper attrs maybe options formState data form =
 
 helperValues :
     (List (Html.Attribute (Pages.Msg.Msg msg)) -> view)
-    ->
-        Maybe
-            { fields : List ( String, String )
-            , errors : Dict String (List error)
-            }
+    -> (actionData -> Maybe (Response error))
     -> RenderOptions msg
     -> AppContext app actionData
     -> data
     ---> Form error parsed data view
     -> FormInternal error (Validation.Validation error parsed named constraints) data (Context error data -> List view)
     -> { formId : String, hiddenInputs : List view, children : List view, isValid : Bool }
-helperValues toHiddenInput maybe options formState data (FormInternal fieldDefinitions parser toInitialValues) =
+helperValues toHiddenInput accessResponse options formState data (FormInternal fieldDefinitions parser toInitialValues) =
     let
         formId : String
         formId =
@@ -1324,7 +1301,8 @@ helperValues toHiddenInput maybe options formState data (FormInternal fieldDefin
             formState.pageFormState
                 |> Dict.get formId
                 |> Maybe.withDefault
-                    (maybe
+                    (formState.action
+                        |> Maybe.andThen (accessResponse >> Maybe.map unwrapResponse)
                         |> Maybe.map
                             (\{ fields } ->
                                 { fields =
@@ -1364,8 +1342,8 @@ helperValues toHiddenInput maybe options formState data (FormInternal fieldDefin
                             |> Tuple.mapSecond
                                 (\errors1 ->
                                     mergeErrors errors1
-                                        (maybe
-                                            |> Maybe.map .errors
+                                        (formState.action
+                                            |> Maybe.andThen (accessResponse >> Maybe.map (unwrapResponse >> .errors))
                                             |> Maybe.withDefault Dict.empty
                                         )
                                 )
@@ -1376,7 +1354,8 @@ helperValues toHiddenInput maybe options formState data (FormInternal fieldDefin
             formState.pageFormState
                 |> Dict.get formId
                 |> Maybe.withDefault
-                    (maybe
+                    (formState.action
+                        |> Maybe.andThen (accessResponse >> Maybe.map unwrapResponse)
                         |> Maybe.map
                             (\{ fields } ->
                                 { fields =

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