@squiz/dxp-cli-next 5.33.0-develop.5 → 5.33.0-develop.7

package/lib/page/layouts/dev/dev.spec.js

@@ -1,271 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-jest.mock('../../utils/definitions');
-jest.mock('../../utils/server');
-jest.mock('@squiz/dx-logger-lib', () => ({
-    getLogger: () => {
-        return {
-            info: mockLoggerInfoFn,
-            error: mockLoggerErrorFn,
-            warn: jest.fn(),
-        };
-    },
-}));
-const mockLoggerInfoFn = jest.fn();
-const mockLoggerErrorFn = jest.fn();
-const dev_1 = __importDefault(require("./dev"));
-const definitions_1 = require("../../utils/definitions");
-const server_1 = require("../../utils/server");
-const path_1 = __importDefault(require("path"));
-const originalProcessArgv = process.argv;
-function createMockArgs(opts) {
-    const args = ['node', 'dxp-cli', 'dev'];
-    if (opts.config)
-        args.push('--config', opts.config);
-    if (opts.port)
-        args.push('--port', opts.port.toString());
-    if (opts.open === false)
-        args.push('--no-open');
-    if (opts.stylesheet)
-        args.push('--stylesheet', opts.stylesheet);
-    if (opts.zoneContent) {
-        Object.entries(opts.zoneContent).forEach(([zoneName, filePaths]) => {
-            filePaths.forEach(filePath => {
-                args.push(`--zones=${zoneName}=${filePath}`);
-            });
-        });
-    }
-    if (opts.layoutProperties) {
-        Object.entries(opts.layoutProperties).forEach(([propertyName, value]) => {
-            args.push(`--properties=${propertyName}=${value}`);
-        });
-    }
-    return args;
-}
-describe('devCommand', () => {
-    beforeEach(() => {
-        jest.clearAllMocks();
-        process.argv = originalProcessArgv;
-    });
-    it('correctly handles command option defaults', () => __awaiter(void 0, void 0, void 0, function* () {
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({});
-        process.argv = args;
-        yield program.parseAsync(args);
-        const opts = program.opts();
-        expect(opts.config).toEqual(`./${definitions_1.LAYOUT_MANIFEST_FILE}`);
-        expect(opts.port).toEqual('4040');
-        expect(opts.open).toEqual(true);
-        expect(opts.stylesheet).toBeUndefined();
-    }));
-    it('correctly handles command arguments', () => __awaiter(void 0, void 0, void 0, function* () {
-        const config = './src/__tests__/layout.yaml';
-        const port = '3000';
-        const open = false;
-        const stylesheet = './src/__tests__/styles.css';
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({
-            config,
-            port,
-            open,
-            stylesheet,
-        });
-        process.argv = args;
-        yield program.parseAsync(args);
-        const opts = program.opts();
-        expect(opts.config).toEqual(config);
-        expect(opts.port).toEqual(port);
-        expect(opts.open).toEqual(open);
-        expect(opts.stylesheet).toEqual(stylesheet);
-    }));
-    it('loads the layout definition and starts the server', () => __awaiter(void 0, void 0, void 0, function* () {
-        const config = './src/__tests__/layout.yaml';
-        const mockLayout = { name: 'Test Layout' };
-        definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ config });
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(definitions_1.loadLayoutDefinition).toHaveBeenCalledWith(config);
-        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(1, `Loading layout definition from ${config}`);
-        expect(mockLoggerInfoFn).toHaveBeenNthCalledWith(2, 'Starting development server...');
-        expect(server_1.startDevServer).toHaveBeenCalledWith(expect.objectContaining({
-            configPath: path_1.default.resolve(config),
-            layoutDefinition: mockLayout,
-        }));
-    }));
-    it('parses and passes zone content to the server', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockLayout = { name: 'Test Layout' };
-        definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-        const zoneContent = {
-            main: ['./example.main.0.html', './example.main.1.html'],
-            aside: ['./example.aside.html'],
-        };
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ zoneContent });
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(server_1.startDevServer).toHaveBeenCalledWith(expect.objectContaining({
-            zoneContent,
-        }));
-    }));
-    it('parses and passes layout properties to the server', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockLayout = { name: 'Test Layout' };
-        definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-        const layoutProperties = {
-            sizing: 'large',
-            theme: 'dark',
-        };
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ layoutProperties });
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(server_1.startDevServer).toHaveBeenCalledWith(expect.objectContaining({
-            layoutProperties,
-        }));
-    }));
-    it('normalizes boolean properties from strings to actual booleans', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockLayout = {
-            name: 'Test Layout',
-            properties: {
-                showFooter: { type: 'boolean' },
-                showHeader: { type: 'boolean' },
-                theme: { type: 'string' },
-            },
-        };
-        definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-        const layoutProperties = {
-            showFooter: 'true',
-            showHeader: 'false',
-            theme: 'dark',
-        };
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ layoutProperties });
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(server_1.startDevServer).toHaveBeenCalledWith(expect.objectContaining({
-            layoutProperties: {
-                showFooter: true,
-                showHeader: false,
-                theme: 'dark', // Remains string
-            },
-        }));
-    }));
-    it('handles failure to load layout definition', () => __awaiter(void 0, void 0, void 0, function* () {
-        const config = './src/__tests__/layout.yaml';
-        definitions_1.loadLayoutDefinition.mockResolvedValue(undefined);
-        const originalError = mockLoggerErrorFn;
-        mockLoggerErrorFn.mockClear();
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ config });
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(mockLoggerErrorFn).toHaveBeenCalledWith(expect.stringContaining(`Failed to load layout definition from ${config}`));
-    }));
-    it('handles server startup error', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockLayout = { name: 'Test Layout' };
-        definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-        server_1.startDevServer.mockRejectedValue(new Error('Server start failed'));
-        const originalError = mockLoggerErrorFn;
-        mockLoggerErrorFn.mockClear();
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({});
-        process.argv = args;
-        yield program.parseAsync(args);
-        expect(mockLoggerErrorFn).toHaveBeenCalledWith(expect.stringContaining('Server start failed'));
-    }));
-    it('should not allow unknown options (e.g. --options instead of --properties)', () => __awaiter(void 0, void 0, void 0, function* () {
-        const config = './src/__tests__/layout.yaml';
-        const program = (0, dev_1.default)();
-        const args = createMockArgs({ config });
-        args.push('--options=backgroundColor=red');
-        process.argv = args;
-        const errorSpy = jest.spyOn(program, 'error').mockImplementation();
-        yield program.parseAsync(args);
-        expect(errorSpy).toHaveBeenCalledWith("error: unknown option '--options=backgroundColor=red'", { code: 'commander.unknownOption' });
-    }));
-    describe('zone consistency validation', () => {
-        it('should handle zone consistency validation errors where zones are used but not defined in the layout', () => __awaiter(void 0, void 0, void 0, function* () {
-            const config = './src/__tests__/layout.yaml';
-            // Mock layout with zones that don't match the template
-            const mockLayout = {
-                name: 'test-layout',
-                zones: [
-                    {
-                        key: 'col1',
-                        displayName: 'Column 1',
-                        description: 'The first column',
-                    },
-                ],
-                template: '{{zones.col1}} {{zones.col2}}', // col2 is used but not defined in zones
-            };
-            definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-            const program = (0, dev_1.default)();
-            const args = createMockArgs({ config });
-            process.argv = args;
-            yield program.parseAsync(args);
-            expect(mockLoggerErrorFn).toHaveBeenCalledWith(expect.stringMatching(/Zone consistency validation failed[\s\S]*Zones used in template but not defined in layout definition: col2/));
-        }));
-        it('should handle zone consistency validation errors where zones are defined but not used in the template', () => __awaiter(void 0, void 0, void 0, function* () {
-            const config = './src/__tests__/layout.yaml';
-            const mockLayout = {
-                name: 'test-layout',
-                zones: [
-                    {
-                        key: 'col1',
-                        displayName: 'Column 1',
-                        description: 'The first column',
-                    },
-                    {
-                        key: 'col2',
-                        displayName: 'Column 2',
-                        description: 'The second column',
-                    }, // col2 is defined but not used in the template
-                ],
-                template: '{{zones.col1}}',
-            };
-            definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-            const program = (0, dev_1.default)();
-            const args = createMockArgs({ config });
-            process.argv = args;
-            yield program.parseAsync(args);
-            expect(mockLoggerErrorFn).toHaveBeenCalledWith(expect.stringMatching(/Zone consistency validation failed[\s\S]*Zones defined in layout definition but not used in template: col2/));
-        }));
-    });
-    describe('property consistency validation', () => {
-        it('should handle property consistency validation errors where properties are used but not defined in the layout', () => __awaiter(void 0, void 0, void 0, function* () {
-            const config = './src/__tests__/manifest.json';
-            // Mock layout with properties that don't match the template
-            const mockLayout = {
-                name: 'test-layout',
-                zones: [],
-                properties: {
-                    title: {
-                        type: 'string',
-                        title: 'Title',
-                        description: 'Page title',
-                    },
-                },
-                template: '{{properties.title}} {{properties.undefined}}', // undefined is used but not defined in properties
-            };
-            definitions_1.loadLayoutDefinition.mockResolvedValue(mockLayout);
-            const program = (0, dev_1.default)();
-            const args = createMockArgs({ config });
-            process.argv = args;
-            yield program.parseAsync(args);
-            expect(mockLoggerErrorFn).toHaveBeenCalledWith(expect.stringMatching(/Property consistency validation failed[\s\S]*Properties used in template but not defined in layout definition: undefined/));
-        }));
-    });
-});

