@sap-ux/project-input-validator 0.5.0 → 0.5.2

package/dist/adp/validators.d.ts

@@ -23,4 +23,46 @@ export declare function hasCustomerPrefix(value: string): boolean;
  * @returns {boolean} True if the URI is valid, false if it is not.
  */
 export declare function isDataSourceURI(uri: string): boolean;
+/**
+ * Validates that the project name is not empty and it is correct for VENDOR and CUSTOMER_BASE layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @param {boolean} isCustomerBase - Whether the layer is customer base.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+export declare function validateProjectName(value: string, destinationPath: string, isCustomerBase: boolean): boolean | string;
+/**
+ * Validates that project name is valid for CUSTOMER_BASE layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+export declare function validateProjectNameExternal(value: string, destinationPath: string): boolean | string;
+/**
+ * Validates that project name is valid for VENDOR layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+export declare function validateProjectNameInternal(value: string, destinationPath: string): boolean | string;
+/**
+ * Validates that project name is unique in directory.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If project with same name already exists return error message otherwise true.
+ */
+export declare function validateDuplicateProjectName(value: string, destinationPath: string): boolean | string;
+/**
+ * Validates that the project name is valid. Checks that it is not empty string and it is valid for CUSTOMER_BASE and VENDOR layers.
+ *
+ * @param {string} namespace - The project namespace.
+ * @param {string} projectName - The project name.
+ * @param {boolean} isCustomerBase - Whether the layer is customer base.
+ * @returns {string | boolean} If project namespace is valid returns true otherwise error message.
+ */
+export declare function validateNamespaceAdp(namespace: string, projectName: string, isCustomerBase: boolean): string | boolean;
 //# sourceMappingURL=validators.d.ts.map

package/dist/adp/validators.js

@@ -3,6 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasContentDuplication = hasContentDuplication;
 exports.hasCustomerPrefix = hasCustomerPrefix;
 exports.isDataSourceURI = isDataSourceURI;
