@almadar/std 14.26.0 → 14.27.0

package/dist/behaviors/registry/app/atoms/std-email-broadcast.orb

@@ -1,7 +1,7 @@
 {
   "name": "std-email-broadcast",
   "version": "1.0.0",
-  "description": "std-email-broadcast — send an email blast to a segment of contacts using a chosen template; tracks send progress.",
+  "description": "std-email-broadcast — send an email blast to a segment of contacts using a chosen template. Lists broadcasts in `browsing`; opens detail in `viewing_single` with Send / Cancel actions.",
   "orbitals": [
     {
       "name": "EmailBroadcastOrbital",
@@ -70,6 +70,57 @@
           "category": "interaction",
           "linkedEntity": "EmailBroadcast",
           "emits": [
+            {
+              "event": "OPEN_BROADCAST",
+              "payloadSchema": [
+                {
+                  "name": "id",
+                  "type": "string",
+                  "required": true
+                },
+                {
+                  "name": "row.id",
+                  "type": "string",
+                  "required": true
+                },
+                {
+                  "name": "row.name",
+                  "type": "string",
+                  "required": true
+                },
+                {
+                  "name": "row.subject",
+                  "type": "string"
+                },
+                {
+                  "name": "row.segmentId",
+                  "type": "string"
+                },
+                {
+                  "name": "row.templateId",
+                  "type": "string"
+                },
+                {
+                  "name": "row.status",
+                  "type": "string"
+                },
+                {
+                  "name": "row.scheduledAt",
+                  "type": "string"
+                },
+                {
+                  "name": "row.recipientCount",
+                  "type": "number"
+                },
+                {
+                  "name": "row.sentCount",
+                  "type": "number"
+                }
+              ]
+            },
+            {
+              "event": "CLOSE_VIEW"
+            },
             {
               "event": "SEND",
               "payloadSchema": [
@@ -80,6 +131,16 @@
                 }
               ]
             },
+            {
+              "event": "CANCEL_BROADCAST",
+              "payloadSchema": [
+                {
+                  "name": "id",
+                  "type": "string",
+                  "required": true
+                }
+              ]
+            },
             {
               "event": "EmailBroadcastLoaded",
               "payloadSchema": [
@@ -101,15 +162,6 @@
                   "type": "string"
                 }
               ]
-            },
-            {
-              "event": "BroadcastSent",
-              "payloadSchema": [
-                {
-                  "name": "id",
-                  "type": "string"
-                }
-              ]
             }
           ],
           "stateMachine": {
@@ -122,7 +174,7 @@
                 "name": "browsing"
               },
               {
-                "name": "sending"
+                "name": "viewing_single"
               },
               {
                 "name": "error"
@@ -158,23 +210,43 @@
                 ]
               },
               {
-                "key": "SEND",
-                "name": "Send",
+                "key": "OPEN_BROADCAST",
+                "name": "Open Broadcast",
                 "payloadSchema": [
                   {
-                    "name": "broadcastId",
+                    "name": "id",
                     "type": "string",
                     "required": true
+                  },
+                  {
+                    "name": "row",
+                    "type": "EmailBroadcast"
                   }
                 ]
               },
               {
-                "key": "BroadcastSent",
-                "name": "Broadcast sent",
+                "key": "CANCEL_BROADCAST",
+                "name": "Cancel Broadcast",
                 "payloadSchema": [
                   {
                     "name": "id",
-                    "type": "string"
+                    "type": "string",
+                    "required": true
+                  }
+                ]
+              },
+              {
+                "key": "CLOSE_VIEW",
+                "name": "Close View"
+              },
+              {
+                "key": "SEND",
+                "name": "Send",
+                "payloadSchema": [
+                  {
+                    "name": "broadcastId",
+                    "type": "string",
+                    "required": true
                   }
                 ]
               }
