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

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

@@ -19,6 +19,33 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
      * Description to provide extra information on the layout
      */
     description: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    description: string;
+    displayName: string;
+}, {
+    name: string;
+    description: string;
+    displayName: string;
+}>;
+/**
+ * Layout definition used for deprecated page-layout.yaml files
+ */
+export declare const InputLayoutDefinitionV1: z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * User defined identifier for a Page Layout
+     */
+    name: z.ZodString;
+    /**
+     * Name displayed in user interfaces
+     */
+    displayName: z.ZodString;
+    /**
+     * Description to provide extra information on the layout
+     */
+    description: z.ZodString;
+}, {
+    entry: z.ZodString;
     /**
      * Zone input structure configuration
      *
@@ -49,18 +76,22 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
     options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
-        values: z.ZodArray<z.ZodString, "many">;
+        valueType: z.ZodOptional<z.ZodEnum<["string-enum", "boolean", "text"]>>;
+        values: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }>>>;
-}, "strip", z.ZodTypeAny, {
+}>, "strip", z.ZodTypeAny, {
     name: string;
+    entry: string;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -70,12 +101,14 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
         maxNodes?: number | undefined;
     }>;
     options?: Record<string, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }> | undefined;
 }, {
     name: string;
+    entry: string;
     description: string;
     displayName: string;
     zones: Record<string, {
@@ -85,12 +118,16 @@ export declare const BaseLayoutDefinition: z.ZodObject<{
         maxNodes?: number | undefined;
     }>;
     options?: Record<string, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }> | undefined;
 }>;
-export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
+/**
+ * Layout definition used for manifest.json files
+ */
+export declare const InputLayoutDefinitionV2: z.ZodObject<z.objectUtil.extendShape<{
     /**
      * User defined identifier for a Page Layout
      */
@@ -103,6 +140,123 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
      * Description to provide extra information on the layout
      */
     description: z.ZodString;
+}, {
+    entry: z.ZodString;
+    /**
+     * Zone input structure configuration
+     *
+     * Declares the content structure that will be the input to the
+     * Handlebars template
+     */
+    zones: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        displayName: z.ZodString;
+        description: z.ZodString;
+    }, "strict", z.ZodTypeAny, {
+        key: string;
+        description: string;
+        displayName: string;
+    }, {
+        key: string;
+        description: string;
+        displayName: string;
+    }>, "many">;
+    /**
+     * Layout properties
+     *
+     * Declares any configurable properties that can be provided by a Content Editor
+     */
+    properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"boolean">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodBoolean, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }>, z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"string">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }>]>>>;
+}>, "strict", z.ZodTypeAny, {
+    name: string;
+    entry: string;
+    description: string;
+    displayName: string;
+    zones: {
+        key: string;
+        description: string;
+        displayName: string;
+    }[];
+    properties?: Record<string, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }> | undefined;
+}, {
+    name: string;
+    entry: string;
+    description: string;
+    displayName: string;
+    zones: {
+        key: string;
+        description: string;
+        displayName: string;
+    }[];
+    properties?: Record<string, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }> | undefined;
+}>;
+export declare type InputLayoutDefinitionV1 = z.infer<typeof InputLayoutDefinitionV1>;
+export declare type InputLayoutDefinitionV2 = z.infer<typeof InputLayoutDefinitionV2>;
+export declare const InputLayoutDefinition: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    /**
+     * User defined identifier for a Page Layout
+     */
+    name: z.ZodString;
+    /**
+     * Name displayed in user interfaces
+     */
+    displayName: z.ZodString;
+    /**
+     * Description to provide extra information on the layout
+     */
+    description: z.ZodString;
+}, {
+    entry: z.ZodString;
     /**
      * Zone input structure configuration
      *
@@ -133,18 +287,19 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
     options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         displayName: z.ZodString;
         description: z.ZodString;
-        values: z.ZodArray<z.ZodString, "many">;
+        valueType: z.ZodOptional<z.ZodEnum<["string-enum", "boolean", "text"]>>;
+        values: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }>>>;
-}, {
-    entry: z.ZodString;
 }>, "strip", z.ZodTypeAny, {
     name: string;
     entry: string;
@@ -157,9 +312,10 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
         maxNodes?: number | undefined;
     }>;
     options?: Record<string, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }> | undefined;
 }, {
     name: string;
@@ -173,12 +329,12 @@ export declare const InputLayoutDefinition: z.ZodObject<z.objectUtil.extendShape
         maxNodes?: number | undefined;
     }>;
     options?: Record<string, {
-        values: string[];
         description: string;
         displayName: string;
+        values?: string[] | undefined;
+        valueType?: "boolean" | "text" | "string-enum" | undefined;
     }> | undefined;
-}>;
-export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
+}>, z.ZodObject<z.objectUtil.extendShape<{
     /**
      * User defined identifier for a Page Layout
      */
@@ -191,80 +347,221 @@ export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<{
      * Description to provide extra information on the layout
      */
     description: z.ZodString;
+}, {
+    entry: z.ZodString;
     /**
      * Zone input structure configuration
      *
      * Declares the content structure that will be the input to the
      * Handlebars template
      */
-    zones: z.ZodRecord<z.ZodString, z.ZodObject<{
+    zones: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
         displayName: z.ZodString;
         description: z.ZodString;
-        minNodes: z.ZodDefault<z.ZodNumber>;
-        maxNodes: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
+    }, "strict", z.ZodTypeAny, {
+        key: string;
         description: string;
         displayName: string;
-        minNodes: number;
-        maxNodes?: number | undefined;
     }, {
+        key: string;
         description: string;
         displayName: string;
-        minNodes?: number | undefined;
-        maxNodes?: number | undefined;
-    }>>;
+    }>, "many">;
     /**
-     * Layout options
+     * Layout properties
      *
-     * Declares any configurable options that can be provided by a Content Editor
+     * Declares any configurable properties that can be provided by a Content Editor
      */
-    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+    properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"boolean">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodBoolean, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }>, z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"string">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }>]>>>;
+}>, "strict", z.ZodTypeAny, {
+    name: string;
+    entry: string;
+    description: string;
+    displayName: string;
+    zones: {
+        key: string;
+        description: string;
+        displayName: string;
+    }[];
+    properties?: Record<string, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }> | undefined;
+}, {
+    name: string;
+    entry: string;
+    description: string;
+    displayName: string;
+    zones: {
+        key: string;
+        description: string;
+        displayName: string;
+    }[];
+    properties?: Record<string, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }> | undefined;
+}>]>;
+export declare const LayoutDefinition: z.ZodObject<z.objectUtil.extendShape<Omit<z.objectUtil.extendShape<{
+    /**
+     * User defined identifier for a Page Layout
+     */
+    name: z.ZodString;
+    /**
+     * Name displayed in user interfaces
+     */
+    displayName: z.ZodString;
+    /**
+     * Description to provide extra information on the layout
+     */
+    description: z.ZodString;
+}, {
+    entry: z.ZodString;
+    /**
+     * Zone input structure configuration
+     *
+     * Declares the content structure that will be the input to the
+     * Handlebars template
+     */
+    zones: z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
         displayName: z.ZodString;
         description: z.ZodString;
-        values: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        values: string[];
+    }, "strict", z.ZodTypeAny, {
+        key: string;
         description: string;
         displayName: string;
     }, {
-        values: string[];
+        key: string;
         description: string;
         displayName: string;
-    }>>>;
-}, {
+    }>, "many">;
+    /**
+     * Layout properties
+     *
+     * Declares any configurable properties that can be provided by a Content Editor
+     */
+    properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"boolean">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodBoolean, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }, {
+        type: "boolean";
+        description: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    }>, z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodString;
+        type: z.ZodLiteral<"string">;
+        enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strict", z.ZodTypeAny, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }, {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
+    }>]>>>;
+}>, "entry">, {
     template: z.ZodString;
-}>, "strip", z.ZodTypeAny, {
+}>, "strict", z.ZodTypeAny, {
     name: string;
     description: string;
     displayName: string;
-    zones: Record<string, {
+    zones: {
+        key: string;
         description: string;
         displayName: string;
-        minNodes: number;
-        maxNodes?: number | undefined;
-    }>;
+    }[];
     template: string;
-    options?: Record<string, {
-        values: string[];
+    properties?: Record<string, {
+        type: "boolean";
         description: string;
-        displayName: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
     }> | undefined;
 }, {
     name: string;
     description: string;
     displayName: string;
-    zones: Record<string, {
+    zones: {
+        key: string;
         description: string;
         displayName: string;
-        minNodes?: number | undefined;
-        maxNodes?: number | undefined;
-    }>;
+    }[];
     template: string;
-    options?: Record<string, {
-        values: string[];
+    properties?: Record<string, {
+        type: "boolean";
         description: string;
-        displayName: string;
+        title: string;
+        enum?: boolean[] | undefined;
+    } | {
+        type: "string";
+        description: string;
+        title: string;
+        enum?: string[] | undefined;
     }> | undefined;
 }>;
 export declare type InputLayoutDefinition = z.infer<typeof InputLayoutDefinition>;
 export declare type LayoutDefinition = z.infer<typeof LayoutDefinition>;
+export declare const LAYOUT_MANIFEST_FILE = "manifest.json";

package/lib/page/utils/definitions.js

@@ -36,19 +36,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayoutDefinition = exports.InputLayoutDefinition = exports.BaseLayoutDefinition = exports.loadLayoutFromFile = exports.loadLayoutDefinition = void 0;
+exports.LAYOUT_MANIFEST_FILE = exports.LayoutDefinition = exports.InputLayoutDefinition = exports.InputLayoutDefinitionV2 = exports.InputLayoutDefinitionV1 = exports.BaseLayoutDefinition = exports.loadLayoutFromFile = exports.loadLayoutDefinition = void 0;
 // External
 const fs = __importStar(require("node:fs/promises"));
 const path = __importStar(require("node:path"));
@@ -56,12 +45,24 @@ const zod_1 = require("zod");
 const yaml_1 = require("yaml");
 // Local
 const validation_1 = require("../templates/validation");
+const render_1 = require("./render");
+const normalize_1 = require("./normalize");
 function loadLayoutDefinition(layoutFile) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const _a = yield loadLayoutFromFile(layoutFile), { entry } = _a, layout = __rest(_a, ["entry"]);
-            const template = yield loadTemplate(path.dirname(layoutFile), entry);
-            const layoutDefinition = Object.assign(Object.assign({}, layout), { template });
+            const layout = yield loadLayoutFromFile(layoutFile);
+            const template = yield loadTemplate(path.dirname(layoutFile), layout.entry);
+            const layoutDefinition = {
+                name: layout.name,
+                displayName: layout.displayName,
+                description: layout.description,
+                template,
+                zones: (0, normalize_1.normalizeZones)(layout.zones),
+            };
+            const normalizedProperties = (0, normalize_1.normalizeProperties)(layout);
+            if (normalizedProperties) {
+                layoutDefinition.properties = normalizedProperties;
+            }
             exports.LayoutDefinition.parse(layoutDefinition);
             return layoutDefinition;
         }
@@ -82,15 +83,38 @@ function loadLayoutFromFile(layoutFile) {
         });
         try {
             const layout = (0, yaml_1.parse)(content);
-            exports.InputLayoutDefinition.parse(layout);
+            const fileName = path.basename(layoutFile);
+            if (fileName === exports.LAYOUT_MANIFEST_FILE) {
+                exports.InputLayoutDefinitionV2.parse(layout);
+            }
+            else {
+                exports.InputLayoutDefinitionV1.parse(layout);
+            }
             return layout;
         }
         catch (e) {
-            throw Error(`Failed to parse ${layoutFile}: ${e.message}`);
+            const errorMessage = formatLayoutParseError(layoutFile, e);
+            throw Error(errorMessage);
         }
     });
 }
 exports.loadLayoutFromFile = loadLayoutFromFile;
