elm-pages 3.0.0-beta.13 → 3.0.0-beta.14

package/src/Exception.elm

@@ -0,0 +1,37 @@
+module Exception exposing (Throwable, Catchable(..), fromString, fromStringWithValue, throw)
+
+{-|
+
+@docs Throwable, Catchable, fromString, fromStringWithValue, throw
+
+-}
+
+
+{-| -}
+type alias Throwable =
+    Catchable ()
+
+
+{-| -}
+type Catchable error
+    = Catchable error { title : String, body : String }
+
+
+{-| -}
+fromString : String -> Catchable ()
+fromString string =
+    fromStringWithValue string ()
+
+
+{-| -}
+fromStringWithValue : String -> value -> Catchable value
+fromStringWithValue string value =
+    Catchable value { title = "Custom Error", body = string }
+
+
+{-| -}
+throw : Catchable error -> Catchable ()
+throw exception =
+    case exception of
+        Catchable _ string ->
+            Catchable () string

package/src/Form.elm

@@ -23,7 +23,7 @@ module Form exposing
   - Showing validation errors on the client-side
   - Receiving a form submission on the server-side
   - Using the exact same client-side validations on the server-side
-  - Letting you run server-only Validations with DataSource's (things like checking for a unique username)
+  - Letting you run server-only Validations with BackendTask's (things like checking for a unique username)
 
 Because elm-pages is a framework, it has its own internal Model and Msg's. That means you, the user,
 can offload some of the responsibility to elm-pages and build an interactive form with real-time
@@ -64,7 +64,7 @@ them into a type and/or errors.
 
 Totally customizable. Uses [`Form.FieldView`](Form-FieldView) to render all of the fields declared.
 
-    import DataSource exposing (DataSource)
+    import BackendTask exposing (BackendTask)
     import ErrorPage exposing (ErrorPage)
     import Form
     import Form.Field as Field
@@ -184,7 +184,7 @@ Totally customizable. Uses [`Form.FieldView`](Form-FieldView) to render all of t
 
 ### Step 3 - Handle Server-Side Form Submissions
 
-    action : RouteParams -> Request.Parser (DataSource (Response ActionData ErrorPage))
+    action : RouteParams -> Request.Parser (BackendTask (Response ActionData ErrorPage))
     action routeParams =
         Request.formData [ signupForm ]
             |> Request.map
@@ -192,8 +192,8 @@ Totally customizable. Uses [`Form.FieldView`](Form-FieldView) to render all of t
                     case signupResult of
                         Ok newUser ->
                             newUser
-                                |> myCreateUserDataSource
-                                |> DataSource.map
+                                |> myCreateUserBackendTask
+                                |> BackendTask.map
                                     (\() ->
                                         -- redirect to the home page
                                         -- after successful sign-up
@@ -202,12 +202,12 @@ Totally customizable. Uses [`Form.FieldView`](Form-FieldView) to render all of t
 
                         Err _ ->
                             Route.redirectTo Route.Login
-                                |> DataSource.succeed
+                                |> BackendTask.succeed
                 )
 
-    myCreateUserDataSource : DataSource ()
-    myCreateUserDataSource =
-        DataSource.fail
+    myCreateUserBackendTask : BackendTask ()
+    myCreateUserBackendTask =
+        BackendTask.fail
             "TODO - make a database call to create a new user"
 
 
@@ -267,7 +267,7 @@ Totally customizable. Uses [`Form.FieldView`](Form-FieldView) to render all of t
 
 -}
 
-import DataSource exposing (DataSource)
+import BackendTask exposing (BackendTask)
 import Dict exposing (Dict)
 import Form.Field as Field exposing (Field(..))
 import Form.FieldStatus as FieldStatus exposing (FieldStatus)
@@ -681,7 +681,7 @@ toServerForm :
     ->
         Form
             error
