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

package/src/Server/Session.elm

@@ -13,13 +13,13 @@ to choose which requests to respond to and how to extract structured data from t
 Using these functions, you can store and read session data in cookies to maintain state between requests.
 For example, TODO:
 
-    action : RouteParams -> Request.Parser (DataSource (Response ActionData ErrorPage))
+    action : RouteParams -> Request.Parser (BackendTask (Response ActionData ErrorPage))
     action routeParams =
         MySession.withSession
             (Request.formDataWithServerValidation (form |> Form.initCombinedServer identity))
             (\nameResultData session ->
                 nameResultData
-                    |> DataSource.map
+                    |> BackendTask.map
                         (\nameResult ->
                             case nameResult of
                                 Err errors ->
@@ -42,7 +42,7 @@ For example, TODO:
                         )
             )
 
-The elm-pages framework will manage signing these cookies using the `secrets : DataSource (List String)` you pass in.
+The elm-pages framework will manage signing these cookies using the `secrets : BackendTask (List String)` you pass in.
 That means that the values you set in your session will be directly visible to anyone who has access to the cookie
 (so don't directly store sensitive data in your session). Since the session cookie is signed using the secret you provide,
 the cookie will be invalidated if it is tampered with because it won't match when elm-pages verifies that it has been
@@ -51,13 +51,13 @@ signed with your secrets. Of course you need to provide secure secrets and treat
 
 ### Rotating Secrets
 
-The first String in `secrets : DataSource (List String)` will be used to sign sessions, while the remaining String's will
+The first String in `secrets : BackendTask (List String)` will be used to sign sessions, while the remaining String's will
 still be used to attempt to "unsign" the cookies. So if you have a single secret:
 
     Session.withSession
         { name = "mysession"
         , secrets =
-            DataSource.map List.singleton
+            BackendTask.map List.singleton
                 (Env.expect "SESSION_SECRET2022-09-01")
         , options = cookieOptions
         }
@@ -67,7 +67,7 @@ Then you add a second secret
     Session.withSession
         { name = "mysession"
         , secrets =
-            DataSource.map2
+            BackendTask.map2
                 (\newSecret oldSecret -> [ newSecret, oldSecret ])
                 (Env.expect "SESSION_SECRET2022-12-01")
                 (Env.expect "SESSION_SECRET2022-09-01")
@@ -87,7 +87,7 @@ it will invalidate all cookies signed with that. For example, if we remove our o
     Session.withSession
         { name = "mysession"
         , secrets =
-            DataSource.map List.singleton
+            BackendTask.map List.singleton
                 (Env.expect "SESSION_SECRET2022-12-01")
         , options = cookieOptions
         }
@@ -107,9 +107,9 @@ so there's nothing wrong with an old session expiring (and the browser will even
 
 -}
 
-import DataSource exposing (DataSource)
-import DataSource.Http
-import DataSource.Internal.Request
+import BackendTask exposing (BackendTask)
+import BackendTask.Http
+import BackendTask.Internal.Request
 import Dict exposing (Dict)
 import Json.Decode
 import Json.Encode
@@ -242,23 +242,23 @@ flashPrefix =
 {-| -}
 withSession :
     { name : String
-    , secrets : DataSource (List String)
+    , secrets : BackendTask error (List String)
     , options : SetCookie.Options
     }
-    -> (request -> Result NotLoadedReason Session -> DataSource ( Session, Response data errorPage ))
+    -> (request -> Result NotLoadedReason Session -> BackendTask error ( Session, Response data errorPage ))
     -> Server.Request.Parser request
-    -> Server.Request.Parser (DataSource (Response data errorPage))
+    -> Server.Request.Parser (BackendTask error (Response data errorPage))
 withSession config toRequest userRequest =
     Server.Request.map2
         (\maybeSessionCookie userRequestData ->
             let
-                unsigned : DataSource (Result NotLoadedReason Session)
+                unsigned : BackendTask error (Result NotLoadedReason Session)
                 unsigned =
                     case maybeSessionCookie of
                         Just sessionCookie ->
                             sessionCookie
                                 |> unsignCookie config
-                                |> DataSource.map
+                                |> BackendTask.map
                                     (\unsignResult ->
                                         case unsignResult of
                                             Ok decoded ->
@@ -270,10 +270,10 @@ withSession config toRequest userRequest =
 
                         Nothing ->
                             Err NoSessionCookie
-                                |> DataSource.succeed
+                                |> BackendTask.succeed
             in
             unsigned
-                |> DataSource.andThen
+                |> BackendTask.andThen
                     (encodeSessionUpdate config toRequest userRequestData)
         )
         (Server.Request.cookie config.name)
@@ -282,19 +282,19 @@ withSession config toRequest userRequest =
 
 encodeSessionUpdate :
     { name : String
-    , secrets : DataSource (List String)
+    , secrets : BackendTask error (List String)
     , options : SetCookie.Options
     }
-    -> (c -> d -> DataSource ( Session, Response data errorPage ))
+    -> (c -> d -> BackendTask error ( Session, Response data errorPage ))
     -> c
     -> d
-    -> DataSource (Response data errorPage)
+    -> BackendTask error (Response data errorPage)
 encodeSessionUpdate config toRequest userRequestData sessionResult =
     sessionResult
         |> toRequest userRequestData
-        |> DataSource.andThen
+        |> BackendTask.andThen
             (\( sessionUpdate, response ) ->
-                DataSource.map
+                BackendTask.map
                     (\encoded ->
                         response
                             |> Server.Response.withSetCookieHeader
@@ -306,11 +306,11 @@ encodeSessionUpdate config toRequest userRequestData sessionResult =
             )
 
 
-unsignCookie : { a | secrets : DataSource (List String) } -> String -> DataSource (Result () Session)
+unsignCookie : { a | secrets : BackendTask error (List String) } -> String -> BackendTask error (Result () Session)
 unsignCookie config sessionCookie =
     sessionCookie
         |> unsign config.secrets (Json.Decode.dict Json.Decode.string)
-        |> DataSource.map
+        |> BackendTask.map
             (Result.map
                 (\dict ->
                     dict
@@ -331,15 +331,15 @@ unsignCookie config sessionCookie =
             )
 
 
-sign : DataSource (List String) -> Json.Encode.Value -> DataSource String
+sign : BackendTask error (List String) -> Json.Encode.Value -> BackendTask error String
 sign getSecrets input =
     getSecrets
-        |> DataSource.andThen
+        |> BackendTask.andThen
             (\secrets ->
-                DataSource.Internal.Request.request
+                BackendTask.Internal.Request.request
                     { name = "encrypt"
                     , body =
-                        DataSource.Http.jsonBody
+                        BackendTask.Http.jsonBody
                             (Json.Encode.object
                                 [ ( "values", input )
                                 , ( "secret"
@@ -353,21 +353,21 @@ sign getSecrets input =
                                 ]
                             )
                     , expect =
-                        DataSource.Http.expectJson
+                        BackendTask.Http.expectJson
                             Json.Decode.string
                     }
             )
 
 
-unsign : DataSource (List String) -> Json.Decode.Decoder a -> String -> DataSource (Result () a)
+unsign : BackendTask error (List String) -> Json.Decode.Decoder a -> String -> BackendTask error (Result () a)
 unsign getSecrets decoder input =
     getSecrets
-        |> DataSource.andThen
+        |> BackendTask.andThen
             (\secrets ->
-                DataSource.Internal.Request.request
+                BackendTask.Internal.Request.request
                     { name = "decrypt"
                     , body =
-                        DataSource.Http.jsonBody
+                        BackendTask.Http.jsonBody
                             (Json.Encode.object
                                 [ ( "input", Json.Encode.string input )
                                 , ( "secrets", Json.Encode.list Json.Encode.string secrets )
@@ -377,6 +377,6 @@ unsign getSecrets decoder input =
                         decoder
                             |> Json.Decode.nullable
                             |> Json.Decode.map (Result.fromMaybe ())
-                            |> DataSource.Http.expectJson
+                            |> BackendTask.Http.expectJson
                     }
             )

package/src/Server/SetCookie.elm

@@ -174,7 +174,7 @@ dynamically). In this API you opt into exposing a cookie you set to JavaScript t
 
 In general if you can accomplish your goal using HttpOnly cookies (i.e. not using `makeVisibleToJavaScript`) then
 it's a good practice. With server-rendered `elm-pages` applications you can often manage your session state by pulling
-in session data from cookies in a `DataSource` (which is resolved server-side before it ever reaches the browser).
+in session data from cookies in a `BackendTask` (which is resolved server-side before it ever reaches the browser).
 
 -}
 makeVisibleToJavaScript : Options -> Options

package/src/DataSource/Env.elm

@@ -1,62 +0,0 @@
-module DataSource.Env exposing (get, expect)
-
-{-| Because DataSource's in `elm-pages` never run in the browser (see [the DataSource docs](DataSource)), you can access environment variables securely. As long as the environment variable isn't sent
-down into the final `Data` value, it won't end up in the client!
-
-    import DataSource exposing (DataSource)
-    import DataSource.Env
-
-    type alias EnvVariables =
-        { sendGridKey : String
-        , siteUrl : String
-        }
-
-    sendEmail : Email -> DataSource ()
-    sendEmail email =
-        DataSource.map2 EnvVariables
-            (DataSource.Env.expect "SEND_GRID_KEY")
-            (DataSource.Env.get "BASE_URL"
-                |> DataSource.map (Maybe.withDefault "http://localhost:1234")
-            )
-            |> DataSource.andThen (sendEmailDataSource email)
-
-    sendEmailDataSource : Email -> EnvVariables -> DataSource ()
-    sendEmailDataSource email envVariables =
-        Debug.todo "Not defined here"
-
-@docs get, expect
-
--}
-
-import DataSource exposing (DataSource)
-import DataSource.Http
-import DataSource.Internal.Request
-import Json.Decode as Decode
-import Json.Encode as Encode
-
-
-{-| Get an environment variable, or Nothing if there is no environment variable matching that name.
--}
-get : String -> DataSource (Maybe String)
-get envVariableName =
-    DataSource.Internal.Request.request
-        { name = "env"
-        , body = DataSource.Http.jsonBody (Encode.string envVariableName)
-        , expect =
-            DataSource.Http.expectJson
-                (Decode.nullable Decode.string)
-        }
-
-
-{-| Get an environment variable, or a DataSource failure if there is no environment variable matching that name.
--}
-expect : String -> DataSource String
-expect envVariableName =
-    envVariableName
-        |> get
-        |> DataSource.andThen
-            (\maybeValue ->
-                maybeValue
-                    |> Result.fromMaybe ("DataSource.Env.expect was expecting a variable `" ++ envVariableName ++ "` but couldn't find a variable with that name.")
-                    |> DataSource.fromResult
-            )