@squiz/dxp-cli-next 5.29.0 → 5.29.1-develop.1

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

@@ -41,7 +41,7 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
      *
      * Declares any configurable options that can be provided by a Content Editor
      */
-    options: z.ZodRecord<z.ZodString, z.ZodObject<{
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
         values: z.ZodArray<z.ZodString, "many">;
@@ -53,14 +53,9 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
         values: string[];
         description: string;
         displayName: string;
-    }>>;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    options: Record<string, {
-        values: string[];
-        description: string;
-        displayName: string;
-    }>;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -69,13 +64,13 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
         minNodes: number;
         maxNodes?: number | undefined;
     }>;
-}, {
-    name: string;
-    options: Record<string, {
+    options?: Record<string, {
         values: string[];
         description: string;
         displayName: string;
-    }>;
+    }> | undefined;
+}, {
+    name: string;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -84,6 +79,11 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
         minNodes: number;
         maxNodes?: number | undefined;
     }>;
+    options?: Record<string, {
+        values: string[];
+        description: string;
+        displayName: string;
+    }> | undefined;
 }>;
 export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
     /**
@@ -125,7 +125,7 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
      *
      * Declares any configurable options that can be provided by a Content Editor
      */
-    options: z.ZodRecord<z.ZodString, z.ZodObject<{
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
         values: z.ZodArray<z.ZodString, "many">;
@@ -137,16 +137,11 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
         values: string[];
         description: string;
         displayName: string;
-    }>>;
+    }>>>;
 }, {
     entry: z.ZodString;
 }>, "strip", z.ZodTypeAny, {
     name: string;
-    options: Record<string, {
-        values: string[];
-        description: string;
-        displayName: string;
-    }>;
     entry: string;
     description: string;
     displayName: string;
@@ -156,13 +151,13 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
         minNodes: number;
         maxNodes?: number | undefined;
     }>;
-}, {
-    name: string;
-    options: Record<string, {
+    options?: Record<string, {
         values: string[];
         description: string;
         displayName: string;
-    }>;
+    }> | undefined;
+}, {
+    name: string;
     entry: string;
     description: string;
     displayName: string;
@@ -172,6 +167,11 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
         minNodes: number;
         maxNodes?: number | undefined;
     }>;
+    options?: Record<string, {
+        values: string[];
+        description: string;
+        displayName: string;
+    }> | undefined;
 }>;
 export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
     /**
@@ -213,7 +213,7 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
      *
      * Declares any configurable options that can be provided by a Content Editor
      */
-    options: z.ZodRecord<z.ZodString, z.ZodObject<{
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
         values: z.ZodArray<z.ZodString, "many">;
@@ -225,16 +225,11 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
         values: string[];
         description: string;
         displayName: string;
-    }>>;
+    }>>>;
 }, {
     template: z.ZodString;
 }>, "strip", z.ZodTypeAny, {
     name: string;
-    options: Record<string, {
-        values: string[];
-        description: string;
-        displayName: string;
-    }>;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -244,13 +239,13 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
         maxNodes?: number | undefined;
     }>;
     template: string;
-}, {
-    name: string;
-    options: Record<string, {
+    options?: Record<string, {
         values: string[];
         description: string;
         displayName: string;
-    }>;
+    }> | undefined;
+}, {
+    name: string;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -260,6 +255,11 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
         maxNodes?: number | undefined;
     }>;
     template: string;
+    options?: Record<string, {
+        values: string[];
+        description: string;
+        displayName: string;
+    }> | undefined;
 }>;
 export declare type InputLayoutDefinition = z.infer<typeof InputLayoutDefinition>;
 export declare type LayoutDefinition = z.infer<typeof LayoutDefinition>;

package/lib/page/utils/definitions.js

@@ -125,11 +125,13 @@ exports.BaseLayoutDefinition = zod_1.z.object({
      *
      * Declares any configurable options that can be provided by a Content Editor
      */
-    options: zod_1.z.record(zod_1.z.string(), zod_1.z.object({
+    options: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.object({
         displayName: zod_1.z.string(),
         description: zod_1.z.string(),
         values: zod_1.z.array(zod_1.z.string()),
-    })),
+    }))
+        .optional(),
 });
 exports.InputLayoutDefinition = exports.BaseLayoutDefinition.extend({
     entry: zod_1.z.string(),

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

@@ -287,4 +287,136 @@ entry: template.hbs
         });
         yield expect((0, definitions_1.loadLayoutDefinition)(paintLayoutFileYaml)).rejects.toThrow('Failed loading layout definition: Failed loading template file "template.hbs": File not found');
     }));