-            { combine : Validation.Validation error (DataSource (Validation.Validation error combined kind constraints)) kind constraints
+            { combine : Validation.Validation error (BackendTask backendTaskError (Validation.Validation error combined kind constraints)) kind constraints
             , view : viewFn
             }
             data
@@ -694,7 +694,7 @@ toServerForm (Form a b c) =
                 { result : Dict String (List error)
                 , isMatchCandidate : Bool
                 , combineAndView :
-                    { combine : Validation.Validation error (DataSource (Validation.Validation error combined kind constraints)) kind constraints
+                    { combine : Validation.Validation error (BackendTask backendTaskError (Validation.Validation error combined kind constraints)) kind constraints
                     , view : viewFn
                     }
                 }
@@ -705,7 +705,7 @@ toServerForm (Form a b c) =
                         , combineAndView =
                             { combine =
                                 thing.combineAndView.combine
-                                    |> DataSource.succeed
+                                    |> BackendTask.succeed
                                     |> Validation.succeed2
                             , view = thing.combineAndView.view
                             }
@@ -1568,12 +1568,12 @@ initCombinedServer :
         Form
             error
             { combineAndView
-                | combine : Combined error (DataSource (Validation.Validation error parsed kind constraints))
+                | combine : Combined error (BackendTask backendTaskError (Validation.Validation error parsed kind constraints))
             }
             input
-    -> ServerForms error (DataSource (Validation.Validation error combined kind constraints))
+    -> ServerForms error (BackendTask backendTaskError (Validation.Validation error combined kind constraints))
 initCombinedServer mapFn serverForms =
-    initCombined (DataSource.map (Validation.map mapFn)) serverForms
+    initCombined (BackendTask.map (Validation.map mapFn)) serverForms
 
 
 {-| -}
@@ -1584,13 +1584,13 @@ combineServer :
             error
             { combineAndView
                 | combine :
-                    Combined error (DataSource (Validation.Validation error parsed kind constraints))
+                    Combined error (BackendTask backendTaskError (Validation.Validation error parsed kind constraints))
             }
             input
-    -> ServerForms error (DataSource (Validation.Validation error combined kind constraints))
-    -> ServerForms error (DataSource (Validation.Validation error combined kind constraints))
+    -> ServerForms error (BackendTask backendTaskError (Validation.Validation error combined kind constraints))
+    -> ServerForms error (BackendTask backendTaskError (Validation.Validation error combined kind constraints))
 combineServer mapFn a b =
-    combine (DataSource.map (Validation.map mapFn)) a b
+    combine (BackendTask.map (Validation.map mapFn)) a b
 
 
 {-| -}

package/src/Head.elm

@@ -15,18 +15,18 @@ when your page is pre-rendered (or server-rendered, in the case of your server-r
 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 DataSource resolved, and the `Model` from `init`).
+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 `DataSource` and the `RouteParams` for the page and can return head tags based on that.
+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 DataSource exposing (DataSource)
+    import BackendTask exposing (BackendTask)
     import Head
     import MimeType
     import SiteConfig exposing (SiteConfig)
@@ -37,7 +37,7 @@ Here is a common set of global head tags that we can define in `Site.elm`:
     , head = head
     }
 
-    head : DataSource (List Head.Tag)
+    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")
@@ -49,13 +49,13 @@ Here is a common set of global head tags that we can define in `Site.elm`:
     , Head.appleTouchIcon (Just 180) (cloudinaryIcon MimeType.Png 180)
     , Head.appleTouchIcon (Just 192) (cloudinaryIcon MimeType.Png 192)
     ]
-    |> DataSource.succeed
+    |> BackendTask.succeed
 
-And here is a `head` function for a Route Module for a blog post. Note that we have access to our `DataSource` Data and
+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 DataSource
+    import BackendTask
     import Date
     import Head
     import Head.Seo

package/src/Internal/ApiRoute.elm

@@ -8,8 +8,10 @@ module Internal.ApiRoute exposing
     , withRoutes
     )
 
-import DataSource exposing (DataSource)
+import BackendTask exposing (BackendTask)
+import Exception exposing (Throwable)
 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 Throwable (Maybe response)
+        , buildTimeRoutes : BackendTask Throwable (List String)
+        , handleRoute : String -> BackendTask Throwable Bool
         , pattern : Pattern
         , kind : String
