@meadow-studio/platform 0.0.0-stage → 0.1.0

package/schema/meadow-config.schema.json

@@ -0,0 +1,250 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://meadow.app/schemas/meadow-config.schema.json",
+  "title": "Meadow application configuration",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "version",
+    "app",
+    "links",
+    "store",
+    "services",
+    "environments",
+    "analytics",
+    "ci",
+    "release"
+  ],
+  "properties": {
+    "$schema": { "type": "string" },
+    "version": { "const": 2 },
+    "app": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "slug",
+        "description",
+        "identifiers",
+        "platforms",
+        "orientation",
+        "devices"
+      ],
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "slug": { "type": "string", "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$" },
+        "description": { "type": "string" },
+        "identifiers": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["ios", "android"],
+          "properties": {
+            "ios": { "$ref": "#/$defs/applicationId" },
+            "android": { "$ref": "#/$defs/applicationId" }
+          }
+        },
+        "platforms": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "enum": ["ios", "android"] }
+        },
+        "orientation": { "enum": ["any", "portrait", "landscape"] },
+        "devices": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "enum": ["phone", "tablet"] }
+        }
+      }
+    },
+    "links": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "supportEmail": { "type": "string" },
+        "supportUrl": { "$ref": "#/$defs/url" },
+        "privacyUrl": { "$ref": "#/$defs/url" },
+        "termsUrl": { "$ref": "#/$defs/url" },
+        "websiteUrl": { "$ref": "#/$defs/url" }
+      }
+    },
+    "store": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "appleAppId": { "type": "string", "minLength": 1 },
+        "appStoreUrl": { "$ref": "#/$defs/url" },
+        "playStoreUrl": { "$ref": "#/$defs/url" }
+      }
+    },
+    "services": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["firebase", "revenuecat", "supabase", "localData", "notifications"],
+      "properties": {
+        "firebase": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["enabled", "configured", "analyticsConsent", "crashlyticsConsent"],
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "configured": { "type": "boolean" },
+            "analyticsConsent": { "const": "explicit" },
+            "crashlyticsConsent": { "const": "explicit" }
+          }
+        },
+        "revenuecat": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["enabled", "configured", "mode", "productIds"],
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "configured": { "type": "boolean" },
+            "mode": {
+              "enum": ["none", "subscription", "lifetime", "subscription-and-lifetime"]
+            },
+            "entitlementId": { "type": "string" },
+            "offeringId": { "type": "string" },
+            "productIds": {
+              "type": "array",
+              "uniqueItems": true,
+              "items": { "type": "string", "minLength": 1 }
+            }
+          }
+        },
+        "supabase": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "enabled",
+            "configured",
+            "auth",
+            "storage",
+            "urlVariable",
+            "publishableKeyVariable"
+          ],
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "configured": { "type": "boolean" },
+            "auth": { "enum": ["none", "email-otp"] },
+            "storage": { "type": "boolean" },
+            "projectRef": { "type": "string", "minLength": 1 },
+            "urlVariable": { "$ref": "#/$defs/environmentVariable" },
+            "publishableKeyVariable": { "$ref": "#/$defs/environmentVariable" }
+          }
+        },
+        "localData": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["enabled", "configured", "databaseVersion"],
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "configured": { "type": "boolean" },
+            "databaseVersion": { "type": "integer", "minimum": 0 }
+          }
+        },
+        "notifications": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["enabled", "configured"],
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "configured": { "type": "boolean" }
+          }
+        }
+      }
+    },
+    "environments": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["development", "test", "production"],
+      "properties": {
+        "development": { "$ref": "#/$defs/environment" },
+        "test": { "$ref": "#/$defs/environment" },
+        "production": { "$ref": "#/$defs/environment" }
+      }
+    },
+    "analytics": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["events"],
+      "properties": {
+        "events": {
+          "type": "object",
+          "propertyNames": { "pattern": "^[a-z][a-z0-9_]{0,39}$" },
+          "additionalProperties": { "$ref": "#/$defs/analyticsEvent" }
+        }
+      }
+    },
+    "ci": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["provider", "visualViewports"],
+      "properties": {
+        "provider": { "const": "github" },
+        "visualViewports": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "enum": ["phone", "tablet"] }
+        }
+      }
+    },
+    "release": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["version", "build", "channel"],
+      "properties": {
+        "version": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+$" },
+        "build": { "type": "integer", "minimum": 1 },
+        "channel": { "enum": ["development", "test", "production"] }
+      }
+    }
+  },
+  "$defs": {
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Za-z][A-Za-z0-9_]*(?:\\.[A-Za-z][A-Za-z0-9_]*)+$"
+    },
+    "url": { "type": "string", "format": "uri", "pattern": "^https?://" },
+    "environmentVariable": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" },
+    "environment": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["runtime", "analytics", "crashlytics"],
+      "properties": {
+        "runtime": { "enum": ["development", "device", "production"] },
+        "analytics": { "type": "boolean" },
+        "crashlytics": { "type": "boolean" }
+      }
+    },
+    "analyticsEvent": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["properties"],
+      "properties": {
+        "properties": {
+          "type": "object",
+          "propertyNames": { "pattern": "^[a-z][a-z0-9_]{0,39}$" },
+          "additionalProperties": { "$ref": "#/$defs/analyticsProperty" }
+        }
+      }
+    },
+    "analyticsProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "required"],
+      "properties": {
+        "type": { "enum": ["string", "number", "integer", "boolean"] },
+        "required": { "type": "boolean" },
+        "values": {
+          "type": "array",
+          "minItems": 1,
+          "uniqueItems": true,
+          "items": { "type": "string", "minLength": 1 }
+        }
+      }
+    }
+  }
+}