@@ -199,22 +271,22 @@
                     "render-ui",
                     "main",
                     {
-                      "gap": "md",
-                      "type": "stack",
-                      "direction": "vertical",
                       "align": "center",
-                      "className": "py-12",
                       "children": [
                         {
                           "type": "spinner"
                         },
                         {
-                          "color": "muted",
                           "type": "typography",
-                          "content": "Loading broadcasts…",
-                          "variant": "caption"
+                          "variant": "caption",
+                          "color": "muted",
+                          "content": "Loading broadcasts…"
                         }
-                      ]
+                      ],
+                      "gap": "md",
+                      "className": "py-12",
+                      "type": "stack",
+                      "direction": "vertical"
                     }
                   ]
                 ]
@@ -228,15 +300,14 @@
                     "render-ui",
                     "main",
                     {
-                      "direction": "vertical",
-                      "gap": "md",
                       "type": "stack",
+                      "direction": "vertical",
                       "children": [
                         {
                           "children": [
                             {
-                              "type": "icon",
-                              "name": "mail"
+                              "name": "mail",
+                              "type": "icon"
                             },
                             {
                               "content": "@config.title",
@@ -244,50 +315,72 @@
                               "variant": "h3"
                             }
                           ],
-                          "type": "stack",
+                          "direction": "horizontal",
+                          "align": "center",
                           "gap": "sm",
-                          "direction": "horizontal"
+                          "type": "stack"
+                        },
+                        {
+                          "type": "simple-grid",
+                          "cols": 4.0,
+                          "children": [
+                            {
+                              "value": "@payload.data.length",
+                              "icon": "mail",
+                              "label": "Total broadcasts",
+                              "type": "stat-display"
+                            },
+                            {
+                              "icon": "send",
+                              "type": "stat-display",
+                              "label": "Sent this month",
+                              "value": "23"
+                            },
+                            {
+                              "value": "41%",
+                              "label": "Open rate",
+                              "icon": "eye",
+                              "type": "stat-display"
+                            },
+                            {
+                              "value": "12%",
+                              "type": "stat-display",
+                              "icon": "mouse-pointer",
+                              "label": "Click rate"
+                            }
+                          ]
                         },
                         {
                           "type": "divider"
                         },
                         {
                           "entity": "@payload.data",
-                          "itemActions": [
-                            {
-                              "label": "Send",
-                              "variant": "primary",
-                              "event": "SEND",
-                              "icon": "send"
-                            }
-                          ],
                           "type": "data-grid",
-                          "gap": "sm",
                           "fields": [
                             {
+                              "name": "name",
                               "label": "Name",
-                              "variant": "caption",
-                              "name": "name"
+                              "variant": "caption"
                             },
                             {
+                              "variant": "caption",
                               "name": "subject",
-                              "label": "Subject",
-                              "variant": "caption"
+                              "label": "Subject"
                             },
                             {
+                              "name": "status",
                               "label": "Status",
-                              "variant": "badge",
-                              "name": "status"
+                              "variant": "badge"
                             },
                             {
-                              "name": "recipientCount",
+                              "variant": "caption",
                               "label": "Recipients",
-                              "variant": "badge"
+                              "name": "recipientCount"
                             },
                             {
-                              "name": "sentCount",
                               "label": "Sent",
-                              "variant": "badge"
+                              "variant": "caption",
+                              "name": "sentCount"
                             },
                             {
                               "name": "scheduledAt",
@@ -295,9 +388,24 @@
                               "variant": "caption"
                             }
                           ],
-                          "cols": 1.0
+                          "cols": 1.0,
+                          "gap": "sm",
+                          "itemActions": [
+                            {
+                              "event": "OPEN_BROADCAST",
+                              "label": "Open",
+                              "variant": "primary",
+                              "icon": "arrow-right"
+                            },
+                            {
+                              "label": "Cancel",
+                              "event": "CANCEL_BROADCAST",
+                              "variant": "danger"
+                            }
+                          ]
                         }
-                      ]
+                      ],
+                      "gap": "md"
                     }
                   ]
                 ]
