gpm.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GPM Config",
  "name": "gpm.yml",
  "fileMatch": [ "gpm.json", "gpm.yml", "gpm.yaml" ],
  "description": "A config file for GPM",

  "definitions": {
    "partialConfig": {
      "type": "string",
      "description": "Partial config file path"
    },

    "categories": {
      "anyOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "object",
          "additionalProperties": false,
          "required": ["name"],
          "properties": {
            "name": { "type": "string" },
            "rank": { "type":  "integer" },
            "children": {
              "oneOf": [
                { "$ref": "#/definitions/partialConfig" },
                {
                  "type": "array",
                  "items": { "$ref": "#/definitions/categories" },
                  "default": []
                }
              ]
            }
          }
        }
      ]
    },

    "properties": {
      "type": "array",
      "items": {
        "type": "object",
        "required": ["name"],
        "properties": {
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "type": {
            "$ref": "#/definitions/type"
          },
          "value": {
            "oneOf": [
              { "type": "string" },
              { "type": "number" },
              { "type": "boolean" }
            ]
          },
          "lexicon": {
            "type": "string"
          },
          "area": {
            "type": "string"
          }
        }
      }
    },

    "type": {
      "anyOf": [
        {
          "type": "string",
          "default": "textfield",
          "enum": [
            "textfield",
            "textarea",
            "numberfield",
            "combo-boolean",
            "text-password",
            "modx-combo-category",
            "modx-combo-charset",
            "modx-combo-country",
            "modx-combo-context",
            "modx-combo-namespace",
            "modx-combo-template",
            "modx-combo-user",
            "modx-combo-usergroup",
            "modx-combo-language",
            "modx-combo-source",
            "modx-combo-source-type",
            "modx-combo-manager-theme",
            "modx-grid-json"
          ]
        },
        {
          "type": "string"
        }
      ]
    },

    "eventName": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "OnBeforeCacheUpdate",
            "OnBeforeChunkFormDelete",
            "OnBeforeChunkFormSave",
            "OnBeforeDocFormDelete",
            "OnBeforeDocFormSave",
            "OnBeforeEmptyTrash",
            "OnBeforeManagerLogin",
            "OnBeforeManagerLogout",
            "OnBeforeManagerPageInit",
            "OnBeforePluginFormDelete",
            "OnBeforePluginFormSave",
            "OnBeforeRegisterClientScripts",
            "OnBeforeSaveWebPageCache",
            "OnBeforeSnipFormDelete",
            "OnBeforeSnipFormSave",
            "OnBeforeTempFormDelete",
            "OnBeforeTempFormSave",
            "OnBeforeTVFormDelete",
            "OnBeforeTVFormSave",
            "OnBeforeUserActivate",
            "OnBeforeUserDeactivate",
            "OnBeforeUserDuplicate",
            "OnBeforeUserFormDelete",
            "OnBeforeUserFormSave",
            "OnBeforeUserGroupFormRemove",
            "OnBeforeUserGroupFormSave",
            "OnBeforeWebLogin",
            "OnBeforeWebLogout",
            "OnCacheUpdate",
            "OnCategoryBeforeRemove",
            "OnCategoryBeforeSave",
            "OnCategoryRemove",
            "OnCategorySave",
            "OnChunkBeforeRemove",
            "OnChunkBeforeSave",
            "OnChunkFormDelete",
            "OnChunkFormPrerender",
            "OnChunkFormRender",
            "OnChunkFormSave",
            "OnChunkRemove",
            "OnChunkSave",
            "OnContextBeforeRemove",
            "OnContextBeforeSave",
            "OnContextFormPrerender",
            "OnContextFormRender",
            "OnContextRemove",
            "OnContextSave",
            "OnDocFormDelete",
            "OnDocFormPrerender",
            "OnDocFormRender",
            "OnDocFormSave",
            "OnDocPublished",
            "OnDocUnPublished",
            "OnElementNotFound",
            "OnEmptyTrash",
            "OnFileCreateFormPrerender",
            "OnFileEditFormPrerender",
            "OnFileManagerBeforeUpload",
            "OnFileManagerDirCreate",
            "OnFileManagerDirRemove",
            "OnFileManagerDirRename",
            "OnFileManagerFileCreate",
            "OnFileManagerFileRemove",
            "OnFileManagerFileRename",
            "OnFileManagerFileUpdate",
            "OnFileManagerMoveObject",
            "OnFileManagerUpload",
            "OnHandleRequest",
            "OnInitCulture",
            "OnLoadWebDocument",
            "OnLoadWebPageCache",
            "OnManagerAuthentication",
            "OnManagerLogin",
            "OnManagerLoginFormPrerender",
            "OnManagerLoginFormRender",
            "OnManagerLogout",
            "OnManagerPageAfterRender",
            "OnManagerPageBeforeRender",
            "OnManagerPageInit",
            "OnMediaSourceBeforeFormDelete",
            "OnMediaSourceBeforeFormSave",
            "OnMediaSourceDuplicate",
            "OnMediaSourceFormDelete",
            "OnMediaSourceFormSave",
            "OnMediaSourceGetProperties",
            "OnMODXInit",
            "OnPackageInstall",
            "OnPackageRemove",
            "OnPackageUninstall",
            "OnPageNotFound",
            "OnPageUnauthorized",
            "OnParseDocument",
            "OnPluginBeforeRemove",
            "OnPluginBeforeSave",
            "OnPluginEventBeforeRemove",
            "OnPluginEventBeforeSave",
            "OnPluginEventRemove",
            "OnPluginEventSave",
            "OnPluginFormDelete",
            "OnPluginFormPrerender",
            "OnPluginFormRender",
            "OnPluginFormSave",
            "OnPluginRemove",
            "OnPluginSave",
            "OnPropertySetBeforeRemove",
            "OnPropertySetBeforeSave",
            "OnPropertySetRemove",
            "OnPropertySetSave",
            "OnResourceAddToResourceGroup",
            "OnResourceAutoPublish",
            "OnResourceBeforeSort",
            "OnResourceCacheUpdate",
            "OnResourceDelete",
            "OnResourceDuplicate",
            "OnResourceGroupBeforeRemove",
            "OnResourceGroupBeforeSave",
            "OnResourceGroupRemove",
            "OnResourceGroupSave",
            "OnResourceRemoveFromResourceGroup",
            "OnResourceSort",
            "OnResourceToolbarLoad",
            "OnResourceTVFormPrerender",
            "OnResourceTVFormRender",
            "OnResourceUndelete",
            "OnRichTextBrowserInit",
            "OnRichTextEditorInit",
            "OnRichTextEditorRegister",
            "OnSiteRefresh",
            "OnSiteSettingsRender",
            "OnSnipFormDelete",
            "OnSnipFormPrerender",
            "OnSnipFormRender",
            "OnSnipFormSave",
            "OnSnippetBeforeRemove",
            "OnSnippetBeforeSave",
            "OnSnippetRemove",
            "OnSnippetSave",
            "OnTempFormDelete",
            "OnTempFormPrerender",
            "OnTempFormRender",
            "OnTempFormSave",
            "OnTemplateBeforeRemove",
            "OnTemplateBeforeSave",
            "OnTemplateRemove",
            "OnTemplateSave",
            "OnTemplateVarBeforeRemove",
            "OnTemplateVarBeforeSave",
            "OnTemplateVarRemove",
            "OnTemplateVarSave",
            "OnTVFormDelete",
            "OnTVFormPrerender",
            "OnTVFormRender",
            "OnTVFormSave",
            "OnTVInputPropertiesList",
            "OnTVInputRenderList",
            "OnTVOutputRenderList",
            "OnTVOutputRenderPropertiesList",
            "OnUserActivate",
            "OnUserAddToGroup",
            "OnUserBeforeAddToGroup",
            "OnUserBeforeRemove",
            "OnUserBeforeRemoveFromGroup",
            "OnUserBeforeSave",
            "OnUserChangePassword",
            "OnUserDeactivate",
            "OnUserDuplicate",
            "OnUserFormDelete",
            "OnUserFormPrerender",
            "OnUserFormRender",
            "OnUserFormSave",
            "OnUserGroupBeforeRemove",
            "OnUserGroupBeforeSave",
            "OnUserGroupFormSave",
            "OnUserGroupRemove",
            "OnUserGroupSave",
            "OnUserNotFound",
            "OnUserProfileBeforeRemove",
            "OnUserProfileBeforeSave",
            "OnUserProfileRemove",
            "OnUserProfileSave",
            "OnUserRemove",
            "OnUserRemoveFromGroup",
            "OnUserSave",
            "OnWebAuthentication",
            "OnWebLogin",
            "OnWebLogout",
            "OnWebPageComplete",
            "OnWebPageInit",
            "OnWebPagePrerender"
          ]
        },
        {
          "type": "string"
        }
      ]
    },

    "event": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": { "$ref": "#/definitions/eventName" },
        "priority": {
          "type": "integer"
        },
        "propertySet": {
          "type": "string"
        }
      }
    },

    "category": {
      "oneOf": [
        {"type":  "string"},
        {"type":  "array", "items":  {"type": "string"}}
      ]
    },

    "element": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties":  {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "file": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "category": { "$ref": "#/definitions/category" },
        "propertyPreProcess": {
          "type": "integer"
        },
        "properties": {
          "$ref": "#/definitions/properties"
        },
        "propertySets": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  },

  "required": [
    "name",
    "version"
  ],

  "additionalProperties": false,

  "properties": {
    "name": {
      "type": "string",
      "description": "Package name"
    },
    "lowCaseName": {
      "type": "string"
    },
    "namespace": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "author": {
      "type": "string"
    },
    "version": {
      "type": "string",
      "pattern": "^[0-9]+.[0-9]+.[0-9]+(-[a-zA-Z]+)?[0-9]*$"
    },

    "menus": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "text"
                ],
                "properties": {
                  "text": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "action": {
                    "type": "string"
                  },
                  "parent": {
                    "type": "string",
                    "default": "components"
                  },
                  "icon": {
                    "type": "string"
                  },
                  "menuIndex": {
                    "type": "integer"
                  },
                  "params": {
                    "type": "string"
                  },
                  "handler": {
                    "type": "string"
                  },
                  "permission": {
                    "type": "string"
                  }
                }
              }
            ]
          }
        }
      ]
    },

    "systemSettings": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "type": "object",
                "additionalProperties": false,
                "required": ["key"],
                "properties": {
                  "key": {
                    "type": "string"
                  },
                  "namespace": {
                    "type": "string"
                  },
                  "type": {
                    "$ref": "#/definitions/type"
                  },
                  "area": {
                    "type": "string",
                    "default": "default"
                  },
                  "value": {
                    "oneOf": [
                      { "type": "string" },
                      { "type": "number" },
                      { "type": "boolean" }
                    ]
                  }
                }
              }
            ]
          }
        }
      ]
    },

    "categories": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": { "$ref": "#/definitions/categories" }
        }
      ]
    },

    "snippets": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              { "$ref": "#/definitions/element" }
            ]
          }
        }
      ]
    },

    "chunks": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              { "$ref": "#/definitions/element" }
            ]
          }
        }
      ]
    },

    "plugins": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "allOf": [
                  { "$ref": "#/definitions/element" },
                  {
                    "properties": {
                      "disabled": {
                        "type": "boolean"
                      },
                      "events": {
                        "type": "array",
                        "items": {
                          "anyOf": [
                            { "$ref": "#/definitions/eventName" },
                            { "$ref": "#/definitions/event" }
                          ]
                        }
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    },

    "templates": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "allOf": [
                  { "$ref": "#/definitions/element" },
                  {
                    "properties": {
                      "icon": {
                        "type": "string"
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    },

    "tvs": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "allOf": [
                  { "$ref": "#/definitions/element" },
                  {
                    "properties": {
                      "caption": {
                        "type": "string"
                      },
                      "defaultValue": {
                        "type": "string"
                      },
                      "type": {
                        "anyOf": [
                          {
                            "type": "string",
                            "enum": [
                              "autotag",
                              "checkbox",
                              "date",
                              "email",
                              "file",
                              "hidden",
                              "image",
                              "listbox-multiple",
                              "listbox",
                              "number",
                              "option",
                              "resourcelist",
                              "richtext",
                              "tag",
                              "text",
                              "textarea",
                              "url"
                            ]
                          },
                          {
                            "type": "string"
                          }
                        ]
                      },
                      "inputOptionValues": {
                        "type": "string"
                      },
                      "outputType": {
                        "anyOf": [
                          {
                            "type": "string",
                            "enum": [
                              "date",
                              "default",
                              "delim",
                              "htmltag",
                              "image",
                              "richtext",
                              "string",
                              "text",
                              "url"
                            ]
                          },
                          {
                            "type": "string"
                          }
                        ]
                      },
                      "inputOptions": {
                        "type": "object"
                      },
                      "outputOptions": {
                        "type": "object"
                      },
                      "templates": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "sortOrder": {
                        "type": "number"
                      }
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    },

    "propertySets": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "type": "object",
                "additionalProperties": false,
                "required": ["name"],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "category": {
                    "$ref": "#/definitions/category"
                  },
                  "properties": {
                    "$ref": "#/definitions/properties"
                  }
                }
              }
            ]
          }
        }
      ]
    },

    "build": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "readme": {
              "type": "string"
            },
            "license": {
              "type": "string"
            },
            "changelog": {
              "type": "string"
            },
            "scriptsBefore": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "requires": {
              "type": "object"
            },
            "setupOptions": {
              "type": "string"
            },
            "installValidator": {
              "type": "string"
            },
            "unInstallValidator": {
              "type": "string"
            },
            "scriptsAfter": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ]
    },

    "database": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "tables": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ]
    },

    "widgets": {
      "oneOf": [
        { "$ref": "#/definitions/partialConfig" },
        {
          "type": "array",
          "items": {
            "anyOf": [
              { "$ref": "#/definitions/partialConfig" },
              {
                "type": "object",
                "additionalProperties": false,
                "required": ["name"],
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "type": {
                    "type": "string",
                    "default": "file",
                    "enum": ["html", "file", "snippet", "php"]
                  },
                  "size": {
                    "type": "string",
                    "default": "half",
                    "enum": ["quarter", "one-third", "half", "two-third", "three-quarters", "full", "double"]
                  },
                  "content": {
                    "type": "string"
                  },
                  "lexicon": {
                    "type": "string"
                  },
                  "permission": {
                    "type": "string"
                  },
                  "properties": {
                    "type": "object"
                  }
                }
              }
            ]
          }
        }
      ]
    }
  }
}