@maxisoft/instantcms-mcp 1.2.3

package/dist/registry/generator-tools.js

@@ -0,0 +1,506 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerGeneratorTools = registerGeneratorTools;
+const zod_1 = require("zod");
+const addon_tool_js_1 = require("../tools/addon-tool.js");
+const scaffold_tool_js_1 = require("../tools/scaffold-tool.js");
+const crud_tool_js_1 = require("../tools/crud-tool.js");
+const form_tool_js_1 = require("../tools/form-tool.js");
+const grid_tool_js_1 = require("../tools/grid-tool.js");
+const api_tool_js_1 = require("../tools/api-tool.js");
+const test_tool_js_1 = require("../tools/test-tool.js");
+const email_tool_js_1 = require("../tools/email-tool.js");
+const layout_override_tool_js_1 = require("../tools/layout-override-tool.js");
+const admin_partial_tool_js_1 = require("../tools/admin-partial-tool.js");
+const template_overrides_tool_js_1 = require("../tools/template-overrides-tool.js");
+const cron_tool_js_1 = require("../tools/cron-tool.js");
+const hooks_js_1 = require("../data/hooks.js");
+function registerGeneratorTools(server) {
+    // ── 1. Структура дополнения ──────────────────────────────────────────────
+    server.tool('get_addon_structure', 'Возвращает полную структуру файлов и папок для дополнения InstantCMS с описанием каждого файла и шаблонами кода', {
+        addon_type: zod_1.z
+            .enum(['basic', 'with_admin', 'with_hooks', 'with_routes', 'with_widget'])
+            .default('basic')
+            .describe('Тип дополнения: basic (только фронтенд), with_admin (с CRUD панелью), with_hooks (с хуками), with_routes (кастомные URL), with_widget (с виджетом)'),
+    }, async ({ addon_type }) => {
+        const result = (0, addon_tool_js_1.getAddonStructure)(addon_type);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2. Генерация скаффолда дополнения ────────────────────────────────────
+    server.tool('scaffold_addon', 'Генерирует готовый код всех файлов дополнения InstantCMS на основе параметров. Возвращает map {имя_файла: содержимое}', {
+        name: zod_1.z
+            .string()
+            .regex(/^[a-z][a-z0-9_]{1,63}$/)
+            .describe('Техническое имя: 2–64 строчных латинских символа, цифры и подчёркивания'),
+        title: zod_1.z.string().trim().min(1).max(200).describe('Отображаемое название дополнения'),
+        type: zod_1.z
+            .enum(['basic', 'with_admin', 'with_hooks', 'with_routes', 'with_widget'])
+            .default('basic')
+            .describe('Тип дополнения'),
+        author: zod_1.z.string().trim().min(1).max(200).optional().describe('Имя автора'),
+        author_url: zod_1.z.string().url().optional().describe('URL сайта автора'),
+        version: zod_1.z
+            .string()
+            .regex(/^\d+\.\d+\.\d+$/)
+            .optional()
+            .default('1.0.0')
+            .describe('Версия X.Y.Z'),
+        description: zod_1.z.string().trim().max(1000).optional().describe('Описание дополнения'),
+        hooks: zod_1.z
+            .array(zod_1.z.string().refine(value => hooks_js_1.hooks.some(h => h.name === value), 'Неизвестный хук'))
+            .max(100)
+            .optional()
+            .describe("Список хуков для интеграции. Пример: ['content_after_add_approve', 'user_registered']"),
+    }, async (opts) => {
+        const result = (0, scaffold_tool_js_1.scaffoldAddon)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.1. Генерация CRUD для контент-типа ─────────────────────────────────
+    server.tool('scaffold_crud', 'Генерирует полный CRUD для контент-типа InstantCMS: модель, контроллеры фронтенда и бэкенда, гриды, формы', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_crud'),
+        fields: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя поля БД. Пример: title'),
+            type: zod_1.z.string().describe('Тип поля: varchar, text, html, int, date, etc.'),
+            title: zod_1.z.string().optional().describe('Заголовок поля для формы'),
+            comment: zod_1.z.string().optional().describe('Комментарий поля'),
+            is_system: zod_1.z.boolean().optional().describe('Системное поле'),
+            default: zod_1.z
+                .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean()])
+                .optional()
+                .describe('Значение по умолчанию'),
+            key: zod_1.z.string().optional().describe('Ключ: MUL, PRI, etc.'),
+        }))
+            .describe('Список полей таблицы'),
+        options: zod_1.z
+            .object({
+            use_category: zod_1.z.boolean().optional().describe('Использовать категории'),
+            use_tags: zod_1.z.boolean().optional().describe('Использовать теги'),
+            use_comments: zod_1.z.boolean().optional().describe('Использовать комментарии'),
+            use_rating: zod_1.z.boolean().optional().describe('Использовать рейтинг'),
+            use_moderation: zod_1.z.boolean().optional().describe('Использовать модерацию'),
+            use_seo: zod_1.z.boolean().optional().describe('Использовать SEO'),
+            use_content: zod_1.z.boolean().optional().describe('Использовать контент-тип'),
+            list_template: zod_1.z.enum(['grid', 'list', 'table']).optional().describe('Шаблон списка'),
+        })
+            .optional()
+            .describe('Дополнительные опции'),
+    }, async (opts) => {
+        const result = (0, crud_tool_js_1.scaffoldCrud)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.2. Генерация формы ──────────────────────────────────────────────────
+    server.tool('scaffold_form', 'Генерирует PHP класс формы для бэкенда InstantCMS с указанными полями и правилами валидации', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_addon'),
+        form_name: zod_1.z
+            .string()
+            .describe('Имя формы (без префикса form_). Пример: item, options, profile'),
+        fields: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя поля. Пример: title, content, price'),
+            type: zod_1.z
+                .string()
+                .describe('Тип поля: varchar, text, html, int, date, datetime, checkbox, select, file, image, user, etc.'),
+            title: zod_1.z.string().optional().describe('Заголовок поля в форме'),
+            rules: zod_1.z
+                .array(zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.unknown())]))
+                .optional()
+                .describe("Правила валидации: [['required'], ['max_length', 255]]"),
+            options: zod_1.z
+                .record(zod_1.z.string(), zod_1.z.unknown())
+                .optional()
+                .describe('Дополнительные опции поля'),
+            is_system: zod_1.z.boolean().optional().describe("Добавить в секцию 'system' вместо 'basic'"),
+        }))
+            .describe('Список полей формы'),
+        options: zod_1.z
+            .object({
+            use_tabs: zod_1.z.boolean().optional().describe('Использовать табы для группировки полей'),
+            use_separate_save: zod_1.z
+                .boolean()
+                .optional()
+                .describe('Генерировать отдельный класс для сохранения'),
+            generate_rules: zod_1.z
+                .boolean()
+                .optional()
+                .describe('Автоматически генерировать правила валидации'),
+        })
+            .optional()
+            .describe('Опции формы'),
+    }, async (opts) => {
+        const result = (0, form_tool_js_1.scaffoldForm)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.3. Генерация грида ──────────────────────────────────────────────────
+    server.tool('scaffold_grid', 'Генерирует PHP функцию грида для бэкенда InstantCMS с колонками, фильтрами и экшенами', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_addon'),
+        grid_name: zod_1.z
+            .string()
+            .describe('Имя грида (без префикса grid_). Пример: items, products, orders'),
+        columns: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя колонки. Пример: title, date_pub, is_pub'),
+            title: zod_1.z.string().describe('Заголовок колонки'),
+            width: zod_1.z.number().optional().describe('Ширина колонки в пикселях'),
+            filter: zod_1.z.string().optional().describe('Тип фильтра: like, eq, gt, lt, date, etc.'),
+            href: zod_1.z
+                .string()
+                .optional()
+                .describe("URL для клика по ссылке. Пример: href_to($controller->root_url, 'items', ['edit', '{id}'])"),
+            show: zod_1.z.boolean().optional().describe('Показывать колонку по умолчанию'),
+            flag: zod_1.z.boolean().optional().describe('Отображать как флаг (вкл/выкл)'),
+            flag_toggle: zod_1.z.string().optional().describe('URL для переключения флага'),
+            handler: zod_1.z
+                .string()
+                .optional()
+                .describe('PHP функция-обработчик значения: function ($value) { return ...; }'),
+            order_by: zod_1.z.boolean().optional().describe('Разрешить сортировку по этой колонке'),
+        }))
+            .describe('Колонки грида'),
+        options: zod_1.z
+            .object({
+            is_sortable: zod_1.z.boolean().optional().describe('Включить сортировку'),
+            is_filter: zod_1.z.boolean().optional().describe('Включить фильтры'),
+            is_pagination: zod_1.z.boolean().optional().describe('Включить пагинацию'),
+            is_draggable: zod_1.z.boolean().optional().describe('Включить drag-n-drop сортировку'),
+            is_selectable: zod_1.z.boolean().optional().describe('Включить чекбоксы для массовых операций'),
+            is_collapsible: zod_1.z
+                .boolean()
+                .optional()
+                .describe('Позволить пользователям сворачивать колонки'),
+            order_by: zod_1.z.string().optional().describe('Поле сортировки по умолчанию'),
+            order_to: zod_1.z
+                .enum(['asc', 'desc'])
+                .optional()
+                .describe('Направление сортировки по умолчанию'),
+            show_id: zod_1.z.boolean().optional().describe('Показывать колонку ID'),
+            filter_button_title: zod_1.z.string().optional().describe('Текст кнопки фильтра'),
+        })
+            .optional()
+            .describe('Опции грида'),
+        actions: zod_1.z
+            .array(zod_1.z.object({
+            title: zod_1.z.string().describe('Заголовок кнопки. Пример: EDIT, DELETE'),
+            href: zod_1.z
+                .string()
+                .describe("URL экшена. Пример: href_to($controller->root_url, 'items', ['edit', '{id}'])"),
+            icon: zod_1.z.string().optional().describe('Иконка: pen, times-circle, eye, etc.'),
+            class: zod_1.z.string().optional().describe('Дополнительные CSS классы. Пример: text-danger'),
+            confirm: zod_1.z.string().optional().describe('Текст подтверждения действия'),
+        }))
+            .optional()
+            .describe('Кнопки действий'),
+    }, async (opts) => {
+        const result = (0, grid_tool_js_1.scaffoldGrid)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.4. Генерация REST API ──────────────────────────────────────────────
+    server.tool('scaffold_api', 'Генерирует REST API контроллер для InstantCMS с эндпоинтами, аутентификацией и опционально OpenAPI спецификацией', {
+        addon_name: zod_1.z.string().describe('Техническое имя API. Пример: my_api'),
+        version: zod_1.z.string().optional().default('v1').describe('Версия API. Пример: v1, v2'),
+        endpoints: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя эндпоинта. Пример: list, get, create, update, delete'),
+            method: zod_1.z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']).describe('HTTP метод'),
+            path: zod_1.z.string().describe('Путь эндпоинта. Пример: /list, /{id}, /search'),
+            description: zod_1.z.string().optional().describe('Описание эндпоинта'),
+            auth_required: zod_1.z.boolean().optional().describe('Требуется ли аутентификация'),
+            params: zod_1.z
+                .array(zod_1.z.object({
+                name: zod_1.z.string().describe('Имя параметра'),
+                type: zod_1.z.enum(['path', 'query', 'body']).describe('Тип параметра'),
+                required: zod_1.z.boolean().optional().describe('Обязательный параметр'),
+                description: zod_1.z.string().optional().describe('Описание параметра'),
+            }))
+                .optional()
+                .describe('Параметры эндпоинта'),
+        }))
+            .describe('Список эндпоинтов API'),
+        options: zod_1.z
+            .object({
+            use_swagger: zod_1.z.boolean().optional().describe('Генерировать OpenAPI спецификацию'),
+            use_rate_limit: zod_1.z.boolean().optional().describe('Включить rate limiting'),
+            base_path: zod_1.z
+                .string()
+                .optional()
+                .describe('Базовая часть пути. По умолчанию: /api/{version}/{addon_name}'),
+        })
+            .optional()
+            .describe('Опции API'),
+    }, async (opts) => {
+        const result = (0, api_tool_js_1.scaffoldApi)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.5. Генерация тестов ─────────────────────────────────────────────────
+    server.tool('scaffold_test', 'Генерирует PHPUnit или Codeception тесты для дополнения InstantCMS', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_addon'),
+        class_name: zod_1.z.string().describe('Имя тестируемого класса. Пример: modelMyaddon'),
+        class_type: zod_1.z.enum(['model', 'controller', 'component', 'widget']).describe('Тип класса'),
+        methods: zod_1.z.array(zod_1.z.string()).describe('Список методов для тестирования'),
+        options: zod_1.z
+            .object({
+            test_framework: zod_1.z
+                .enum(['phpunit', 'codeception'])
+                .optional()
+                .default('phpunit')
+                .describe('Фреймворк для тестов'),
+            mock_db: zod_1.z.boolean().optional().default(true).describe('Создавать мок для базы данных'),
+            mock_cache: zod_1.z.boolean().optional().default(true).describe('Создавать мок для кэша'),
+        })
+            .optional()
+            .describe('Опции генерации тестов'),
+    }, async (opts) => {
+        const result = (0, test_tool_js_1.scaffoldTest)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.6. Генерация email шаблонов ───────────────────────────────────────
+    server.tool('scaffold_email', 'Генерирует HTML email шаблоны для уведомлений InstantCMS с переменными и стилями', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_addon'),
+        templates: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя шаблона. Пример: welcome, notification, reminder'),
+            subject: zod_1.z.string().describe('Тема письма'),
+            body: zod_1.z
+                .string()
+                .describe('Тело письма с поддержкой переменных {user_name}, {site_name}, etc.'),
+            variables: zod_1.z
+                .array(zod_1.z.object({
+                name: zod_1.z.string().describe('Имя переменной'),
+                description: zod_1.z.string().optional().describe('Описание переменной'),
+                example: zod_1.z.string().optional().describe('Пример значения'),
+            }))
+                .optional()
+                .describe('Список переменных в шаблоне'),
+        }))
+            .describe('Список email шаблонов'),
+        options: zod_1.z
+            .object({
+            use_html: zod_1.z.boolean().optional().default(true).describe('Использовать HTML разметку'),
+            base_template: zod_1.z
+                .enum(['default', 'minimal', 'notifications'])
+                .optional()
+                .default('default')
+                .describe('Базовый шаблон стилей'),
+        })
+            .optional()
+            .describe('Опции email'),
+    }, async (opts) => {
+        const result = (0, email_tool_js_1.scaffoldEmail)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.7. Генерация переопределений шаблонов ──────────────────────────────
+    server.tool('scaffold_layout_override', 'Генерирует шаблоны для переопределения стандартных шаблонов контроллеров InstantCMS в пользовательских темах', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_overrides'),
+        overrides: zod_1.z
+            .array(zod_1.z.object({
+            controller: zod_1.z.string().describe('Имя контроллера. Пример: content, users, photos'),
+            template: zod_1.z.string().describe('Имя темы для переопределения. Пример: modern, default'),
+            action: zod_1.z
+                .string()
+                .optional()
+                .describe('Имя экшена. Если не указано - переопределяется index'),
+        }))
+            .describe('Список переопределений'),
+        options: zod_1.z
+            .object({
+            use_wrapper: zod_1.z.boolean().optional().describe('Добавить обёртку с сайдбаром'),
+            add_breadcrumbs: zod_1.z.boolean().optional().describe('Добавить хлебные крошки'),
+        })
+            .optional()
+            .describe('Опции генерации'),
+    }, async (opts) => {
+        const result = (0, layout_override_tool_js_1.scaffoldLayoutOverride)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.8. Генерация частей админки ─────────────────────────────────────────
+    server.tool('scaffold_admin_partial', 'Генерирует переиспользуемые части интерфейса админки: header, sidebar, toolbar, breadcrumbs, panels, modals', {
+        addon_name: zod_1.z.string().describe('Техническое имя набора. Пример: my_partials'),
+        partials: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя части. Пример: menu, header, footer'),
+            type: zod_1.z
+                .enum([
+                'header',
+                'sidebar',
+                'footer',
+                'toolbar',
+                'breadcrumb',
+                'panel',
+                'modal',
+                'notification',
+            ])
+                .describe('Тип части'),
+            items: zod_1.z.array(zod_1.z.string()).optional().describe('Элементы меню или списка'),
+        }))
+            .describe('Список частей для генерации'),
+        options: zod_1.z
+            .object({
+            use_bootstrap: zod_1.z
+                .boolean()
+                .optional()
+                .default(true)
+                .describe('Использовать Bootstrap классы'),
+            use_icms_icons: zod_1.z.boolean().optional().default(true).describe('Использовать иконки ICMS'),
+        })
+            .optional()
+            .describe('Опции генерации'),
+    }, async (opts) => {
+        const result = (0, admin_partial_tool_js_1.scaffoldAdminPartial)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.9. Список переопределений шаблонов ──────────────────────────────────
+    server.tool('list_template_overrides', 'Возвращает список всех доступных переопределений шаблонов контроллеров InstantCMS', {
+        controller: zod_1.z
+            .string()
+            .optional()
+            .describe('Фильтр по имени контроллера. Пример: content, users, photos'),
+    }, async ({ controller }) => {
+        const result = (0, template_overrides_tool_js_1.listTemplateOverrides)(controller);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.10. Информация о переопределении ──────────────────────────────────
+    server.tool('get_template_override_info', 'Возвращает подробную информацию о конкретном переопределении шаблона', {
+        controller: zod_1.z.string().describe('Имя контроллера. Пример: content, users'),
+        action: zod_1.z
+            .string()
+            .optional()
+            .describe('Имя экшена. Пример: view, index. Если не указано - возвращает информацию о index'),
+    }, async ({ controller, action }) => {
+        const result = (0, template_overrides_tool_js_1.getTemplateOverrideInfo)(controller, action);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+    // ── 2.11. Генерация cron задач ───────────────────────────────────────────
+    server.tool('scaffold_cron', 'Генерирует PHP cron контроллер для периодических задач с настройкой расписания, блокировками и логированием', {
+        addon_name: zod_1.z.string().describe('Техническое имя дополнения. Пример: my_cron'),
+        tasks: zod_1.z
+            .array(zod_1.z.object({
+            name: zod_1.z.string().describe('Имя задачи. Пример: cleanup, send_emails, sync_data'),
+            schedule: zod_1.z
+                .object({
+                minute: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('Минуты (0-59, * или */n). Пример: 0, */15, 30'),
+                hour: zod_1.z.string().optional().describe('Часы (0-23, * или */n). Пример: 0, */2, 12'),
+                day: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('День месяца (1-31, * или */n). Пример: 1, */7'),
+                month: zod_1.z.string().optional().describe('Месяц (1-12, * или */n). Пример: 1, */3'),
+                day_of_week: zod_1.z
+                    .string()
+                    .optional()
+                    .describe('День недели (0-6, *). Пример: 0 (воскр), 1-5'),
+            })
+                .describe('Расписание в формате cron'),
+            description: zod_1.z.string().optional().describe('Описание задачи'),
+            action: zod_1.z.string().describe('Имя PHP функции для выполнения. Пример: taskCleanup'),
+        }))
+            .describe('Список cron задач'),
+        options: zod_1.z
+            .object({
+            use_lock_file: zod_1.z
+                .boolean()
+                .optional()
+                .default(true)
+                .describe('Блокировка от повторного запуска'),
+            log_execution: zod_1.z.boolean().optional().default(true).describe('Логирование выполнения'),
+        })
+            .optional()
+            .describe('Опции cron'),
+    }, async (opts) => {
+        const result = (0, cron_tool_js_1.scaffoldCron)(opts);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify(result, null, 2),
+                },
+            ],
+        };
+    });
+}