package/lib/page/layouts/layouts.d.ts

@@ -1,3 +0,0 @@
-import { Command } from 'commander';
-declare const createLayoutsCommand: () => Command;
-export default createLayoutsCommand;

package/lib/page/layouts/layouts.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const deploy_1 = __importDefault(require("./deploy/deploy"));
-const dev_1 = __importDefault(require("./dev/dev"));
-const createLayoutsCommand = () => {
-    const layoutsCommand = new commander_1.Command('layouts');
-    layoutsCommand
-        .description('Page Contents Layouts Commands')
-        .addCommand((0, deploy_1.default)())
-        .addCommand((0, dev_1.default)());
-    return layoutsCommand;
-};
-exports.default = createLayoutsCommand;

package/lib/page/layouts/layouts.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/page/layouts/layouts.spec.js

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const layouts_1 = __importDefault(require("./layouts"));
-const deploy_1 = __importDefault(require("./deploy/deploy"));
-const dev_1 = __importDefault(require("./dev/dev"));
-jest.mock('./deploy/deploy');
-deploy_1.default.mockImplementation(() => {
-    return new commander_1.Command('mock-deploy');
-});
-jest.mock('./dev/dev');
-dev_1.default.mockImplementation(() => {
-    return new commander_1.Command('mock-dev');
-});
-describe('createLayoutsCommand', () => {
-    it('should create a layouts command with deploy subcommand', () => {
-        const layoutsCommand = (0, layouts_1.default)();
-        expect(layoutsCommand).toBeInstanceOf(commander_1.Command);
-        expect(layoutsCommand.name()).toBe('layouts');
-        expect(layoutsCommand.description()).toBe('Page Contents Layouts Commands');
-        expect(deploy_1.default).toHaveBeenCalled();
-        expect(layoutsCommand.commands.map(cmd => cmd.name())).toContain('mock-deploy');
-        expect(dev_1.default).toHaveBeenCalled();
-        expect(layoutsCommand.commands.map(cmd => cmd.name())).toContain('mock-dev');
-    });
-});

