Rename internal messages

Author: ghivert

src/grille_pain.gleam

@@ -46,40 +46,40 @@ pub fn simple() {
 
 fn update(model: Model, msg: Msg) {
   case msg {
-    msg.RemoveToast(id) -> {
+    msg.ToastHidDisplay(id) -> {
       let model = model.remove(model, id)
       let update = update_display(model)
       #(model, update)
     }
 
-    msg.StopToast(id) -> {
+    msg.UserEnteredToast(id) -> {
       let model = model.stop(model, id)
       #(model, effect.none())
     }
 
-    msg.ExternalHide(uuid:) -> {
+    msg.UserHidToast(uuid:) -> {
       case list.find(model.toasts, toast.by_uuid(_, uuid)) {
         Error(_) -> #(model, effect.none())
         Ok(toast) -> #(model, {
           use dispatch <- effect.from()
-          dispatch(msg.HideToast(toast.id, toast.iteration))
+          dispatch(msg.ToastTimedOut(toast.id, toast.iteration))
         })
       }
     }
 
-    msg.HideToast(id, iteration) -> {
+    msg.ToastTimedOut(id, iteration) -> {
       case list.find(model.toasts, toast.by_iteration(_, id, iteration)) {
         Error(_) -> #(model, effect.none())
         Ok(toast) -> {
           let model = model.hide(model, toast.id)
-          let to_remove = schedule(1000, msg.RemoveToast(id))
+          let to_remove = schedule(1000, msg.ToastHidDisplay(id))
           let update = update_display(model)
           #(model, effect.batch([to_remove, update]))
         }
       }
     }
 
-    msg.ResumeToast(id) -> {
+    msg.UserLeavedToast(id) -> {
       case list.find(model.toasts, toast.by_id(_, id)) {
         Error(_) -> #(model, effect.none())
         Ok(toast.Toast(sticky:, remaining:, iteration:, ..)) -> {
@@ -89,29 +89,29 @@ fn update(model: Model, msg: Msg) {
       }
     }
 
-    msg.NewToast(uuid:, message:, level:, timeout:, sticky:) -> {
+    msg.UserAddedToast(uuid:, message:, level:, timeout:, sticky:) -> {
       model.add(uuid:, model:, message:, level:, timeout:, sticky:)
       |> pair.new(update_display(model))
     }
 
     // Called after a requestAnimationFrame call.
     // Avoid to call an infinity of animation frames.
-    msg.UpdateNextAnimationFrame(frame) -> {
+    msg.LustreRequestedAnimationFrame(frame) -> {
       let next_frame = option.Some(frame)
       let model = Model(..model, next_frame:)
       #(model, effect.none())
     }
 
     // Recompute positions of every toast, and schedule a management of
     // model to recompute next positions.
-    msg.UpdateDisplay -> {
+    msg.BrowserUpdatedToasts -> {
       let model = Model(..model, next_frame: option.None)
       let model = model.update_bottom_positions(model)
       #(model, update_toasts(model))
     }
 
     // Compute the new state of toasts.
-    msg.UpdateToasts -> {
+    msg.LustreComputedToasts -> {
       let model = Model(..model, next_frame: option.None)
       case model.to_show {
         [] -> #(model, effect.none())
@@ -139,7 +139,7 @@ fn show(model: Model, id: Int, timeout: option.Option(Int), sticky: Bool) {
 
 fn schedule_hide(sticky, timeout, id, iteration) {
   use <- bool.lazy_guard(when: sticky, return: effect.none)
-  schedule(timeout, msg.HideToast(id, iteration))
+  schedule(timeout, msg.ToastTimedOut(id, iteration))
 }
 
 fn update_display(model: Model) {
@@ -148,9 +148,9 @@ fn update_display(model: Model) {
     option.None -> {
       use dispatch <- effect.from()
       dispatch({
-        msg.UpdateNextAnimationFrame({
+        msg.LustreRequestedAnimationFrame({
           use <- request_animation_frame()
-          dispatch(msg.UpdateDisplay)
+          dispatch(msg.BrowserUpdatedToasts)
         })
       })
     }
@@ -163,9 +163,9 @@ fn update_toasts(model: Model) {
     option.None -> {
       use dispatch <- effect.from()
       dispatch({
-        msg.UpdateNextAnimationFrame({
+        msg.LustreRequestedAnimationFrame({
           use <- request_animation_frame()
-          dispatch(msg.UpdateToasts)
+          dispatch(msg.LustreComputedToasts)
         })
       })
     }

src/grille_pain/internals/data/msg.gleam

@@ -3,19 +3,19 @@ import grille_pain/internals/data/model
 import grille_pain/toast/level.{type Level}
 
 pub type Msg {
-  ExternalHide(uuid: String)
-  HideToast(id: Int, iteration: Int)
-  NewToast(
+  BrowserUpdatedToasts
+  LustreComputedToasts
+  LustreRequestedAnimationFrame(model.AnimationFrame)
+  ToastHidDisplay(id: Int)
+  ToastTimedOut(id: Int, iteration: Int)
+  UserAddedToast(
     uuid: String,
     message: String,
     level: Level,
     timeout: Option(Int),
     sticky: Bool,
   )
-  RemoveToast(id: Int)
-  ResumeToast(id: Int)
-  StopToast(id: Int)
-  UpdateDisplay
-  UpdateToasts
-  UpdateNextAnimationFrame(model.AnimationFrame)
+  UserEnteredToast(id: Int)
+  UserHidToast(uuid: String)
+  UserLeavedToast(id: Int)
 }

src/grille_pain/internals/view.gleam

@@ -43,12 +43,12 @@ fn view_toast(toast: Toast) {
 
 fn select_on_click_action(toast: Toast) {
   use <- bool.lazy_guard(when: toast.sticky, return: attribute.none)
-  event.on_click(msg.HideToast(toast.id, toast.iteration))
+  event.on_click(msg.ToastTimedOut(toast.id, toast.iteration))
 }
 
 fn toast_container(toast: Toast, children: List(element.Element(Msg))) {
-  let mouse_enter = event.on_mouse_enter(msg.StopToast(toast.id))
-  let mouse_leave = event.on_mouse_leave(msg.ResumeToast(toast.id))
+  let mouse_enter = event.on_mouse_enter(msg.UserEnteredToast(toast.id))
+  let mouse_leave = event.on_mouse_leave(msg.UserLeavedToast(toast.id))
   [toast_colors(toast.level), toast_class()]
   |> list.map(css.compose)
   |> css.class

src/grille_pain/toast.gleam

@@ -57,7 +57,7 @@ fn dispatch_toast(options: Options, message: String) {
   use dispatch <- effect_manager.call
   let Options(timeout:, level:, sticky:) = options
   let level = option.unwrap(level, level.Standard)
-  msg.NewToast(uuid:, message:, level:, timeout:, sticky:)
+  msg.UserAddedToast(uuid:, message:, level:, timeout:, sticky:)
   |> lustre.dispatch
   |> dispatch
 }
@@ -99,7 +99,7 @@ pub fn custom(options: Options, content: String) {
 /// Hide toast. Sticky toast can only be hidden using `hide`.
 pub fn hide(id: String) {
   use dispatch <- effect_manager.call
-  msg.ExternalHide(id)
+  msg.UserHidToast(id)
   |> lustre.dispatch
   |> dispatch
 }