+exports.validateProjectName = validateProjectName;
+exports.validateProjectNameExternal = validateProjectNameExternal;
+exports.validateProjectNameInternal = validateProjectNameInternal;
+exports.validateDuplicateProjectName = validateDuplicateProjectName;
+exports.validateNamespaceAdp = validateNamespaceAdp;
+const path_1 = require("path");
+const fs_1 = require("fs");
+const i18n_1 = require("../i18n");
+const validators_1 = require("../general/validators");
 /**
  * Validates a value for duplication in existing change files.
  *
@@ -35,4 +44,108 @@ function hasCustomerPrefix(value) {
 function isDataSourceURI(uri) {
     return /^(?!.*\/\/)\/([^\s]*)\/$/.test(uri);
 }
+const projectNamePattern = /^(\w\.\w|[a-zA-Z0-9]){1,61}$/;
+/**
+ * Validates that the project name is not empty and it is correct for VENDOR and CUSTOMER_BASE layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @param {boolean} isCustomerBase - Whether the layer is customer base.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+function validateProjectName(value, destinationPath, isCustomerBase) {
+    const validationResult = (0, validators_1.validateEmptyString)(value);
+    if (typeof validationResult === 'string') {
+        return validationResult;
+    }
+    if (/[A-Z]/.test(value)) {
+        return (0, i18n_1.t)('adp.projectNameUppercaseError');
+    }
+    if (!isCustomerBase) {
+        return validateProjectNameInternal(value, destinationPath);
+    }
+    else {
+        return validateProjectNameExternal(value, destinationPath);
+    }
+}
+/**
+ * Validates that project name is valid for CUSTOMER_BASE layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+function validateProjectNameExternal(value, destinationPath) {
+    if (value.length > 61 || value.toLocaleLowerCase().endsWith('component')) {
+        return (0, i18n_1.t)('adp.projectNameLengthErrorExt');
+    }
+    const projectNamePattern = /^(\w\.\w|[a-zA-Z0-9]){1,61}$/;
+    if (!projectNamePattern.test(value)) {
+        return (0, i18n_1.t)('adp.projectNameValidationErrorExt');
+    }
+    return validateDuplicateProjectName(value, destinationPath);
+}
+/**
+ * Validates that project name is valid for VENDOR layer.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If value is valid returns true otherwise error message.
+ */
+function validateProjectNameInternal(value, destinationPath) {
+    if (value.toLowerCase().startsWith('customer') ||
+        value.length > 61 ||
+        value.toLocaleLowerCase().endsWith('component')) {
+        return (0, i18n_1.t)('adp.projectNameLengthErrorInt');
+    }
+    if (!projectNamePattern.test(value)) {
+        return (0, i18n_1.t)('adp.projectNameValidationErrorInt');
+    }
+    return validateDuplicateProjectName(value, destinationPath);
+}
+/**
+ * Validates that project name is unique in directory.
+ *
+ * @param {string} value - The project name.
+ * @param {string} destinationPath - The project directory.
+ * @returns {string | boolean} If project with same name already exists return error message otherwise true.
+ */
+function validateDuplicateProjectName(value, destinationPath) {
+    if ((0, fs_1.existsSync)((0, path_1.join)(destinationPath, value))) {
+        return (0, i18n_1.t)('adp.duplicatedProjectName');
+    }
+    return true;
+}
+/**
+ * Validates that the project name is valid. Checks that it is not empty string and it is valid for CUSTOMER_BASE and VENDOR layers.
+ *
+ * @param {string} namespace - The project namespace.
+ * @param {string} projectName - The project name.
+ * @param {boolean} isCustomerBase - Whether the layer is customer base.
+ * @returns {string | boolean} If project namespace is valid returns true otherwise error message.
+ */
+function validateNamespaceAdp(namespace, projectName, isCustomerBase) {
+    const validationResult = (0, validators_1.validateEmptyString)(namespace);
+    if (typeof validationResult === 'string') {
+        return validationResult;
+    }
+    if (!isCustomerBase) {
+        if (namespace !== projectName) {
+            return (0, i18n_1.t)('adp.differentNamespaceThanProjectName');
+        }
+    }
+    else if (namespace.toLowerCase().startsWith('customer.') !== true) {
+        return (0, i18n_1.t)('adp.namespaceSameAsProjectNameError');
+    }
+    else {
+        namespace = namespace.slice('customer.'.length, namespace.length);
+    }
+    if (namespace.length > 61 || namespace.toLowerCase().endsWith('component') === true) {
+        return (0, i18n_1.t)('adp.namespaceLengthError');
+    }
+    else if (namespace !== '' && projectNamePattern.test(namespace) === false) {
+        return (0, i18n_1.t)('adp.namespaceValidationError');
+    }
+    return true;
+}
 //# sourceMappingURL=validators.js.map

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

@@ -54,5 +54,17 @@
         "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"
+    },
+    "adp": {
+        "projectNameUppercaseError": "The name cannot contain uppercase letters.",
+        "projectNameLengthErrorExt": "The name cannot contain more than 61 characters or end with the word 'component'.",
+        "projectNameValidationErrorExt": "The name must contain only latin alphanumeric characters. Different parts can be separated by a period and every part must start with a letter.",
+        "projectNameLengthErrorInt": "The name cannot start with the word 'customer', or contain more than 61 characters, or end with the word 'component'.",
+        "projectNameValidationErrorInt": "The name must contain only latin alphanumeric characters and it must have at least two parts. The different parts must be separated by a period and every part must start with a letter.",
+        "duplicatedProjectName": "A project with this name already exists in your workspace. Please choose another name.",
+        "differentNamespaceThanProjectName": "The namespace must be the same as the project name.",
+        "namespaceSameAsProjectNameError": "The namespace must be the same as the project name.",
+        "namespaceLengthError": "The namespace cannot contain more than 61 characters or end with the word 'component'.",
+        "namespaceValidationError": "The namespace must contain only latin alphanumeric characters. Different parts can be separated by a period and every part must start with a letter."
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-input-validator",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "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.29.18"
+    "@sap-ux/project-access": "1.29.19"
   },
   "devDependencies": {
     "@types/validate-npm-package-name": "4.0.1",