-        , globalHeadTags : Maybe (DataSource (List Head.Tag))
+        , globalHeadTags : Maybe (BackendTask Throwable (List Head.Tag))
         }
 
 

package/src/PageServerResponse.elm

@@ -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/Generate.elm

@@ -101,10 +101,8 @@ preRender input =
         , pages =
             input.pages
                 |> Elm.withType
-                    (Elm.Annotation.namedWith [ "DataSource" ]
-                        "DataSource"
-                        [ Elm.Annotation.list <| Elm.Annotation.named [] "RouteParams"
-                        ]
+                    (throwableTask
+                        (Elm.Annotation.list <| Elm.Annotation.named [] "RouteParams")
                     )
                 |> Just
         , head = input.head
@@ -163,10 +161,8 @@ buildNoState definitions builder_ =
                     , msg = Alias Elm.Annotation.unit
                     , data = builder.data |> Tuple.first
                     , actionData =
-                        Elm.Annotation.namedWith [ "DataSource" ]
-                            "DataSource"
-                            [ Elm.Annotation.list (Elm.Annotation.named [] "RouteParams")
-                            ]
+                        throwableTask
+                            (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
                 }
@@ -224,10 +220,8 @@ buildWithLocalState definitions builder_ =
                     , msg = definitions.msg
                     , data = builder.data |> Tuple.first
                     , actionData =
-                        Elm.Annotation.namedWith [ "DataSource" ]
-                            "DataSource"
-                            [ Elm.Annotation.list (Elm.Annotation.named [] "RouteParams")
-                            ]
+                        throwableTask
+                            (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
                 }
@@ -285,10 +279,8 @@ buildWithSharedState definitions builder_ =
                     , msg = definitions.msg
                     , data = builder.data |> Tuple.first
                     , actionData =
-                        Elm.Annotation.namedWith [ "DataSource" ]
-                            "DataSource"
-                            [ Elm.Annotation.list (Elm.Annotation.named [] "RouteParams")
-                            ]
+                        throwableTask
+                            (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                             |> Alias
                     }
                 }