package/lib/page/layouts/validation/index.d.ts

@@ -1,3 +0,0 @@
-export { validateLayoutFormat } from './validateLayoutFormat';
-export { validatePropertyConsistency } from './property-consistency';
-export { validateZoneConsistency } from './zone-consistency';

package/lib/page/layouts/validation/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateZoneConsistency = exports.validatePropertyConsistency = exports.validateLayoutFormat = void 0;
-var validateLayoutFormat_1 = require("./validateLayoutFormat");
-Object.defineProperty(exports, "validateLayoutFormat", { enumerable: true, get: function () { return validateLayoutFormat_1.validateLayoutFormat; } });
-var property_consistency_1 = require("./property-consistency");
-Object.defineProperty(exports, "validatePropertyConsistency", { enumerable: true, get: function () { return property_consistency_1.validatePropertyConsistency; } });
-var zone_consistency_1 = require("./zone-consistency");
-Object.defineProperty(exports, "validateZoneConsistency", { enumerable: true, get: function () { return zone_consistency_1.validateZoneConsistency; } });

package/lib/page/layouts/validation/property-consistency.d.ts

@@ -1,7 +0,0 @@
-import { LayoutDefinition } from '../../utils/definitions';
-/**
- * Validates that options/properties defined in layout definition match options/properties used in the Handlebars template
- * @param layout The layout definition containing options/properties and template
- * @returns Error message if validation fails, null if validation passes
- */
-export declare function validatePropertyConsistency(layout: LayoutDefinition, filePath: string): string | null;

