@ui5/mcp-server 0.1.0

package/lib/tools/create_ui5_app/create_ui5_app.js

@@ -0,0 +1,273 @@
+import os from "os";
+import path, { isAbsolute } from "path";
+import { fileURLToPath } from "url";
+import { mkdir } from "fs/promises";
+import semver from "semver";
+import { execa } from "execa";
+import { getLatestUi5Version } from "./ui5Version.js";
+import { processTemplates } from "./templateProcessor.js";
+import ODataMetadata from "./ODataMetadata.js";
+import { getLogger } from "@ui5/logger";
+import { isUi5Framework } from "../../utils/ui5Framework.js";
+import { dirExists, InvalidInputError } from "../../utils.js";
+import isValidUrl from "./isValidUrl.js";
+const log = getLogger("tools:create_ui5_app:create_ui5_app");
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const minFwkVersion = {
+    OpenUI5: "1.96.0",
+    SAPUI5: "1.96.0",
+};
+const minFwkVersionJS = {
+    OpenUI5: "1.96.0",
+    SAPUI5: "1.96.0",
+};
+const fwkCDNDomain = {
+    OpenUI5: "sdk.openui5.org",
+    SAPUI5: "ui5.sap.com",
+};
+function getTypePackageFor(framework, version = "99.99.99") {
+    const typesName = semver.gte(version, "1.113.0") ? "types" : "ts-types-esm";
+    return `@${framework.toLowerCase()}/${typesName}`;
+}
+/**
+ * Creates a new SAPUI5/OpenUI5 application using templating.
+ *
+ * @param {CreateUi5AppParams} params - Parameters for the application to be created.
+ * @returns {Promise<CreateUi5AppResult>} Result object indicating success, message, and final location.
+ */
+export async function createUi5App(params) {
+    const { appNamespace, framework = "SAPUI5", frameworkVersion = await getLatestUi5Version(params.framework ?? "SAPUI5"), author = os.userInfo().username || "Developer", createAppDirectory = true, oDataV4Url, oDataEntitySet, entityProperties = [], initializeGitRepository = true, runNpmInstall = true, basePath, typescript = true, } = params;
+    // Validate parameters
+    if (!isUi5Framework(framework)) {
+        throw new InvalidInputError("The provided framework is not valid! Please use either OpenUI5 or SAPUI5.");
+    }
+    if (!semver.valid(frameworkVersion)) {
+        throw new InvalidInputError("The provided framework version is not valid! Please use a semantic version, e.g. 1.136.0");
+    }
+    const minFwkVersionToUse = typescript ?
+        minFwkVersion[framework] :
+        minFwkVersionJS[framework];
+    if (semver.lt(frameworkVersion, minFwkVersionToUse)) {
+        throw new InvalidInputError(`The provided framework version ${frameworkVersion} is not valid!
+The minimum version for ${framework} is ${minFwkVersionToUse}.`);
+    }
+    let metadata, metadataUrl;
+    if (oDataV4Url) {
+        metadataUrl = oDataV4Url;
+        if (oDataV4Url.startsWith("/")) {
+            metadataUrl = `http://localhost:4004${oDataV4Url}`;
+        }
+        const allowedDomains = getAllowedOdataV4Domains();
+        if (!isValidUrl(metadataUrl, allowedDomains)) {
+            let allowedDomainsNote = "";
+            if (allowedDomains.length) {
+                allowedDomainsNote =
+                    `As per the MCP server configuration, only the following domains are currently allowed: ` +
+                        `'${allowedDomains.join("', '")}'. See https://github.com/UI5/mcp-server#configuration ` +
+                        `for information on how to configure the allow list.`;
+            }
+            throw new InvalidInputError(`The provided OData V4 service URL is not valid. It must be either an absolute URL` +
+                `starting with http:// or https:// or pathname like '/odata/v4/serviceName' in case ` +
+                `the OData service is exposed on the same server as the application. In this case, ` +
+                `the protocol and host 'http://localhost:4004' will be assumed and used by this tool for inquiries ` +
+                `about the service. ${allowedDomainsNote}`);
+        }
+        try {
+            metadata = await ODataMetadata.load(metadataUrl);
+        }
+        catch (err) {
+            // Silently ignore metadata loading errors
+            // Many services require proxies or authentication, which is out of scope for this tool
+            log.info(`Failed to load OData V4 metadata from ${metadataUrl}: ` +
+                ` ${err instanceof Error ? err.message : String(err)}` +
+                " This means the given entity and properties will not be verified and when no properties are" +
+                " given, there is no automatic display of some properties.");
+        }
+    }
+    // let metadataEntityKeys: string[] | undefined;
+    let metadataEntityProperties;
+    if (oDataEntitySet && metadata) {
+        if (!metadata.getEntitySet(oDataEntitySet)) {
+            throw new InvalidInputError(`The provided OData V4 entity set '${oDataEntitySet}' does not exist in the service metadata. ` +
+                `Please check the entity set name and ensure it is correct or omit it to generate the app ` +
+                `without data in the UI.`);
+        }
+        metadataEntityProperties = metadata.getProperties(oDataEntitySet);
+        // metadataEntityKeys = metadata.getKeys(oDataEntitySet);
+        if (entityProperties) {
+            // Validate provided entity properties against metadata
+            for (const prop of entityProperties) {
+                if (!metadataEntityProperties?.includes(prop)) {
+                    // remove the property from the list if it doesn't exist in the entity
+                    const index = entityProperties.indexOf(prop);
+                    if (index !== -1) {
+                        entityProperties.splice(index, 1);
+                    }
+                }
+            }
+        }
+        if (entityProperties.length === 0) {
+            // Use the first five properties from the metadata if none were provided/existing
+            entityProperties.push(...(metadataEntityProperties?.slice(0, 5) ?? []));
+        }
+    }
+    if (!isAbsolute(basePath)) {
+        throw new InvalidInputError("The provided base path is not valid! Please provide an absolute path to the target directory.");
+    }
+    try {
+        // if the directory does not exist, create it
+        await mkdir(basePath, { recursive: true });
+    }
+    catch (dirError) {
+        throw new InvalidInputError(`Failed to create base path '${basePath}': ${dirError instanceof Error ?
+            dirError.message :
+            String(dirError)}` +
+            " Please ensure the path is valid and as intended and you have write permissions.", { cause: dirError });
+    }
+    const finalLocation = createAppDirectory ? path.join(basePath, appNamespace) : basePath;
+    // Create app directory if needed
+    if (createAppDirectory) {
+        // Check directory does not already exist
+        if (await dirExists(finalLocation)) {
+            throw new InvalidInputError(`Target directory '${finalLocation}' already exists. ` +
+                "Please choose a different namespace or base path or remove the existing directory.");
+        }
+        await mkdir(finalLocation, { recursive: true });
+    }
+    // build the final OData V4 URL, which must be relative when starting with localhost as server because
+    // "localhost" won't work when deployed. Also, ensure it ends with a slash because the ODataModel
+    // requires this.
+    let finalODataV4Url = oDataV4Url?.match(/^https?:\/\/localhost:\d+/) ?
+        oDataV4Url.replace(/^https?:\/\/localhost:\d+/, "") :
+        oDataV4Url;
+    if (finalODataV4Url && !finalODataV4Url?.endsWith("/")) {
+        finalODataV4Url += "/";
+    }
+    // This allows us to apply an ODataModel setting (earlyRequests: true), which is recommended for
+    // servers that require x-csrf tokens. But this setting breaks with other servers.
+    // Details how this setting and x-csrf tokens are related are discussed in
+    // https://github.com/UI5/openui5/issues/2288
+    // As result, we want to enable earlyRequests only when we are very sure that it doesn't break anything
+    // -- i.e. for local CAP servers, which are known to require x-csrf tokens and are typically running on
+    // localhost:4004 at development time. This should at least cover a common use case.
+    // TODO: Could also find out with requests when server is alive?
+    const serverRequiresXCSRF = !!metadataUrl?.includes("localhost:4004");
+    let escapedOdataV4Url;
+    if (finalODataV4Url) {
+        // Always stringify the URL to ensure special characters like quotes
+        // do not break the JSON templates it is injected into
+        escapedOdataV4Url = JSON.stringify(finalODataV4Url).slice(1, -1); // Remove leading and trailing quotes
+    }
+    // Generate template variables
+    const templateVars = {
+        namespace: appNamespace,
+        framework: framework,
+        frameworkVersion,
+        author,
+        ...(typescript && {
+            tstypes: getTypePackageFor(framework, frameworkVersion),
+            tstypesVersion: frameworkVersion,
+        }),
+        appId: appNamespace,
+        appURI: appNamespace.split(".").join("/"),
+        cdnDomain: fwkCDNDomain[framework],
+        oDataV4Url: escapedOdataV4Url,
+        oDataEntitySet,
+        entityProperties,
+        serverRequiresXCSRF,
+        defaultTheme: semver.gte(frameworkVersion, "1.108.0") ? "sap_horizon" : "sap_fiori_3",
+        qunitCoverageFile: semver.gte(frameworkVersion, "1.113.0") ?
+            "qunit-coverage-istanbul.js" :
+            "qunit-coverage.js",
+        gte1_98_0: semver.gte(frameworkVersion, "1.98.0"),
+        gte1_100_0: semver.gte(frameworkVersion, "1.100.0"),
+        gte1_104_0: semver.gte(frameworkVersion, "1.104.0"),
+        lt1_110_0: semver.lt(frameworkVersion, "1.110.0"),
+        gte1_115_0: semver.gte(frameworkVersion, "1.115.0"),
+        gte1_120_0: semver.gte(frameworkVersion, "1.120.0"),
+        lt1_124_0: semver.lt(frameworkVersion, "1.124.0"),
+    };
+    // Process template files
+    const templateDir = path.join(__dirname, "..", "..", "..", "resources", typescript ?
+        "template-ts" :
+        "template-js");
+    const generatedFiles = await processTemplates({
+        templateDir,
+        targetDir: finalLocation,
+        templateVars,
+        versionSpecificLogic: {
+            lt1_124_0: templateVars.lt1_124_0,
+        },
+    });
+    if (runNpmInstall) {
+        // Run npm install
+        await execa("npm", ["install"], {
+            cwd: finalLocation,
+            stdout: process.stderr,
+        });
+    }
+    // Initialize git repository if requested
+    if (initializeGitRepository) {
+        await execa("git", ["init", "--quiet"], {
+            cwd: finalLocation,
+            stdout: process.stderr,
+        });
+        await execa("git", ["add", "."], {
+            cwd: finalLocation,
+            stdout: process.stderr,
+        });
+        await execa("git", ["commit", "--quiet", "--allow-empty", "-m", "Initial commit"], {
+            cwd: finalLocation,
+            stdout: process.stderr,
+        });
+    }
+    return {
+        message: `${framework} ${typescript ? "TypeScript" : "JavaScript"} application ` +
+            `${appNamespace} created successfully.`,
+        finalLocation,
+        generatedFiles, // array of generated file paths, relative to finalLocation
+        basePath,
+        appInfo: {
+            appNamespace,
+            framework: framework,
+            frameworkVersion,
+            finalODataV4Url,
+            oDataEntitySet,
+            entityProperties: entityProperties ?? [],
+            npmInstallExecuted: runNpmInstall,
+            gitInitialized: initializeGitRepository,
+            typescript,
+        },
+    };
+}
+function getAllowedOdataV4Domains() {
+    if ("UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS" in process.env) {
+        const inputDomainList = process.env.UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS;
+        if (!inputDomainList?.trim()) {
+            // Empty list allows all domains
+            log.verbose("Empty value for UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS, allowing all domains");
+            return [];
+        }
+        // Use the environment variable if set
+        const domainList = inputDomainList.split(",").map((d) => d.trim());
+        // Validate domains to catch user errors
+        for (const domain of domainList) {
+            try {
+                // Note that the dot prefix (which we use for wildcards) is valid in a domain
+                new URL(`https://${domain}`);
+            }
+            catch (err) {
+                throw new InvalidInputError(`Invalid domain '${domain}' in UI5_MCP_SERVER_ALLOWED_ODATA_DOMAINS: ` +
+                    (err instanceof Error ? err.message : String(err)));
+            }
+        }
+        log.verbose(`${domainList.length} allowed OData V4 domains configured: ${domainList.join(", ")}`);
+        return domainList;
+    }
+    return [
+        // Default allowed domains for OData V4 services
+        "localhost",
+        "services.odata.org",
+    ];
+}
+//# sourceMappingURL=create_ui5_app.js.map

