forgeos 0.1.0-alpha.7 → 0.1.0-alpha.71

package/schemas/forge-manifest.schema.json

@@ -0,0 +1,389 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://forgeos.dev/schemas/forge-manifest.schema.json",
+  "title": "Forge external runtime manifest",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/service"
+    },
+    {
+      "$ref": "#/$defs/repository"
+    }
+  ],
+  "$defs": {
+    "service": {
+      "type": "object",
+      "required": [
+        "forgeProtocol",
+        "language",
+        "service",
+        "entries"
+      ],
+      "properties": {
+        "forgeProtocol": {
+          "const": "1.0"
+        },
+        "language": {
+          "type": "string",
+          "minLength": 1
+        },
+        "framework": {
+          "type": "string",
+          "minLength": 1
+        },
+        "service": {
+          "type": "object",
+          "required": [
+            "name",
+            "transport"
+          ],
+          "properties": {
+            "name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "transport": {
+              "enum": [
+                "http",
+                "grpc",
+                "stdio"
+              ]
+            },
+            "baseUrl": {
+              "type": "string",
+              "minLength": 1
+            },
+            "command": {
+              "type": "string",
+              "minLength": 1
+            },
+            "health": {
+              "type": "string",
+              "minLength": 1
+            },
+            "commandArgs": {
+              "type": "array",
+              "minItems": 1,
+              "prefixItems": [
+                {
+                  "type": "string",
+                  "minLength": 1
+                }
+              ],
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "entries": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "name",
+              "kind"
+            ],
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              },
+              "kind": {
+                "enum": [
+                  "command",
+                  "query"
+                ]
+              },
+              "description": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string",
+                "minLength": 1
+              },
+              "method": {
+                "enum": [
+                  "GET",
+                  "POST"
+                ]
+              },
+              "inputSchema": {},
+              "outputSchema": {},
+              "policy": {
+                "type": "string",
+                "minLength": 1
+              },
+              "tenantScoped": {
+                "type": "boolean"
+              },
+              "transaction": {
+                "enum": [
+                  "read-only",
+                  "external-managed",
+                  "forge-managed",
+                  "saga"
+                ]
+              },
+              "risk": {
+                "enum": [
+                  "read",
+                  "write",
+                  "destructive",
+                  "external"
+                ]
+              },
+              "needsApproval": {
+                "type": "boolean"
+              },
+              "effects": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "schemas": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "repository": {
+      "type": "object",
+      "required": [
+        "forgeProtocol",
+        "kind",
+        "components"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "forgeProtocol": {
+          "const": "2.0"
+        },
+        "kind": {
+          "const": "repository"
+        },
+        "components": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "required": [
+              "id",
+              "root",
+              "adapters"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "id": {
+                "type": "string",
+                "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$"
+              },
+              "root": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 4096,
+                "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+              },
+              "adapters": {
+                "type": "array",
+                "minItems": 1,
+                "uniqueItems": true,
+                "items": {
+                  "enum": [
+                    "typescript",
+                    "javascript",
+                    "vue",
+                    "nuxt",
+                    "java",
+                    "spring",
+                    "maven",
+                    "gradle",
+                    "docker"
+                  ]
+                }
+              },
+              "files": {
+                "type": "array",
+                "maxItems": 1000,
+                "items": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 4096,
+                  "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+                }
+              },
+              "analysis": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "aliases": {
+                    "type": "object", "maxProperties": 100,
+                    "propertyNames": { "type": "string", "pattern": "^(?!__proto__$|prototype$|constructor$)(?!.*(?:^|/)\\.\\.(?:/|$))[A-Za-z_$@~][A-Za-z0-9_$@~./-]{0,127}$" },
+                    "additionalProperties": { "$ref": "#/$defs/repositoryPath" }
+                  },
+                  "nuxt": {
+                    "type": "object", "additionalProperties": false,
+                    "properties": {
+                      "rootDir": { "$ref": "#/$defs/repositoryPath" },
+                      "srcDir": { "$ref": "#/$defs/repositoryPath" },
+                      "components": { "type": "array", "maxItems": 100, "items": { "$ref": "#/$defs/repositoryPath" } },
+                      "imports": { "type": "array", "maxItems": 100, "items": { "$ref": "#/$defs/repositoryPath" } }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "exclude": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 4096,
+            "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+          }
+        },
+        "services": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 4096,
+            "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+          }
+        },
+        "checks": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "required": [
+              "id",
+              "component",
+              "argv"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "id": {
+                "type": "string",
+                "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$"
+              },
+              "component": {
+                "type": "string",
+                "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$"
+              },
+              "argv": {
+                "type": "array",
+                "minItems": 1,
+                "maxItems": 1000,
+                "items": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 4096
+                }
+              },
+              "cwd": { "$ref": "#/$defs/repositoryPath" },
+              "files": { "type": "array", "maxItems": 1000, "items": { "$ref": "#/$defs/repositoryPath" } },
+              "category": { "enum": ["typecheck", "test", "lint", "build", "integration", "security", "other"] },
+              "cost": { "enum": ["low", "medium", "high"] },
+              "requires": {
+                "type": "array", "maxItems": 32, "uniqueItems": true,
+                "items": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$" }
+              }
+            }
+          }
+        },
+        "httpClients": {
+          "type": "array", "maxItems": 1000,
+          "items": {
+            "type": "object", "additionalProperties": false,
+            "required": ["id", "component"],
+            "properties": {
+              "id": { "type": "string", "pattern": "^[A-Za-z_$][A-Za-z0-9_$.-]{0,79}$" },
+              "component": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$" },
+              "apiComponent": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$" },
+              "files": { "type": "array", "maxItems": 1000, "items": { "$ref": "#/$defs/repositoryPath" } },
+              "basePath": { "type": "string", "maxLength": 2048, "pattern": "^/(?!/)(?!.*(?:^|/)\\.\\.(?:/|$))[A-Za-z0-9_~!()*+,;=:@./-]*$" }
+            }
+          }
+        },
+        "runtime": {
+          "type": "object", "additionalProperties": false, "required": ["observations"],
+          "properties": { "observations": {
+            "type": "array", "minItems": 1, "maxItems": 32,
+            "items": {
+              "type": "object", "additionalProperties": false, "required": ["id", "component", "commands", "artifacts"],
+              "properties": {
+                "id": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$" },
+                "component": { "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$" },
+                "commands": { "type": "array", "minItems": 1, "maxItems": 16, "items": {
+                  "type": "object", "additionalProperties": false, "required": ["argv"],
+                  "properties": {
+                    "argv": { "type": "array", "minItems": 1, "maxItems": 128, "items": { "type": "string", "minLength": 1, "maxLength": 4096, "pattern": "^[^\\u0000-\\u001f\\u007f]+$" } },
+                    "cwd": { "$ref": "#/$defs/repositoryPath" },
+                    "timeoutMs": { "type": "integer", "minimum": 100, "maximum": 120000 }
+                  }
+                } },
+                "artifacts": { "type": "array", "minItems": 1, "maxItems": 32, "items": {
+                  "type": "object", "additionalProperties": false, "required": ["path", "format"],
+                  "properties": {
+                    "path": { "$ref": "#/$defs/repositoryPath" },
+                    "format": { "enum": ["nuxt-components", "nuxt-imports", "spring-mappings", "spring-beans", "docker-inspect", "http-trace", "forge-runtime"] }
+                  }
+                } }
+              }
+            }
+          } }
+        },
+        "scenario": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "id": {
+              "type": "string",
+              "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$"
+            },
+            "mode": {
+              "type": "string",
+              "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,79}$"
+            },
+            "profiles": {
+              "type": "array",
+              "maxItems": 1000,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 4096
+              }
+            },
+            "composeFiles": {
+              "type": "array",
+              "maxItems": 1000,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 4096,
+                "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+              }
+            }
+          }
+        }
+      }
+    },
+    "repositoryPath": {
+      "type": "string", "minLength": 1, "maxLength": 4096,
+      "pattern": "^(?!/)(?!.*[:\\u0000-\\u001f])(?!.*\\\\)(?!.*(?:^|/)\\.\\.(?:/|$)).+$"
+    }
+  }
+}