@squiz/dxp-cli-next 5.33.0-develop.1 → 5.33.0-develop.11

package/lib/page/utils/parse-args.spec.js

@@ -1,284 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const parse_args_1 = require("./parse-args");
-describe('parseZonesList', () => {
-    it('returns empty object when given empty string', () => {
-        const result = (0, parse_args_1.parseZonesList)('', {});
-        expect(result).toEqual({});
-    });
-    it('parses single zone with equals separator', () => {
-        const result = (0, parse_args_1.parseZonesList)('main=./main.html', {});
-        expect(result).toEqual({
-            main: ['./main.html'],
-        });
-    });
-    it('parses single zone with colon separator', () => {
-        const result = (0, parse_args_1.parseZonesList)('main:./main.html', {});
-        expect(result).toEqual({
-            main: ['./main.html'],
-        });
-    });
-    it('parses comma-separated zones with equals separator', () => {
-        const result = (0, parse_args_1.parseZonesList)('header=./header.html,main=./main.html,footer=./footer.html', {});
-        expect(result).toEqual({
-            header: ['./header.html'],
-            main: ['./main.html'],
-            footer: ['./footer.html'],
-        });
-    });
-    it('parses comma-separated zones with colon separator', () => {
-        const result = (0, parse_args_1.parseZonesList)('header:./header.html,main:./main.html,footer:./footer.html', {});
-        expect(result).toEqual({
-            header: ['./header.html'],
-            main: ['./main.html'],
-            footer: ['./footer.html'],
-        });
-    });
-    it('accumulates multiple values for the same zone', () => {
-        const previous = { main: ['./main.0.html'] };
-        const result = (0, parse_args_1.parseZonesList)('main=./main.1.html', previous);
-        expect(result).toEqual({
-            main: ['./main.0.html', './main.1.html'],
-        });
-    });
-    it('accumulates values from multiple zone flags', () => {
-        let result = (0, parse_args_1.parseZonesList)('main=./main.html', {});
-        result = (0, parse_args_1.parseZonesList)('sidebar=./sidebar.html', result);
-        result = (0, parse_args_1.parseZonesList)('footer=./footer.html', result);
-        expect(result).toEqual({
-            main: ['./main.html'],
-            sidebar: ['./sidebar.html'],
-            footer: ['./footer.html'],
-        });
-    });
-    it('handles mixed syntax with equals and colons', () => {
-        const result = (0, parse_args_1.parseZonesList)('header=./header.html,main:./main.html', {});
-        expect(result).toEqual({
-            header: ['./header.html'],
-            main: ['./main.html'],
-        });
-    });
-    it('ignores malformed inputs', () => {
-        const result = (0, parse_args_1.parseZonesList)('malformed,main=,=./file.html', {});
-        expect(result).toEqual({});
-    });
-    it('handles complex example with multiple formats', () => {
-        let result = (0, parse_args_1.parseZonesList)('header:./header.html', {});
-        result = (0, parse_args_1.parseZonesList)('main:./main.0.html,main:./main.1.html', result);
-        result = (0, parse_args_1.parseZonesList)('sidebar=./sidebar.0.html', result);
-        expect(result).toEqual({
-            header: ['./header.html'],
-            main: ['./main.0.html', './main.1.html'],
-            sidebar: ['./sidebar.0.html'],
-        });
-    });
-});
-describe('parsePropertiesList', () => {
-    it('returns empty object when given empty string', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('', {});
-        expect(result).toEqual({});
-    });
-    it('parses single property with equals separator', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('theme=dark', {});
-        expect(result).toEqual({
-            theme: 'dark',
-        });
-    });
-    it('parses single property with colon separator', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('theme:dark', {});
-        expect(result).toEqual({
-            theme: 'dark',
-        });
-    });
-    it('parses comma-separated properties with equals separator', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('theme=dark,containerSize=standard,sidebarPosition=right', {});
-        expect(result).toEqual({
-            theme: 'dark',
-            containerSize: 'standard',
-            sidebarPosition: 'right',
-        });
-    });
-    it('parses comma-separated properties with colon separator', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('theme:dark,containerSize:standard,sidebarPosition:right', {});
-        expect(result).toEqual({
-            theme: 'dark',
-            containerSize: 'standard',
-            sidebarPosition: 'right',
-        });
-    });
-    it('later properties override earlier ones', () => {
-        let result = (0, parse_args_1.parsePropertiesList)('theme=light', {});
-        result = (0, parse_args_1.parsePropertiesList)('theme=dark', result);
-        expect(result).toEqual({
-            theme: 'dark',
-        });
-    });
-    it('accumulates values from multiple property flags', () => {
-        let result = (0, parse_args_1.parsePropertiesList)('theme=dark', {});
-        result = (0, parse_args_1.parsePropertiesList)('containerSize=standard', result);
-        result = (0, parse_args_1.parsePropertiesList)('sidebarPosition=right', result);
-        expect(result).toEqual({
-            theme: 'dark',
-            containerSize: 'standard',
-            sidebarPosition: 'right',
-        });
-    });
-    it('handles mixed syntax with equals and colons', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('theme=dark,containerSize:standard', {});
-        expect(result).toEqual({
-            theme: 'dark',
-            containerSize: 'standard',
-        });
-    });
-    it('ignores malformed inputs', () => {
-        const result = (0, parse_args_1.parsePropertiesList)('malformed,theme=,=dark', {});
-        expect(result).toEqual({});
-    });
-    it('handles complex example with multiple formats', () => {
-        let result = (0, parse_args_1.parsePropertiesList)('containerSize:standard', {});
-        result = (0, parse_args_1.parsePropertiesList)('sidebarPosition=right,colorTheme=dark', result);
-        expect(result).toEqual({
-            containerSize: 'standard',
-            sidebarPosition: 'right',
-            colorTheme: 'dark',
-        });
-    });
-});
-describe('normalizeLayoutProperties', () => {
-    it('returns empty object when given no properties', () => {
-        const result = (0, parse_args_1.normalizeLayoutProperties)({}, {});
-        expect(result).toEqual({});
-    });
-    it('returns properties unchanged when layoutDefinition has no properties', () => {
-        const properties = {
-            theme: 'dark',
-            size: 'large',
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, {});
-        expect(result).toEqual(properties);
-    });
-    it('converts string "true" to boolean true for boolean-type properties', () => {
-        const properties = {
-            showFooter: 'true',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: {
-                    type: 'boolean',
-                },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual({
-            showFooter: true,
-        });
-        expect(typeof result.showFooter).toBe('boolean');
-    });
-    it('converts string "false" to boolean false for boolean-type properties', () => {
-        const properties = {
-            showFooter: 'false',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: {
-                    type: 'boolean',
-                },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual({
-            showFooter: false,
-        });
-        expect(typeof result.showFooter).toBe('boolean');
-    });
-    it('leaves string properties unchanged for non-boolean types', () => {
-        const properties = {
-            theme: 'dark',
-            customTitle: 'My Title',
-        };
-        const layoutDefinition = {
-            properties: {
-                theme: {
-                    type: 'string',
-                },
-                customTitle: {
-                    type: 'string',
-                },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual(properties);
-    });
-    it('handles mixed boolean and string properties', () => {
-        const properties = {
-            showFooter: 'true',
-            showHeader: 'false',
-            theme: 'dark',
-            customTitle: 'Test',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: { type: 'boolean' },
-                showHeader: { type: 'boolean' },
-                theme: { type: 'string' },
-                customTitle: { type: 'string' },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual({
-            showFooter: true,
-            showHeader: false,
-            theme: 'dark',
-            customTitle: 'Test',
-        });
-    });
-    it('throws error for invalid boolean value', () => {
-        const properties = {
-            showFooter: 'yes',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: {
-                    type: 'boolean',
-                },
-            },
-        };
-        expect(() => (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition)).toThrow('Invalid boolean value "yes" for property "showFooter". Must be "true" or "false".');
-    });
-    it('only normalizes properties that exist in layoutDefinition', () => {
-        const properties = {
-            showFooter: 'true',
-            unknownProperty: 'true',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: {
-                    type: 'boolean',
-                },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual({
-            showFooter: true,
-            unknownProperty: 'true', // Left as string because not in layoutDefinition
-        });
-    });
-    it('preserves properties not present in layoutDefinition properties', () => {
-        const properties = {
-            showFooter: 'true',
-            theme: 'dark',
-        };
-        const layoutDefinition = {
-            properties: {
-                showFooter: {
-                    type: 'boolean',
-                },
-            },
-        };
-        const result = (0, parse_args_1.normalizeLayoutProperties)(properties, layoutDefinition);
-        expect(result).toEqual({
-            showFooter: true,
-            theme: 'dark', // Preserved even though not in layoutDefinition
-        });
-    });
-});

package/lib/page/utils/render.d.ts

@@ -1,51 +0,0 @@
-export interface LayoutDefinition {
-    name: string;
-    displayName?: string;
-    description?: string;
-    entry?: string;
-    template?: string;
-    zones: ZoneDefinition[];
-    properties?: Record<string, PropertyDefinition>;
-}
-export interface ExtendedLayoutDefinition extends LayoutDefinition {
-    template: string;
-}
-export interface ZoneDefinition {
-    key: string;
-    displayName: string;
-    description: string;
-}
-/**
- * Layout option value types.
- */
-export declare const LayoutOptionValueType: {
-    readonly stringEnum: "string-enum";
-    readonly boolean: "boolean";
-    readonly text: "text";
-};
-export declare type LayoutOptionValueType = typeof LayoutOptionValueType[keyof typeof LayoutOptionValueType];
-export declare const LayoutOptionValueTypes: readonly ["string-enum", "boolean", "text"];
-/**
- * Layout property types.
- */
-export declare const LayoutPropertyType: {
-    readonly string: "string";
-    readonly boolean: "boolean";
-};
-export declare type LayoutPropertyType = typeof LayoutPropertyType[keyof typeof LayoutPropertyType];
-export interface PropertyDefinition {
-    title: string;
-    description: string;
-    type: LayoutPropertyType;
-    enum?: string[] | boolean[];
-}
-/**
- * Renders a layout using Handlebars templating
- *
- * @param templateContent The Handlebars template string
- * @param zoneContents Content for each zone as single concatenated strings
- * @param layoutProperties Properties for the layout (can include boolean values for boolean-type properties)
- * @param layoutDefinition Optional layout definition object to pass to the template
- * @returns The rendered HTML
- */
-export declare function renderLayout(templateContent: string, zoneContents: Record<string, string>, layoutProperties: Record<string, string | boolean>, layoutDefinition?: ExtendedLayoutDefinition): Promise<string>;

package/lib/page/utils/render.js

@@ -1,112 +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 });
-exports.renderLayout = exports.LayoutPropertyType = exports.LayoutOptionValueTypes = exports.LayoutOptionValueType = void 0;
-const handlebars_1 = __importDefault(require("handlebars"));
-/**
- * Layout option value types.
- */
-exports.LayoutOptionValueType = {
-    stringEnum: 'string-enum',
-    boolean: 'boolean',
-    text: 'text',
-};
-exports.LayoutOptionValueTypes = [
-    exports.LayoutOptionValueType.stringEnum,
-    exports.LayoutOptionValueType.boolean,
-    exports.LayoutOptionValueType.text,
-];
-/**
- * Layout property types.
- */
-exports.LayoutPropertyType = {
-    string: 'string',
-    boolean: 'boolean',
-};
-/**
- * Registers global Handlebars helpers
- * TODO: Consider how these can be shared with page-contents-lib
- */
-function registerGlobalHelpers() {
-    handlebars_1.default.registerHelper('toLowerCase', function (text) {
-        return typeof text === 'string' ? text.toLowerCase() : '';
-    });
-    handlebars_1.default.registerHelper('toUpperCase', function (text) {
-        return typeof text === 'string' ? text.toUpperCase() : '';
-    });
-    handlebars_1.default.registerHelper('ifEq', function (first, second, options) {
-        if (first === second) {
-            return options.fn(this);
-        }
-        else {
-            return options.inverse(this);
-        }
-    });
-    handlebars_1.default.registerHelper('ifNotEq', function (first, second, options) {
-        if (first !== second) {
-            return options.fn(this);
-        }
-        else {
-            return options.inverse(this);
-        }
-    });
-    handlebars_1.default.registerHelper('stringify', function (object) {
-        return JSON.stringify(object);
-    });
-}
-/**
- * Renders a layout using Handlebars templating
- *
- * @param templateContent The Handlebars template string
- * @param zoneContents Content for each zone as single concatenated strings
- * @param layoutProperties Properties for the layout (can include boolean values for boolean-type properties)
- * @param layoutDefinition Optional layout definition object to pass to the template
- * @returns The rendered HTML
- */
-function renderLayout(templateContent, zoneContents, layoutProperties, layoutDefinition) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            registerGlobalHelpers();
-            const template = handlebars_1.default.compile(templateContent);
-            const zones = {};
-            for (const [zoneName, content] of Object.entries(zoneContents)) {
-                // Wrap the content in SafeString to prevent HTML escaping
-                zones[zoneName] = new handlebars_1.default.SafeString(content);
-            }
-            const flattenedProperties = {};
-            for (const [key, value] of Object.entries(layoutProperties)) {
-                const propertyValue = value;
-                if (propertyValue &&
-                    typeof propertyValue === 'object' &&
-                    'selectedValue' in propertyValue) {
-                    flattenedProperties[key] = propertyValue.selectedValue;
-                }
-                else {
-                    flattenedProperties[key] = propertyValue;
-                }
-            }
-            return template({
-                zones: zones,
-                // Still provide options for existing templates that use it
-                options: flattenedProperties,
-                properties: flattenedProperties,
-                layout: layoutDefinition,
-            });
-        }
-        catch (error) {
-            return `<div class="error">Error rendering template: ${error.message}</div>`;
-        }
-    });
-}
-exports.renderLayout = renderLayout;

