@styleflow.app/flowpress-deploy 1.0.0-beta.3 → 1.0.0-beta.31

package/schema/deployment.schema.json

@@ -0,0 +1,306 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "FlowPress deployment manifest",
+  "type": "object",
+  "required": [
+    "schemaVersion",
+    "platform",
+    "profile",
+    "database",
+    "media",
+    "environments"
+  ],
+  "properties": {
+    "schemaVersion": {
+      "enum": [
+        1,
+        2
+      ]
+    },
+    "platform": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9-]*$"
+    },
+    "profile": {
+      "enum": [
+        "backend",
+        "static",
+        "headless-static",
+        "headless-ssr"
+      ]
+    },
+    "database": {
+      "const": "shared"
+    },
+    "media": {
+      "oneOf": [
+        {
+          "enum": [
+            "local",
+            "s3"
+          ]
+        },
+        {
+          "$ref": "#/$defs/media"
+        }
+      ]
+    },
+    "registryProject": {
+      "type": "string"
+    },
+    "sources": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "required": [
+          "ssh",
+          "user",
+          "path"
+        ],
+        "properties": {
+          "ssh": {
+            "type": "string"
+          },
+          "user": {
+            "type": "string"
+          },
+          "path": {
+            "type": "string",
+            "pattern": "^/"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "environments": {
+      "type": "object",
+      "propertyNames": {
+        "enum": [
+          "local",
+          "staging",
+          "production",
+          "preview"
+        ]
+      },
+      "additionalProperties": {
+        "type": "object",
+        "required": [
+          "publish"
+        ],
+        "properties": {
+          "publish": {
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+              "enum": [
+                "cms",
+                "web-static",
+                "web-ssr"
+              ]
+            }
+          },
+          "profile": {
+            "enum": [
+              "backend",
+              "static",
+              "headless-static",
+              "headless-ssr"
+            ]
+          },
+          "frontendUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "backendUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "graphqlUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "mediaUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "backend": {
+            "enum": [
+              "local",
+              "staging",
+              "production"
+            ]
+          },
+          "aliases": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uri"
+            }
+          },
+          "mode": {
+            "const": "on-demand"
+          },
+          "mail": {
+            "enum": [
+              "disabled",
+              "capture",
+              "smtp"
+            ]
+          },
+          "backendAliases": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "format": "uri"
+            }
+          },
+          "media": {
+            "$ref": "#/$defs/media"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "development": {
+      "type": "object",
+      "properties": {
+        "ports": {
+          "type": "object",
+          "properties": {
+            "web": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 65535
+            },
+            "cms": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 65535
+            },
+            "https": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 65535
+            },
+            "database": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 65535
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "schemaVersion": {
+            "const": 1
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "media": {
+            "enum": [
+              "local",
+              "s3"
+            ]
+          },
+          "environments": {
+            "additionalProperties": {
+              "not": {
+                "required": [
+                  "media"
+                ]
+              }
+            }
+          }
+        }
+      },
+      "else": {
+        "properties": {
+          "media": {
+            "$ref": "#/$defs/media"
+          }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "media": {
+      "type": "object",
+      "required": [
+        "storage"
+      ],
+      "properties": {
+        "storage": {
+          "enum": [
+            "local",
+            "s3"
+          ]
+        },
+        "provider": {
+          "enum": [
+            "aws_s3",
+            "cloudflare_r2",
+            "digitalocean",
+            "backblaze_b2",
+            "wasabi",
+            "minio"
+          ]
+        },
+        "shared": {
+          "type": "boolean"
+        },
+        "prefix": {
+          "type": "string",
+          "pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$))[^\\\\\\r\\n?#]*$"
+        }
+      },
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "storage": {
+                "const": "s3"
+              }
+            }
+          },
+          "then": {
+            "required": [
+              "provider"
+            ]
+          },
+          "else": {
+            "not": {
+              "anyOf": [
+                {
+                  "required": [
+                    "provider"
+                  ]
+                },
+                {
+                  "required": [
+                    "shared"
+                  ]
+                },
+                {
+                  "required": [
+                    "prefix"
+                  ]
+                }
+              ]
+            }
+          }
+        }
+      ]
+    }
+  }
+}