@sap-ux/project-input-validator 0.3.1 → 0.3.2

package/dist/adp/validators.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Validates a value for duplication in existing change files.
+ *
+ * @param value The value to check for duplication.
+ * @param propertyName The property name in the change file objects to check.
+ * @param changeFiles The list of existing change files to check against.
+ * @returns {boolean} Returns true if a content duplication is found and false if there is no content duplication.
+ */
+export declare function hasContentDuplication(value: string, propertyName: string, changeFiles: {
+    content: object;
+}[]): boolean;
+/**
+ * Validates a value for starting with a customer prefix.
+ *
+ * @param value The value to validate.
+ * @returns {boolean} True if the value starts with 'customer.' and false if it does not.
+ */
+export declare function hasCustomerPrefix(value: string): boolean;
+/**
+ * Validates if a value is a valid data source URI.
+ *
+ * @param uri The URI to validate.
+ * @returns {boolean} True if the URI is valid, false if it is not.
+ */
+export declare function isDataSourceURI(uri: string): boolean;
+//# sourceMappingURL=validators.d.ts.map

package/dist/adp/validators.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDataSourceURI = exports.hasCustomerPrefix = exports.hasContentDuplication = void 0;
+/**
+ * Validates a value for duplication in existing change files.
+ *
+ * @param value The value to check for duplication.
+ * @param propertyName The property name in the change file objects to check.
+ * @param changeFiles The list of existing change files to check against.
+ * @returns {boolean} Returns true if a content duplication is found and false if there is no content duplication.
+ */
+function hasContentDuplication(value, propertyName, changeFiles) {
+    return changeFiles.some(({ content }) => {
+        const contentProperty = content[propertyName];
+        return contentProperty && Object.keys(contentProperty).includes(value);
+    });
+}
+exports.hasContentDuplication = hasContentDuplication;
+/**
+ * Validates a value for starting with a customer prefix.
+ *
+ * @param value The value to validate.
+ * @returns {boolean} True if the value starts with 'customer.' and false if it does not.
+ */
+function hasCustomerPrefix(value) {
+    return value.toLowerCase().startsWith('customer.');
+}
+exports.hasCustomerPrefix = hasCustomerPrefix;
+/**
+ * Validates if a value is a valid data source URI.
+ *
+ * @param uri The URI to validate.
+ * @returns {boolean} True if the URI is valid, false if it is not.
+ */
+function isDataSourceURI(uri) {
+    return /^(?!.*\/\/)\/([^\s]*)\/$/.test(uri);
+}
+exports.isDataSourceURI = isDataSourceURI;
+//# sourceMappingURL=validators.js.map

package/dist/general/validators.d.ts

@@ -12,4 +12,33 @@ export declare function validateClient(client: string): boolean | string;
  * @returns true or error message
  */
 export declare function validateUrl(input: string): boolean | string;
+/**
+ * Validate input is not empty string.
+ *
+ * @param input input string to be validated
+ * @returns true or error message
+ */
+export declare function validateEmptyString(input: string): boolean | string;
+/**
+ * Validate input does not contain any whitespace characters.
+ *
+ * @param value The string to check for whitespace characters.
+ * @returns true or error message
+ */
+export declare function validateEmptySpaces(value: string): boolean | string;
+/**
+ * Validate input is valid JSON.
+ *
+ * @param value The string to test.
+ * @returns true or error message
+ */
+export declare function validateJSON(value: string): boolean | string;
+/**
+ * Validates a value for special characters.
+ *
+ * @param value The value to validate.
+ * @param regexp The regex expression for allowed special characters.
+ * @returns {boolean} True if validation passes, or an error message if validation fails.
+ */
+export declare function validateSpecialChars(value: string, regexp?: string): boolean | string;
 //# sourceMappingURL=validators.d.ts.map

package/dist/general/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateUrl = exports.validateClient = void 0;
+exports.validateSpecialChars = exports.validateJSON = exports.validateEmptySpaces = exports.validateEmptyString = exports.validateUrl = exports.validateClient = void 0;
 const i18n_1 = require("../i18n");
 /**
  * SAP client number is either empty or 3 digit string.
@@ -35,4 +35,62 @@ function validateUrl(input) {
     }
 }
 exports.validateUrl = validateUrl;
+/**
+ * Validate input is not empty string.
+ *
+ * @param input input string to be validated
+ * @returns true or error message
+ */
+function validateEmptyString(input) {
+    const formattedInput = input?.trim() || '';
+    if (formattedInput.trim().length > 0) {
+        return true;
+    }
+    return (0, i18n_1.t)('general.inputCannotBeEmpty');
+}
+exports.validateEmptyString = validateEmptyString;
+/**
+ * Validate input does not contain any whitespace characters.
+ *
+ * @param value The string to check for whitespace characters.
+ * @returns true or error message
+ */
+function validateEmptySpaces(value) {
+    if (/\s/.test(value)) {
+        return (0, i18n_1.t)('general.inputCannotHaveSpaces');
+    }
+    return true;
+}
+exports.validateEmptySpaces = validateEmptySpaces;
+/**
+ * Validate input is valid JSON.
+ *
+ * @param value The string to test.
+ * @returns true or error message
+ */
+function validateJSON(value) {
+    try {
+        JSON.parse(`{${value}}`);
+        return true;
+    }
+    catch {
+        return (0, i18n_1.t)('general.invalidJSON');
+    }
+}
+exports.validateJSON = validateJSON;
+/**
+ * Validates a value for special characters.
+ *
+ * @param value The value to validate.
+ * @param regexp The regex expression for allowed special characters.
+ * @returns {boolean} True if validation passes, or an error message if validation fails.
+ */
+function validateSpecialChars(value, regexp = '^[a-zA-Z0-9_$.\\-]+$') {
+    const regex = new RegExp(regexp, 'g');
+    if (regex.test(value)) {
+        return true;
+    }
+    return (0, i18n_1.t)('general.invalidValueForSpecialChars');
+}
+exports.validateSpecialChars = validateSpecialChars;
 //# sourceMappingURL=validators.js.map

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './deploy/validators';
 export * from './ui5/validators';
 export * from './general/validators';
+export * from './adp/validators';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./deploy/validators"), exports);
 __exportStar(require("./ui5/validators"), exports);
 __exportStar(require("./general/validators"), exports);
+__exportStar(require("./adp/validators"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -44,6 +44,10 @@
     },
     "general": {
         "invalidUrl": "Invalid URL: [{{-input}}]",
-        "invalidClient": "[{{client}}] is invalid. Leave empty or enter value between 000-999"
+        "invalidClient": "[{{client}}] is invalid. Leave empty or enter value between 000-999",
+        "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 '.'"
     }
 }

package/package.json

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