package/lib/tools/create_ui5_app/create_ui5_app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_ui5_app.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/create_ui5_app.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,EAAE,EAAC,UAAU,EAAC,MAAM,MAAM,CAAC;AACtC,OAAO,EAAC,aAAa,EAAC,MAAM,KAAK,CAAC;AAClC,OAAO,EAAC,KAAK,EAAC,MAAM,aAAa,CAAC;AAClC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAC,KAAK,EAAC,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAC,mBAAmB,EAAC,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAC,gBAAgB,EAAC,MAAM,wBAAwB,CAAC;AACxD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AACtC,OAAO,EAAC,cAAc,EAAe,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAC,SAAS,EAAE,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAC5D,OAAO,UAAU,MAAM,iBAAiB,CAAC;AAEzC,MAAM,GAAG,GAAG,SAAS,CAAC,qCAAqC,CAAC,CAAC;AAE7D,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE/D,MAAM,aAAa,GAAG;IACrB,OAAO,EAAE,QAAQ;IACjB,MAAM,EAAE,QAAQ;CAChB,CAAC;AAEF,MAAM,eAAe,GAAG;IACvB,OAAO,EAAE,QAAQ;IACjB,MAAM,EAAE,QAAQ;CAChB,CAAC;AAEF,MAAM,YAAY,GAAG;IACpB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,aAAa;CACrB,CAAC;AAEF,SAAS,iBAAiB,CAAC,SAAuB,EAAE,OAAO,GAAG,UAAU;IACvE,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC;IAC5E,OAAO,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,SAAS,EAAE,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAA0B;IAC5D,MAAM,EACL,YAAY,EACZ,SAAS,GAAG,QAAQ,EACpB,gBAAgB,GAAG,MAAM,mBAAmB,CAAC,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC,EAC1E,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,IAAI,WAAW,EAC9C,kBAAkB,GAAG,IAAI,EACzB,UAAU,EACV,cAAc,EACd,gBAAgB,GAAG,EAAE,EACrB,uBAAuB,GAAG,IAAI,EAC9B,aAAa,GAAG,IAAI,EACpB,QAAQ,EACR,UAAU,GAAG,IAAI,GACjB,GAAG,MAAM,CAAC;IAEX,sBAAsB;IAEtB,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,iBAAiB,CAAC,2EAA2E,CAAC,CAAC;IAC1G,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,iBAAiB,CAC1B,0FAA0F,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,kBAAkB,GAAG,UAAU,CAAC,CAAC;QACtC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC;QAC1B,eAAe,CAAC,SAAS,CAAC,CAAC;IAC5B,IAAI,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,iBAAiB,CAC1B,kCAAkC,gBAAgB;0BAC3B,SAAS,OAAO,kBAAkB,GAAG,CAC5D,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,EAAE,WAAW,CAAC;IAC1B,IAAI,UAAU,EAAE,CAAC;QAChB,WAAW,GAAG,UAAU,CAAC;QACzB,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,WAAW,GAAG,wBAAwB,UAAU,EAAE,CAAC;QACpD,CAAC;QACD,MAAM,cAAc,GAAG,wBAAwB,EAAE,CAAC;QAClD,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,cAAc,CAAC,EAAE,CAAC;YAC9C,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,IAAI,cAAc,CAAC,MAAM,EAAE,CAAC;gBAC3B,kBAAkB;oBACjB,yFAAyF;wBACzF,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,yDAAyD;wBACxF,qDAAqD,CAAC;YACxD,CAAC;YACD,MAAM,IAAI,iBAAiB,CAC1B,mFAAmF;gBACnF,qFAAqF;gBACrF,oFAAoF;gBACpF,oGAAoG;gBACpG,sBAAsB,kBAAkB,EAAE,CAC1C,CAAC;QACH,CAAC;QACD,IAAI,CAAC;YACJ,QAAQ,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,0CAA0C;YAC1C,uFAAuF;YACvF,GAAG,CAAC,IAAI,CACP,yCAAyC,WAAW,IAAI;gBACxD,IAAI,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;gBACtD,6FAA6F;gBAC7F,2DAA2D,CAC3D,CAAC;QACH,CAAC;IACF,CAAC;IAED,gDAAgD;IAChD,IAAI,wBAA8C,CAAC;IACnD,IAAI,cAAc,IAAI,QAAQ,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,iBAAiB,CAC1B,qCAAqC,cAAc,4CAA4C;gBAC/F,2FAA2F;gBAC3F,yBAAyB,CACzB,CAAC;QACH,CAAC;QAED,wBAAwB,GAAG,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QAClE,yDAAyD;QAEzD,IAAI,gBAAgB,EAAE,CAAC;YACtB,uDAAuD;YACvD,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;gBACrC,IAAI,CAAC,wBAAwB,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC/C,sEAAsE;oBACtE,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC7C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;wBAClB,gBAAgB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACnC,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;QAED,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,iFAAiF;YACjF,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACzE,CAAC;IACF,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,iBAAiB,CAC1B,+FAA+F,CAC/F,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACJ,6CAA6C;QAC7C,MAAM,KAAK,CAAC,QAAQ,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,QAAQ,EAAE,CAAC;QACnB,MAAM,IAAI,iBAAiB,CAC1B,+BAA+B,QAAQ,MAAM,QAAQ,YAAY,KAAK,CAAC,CAAC;YACvE,QAAQ,CAAC,OAAO,CAAC,CAAC;YACjB,MAAM,CAAC,QAAQ,CAAC,EAAE;YAClB,kFAAkF,EACpF,EAAC,KAAK,EAAE,QAAQ,EAAC,CACjB,CAAC;IACH,CAAC;IACD,MAAM,aAAa,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAExF,iCAAiC;IACjC,IAAI,kBAAkB,EAAE,CAAC;QACxB,yCAAyC;QACzC,IAAI,MAAM,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,iBAAiB,CAC1B,qBAAqB,aAAa,oBAAoB;gBACtD,oFAAoF,CACpF,CAAC;QACH,CAAC;QACD,MAAM,KAAK,CAAC,aAAa,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;IAC/C,CAAC;IAED,sGAAsG;IACtG,iGAAiG;IACjG,iBAAiB;IACjB,IAAI,eAAe,GAAG,UAAU,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACpE,UAAU,CAAC,OAAO,CAAC,2BAA2B,EAAE,EAAE,CAAC,CAAC,CAAC;QACtD,UAAU,CAAC;IACZ,IAAI,eAAe,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxD,eAAe,IAAI,GAAG,CAAC;IACxB,CAAC;IAED,gGAAgG;IAChG,kFAAkF;IAClF,0EAA0E;IAC1E,6CAA6C;IAC7C,uGAAuG;IACvG,uGAAuG;IACvG,oFAAoF;IACpF,gEAAgE;IAChE,MAAM,mBAAmB,GAAG,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAEtE,IAAI,iBAAiB,CAAC;IACtB,IAAI,eAAe,EAAE,CAAC;QACrB,oEAAoE;QACpE,sDAAsD;QACtD,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,qCAAqC;IACxG,CAAC;IAED,8BAA8B;IAC9B,MAAM,YAAY,GAAG;QACpB,SAAS,EAAE,YAAY;QACvB,SAAS,EAAE,SAAS;QACpB,gBAAgB;QAChB,MAAM;QACN,GAAG,CAAC,UAAU,IAAI;YACjB,OAAO,EAAE,iBAAiB,CAAC,SAAS,EAAE,gBAAgB,CAAC;YACvD,cAAc,EAAE,gBAAgB;SAChC,CAAC;QACF,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACzC,SAAS,EAAE,YAAY,CAAC,SAAS,CAAC;QAClC,UAAU,EAAE,iBAAiB;QAC7B,cAAc;QACd,gBAAgB;QAChB,mBAAmB;QACnB,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa;QACrF,iBAAiB,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC;YAC3D,4BAA4B,CAAC,CAAC;YAC9B,mBAAmB;QACpB,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC;QACjD,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC;QACnD,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC;QACnD,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAC;QACjD,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC;QACnD,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC;QACnD,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,SAAS,CAAC;KACjD,CAAC;IAEF,yBAAyB;IACzB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QACnF,aAAa,CAAC,CAAC;QACf,aAAa,CAAC,CAAC;IAChB,MAAM,cAAc,GAAG,MAAM,gBAAgB,CAAC;QAC7C,WAAW;QACX,SAAS,EAAE,aAAa;QACxB,YAAY;QACZ,oBAAoB,EAAE;YACrB,SAAS,EAAE,YAAY,CAAC,SAAS;SACjC;KACD,CAAC,CAAC;IAEH,IAAI,aAAa,EAAE,CAAC;QACnB,kBAAkB;QAClB,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE;YAC/B,GAAG,EAAE,aAAa;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;IACJ,CAAC;IAED,yCAAyC;IACzC,IAAI,uBAAuB,EAAE,CAAC;QAC7B,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE;YACvC,GAAG,EAAE,aAAa;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;QACH,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;YAChC,GAAG,EAAE,aAAa;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;QACH,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,IAAI,EAAE,gBAAgB,CAAC,EAAE;YAClF,GAAG,EAAE,aAAa;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;IACJ,CAAC;IAED,OAAO;QACN,OAAO,EAAE,GAAG,SAAS,IAAI,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,YAAY,eAAe;YAC/E,GAAG,YAAY,wBAAwB;QACxC,aAAa;QACb,cAAc,EAAE,2DAA2D;QAC3E,QAAQ;QACR,OAAO,EAAE;YACR,YAAY;YACZ,SAAS,EAAE,SAAS;YACpB,gBAAgB;YAChB,eAAe;YACf,cAAc;YACd,gBAAgB,EAAE,gBAAgB,IAAI,EAAE;YACxC,kBAAkB,EAAE,aAAa;YACjC,cAAc,EAAE,uBAAuB;YACvC,UAAU;SACV;KACD,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB;IAChC,IAAI,sCAAsC,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3D,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC;QACzE,IAAI,CAAC,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC;YAC9B,gCAAgC;YAChC,GAAG,CAAC,OAAO,CAAC,4EAA4E,CAAC,CAAC;YAC1F,OAAO,EAAE,CAAC;QACX,CAAC;QACD,sCAAsC;QACtC,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,wCAAwC;QACxC,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,CAAC;gBACJ,6EAA6E;gBAC7E,IAAI,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;YAC9B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,MAAM,IAAI,iBAAiB,CAC1B,mBAAmB,MAAM,6CAA6C;oBACtE,CAAC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAClD,CAAC;YACH,CAAC;QACF,CAAC;QACD,GAAG,CAAC,OAAO,CAAC,GAAG,UAAU,CAAC,MAAM,yCAAyC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClG,OAAO,UAAU,CAAC;IACnB,CAAC;IACD,OAAO;QACN,gDAAgD;QAChD,WAAW;QACX,oBAAoB;KACpB,CAAC;AACH,CAAC"}

