@sap-ux/project-input-validator 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,20 @@
+# @sap-ux/project-input-validator
+Library that provides utility functions to validate input constraints required by Fiori projects.
+For example, validate Fiori project name text length limit, special characters that are not allowed
+in the naming, SAP client format, project description text length limit, etc.
+
+This library provides reusable validation utilities to support validations required in tools that facilitate
+Fiori project generation, deployment configuration, etc. 
+
+## Installation
+Npm
+`npm install --save @sap-ux/project-input-validator`
+
+Yarn
+`yarn add @sap-ux/project-input-validator`
+
+Pnpm
+`pnpm add @sap-ux/project-input-validator`
+
+## Usage
+See example usage in [test folder](./test/validators.test.ts).

package/dist/i18n.d.ts

@@ -0,0 +1,15 @@
+import type { TOptions } from 'i18next';
+export declare const PROJECT_INPUT_VALIDATOR_NS = "project-input-validator";
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = exports.PROJECT_INPUT_VALIDATOR_NS = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const common_i18n_json_1 = __importDefault(require("./translations/common.i18n.json"));
+exports.PROJECT_INPUT_VALIDATOR_NS = 'project-input-validator';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+function initI18n() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield i18next_1.default.init({
+            resources: {
+                en: {
+                    [exports.PROJECT_INPUT_VALIDATOR_NS]: common_i18n_json_1.default
+                }
+            },
+            lng: 'en',
+            fallbackLng: 'en',
+            defaultNS: exports.PROJECT_INPUT_VALIDATOR_NS,
+            ns: [exports.PROJECT_INPUT_VALIDATOR_NS]
+        });
+    });
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Ignore any errors since the write will still work
+});
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './validators';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./validators"), exports);
+//# sourceMappingURL=index.js.map

package/dist/translations/common.i18n.json

@@ -0,0 +1,14 @@
+{
+    "AbapAppDescLength": "Deployment Description should not exceed 60 characters",
+    "InvalidClient": "[{{client}}] is invalid. Enter blank or a value between 000-999",
+    "AbapTransportNumRequired": "Provide a transport request for your application",
+    "AbapPackageWarn": "Provide a package",
+    "InvalidUrl": "Invalid URL: [{{input}}]",
+    "AbapAppNameRequired": "Application name required",
+    "AbapInvalidNamespace": "Namespace invalid as there are too many forward slashes",
+    "AbapInvalidNamespaceLength": "Namespace limited to 10 characters, entered {{length}}",
+    "AbapInvalidAppNameLength": "Application name limited to 15 characters, entered {{length}}",
+    "AbapInvalidAppName": "Application name needs to be prefixed with [{{prefix}}]",
+    "CharactersForbiddenInAppName": "Only alphanumeric, underscore and slash characters are allowed",
+    "InvalidAppNameMultipleReason": "Application name is invaid for multiple reasons:"
+}

package/dist/validators.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Validator Fiori app name is compatbiel with Fiori project requirements.
+ *
+ * @param name Fiori app name
+ * @param prefix Prefix required by backend system
+ * @returns True or error message
+ */
+export declare function validateAppName(name: string, prefix?: string): boolean | string;
+/**
+ * Validate Fiori app description length is not exceeding 60 characters.
+ *
+ * @param description Fiori app description
+ * @returns true or error message
+ */
+export declare function validateAppDescription(description: string): boolean | string;
+/**
+ * Client number is either empty or 3 digit string.
+ *
+ * @param client ABAP system client number
+ * @returns true or error message
+ */
+export declare function validateClient(client: string): boolean | string;
+/**
+ * Transport request number is not required for local package.
+ *
+ * @param transportRequest Transport request number
+ * @param packageName Package name
+ * @returns true or error message
+ */
+export declare function validateTransportRequestNumber(transportRequest: string, packageName: string): boolean | string;
+/**
+ * Validate package name cannot be empty.
+ *
+ * @param input Package name
+ * @returns true or error message
+ */
+export declare function validatePackage(input: string): boolean | string;
+/**
+ * Validate url input is valid url format.
+ *
+ * @param input Backend ABAP system url
+ * @returns true or error message
+ */
+export declare function validateUrl(input: string): boolean | string;
+//# sourceMappingURL=validators.d.ts.map

