chadstart 1.0.0

package/chadstart.schema.json

@@ -0,0 +1,367 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://chadstart.com/chadstart.schema.json",
+  "title": "ChadStart Configuration",
+  "description": "Schema for chadstart.yaml — define your entire backend in one YAML file.",
+  "type": "object",
+  "required": ["name"],
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of your application."
+    },
+    "port": {
+      "type": "integer",
+      "default": 3000,
+      "description": "The port your server listens on."
+    },
+    "database": {
+      "type": "string",
+      "description": "Path to the SQLite database file, relative to this config file (default: data/chadstart.db in the working directory, overridden by DB_PATH env var)."
+    },
+    "entities": {
+      "type": "object",
+      "description": "Map of entity names to their definitions.",
+      "additionalProperties": { "$ref": "#/$defs/entity" }
+    },
+    "functions": {
+      "type": "object",
+      "description": "Map of custom function-based endpoint names to their definitions.",
+      "additionalProperties": { "$ref": "#/$defs/endpoint" }
+    },
+    "groups": {
+      "type": "object",
+      "description": "Reusable property groups that can be embedded in entities.",
+      "additionalProperties": { "$ref": "#/$defs/group" }
+    },
+    "files": {
+      "type": "object",
+      "description": "Map of file bucket names to their definitions.",
+      "additionalProperties": { "$ref": "#/$defs/fileBucket" }
+    },
+    "public": {
+      "type": "object",
+      "required": ["folder"],
+      "additionalProperties": false,
+      "properties": {
+        "folder": {
+          "type": "string",
+          "description": "Path to the public static files directory."
+        }
+      }
+    },
+    "plugins": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/plugin" }
+    },
+    "admin": {
+      "type": "object",
+      "description": "Admin UI and Admin entity configuration.",
+      "additionalProperties": false,
+      "properties": {
+        "enable_app": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable the Admin UI at /admin. Default: true."
+        },
+        "enable_entity": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable the built-in Admin entity (email + password authenticable entity). Default: true."
+        },
+        "policies": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/policy" },
+          "description": "Access policies for the /admin route. Default: [{ access: admin }]."
+        }
+      }
+    },
+    "rateLimits": {
+      "type": "array",
+      "description": "Rate limit definitions applied to API routes.",
+      "items": { "$ref": "#/$defs/rateLimit" }
+    },
+    "telemetry": {
+      "type": "object",
+      "description": "OpenTelemetry tracing configuration. Secret values (auth headers / API keys) must be supplied via environment variables only — never put secrets in this file.",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable OpenTelemetry tracing. Also configurable via OTEL_ENABLED=true env var."
+        },
+        "serviceName": {
+          "type": "string",
+          "description": "Service name reported to the OTLP collector. Overridable via OTEL_SERVICE_NAME env var."
+        },
+        "endpoint": {
+          "type": "string",
+          "description": "OTLP collector base URL (e.g. http://localhost:4318). Overridable via OTEL_EXPORTER_OTLP_ENDPOINT env var."
+        }
+      }
+    },
+    "sentry": {
+      "type": "object",
+      "description": "Sentry (or Bugsink) error-reporting configuration. The DSN is a secret and must be provided via the SENTRY_DSN environment variable — do NOT put it here.",
+      "additionalProperties": false,
+      "properties": {
+        "environment": {
+          "type": "string",
+          "description": "The environment label sent to Sentry (e.g. production, staging). Defaults to NODE_ENV."
+        },
+        "tracesSampleRate": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1,
+          "default": 1.0,
+          "description": "Fraction of transactions to sample for performance monitoring (0.0–1.0)."
+        },
+        "debug": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable Sentry SDK debug logging."
+        }
+      }
+    }
+  },
+  "$defs": {
+    "property": {
+      "oneOf": [
+        { "type": "string", "description": "Short syntax: property name (type defaults to string)." },
+        {
+          "type": "object",
+          "required": ["name"],
+          "properties": {
+            "name": { "type": "string" },
+            "type": {
+              "type": "string",
+              "enum": [
+                "string", "text", "richText", "number", "link", "money",
+                "date", "timestamp", "email", "boolean", "file", "image",
+                "password", "choice", "location", "group", "json",
+                "integer", "float", "real"
+              ],
+              "default": "string"
+            },
+            "hidden": { "type": "boolean", "default": false },
+            "options": { "type": "object" },
+            "validation": { "$ref": "#/$defs/validationRules" },
+            "helpText": { "type": "string" },
+            "default": {}
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "relationItem": {
+      "oneOf": [
+        { "type": "string", "description": "Short syntax: entity name." },
+        {
+          "type": "object",
+          "required": ["name", "entity"],
+          "properties": {
+            "name": { "type": "string" },
+            "entity": { "type": "string" },
+            "helpText": { "type": "string" },
+            "eager": { "type": "boolean", "default": false }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "accessType": {
+      "type": "string",
+      "enum": ["public", "restricted", "admin", "forbidden", "🌐", "🔒", "👨🏻‍💻", "🚫"]
+    },
+    "policy": {
+      "type": "object",
+      "required": ["access"],
+      "properties": {
+        "access": { "$ref": "#/$defs/accessType" },
+        "allow": {
+          "oneOf": [
+            { "type": "string" },
+            { "type": "array", "items": { "type": "string" } }
+          ]
+        },
+        "condition": { "type": "string", "enum": ["self"] }
+      },
+      "additionalProperties": false
+    },
+    "policies": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "create":  { "type": "array", "items": { "$ref": "#/$defs/policy" } },
+        "read":    { "type": "array", "items": { "$ref": "#/$defs/policy" } },
+        "update":  { "type": "array", "items": { "$ref": "#/$defs/policy" } },
+        "delete":  { "type": "array", "items": { "$ref": "#/$defs/policy" } },
+        "signup":  { "type": "array", "items": { "$ref": "#/$defs/policy" } }
+      }
+    },
+    "validationRules": {
+      "type": "object",
+      "properties": {
+        "required":       { "type": "boolean" },
+        "isDefined":      { "type": "boolean" },
+        "isOptional":     { "type": "boolean" },
+        "equals":         {},
+        "notEquals":      {},
+        "isEmpty":        { "type": "boolean" },
+        "isNotEmpty":     { "type": "boolean" },
+        "isIn":           { "type": "array" },
+        "isNotIn":        { "type": "array" },
+        "min":            { "type": "number" },
+        "max":            { "type": "number" },
+        "contains":       { "type": "string" },
+        "notContains":    { "type": "string" },
+        "isAlpha":        { "type": "boolean" },
+        "isAlphanumeric": { "type": "boolean" },
+        "isAscii":        { "type": "boolean" },
+        "isEmail":        { "type": "boolean" },
+        "isJSON":         { "type": "boolean" },
+        "minLength":      { "type": "integer" },
+        "maxLength":      { "type": "integer" },
+        "matches":        { "type": "string" },
+        "isMimeType":     { "type": "boolean" }
+      },
+      "additionalProperties": false
+    },
+    "lifecycleEvents": {
+      "type": "string",
+      "enum": ["beforeCreate", "afterCreate", "beforeUpdate", "afterUpdate", "beforeDelete", "afterDelete"]
+    },
+    "webhook": {
+      "type": "object",
+      "required": ["url"],
+      "properties": {
+        "url":     { "type": "string", "format": "uri" },
+        "method":  { "type": "string", "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"], "default": "POST" },
+        "headers": { "type": "object", "additionalProperties": { "type": "string" } }
+      },
+      "additionalProperties": false
+    },
+    "middleware": {
+      "type": "object",
+      "required": ["function"],
+      "properties": {
+        "function": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "entity": {
+      "type": "object",
+      "properties": {
+        "authenticable": { "type": "boolean", "default": false, "description": "Makes this entity authenticable (adds email + password fields, enables login/signup)." },
+        "single":        { "type": "boolean", "default": false, "description": "Single entity — only one record exists (no create/delete)." },
+        "mainProp":      { "type": "string", "description": "Identifier property used in the admin panel." },
+        "nameSingular":  { "type": "string" },
+        "namePlural":    { "type": "string" },
+        "seedCount":     { "type": "integer", "default": 50 },
+        "slug":          { "type": "string", "description": "Custom kebab-case slug for API endpoints." },
+        "properties":    { "type": "array", "items": { "$ref": "#/$defs/property" } },
+        "belongsTo":     { "type": "array", "items": { "$ref": "#/$defs/relationItem" } },
+        "belongsToMany": { "type": "array", "items": { "$ref": "#/$defs/relationItem" } },
+        "policies":      { "$ref": "#/$defs/policies" },
+        "validation": {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/validationRules" }
+        },
+        "hooks": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "beforeCreate": { "type": "array", "items": { "$ref": "#/$defs/webhook" } },
+            "afterCreate":  { "type": "array", "items": { "$ref": "#/$defs/webhook" } },
+            "beforeUpdate": { "type": "array", "items": { "$ref": "#/$defs/webhook" } },
+            "afterUpdate":  { "type": "array", "items": { "$ref": "#/$defs/webhook" } },
+            "beforeDelete": { "type": "array", "items": { "$ref": "#/$defs/webhook" } },
+            "afterDelete":  { "type": "array", "items": { "$ref": "#/$defs/webhook" } }
+          }
+        },
+        "middlewares": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "beforeCreate": { "type": "array", "items": { "$ref": "#/$defs/middleware" } },
+            "afterCreate":  { "type": "array", "items": { "$ref": "#/$defs/middleware" } },
+            "beforeUpdate": { "type": "array", "items": { "$ref": "#/$defs/middleware" } },
+            "afterUpdate":  { "type": "array", "items": { "$ref": "#/$defs/middleware" } },
+            "beforeDelete": { "type": "array", "items": { "$ref": "#/$defs/middleware" } },
+            "afterDelete":  { "type": "array", "items": { "$ref": "#/$defs/middleware" } }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "trigger": {
+      "type": "object",
+      "required": ["type"],
+      "properties": {
+        "type":     { "type": "string", "enum": ["http", "cron", "event"] },
+        "method":   { "type": "string", "enum": ["GET", "POST", "PATCH", "PUT", "DELETE"] },
+        "path":     { "type": "string", "description": "URL path for http triggers (supports :param syntax)." },
+        "schedule": { "type": "string", "description": "Cron expression or predefined alias (@daily, @hourly…)." },
+        "name":     { "type": "string", "description": "Event name for event triggers." },
+        "policies": { "type": "array", "items": { "$ref": "#/$defs/policy" }, "description": "Access policies for http triggers. Default: public." }
+      },
+      "additionalProperties": false
+    },
+    "endpoint": {
+      "type": "object",
+      "required": ["function", "triggers"],
+      "properties": {
+        "function":    { "type": "string", "description": "Name of the function file in /functions." },
+        "runtime":     { "type": "string", "enum": ["js", "bash", "python", "go", "c++", "ruby", "php"], "default": "js" },
+        "description": { "type": "string" },
+        "triggers":    { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/trigger" }, "description": "List of triggers (http, cron, event)." }
+      },
+      "additionalProperties": false
+    },
+    "group": {
+      "type": "object",
+      "properties": {
+        "properties": { "type": "array", "items": { "$ref": "#/$defs/property" } },
+        "validation": {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/validationRules" }
+        }
+      },
+      "additionalProperties": false
+    },
+    "fileBucket": {
+      "type": "object",
+      "required": ["path"],
+      "properties": {
+        "path":   { "type": "string" },
+        "public": { "type": "boolean", "default": false }
+      },
+      "additionalProperties": false
+    },
+    "plugin": {
+      "type": "object",
+      "anyOf": [
+        { "required": ["repo"] },
+        { "required": ["path"] }
+      ],
+      "properties": {
+        "repo": { "type": "string" },
+        "path": { "type": "string" },
+        "name": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "rateLimit": {
+      "type": "object",
+      "required": ["name", "limit", "ttl"],
+      "additionalProperties": false,
+      "properties": {
+        "name":  { "type": "string",  "description": "Identifier for this rate limit definition." },
+        "limit": { "type": "integer", "description": "Maximum number of requests allowed in the time window." },
+        "ttl":   { "type": "integer", "description": "Time window in milliseconds." }
+      }
+    }
+  }
+}

package/chadstart.yaml

@@ -0,0 +1,53 @@
+name: Blog
+
+port: 3000
+
+entities:
+  Admin:
+    authenticable: true
+    properties:
+      - name
+
+  Customer:
+    authenticable: true
+    properties:
+      - name
+      - phone
+
+  Post:
+    properties:
+      - title
+      - { name: content, type: text }
+      - { name: published, type: boolean }
+    policies:
+      create:
+        - { access: restricted, allow: Admin }
+      read:
+        - access: public
+      update:
+        - { access: restricted, allow: Admin }
+      delete:
+        - { access: restricted, allow: Admin }
+
+  Comment:
+    properties:
+      - text
+    belongsTo:
+      - Post
+    policies:
+      create:
+        - access: restricted
+      read:
+        - access: public
+      update:
+        - access: restricted
+      delete:
+        - access: restricted
+
+files:
+  uploads:
+    path: ./uploads
+    public: true
+
+public:
+  folder: ./public