package/lib/tools/create_ui5_app/index.d.ts

@@ -0,0 +1,3 @@
+import Context from "../../Context.js";
+import { RegisterTool } from "../../registerTools.js";
+export default function registerTool(registerTool: RegisterTool, context: Context): void;

package/lib/tools/create_ui5_app/index.js

@@ -0,0 +1,58 @@
+import { createUi5App } from "./create_ui5_app.js";
+import { createAppSchema } from "./schema.js";
+import { createSuccessMessage } from "./createSuccessMessage.js";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("tools:create_ui5_app");
+export default function registerTool(registerTool, context) {
+    registerTool("create_ui5_app", {
+        description: "Create a new basic SAPUI5 application implemented in TypeScript or JavaScript",
+        annotations: {
+            title: "Create SAPUI5 App",
+            readOnlyHint: false,
+        },
+        inputSchema: createAppSchema,
+    }, async (params) => {
+        log.info(`Creating a new UI5 application at ${params.basePath}`);
+        log.info(`   Using framework: ${params.framework}, version: ${params.frameworkVersion}`);
+        log.info(`   Namespace: ${params.appNamespace}`);
+        log.info(`   OData V4 URL: ${params.oDataV4Url}`);
+        log.info(`   OData entity set: ${params.oDataEntitySet}`);
+        log.info(`   Create app directory: ${params.createAppDirectory}`);
+        log.info(`   Run npm install: ${params.runNpmInstall}`);
+        log.info(`   Initialize git repository: ${params.initializeGitRepository}`);
+        log.info(`   TypeScript: ${params.typescript}`);
+        const resolvedBasePath = await context.normalizePath(params.basePath);
+        const result = await createUi5App({
+            basePath: resolvedBasePath,
+            framework: params.framework,
+            frameworkVersion: params.frameworkVersion,
+            appNamespace: params.appNamespace,
+            oDataV4Url: params.oDataV4Url,
+            oDataEntitySet: params.oDataEntitySet,
+            createAppDirectory: params.createAppDirectory,
+            runNpmInstall: params.runNpmInstall,
+            initializeGitRepository: params.initializeGitRepository,
+            typescript: params.typescript,
+        });
+        const message = createSuccessMessage({
+            finalLocation: result.finalLocation,
+            generatedFiles: result.generatedFiles,
+            basePath: result.basePath,
+            finalODataV4Url: result.appInfo?.finalODataV4Url,
+            oDataEntitySet: result.appInfo?.oDataEntitySet,
+            entityProperties: result.appInfo.entityProperties,
+            appNamespace: result.appInfo.appNamespace,
+            framework: result.appInfo.framework,
+            frameworkVersion: result.appInfo.frameworkVersion,
+            runNpmInstall: result.appInfo.npmInstallExecuted,
+            typescript: result.appInfo.typescript,
+        });
+        return {
+            content: [{
+                    type: "text",
+                    text: message,
+                }],
+        };
+    });
+}
+//# sourceMappingURL=index.js.map

