@sap-ux/project-input-validator 0.3.3 → 0.3.4

package/dist/adp/validators.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isDataSourceURI = exports.hasCustomerPrefix = exports.hasContentDuplication = void 0;
+exports.hasContentDuplication = hasContentDuplication;
+exports.hasCustomerPrefix = hasCustomerPrefix;
+exports.isDataSourceURI = isDataSourceURI;
 /**
  * Validates a value for duplication in existing change files.
  *
@@ -15,7 +17,6 @@ function hasContentDuplication(value, propertyName, changeFiles) {
         return contentProperty && Object.keys(contentProperty).includes(value);
     });
 }
-exports.hasContentDuplication = hasContentDuplication;
 /**
  * Validates a value for starting with a customer prefix.
  *
@@ -25,7 +26,6 @@ exports.hasContentDuplication = hasContentDuplication;
 function hasCustomerPrefix(value) {
     return value.toLowerCase().startsWith('customer.');
 }
-exports.hasCustomerPrefix = hasCustomerPrefix;
 /**
  * Validates if a value is a valid data source URI.
  *
@@ -35,5 +35,4 @@ exports.hasCustomerPrefix = hasCustomerPrefix;
 function isDataSourceURI(uri) {
     return /^(?!.*\/\/)\/([^\s]*)\/$/.test(uri);
 }
-exports.isDataSourceURI = isDataSourceURI;
 //# sourceMappingURL=validators.js.map

package/dist/deploy/validators.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePackage = exports.validateTransportRequestNumber = exports.validateAppDescription = exports.validateAppName = void 0;
+exports.validateAppName = validateAppName;
+exports.validateAppDescription = validateAppDescription;
+exports.validateTransportRequestNumber = validateTransportRequestNumber;
+exports.validatePackage = validatePackage;
 const i18n_1 = require("../i18n");
 const os_1 = require("os");
 /**
@@ -46,7 +49,6 @@ function validateAppName(name, prefix) {
     }
     return processErrorMessages(errorMessages);
 }
-exports.validateAppName = validateAppName;
 /**
  * Helper function to format an array of error messages to a single string.
  *
@@ -79,7 +81,6 @@ function validateAppDescription(description) {
         return true;
     }
 }
-exports.validateAppDescription = validateAppDescription;
 /**
  * Transport request number is not required for local package.
  *
@@ -96,7 +97,6 @@ function validateTransportRequestNumber(transportRequest, packageName) {
         return true;
     }
 }
-exports.validateTransportRequestNumber = validateTransportRequestNumber;
 /**
  * Validate package name cannot be empty.
  *
@@ -111,5 +111,4 @@ function validatePackage(input) {
         return true;
     }
 }
-exports.validatePackage = validatePackage;
 //# sourceMappingURL=validators.js.map

package/dist/flp/validators.d.ts

@@ -0,0 +1,13 @@
+import type { AllowedCharacters } from '../general/validators';
+/**
+ * Validates that text input does not have zero length and optionally is less than the specified maximum length.
+ * Returns an end user message if validation fails.
+ *
+ * @param input the text input to validate
+ * @param isCLI indicates if the platform is CLI
+ * @param maxLength optional, the maximum length of text to allow
+ * @param allowedCharacters optional, define a list of special characters that should be allowed in the input field
+ * @returns true, if all validation checks pass or a message explaining the validation failure
+ */
+export declare function validateText(input: string, isCLI: boolean, maxLength?: number, allowedCharacters?: AllowedCharacters[]): boolean | string;
+//# sourceMappingURL=validators.d.ts.map

package/dist/flp/validators.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateText = validateText;
+const i18n_1 = require("../i18n");
+const validators_1 = require("../general/validators");
+/**
+ * Validates that text input does not have zero length and optionally is less than the specified maximum length.
+ * Returns an end user message if validation fails.
+ *
+ * @param input the text input to validate
+ * @param isCLI indicates if the platform is CLI
+ * @param maxLength optional, the maximum length of text to allow
+ * @param allowedCharacters optional, define a list of special characters that should be allowed in the input field
+ * @returns true, if all validation checks pass or a message explaining the validation failure
+ */
+function validateText(input, isCLI, maxLength = 0, allowedCharacters) {
+    const trimmedInput = input ? input.trim() : '';
+    const length = trimmedInput.length;
+    if (!length) {
+        if (isCLI) {
+            return (0, i18n_1.t)('general.inputCannotBeEmpty');
+        }
+        return false;
+    }
+    const maxLengthValidation = (0, validators_1.validateMaxLength)(input, maxLength);
+    if (typeof maxLengthValidation === 'string') {
+        return maxLengthValidation;
+    }
+    const allowedCharsValidation = (0, validators_1.validateAllowedCharacters)(input, allowedCharacters);
+    if (typeof allowedCharsValidation === 'string') {
+        return allowedCharsValidation;
+    }
+    return true;
+}
+//# sourceMappingURL=validators.js.map

package/dist/general/validators.d.ts

