schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "@flisk/analyze-tracking output schema",
  "type": "object",
  "properties": {
    "version": {
      "type": "number",
      "enum": [
        1
      ],
      "description": "Version of the schema"
    },
    "source": {
      "type": "object",
      "properties": {
        "repository": {
          "type": "string",
          "description": "URL of git repository that was used to generate the schema"
        },
        "commit": {
          "type": "string",
          "description": "Git commit hash when this schema was generated"
        },
        "timestamp": {
          "type": "string",
          "description": "Git commit timestamp when this schema was generated"
        }
      },
      "required": [
        "timestamp"
      ],
      "additionalProperties": false
    },
    "events": {
      "type": "object",
      "patternProperties": {
        "^[a-zA-Z0-9_-]+$": {
          "type": "object",
          "properties": {
            "implementations": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "path": {
                    "type": "string",
                    "description": "Relative path to the file where the event is tracked"
                  },
                  "line": {
                    "type": "integer",
                    "description": "Line number in the file where the event is tracked"
                  },
                  "function": {
                    "type": "string",
                    "description": "Name of the function where the event is tracked"
                  },
                  "destination": {
                    "type": "string",
                    "enum": [
                      "googleanalytics",
                      "segment",
                      "mixpanel",
                      "amplitude",
                      "rudderstack",
                      "mparticle",
                      "posthog",
                      "pendo",
                      "heap",
                      "snowplow",
                      "custom",
                      "unknown"
                    ],
                    "description": "Name of the platform where the event is sent"
                  },
                  "description": {
                    "type": "string",
                    "description": "Description of how the event is triggered"
                  }
                },
                "required": [
                  "path",
                  "line",
                  "function",
                  "destination"
                ],
                "additionalProperties": false
              }
            },
            "properties": {
              "type": "object",
              "patternProperties": {
                "^[a-zA-Z0-9_-]+$": {
                  "$ref": "#/definitions/property"
                }
              }
            },
            "description": {
              "type": "string",
              "description": "Description of the event"
            }
          },
          "required": [
            "implementations",
            "properties"
          ],
          "additionalProperties": false
        }
      }
    }
  },
  "required": [
    "version",
    "source",
    "events"
  ],
  "definitions": {
    "property": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "Data type of the property (e.g., string, number, any)"
        },
        "required": {
          "type": "boolean",
          "description": "Whether this property is required"
        },
        "description": {
          "type": "string",
          "description": "Description of the property"
        },
        "properties": {
          "type": "object",
          "patternProperties": {
            "^[a-zA-Z0-9_-]+$": {
              "$ref": "#/definitions/property"
            }
          }
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    }
  }
}