package/lib/tools/create_ui5_app/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAqB,eAAe,EAAC,MAAM,aAAa,CAAC;AAChE,OAAO,EAAC,oBAAoB,EAAC,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAC,SAAS,EAAC,MAAM,aAAa,CAAC;AAItC,MAAM,GAAG,GAAG,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAA0B,EAAE,OAAgB;IAChF,YAAY,CAAC,gBAAgB,EAAE;QAC9B,WAAW,EAAE,+EAA+E;QAC5F,WAAW,EAAE;YACZ,KAAK,EAAE,mBAAmB;YAC1B,YAAY,EAAE,KAAK;SACnB;QACD,WAAW,EAAE,eAAe;KAC5B,EAAE,KAAK,EAAE,MAA0B,EAAE,EAAE;QACvC,GAAG,CAAC,IAAI,CAAC,qCAAqC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjE,GAAG,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,SAAS,cAAc,MAAM,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACzF,GAAG,CAAC,IAAI,CAAC,iBAAiB,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;QACjD,GAAG,CAAC,IAAI,CAAC,oBAAoB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAClD,GAAG,CAAC,IAAI,CAAC,wBAAwB,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QAC1D,GAAG,CAAC,IAAI,CAAC,4BAA4B,MAAM,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAClE,GAAG,CAAC,IAAI,CAAC,uBAAuB,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;QACxD,GAAG,CAAC,IAAI,CAAC,iCAAiC,MAAM,CAAC,uBAAuB,EAAE,CAAC,CAAC;QAC5E,GAAG,CAAC,IAAI,CAAC,kBAAkB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;QAChD,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;YACjC,QAAQ,EAAE,gBAAgB;YAC1B,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;YAC7C,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;YACvD,UAAU,EAAE,MAAM,CAAC,UAAU;SAC7B,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,oBAAoB,CAAC;YACpC,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,eAAe,EAAE,MAAM,CAAC,OAAO,EAAE,eAAe;YAChD,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,cAAc;YAC9C,gBAAgB,EAAE,MAAM,CAAC,OAAQ,CAAC,gBAAgB;YAClD,YAAY,EAAE,MAAM,CAAC,OAAQ,CAAC,YAAY;YAC1C,SAAS,EAAE,MAAM,CAAC,OAAQ,CAAC,SAAS;YACpC,gBAAgB,EAAE,MAAM,CAAC,OAAQ,CAAC,gBAAgB;YAClD,aAAa,EAAE,MAAM,CAAC,OAAQ,CAAC,kBAAkB;YACjD,UAAU,EAAE,MAAM,CAAC,OAAQ,CAAC,UAAU;SACtC,CAAC,CAAC;QACH,OAAO;YACN,OAAO,EAAE,CAAC;oBACT,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,OAAO;iBACb,CAAC;SACF,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/lib/tools/create_ui5_app/isValidUrl.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Validates a URL against a set of specified rules, including protocol and domain allow lists.
+ *
+ * @param urlString The string to validate as a URL.
+ * @param domainAllowList An array of allowed domain names.
+ *                        - An empty array allows any domain.
+ *                        - e.g., ["localhost", "example.com", "sub.example.com"]
+ *                        - For wildcard subdomains, prefix the domain with a dot: ".example.com".
+ *                          This will match "www.example.com" but not "example.com".
+ * @param protocolAllowList An array of allowed protocols (without the trailing colon).
+ *                         - An empty array allows any protocol.
+ *                         - e.g., ["http", "https"]
+ * @returns `true` if the URL is valid according to the rules, otherwise `false`.
+ * @throws {InvalidInputError} if the URL's domain is not in the provided allow list.
+ */
+export default function isValidUrl(urlString: string, domainAllowList?: string[], protocolAllowList?: string[]): boolean;

