{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://flowable.com/pallete.json",
  "type": "object",
  "title": "The Palette Schema",
  "description": "This is a helper resource, not officially supported",
  "required": [
    "Palette-Id"
  ],
  "properties": {
    "Palette-Id": {
      "type": "string",
      "minLength": 1,
      "title": "Palette Id",
      "description": "The definition id of the palette"
    },
    "title": {
      "type": "string",
      "title": "Name of the palette",
      "description": "Custom name that can be given to the palette"
    },
    "patchPalettes": {
      "type": "array",
      "title": "Palette IDs that should be extended by this palette",
      "description": "This shouldn't be set if you're creating a new palette instead of tweaking an existing one.",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "flowable-core-process-palette",
              "flowable-work-process-palette",
              "flowable-engage-process-palette",
              "flowable-core-case-palette",
              "flowable-work-case-palette",
              "flowable-engage-case-palette",
              "flowable-core-form-palette",
              "flowable-work-form-palette",
              "flowable-engage-form-palette",
              "flowable-work-page-palette",
              "flowable-engage-page-palette",
              "flowable-core-drd-palette",
              "flowable-work-drd-palette",
              "flowable-engage-drd-palette"
            ]
          },
          {
            "type": "string"
          }
        ]
      }
    },
    "resourceBundles": {
      "type": "array",
      "title": "References to i18n files",
      "description": "",
      "items": [
        {
          "type": "string"
        }
      ]
    },
    "groups": {
      "type": "object",
      "title": "Groups",
      "description": "An array of group definitions. The key is the value of the group key.",
      "patternProperties": {
        ".*": {
          "$ref": "#/definitions/group"
        }
      }
    },
    "stencils": {
      "type": "array",
      "title": "Stencils",
      "description": "Definitions for the elements of the palette",
      "items": {
        "$ref": "#/definitions/stencil"
      }
    },
    "presentations": {
      "type": "array",
      "title": "Presentations",
      "description": "Definition of presentations to specify icons for components",
      "items": {
        "$ref": "#/definitions/presentation"
      }
    },
    "removeStencils": {
      "type": "array",
      "title": "Remove stencils",
      "description": "List of stencils to be removed with this palette file.",
      "items": {
        "type": "string"
      }
    },
    "favoritePaletteItems": {
      "type": "array",
      "title": "Favorite palette items",
      "description": "List of stencil ids to be shown as favorites",
      "items": {
        "type": "string",
        "title": "Stencil ID"
      }
    },
    "additionalPropertyPackages": {
      "type": "object",
      "title": "Additional property packages",
      "description": "List of additional property packages to be applied for a stencil id.",
      "patternProperties": {
        ".*": {
          "type": "array",
          "title": "List of stencil IDs",
          "items": {
            "type": "string",
            "title": "Stencil ID"
          }
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "title": "Additional properties",
      "description": "List of additional properties to be applied for a stencil id.",
      "patternProperties": {
        ".*": {
          "type": "array",
          "title": "Properties to be added",
          "items": {
            "$ref": "#/definitions/property"
          }
        }
      }
    },
    "tabCategories": {
      "type": "object",
      "title": "Tab categories",
      "description": "Map of custom tab categories.",
      "patternProperties": {
        ".*": {
          "$ref": "#/definitions/tab"
        }
      }
    },
    "sectionCategories": {
      "type": "array",
      "title": "Section categories",
      "description": "List of custom section categories.",
      "items": {
        "$ref": "#/definitions/category"
      }
    }
  },
  "definitions": {
    "group": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "title": "Group title",
          "description": "The title of the group"
        },
        "description": {
          "type": "string",
          "title": "Group description",
          "description": "The description of the group"
        },
        "index": {
          "type": "integer",
          "title": "Group index",
          "description": "The order of the group"
        },
        "basePaletteItemId": {
          "type": "string",
          "title": "Base palette item id",
          "description": "The id of the main stencil to be used for this group."
        },
        "visibleInViews": {
          "type": "array",
          "title": "Visible in views",
          "description": "Palette views in which the group is visible",
          "items": {
            "type": "string",
            "enum": [
              "icon",
              "quick",
              "list"
            ]
          }
        }
      }
    },
    "stencil": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "description": "Unique ID for the stencil"
        },
        "title": {
          "type": "string",
          "title": "Name",
          "description": "The name of the stencil"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "The description of the stencil"
        },
        "superId": {
          "type": "string",
          "title": "Super ID",
          "description": "A reference to a parent stencil"
        },
        "index": {
          "type": "integer",
          "title": "Index",
          "description": "The index of the stencil within its group"
        },
        "presentationId": {
          "type": "string",
          "title": "Presentation ID",
          "description": "Id of the presentation specifiying the icons for this component."
        },
        "groups": {
          "type": "array",
          "title": "Groups",
          "description": "The group keys that the stencil is part of (a stencil can be in more than one group).",
          "items": {
            "type": "string"
          }
        },
        "properties": {
          "type": "array",
          "title": "Properties",
          "description": "The stencil properties",
          "items": {
            "$ref": "#/definitions/property"
          }
        }
      }
    },
    "property": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "description": "The unique ID of the property"
        },
        "type": {
          "oneOf": [
            {
              "type": "string",
              "not": {
                "enum": [
                  "Boolean",
                  "Integer",
                  "TextArea",
                  "Multiline",
                  "Complex",
                  "FormList",
                  "Json",
                  "SimpleText",
                  "SimpleTextExpression"
                ]
              }
            },
            {
              "enum": [
                "Boolean",
                "Integer",
                "TextArea",
                "Multiline",
                "Complex",
                "FormList",
                "Json",
                "SimpleText",
                "SimpleTextExpression",
                "ComboBox",
                "RestComboBox"
              ]
            }
          ],
          "title": "Type",
          "description": "The type of the property"
        },
        "title": {
          "type": "string",
          "title": "Name",
          "description": "The name of the property"
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "The description of the property"
        },
        "path": {
          "type": "string",
          "title": "Path",
          "description": "The path where it should be stored for Forms and Pages"
        },
        "value": {
          "type": [
            "string",
            "integer",
            "boolean"
          ],
          "title": "Value",
          "description": "The optional default value of the property"
        },
        "category": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "commonDetails"
              ]
            },
            {
              "type": "string",
              "not": {
                "enum": [
                  "commonDetails"
                ]
              }
            }
          ],
          "title": "Category",
          "description": "The category that this property belongs to. This is required to make the attribute visible."
        },
        "editCategory": {
          "type": "string",
          "title": "Edit category",
          "description": "The category allows to group together multiple attributes for editing."
        },
        "index": {
          "type": "integer",
          "title": "Index",
          "description": "The index of the property within its group"
        },
        "optional": {
          "type": "boolean",
          "title": "Optional",
          "default": false,
          "description": "Whether the property is mandatory."
        },
        "constant": {
          "type": "boolean",
          "title": "Constant",
          "default": false,
          "description": "Whether the property is a constant property."
        },
        "readonly": {
          "type": "boolean",
          "title": "Read Only",
          "default": false,
          "description": "Whether the property is read only."
        },
        "visible": {
          "type": "boolean",
          "title": "Visible",
          "default": false,
          "description": "Whether the property is visible."
        },
        "runtime": {
          "type": "boolean",
          "title": "Runtime",
          "default": false,
          "description": "Wheather the property is evaluated during runtime."
        },
        "exportToXml": {
          "type": "boolean",
          "title": "Export to XML",
          "default": true,
          "description": "Whether the property should be exported to XML."
        },
        "exportAsExtensionElement": {
          "type": "boolean",
          "title": "Export as an extension element",
          "default": true,
          "description": "Export the property as an extension element under the flowable namespace"
        },
        "exportAsFieldExtension": {
          "type": "boolean",
          "title": "Export as a field extension",
          "default": true,
          "description": "Export the property as a field extension under the flowable namespace"
        },
        "variableExtractor": {
          "type": "object",
          "title": "Variable Extractor",
          "description": "Use variable as part of expression builder as writing variable",
          "properties": {
            "type": {
              "oneOf": [
                {
                  "type": "string"
                },
                {
                  "type": "string",
                  "enum": [
                    "simple"
                  ]
                }
              ],
              "title": "Type",
              "description": "The type of the variable extractor to be used"
            }
          },
          "required": [
            "type"
          ]
        },
        "tracking": {
          "type": "array",
          "title": "Tracking",
          "description": "Tracking items to show for FormList on the left side in the overview.",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "The id must match the id out of the complexItems"
              }
            }
          }
        },
        "complexItems": {
          "type": "array",
          "title": "Complex Items",
          "description": "Complex Items as sub-elements for the type Complex or FormList",
          "items": {
            "$ref": "#/definitions/property"
          }
        },
        "restURL": {
          "type": "string",
          "title": "REST URL",
          "description": "URL for a Flowable Design REST endpoint to be called for the RestComboBox"
        },
        "fieldMap": {
          "type": "string",
          "title": "Field Map",
          "description": "Title and Value with comma separated for the RestComboBox"
        },
        "items": {
          "type": "array",
          "title": "Items",
          "description": "Items for ComboBox",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "title": "Unique identifier"
              },
              "value": {
                "type": "string",
                "title": "Value",
                "description": "Value saved to the model"
              },
              "title": {
                "type": "string",
                "title": "Title",
                "description": "Title visible in Flowable Design."
              }
            }
          }
        }
      },
      "required": [
        "id"
      ]
    },
    "presentation": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "description": "Unique ID for the presentation"
        },
        "icon": {
          "type": "string",
          "title": "Icon",
          "description": "Icon of task to be shown in the palette and diagram (typically png 16x16) placed into the folder relative to the current file component-presentations/palette-icons/ and prefixed in this attribute with ../palette-icons?id=component-presentations/palette-icons/"
        },
        "bigIcon": {
          "type": "string",
          "title": "Big Icon",
          "description": "Larger icon to be shown in the palette for icon view (typically svg) placed into the folder relative to the current file component-presentations/palette-icons/ and prefixed in this attribute with ../palette-icons?id=component-presentations/palette-icons/"
        }
      },
      "required": [
        "id"
      ]
    },
    "tab": {
      "type": "object",
      "properties": {
        "index": {
          "type": "integer",
          "title": "Tab index",
          "description": "The order of the tab"
        },
        "visible": {
          "type": "boolean",
          "title": "Visible",
          "default": true,
          "description": "Whether the tab is visible."
        },
        "title": {
          "type": "string",
          "title": "Name of the tab",
          "description": "Custom name that can be given to the tab"
        },
        "icon": {
          "type": "string",
          "title": "Icon",
          "description": "Fontawesome icon of the tab."
        },
        "sectionCategories": {
          "type": "array",
          "title": "Section categories",
          "description": "List of sections to be shown in the tab.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "category": {
      "type": "object",
      "title": "Section category",
      "properties": {
        "id": {
          "type": "string",
          "title": "ID",
          "description": "Unique ID for the presentation"
        },
        "index": {
          "type": "integer",
          "title": "Section category index",
          "description": "The order of the section category"
        },
        "visible": {
          "type": "boolean",
          "title": "Visible",
          "default": true,
          "description": "Whether the section category is visible."
        },
        "title": {
          "type": "string",
          "title": "Name of the section category",
          "description": "Custom name that can be given to the section category"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}