package/lib/page/layouts/validation/property-consistency.js

@@ -1,92 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePropertyConsistency = void 0;
-const path = __importStar(require("node:path"));
-const definitions_1 = require("../../utils/definitions");
-/**
- * Validates that options/properties defined in layout definition match options/properties used in the Handlebars template
- * @param layout The layout definition containing options/properties and template
- * @returns Error message if validation fails, null if validation passes
- */
-function validatePropertyConsistency(layout, filePath) {
-    var _a;
-    const layoutProperties = (_a = layout.properties) !== null && _a !== void 0 ? _a : {};
-    const template = layout.template;
-    // If no template or properties are provided, skip validation
-    if (!template) {
-        return null;
-    }
-    const uniquePropertyKeys = new Set(Object.keys(layoutProperties));
-    if (uniquePropertyKeys.size !== Object.keys(layoutProperties).length) {
-        return 'Duplicate property keys found in layout definition';
-    }
-    // Extract property references from Handlebars template
-    // Look for patterns like {{properties.propertyName}}, {{#if properties.propertyName}} {{#ifEq 'value' properties.propertyName}}
-    const propertyPattern = /\{\{#*(?:[^\}]+\s)*properties\.(\w+)/g;
-    const optionPattern = /\{\{#*(?:[^\}]+\s)*options\.(\w+)/g;
-    // Keep track of properties/options used in the Handlebars template
-    const templateProperties = getTemplateMatches(template, propertyPattern);
-    const templateOptions = getTemplateMatches(template, optionPattern);
-    // Create an array of errors
-    const errors = [];
-    // Check that properties/options are being used correctly based on the layout definition file format
-    const fileName = path.basename(filePath);
-    const isNewFormat = fileName === definitions_1.LAYOUT_MANIFEST_FILE;
-    const templateSetToCheck = isNewFormat ? templateProperties : templateOptions;
-    // Check for incorrect option/property usage based on the layout definition file format
-    if (isNewFormat) {
-        if (templateOptions.size > 0) {
-            errors.push('Options are not supported in the Handlebars template for a layout defined with "manifest.json". Please use properties instead.');
-        }
-    }
-    else {
-        if (templateProperties.size > 0) {
-            errors.push('Properties are only allowed in the Handlebars template for a layout defined with "manifest.json". Please use options instead.');
-        }
-    }
-    // Find options/properties used in template but not defined in layout definition
-    const undefinedTemplateProperties = Array.from(templateSetToCheck).filter(property => !Object.keys(layoutProperties).includes(property));
-    // Add the undefined options/properties to the errors
-    if (undefinedTemplateProperties.length > 0) {
-        errors.push(`${isNewFormat ? 'Properties' : 'Options'} used in template but not defined in layout definition: ${undefinedTemplateProperties.join(', ')}`);
-    }
-    // If there are errors, return the errors
-    if (errors.length > 0) {
-        return `${isNewFormat ? 'Property' : 'Option'} consistency validation failed:\n${errors
-            .map(err => `  - ${err}`)
-            .join('\n')}`;
-    }
-    return null;
-}
-exports.validatePropertyConsistency = validatePropertyConsistency;
-function getTemplateMatches(template, pattern) {
-    const matches = new Set();
-    let match;
-    while ((match = pattern.exec(template)) !== null) {
-        matches.add(match[1]);
-    }
-    return matches;
-}

package/lib/page/layouts/validation/property-consistency.spec.d.ts

@@ -1 +0,0 @@
-export {};