@almadar/std 16.241.0 → 16.242.0

package/behaviors/registry/infra/atoms/std-page-treat.orb

@@ -0,0 +1,494 @@
+{
+  "description": "std-page-treat — applies a declared visual treatment to one element of a browser tab (hide, blur, highlight, or label it with text) or restores it, and reports which element it treated. TREAT takes the tab and element id std-page-watch reports. The treatments are a fixed, declared set: no arbitrary styles or scripts. Needs a host with the `page` service (a browser extension).",
+  "ledger": {
+    "entries": {
+      "ent_01M431PMWEZFEQMV1ZADZ4AR3S": {
+        "bakedName": "PageTreatRecord",
+        "curName": "PageTreatRecord",
+        "id": "ent_01M431PMWEZFEQMV1ZADZ4AR3S",
+        "kind": "entity",
+        "owner": "workspace",
+        "renames": []
+      },
+      "evt_01M431PMWE4VVYTJQ6GD0DRJ28": {
+        "bakedName": "TREAT",
+        "curName": "TREAT",
+        "id": "evt_01M431PMWE4VVYTJQ6GD0DRJ28",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "evt_01M431PMWEAB7ZC4WPP859PDC7": {
+        "bakedName": "APPLIED",
+        "curName": "APPLIED",
+        "id": "evt_01M431PMWEAB7ZC4WPP859PDC7",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "evt_01M431PMWEBZK1KCZAB9FG6AE1": {
+        "bakedName": "TREAT_FAILED",
+        "curName": "TREAT_FAILED",
+        "id": "evt_01M431PMWEBZK1KCZAB9FG6AE1",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "evt_01M431PMWEC98MRRW9ZBPEGHEK": {
+        "bakedName": "INIT",
+        "curName": "INIT",
+        "id": "evt_01M431PMWEC98MRRW9ZBPEGHEK",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "evt_01M431PMWETQ15DFSCY7X3S3DQ": {
+        "bakedName": "APPLY_FAILED",
+        "curName": "APPLY_FAILED",
+        "id": "evt_01M431PMWETQ15DFSCY7X3S3DQ",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "evt_01M431PMWEYV983BES8KAC6K4E": {
+        "bakedName": "TREATED",
+        "curName": "TREATED",
+        "id": "evt_01M431PMWEYV983BES8KAC6K4E",
+        "kind": "event",
+        "owner": "workspace",
+        "parent": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "renames": []
+      },
+      "orb_01M431PMWEGB77DC3DGPK02RAP": {
+        "bakedName": "PageTreatOrbital",
+        "curName": "PageTreatOrbital",
+        "id": "orb_01M431PMWEGB77DC3DGPK02RAP",
+        "kind": "orbital",
+        "owner": "workspace",
+        "renames": []
+      },
+      "pag_01M431PMWEF9RN6XNBYXP13BJ4": {
+        "bakedName": "PageTreatPage",
+        "curName": "PageTreatPage",
+        "id": "pag_01M431PMWEF9RN6XNBYXP13BJ4",
+        "kind": "page",
+        "owner": "workspace",
+        "renames": []
+      },
+      "trt_01M431PMWE8GVWK42G31TJKSYS": {
+        "bakedName": "PageTreat",
+        "curName": "PageTreat",
+        "id": "trt_01M431PMWE8GVWK42G31TJKSYS",
+        "kind": "trait",
+        "owner": "workspace",
+        "renames": []
+      }
+    },
+    "schemaVersion": 1
+  },
+  "name": "std-page-treat",
+  "orbitals": [
+    {
+      "entity": {
+        "fields": [
+          {
+            "default": 0.0,
+            "description": "How many treatments were applied",
+            "name": "treated",
+            "synonyms": "count, applied",
+            "type": "number"
+          },
+          {
+            "default": "",
+            "description": "Why the last treatment failed; blank = none",
+            "name": "errorMessage",
+            "synonyms": "error, failure reason",
+            "type": "string"
+          }
+        ],
+        "id": "ent_01M431PMWEZFEQMV1ZADZ4AR3S",
+        "name": "PageTreatRecord",
+        "persistence": "runtime"
+      },
+      "id": "orb_01M431PMWEGB77DC3DGPK02RAP",
+      "name": "PageTreatOrbital",
+      "pages": [
+        {
+          "id": "pag_01M431PMWEF9RN6XNBYXP13BJ4",
+          "name": "PageTreatPage",
+          "path": "/page-treat",
+          "traits": [
+            {
+              "ref": "PageTreat",
+              "refId": "trt_01M431PMWE8GVWK42G31TJKSYS"
+            }
+          ]
+        }
+      ],
+      "traits": [
+        {
+          "category": "interaction",
+          "config": {
+            "statusSlot": {
+              "default": "main",
+              "description": "Where the atom shows its one-line status; an organism running it in the background sends it to `system`",
+              "label": "Status slot",
+              "synonyms": "status area, slot",
+              "tier": "presentation",
+              "type": "slot"
+            }
+          },
+          "effectRow": [
+            {
+              "kind": "call-service",
+              "resource": "page.apply"
+            },
+            {
+              "kind": "emit",
+              "resource": "TREATED"
+            },
+            {
+              "kind": "emit",
+              "resource": "TREAT_FAILED"
+            },
+            {
+              "kind": "render-ui",
+              "resolved": false,
+              "resource": "@config.statusSlot"
+            },
+            {
+              "kind": "set",
+              "resource": "@entity.errorMessage"
+            },
+            {
+              "kind": "set",
+              "resource": "@entity.treated"
+            }
+          ],
+          "emits": [
+            {
+              "description": "The page service applied the treatment",
+              "event": "APPLIED",
+              "eventId": "evt_01M431PMWEAB7ZC4WPP859PDC7",
+              "payloadSchema": [
+                {
+                  "name": "applied",
+                  "required": true,
+                  "type": "boolean"
+                },
+                {
+                  "name": "tab",
+                  "required": true,
+                  "type": "number"
+                },
+                {
+                  "name": "elementId",
+                  "required": true,
+                  "type": "string"
+                },
+                {
+                  "name": "treatment",
+                  "type": "string"
+                }
+              ],
+              "tier": "secondary"
+            },
+            {
+              "description": "The page service could not apply the treatment",
+              "event": "APPLY_FAILED",
+              "eventId": "evt_01M431PMWETQ15DFSCY7X3S3DQ",
+              "payloadSchema": [
+                {
+                  "name": "error",
+                  "required": true,
+                  "type": "string"
+                }
+              ],
+              "tier": "secondary"
+            },
+            {
+              "description": "The element now shows the treatment (or, for restore, is back as it was)",
+              "event": "TREATED",
+              "eventId": "evt_01M431PMWEYV983BES8KAC6K4E",
+              "payloadSchema": [
+                {
+                  "name": "tab",
+                  "required": true,
+                  "type": "number"
+                },
+                {
+                  "name": "elementId",
+                  "required": true,
+                  "type": "string"
+                },
+                {
+                  "name": "treatment",
+                  "type": "string"
+                }
+              ],
+              "scope": "external",
+              "synonyms": "hidden, blurred, highlighted, labelled, restored",
+              "tier": "primary"
+            },
+            {
+              "description": "The treatment could not be applied (the element is gone, or the tab closed)",
+              "event": "TREAT_FAILED",
+              "eventId": "evt_01M431PMWEBZK1KCZAB9FG6AE1",
+              "payloadSchema": [
+                {
+                  "name": "error",
+                  "required": true,
+                  "type": "string"
+                }
+              ],
+              "scope": "external",
+              "tier": "primary"
+            }
+          ],
+          "entityRefIds": {
+            "PageTreatRecord": "ent_01M431PMWEZFEQMV1ZADZ4AR3S"
+          },
+          "id": "trt_01M431PMWE8GVWK42G31TJKSYS",
+          "linkedEntity": "PageTreatRecord",
+          "linkedEntityId": "ent_01M431PMWEZFEQMV1ZADZ4AR3S",
+          "name": "PageTreat",
+          "scope": "instance",
+          "stateMachine": {
+            "events": [
+              {
+                "id": "evt_01M431PMWEC98MRRW9ZBPEGHEK",
+                "key": "INIT",
+                "name": "Initialize"
+              },
+              {
+                "description": "Treat one page element; `label` is the text shown with it (for example why it was hidden)",
+                "external": true,
+                "id": "evt_01M431PMWE4VVYTJQ6GD0DRJ28",
+                "key": "TREAT",
+                "name": "Treat",
+                "payloadSchema": [
+                  {
+                    "name": "tab",
+                    "required": true,
+                    "type": "number"
+                  },
+                  {
+                    "name": "elementId",
+                    "required": true,
+                    "type": "string"
+                  },
+                  {
+                    "name": "treatment",
+                    "type": "string"
+                  },
+                  {
+                    "name": "label",
+                    "type": "string"
+                  }
+                ]
+              },
+              {
+                "description": "The page service applied the treatment",
+                "id": "evt_01M431PMWEAB7ZC4WPP859PDC7",
+                "key": "APPLIED",
+                "name": "Applied",
+                "payloadSchema": [
+                  {
+                    "name": "applied",
+                    "required": true,
+                    "type": "boolean"
+                  },
+                  {
+                    "name": "tab",
+                    "required": true,
+                    "type": "number"
+                  },
+                  {
+                    "name": "elementId",
+                    "required": true,
+                    "type": "string"
+                  },
+                  {
+                    "name": "treatment",
+                    "type": "string"
+                  }
+                ],
+                "tier": "secondary"
+              },
+              {
+                "description": "The page service could not apply the treatment",
+                "id": "evt_01M431PMWETQ15DFSCY7X3S3DQ",
+                "key": "APPLY_FAILED",
+                "name": "Apply Failed",
+                "payloadSchema": [
+                  {
+                    "name": "error",
+                    "required": true,
+                    "type": "string"
+                  }
+                ],
+                "tier": "secondary"
+              },
+              {
+                "description": "The element now shows the treatment (or, for restore, is back as it was)",
+                "id": "evt_01M431PMWEYV983BES8KAC6K4E",
+                "key": "TREATED",
+                "name": "Treated",
+                "payloadSchema": [
+                  {
+                    "name": "tab",
+                    "required": true,
+                    "type": "number"
+                  },
+                  {
+                    "name": "elementId",
+                    "required": true,
+                    "type": "string"
+                  },
+                  {
+                    "name": "treatment",
+                    "type": "string"
+                  }
+                ],
+                "synonyms": "hidden, blurred, highlighted, labelled, restored",
+                "tier": "primary"
+              },
+              {
+                "description": "The treatment could not be applied (the element is gone, or the tab closed)",
+                "id": "evt_01M431PMWEBZK1KCZAB9FG6AE1",
+                "key": "TREAT_FAILED",
+                "name": "Treat Failed",
+                "payloadSchema": [
+                  {
+                    "name": "error",
+                    "required": true,
+                    "type": "string"
+                  }
+                ],
+                "tier": "primary"
+              }
+            ],
+            "states": [
+              {
+                "isInitial": true,
+                "name": "ready"
+              }
+            ],
+            "transitions": [
+              {
+                "effects": [
+                  [
+                    "render-ui",
+                    "@config.statusSlot",
+                    {
+                      "content": "Ready to treat page elements",
+                      "role": "status",
+                      "type": "typography",
+                      "variant": "body"
+                    }
+                  ]
+                ],
+                "event": "INIT",
+                "eventId": "evt_01M431PMWEC98MRRW9ZBPEGHEK",
+                "from": "ready",
+                "to": "ready"
+              },
+              {
+                "effects": [
+                  [
+                    "call-service",
+                    "page",
+                    "apply",
+                    {
+                      "elementId": "@payload.elementId",
+                      "label": "@payload.label",
+                      "tab": "@payload.tab",
+                      "treatment": "@payload.treatment"
+                    },
+                    {
+                      "emit": {
+                        "failure": "APPLY_FAILED",
+                        "success": "APPLIED"
+                      }
+                    }
+                  ]
+                ],
+                "event": "TREAT",
+                "eventId": "evt_01M431PMWE4VVYTJQ6GD0DRJ28",
+                "from": "ready",
+                "to": "ready"
+              },
+              {
+                "effects": [
+                  [
+                    "set",
+                    "@entity.treated",
+                    [
+                      "+",
+                      "@entity.treated",
+                      1.0
+                    ]
+                  ],
+                  [
+                    "emit",
+                    "TREATED",
+                    {
+                      "elementId": "@payload.elementId",
+                      "tab": "@payload.tab",
+                      "treatment": "@payload.treatment"
+                    }
+                  ]
+                ],
+                "event": "APPLIED",
+                "eventId": "evt_01M431PMWEAB7ZC4WPP859PDC7",
+                "from": "ready",
+                "to": "ready"
+              },
+              {
+                "effects": [
+                  [
+                    "set",
+                    "@entity.errorMessage",
+                    "@payload.error"
+                  ],
+                  [
+                    "emit",
+                    "TREAT_FAILED",
+                    {
+                      "error": "@payload.error"
+                    }
+                  ],
+                  [
+                    "render-ui",
+                    "@config.statusSlot",
+                    {
+                      "content": [
+                        "str/concat",
+                        "Couldn't treat a page element: ",
+                        "@payload.error"
+                      ],
+                      "role": "status",
+                      "type": "typography",
+                      "variant": "body"
+                    }
+                  ]
+                ],
+                "event": "APPLY_FAILED",
+                "eventId": "evt_01M431PMWETQ15DFSCY7X3S3DQ",
+                "from": "ready",
+                "to": "ready"
+              }
+            ]
+          }
+        }
+      ]
+    }
+  ],
+  "schemaVersion": 1,
+  "version": "1.0.0"
+}