normalized-ir.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Stack Normalized Diagram IR",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schemaVersion",
    "languageVersion",
    "title",
    "themeId",
    "children",
    "nodes",
    "groups",
    "edges",
    "layout"
  ],
  "properties": {
    "schemaVersion": {
      "const": "1.0"
    },
    "languageVersion": {
      "$ref": "#/$defs/languageVersion"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "themeId": {
      "$ref": "#/$defs/identifier"
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/elementReference"
      },
      "minItems": 1
    },
    "nodes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/node"
      },
      "minItems": 1,
      "maxItems": 40
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/group"
      },
      "maxItems": 12
    },
    "edges": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/edge"
      },
      "maxItems": 80
    },
    "layout": {
      "$ref": "#/$defs/nullableLayout"
    }
  },
  "$defs": {
    "identifier": {
      "type": "string",
      "pattern": "^(?!.*--)[a-z][a-z0-9_-]{0,63}$"
    },
    "iconIdentifier": {
      "type": "string",
      "pattern": "^(?:[a-z0-9][a-z0-9-]{0,63}|[a-z][a-z0-9-]{1,31}:[a-z0-9][a-z0-9-]{0,63})$"
    },
    "languageVersion": {
      "type": "object",
      "additionalProperties": false,
      "required": ["major", "minor"],
      "properties": {
        "major": {
          "type": "integer",
          "minimum": 0
        },
        "minor": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "elementReference": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id"],
      "properties": {
        "type": {
          "enum": ["node", "group"]
        },
        "id": {
          "$ref": "#/$defs/identifier"
        }
      }
    },
    "node": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "label",
        "kind",
        "iconId",
        "detail",
        "parentGroupId"
      ],
      "properties": {
        "id": {
          "$ref": "#/$defs/identifier"
        },
        "label": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "kind": {
          "enum": [
            "actor",
            "client",
            "service",
            "function",
            "worker",
            "database",
            "cache",
            "queue",
            "storage",
            "external"
          ]
        },
        "iconId": {
          "oneOf": [
            {
              "$ref": "#/$defs/iconIdentifier"
            },
            {
              "type": "null"
            }
          ]
        },
        "detail": {
          "type": ["string", "null"],
          "minLength": 1,
          "maxLength": 80
        },
        "parentGroupId": {
          "oneOf": [
            {
              "$ref": "#/$defs/identifier"
            },
            {
              "type": "null"
            }
          ]
        }
      }
    },
    "group": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label", "parentGroupId", "children", "layout"],
      "properties": {
        "id": {
          "$ref": "#/$defs/identifier"
        },
        "label": {
          "type": "string",
          "minLength": 1,
          "maxLength": 60
        },
        "parentGroupId": {
          "oneOf": [
            {
              "$ref": "#/$defs/identifier"
            },
            {
              "type": "null"
            }
          ]
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/elementReference"
          },
          "minItems": 1
        },
        "layout": {
          "$ref": "#/$defs/nullableLayout"
        }
      }
    },
    "edge": {
      "type": "object",
      "additionalProperties": false,
      "required": ["from", "to", "direction", "kind", "label"],
      "properties": {
        "from": {
          "$ref": "#/$defs/identifier"
        },
        "to": {
          "$ref": "#/$defs/identifier"
        },
        "direction": {
          "enum": ["forward", "bidirectional", "association"]
        },
        "kind": {
          "enum": ["flow", "request", "event", "data", "dependency"]
        },
        "label": {
          "type": ["string", "null"],
          "minLength": 1,
          "maxLength": 40
        }
      }
    },
    "nullableLayout": {
      "oneOf": [
        {
          "$ref": "#/$defs/layout"
        },
        {
          "type": "null"
        }
      ]
    },
    "layout": {
      "type": "object",
      "additionalProperties": false,
      "required": ["direction", "sameRanks", "order"],
      "properties": {
        "direction": {
          "type": ["string", "null"],
          "enum": ["right", "down", null]
        },
        "sameRanks": {
          "type": "array",
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/identifier"
            },
            "minItems": 2,
            "uniqueItems": true
          }
        },
        "order": {
          "oneOf": [
            {
              "type": "array",
              "items": {
                "$ref": "#/$defs/identifier"
              },
              "minItems": 2,
              "uniqueItems": true
            },
            {
              "type": "null"
            }
          ]
        }
      }
    }
  }
}