@maxisoft/instantcms-mcp 1.2.3

package/dist/tools/template-development-tool.js

@@ -0,0 +1,271 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scaffoldCompleteTemplate = scaffoldCompleteTemplate;
+exports.analyzeInstantCmsTemplate = analyzeInstantCmsTemplate;
+exports.scaffoldTemplateOverride = scaffoldTemplateOverride;
+exports.validateLayoutScheme = validateLayoutScheme;
+exports.checkTemplateOverrideCompatibility = checkTemplateOverrideCompatibility;
+const yaml_1 = require("yaml");
+const scaffold_tool_js_1 = require("./scaffold-tool.js");
+const layout_tool_js_1 = require("./layout-tool.js");
+const safeNamePattern = /^[a-z][a-z0-9_]{1,63}$/;
+function normalizeFiles(files) {
+    return Object.fromEntries(Object.entries(files).map(([path, content]) => [
+        path.replace(/\\/g, '/').replace(/^\.\//, ''),
+        content,
+    ]));
+}
+function assertSafeName(value, label) {
+    if (!safeNamePattern.test(value))
+        throw new Error(`${label} must match ${safeNamePattern}`);
+}
+function scaffoldCompleteTemplate(options) {
+    assertSafeName(options.name, 'Template name');
+    const base = (0, scaffold_tool_js_1.scaffoldTemplate)({
+        name: options.name,
+        title: options.title,
+        author: options.author,
+    });
+    const files = { ...base.files };
+    files['manifest.php'] = files['manifest.php'].replace("'has_options'                => true", "'has_options'                => false");
+    const inherits = (options.inherit ?? []).filter(Boolean);
+    if (inherits.length) {
+        for (const item of inherits)
+            assertSafeName(item, 'Inherited template name');
+        files['manifest.php'] = files['manifest.php'].replace('return [', `return [\n    'inherit' => [${inherits.map(item => `'${item}'`).join(', ')}],`);
+    }
+    files['js/main.js'] =
+        `(() => {\n    'use strict';\n    document.documentElement.classList.add('js');\n})();\n`;
+    files['widgets/wrapper.tpl.php'] =
+        `<section class="widget<?= !empty($widget->css_class) ? ' ' . html($widget->css_class) : '' ?>">\n    <?php if (!empty($widget->title)): ?>\n        <h2 class="widget-title"><?= html($widget->title) ?></h2>\n    <?php endif ?>\n    <div class="widget-body"><?= $widget->body ?></div>\n</section>\n`;
+    files['main.tpl.php'] = files['main.tpl.php'].replace("<?= $this->linkCSS('css/main.css') ?>", "<?= $this->linkCSS('css/main.css') ?>\n    <?= $this->linkJS('js/main.js') ?>");
+    const layout = options.with_layout_scheme === false
+        ? null
+        : (0, layout_tool_js_1.scaffoldLayoutScheme)({
+            template: options.name,
+            rows: [
+                {
+                    title: 'Header',
+                    outer_tag: 'header',
+                    cols: [{ title: 'Header', position: 'header', col_class: 'col-12' }],
+                },
+                {
+                    title: 'Content',
+                    tag: 'main',
+                    cols: [
+                        { title: 'Main', position: 'content', col_class: 'col-lg-8' },
+                        { title: 'Sidebar', position: 'right-top', col_class: 'col-lg-4' },
+                    ],
+                },
+                {
+                    title: 'Footer',
+                    outer_tag: 'footer',
+                    cols: [{ title: 'Footer', position: 'footer', col_class: 'col-12' }],
+                },
+            ],
+        });
+    return {
+        ...base,
+        files,
+        layout_scheme: layout,
+        checklist: [
+            `Install files into /templates/${options.name}/.`,
+            'Import layout_scheme.yaml through the template layout administration UI if required.',
+            'Run analyze_instantcms_template and validate_layout_scheme before packaging.',
+        ],
+    };
+}
+function analyzeInstantCmsTemplate(filesInput, theme) {
+    const normalized = normalizeFiles(filesInput);
+    if (theme)
+        assertSafeName(theme, 'Theme name');
+    const discovered = [
+        ...new Set(Object.keys(normalized).flatMap(path => path.match(/(?:^|\/)templates\/([^/]+)\/manifest\.php$/)?.[1] ?? [])),
+    ];
+    const selectedTheme = theme ?? (discovered.length === 1 ? discovered[0] : null);
+    const prefix = selectedTheme ? `templates/${selectedTheme}/` : '';
+    const files = prefix
+        ? Object.fromEntries(Object.entries(normalized)
+            .filter(([path]) => path.startsWith(prefix))
+            .map(([path, content]) => [path.slice(prefix.length), content]))
+        : normalized;
+    const paths = Object.keys(files);
+    const diagnostics = [];
+    if (!theme && discovered.length > 1) {
+        diagnostics.push({
+            code: 'MULTIPLE_TEMPLATES_FOUND',
+            severity: 'error',
+            path: 'templates/',
+            message: `Multiple templates found (${discovered.join(', ')}); select one with the theme parameter.`,
+        });
+    }
+    for (const required of ['manifest.php', 'main.tpl.php']) {
+        if (!(required in files))
+            diagnostics.push({
+                code: 'MISSING_TEMPLATE_FILE',
+                severity: 'error',
+                path: required,
+                message: `Required template file ${required} is missing.`,
+            });
+    }
+    if (files['manifest.json'])
+        diagnostics.push({
+            code: 'INVALID_TEMPLATE_MANIFEST',
+            severity: 'error',
+            path: 'manifest.json',
+            message: 'InstantCMS templates use manifest.php, not manifest.json.',
+        });
+    if (files['main.tpl.php'] && !files['main.tpl.php'].includes('$this->body()'))
+        diagnostics.push({
+            code: 'MISSING_TEMPLATE_BODY',
+            severity: 'error',
+            path: 'main.tpl.php',
+            message: 'Main template does not render $this->body().',
+        });
+    const phpTemplates = paths.filter(path => path.endsWith('.tpl.php'));
+    for (const path of phpTemplates) {
+        const content = files[path];
+        if (/echo\s+\$(?!this\b)[a-z_][a-z0-9_]*(?:\[[^\]]+\])?\s*;/i.test(content))
+            diagnostics.push({
+                code: 'POSSIBLE_UNESCAPED_TEMPLATE_OUTPUT',
+                severity: 'warning',
+                path,
+                message: 'Variable output may require context-aware escaping.',
+            });
+    }
+    const positions = [
+        ...new Set(Object.values(files).flatMap(content => [...content.matchAll(/(?:widgets|hasWidgetsOn)\(\s*['"]([^'"]+)['"]/g)].map(match => match[1]))),
+    ].sort();
+    const overrides = paths.filter(path => /^controllers\/[^/]+\/(?:backend\/)?[^/]+\.tpl\.php$/.test(path));
+    const layoutFiles = paths.filter(path => /(?:^|\/)layout[^/]*\.(?:ya?ml)$/i.test(path));
+    return {
+        theme: selectedTheme,
+        discovered_themes: discovered,
+        is_valid: !diagnostics.some(item => item.severity === 'error'),
+        summary: {
+            files: paths.length,
+            php_templates: phpTemplates.length,
+            overrides: overrides.length,
+            positions: positions.length,
+            layouts: layoutFiles.length,
+        },
+        widget_positions: positions,
+        overrides,
+        layout_files: layoutFiles,
+        diagnostics,
+    };
+}
+function scaffoldTemplateOverride(options) {
+    assertSafeName(options.theme, 'Theme name');
+    const source = options.source_path.replace(/\\/g, '/').replace(/^\.\//, '');
+    const match = source.match(/(?:^|\/)(?:templates\/[^/]+\/)?controllers\/([^/]+)\/(backend\/)?([^/]+\.tpl\.php)$/);
+    const controller = options.controller ?? match?.[1];
+    const actionFile = options.action ? `${options.action}.tpl.php` : match?.[3];
+    const backend = options.backend ?? Boolean(match?.[2]);
+    if (!controller || !actionFile)
+        throw new Error('Controller and action could not be derived from source_path');
+    assertSafeName(controller, 'Controller name');
+    if (!/^[a-z][a-z0-9_]{0,63}\.tpl\.php$/.test(actionFile))
+        throw new Error('Invalid template action');
+    const relative = `controllers/${controller}/${backend ? 'backend/' : ''}${actionFile}`;
+    return {
+        theme: options.theme,
+        source_path: source,
+        target_path: `templates/${options.theme}/${relative}`,
+        files: { [relative]: options.source_content },
+        review_notes: [
+            'Keep the override as small as possible.',
+            'Record the upstream InstantCMS version or commit used as the source.',
+            'Recheck this override when the upstream source template changes.',
+        ],
+    };
+}
+function collectLayoutPositions(value, positions) {
+    if (Array.isArray(value))
+        return value.forEach(item => collectLayoutPositions(item, positions));
+    if (!value || typeof value !== 'object')
+        return;
+    for (const [key, child] of Object.entries(value)) {
+        if (key === 'position' && typeof child === 'string')
+            positions.push(child);
+        collectLayoutPositions(child, positions);
+    }
+}
+function validateLayoutScheme(yaml) {
+    const diagnostics = [];
+    let document;
+    try {
+        document = (0, yaml_1.parse)(yaml);
+    }
+    catch (error) {
+        return {
+            is_valid: false,
+            positions: [],
+            diagnostics: [
+                {
+                    code: 'INVALID_LAYOUT_YAML',
+                    severity: 'error',
+                    message: error instanceof Error ? error.message : 'Invalid YAML',
+                },
+            ],
+        };
+    }
+    if (!document || typeof document !== 'object' || !('layout' in document))
+        diagnostics.push({
+            code: 'MISSING_LAYOUT_ROOT',
+            severity: 'error',
+            message: 'Layout YAML must contain a layout root.',
+        });
+    const positions = [];
+    collectLayoutPositions(document, positions);
+    const duplicates = [
+        ...new Set(positions.filter((item, index) => positions.indexOf(item) !== index)),
+    ];
+    if (duplicates.length)
+        diagnostics.push({
+            code: 'DUPLICATE_LAYOUT_POSITION',
+            severity: 'warning',
+            message: `Duplicate positions: ${duplicates.join(', ')}`,
+        });
+    if (!positions.length)
+        diagnostics.push({
+            code: 'MISSING_LAYOUT_POSITIONS',
+            severity: 'warning',
+            message: 'No widget positions were found.',
+        });
+    return {
+        is_valid: !diagnostics.some(item => item.severity === 'error'),
+        positions: [...new Set(positions)],
+        diagnostics,
+    };
+}
+function checkTemplateOverrideCompatibility(themeFilesInput, upstreamBeforeInput, upstreamAfterInput) {
+    const themeFiles = normalizeFiles(themeFilesInput);
+    const before = normalizeFiles(upstreamBeforeInput);
+    const after = normalizeFiles(upstreamAfterInput);
+    const overrides = Object.keys(themeFiles).filter(path => /^controllers\/[^/]+\/(?:backend\/)?[^/]+\.tpl\.php$/.test(path));
+    const findSource = (files, override) => Object.keys(files).find(path => path === override || path.endsWith(`/${override}`));
+    const results = overrides.map(path => {
+        const beforePath = findSource(before, path);
+        const afterPath = findSource(after, path);
+        const status = !afterPath
+            ? 'missing_upstream'
+            : !beforePath
+                ? 'untracked'
+                : before[beforePath] !== after[afterPath]
+                    ? 'upstream_changed'
+                    : 'compatible';
+        return {
+            path,
+            status,
+            upstream_before: beforePath ?? null,
+            upstream_after: afterPath ?? null,
+            requires_review: status !== 'compatible',
+        };
+    });
+    return {
+        overrides_checked: overrides.length,
+        requires_review: results.filter(item => item.requires_review).length,
+        results,
+    };
+}

package/dist/tools/template-overrides-tool.js

@@ -0,0 +1,294 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listTemplateOverrides = listTemplateOverrides;
+exports.getTemplateOverrideInfo = getTemplateOverrideInfo;
+function listTemplateOverrides(controller) {
+    const templateOverrides = getTemplateOverrides();
+    let filtered = templateOverrides;
+    if (controller) {
+        const controllerLower = controller.toLowerCase();
+        filtered = templateOverrides.filter(t => t.controller.toLowerCase() === controllerLower);
+    }
+    return {
+        total: filtered.length,
+        controller: controller || 'all',
+        overrides: filtered.map(t => ({
+            controller: t.controller,
+            action: t.action,
+            path: t.path,
+            description: t.description,
+            category: t.category,
+        })),
+    };
+}
+function getTemplateOverrideInfo(controller, action) {
+    const templateOverrides = getTemplateOverrides();
+    const controllerLower = controller.toLowerCase();
+    const found = templateOverrides.find(t => t.controller.toLowerCase() === controllerLower &&
+        (action ? t.action?.toLowerCase() === action.toLowerCase() : !t.action));
+    if (!found) {
+        return {
+            error: `Override not found for controller "${controller}"${action ? ` and action "${action}"` : ''}`,
+            available: templateOverrides
+                .filter(t => t.controller.toLowerCase() === controllerLower)
+                .map(t => ({
+                action: t.action || 'index',
+                path: t.path,
+            })),
+        };
+    }
+    return {
+        controller: found.controller,
+        action: found.action,
+        path: found.path,
+        description: found.description,
+        category: found.category,
+        example: `<?php
+// В вашем шаблоне: templates/{theme}/controllers/${found.controller}/${found.action || 'index'}.tpl.php
+// Или через renderPartial:
+echo $this->renderPartial('${found.controller}', '${found.action || 'index'}', $vars);
+`,
+    };
+}
+function getTemplateOverrides() {
+    return [
+        {
+            controller: 'content',
+            action: 'index',
+            path: 'templates/default/controllers/content/index.tpl.php',
+            description: 'Страница списка контента',
+            category: 'content',
+        },
+        {
+            controller: 'content',
+            action: 'view',
+            path: 'templates/default/controllers/content/view.tpl.php',
+            description: 'Страница просмотра материала',
+            category: 'content',
+        },
+        {
+            controller: 'content',
+            action: 'item',
+            path: 'templates/default/controllers/content/item.tpl.php',
+            description: 'Карточка материала в списке',
+            category: 'content',
+        },
+        {
+            controller: 'content',
+            action: 'category',
+            path: 'templates/default/controllers/content/category.tpl.php',
+            description: 'Страница категории',
+            category: 'content',
+        },
+        {
+            controller: 'users',
+            action: 'index',
+            path: 'templates/default/controllers/users/index.tpl.php',
+            description: 'Профили пользователей',
+            category: 'users',
+        },
+        {
+            controller: 'users',
+            action: 'profile',
+            path: 'templates/default/controllers/users/profile.tpl.php',
+            description: 'Страница профиля пользователя',
+            category: 'users',
+        },
+        {
+            controller: 'users',
+            action: 'registration',
+            path: 'templates/default/controllers/users/registration.tpl.php',
+            description: 'Форма регистрации',
+            category: 'users',
+        },
+        {
+            controller: 'users',
+            action: 'auth',
+            path: 'templates/default/controllers/users/auth.tpl.php',
+            description: 'Форма авторизации',
+            category: 'users',
+        },
+        {
+            controller: 'comments',
+            action: 'index',
+            path: 'templates/default/controllers/comments/index.tpl.php',
+            description: 'Список комментариев',
+            category: 'comments',
+        },
+        {
+            controller: 'comments',
+            action: 'item',
+            path: 'templates/default/controllers/comments/item.tpl.php',
+            description: 'Один комментарий',
+            category: 'comments',
+        },
+        {
+            controller: 'photos',
+            action: 'index',
+            path: 'templates/default/controllers/photos/index.tpl.php',
+            description: 'Альбомы фотографий',
+            category: 'photos',
+        },
+        {
+            controller: 'photos',
+            action: 'album',
+            path: 'templates/default/controllers/photos/album.tpl.php',
+            description: 'Фотографии альбома',
+            category: 'photos',
+        },
+        {
+            controller: 'photos',
+            action: 'image',
+            path: 'templates/default/controllers/photos/image.tpl.php',
+            description: 'Просмотр одного фото',
+            category: 'photos',
+        },
+        {
+            controller: 'blogs',
+            action: 'index',
+            path: 'templates/default/controllers/blogs/index.tpl.php',
+            description: 'Список блогов',
+            category: 'blogs',
+        },
+        {
+            controller: 'blogs',
+            action: 'post',
+            path: 'templates/default/controllers/blogs/post.tpl.php',
+            description: 'Пост в блоге',
+            category: 'blogs',
+        },
+        {
+            controller: 'forums',
+            action: 'index',
+            path: 'templates/default/controllers/forums/index.tpl.php',
+            description: 'Список форумов',
+            category: 'forums',
+        },
+        {
+            controller: 'forums',
+            action: 'thread',
+            path: 'templates/default/controllers/forums/thread.tpl.php',
+            description: 'Тема форума',
+            category: 'forums',
+        },
+        {
+            controller: 'forums',
+            action: 'post',
+            path: 'templates/default/controllers/forums/post.tpl.php',
+            description: 'Пост на форуме',
+            category: 'forums',
+        },
+        {
+            controller: 'messages',
+            action: 'index',
+            path: 'templates/default/controllers/messages/index.tpl.php',
+            description: 'Личные сообщения',
+            category: 'messages',
+        },
+        {
+            controller: 'messages',
+            action: 'chat',
+            path: 'templates/default/controllers/messages/chat.tpl.php',
+            description: 'Чат сообщений',
+            category: 'messages',
+        },
+        {
+            controller: 'wall',
+            action: 'index',
+            path: 'templates/default/controllers/wall/index.tpl.php',
+            description: 'Записи на стене',
+            category: 'wall',
+        },
+        {
+            controller: 'wall',
+            action: 'entry',
+            path: 'templates/default/controllers/wall/entry.tpl.php',
+            description: 'Одна запись на стене',
+            category: 'wall',
+        },
+        {
+            controller: 'activity',
+            action: 'index',
+            path: 'templates/default/controllers/activity/index.tpl.php',
+            description: 'Лента активности',
+            category: 'activity',
+        },
+        {
+            controller: 'groups',
+            action: 'index',
+            path: 'templates/default/controllers/groups/index.tpl.php',
+            description: 'Список групп',
+            category: 'groups',
+        },
+        {
+            controller: 'groups',
+            action: 'view',
+            path: 'templates/default/controllers/groups/view.tpl.php',
+            description: 'Страница группы',
+            category: 'groups',
+        },
+        {
+            controller: 'board',
+            action: 'index',
+            path: 'templates/default/controllers/board/index.tpl.php',
+            description: 'Доска объявлений',
+            category: 'board',
+        },
+        {
+            controller: 'board',
+            action: 'item',
+            path: 'templates/default/controllers/board/item.tpl.php',
+            description: 'Объявление',
+            category: 'board',
+        },
+        {
+            controller: 'board',
+            action: 'add',
+            path: 'templates/default/controllers/board/add.tpl.php',
+            description: 'Форма добавления объявления',
+            category: 'board',
+        },
+        {
+            controller: 'catalog',
+            action: 'index',
+            path: 'templates/default/controllers/catalog/index.tpl.php',
+            description: 'Каталог товаров',
+            category: 'catalog',
+        },
+        {
+            controller: 'catalog',
+            action: 'item',
+            path: 'templates/default/controllers/catalog/item.tpl.php',
+            description: 'Страница товара',
+            category: 'catalog',
+        },
+        {
+            controller: 'search',
+            action: 'index',
+            path: 'templates/default/controllers/search/index.tpl.php',
+            description: 'Результаты поиска',
+            category: 'search',
+        },
+        {
+            controller: 'tags',
+            action: 'index',
+            path: 'templates/default/controllers/tags/index.tpl.php',
+            description: 'Страница тега',
+            category: 'tags',
+        },
+        {
+            controller: 'favorites',
+            action: 'index',
+            path: 'templates/default/controllers/favorites/index.tpl.php',
+            description: 'Избранное пользователя',
+            category: 'favorites',
+        },
+        {
+            controller: 'feed',
+            action: 'index',
+            path: 'templates/default/controllers/feed/index.tpl.php',
+            description: 'Лента контента',
+            category: 'feed',
+        },
+    ];
+}