package/lib/tools/create_ui5_app/isValidUrl.js

@@ -0,0 +1,59 @@
+import { InvalidInputError } from "../../utils.js";
+/**
+ * Validates a URL against a set of specified rules, including protocol and domain allow lists.
+ *
+ * @param urlString The string to validate as a URL.
+ * @param domainAllowList An array of allowed domain names.
+ *                        - An empty array allows any domain.
+ *                        - e.g., ["localhost", "example.com", "sub.example.com"]
+ *                        - For wildcard subdomains, prefix the domain with a dot: ".example.com".
+ *                          This will match "www.example.com" but not "example.com".
+ * @param protocolAllowList An array of allowed protocols (without the trailing colon).
+ *                         - An empty array allows any protocol.
+ *                         - e.g., ["http", "https"]
+ * @returns `true` if the URL is valid according to the rules, otherwise `false`.
+ * @throws {InvalidInputError} if the URL's domain is not in the provided allow list.
+ */
+export default function isValidUrl(urlString, domainAllowList = [], protocolAllowList = ["http", "https"]) {
+    let url;
+    // 1. Validate URL structure using the WHATWG URL API.
+    try {
+        url = new URL(urlString);
+    }
+    catch (_err) {
+        // If the URL constructor throws an error, the URL is malformed.
+        return false;
+    }
+    // 2. Validate the protocol.
+    if (protocolAllowList.length > 0) {
+        // The `protocol` property includes the colon (e.g., "https:").
+        // We remove it for a clean comparison.
+        const urlProtocol = url.protocol.slice(0, -1);
+        if (!protocolAllowList.includes(urlProtocol)) {
+            return false;
+        }
+    }
+    // 3. Validate the domain/hostname.
+    if (domainAllowList.length > 0) {
+        const hostname = url.hostname;
+        const isDomainAllowed = domainAllowList.some((allowedDomain) => {
+            // Wildcard domain check (e.g., ".example.com")
+            if (allowedDomain.startsWith(".")) {
+                // Must match the suffix and not be the root domain itself.
+                // e.g., "api.example.com" ends with ".example.com"
+                // e.g., "example.com" does NOT end with ".example.com"
+                return hostname.endsWith(allowedDomain);
+            }
+            // Exact domain match
+            return hostname === allowedDomain;
+        });
+        if (!isDomainAllowed) {
+            throw new InvalidInputError(`Domain "${hostname}" is not allowed. Allowed domains are: ${domainAllowList.join(", ")}. See ` +
+                `https://github.com/UI5/mcp-server#configuration for information on how to configure the allow list.`);
+        }
+    }
+    // If all checks pass, the URL is valid.
+    return true;
+}
+;
+//# sourceMappingURL=isValidUrl.js.map

