@sap-ux/project-input-validator 0.6.1 → 0.6.3

package/dist/{ui5 → general}/project-path-validators.d.ts

@@ -1,22 +1,25 @@
 /**
- * Validates whether the specified target path is suitable for creating a Fiori App project.
+ * Validates whether the specified target path is suitable for creating an SAP Fiori project App project.
  * The function performs the following checks:
  *
  * 1. **CAP Project Check:** If `validateFioriAppFolder` is true, it checks if the target path is part of an existing CAP project.
  *    - Uses `findCapProjectRoot()` and `getCapProjectType()` to verify the presence of a CAP project.
  *    - Returns an error message if a CAP project is detected.
  *
- * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains a Fiori project.
- *    - Uses `findRootsForPath()` to determine if a Fiori application root exists.
- *    - Returns a success message if a valid Fiori app root is found, otherwise returns true.
+ * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains an SAP Fiori project.
+ *    - Uses `findRootsForPath()` to determine if an SAP Fiori project application root exists.
+ *    - Returns a success message if a valid SAP Fiori app root is found, otherwise returns true.
  *
  * 3. **General Project Folder Check:**
  *    - Uses `validateProjectFolder()` to verify if the provided target path exists.
  *    - Ensures the target folder does not already contain a subfolder with the intended project name.
  *
- * @param targetPath - The target directory path where the Fiori app is to be created.
+ * 4. **Windows Path Length Validation:**
+ *   - Validates the combined path length of the target directory and application name against the Windows max path length limit (256 characters).
+ *
+ * @param targetPath - The target directory path where the SAP Fiori app is to be created.
  * @param appName - The application directory name.
- * @param validateFioriAppFolder - If true, validates the target path as a Fiori App project folder.
+ * @param validateFioriAppFolder - If true, validates the target path as an SAP Fiori App project folder.
  * @returns A boolean value `true` if all validations pass; otherwise, an error message.
  */
 export declare function validateFioriAppTargetFolder(targetPath: string, appName: string, validateFioriAppFolder?: boolean): Promise<string | boolean>;

package/dist/{ui5 → general}/project-path-validators.js

@@ -2,20 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateFioriAppTargetFolder = validateFioriAppTargetFolder;
 const project_access_1 = require("@sap-ux/project-access");
-const validators_1 = require("./validators");
+const path_1 = require("path");
 const i18n_1 = require("../i18n");