package/lib/page/utils/render.spec.d.ts

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

package/lib/page/utils/render.spec.js

@@ -1,134 +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 });
-const render_1 = require("./render");
-const handlebars_1 = __importDefault(require("handlebars"));
-describe('renderLayout', () => {
-    beforeEach(() => {
-        jest.resetAllMocks();
-    });
-    it('should render a simple template with zone content', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '<div class="container">{{zones.main}}</div>';
-        const zoneContents = {
-            main: '<p>Content 1</p><p>Content 2</p>',
-        };
-        const layoutProperties = {};
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, layoutProperties);
-        expect(result).toContain('<div class="container">');
-        expect(result).toContain('<p>Content 1</p>');
-        expect(result).toContain('<p>Content 2</p>');
-    }));
-    it('should apply layout properties to the template (with deprecated options support)', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '<div class="container {{options.size}}">{{zones.main}}</div>';
-        const zoneContents = {
-            main: '<p>Content</p>',
-        };
-        const layoutProperties = {
-            size: 'large',
-        };
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, layoutProperties);
-        expect(result).toContain('<div class="container large">');
-        expect(result).toContain('<p>Content</p>');
-    }));
-    it('should handle multiple zones', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = `
-      <div class="container">
-        <div class="main">{{zones.main}}</div>
-        <div class="sidebar">{{zones.sidebar}}</div>
-      </div>
-    `;
-        const zoneContents = {
-            main: '<p>Main Content</p>',
-            sidebar: '<div>Sidebar Item 1</div><div>Sidebar Item 2</div>',
-        };
-        const layoutProperties = {};
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, layoutProperties);
-        expect(result).toContain('<div class="main"><p>Main Content</p></div>');
-        expect(result).toContain('<div class="sidebar"><div>Sidebar Item 1</div><div>Sidebar Item 2</div></div>');
-    }));
-    it('should handle complex option values with selectedValue property', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = `
-      <div class="theme-{{options.theme}}">
-        <div class="main">{{zones.main}}</div>
-        <div class="sidebar">{{zones.sidebar}}</div>
-      </div>
-    `;
-        const zoneContents = {
-            main: '<p>Content</p>',
-        };
-        const layoutProperties = {
-            theme: 'dark',
-        };
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, layoutProperties);
-        expect(result).toContain('<div class="theme-dark">');
-    }));
-    it('should use SafeString to prevent HTML escaping', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '<div>{{zones.content}}</div>';
-        const zoneContents = {
-            content: '<strong>Bold Text</strong>',
-        };
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, {});
-        expect(result).toContain('<strong>Bold Text</strong>');
-    }));
-    it('should handle empty zone content gracefully', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '<div>{{zones.main}}</div>';
-        const zoneContents = {
-            main: '',
-        };
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, {});
-        expect(result).toEqual('<div></div>');
-    }));
-    it('should include layout definition in template data when provided', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '<div class="{{layout.name}}">{{zones.main}}</div>';
-        const zoneContents = {
-            main: '<p>Content</p>',
-        };
-        const layoutDefinition = {
-            name: 'test-layout',
-            displayName: 'Test Layout',
-            template: templateContent,
-            zones: [
-                {
-                    key: 'main',
-                    displayName: 'Main Content',
-                    description: 'Main content area',
-                },
-            ],
-        };
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, {}, layoutDefinition);
-        expect(result).toContain('<div class="test-layout">');
-    }));
-    it('should handle rendering errors gracefully', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '{{#invalid}}Invalid Handlebars Syntax{{/invalid}}';
-        const zoneContents = { main: '<p>Content</p>' };
-        handlebars_1.default.compile = jest.fn().mockImplementation(() => {
-            throw new Error('Handlebars compilation error');
-        });
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, {});
-        expect(result).toContain('<div class="error">');
-        expect(result).toContain('Handlebars compilation error');
-    }));
-    it('should handle compilation errors during template execution', () => __awaiter(void 0, void 0, void 0, function* () {
-        const templateContent = '{{invalidHelper}}';
-        const zoneContents = { main: '<p>Content</p>' };
-        handlebars_1.default.compile = jest.fn().mockImplementation(() => {
-            return () => {
-                throw new Error('Template execution error');
-            };
-        });
-        const result = yield (0, render_1.renderLayout)(templateContent, zoneContents, {});
-        expect(result).toContain('<div class="error">');
-        expect(result).toContain('Template execution error');
-    }));
-});

package/lib/page/utils/server.d.ts

@@ -1,12 +0,0 @@
-import { ExtendedLayoutDefinition } from './render';
-interface DevServerOptions {
-    configPath: string;
-    layoutDefinition: ExtendedLayoutDefinition;
-    zoneContent: Record<string, string[]>;
-    layoutProperties: Record<string, string | boolean>;
-    stylesheet?: string;
-    port: number;
-    openBrowser: boolean;
-}
-export declare function startDevServer(options: DevServerOptions): Promise<void>;
-export {};