package/lib/tools/create_ui5_app/isValidUrl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isValidUrl.js","sourceRoot":"","sources":["../../../src/tools/create_ui5_app/isValidUrl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AAEjD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CACjC,SAAiB,EACjB,kBAA4B,EAAE,EAC9B,oBAA8B,CAAC,MAAM,EAAE,OAAO,CAAC;IAE/C,IAAI,GAAQ,CAAC;IAEb,sDAAsD;IACtD,IAAI,CAAC;QACJ,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IAC1B,CAAC;IAAC,OAAO,IAAI,EAAE,CAAC;QACf,gEAAgE;QAChE,OAAO,KAAK,CAAC;IACd,CAAC;IAED,4BAA4B;IAC5B,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,+DAA+D;QAC/D,uCAAuC;QACvC,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IAED,mCAAmC;IACnC,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAE9B,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;YAC9D,+CAA+C;YAC/C,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnC,2DAA2D;gBAC3D,mDAAmD;gBACnD,uDAAuD;gBACvD,OAAO,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YACzC,CAAC;YAED,qBAAqB;YACrB,OAAO,QAAQ,KAAK,aAAa,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,EAAE,CAAC;YACtB,MAAM,IAAI,iBAAiB,CAC1B,WAAW,QAAQ,0CAA0C,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAC/F,qGAAqG,CAAC,CAAC;QACzG,CAAC;IACF,CAAC;IAED,wCAAwC;IACxC,OAAO,IAAI,CAAC;AACb,CAAC;AAAA,CAAC"}

package/lib/tools/create_ui5_app/schema.d.ts

