@sap-ux/app-config-writer 0.4.36 → 0.4.37

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { getSmartLinksTargetFromPrompt, promptInboundNavigationConfig } from './prompt';
+export { getSmartLinksTargetFromPrompt, promptInboundNavigationConfig, validateText } from './prompt';
 export { generateSmartLinksConfig } from './smartlinks-config';
 export { generateInboundNavigationConfig } from './navigation-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateInboundNavigationConfig = exports.generateSmartLinksConfig = exports.promptInboundNavigationConfig = exports.getSmartLinksTargetFromPrompt = void 0;
+exports.generateInboundNavigationConfig = exports.generateSmartLinksConfig = exports.validateText = exports.promptInboundNavigationConfig = exports.getSmartLinksTargetFromPrompt = void 0;
 var prompt_1 = require("./prompt");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return prompt_1.getSmartLinksTargetFromPrompt; } });
 Object.defineProperty(exports, "promptInboundNavigationConfig", { enumerable: true, get: function () { return prompt_1.promptInboundNavigationConfig; } });
+Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return prompt_1.validateText; } });
 var smartlinks_config_1 = require("./smartlinks-config");
 Object.defineProperty(exports, "generateSmartLinksConfig", { enumerable: true, get: function () { return smartlinks_config_1.generateSmartLinksConfig; } });
 var navigation_config_1 = require("./navigation-config");

package/dist/prompt/index.d.ts

@@ -1,3 +1,3 @@
 export { getSmartLinksTargetFromPrompt, promptUserPass } from './smartlinks-config';
-export { promptInboundNavigationConfig } from './navigation-config';
+export { promptInboundNavigationConfig, validateText } from './navigation-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/prompt/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptInboundNavigationConfig = exports.promptUserPass = exports.getSmartLinksTargetFromPrompt = void 0;
+exports.validateText = exports.promptInboundNavigationConfig = exports.promptUserPass = exports.getSmartLinksTargetFromPrompt = void 0;
 var smartlinks_config_1 = require("./smartlinks-config");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return smartlinks_config_1.getSmartLinksTargetFromPrompt; } });
 Object.defineProperty(exports, "promptUserPass", { enumerable: true, get: function () { return smartlinks_config_1.promptUserPass; } });
 var navigation_config_1 = require("./navigation-config");
 Object.defineProperty(exports, "promptInboundNavigationConfig", { enumerable: true, get: function () { return navigation_config_1.promptInboundNavigationConfig; } });
+Object.defineProperty(exports, "validateText", { enumerable: true, get: function () { return navigation_config_1.validateText; } });
 //# sourceMappingURL=index.js.map

package/dist/prompt/navigation-config.d.ts

@@ -1,5 +1,6 @@
 import type { ManifestNamespace } from '@sap-ux/project-access';
 import type { Editor } from 'mem-fs-editor';
+import type { AllowedCharacters } from '../types/';
 /**
  * Prompt for inbound navigation configuration values.
  *
@@ -10,4 +11,15 @@ export declare function promptInboundNavigationConfig(basePath: string): Promise
     config: ManifestNamespace.Inbound[string] | undefined;
     fs: Editor;
 }>;
+/**
+ * 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 inputName the name of the input as seen by the user
+ * @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, inputName: string, maxLength?: number, allowedCharacters?: AllowedCharacters[]): boolean | string;
 //# sourceMappingURL=navigation-config.d.ts.map

package/dist/prompt/navigation-config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptInboundNavigationConfig = void 0;
+exports.validateText = exports.promptInboundNavigationConfig = void 0;
 const prompts_1 = require("prompts");
 const i18n_1 = require("../i18n");
 const mem_fs_1 = require("mem-fs");
@@ -39,9 +39,10 @@ exports.promptInboundNavigationConfig = promptInboundNavigationConfig;
  * @param input the text input to validate
  * @param inputName the name of the input as seen by the user
  * @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, inputName, maxLength = 0) {
+function validateText(input, inputName, maxLength = 0, allowedCharacters) {
     if (input?.trim().length === 0) {
         return (0, i18n_1.t)('prompt.validationWarning.inputRequired', {
             inputName,
@@ -51,8 +52,20 @@ function validateText(input, inputName, maxLength = 0) {
     if (maxLength && input.length > maxLength) {
         return (0, i18n_1.t)('prompt.validationWarning.maxLength', { maxLength, ns: i18n_1.NAV_CONFIG_NS });
     }
+    // Asterisks is supported for the semantic object and action field but not the inbound title
+    if (allowedCharacters) {
+        const escapedChars = allowedCharacters.map((char) => `\\${char}`).join('');
+        const regex = new RegExp(`^[a-zA-Z0-9${escapedChars}]+$`);
+        if (!regex.test(input)) {
+            return (0, i18n_1.t)('prompt.validationWarning.supportedFormats', {
+                ns: i18n_1.NAV_CONFIG_NS,
+                allowedCharacters: allowedCharacters.join('')
+            });
+        }
+    }
     return true;
 }
+exports.validateText = validateText;
 /**
  * Get the prompts for inbound navigation configuration.
  *
@@ -69,14 +82,14 @@ function getPrompts(inboundKeys) {
             type: 'text',
             message: semanticObjectInputMsg,
             format: (val) => val?.trim(),
-            validate: (val) => validateText(val, semanticObjectInputMsg, 30)
+            validate: (val) => validateText(val, semanticObjectInputMsg, 30, ['_'])
         },
         {
             name: 'action',
             type: 'text',
             message: actionInputMsg,
             format: (val) => val?.trim(),
-            validate: (val) => validateText(val, actionInputMsg, 60)
+            validate: (val) => validateText(val, actionInputMsg, 60, ['_'])
         },
         {
             type: (prev, values) => inboundKeys.indexOf(`${values.semanticObject}-${values.action}`) > -1 ? 'confirm' : false,

package/dist/translations/navigation-config.json

@@ -7,7 +7,8 @@
     "prompt": {
         "validationWarning": {
             "inputRequired": "{{inputName}} input is required",
-            "maxLength": "Maximum length: {{maxLength}} characters"
+            "maxLength": "Maximum length: {{maxLength}} characters",
+            "supportedFormats": "Only alphanumeric and '{{allowedCharacters}}' characters are allowed"
         },
         "message": {
             "semanticObject": "Semantic Object",

package/dist/types/index.d.ts

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

package/dist/types/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./smartLinks"), exports);
+__exportStar(require("./navigation"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/navigation.d.ts

@@ -0,0 +1,2 @@
+export type AllowedCharacters = '_';
+//# sourceMappingURL=navigation.d.ts.map

package/dist/types/navigation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=navigation.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "0.4.36",
+  "version": "0.4.37",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,11 +26,11 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
+    "@sap-ux/project-access": "1.27.5",
     "@sap-ux/axios-extension": "1.16.6",
+    "@sap-ux/store": "0.9.1",
     "@sap-ux/btp-utils": "0.15.2",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.27.5",
-    "@sap-ux/store": "0.9.1",
     "@sap-ux/ui5-config": "0.25.0"
   },
   "devDependencies": {