+const validators_1 = require("../ui5/validators");
+const validators_2 = require("./validators");
 /**
- * Returns true if the specified target path does not contain a Fiori project.
+ * Returns true if the specified target path does not contain an SAP Fiori project.
  *
  * @param targetDir the target directory path.
- * @returns true, if not Fiori Project, or string message indicating that the path contains a Fiori project.
+ * @returns true, if not Fiori Project, or string message indicating that the path contains an SAP Fiori project.
  */
 async function validateFioriAppProjectFolder(targetDir) {
     // Check if the target directory contains a CAP project
     if (!!(await (0, project_access_1.findCapProjectRoot)(targetDir, false)) || !!(await (0, project_access_1.getCapProjectType)(targetDir))) {
         return (0, i18n_1.t)('ui5.folderContainsCapApp');
     }
-    // Check if the target directory contains a Fiori project
+    // Check if the target directory contains an SAP Fiori project
     const appRoot = await (0, project_access_1.findRootsForPath)(targetDir);
     if (appRoot) {
         return (0, i18n_1.t)('ui5.folderContainsFioriApp', { path: appRoot.appRoot });
@@ -25,24 +27,27 @@ async function validateFioriAppProjectFolder(targetDir) {
     }
 }
 /**
- * Validates whether the specified target path is suitable for creating a Fiori App project.
+ * Validates whether the specified target path is suitable for creating an SAP Fiori project App project.
  * The function performs the following checks:
  *
  * 1. **CAP Project Check:** If `validateFioriAppFolder` is true, it checks if the target path is part of an existing CAP project.
  *    - Uses `findCapProjectRoot()` and `getCapProjectType()` to verify the presence of a CAP project.
  *    - Returns an error message if a CAP project is detected.
  *
- * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains a Fiori project.
- *    - Uses `findRootsForPath()` to determine if a Fiori application root exists.
- *    - Returns a success message if a valid Fiori app root is found, otherwise returns true.
+ * 2. **Fiori App Project Check:** If `validateFioriAppFolder` is true, it checks if the target path contains an SAP Fiori project.
+ *    - Uses `findRootsForPath()` to determine if an SAP Fiori project application root exists.
+ *    - Returns a success message if a valid SAP Fiori app root is found, otherwise returns true.
  *
  * 3. **General Project Folder Check:**
  *    - Uses `validateProjectFolder()` to verify if the provided target path exists.
  *    - Ensures the target folder does not already contain a subfolder with the intended project name.
  *
- * @param targetPath - The target directory path where the Fiori app is to be created.
+ * 4. **Windows Path Length Validation:**
+ *   - Validates the combined path length of the target directory and application name against the Windows max path length limit (256 characters).
+ *
+ * @param targetPath - The target directory path where the SAP Fiori app is to be created.
  * @param appName - The application directory name.
- * @param validateFioriAppFolder - If true, validates the target path as a Fiori App project folder.
+ * @param validateFioriAppFolder - If true, validates the target path as an SAP Fiori App project folder.
  * @returns A boolean value `true` if all validations pass; otherwise, an error message.
  */
 async function validateFioriAppTargetFolder(targetPath, appName, validateFioriAppFolder) {
@@ -56,6 +61,11 @@ async function validateFioriAppTargetFolder(targetPath, appName, validateFioriAp
     if (isProjectValid !== true) {
         return isProjectValid;
     }
+    // Windows path length validation
+    const winPathResult = (0, validators_2.validateWindowsPathLength)((0, path_1.join)(targetPath, appName), (0, i18n_1.t)(`general.windowsFolderPathTooLong`));
+    if (winPathResult !== true) {
+        return winPathResult;
+    }
     return true;
 }
 //# sourceMappingURL=project-path-validators.js.map

package/dist/general/validators.d.ts

@@ -58,4 +58,12 @@ export declare function validateJSON(value: string): boolean | string;
  * @returns {boolean} True if validation passes, or an error message if validation fails.
  */
 export declare function validateSpecialChars(value: string, regexp?: string): boolean | string;
+/**
+ * Checks if the combined Windows path length exceeds the default limit (256 characters).
+ *
+ * @param basePath The base path (e.g., target folder or mtaPath) + the name, ID, or additional segment to be appended
+ * @param errorMessage The error message to be returned if the path is too long. Use `{length}` as a placeholder for the actual length.
+ * @returns true if valid, or the error message if too long
+ */
+export declare function validateWindowsPathLength(basePath: string, errorMessage: string): true | string;
 //# sourceMappingURL=validators.d.ts.map

package/dist/general/validators.js

@@ -8,6 +8,7 @@ exports.validateMaxLength = validateMaxLength;
 exports.validateAllowedCharacters = validateAllowedCharacters;
 exports.validateJSON = validateJSON;
 exports.validateSpecialChars = validateSpecialChars;
+exports.validateWindowsPathLength = validateWindowsPathLength;
 const i18n_1 = require("../i18n");
 /**
  * SAP client number is either empty or 3 digit string.
@@ -127,4 +128,20 @@ function validateSpecialChars(value, regexp = '^[a-zA-Z0-9_$.\\-]+$') {
     }
     return (0, i18n_1.t)('general.invalidValueForSpecialChars');
 }
+/**
+ * Checks if the combined Windows path length exceeds the default limit (256 characters).
+ *
+ * @param basePath The base path (e.g., target folder or mtaPath) + the name, ID, or additional segment to be appended
+ * @param errorMessage The error message to be returned if the path is too long. Use `{length}` as a placeholder for the actual length.
+ * @returns true if valid, or the error message if too long
+ */
+function validateWindowsPathLength(basePath, errorMessage) {
+    if (process.platform === 'win32') {
+        const combinedLength = `${basePath}`.length;
+        if (combinedLength >= 256) {
+            return errorMessage.replace('{{length}}', combinedLength.toString());
+        }
+    }
+    return true;
+}
 //# sourceMappingURL=validators.js.map

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export * from './deploy/validators';
 export * from './ui5/validators';
-export * from './ui5/project-path-validators';
+export * from './general/project-path-validators';
 export * from './general/validators';
 export * from './adp/validators';
 export * from './flp/validators';

package/dist/index.js

@@ -17,7 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addi18nResourceBundle = void 0;
 __exportStar(require("./deploy/validators"), exports);
 __exportStar(require("./ui5/validators"), exports);
-__exportStar(require("./ui5/project-path-validators"), exports);
+__exportStar(require("./general/project-path-validators"), exports);
 __exportStar(require("./general/validators"), exports);
 __exportStar(require("./adp/validators"), exports);
 __exportStar(require("./flp/validators"), exports);

package/dist/translations/project-input-validator.i18n.json

@@ -42,8 +42,8 @@
         "invalidModuleName": "Invalid module name",
         "moduleAlreadyExists": "The module folder named: {{folderName}} already exists at the specified path",
         "appFolderExistsAtPath": "A module with this name already exists in the folder: {{-path}}",
-        "folderContainsFioriApp": "The project folder path already contains an SAP Fiori application in the folder: {{-path}}. Please choose a different folder and try again.",
-        "folderContainsCapApp": "The selected project folder is part of an existing CAP project. This application must therefore use the local CAP project as the data source."
+        "folderContainsCapApp": "The selected project folder is part of an existing CAP project. This application must therefore use the local CAP project as the data source.",
+        "folderContainsFioriApp": "The project folder path already contains an SAP Fiori application in the folder: {{-path}}. Please choose a different folder and try again."
     },
     "general": {
         "invalidUrl": "Invalid URL: [{{-input}}]",
@@ -53,7 +53,8 @@
         "invalidJSON": "Invalid JSON",
         "invalidValueForSpecialChars": "Input must contain only Latin alphanumeric characters or the following symbols: '-','_','$' and '.'",
         "maxLength": "Maximum length: {{maxLength}} characters",
-        "supportedFormats": "Only alphanumeric and '{{allowedCharacters}}' characters are allowed"
+        "supportedFormats": "Only alphanumeric and '{{allowedCharacters}}' characters are allowed",
+        "windowsFolderPathTooLong": "The combined length {{length}} of the target folder and module name exceeds the default Windows path length. This can cause issues with project generation."
     },
     "adp": {
         "projectNameUppercaseError": "The name cannot contain uppercase letters.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-input-validator",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Library to validate Fiori project input formats",
   "repository": {
     "type": "git",
@@ -16,7 +16,7 @@
   "dependencies": {
     "i18next": "23.5.1",
     "validate-npm-package-name": "5.0.0",
-    "@sap-ux/project-access": "1.30.1"
+    "@sap-ux/project-access": "1.30.2"
   },
   "devDependencies": {
     "@types/validate-npm-package-name": "4.0.1",