@@ -0,0 +1,135 @@
+import z from "zod";
+import { Ui5Framework } from "../../utils/ui5Framework.js";
+export declare const createAppSchema: {
+    appNamespace: z.ZodString;
+    basePath: z.ZodString;
+    createAppDirectory: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    framework: z.ZodDefault<z.ZodOptional<z.ZodEnum<["OpenUI5", "SAPUI5"]>>>;
+    frameworkVersion: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    oDataV4Url: z.ZodOptional<z.ZodString>;
+    oDataEntitySet: z.ZodOptional<z.ZodString>;
+    entityProperties: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    initializeGitRepository: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    runNpmInstall: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    typescript: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+};
+export declare const createAppSchemaObject: z.ZodObject<{
+    appNamespace: z.ZodString;
+    basePath: z.ZodString;
+    createAppDirectory: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    framework: z.ZodDefault<z.ZodOptional<z.ZodEnum<["OpenUI5", "SAPUI5"]>>>;
+    frameworkVersion: z.ZodOptional<z.ZodString>;
+    author: z.ZodOptional<z.ZodString>;
+    oDataV4Url: z.ZodOptional<z.ZodString>;
+    oDataEntitySet: z.ZodOptional<z.ZodString>;
+    entityProperties: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    initializeGitRepository: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    runNpmInstall: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    typescript: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    appNamespace: string;
+    basePath: string;
+    createAppDirectory: boolean;
+    framework: "OpenUI5" | "SAPUI5";
+    initializeGitRepository: boolean;
+    runNpmInstall: boolean;
+    typescript: boolean;
+    frameworkVersion?: string | undefined;
+    author?: string | undefined;
+    oDataV4Url?: string | undefined;
+    oDataEntitySet?: string | undefined;
+    entityProperties?: string[] | undefined;
+}, {
+    appNamespace: string;
+    basePath: string;
+    createAppDirectory?: boolean | undefined;
+    framework?: "OpenUI5" | "SAPUI5" | undefined;
+    frameworkVersion?: string | undefined;
+    author?: string | undefined;
+    oDataV4Url?: string | undefined;
+    oDataEntitySet?: string | undefined;
+    entityProperties?: string[] | undefined;
+    initializeGitRepository?: boolean | undefined;
+    runNpmInstall?: boolean | undefined;
+    typescript?: boolean | undefined;
+}>;
+/**
+ * Parameters for creating a basic UI5 application.
+ *
+ * @typedef {Object} CreateUi5AppParams
+ * @property {string} appNamespace - The namespace for the application, e.g. com.myorg.myapp. Only lowercase
+ * 						alpha-numeric characters, underscores and dots are allowed.
+ * @property {string} basePath - Absolute base path for the creation. The application will be created either
+ * 						immediately inside this path or in a subdirectory (its name equals the
+ * 						application namespace) depending on the 'createAppDirectory' parameter.
+ * 						This path must be absolute, not just 'app' or '.' or './something'!
+ * @property {boolean} [createAppDirectory] - Whether to create a new directory (name equals the application namespace)
+ * 						inside the base path. Set this to 'false' when you want to place the application directly
+ * 						in the given base path. In SAP CAP applications, typically give the path to the "app" folder
+ * 						as basePath and set this to 'true' to create an application folder. Default: true.
+ * @property {string} [framework] - The framework to use (OpenUI5 or SAPUI5), defaults to SAPUI5.
+ * @property {string} [frameworkVersion] - The framework version to use, e.g. 1.136.0,
+ * 						defaults to the latest version.
+ * @property {string} [author] - The author of the application (auto-detected if not provided).
+ * @property {string} [oDataV4Url] - URL of an OData V4 service, if applicable. This is entirely optional, but without
+ * 						it, the generated app UI will have no OData Model configured. Setting an URL will configure an
+ *  					OData V4 model in the application. Only works for OData V4 services, not for OData V2.
+ * 						The URL must be either a valid complete URL starting with http:// or https:// or a
+ * 						server-root-relative URL like '/odata/v4/serviceName' when the OData service is running on
+ * 						the same server. In this case, the prefix 'http://localhost:4004/' will be assumed and used
+ * 						by this tool for inquiries about the service. When the port is not 4004, a complete
+ * 						'http://localhost:<port>...' URL must be provided. In the generated application, any
+ * 						'http://localhost:<port>' prefix will be removed.
+ * @property {string} [oDataEntitySet] - Entity set of the OData V4 service to display. Only has an effect when
+ * 						'oDataV4Url' is set as well. This is optional. Setting an entity set will configure a basic
+ * 						UI displaying the entity set in the application.
+ * @property {string[]} [entityProperties] - Properties of the OData entity set to display. Only has an effect when
+ * 						'oDataV4Url' and 'oDataEntitySet' are set. This parameter is optional, but useful to display
+ * 						initial data, when the names of existing properties are known. If not provided and the service
+ * 						is active and reachable at tool execution time, some random properties will be displayed.
+ * @property {boolean} [runNpmInstall] - Whether to execute npm install after creating the application.
+ * 						Default: true.
+ * @property {boolean} [initializeGitRepository] - Whether to initialize a local git repository for the application.
+ * 						Default: true.
+ * @property {boolean} [typescript] - Whether to create a TypeScript application (true) or JavaScript
+ * 						application (false). Default: true.
+ */
+export type CreateUi5AppParams = z.input<typeof createAppSchemaObject>;
+/**
+ * Result of the createUi5App function.
+ *
+ * @typedef {Object} CreateUi5AppResult
+ * @property {string} message - Basic success/error message only.
+ * @property {string} finalLocation - Final location (app root directory) of the created application (if successful).
+ * @property {string[]} generatedFiles - Array of generated file paths relative to finalLocation.
+ * @property {string} basePath - Absolute base path used for creation.
+ * @property {Object} [appInfo] - Structured app information.
+ * @property {string} appInfo.appNamespace - The namespace of the application.
+ * @property {Ui5Framework} appInfo.framework - The framework used for the application.
+ * @property {string} appInfo.frameworkVersion - The version of the framework used.
+ * @property {string} [appInfo.finalODataV4Url] - Final OData V4 service URL, if applicable.
+ * @property {string} [appInfo.oDataEntitySet] - OData entity set, if applicable.
+ * @property {string[]} [appInfo.entityProperties] - Properties of the OData entity set, if applicable.
+ * @property {boolean} appInfo.npmInstallExecuted - Whether 'npm install' was executed.
+ * @property {boolean} appInfo.gitInitialized - Whether a local git repository was initialized.
+ * @property {boolean} appInfo.typescript - Whether the application is a TypeScript application (true) or a JavaScript
+ * 	application (false).
+ */
+export interface CreateUi5AppResult {
+    message: string;
+    finalLocation: string;
+    generatedFiles: string[];
+    basePath: string;
+    appInfo?: {
+        appNamespace: string;
+        framework: Ui5Framework;
+        frameworkVersion: string;
+        finalODataV4Url?: string;
+        oDataEntitySet?: string;
+        entityProperties?: string[];
+        npmInstallExecuted: boolean;
+        gitInitialized: boolean;
+        typescript: boolean;
+    };
+}