@@ -1,3 +1,4 @@
+export type AllowedCharacters = '_';
 /**
  * SAP client number is either empty or 3 digit string.
  *
@@ -26,6 +27,22 @@ export declare function validateEmptyString(input: string): boolean | string;
  * @returns true or error message
  */
 export declare function validateEmptySpaces(value: string): boolean | string;
+/**
+ * Validates that the given string does not exceed the specified maximum length.
+ *
+ * @param {string} value - The string value to validate.
+ * @param {number} [maxLength] - The maximum allowed length of the string. If 0 or not provided, no length validation is performed.
+ * @returns {boolean | string} Returns `true` if the validation passes, or an error message string if it fails.
+ */
+export declare function validateMaxLength(value: string, maxLength?: number): boolean | string;
+/**
+ * Validates whether the input contains only alphanumeric characters and allowed special characters.
+ *
+ * @param {string} value - The input string to validate.
+ * @param {string[]} allowedCharacters - An array of allowed special characters.
+ * @returns {boolean | string} Returns `true` if validation passes, or an error message string if validation fails.
+ */
+export declare function validateAllowedCharacters(value: string, allowedCharacters?: AllowedCharacters[]): boolean | string;
 /**
  * Validate input is valid JSON.
  *

package/dist/general/validators.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSpecialChars = exports.validateJSON = exports.validateEmptySpaces = exports.validateEmptyString = exports.validateUrl = exports.validateClient = void 0;
+exports.validateClient = validateClient;
+exports.validateUrl = validateUrl;
+exports.validateEmptyString = validateEmptyString;
+exports.validateEmptySpaces = validateEmptySpaces;
+exports.validateMaxLength = validateMaxLength;
+exports.validateAllowedCharacters = validateAllowedCharacters;
+exports.validateJSON = validateJSON;
+exports.validateSpecialChars = validateSpecialChars;
 const i18n_1 = require("../i18n");
 /**
  * SAP client number is either empty or 3 digit string.
@@ -18,7 +25,6 @@ function validateClient(client) {
         return (0, i18n_1.t)('general.invalidClient', { client });
     }
 }
-exports.validateClient = validateClient;
 /**
  * Validate url input is valid url format.
  *
@@ -34,7 +40,6 @@ function validateUrl(input) {
         return (0, i18n_1.t)('general.invalidUrl', { input });
     }
 }
-exports.validateUrl = validateUrl;
 /**
  * Validate input is not empty string.
  *
@@ -48,7 +53,6 @@ function validateEmptyString(input) {
     }
     return (0, i18n_1.t)('general.inputCannotBeEmpty');
 }
-exports.validateEmptyString = validateEmptyString;
 /**
  * Validate input does not contain any whitespace characters.
  *
@@ -61,7 +65,39 @@ function validateEmptySpaces(value) {
     }
     return true;
 }
-exports.validateEmptySpaces = validateEmptySpaces;
+/**
+ * Validates that the given string does not exceed the specified maximum length.
+ *
+ * @param {string} value - The string value to validate.
+ * @param {number} [maxLength] - The maximum allowed length of the string. If 0 or not provided, no length validation is performed.
+ * @returns {boolean | string} Returns `true` if the validation passes, or an error message string if it fails.
+ */
+function validateMaxLength(value, maxLength = 0) {
+    if (maxLength > 0 && value.length > maxLength) {
+        return (0, i18n_1.t)('general.maxLength', { maxLength });
+    }
+    return true;
+}
+/**
+ * Validates whether the input contains only alphanumeric characters and allowed special characters.
+ *
+ * @param {string} value - The input string to validate.
+ * @param {string[]} allowedCharacters - An array of allowed special characters.
+ * @returns {boolean | string} Returns `true` if validation passes, or an error message string if validation fails.
+ */
+function validateAllowedCharacters(value, allowedCharacters) {
+    // Asterisks is supported for the semantic object and action field but not the inbound title
+    if (allowedCharacters && allowedCharacters.length > 0) {
+        const escapedChars = allowedCharacters.map((char) => `\\${char}`).join('');
+        const regex = new RegExp(`^[a-zA-Z0-9${escapedChars}]+$`);
+        if (!regex.test(value)) {
+            return (0, i18n_1.t)('general.supportedFormats', {
+                allowedCharacters: allowedCharacters.join('')
+            });
+        }
+    }
+    return true;
+}
 /**
  * Validate input is valid JSON.
  *
@@ -77,7 +113,6 @@ function validateJSON(value) {
         return (0, i18n_1.t)('general.invalidJSON');
     }
 }
-exports.validateJSON = validateJSON;
 /**
  * Validates a value for special characters.
  *
@@ -92,5 +127,4 @@ function validateSpecialChars(value, regexp = '^[a-zA-Z0-9_$.\\-]+$') {
     }
     return (0, i18n_1.t)('general.invalidValueForSpecialChars');
 }
-exports.validateSpecialChars = validateSpecialChars;
 //# sourceMappingURL=validators.js.map

package/dist/i18n.d.ts

@@ -1,5 +1,10 @@
 import type { TOptions } from 'i18next';
 export declare const PROJECT_INPUT_VALIDATOR_NS = "project-input-validator";
+/**
+ * Adds the `project-input-validator` resource bundle to i18next.
+ * May be required to load i18n translations after initialising in the consumer module.
+ */
+export declare function addi18nResourceBundle(): void;
 /**
  * Initialize i18next with the translations for this module.
  */