@@ -439,10 +431,7 @@ userFunction moduleName definitions =
                                 |> Elm.withType
                                     (case definitions.action of
                                         Pages _ ->
-                                            Elm.Annotation.namedWith [ "DataSource" ]
-                                                "DataSource"
-                                                [ Elm.Annotation.named [] "Data"
-                                                ]
+                                            throwableTask (Elm.Annotation.named [] "Data")
 
                                         Action _ ->
                                             myType "Data"
@@ -464,10 +453,7 @@ userFunction moduleName definitions =
                                         |> Elm.withType
                                             (case definitions.action of
                                                 Pages _ ->
-                                                    Elm.Annotation.namedWith [ "DataSource" ]
-                                                        "DataSource"
-                                                        [ Elm.Annotation.named [] "Data"
-                                                        ]
+                                                    throwableTask (Elm.Annotation.named [] "Data")
 
                                                 Action _ ->
                                                     myType "Data"
@@ -556,10 +542,8 @@ userFunction moduleName definitions =
                                 { data =
                                     dataFn.call []
                                         |> Elm.withType
-                                            (Elm.Annotation.namedWith [ "DataSource" ]
-                                                "DataSource"
-                                                [ Elm.Annotation.named [] "Data"
-                                                ]
+                                            (throwableTask
+                                                (Elm.Annotation.named [] "Data")
                                             )
                                 , head = headFn.call
                                 }
@@ -571,11 +555,7 @@ userFunction moduleName definitions =
                                     \routeParams ->
                                         dataFn.call [ routeParams ]
                                             |> Elm.withType
-                                                (Elm.Annotation.namedWith [ "DataSource" ]
-                                                    "DataSource"
-                                                    [ Elm.Annotation.named [] "Data"
-                                                    ]
-                                                )
+                                                (throwableTask (Elm.Annotation.named [] "Data"))
                                 , head = headFn.call
                                 }
                     )
@@ -646,14 +626,13 @@ myType : String -> Elm.Annotation.Annotation
 myType dataType =
     Elm.Annotation.namedWith [ "Server", "Request" ]
         "Parser"
-        [ Elm.Annotation.namedWith [ "DataSource" ]
-            "DataSource"
-            [ Elm.Annotation.namedWith [ "Server", "Response" ]
+        [ throwableTask
+            (Elm.Annotation.namedWith [ "Server", "Response" ]
                 "Response"
                 [ Elm.Annotation.named [] dataType
                 , Elm.Annotation.named [ "ErrorPage" ] "ErrorPage"
                 ]
-            ]
+            )
         ]
 
 
@@ -688,10 +667,8 @@ serverRender_ serverRenderArg =
                                     (Elm.Annotation.namedWith
                                         [ "Server", "Request" ]
                                         "Parser"
-                                        [ Elm.Annotation.namedWith
-                                            [ "DataSource" ]
-                                            "DataSource"
-                                            [ Elm.Annotation.namedWith
+                                        [ throwableTask
+                                            (Elm.Annotation.namedWith
                                                 [ "Server", "Response" ]
                                                 "Response"
                                                 [ Elm.Annotation.var "data"
@@ -700,7 +677,7 @@ serverRender_ serverRenderArg =
                                                     "ErrorPage"
                                                     []
                                                 ]
-                                            ]
+                                            )
                                         ]
                                     )
                               )
@@ -710,10 +687,8 @@ serverRender_ serverRenderArg =
                                     (Elm.Annotation.namedWith
                                         [ "Server", "Request" ]
                                         "Parser"
-                                        [ Elm.Annotation.namedWith
-                                            [ "DataSource" ]
-                                            "DataSource"
-                                            [ Elm.Annotation.namedWith
+                                        [ throwableTask
+                                            (Elm.Annotation.namedWith
                                                 [ "Server", "Response" ]
                                                 "Response"
                                                 [ Elm.Annotation.var "action"
@@ -722,7 +697,7 @@ serverRender_ serverRenderArg =
                                                     "ErrorPage"
                                                     []
                                                 ]
-                                            ]
+                                            )
                                         ]
                                     )
                               )
@@ -785,19 +760,11 @@ preRender_ serverRenderArg =
                             [ ( "data"
                               , Elm.Annotation.function
                                     [ Elm.Annotation.var "routeParams" ]
-                                    (Elm.Annotation.namedWith
-                                        [ "DataSource" ]
-                                        "DataSource"
-                                        [ Elm.Annotation.var "data"
-                                        ]
-                                    )
+                                    (throwableTask (Elm.Annotation.var "data"))
                               )
                             , ( "pages"
-                              , Elm.Annotation.namedWith
-                                    [ "DataSource" ]
-                                    "DataSource"
-                                    [ Elm.Annotation.list (Elm.Annotation.named [] "RouteParams")
-                                    ]
+                              , throwableTask
+                                    (Elm.Annotation.list (Elm.Annotation.named [] "RouteParams"))
                               )
                             , ( "head"
                               , Elm.Annotation.function
@@ -849,11 +816,7 @@ single_ serverRenderArg =
                     (Elm.Annotation.function
                         [ Elm.Annotation.record
                             [ ( "data"
-                              , Elm.Annotation.namedWith
-                                    [ "DataSource" ]
-                                    "DataSource"
-                                    [ Elm.Annotation.var "data"
-                                    ]
+                              , throwableTask (Elm.Annotation.var "data")
                               )
                             , ( "head"
                               , Elm.Annotation.function
@@ -1243,3 +1206,12 @@ buildNoState_ buildNoStateArg buildNoStateArg0 =
             ]
         , buildNoStateArg0
         ]
+
+
+throwableTask : Elm.Annotation.Annotation -> Elm.Annotation.Annotation
+throwableTask dataType =
+    Elm.Annotation.namedWith [ "BackendTask" ]
+        "BackendTask"
+        [ Elm.Annotation.named [ "Exception" ] "Throwable"
+        , dataType
+        ]