elm-pages 3.0.0-beta.34 → 3.0.0-beta.35

package/README.md

@@ -81,7 +81,7 @@ https://github.com/dillonkearns/elm-pages/projects
 You will see an error if the NPM and Elm package do not have a matching Compatibility Key. Usually it's best to upgrade to the latest version of both the Elm and NPM
 packages when you upgrade. However, in case you want to install versions that are behind the latest, the Compatibility Key is included here for reference.
 
-Current Compatibility Key: 14.
+Current Compatibility Key: 15.
 
 ## Contributors ✨
 

package/codegen/elm-pages-codegen.cjs

@@ -25043,6 +25043,41 @@ var $author$project$Elm$Extra$topLevelValue = F2(
 			}
 		};
 	});
+var $elm$core$String$isEmpty = function (string) {
+	return string === '';
+};
+var $author$project$Internal$Compiler$documentation = F2(
+	function (rawDoc, decl) {
+		var doc = $elm$core$String$trim(rawDoc);
+		if ($elm$core$String$isEmpty(doc)) {
+			return decl;
+		} else {
+			switch (decl.$) {
+				case 'Comment':
+					return decl;
+				case 'Block':
+					var source = decl.a;
+					return decl;
+				default:
+					var details = decl.a;
+					return $author$project$Internal$Compiler$Declaration(
+						_Utils_update(
+							details,
+							{
+								docs: function () {
+									var _v1 = details.docs;
+									if (_v1.$ === 'Nothing') {
+										return $elm$core$Maybe$Just(doc);
+									} else {
+										var existing = _v1.a;
+										return $elm$core$Maybe$Just(doc + ('\n\n' + existing));
+									}
+								}()
+							}));
+			}
+		}
+	});
+var $author$project$Elm$withDocumentation = $author$project$Internal$Compiler$documentation;
 var $author$project$Generate$file = F2(
 	function (templates, basePath) {
 		var routes = A2($elm$core$List$filterMap, $author$project$Pages$Internal$RoutePattern$fromModuleName, templates);
@@ -25124,8 +25159,11 @@ var $author$project$Generate$file = F2(
 				$elm$core$Maybe$Just(
 					A2($author$project$Elm$Annotation$named, _List_Nil, 'Route'))),
 			function (route) {
-				return $author$project$Gen$Path$toAbsolute(
-					toPath.call(route));
+				return A2(
+					$author$project$Elm$withType,
+					$author$project$Elm$Annotation$string,
+					$author$project$Gen$Path$toAbsolute(
+						toPath.call(route)));
 			});
 		var redirectTo = A2(
 			$author$project$Elm$declaration,
@@ -25155,7 +25193,25 @@ var $author$project$Generate$file = F2(
 		var toLink = A4(
 			$author$project$Elm$Declare$fn2,
 			'toLink',
-			_Utils_Tuple2('toAnchorTag', $elm$core$Maybe$Nothing),
+			_Utils_Tuple2(
+				'toAnchorTag',
+				$elm$core$Maybe$Just(
+					A2(
+						$author$project$Elm$Annotation$function,
+						_List_fromArray(
+							[
+								$author$project$Elm$Annotation$list(
+								A3(
+									$author$project$Elm$Annotation$namedWith,
+									_List_fromArray(
+										['Html']),
+									'Attribute',
+									_List_fromArray(
+										[
+											$author$project$Elm$Annotation$var('msg')
+										])))
+							]),
+						$author$project$Elm$Annotation$var('a')))),
 			_Utils_Tuple2(
 				'route',
 				$elm$core$Maybe$Just(
@@ -25163,45 +25219,85 @@ var $author$project$Generate$file = F2(
 			F2(
 				function (toAnchorTag, route) {
 					return A2(
-						$author$project$Elm$apply,
-						toAnchorTag,
-						_List_fromArray(
-							[
-								$author$project$Elm$list(
-								_List_fromArray(
-									[
-										$author$project$Gen$Html$Attributes$call_.href(
-										toString.call(route)),
-										A2($author$project$Gen$Html$Attributes$attribute, 'elm-pages:prefetch', '')
-									]))
-							]));
+						$author$project$Elm$withType,
+						$author$project$Elm$Annotation$var('a'),
+						A2(
+							$author$project$Elm$apply,
+							toAnchorTag,
+							_List_fromArray(
+								[
+									$author$project$Elm$list(
+									_List_fromArray(
+										[
+											$author$project$Gen$Html$Attributes$call_.href(
+											toString.call(route)),
+											A2($author$project$Gen$Html$Attributes$attribute, 'elm-pages:prefetch', '')
+										]))
+								])));
 				}));
 		var link = A2(
 			$author$project$Elm$declaration,
 			'link',
-			A4(
-				$author$project$Elm$fn3,
-				_Utils_Tuple2('attributes', $elm$core$Maybe$Nothing),
-				_Utils_Tuple2('children', $elm$core$Maybe$Nothing),
-				_Utils_Tuple2(
-					'route',
-					$elm$core$Maybe$Just(
-						A2($author$project$Elm$Annotation$named, _List_Nil, 'Route'))),
-				F3(
-					function (attributes, children, route) {
-						return A2(
-							toLink.call,
-							A2(
-								$author$project$Elm$fn,
-								_Utils_Tuple2('anchorAttrs', $elm$core$Maybe$Nothing),
-								function (anchorAttrs) {
-									return A2(
-										$author$project$Gen$Html$call_.a,
-										A2($author$project$Elm$Op$append, anchorAttrs, attributes),
-										children);
-								}),
-							route);
-					})));
+			A2(
+				$author$project$Elm$withType,
+				A2(
+					$author$project$Elm$Annotation$function,
+					_List_fromArray(
+						[
+							$author$project$Elm$Annotation$list(
+							A3(
+								$author$project$Elm$Annotation$namedWith,
+								_List_fromArray(
+									['Html']),
+								'Attribute',
+								_List_fromArray(
+									[
+										$author$project$Elm$Annotation$var('msg')
+									]))),
+							$author$project$Elm$Annotation$list(
+							A3(
+								$author$project$Elm$Annotation$namedWith,
+								_List_fromArray(
+									['Html']),
+								'Html',
+								_List_fromArray(
+									[
+										$author$project$Elm$Annotation$var('msg')
+									]))),
+							A2($author$project$Elm$Annotation$named, _List_Nil, 'Route')
+						]),
+					A3(
+						$author$project$Elm$Annotation$namedWith,
+						_List_fromArray(
+							['Html']),
+						'Html',
+						_List_fromArray(
+							[
+								$author$project$Elm$Annotation$var('msg')
+							]))),
+				A4(
+					$author$project$Elm$fn3,
+					_Utils_Tuple2('attributes', $elm$core$Maybe$Nothing),
+					_Utils_Tuple2('children', $elm$core$Maybe$Nothing),
+					_Utils_Tuple2(
+						'route',
+						$elm$core$Maybe$Just(
+							A2($author$project$Elm$Annotation$named, _List_Nil, 'Route'))),
+					F3(
+						function (attributes, children, route) {
+							return A2(
+								toLink.call,
+								A2(
+									$author$project$Elm$fn,
+									_Utils_Tuple2('anchorAttrs', $elm$core$Maybe$Nothing),
+									function (anchorAttrs) {
+										return A2(
+											$author$project$Gen$Html$call_.a,
+											A2($author$project$Elm$Op$append, anchorAttrs, attributes),
+											children);
+									}),
+								route);
+						}))));
 		var withoutBaseUrl = A2(
 			$author$project$Elm$declaration,
 			'withoutBaseUrl',
@@ -25230,24 +25326,27 @@ var $author$project$Generate$file = F2(
 						A2(
 						$elm$core$List$map,
 						$author$project$Generate$expose,
-						_List_fromArray(
-							[
-								A2(
-								$author$project$Elm$customType,
-								'Route',
-								A2($elm$core$List$map, $author$project$Pages$Internal$RoutePattern$toVariant, routes)),
-								segmentsToRouteFn.declaration,
-								urlToRoute,
-								baseUrl.declaration,
-								routeToPathFn.declaration,
-								baseUrlAsPath.declaration,
-								toPath.declaration,
-								toString.declaration,
-								redirectTo,
-								toLink.declaration,
-								link,
-								withoutBaseUrl
-							])),
+						A2(
+							$elm$core$List$map,
+							$author$project$Elm$withDocumentation('.'),
+							_List_fromArray(
+								[
+									A2(
+									$author$project$Elm$customType,
+									'Route',
+									A2($elm$core$List$map, $author$project$Pages$Internal$RoutePattern$toVariant, routes)),
+									segmentsToRouteFn.declaration,
+									urlToRoute,
+									baseUrl.declaration,
+									routeToPathFn.declaration,
+									baseUrlAsPath.declaration,
+									toPath.declaration,
+									toString.declaration,
+									redirectTo,
+									toLink.declaration,
+									link,
+									withoutBaseUrl
+								]))),
 						_List_fromArray(
 						[$author$project$Generate$splitPath.declaration, $author$project$Generate$maybeToList.declaration])
 					])));

package/generator/src/cli.js

@@ -90,6 +90,7 @@ async function main() {
     .description("run an elm-pages script")
     .allowUnknownOption()
     .allowExcessArguments()
+    .helpOption(false) // allow --help to propogate to the Script to show usage
     .action(async (elmModulePath, options, options2) => {
       const unprocessedCliOptions = options2.args.splice(
         options2.processedArgs.length,
@@ -325,16 +326,11 @@ async function requireElm(compiledElmPath) {
 function generatorWrapperFile(moduleName) {
   return `port module Main exposing (main)
 
-import BackendTask exposing (BackendTask)
-import FatalError
-import Cli.Program as Program
-import Json.Decode as Decode
-import Json.Encode as Encode
 import Pages.Internal.Platform.GeneratorApplication
 import ${moduleName}
 
 
-main : Program.StatefulProgram Pages.Internal.Platform.GeneratorApplication.Model Pages.Internal.Platform.GeneratorApplication.Msg (BackendTask FatalError.FatalError ()) Pages.Internal.Platform.GeneratorApplication.Flags
+main : Pages.Internal.Platform.GeneratorApplication.Program
 main =
     Pages.Internal.Platform.GeneratorApplication.app
         { data = ${moduleName}.run
@@ -345,13 +341,13 @@ main =
         }
 
 
-port toJsPort : Encode.Value -> Cmd msg
+port toJsPort : Pages.Internal.Platform.GeneratorApplication.JsonValue -> Cmd msg
 
 
-port fromJsPort : (Decode.Value -> msg) -> Sub msg
+port fromJsPort : (Pages.Internal.Platform.GeneratorApplication.JsonValue -> msg) -> Sub msg
 
 
-port gotBatchSub : (Decode.Value -> msg) -> Sub msg
+port gotBatchSub : (Pages.Internal.Platform.GeneratorApplication.JsonValue -> msg) -> Sub msg
 `;
 }
 function collect(value, previous) {

package/generator/src/compatibility-key.js

@@ -1,3 +1,3 @@
-export const compatibilityKey = 14;
+export const compatibilityKey = 15;
 
-export const packageVersion = "3.0.0-beta.34";
+export const packageVersion = "3.0.0-beta.35";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "elm-pages",
   "type": "module",
-  "version": "3.0.0-beta.34",
+  "version": "3.0.0-beta.35",
   "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/File.elm

@@ -65,7 +65,7 @@ frontmatter frontmatterDecoder =
 
     import BackendTask exposing (BackendTask)
     import BackendTask.File as File
-    import Decode as Decode exposing (Decoder)
+    import Decode exposing (Decoder)
 
     blogPost : BackendTask BlogPostMetadata
     blogPost =
@@ -101,7 +101,7 @@ It's common to parse the body with a markdown parser or other format.
 
     import BackendTask exposing (BackendTask)
     import BackendTask.File as File
-    import Decode as Decode exposing (Decoder)
+    import Decode exposing (Decoder)
     import Html exposing (Html)
 
     example :
@@ -151,13 +151,28 @@ bodyWithFrontmatter :
             }
             frontmatter
 bodyWithFrontmatter frontmatterDecoder filePath =
-    read filePath
-        (body
-            |> Decode.andThen
-                (\bodyString ->
-                    frontmatter (frontmatterDecoder bodyString)
-                )
-        )
+    BackendTask.Internal.Request.request2
+        { name = "read-file"
+        , body = BackendTask.Http.stringBody "" filePath
+        , expect =
+            body
+                |> Decode.andThen
+                    (\bodyString ->
+                        frontmatter (frontmatterDecoder bodyString)
+                    )
+        , errorDecoder = Decode.field "errorCode" (errorDecoder filePath)
+        , onError =
+            \frontmatterDecodeError ->
+                { fatal =
+                    { title = "BackendTask.File Decoder Error"
+                    , body =
+                        "I encountered a Json Decoder error from a call to BackendTask.File.bodyWithFrontmatter.\n\n"
+                            ++ Decode.errorToString frontmatterDecodeError
+                    }
+                        |> FatalError.build
+                , recoverable = DecodingError frontmatterDecodeError
+                }
+        }
 
 
 {-| -}
@@ -174,7 +189,7 @@ just the metadata.
 
     import BackendTask exposing (BackendTask)
     import BackendTask.File as File
-    import Decode as Decode exposing (Decoder)
+    import Decode exposing (Decoder)
 
     blogPost : BackendTask BlogPostMetadata
     blogPost =
@@ -198,7 +213,7 @@ the [`BackendTask`](BackendTask) API along with [`BackendTask.Glob`](BackendTask
 
     import BackendTask exposing (BackendTask)
     import BackendTask.File as File
-    import Decode as Decode exposing (Decoder)
+    import Decode exposing (Decoder)
 
     blogPostFiles : BackendTask (List String)
     blogPostFiles =
@@ -231,8 +246,23 @@ onlyFrontmatter :
             }
             frontmatter
 onlyFrontmatter frontmatterDecoder filePath =
-    read filePath
-        (frontmatter frontmatterDecoder)
+    BackendTask.Internal.Request.request2
+        { name = "read-file"
+        , body = BackendTask.Http.stringBody "" filePath
+        , expect = frontmatter frontmatterDecoder
+        , errorDecoder = Decode.field "errorCode" (errorDecoder filePath)
+        , onError =
+            \frontmatterDecodeError ->
+                { fatal =
+                    { title = "BackendTask.File Decoder Error"
+                    , body =
+                        "I encountered a Json Decoder error from a call to BackendTask.File.onlyFrontmatter.\n\n"
+                            ++ Decode.errorToString frontmatterDecodeError
+                    }
+                        |> FatalError.build
+                , recoverable = DecodingError frontmatterDecodeError
+                }
+        }
 
 
 {-| Same as `bodyWithFrontmatter` except it doesn't include the frontmatter.

package/src/BackendTask/Internal/Request.elm

@@ -1,7 +1,9 @@
-module BackendTask.Internal.Request exposing (request)
+module BackendTask.Internal.Request exposing (request, request2)
 
 import BackendTask exposing (BackendTask)
-import BackendTask.Http exposing (Body, Expect)
+import BackendTask.Http exposing (Body, Error(..), Expect)
+import Json.Decode exposing (Decoder)
+import Json.Encode as Encode
 
 
 request :
@@ -22,7 +24,50 @@ request ({ name, body, expect } as params) =
         }
         expect
         |> BackendTask.onError
-            (\_ ->
+            (\error ->
+                let
+                    _ =
+                        Debug.log "BackendTask.Internal.Request" error
+                in
                 -- TODO avoid crash here, this should be handled as an internal error
                 request params
             )
+
+
+request2 :
+    { name : String
+    , body : Body
+    , expect : Decoder a
+    , errorDecoder : Decoder error
+    , onError : Json.Decode.Error -> error
+    }
+    -> BackendTask error a
+request2 ({ name, body, expect, onError, errorDecoder } as params) =
+    -- elm-review: known-unoptimized-recursion
+    BackendTask.Http.request
+        { url = "elm-pages-internal://" ++ name
+        , method = "GET"
+        , headers = []
+        , body = body
+        , timeoutInMs = Nothing
+        , retries = Nothing
+        }
+        (BackendTask.Http.expectJson Json.Decode.value)
+        |> BackendTask.onError
+            (\error ->
+                BackendTask.succeed Encode.null
+            )
+        |> BackendTask.andThen
+            (\decodeValue ->
+                case Json.Decode.decodeValue errorDecoder decodeValue of
+                    Ok a ->
+                        BackendTask.fail a
+
+                    Err _ ->
+                        case Json.Decode.decodeValue expect decodeValue of
+                            Ok a ->
+                                BackendTask.succeed a
+
+                            Err e ->
+                                BackendTask.fail (onError e)
+            )

package/src/FatalError.elm

@@ -1,4 +1,4 @@
-module FatalError exposing (FatalError, fromString, recoverable)
+module FatalError exposing (FatalError, build, fromString, recoverable)
 
 {-| The Elm language doesn't have the concept of exceptions or special control flow for errors. It just has
 Custom Types, and by convention types like `Result` and the `Err` variant are used to represent possible failure states
@@ -54,7 +54,7 @@ issue.
 In the case of server-rendered Routes (`RouteBuilder.serverRender`), `elm-pages` will show your 500 error page
 when these errors occur.
 
-@docs FatalError, fromString, recoverable
+@docs FatalError, build, fromString, recoverable
 
 -}
 
@@ -66,7 +66,8 @@ type alias FatalError =
     Pages.Internal.FatalError.FatalError
 
 
-{-| -}
+{-| Create a FatalError with a title and body.
+-}
 build : { title : String, body : String } -> FatalError
 build info =
     Pages.Internal.FatalError.FatalError info

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

@@ -3,4 +3,4 @@ module Pages.Internal.Platform.CompatibilityKey exposing (currentCompatibilityKe
 
 currentCompatibilityKey : Int
 currentCompatibilityKey =
-    14
+    15

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

@@ -1,8 +1,8 @@
-module Pages.Internal.Platform.GeneratorApplication exposing (Flags, Model, Msg(..), init, requestDecoder, update, app)
+module Pages.Internal.Platform.GeneratorApplication exposing (Program, Flags, Model, Msg(..), init, requestDecoder, update, app, JsonValue)
 
 {-| Exposed for internal use only (used in generated code).
 
-@docs Flags, Model, Msg, init, requestDecoder, update, app
+@docs Program, Flags, Model, Msg, init, requestDecoder, update, app, JsonValue
 
 -}
 
@@ -25,6 +25,16 @@ import Pages.StaticHttp.Request
 import TerminalText as Terminal
 
 
+{-| -}
+type alias JsonValue =
+    Decode.Value
+
+
+{-| -}
+type alias Program =
+    Program.StatefulProgram Model Msg (BackendTask FatalError.FatalError ()) Flags
+
+
 {-| -}
 type alias Flags =
     { compatibilityKey : Int
@@ -47,7 +57,7 @@ type Msg
 {-| -}
 app :
     GeneratorProgramConfig
-    -> Program.StatefulProgram Model Msg (BackendTask FatalError ()) Flags
+    -> Program
 app config =
     let
         cliConfig : Program.Config (BackendTask FatalError ())

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

@@ -68,13 +68,7 @@ nextStep allRawResponses staticResponses { errors } =
                     )
     in
     if pendingRequests then
-        let
-            newThing : List HashRequest.Request
-            newThing =
-                urlsToPerform
-                    |> List.Extra.uniqueBy HashRequest.hash
-        in
-        Continue newThing progressedBackendTask
+        Continue urlsToPerform progressedBackendTask
 
     else
         let