Структура и настройка contract.json

Описание

Файл contract.json является конфигурационным файлом, который определяет структуру и настройки плагина для YCLIENTS. Он находится в директории frontend/ и является обязательным для корректной работы плагина.

Структура файла

packages

Объект, который определяет различные пакеты (модули) плагина. Каждый пакет имеет уникальный идентификатор и содержит следующие параметры:

Параметры пакета

• application (string) — определяет, в каком приложении YCLIENTS будет использоваться пакет:
  • erp — для основного приложения YCLIENTS.
  • widget — для виджета.
• areas (string[]) — определяет список мест в приложении, где будут отображаться пакеты плагина:
  • plugin-settings — настройки плагина.
  • erp-visit-modal-client-details — детали клиента в модальном окне посещения ERP.

plugin-slug

• Тип: string.
• Описание: Уникальный идентификатор плагина в системе YCLIENTS.
• Пример: "color-picker-slug".

version

• Тип: string.
• Описание: Версия плагина в формате semver (semantic versioning).
• Пример: "1.0.0".

Пример конфигурации

{
  "packages": {
    "color-picker-erp-settings": {
      "application": "erp",
      "areas": ["plugin-settings"]
    },
    "color-picker-erp-timetable": {
      "application": "erp",
      "areas": ["erp-timetable-controls", "erp-timetable-record-client-name"]
    },
    "color-picker-widget": {
      "application": "widget",
      "areas": ["staff_info_comments"]
    }
  },
  "plugin-slug": "color-picker-slug"
}

Важные замечания

1. При внесении изменений в файл необходимо соблюдать правильный формат JSON.
2. Все идентификаторы пакетов должны быть уникальными в рамках системы YCLIENTS.
3. Версия плагина должна соответствовать формату semver.
4. Изменение plugin-slug может привести к тому, что система будет воспринимать плагин как новый.

Использование

Этот файл используется системой YCLIENTS для:

• Определения мест отображения функциональности плагина.
• Идентификации плагина в системе.
• Управления версиями плагина.
• Интеграции плагина с различными частями системы YCLIENTS.