+    it('should load layout definition without options field from YAML file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const yamlContentWithoutOptions = `
+name: test-layout
+displayName: Test Layout
+description: A test layout
+zones:
+  main:
+    displayName: Main Zone
+    description: Main content area
+    minNodes: 1
+entry: template.hbs
+    `;
+        fs.readFile.mockImplementation((filePath) => {
+            if (filePath.endsWith('page-layout.yaml')) {
+                return yamlContentWithoutOptions;
+            }
+            if (filePath.endsWith('template.hbs')) {
+                return templateContent;
+            }
+            throw new Error('File not found');
+        });
+        const layoutDefinition = yield (0, definitions_1.loadLayoutDefinition)(paintLayoutFileYaml);
+        expect(layoutDefinition).toEqual({
+            name: 'test-layout',
+            displayName: 'Test Layout',
+            description: 'A test layout',
+            zones: {
+                main: {
+                    displayName: 'Main Zone',
+                    description: 'Main content area',
+                    minNodes: 1,
+                },
+            },
+            template: templateContent,
+        });
+    }));
+    it('should load layout definition without maxNodes in zones from YAML file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const yamlContentWithoutMaxNodes = `
+name: test-layout
+displayName: Test Layout
+description: A test layout
+zones:
+  main:
+    displayName: Main Zone
+    description: Main content area
+    minNodes: 1
+  sidebar:
+    displayName: Sidebar Zone
+    description: Sidebar content area
+    minNodes: 0
+entry: template.hbs
+    `;
+        fs.readFile.mockImplementation((filePath) => {
+            if (filePath.endsWith('page-layout.yaml')) {
+                return yamlContentWithoutMaxNodes;
+            }
+            if (filePath.endsWith('template.hbs')) {
+                return templateContent;
+            }
+            throw new Error('File not found');
+        });
+        const layoutDefinition = yield (0, definitions_1.loadLayoutDefinition)(paintLayoutFileYaml);
+        expect(layoutDefinition).toEqual({
+            name: 'test-layout',
+            displayName: 'Test Layout',
+            description: 'A test layout',
+            zones: {
+                main: {
+                    displayName: 'Main Zone',
+                    description: 'Main content area',
+                    minNodes: 1,
+                },
+                sidebar: {
+                    displayName: 'Sidebar Zone',
+                    description: 'Sidebar content area',
+                    minNodes: 0,
+                },
+            },
+            template: templateContent,
+        });
+    }));
+    it('should load layout definition without options and maxNodes from JSON file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const jsonContentWithoutOptionsAndMaxNodes = JSON.stringify({
+            name: 'test-layout',
+            displayName: 'Test Layout',
+            description: 'A test layout',
+            zones: {
+                main: {
+                    displayName: 'Main Zone',
+                    description: 'Main content area',
+                    minNodes: 1,
+                },
+                sidebar: {
+                    displayName: 'Sidebar Zone',
+                    description: 'Sidebar content area',
+                    minNodes: 0,
+                },
+            },
+            entry: 'template.hbs',
+        });
+        fs.readFile.mockImplementation((filePath) => {
+            if (filePath.endsWith('page-layout.yaml')) {
+                throw { code: 'ENOENT' };
+            }
+            if (filePath.endsWith('page-layout.json')) {
+                return jsonContentWithoutOptionsAndMaxNodes;
+            }
+            if (filePath.endsWith('template.hbs')) {
+                return templateContent;
+            }
+            throw new Error('File not found');
+        });
+        const layoutDefinition = yield (0, definitions_1.loadLayoutDefinition)(paintLayoutFileJson);
+        expect(layoutDefinition).toEqual({
+            name: 'test-layout',
+            displayName: 'Test Layout',
+            description: 'A test layout',
+            zones: {
+                main: {
+                    displayName: 'Main Zone',
+                    description: 'Main content area',
+                    minNodes: 1,
+                },
+                sidebar: {
+                    displayName: 'Sidebar Zone',
+                    description: 'Sidebar content area',
+                    minNodes: 0,
+                },
+            },
+            template: templateContent,
+        });
+    }));
 });

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

@@ -13,7 +13,7 @@ export interface ExtendedLayoutDefinition extends LayoutDefinition {
 export interface ZoneDefinition {
     displayName: string;
     description: string;
-    minNodes: number;
+    minNodes?: number;
     maxNodes?: number;
 }
 export interface OptionDefinition {

package/package.json

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