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

package/lib/page/utils/definitions.js

@@ -1,241 +0,0 @@
-"use strict";
-/*!
- * @license
- * Copyright (c) 2025, Squiz Australia Pty Ltd.
- * All rights reserved.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-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());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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"));
-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 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;
-        }
-        catch (e) {
-            throw Error(`Failed loading layout definition: ${e.message}`);
-        }
-    });
-}
-exports.loadLayoutDefinition = loadLayoutDefinition;
-function loadLayoutFromFile(layoutFile) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const fileType = layoutFile.split('.').pop();
-        if (!fileType || !['yaml', 'json'].includes(fileType)) {
-            throw Error('Layout file must have a valid extension: [yaml|json]');
-        }
-        const content = yield fs.readFile(layoutFile, {
-            encoding: 'utf-8',
-        });
-        try {
-            const layout = (0, yaml_1.parse)(content);
-            const fileName = path.basename(layoutFile);
-            if (fileName === exports.LAYOUT_MANIFEST_FILE) {
-                exports.InputLayoutDefinitionV2.parse(layout);
-            }
-            else {
-                exports.InputLayoutDefinitionV1.parse(layout);
-            }
-            return layout;
-        }
-        catch (e) {
-            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
- * @param templateFile - The path to the template file
- * @returns The template
- */
-function loadTemplate(layoutDirectory, templateFile) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const template = yield fs.readFile(path.resolve(layoutDirectory, templateFile), {
-                encoding: 'utf-8',
-            });
-            // Validate the template
-            const validationErrors = yield (0, validation_1.validateTemplateFile)(template);
-            if (validationErrors.length > 0) {
-                throw new Error(validationErrors.join('\n'));
-            }
-            return template;
-        }
-        catch (e) {
-            throw Error(`Failed loading template file "${templateFile}": ${e.message}`);
-        }
-    });
-}
-exports.BaseLayoutDefinition = zod_1.z.object({
-    /**
-     * User defined identifier for a Page Layout
-     */
-    name: zod_1.z.string().regex(/^[a-z][a-z0-9-_]*[a-z0-9]$/),
-    /**
-     * Name displayed in user interfaces
-     */
-    displayName: zod_1.z.string(),
-    /**
-     * 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
-     *
-     * 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({
-        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(),
-    })),
-    /**
-     * Layout options
-     *
-     * 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({
-        displayName: zod_1.z.string(),
-        description: zod_1.z.string(),
-        valueType: zod_1.z.enum(render_1.LayoutOptionValueTypes).optional(),
-        values: zod_1.z.array(zod_1.z.string()).optional(),
-    }))
-        .optional(),
-}).strict();
-/**
- * Layout definition used for manifest.json files
- */
-exports.InputLayoutDefinitionV2 = exports.BaseLayoutDefinition.extend({
-    entry: zod_1.z.string(),
-    /**
-     * 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),
-        })
-            .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';

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

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