@almadar/std 3.2.2 → 3.3.4

package/behaviors/exports/atoms/std-service-custom-header.orb

@@ -0,0 +1,559 @@
+{
+  "name": "ServiceCustomHeaderOrbital",
+  "services": [
+    {
+      "name": "custom-header-api",
+      "type": "rest",
+      "baseUrl": "https://api.example.com/v1",
+      "auth": {
+        "type": "api-key",
+        "keyName": "X-API-Key",
+        "location": "header",
+        "secretEnv": "CUSTOM_API_SECRET"
+      }
+    }
+  ],
+  "orbitals": [
+    {
+      "name": "ServiceCustomHeaderOrbital",
+      "entity": {
+        "name": "ServiceCustomHeader",
+        "persistence": "runtime",
+        "fields": [
+          {
+            "name": "id",
+            "type": "string"
+          },
+          {
+            "name": "name",
+            "type": "string"
+          },
+          {
+            "name": "description",
+            "type": "string"
+          },
+          {
+            "name": "status",
+            "type": "string",
+            "default": "active",
+            "values": [
+              "active",
+              "inactive",
+              "pending"
+            ]
+          },
+          {
+            "name": "createdAt",
+            "type": "string"
+          },
+          {
+            "name": "endpoint",
+            "type": "string"
+          },
+          {
+            "name": "method",
+            "type": "string",
+            "default": "GET"
+          },
+          {
+            "name": "requestBody",
+            "type": "string"
+          },
+          {
+            "name": "responseData",
+            "type": "string"
+          },
+          {
+            "name": "statusCode",
+            "type": "number",
+            "default": 0
+          },
+          {
+            "name": "callStatus",
+            "type": "string",
+            "default": "idle"
+          },
+          {
+            "name": "error",
+            "type": "string"
+          }
+        ]
+      },
+      "traits": [
+        {
+          "name": "ServiceCustomHeaderCustomHeader",
+          "linkedEntity": "ServiceCustomHeader",
+          "category": "interaction",
+          "stateMachine": {
+            "states": [
+              {
+                "name": "idle",
+                "isInitial": true
+              },
+              {
+                "name": "calling"
+              },
+              {
+                "name": "complete"
+              },
+              {
+                "name": "error"
+              }
+            ],
+            "events": [
+              {
+                "key": "INIT",
+                "name": "Initialize"
+              },
+              {
+                "key": "CALL_API",
+                "name": "Call API"
+              },
+              {
+                "key": "API_RESPONSE",
+                "name": "API Response",
+                "payload": [
+                  {
+                    "name": "data",
+                    "type": "string",
+                    "required": true
+                  },
+                  {
+                    "name": "statusCode",
+                    "type": "number",
+                    "required": true
+                  }
+                ]
+              },
+              {
+                "key": "FAILED",
+                "name": "Failed",
+                "payload": [
+                  {
+                    "name": "error",
+                    "type": "string",
+                    "required": true
+                  }
+                ]
+              },
+              {
+                "key": "RETRY",
+                "name": "Retry"
+              },
+              {
+                "key": "RESET",
+                "name": "Reset"
+              }
+            ],
+            "transitions": [
+              {
+                "from": "idle",
+                "to": "idle",
+                "event": "INIT",
+                "effects": [
+                  [
+                    "fetch",
+                    "ServiceCustomHeader"
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "stack",
+                      "direction": "vertical",
+                      "gap": "lg",
+                      "align": "center",
+                      "children": [
+                        {
+                          "type": "icon",
+                          "name": "globe",
+                          "size": "lg"
+                        },
+                        {
+                          "type": "typography",
+                          "content": "API Tester",
+                          "variant": "h2"
+                        },
+                        {
+                          "type": "input",
+                          "field": "endpoint",
+                          "placeholder": "/users",
+                          "bind": "@entity.endpoint"
+                        },
+                        {
+                          "type": "select",
+                          "field": "method",
+                          "bind": "@entity.method",
+                          "options": [
+                            {
+                              "label": "GET",
+                              "value": "GET"
+                            },
+                            {
+                              "label": "POST",
+                              "value": "POST"
+                            },
+                            {
+                              "label": "PUT",
+                              "value": "PUT"
+                            },
+                            {
+                              "label": "DELETE",
+                              "value": "DELETE"
+                            }
+                          ]
+                        },
+                        {
+                          "type": "textarea",
+                          "field": "requestBody",
+                          "placeholder": "JSON request body",
+                          "bind": "@entity.requestBody"
+                        },
+                        {
+                          "type": "button",
+                          "label": "Send Request",
+                          "event": "CALL_API",
+                          "variant": "primary",
+                          "icon": "send"
+                        }
+                      ]
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "idle",
+                "to": "calling",
+                "event": "CALL_API",
+                "effects": [
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "loading-state",
+                      "title": "Calling API...",
+                      "message": "Sending request to servicecustomheader endpoint..."
+                    }
+                  ],
+                  [
+                    "call-service",
+                    "custom-header-api",
+                    "execute",
+                    {
+                      "endpoint": "@entity.endpoint",
+                      "method": "@entity.method",
+                      "body": "@entity.requestBody"
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "calling",
+                "to": "complete",
+                "event": "API_RESPONSE",
+                "effects": [
+                  [
+                    "set",
+                    "@entity.responseData",
+                    "@payload.data"
+                  ],
+                  [
+                    "set",
+                    "@entity.statusCode",
+                    "@payload.statusCode"
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "stack",
+                      "direction": "vertical",
+                      "gap": "lg",
+                      "align": "center",
+                      "children": [
+                        {
+                          "type": "icon",
+                          "name": "check-circle",
+                          "size": "lg"
+                        },
+                        {
+                          "type": "typography",
+                          "content": "Response",
+                          "variant": "h2"
+                        },
+                        {
+                          "type": "badge",
+                          "content": "@entity.statusCode",
+                          "variant": "info"
+                        },
+                        {
+                          "type": "code",
+                          "content": "@entity.responseData",
+                          "language": "json"
+                        },
+                        {
+                          "type": "button",
+                          "label": "New Request",
+                          "event": "RESET",
+                          "variant": "ghost",
+                          "icon": "rotate-ccw"
+                        }
+                      ]
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "calling",
+                "to": "error",
+                "event": "FAILED",
+                "effects": [
+                  [
+                    "set",
+                    "@entity.error",
+                    "@payload.error"
+                  ],
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "error-state",
+                      "title": "Request Failed",
+                      "message": "@entity.error",
+                      "onRetry": "RETRY"
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "error",
+                "to": "idle",
+                "event": "RETRY",
+                "effects": [
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "stack",
+                      "direction": "vertical",
+                      "gap": "lg",
+                      "align": "center",
+                      "children": [
+                        {
+                          "type": "icon",
+                          "name": "globe",
+                          "size": "lg"
+                        },
+                        {
+                          "type": "typography",
+                          "content": "API Tester",
+                          "variant": "h2"
+                        },
+                        {
+                          "type": "input",
+                          "field": "endpoint",
+                          "placeholder": "/users",
+                          "bind": "@entity.endpoint"
+                        },
+                        {
+                          "type": "select",
+                          "field": "method",
+                          "bind": "@entity.method",
+                          "options": [
+                            {
+                              "label": "GET",
+                              "value": "GET"
+                            },
+                            {
+                              "label": "POST",
+                              "value": "POST"
+                            },
+                            {
+                              "label": "PUT",
+                              "value": "PUT"
+                            },
+                            {
+                              "label": "DELETE",
+                              "value": "DELETE"
+                            }
+                          ]
+                        },
+                        {
+                          "type": "textarea",
+                          "field": "requestBody",
+                          "placeholder": "JSON request body",
+                          "bind": "@entity.requestBody"
+                        },
+                        {
+                          "type": "button",
+                          "label": "Send Request",
+                          "event": "CALL_API",
+                          "variant": "primary",
+                          "icon": "send"
+                        }
+                      ]
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "complete",
+                "to": "idle",
+                "event": "RESET",
+                "effects": [
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "stack",
+                      "direction": "vertical",
+                      "gap": "lg",
+                      "align": "center",
+                      "children": [
+                        {
+                          "type": "icon",
+                          "name": "globe",
+                          "size": "lg"
+                        },
+                        {
+                          "type": "typography",
+                          "content": "API Tester",
+                          "variant": "h2"
+                        },
+                        {
+                          "type": "input",
+                          "field": "endpoint",
+                          "placeholder": "/users",
+                          "bind": "@entity.endpoint"
+                        },
+                        {
+                          "type": "select",
+                          "field": "method",
+                          "bind": "@entity.method",
+                          "options": [
+                            {
+                              "label": "GET",
+                              "value": "GET"
+                            },
+                            {
+                              "label": "POST",
+                              "value": "POST"
+                            },
+                            {
+                              "label": "PUT",
+                              "value": "PUT"
+                            },
+                            {
+                              "label": "DELETE",
+                              "value": "DELETE"
+                            }
+                          ]
+                        },
+                        {
+                          "type": "textarea",
+                          "field": "requestBody",
+                          "placeholder": "JSON request body",
+                          "bind": "@entity.requestBody"
+                        },
+                        {
+                          "type": "button",
+                          "label": "Send Request",
+                          "event": "CALL_API",
+                          "variant": "primary",
+                          "icon": "send"
+                        }
+                      ]
+                    }
+                  ]
+                ]
+              },
+              {
+                "from": "error",
+                "to": "idle",
+                "event": "RESET",
+                "effects": [
+                  [
+                    "render-ui",
+                    "main",
+                    {
+                      "type": "stack",
+                      "direction": "vertical",
+                      "gap": "lg",
+                      "align": "center",
+                      "children": [
+                        {
+                          "type": "icon",
+                          "name": "globe",
+                          "size": "lg"
+                        },
+                        {
+                          "type": "typography",
+                          "content": "API Tester",
+                          "variant": "h2"
+                        },
+                        {
+                          "type": "input",
+                          "field": "endpoint",
+                          "placeholder": "/users",
+                          "bind": "@entity.endpoint"
+                        },
+                        {
+                          "type": "select",
+                          "field": "method",
+                          "bind": "@entity.method",
+                          "options": [
+                            {
+                              "label": "GET",
+                              "value": "GET"
+                            },
+                            {
+                              "label": "POST",
+                              "value": "POST"
+                            },
+                            {
+                              "label": "PUT",
+                              "value": "PUT"
+                            },
+                            {
+                              "label": "DELETE",
+                              "value": "DELETE"
+                            }
+                          ]
+                        },
+                        {
+                          "type": "textarea",
+                          "field": "requestBody",
+                          "placeholder": "JSON request body",
+                          "bind": "@entity.requestBody"
+                        },
+                        {
+                          "type": "button",
+                          "label": "Send Request",
+                          "event": "CALL_API",
+                          "variant": "primary",
+                          "icon": "send"
+                        }
+                      ]
+                    }
+                  ]
+                ]
+              }
+            ]
+          }
+        }
+      ],
+      "pages": [
+        {
+          "name": "ServiceCustomHeaderPage",
+          "path": "/servicecustomheaders",
+          "traits": [
+            {
+              "ref": "ServiceCustomHeaderCustomHeader"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "description": "Custom REST API behavior with header-based API key authentication. Tests the schema-level service declaration pattern (no pre-built integration). Pure function: params in, OrbitalDefinition out."
+}