@squiz/dxp-cli-next 5.32.0 → 5.33.0-develop.2

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

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const property_consistency_1 = require("./property-consistency");
 describe('validatePropertyConsistency', () => {
-    const createMockLayout = (layout) => (Object.assign({ name: 'test-layout', displayName: 'Test Layout', description: 'A test layout', zones: [], template: '' }, layout));
+    const createMockLayout = (layout) => (Object.assign({ name: 'test-layout', displayName: 'Test Layout', description: 'A test layout', zones: [
+            { key: 'main', displayName: 'Main Zone', description: 'Main zone' },
+        ], template: '' }, layout));
     describe('new format (manifest.json)', () => {
         it('should return null for valid property consistency', () => {
             const layout = createMockLayout({

package/lib/page/layouts/validation/zone-consistency.spec.js

@@ -80,11 +80,6 @@ describe('validateZoneConsistency', () => {
         const result = (0, zone_consistency_1.validateZoneConsistency)(layout);
         expect(result).toBeNull();
     });
-    it('should handle empty zones object', () => {
-        const layout = createMockLayout([], '<div>Static content only</div>');
-        const result = (0, zone_consistency_1.validateZoneConsistency)(layout);
-        expect(result).toBeNull();
-    });
     it('should handle undefined zones property', () => {
         const layout = {
             name: 'test-layout',

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

@@ -52,7 +52,7 @@ export declare const InputLayoutDefinitionV1: z.ZodObject<z.objectUtil.extendSha
      * Declares the content structure that will be the input to the
      * Handlebars template
      */
-    zones: z.ZodRecord<z.ZodString, z.ZodObject<{
+    zones: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
         minNodes: z.ZodDefault<z.ZodNumber>;
@@ -67,6 +67,16 @@ export declare const InputLayoutDefinitionV1: z.ZodObject<z.objectUtil.extendSha
         displayName: string;
         minNodes?: number | undefined;
         maxNodes?: number | undefined;
+    }>>, Record<string, {
+        description: string;
+        displayName: string;
+        minNodes: number;
+        maxNodes?: number | undefined;
+    }>, Record<string, {
+        description: string;
+        displayName: string;
+        minNodes?: number | undefined;
+        maxNodes?: number | undefined;
     }>>;
     /**
      * Layout options
@@ -160,7 +170,7 @@ export declare const InputLayoutDefinitionV2: z.ZodObject<z.objectUtil.extendSha
         key: string;
         description: string;
         displayName: string;
-    }>, "many">;
+    }>, "atleastone">;
     /**
      * Layout properties
      *
@@ -199,11 +209,15 @@ export declare const InputLayoutDefinitionV2: z.ZodObject<z.objectUtil.extendSha
     entry: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }, ...{
+        key: string;
+        description: string;
+        displayName: string;
+    }[]];
     properties?: Record<string, {
         type: "boolean";
         description: string;
@@ -219,11 +233,15 @@ export declare const InputLayoutDefinitionV2: z.ZodObject<z.objectUtil.extendSha
     entry: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
+        key: string;
+        description: string;
+        displayName: string;
+    }, ...{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }[]];
     properties?: Record<string, {
         type: "boolean";
         description: string;
@@ -258,7 +276,7 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
      * Declares the content structure that will be the input to the
      * Handlebars template
      */
-    zones: z.ZodRecord<z.ZodString, z.ZodObject<{
+    zones: z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
         minNodes: z.ZodDefault<z.ZodNumber>;
@@ -273,6 +291,16 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
         displayName: string;
         minNodes?: number | undefined;
         maxNodes?: number | undefined;
+    }>>, Record<string, {
+        description: string;
+        displayName: string;
+        minNodes: number;
+        maxNodes?: number | undefined;
+    }>, Record<string, {
+        description: string;
+        displayName: string;
+        minNodes?: number | undefined;
+        maxNodes?: number | undefined;
     }>>;
     /**
      * Layout options
@@ -362,7 +390,7 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
         key: string;
         description: string;
         displayName: string;
-    }>, "many">;
+    }>, "atleastone">;
     /**
      * Layout properties
      *
@@ -401,11 +429,15 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
     entry: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }, ...{
+        key: string;
+        description: string;
+        displayName: string;
+    }[]];
     properties?: Record<string, {
         type: "boolean";
         description: string;
@@ -421,11 +453,15 @@ export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil
     entry: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }, ...{
+        key: string;
+        description: string;
+        displayName: string;
+    }[]];
     properties?: Record<string, {
         type: "boolean";
         description: string;
@@ -470,7 +506,7 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<Omit
         key: string;
         description: string;
         displayName: string;
-    }>, "many">;
+    }>, "atleastone">;
     /**
      * Layout properties
      *
@@ -510,11 +546,15 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<Omit
     name: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
+        key: string;
+        description: string;
+        displayName: string;
+    }, ...{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }[]];
     template: string;
     properties?: Record<string, {
         type: "boolean";
@@ -530,11 +570,15 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<Omit
     name: string;
     description: string;
     displayName: string;
-    zones: {
+    zones: [{
+        key: string;
+        description: string;
+        displayName: string;
+    }, ...{
         key: string;
         description: string;
         displayName: string;
-    }[];
+    }[]];
     template: string;
     properties?: Record<string, {
         type: "boolean";

package/lib/page/utils/definitions.js

@@ -164,12 +164,16 @@ exports.InputLayoutDefinitionV1 = exports.BaseLayoutDefinition.extend({
      * Declares the content structure that will be the input to the
      * Handlebars template
      */
-    zones: zod_1.z.record(zod_1.z.string(), zod_1.z.object({
+    zones: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.object({
         displayName: zod_1.z.string(),
         description: zod_1.z.string(),
         minNodes: zod_1.z.number().min(0).default(0),
         maxNodes: zod_1.z.number().min(1).optional(),
-    })),
+    }))
+        .refine(data => Object.keys(data).length > 0, {
+        message: 'Must contain at least 1 zone',
+    }),
     /**
      * Layout options
      *
@@ -195,13 +199,15 @@ exports.InputLayoutDefinitionV2 = exports.BaseLayoutDefinition.extend({
      * Declares the content structure that will be the input to the
      * Handlebars template
      */
-    zones: zod_1.z.array(zod_1.z
+    zones: zod_1.z
+        .array(zod_1.z
         .object({
         key: zod_1.z.string(),
         displayName: zod_1.z.string(),
         description: zod_1.z.string(),
     })
-        .strict()),
+        .strict())
+        .nonempty(),
     /**
      * Layout properties
      *

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

@@ -457,6 +457,15 @@ entry: template.hbs
 });
 describe('LayoutDefinitionParse', () => {
     describe('V1 format - zones objects and options (deprecated)', () => {
+        it('should not allow empty zones object', () => {
+            expect(() => definitions_1.InputLayoutDefinitionV1.parse({
+                name: 'test-layout',
+                displayName: 'Test Layout',
+                description: 'A test layout',
+                entry: 'template.hbs',
+                zones: {},
+            })).toThrow();
+        });
         it('should allow zone.minNodes to be undefined', () => {
             const layoutDefinition = definitions_1.InputLayoutDefinitionV1.parse({
                 name: 'test-layout',
@@ -607,6 +616,15 @@ describe('LayoutDefinitionParse', () => {
         });
     });
     describe('V2 format - zones arrays and properties', () => {
+        it('should not allow empty zones array', () => {
+            expect(() => definitions_1.InputLayoutDefinitionV2.parse({
+                name: 'test-layout',
+                displayName: 'Test Layout',
+                description: 'A test layout',
+                entry: 'template.hbs',
+                zones: [],
+            })).toThrow();
+        });
         it('should not allow minNodes to be defined in a zone', () => {
             expect(() => definitions_1.InputLayoutDefinitionV2.parse({
                 name: 'test-layout',

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

@@ -48,16 +48,6 @@ describe('normalizeZones', () => {
             },
         ]);
     });
-    it('should handle empty zones object', () => {
-        const zones = {};
-        const result = (0, normalize_1.normalizeZones)(zones);
-        expect(result).toEqual([]);
-    });
-    it('should handle empty zones array', () => {
-        const zones = [];
-        const result = (0, normalize_1.normalizeZones)(zones);
-        expect(result).toEqual([]);
-    });
     it('should throw error when zones is null', () => {
         expect(() => (0, normalize_1.normalizeZones)(null)).toThrow('zones must be an object or array');
     });
@@ -79,7 +69,9 @@ describe('normalizeProperties', () => {
                 displayName: 'Test Layout',
                 description: 'A test layout',
                 entry: 'template.hbs',
-                zones: [],
+                zones: [
+                    { key: 'main', displayName: 'Main Zone', description: 'Main zone' },
+                ],
                 properties: {
                     title: {
                         type: 'string',
@@ -103,7 +95,9 @@ describe('normalizeProperties', () => {
                 displayName: 'Test Layout',
                 description: 'A test layout',
                 entry: 'template.hbs',
-                zones: [],
+                zones: [
+                    { key: 'main', displayName: 'Main Zone', description: 'Main zone' },
+                ],
             };
             const result = (0, normalize_1.normalizeProperties)(layout);
             expect(result).toBeUndefined();

package/package.json

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