+/**
+ * Formats a layout parse error into a user-friendly error message
+ */
+function formatLayoutParseError(layoutFile, error) {
+    if (error instanceof zod_1.ZodError) {
+        const errorMessages = error.issues.map(issue => {
+            const pathStr = issue.path.length > 0 ? ` at "${issue.path.join('.')}"` : '';
+            return `${issue.message}${pathStr}`;
+        });
+        return (`Failed to parse ${layoutFile}:\n\n` +
+            `Schema validation failed:\n${errorMessages
+                .map(err => `  - ${err}`)
+                .join('\n')}`);
+    }
+    return `Failed to parse ${layoutFile}: ${error.message}`;
+}
 /**
  * Loads a template file from a file system
  * @param layoutDirectory - The path to the layout directory
@@ -128,6 +152,12 @@ exports.BaseLayoutDefinition = zod_1.z.object({
      * Description to provide extra information on the layout
      */
     description: zod_1.z.string(),
+});
+/**
+ * Layout definition used for deprecated page-layout.yaml files
+ */
+exports.InputLayoutDefinitionV1 = exports.BaseLayoutDefinition.extend({
+    entry: zod_1.z.string(),
     /**
      * Zone input structure configuration
      *
@@ -149,13 +179,64 @@ exports.BaseLayoutDefinition = zod_1.z.object({
         .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()),
+        valueType: zod_1.z.enum(render_1.LayoutOptionValueTypes).optional(),
+        values: zod_1.z.array(zod_1.z.string()).optional(),
     }))
         .optional(),
 });
-exports.InputLayoutDefinition = exports.BaseLayoutDefinition.extend({
+/**
+ * Layout definition used for manifest.json files
+ */
+exports.InputLayoutDefinitionV2 = exports.BaseLayoutDefinition.extend({
     entry: zod_1.z.string(),
-});
-exports.LayoutDefinition = exports.BaseLayoutDefinition.extend({
+    /**
+     * Zone input structure configuration
+     *
+     * Declares the content structure that will be the input to the
+     * Handlebars template
+     */
+    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()),
+    /**
+     * Layout properties
+     *
+     * Declares any configurable properties that can be provided by a Content Editor
+     */
+    properties: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.discriminatedUnion('type', [
+        // Boolean
+        zod_1.z
+            .object({
+            title: zod_1.z.string(),
+            description: zod_1.z.string(),
+            type: zod_1.z.literal(render_1.LayoutPropertyType.boolean),
+            enum: zod_1.z.array(zod_1.z.boolean()).optional(),
+        })
+            .strict(),
+        // String
+        zod_1.z
+            .object({
+            title: zod_1.z.string(),
+            description: zod_1.z.string(),
+            type: zod_1.z.literal(render_1.LayoutPropertyType.string),
+            enum: zod_1.z.array(zod_1.z.string()).optional(),
+        })
+            .strict(),
+    ]))
+        .optional(),
+}).strict();
+exports.InputLayoutDefinition = zod_1.z.union([
+    exports.InputLayoutDefinitionV1,
+    exports.InputLayoutDefinitionV2,
+]);
+exports.LayoutDefinition = exports.InputLayoutDefinitionV2.omit({
+    entry: true,
+}).extend({
     template: zod_1.z.string(),
 });
+exports.LAYOUT_MANIFEST_FILE = 'manifest.json';