@@ -311,16 +419,308 @@
                     "render-ui",
                     "main",
                     {
+                      "type": "alert",
                       "message": "@payload.error",
-                      "variant": "error",
-                      "type": "alert"
+                      "variant": "error"
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "browsing",
+                "to": "viewing_single",
+                "event": "OPEN_BROADCAST",
+                "effects": [
+                  [
+                    "set",
+                    "@entity.id",
+                    "@payload.row.id"
+                  ],
+                  [
+                    "set",
+                    "@entity.name",
+                    "@payload.row.name"
+                  ],
+                  [
+                    "set",
+                    "@entity.subject",
+                    "@payload.row.subject"
+                  ],
+                  [
+                    "set",
+                    "@entity.segmentId",
+                    "@payload.row.segmentId"
+                  ],
+                  [
+                    "set",
+                    "@entity.templateId",
+                    "@payload.row.templateId"
+                  ],
+                  [
+                    "set",
+                    "@entity.status",
+                    "@payload.row.status"
+                  ],
+                  [
+                    "set",
+                    "@entity.scheduledAt",
+                    "@payload.row.scheduledAt"
+                  ],
+                  [
+                    "set",
+                    "@entity.recipientCount",
+                    "@payload.row.recipientCount"
+                  ],
+                  [
+                    "set",
+                    "@entity.sentCount",
+                    "@payload.row.sentCount"
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "children": [
+                        {
+                          "type": "stack",
+                          "align": "center",
+                          "gap": "sm",
+                          "children": [
+                            {
+                              "label": "Back",
+                              "type": "button",
+                              "variant": "ghost",
+                              "action": "CLOSE_VIEW"
+                            },
+                            {
+                              "type": "icon",
+                              "name": "mail"
+                            },
+                            {
+                              "variant": "h3",
+                              "content": "@entity.name",
+                              "type": "typography"
+                            },
+                            {
+                              "variant": "primary",
+                              "type": "badge",
+                              "label": "@entity.status"
+                            }
+                          ],
+                          "direction": "horizontal"
+                        },
+                        {
+                          "type": "divider"
+                        },
+                        {
+                          "direction": "vertical",
+                          "gap": "sm",
+                          "children": [
+                            {
+                              "type": "stack",
+                              "children": [
+                                {
+                                  "type": "typography",
+                                  "color": "muted",
+                                  "content": "Subject",
+                                  "variant": "caption"
+                                },
+                                {
+                                  "content": "@entity.subject",
+                                  "type": "typography",
+                                  "variant": "body"
+                                }
+                              ],
+                              "gap": "md",
+                              "direction": "horizontal"
+                            },
+                            {
+                              "type": "stack",
+                              "children": [
+                                {
+                                  "color": "muted",
+                                  "type": "typography",
+                                  "variant": "caption",
+                                  "content": "Segment"
+                                },
+                                {
+                                  "type": "typography",
+                                  "content": "@entity.segmentId",
+                                  "variant": "body"
+                                }
+                              ],
+                              "direction": "horizontal",
+                              "gap": "md"
+                            },
+                            {
+                              "children": [
+                                {
+                                  "type": "typography",
+                                  "content": "Template",
+                                  "color": "muted",
+                                  "variant": "caption"
+                                },
+                                {
+                                  "type": "typography",
+                                  "content": "@entity.templateId",
+                                  "variant": "body"
+                                }
+                              ],
+                              "direction": "horizontal",
+                              "gap": "md",
+                              "type": "stack"
+                            }
+                          ],
+                          "type": "stack"
+                        },
+                        {
+                          "type": "divider"
+                        },
+                        {
+                          "cols": 3.0,
+                          "children": [
+                            {
+                              "value": "@entity.recipientCount",
+                              "type": "stat-display",
+                              "label": "Recipients",
+                              "icon": "users"
+                            },
+                            {
+                              "label": "Sent",
+                              "icon": "send",
+                              "value": "@entity.sentCount",
+                              "type": "stat-display"
+                            },
+                            {
+                              "icon": "calendar",
+                              "label": "Scheduled",
+                              "type": "stat-display",
+                              "value": "@entity.scheduledAt"
+                            }
+                          ],
+                          "type": "simple-grid"
+                        },
+                        {
+                          "align": "center",
+                          "direction": "horizontal",
+                          "children": [
+                            {
+                              "variant": "primary",
+                              "type": "button",
+                              "label": "Send Now",
+                              "action": "SEND",
+                              "actionPayload": {
+                                "broadcastId": "@entity.id",
+                                "id": "@entity.id"
+                              }
+                            },
+                            {
+                              "action": "CANCEL_BROADCAST",
+                              "label": "Cancel",
+                              "actionPayload": {
+                                "id": "@entity.id"
+                              },
+                              "type": "button",
+                              "variant": "danger"
+                            }
+                          ],
+                          "type": "stack",
+                          "gap": "sm"
+                        }
+                      ],
+                      "gap": "md",
+                      "type": "stack",
+                      "direction": "vertical"
                     }
                   ]
                 ]
               },
               {
                 "from": "browsing",
-                "to": "sending",
+                "to": "loading",
+                "event": "CANCEL_BROADCAST",
+                "effects": [
+                  [
+                    "set",
+                    "@entity.id",
+                    "@payload.id"
+                  ],
+                  [
+                    "fetch",
+                    "EmailBroadcast",
+                    {
+                      "emit": {
+                        "success": "EmailBroadcastLoaded",
+                        "failure": "EmailBroadcastLoadFailed"
+                      }
+                    }
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "align": "center",
+                      "direction": "vertical",
+                      "className": "py-12",
+                      "children": [
+                        {
+                          "type": "spinner"
+                        },
+                        {
+                          "content": "Cancelling broadcast…",
+                          "variant": "caption",
+                          "type": "typography",
+                          "color": "muted"
+                        }
+                      ],
+                      "gap": "md",
+                      "type": "stack"
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "viewing_single",
+                "to": "loading",
+                "event": "CLOSE_VIEW",
+                "effects": [
+                  [
+                    "fetch",
+                    "EmailBroadcast",
+                    {
+                      "emit": {
+                        "success": "EmailBroadcastLoaded",
+                        "failure": "EmailBroadcastLoadFailed"
+                      }
+                    }
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "children": [
+                        {
+                          "type": "spinner"
+                        },
+                        {
+                          "variant": "caption",
+                          "color": "muted",
+                          "type": "typography",
+                          "content": "Loading broadcasts…"
+                        }
+                      ],
+                      "className": "py-12",
+                      "direction": "vertical",
+                      "gap": "md",
+                      "type": "stack",
+                      "align": "center"
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "viewing_single",
+                "to": "loading",
                 "event": "SEND",
                 "effects": [
                   [
@@ -329,26 +729,79 @@
                     "@payload.broadcastId"
                   ],
                   [
-                    "emit",
-                    "BroadcastSent",
+                    "fetch",
+                    "EmailBroadcast",
                     {
-                      "id": "@payload.broadcastId"
+                      "emit": {
+                        "failure": "EmailBroadcastLoadFailed",
+                        "success": "EmailBroadcastLoaded"
+                      }
+                    }
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "className": "py-12",
+                      "children": [
+                        {
+                          "type": "spinner"
+                        },
+                        {
+                          "type": "typography",
+                          "variant": "caption",
+                          "color": "muted",
+                          "content": "Sending broadcast…"
+                        }
+                      ],
+                      "type": "stack",
+                      "gap": "md",
+                      "align": "center",
+                      "direction": "vertical"
                     }
                   ]
                 ]
               },
               {
-                "from": "sending",
-                "to": "browsing",
-                "event": "BroadcastSent",
+                "from": "viewing_single",
+                "to": "loading",
+                "event": "CANCEL_BROADCAST",
                 "effects": [
+                  [
+                    "set",
+                    "@entity.id",
+                    "@payload.id"
+                  ],
+                  [
+                    "fetch",
+                    "EmailBroadcast",
+                    {
+                      "emit": {
+                        "success": "EmailBroadcastLoaded",
+                        "failure": "EmailBroadcastLoadFailed"
+                      }
+                    }
+                  ],
                   [
                     "render-ui",
                     "main",
                     {
-                      "message": "Broadcast sent",
-                      "type": "alert",
-                      "variant": "success"
+                      "gap": "md",
+                      "type": "stack",
+                      "direction": "vertical",
+                      "align": "center",
+                      "className": "py-12",
+                      "children": [
+                        {
+                          "type": "spinner"
+                        },
+                        {
+                          "type": "typography",
+                          "variant": "caption",
+                          "color": "muted",
+                          "content": "Cancelling broadcast…"
+                        }
+                      ]
                     }
                   ]
                 ]