package/lib/tools/create_ui5_app/schema.js

@@ -0,0 +1,67 @@
+import z from "zod";
+import { Ui5FrameworkSchema } from "../../utils/ui5Framework.js";
+export const createAppSchema = {
+    appNamespace: z.string()
+        .regex(/^[a-z0-9][a-z0-9_.]*$/, { message: `Only alphanumeric characters, underscores and dots are allowed.` })
+        .describe("The namespace for the application, e.g. com.myorg.myapp. " +
+        "Only lowercase alpha-numeric characters, underscores and dots are allowed."),
+    basePath: z.string()
+        .describe("Absolute base path for the creation. The application will be created either" +
+        " immediately inside this path or in a subdirectory (its name equals the" +
+        " application namespace), depending on the 'createAppDirectory' parameter." +
+        " This base path must be absolute, not just 'app' or '.' or './something'!"),
+    // NOTE: technically, this could be a relative path, but the current directory in MCP context is often
+    // not defined well, but is root (/)
+    createAppDirectory: z.boolean().optional().default(true)
+        .describe("Whether to create a new directory (name equals the application namespace)" +
+        " inside the base path. Set this to 'false' when you want to place the 'app' directly" +
+        " in the given base path. In SAP CAP applications, typically give the path to the 'app' folder" +
+        " as basePath and set this to 'true' to create an application folder. Default: true."),
+    framework: Ui5FrameworkSchema.optional().default("SAPUI5")
+        .describe("Framework to use (OpenUI5 or SAPUI5), defaults to SAPUI5"),
+    frameworkVersion: z.string()
+        .regex(/^\d+\.\d+\.\d+$/, { message: "Version must be in format X.Y.Z, e.g. 1.120.0" })
+        .optional()
+        .describe("Framework version, defaults to latest version. Omit this when in doubt." +
+        " When provided, it must be a concrete semantic version, like e.g. 1.136.0. Versions older than 1.96.0" +
+        " are not supported."),
+    author: z.string()
+        .regex(/^[a-zA-Z0-9 .,'@_-]+$/, { message: "Only alphanumeric characters, space, and .,'-@_ are allowed." })
+        .optional()
+        .describe("Author of the application (auto-detected if not provided)"),
+    oDataV4Url: z.string()
+        .optional()
+        .describe("URL of an OData V4 service, if applicable. This is entirely optional, but without it," +
+        " the generated app UI will have no OData Model configured. Setting an URL will configure an" +
+        " OData V4 model in the application. Only works for OData V4 services, not for OData V2." +
+        " The URL must be either a valid complete URL starting with http:// or https:// or a" +
+        " server-root-relative URL like '/odata/v4/serviceName' when the OData service is running on" +
+        " the same server. In this case, the prefix 'http://localhost:4004/' will be assumed and used" +
+        " by this tool for inquiries about the service. When the port is not 4004, a complete" +
+        " 'http://localhost:<port>...' URL must be provided. In the generated application, any" +
+        " 'http://localhost:<port>' prefix will be removed. HINT: when the project is a SAP CAP project" +
+        " and CAP/CDS tools are available, you **MUST** use them to search for OData services and entities" +
+        " and properties **BEFORE** calling this tool. This will help you find the correct service URL."),
+    oDataEntitySet: z.string()
+        .regex(/^[a-zA-Z0-9_]+$/, { message: "Only alphanumeric characters and underscore are allowed." })
+        .optional()
+        .describe("Entity set of the OData V4 service to display. Only has an effect when 'oDataV4Url' is set as" +
+        " well. This is optional, but setting an entity set is beneficial, as it will configure a basic UI" +
+        " in the application which displays the entity set."),
+    entityProperties: z.array(z.string().regex(/^[a-zA-Z0-9_]+$/, { message: "Only alphanumeric characters and underscore are allowed." })).optional()
+        .describe("Properties of the OData entity set to display. Only has an effect when 'oDataV4Url' and" +
+        "'oDataEntitySet' are set. This parameter is optional, but useful to display initial data, when the" +
+        " names of existing properties are known. If not provided and the service is active and reachable at" +
+        " tool execution time, some random properties will be displayed."),
+    initializeGitRepository: z.boolean().optional().default(true)
+        .describe("Initialize a local git repository for the application, default is 'true'"),
+    runNpmInstall: z.boolean().optional().default(true)
+        .describe("Execute npm install after creating the application, default is 'true'"),
+    typescript: z.boolean().optional().default(true)
+        .describe("Whether to create a TypeScript application (true) or JavaScript application (false)," +
+        " default is 'true'. Although the default is preferred, the user MUST know about" +
+        " this option before generation, but you should not require an active decision. Also, if an overall" +
+        " project already exists, this should influence the language choice to keep things consistent."),
+};
+export const createAppSchemaObject = z.object(createAppSchema);
+//# sourceMappingURL=schema.js.map