@squiz/dxp-cli-next 5.31.0-develop.5 → 5.31.0-develop.6

package/lib/page/layouts/deploy/deploy.js

@@ -56,7 +56,7 @@ const createDeployCommand = () => {
         try {
             const layout = yield (0, definitions_1.loadLayoutDefinition)(layoutFile);
             if (layout !== undefined) {
-                // Pre-deployment validation: check zones match between YAML and template
+                // Pre-deployment validation: check zones match between manifest and template
                 const zoneValidationError = (0, validation_1.validateZoneConsistency)(layout);
                 if (zoneValidationError) {
                     throw new Error(zoneValidationError);

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

@@ -34,7 +34,7 @@ const createDevCommand = () => {
         .option('--stylesheet <path>', 'Path to CSS file to include')
         .option('--zones <items>', 'Zone content mappings', parse_args_1.parseZonesList, {})
         .option('--properties <items>', 'Layout properties', parse_args_1.parsePropertiesList, {})
-        .allowUnknownOption(true)
+        .allowUnknownOption(false)
         .allowExcessArguments(true)
         .action((options) => __awaiter(void 0, void 0, void 0, function* () {
         try {
@@ -45,6 +45,16 @@ const createDevCommand = () => {
                 throw new Error(`Failed to load layout definition from ${options.config}`);
             }
             (0, validation_1.validateLayoutFormat)(exports.logger, options.config);
+            // Check zones match between manifest and template
+            const zoneValidationError = (0, validation_1.validateZoneConsistency)(rawLayoutDefinition);
+            if (zoneValidationError) {
+                throw new Error(zoneValidationError);
+            }
+            // Validate Handlebars template only refers to properties if manifest.json is used
+            const propertyValidationError = (0, validation_1.validatePropertyConsistency)(rawLayoutDefinition, options.config);
+            if (propertyValidationError) {
+                throw new Error(propertyValidationError);
+            }
             // Confirm for entry property
             const layoutDefinition = Object.assign({}, rawLayoutDefinition);
             // Normalize properties to convert string booleans to actual booleans

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

@@ -186,4 +186,86 @@ describe('devCommand', () => {
         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/validation/validateLayoutFormat.js

@@ -11,7 +11,8 @@ function validateLayoutFormat(logger, layoutFile) {
     if (!layoutFile) {
         logger.warn(`⚠️  DEFAULT CONFIG FILE: "${definitions_1.LAYOUT_MANIFEST_FILE}" has replaced "page-layout.yaml" as the default config file. ` +
             `Please migrate to "${definitions_1.LAYOUT_MANIFEST_FILE}" using the new layout definition format. ` +
-            'Support for "page-layout.yaml" and any other file format will be removed in a future version. ');
+            `Support for files other than "${definitions_1.LAYOUT_MANIFEST_FILE}" will be removed in a future version. ` +
+            'For more information, visit https://docs.squiz.net/component-service/latest/layouts/layout-files.html');
         return;
     }
     // Warn that any file other than manifest.json is deprecated
@@ -19,7 +20,8 @@ function validateLayoutFormat(logger, layoutFile) {
     if (fileName !== definitions_1.LAYOUT_MANIFEST_FILE) {
         logger.warn(`⚠️  DEPRECATED: The file name "${fileName}" is deprecated. ` +
             `Please migrate to "${definitions_1.LAYOUT_MANIFEST_FILE}" using the new layout definition format. ` +
-            'Support for any other file format will be removed in a future version. ');
+            `Support for files other than "${definitions_1.LAYOUT_MANIFEST_FILE}" will be removed in a future version. ` +
+            'For more information, visit https://docs.squiz.net/component-service/latest/layouts/layout-files.html');
     }
 }
 exports.validateLayoutFormat = validateLayoutFormat;

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

@@ -23,7 +23,8 @@ describe('validateLayoutFormat', () => {
         expect(mockLogger.warn).toHaveBeenCalledTimes(1);
         expect(mockLogger.warn).toHaveBeenCalledWith('⚠️  DEPRECATED: The file name "page-layout.yaml" is deprecated. ' +
             `Please migrate to "${definitions_1.LAYOUT_MANIFEST_FILE}" using the new layout definition format. ` +
-            'Support for any other file format will be removed in a future version. ');
+            `Support for files other than "${definitions_1.LAYOUT_MANIFEST_FILE}" will be removed in a future version. ` +
+            'For more information, visit https://docs.squiz.net/component-service/latest/layouts/layout-files.html');
     });
     it('should extract filename correctly from full path', () => {
         const layoutFile = '/very/deep/nested/path/to/layout/page-layout.yaml';
@@ -35,6 +36,7 @@ describe('validateLayoutFormat', () => {
         expect(mockLogger.warn).toHaveBeenCalledTimes(1);
         expect(mockLogger.warn).toHaveBeenCalledWith('⚠️  DEFAULT CONFIG FILE: "manifest.json" has replaced "page-layout.yaml" as the default config file. ' +
             `Please migrate to "${definitions_1.LAYOUT_MANIFEST_FILE}" using the new layout definition format. ` +
-            'Support for "page-layout.yaml" and any other file format will be removed in a future version. ');
+            `Support for files other than "${definitions_1.LAYOUT_MANIFEST_FILE}" will be removed in a future version. ` +
+            'For more information, visit https://docs.squiz.net/component-service/latest/layouts/layout-files.html');
     });
 });

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

@@ -89,7 +89,7 @@ export declare const InputLayoutDefinitionV1: z.ZodObject<z.objectUtil.extendSha
         values?: string[] | undefined;
         valueType?: "boolean" | "text" | "string-enum" | undefined;
     }>>>;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     name: string;
     entry: string;
     description: string;
@@ -300,7 +300,7 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
         values?: string[] | undefined;
         valueType?: "boolean" | "text" | "string-enum" | undefined;
     }>>>;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     name: string;
     entry: string;
     description: string;

package/lib/page/utils/definitions.js

@@ -183,7 +183,7 @@ exports.InputLayoutDefinitionV1 = exports.BaseLayoutDefinition.extend({
         values: zod_1.z.array(zod_1.z.string()).optional(),
     }))
         .optional(),
-});
+}).strict();
 /**
  * Layout definition used for manifest.json files
  */

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

@@ -317,6 +317,40 @@ entry: template.hbs
 
         Schema validation failed:
           - Required at "name""
+      `);
+        }));
+        it('should throw an error if YAML contains properties (instead of options)', () => __awaiter(void 0, void 0, void 0, function* () {
+            const yamlContentWithProperties = `
+      name: test-layout
+      displayName: Test Layout
+      description: A test layout
+      zones:
+        main:
+          displayName: Main Zone
+          description: Main content area
+      properties:
+        color:
+          title: Color
+          description: Color options
+          type: string
+          enum: ['red', 'blue']
+      entry: template.hbs
+      `;
+            fs.readFile.mockImplementation((filePath) => {
+                if (filePath.endsWith('page-layout.yaml')) {
+                    return yamlContentWithProperties;
+                }
+                if (filePath.endsWith('template.hbs')) {
+                    return templateContent;
+                }
+                throw new Error('File not found');
+            });
+            yield expect((0, definitions_1.loadLayoutDefinition)(pageLayoutYaml)).rejects
+                .toThrowErrorMatchingInlineSnapshot(`
+        "Failed loading layout definition: Failed to parse ./some-dir/page-layout.yaml:
+
+        Schema validation failed:
+          - Unrecognized key(s) in object: 'properties'"
       `);
         }));
         it('should throw an error if YAML layout file has invalid YAML', () => __awaiter(void 0, void 0, void 0, function* () {
@@ -548,6 +582,28 @@ describe('LayoutDefinitionParse', () => {
                 expect((_g = layoutDefinition.options) === null || _g === void 0 ? void 0 : _g.withNeither.valueType).toBeUndefined();
                 expect((_h = layoutDefinition.options) === null || _h === void 0 ? void 0 : _h.withNeither.values).toBeUndefined();
             });
+            it('should reject properties (instead of options)', () => {
+                expect(() => definitions_1.InputLayoutDefinitionV1.parse({
+                    name: 'test-layout',
+                    displayName: 'Test Layout',
+                    description: 'A test layout',
+                    entry: 'template.hbs',
+                    zones: {
+                        main: {
+                            displayName: 'Main Zone',
+                            description: 'Main content area',
+                        },
+                    },
+                    properties: {
+                        color: {
+                            title: 'Color',
+                            description: 'Color options',
+                            type: 'string',
+                            enum: ['red', 'blue'],
+                        },
+                    },
+                })).toThrow();
+            });
         });
     });
     describe('V2 format - zones arrays and properties', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dxp-cli-next",
-  "version": "5.31.0-develop.5",
+  "version": "5.31.0-develop.6",
   "repository": {
     "url": "https://gitlab.squiz.net/dxp/dxp-cli-next"
   },