package/dist/i18n.js

@@ -3,17 +3,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.initI18nProjectValidators = exports.PROJECT_INPUT_VALIDATOR_NS = void 0;
+exports.PROJECT_INPUT_VALIDATOR_NS = void 0;
+exports.addi18nResourceBundle = addi18nResourceBundle;
+exports.initI18nProjectValidators = initI18nProjectValidators;
+exports.t = t;
 const i18next_1 = __importDefault(require("i18next"));
 const project_input_validator_i18n_json_1 = __importDefault(require("./translations/project-input-validator.i18n.json"));
 exports.PROJECT_INPUT_VALIDATOR_NS = 'project-input-validator';
+/**
+ * Adds the `project-input-validator` resource bundle to i18next.
+ * May be required to load i18n translations after initialising in the consumer module.
+ */
+function addi18nResourceBundle() {
+    i18next_1.default.addResourceBundle('en', exports.PROJECT_INPUT_VALIDATOR_NS, project_input_validator_i18n_json_1.default);
+}
 /**
  * Initialize i18next with the translations for this module.
  */
 async function initI18nProjectValidators() {
-    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', exports.PROJECT_INPUT_VALIDATOR_NS, project_input_validator_i18n_json_1.default));
+    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' });
+    addi18nResourceBundle();
 }
-exports.initI18nProjectValidators = initI18nProjectValidators;
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *
@@ -27,7 +37,6 @@ function t(key, options) {
     }
     return i18next_1.default.t(key, options);
 }
-exports.t = t;
 initI18nProjectValidators().catch(() => {
     // needed by lint
 });

package/dist/index.d.ts

@@ -2,4 +2,6 @@ export * from './deploy/validators';
 export * from './ui5/validators';
 export * from './general/validators';
 export * from './adp/validators';
+export * from './flp/validators';
+export { addi18nResourceBundle } from './i18n';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,8 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.addi18nResourceBundle = void 0;
 __exportStar(require("./deploy/validators"), exports);
 __exportStar(require("./ui5/validators"), exports);
 __exportStar(require("./general/validators"), exports);
 __exportStar(require("./adp/validators"), exports);
+__exportStar(require("./flp/validators"), exports);
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "addi18nResourceBundle", { enumerable: true, get: function () { return i18n_1.addi18nResourceBundle; } });
 //# sourceMappingURL=index.js.map

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

@@ -48,6 +48,8 @@
         "inputCannotBeEmpty": "Input cannot be empty.",
         "inputCannotHaveSpaces": "Input cannot contain spaces.",
         "invalidJSON": "Invalid JSON",
-        "invalidValueForSpecialChars": "Input must contain only Latin alphanumeric characters or the following symbols: '-','_','$' and '.'"
+        "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"
     }
 }

package/dist/ui5/validators.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateModuleName = exports.validateProjectFolder = exports.validateLibModuleName = exports.validateNamespace = void 0;
+exports.validateNamespace = validateNamespace;
+exports.validateLibModuleName = validateLibModuleName;
+exports.validateProjectFolder = validateProjectFolder;
+exports.validateModuleName = validateModuleName;
 const path_1 = require("path");
 const i18n_1 = require("../i18n");
 const fs_1 = require("fs");
@@ -62,7 +65,6 @@ function validateNamespace(namespace, moduleName, allowUnderscore = true) {
     }
     return validateNamespacePattern(namespace, moduleName, allowUnderscore);
 }
-exports.validateNamespace = validateNamespace;
 /**
  * Validator: UI5 library module name.
  *
@@ -79,7 +81,6 @@ function validateLibModuleName(libName) {
     }
     return true;
 }
-exports.validateLibModuleName = validateLibModuleName;
 /**
  * Validator: UI5 project directory can be used to create a UI5 application.
  *
@@ -104,7 +105,6 @@ function validateProjectFolder(targetFolder, projectName) {
         return (0, i18n_1.t)('ui5.enterProjectFolder');
     }
 }
-exports.validateProjectFolder = validateProjectFolder;
 /**
  * Validator: UI5 package json module name validator. Validates a module name accoding to npm package rules and some additional UI5 specific rules.
  *
@@ -148,7 +148,6 @@ function validateModuleName(moduleName) {
         .map((msg) => messageMap[msg] ?? (0, i18n_1.t)('ui5.invalidModuleName'))
         .join(', ');
 }
-exports.validateModuleName = validateModuleName;
 /**
  * Test for existence of specified directory path.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-input-validator",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Library to validate Fiori project input formats",
   "repository": {
     "type": "git",