package/dist/validators.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUrl = exports.validatePackage = exports.validateTransportRequestNumber = exports.validateClient = exports.validateAppDescription = exports.validateAppName = void 0;
+const i18n_1 = require("./i18n");
+const os_1 = require("os");
+/**
+ * Validator Fiori app name is compatbiel with Fiori project requirements.
+ *
+ * @param name Fiori app name
+ * @param prefix Prefix required by backend system
+ * @returns True or error message
+ */
+function validateAppName(name, prefix) {
+    const errorMessages = [];
+    const length = name ? name.trim().length : 0;
+    if (!length) {
+        return (0, i18n_1.t)('AbapAppNameRequired');
+    }
+    if (name.split('/').length > 3) {
+        errorMessages.push((0, i18n_1.t)('AbapInvalidNamespace'));
+    }
+    else if (/^\/.*\/\w*$/g.test(name)) {
+        const splitNames = name.split('/');
+        let accumulatedMsg = '';
+        if (splitNames[1].length > 10) {
+            const errMsg = (0, i18n_1.t)('AbapInvalidNamespaceLength', { length: splitNames[1].length });
+            accumulatedMsg += `${errMsg}, `;
+        }
+        if (splitNames[2].length > 15) {
+            const errMsg = (0, i18n_1.t)('AbapInvalidAppNameLength', { length: splitNames[2].length });
+            accumulatedMsg += `${errMsg}, `;
+        }
+        if (accumulatedMsg) {
+            accumulatedMsg = accumulatedMsg.substring(0, accumulatedMsg.length - 2);
+            errorMessages.push(accumulatedMsg);
+        }
+    }
+    else if (length > 15) {
+        errorMessages.push((0, i18n_1.t)('AbapInvalidAppNameLength', { length }));
+    }
+    if (prefix && !name.toUpperCase().startsWith(prefix.toUpperCase())) {
+        errorMessages.push((0, i18n_1.t)('AbapInvalidAppName', { prefix }));
+    }
+    if (!/^[A-Za-z0-9_/]*$/.test(name)) {
+        errorMessages.push((0, i18n_1.t)('CharactersForbiddenInAppName'));
+    }
+    return processErrorMessages(errorMessages);
+}
+exports.validateAppName = validateAppName;
+/**
+ * Helper function to format an array of error messages to a single string.
+ *
+ * @param errorMessages Array of error messages
+ * @returns Returns true or formatted error message string
+ */
+function processErrorMessages(errorMessages) {
+    if (errorMessages.length === 0) {
+        return true;
+    }
+    else if (errorMessages.length === 1) {
+        return errorMessages[0];
+    }
+    else {
+        return `${(0, i18n_1.t)('InvalidAppNameMultipleReason')}${os_1.EOL}${errorMessages.join(os_1.EOL)}${os_1.EOL}`;
+    }
+}
+/**
+ * Validate Fiori app description length is not exceeding 60 characters.
+ *
+ * @param description Fiori app description
+ * @returns true or error message
+ */
+function validateAppDescription(description) {
+    if (description.length > 60) {
+        return (0, i18n_1.t)('AbapAppDescLength');
+    }
+    else {
+        return true;
+    }
+}
+exports.validateAppDescription = validateAppDescription;
+/**
+ * Client number is either empty or 3 digit string.
+ *
+ * @param client ABAP system client number
+ * @returns true or error message
+ */
+function validateClient(client) {
+    const formattedInput = (client === null || client === void 0 ? void 0 : client.trim()) || '';
+    const isValid = formattedInput === '' || /^\d{3}$/.test(formattedInput);
+    if (isValid) {
+        return true;
+    }
+    else {
+        return (0, i18n_1.t)('InvalidClient', { client });
+    }
+}
+exports.validateClient = validateClient;
+/**
+ * Transport request number is not required for local package.
+ *
+ * @param transportRequest Transport request number
+ * @param packageName Package name
+ * @returns true or error message
+ */
+function validateTransportRequestNumber(transportRequest, packageName) {
+    const regex = /^[$LlTt]/;
+    if (regex.test(packageName) && (transportRequest === null || transportRequest === void 0 ? void 0 : transportRequest.trim())) {
+        return (0, i18n_1.t)('AbapTransportNumRequired');
+    }
+    else {
+        return true;
+    }
+}
+exports.validateTransportRequestNumber = validateTransportRequestNumber;
+/**
+ * Validate package name cannot be empty.
+ *
+ * @param input Package name
+ * @returns true or error message
+ */
+function validatePackage(input) {
+    if (!(input === null || input === void 0 ? void 0 : input.trim())) {
+        return (0, i18n_1.t)('AbapPackageWarn');
+    }
+    else {
+        return true;
+    }
+}
+exports.validatePackage = validatePackage;
+/**
+ * Validate url input is valid url format.
+ *
+ * @param input Backend ABAP system url
+ * @returns true or error message
+ */
+function validateUrl(input) {
+    try {
+        const url = new URL(input);
+        return !!url.protocol && !!url.host;
+    }
+    catch (_a) {
+        return (0, i18n_1.t)('InvalidUrl', { input });
+    }
+}
+exports.validateUrl = validateUrl;
+//# sourceMappingURL=validators.js.map

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@sap-ux/project-input-validator",
+  "version": "0.1.0",
+  "description": "Library to validate Fiori project input formats",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/project-input-validator"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aproject-input-validator"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "dist/index.js",
+  "dependencies": {
+    "i18next": "20.3.2"
+  },
+  "devDependencies": {},
+  "files": [
+    "dist",
+    "LICENSE",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "engines": {
+    "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
+    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "clean": "rimraf --glob dist coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}