@inneranimalmedia/agentsam-sdk 2.6.8 → 2.6.10

package/packages/agentsam-errors/protocol/agentsam.error.v2.schema.json

@@ -0,0 +1,821 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.inneranimalmedia.com/agentsam/errors/agentsam.error.v2.schema.json",
+  "title": "AgentSam ErrorEnvelope v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "ok",
+    "schema_version",
+    "code",
+    "reason",
+    "domain",
+    "failure_class",
+    "stage",
+    "native_stage",
+    "feature",
+    "failure_behavior",
+    "severity",
+    "retryable",
+    "side_effect_state",
+    "resolution_owner",
+    "source",
+    "adapter",
+    "protocol",
+    "transport",
+    "tool",
+    "message",
+    "retry_after_ms",
+    "remediation",
+    "resource",
+    "native",
+    "environment",
+    "http_status",
+    "grpc_status",
+    "provider",
+    "provider_code",
+    "request_id",
+    "trace_id",
+    "fingerprint",
+    "occurrence_count",
+    "details"
+  ],
+  "properties": {
+    "ok": {
+      "const": false
+    },
+    "schema_version": {
+      "const": 2
+    },
+    "code": {
+      "enum": [
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ]
+    },
+    "reason": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9_]{0,127}$"
+    },
+    "domain": {
+      "enum": [
+        "runtime",
+        "provider",
+        "auth",
+        "identity",
+        "device",
+        "terminal",
+        "transport",
+        "repository",
+        "indexing",
+        "knowledge",
+        "cad",
+        "hook",
+        "model",
+        "configuration",
+        "schema",
+        "migration",
+        "database",
+        "package",
+        "build",
+        "distribution",
+        "deployment",
+        "workflow",
+        "persistence",
+        "policy",
+        "tool"
+      ]
+    },
+    "failure_class": {
+      "enum": [
+        "input",
+        "validation",
+        "authentication",
+        "authorization",
+        "policy",
+        "discovery",
+        "resolution",
+        "availability",
+        "transport",
+        "protocol",
+        "timeout",
+        "rate_limit",
+        "capacity",
+        "resource",
+        "configuration",
+        "dependency",
+        "filesystem",
+        "persistence",
+        "consistency",
+        "conflict",
+        "process",
+        "ipc",
+        "data_integrity",
+        "cancellation",
+        "cancelled",
+        "build",
+        "distribution",
+        "migration",
+        "schema",
+        "identity",
+        "execution",
+        "internal",
+        "unknown"
+      ]
+    },
+    "stage": {
+      "enum": [
+        "discover",
+        "resolve",
+        "load",
+        "configure",
+        "validate",
+        "authorize",
+        "connect",
+        "prepare",
+        "install",
+        "build",
+        "start",
+        "execute",
+        "transform",
+        "persist",
+        "migrate",
+        "verify",
+        "publish",
+        "attach",
+        "detach",
+        "cleanup",
+        "shutdown"
+      ]
+    },
+    "native_stage": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "feature": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$",
+          "maxLength": 256
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "failure_behavior": {
+      "anyOf": [
+        {
+          "enum": [
+            "fail_closed",
+            "fail_open",
+            "observe_only",
+            "retry_bounded",
+            "skip",
+            "abort",
+            "no_replay"
+          ]
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "severity": {
+      "enum": [
+        "transient",
+        "blocking_user_fixable",
+        "blocking_internal",
+        "policy_blocking"
+      ]
+    },
+    "retryable": {
+      "type": "boolean"
+    },
+    "side_effect_state": {
+      "enum": [
+        "none",
+        "not_started",
+        "confirmed_not_applied",
+        "confirmed_applied",
+        "partially_applied",
+        "unknown"
+      ]
+    },
+    "resolution_owner": {
+      "enum": [
+        "user",
+        "agentsam",
+        "provider",
+        "organization_admin",
+        "policy",
+        "unknown"
+      ]
+    },
+    "source": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "kind",
+        "name",
+        "service"
+      ],
+      "properties": {
+        "kind": {
+          "enum": [
+            "user",
+            "agentsam",
+            "provider",
+            "dependency",
+            "runtime",
+            "policy"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "service": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      }
+    },
+    "adapter": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "protocol": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "transport": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "tool": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "message": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 4000
+    },
+    "retry_after_ms": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": 0
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "remediation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "action",
+        "message",
+        "automatic",
+        "command",
+        "url"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "none",
+            "retry",
+            "retry_later",
+            "reauthenticate",
+            "connect_provider",
+            "configure_provider_credential",
+            "refresh_provider_credential",
+            "request_permission",
+            "reenroll_device",
+            "reconnect_service",
+            "install_dependency",
+            "upgrade_dependency",
+            "configure_dependency",
+            "change_configuration",
+            "change_input",
+            "reduce_scope",
+            "increase_quota",
+            "add_budget",
+            "select_model",
+            "change_region",
+            "restart_runtime",
+            "inspect_platform",
+            "contact_provider",
+            "contact_agentsam",
+            "contact_organization_admin",
+            "restart_service",
+            "repair_schema",
+            "run_migration",
+            "regenerate_artifact",
+            "update_lockfile",
+            "reinstall_workspace",
+            "republish_artifact"
+          ]
+        },
+        "message": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "automatic": {
+          "type": "boolean"
+        },
+        "command": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "url": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      }
+    },
+    "resource": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "type",
+            "id",
+            "name"
+          ],
+          "properties": {
+            "type": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 128
+            },
+            "id": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "name": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "native": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "code",
+            "exception_type",
+            "exit_code",
+            "signal",
+            "stderr",
+            "stdout",
+            "stack"
+          ],
+          "properties": {
+            "code": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "exception_type": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "exit_code": {
+              "anyOf": [
+                {
+                  "type": "integer",
+                  "minimum": -2147483648,
+                  "maximum": 2147483647
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "signal": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "stderr": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "stdout": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "stack": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "environment": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "detected_version",
+            "required_version",
+            "component",
+            "runtime",
+            "platform"
+          ],
+          "properties": {
+            "detected_version": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "required_version": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "component": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "runtime": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "platform": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          }
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "http_status": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": 100,
+          "maximum": 599
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "grpc_status": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 16
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "provider": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "provider_code": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "request_id": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "trace_id": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "fingerprint": {
+      "type": "string",
+      "pattern": "^err_[A-Za-z0-9_-]{8,128}$"
+    },
+    "occurrence_count": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "details": {},
+    "operation": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "action": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "resource_type": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "resource_id": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "read_only": {
+          "type": "boolean"
+        },
+        "idempotent": {
+          "type": "boolean"
+        },
+        "side_effect_state": {
+          "enum": [
+            "none",
+            "not_started",
+            "confirmed_not_applied",
+            "confirmed_applied",
+            "partially_applied",
+            "unknown"
+          ]
+        }
+      }
+    },
+    "retry": {
+      "type": "object",
+      "properties": {
+        "allowed": {
+          "type": "boolean"
+        },
+        "strategy": {
+          "type": "string"
+        },
+        "retry_after_ms": {
+          "type": [
+            "number",
+            "null"
+          ]
+        },
+        "max_attempts": {
+          "type": [
+            "integer",
+            "null"
+          ]
+        },
+        "requires_idempotency_key": {
+          "type": "boolean"
+        }
+      }
+    },
+    "fallback": {
+      "type": "object",
+      "properties": {
+        "allowed": {
+          "type": "boolean"
+        },
+        "strategy": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "preserve_semantics": {
+          "type": "boolean"
+        },
+        "target": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
+    "notify": {
+      "type": "object",
+      "properties": {
+        "user": {
+          "type": "string"
+        },
+        "operator": {
+          "type": "string"
+        },
+        "agent": {
+          "type": "string"
+        }
+      }
+    },
+    "cause": {},
+    "status": {
+      "enum": [
+        "success",
+        "partial",
+        "failure"
+      ]
+    },
+    "partial": {
+      "type": "object",
+      "properties": {
+        "completed": {
+          "type": "number"
+        },
+        "failed": {
+          "type": "number"
+        },
+        "failures": {
+          "type": "array"
+        }
+      }
+    }
+  }
+}