Documentation update & sync

.reuse/dep5

@@ -25,7 +25,7 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
  parties the right to use of access any SAP External Product, through API Calls.
 
 # Source code, tests, documentation
-Files: abap-api-tools/** abap-helpers/** assets/** doc/** docker/** model/** *.md abap-value-input-help/**
+Files: abap-api-tools/** abap-helpers/** assets/** doc/** docker/** model/** *.md abap-value-help/**
 Copyright: 2014 SAP SE Srdjan Boskovic <[email protected]>
 License: Apache-2.0
 

README.md

@@ -23,7 +23,7 @@ Node [CLI tool](./abap-api-tools) for [pattern based web applications](./doc/app
 - Application frameworks: electron, NW.js ...
 - Building a [pattern based app](./doc/app.md)
 
-Bonus: generic Value Input Helps server runtime component: [`abap-value-input-help`](./abap-value-input-help/README.md).
+Bonus: generic Value Help server runtime component: [`abap-value-help`](./abap-value-help/README.md).
 
 :star: Your star is appreciated, it helps!
 

abap-api-tools/README.md

@@ -13,7 +13,7 @@ Command line tool for building [pattern based applications'](https://github.com/
 - Custom configurations, open for integration
 - Minimalistic, unobtrusive, powerful
 
-Bonus: generic Value Input Helps server runtime component: [`abap-value-input-help`](https://www.npmjs.com/package/abap-value-input-help).
+Bonus: generic Value Helps server runtime component: [`abap-value-help`](https://github.com/SAP/fundamental-tools/tree/main/abap-value-input-help).
 
 ## Content<!-- omit in toc -->
 
@@ -91,7 +91,7 @@ SYSNR=20
 CLIENT=71
 ```
 
-ABAP API for Value Input Help annotations, if exposed in backend system (see [ABAP helpers](https://github.com/SAP/fundamental-tools/tree/master/abap-helpers)), shall be defined in `config/system.yaml` file. Use the same destination name like in `sapnwrfc.ini`:
+ABAP API for Value Help annotations, if exposed in backend system (see [ABAP helpers](https://github.com/SAP/fundamental-tools/tree/master/abap-helpers)), shall be defined in `config/system.yaml` file. Use the same destination name like in `sapnwrfc.ini`:
 
 ```yaml
 MME:
@@ -237,7 +237,7 @@ Annoted with:
 - Data type, length
 - Texts (label, caption)
 - Currency or quantity reference fields (unit of measure, currency)
-- Value Input Help: field domain values, check table, elementary or complex search help
+- Value Help: field domain values, check table, elementary or complex search help
 - SU3 parameters (User SET/GET parameters)
 
 Aurelia example:
@@ -371,11 +371,11 @@ short:
 
 Integration api provides ABAP annotations, call templates and pre-fabricated ui components, for consumption by other tools, applications or SDKs:
 
-| Method | Output                                            | Backend connection |
-| ------ | ------------------------------------------------- | ------------------ |
-| `call` | Call templates, annotations w/o Value Input Helps | required           |
-| `get`  | Call templates, annotations                       | required           |
-| `make` | Call templates, ui components                     | not required       |
+| Method | Output                                      | Backend connection |
+| ------ | ------------------------------------------- | ------------------ |
+| `call` | Call templates, annotations w/o Value Helps | required           |
+| `get`  | Call templates, annotations                 | required           |
+| `make` | Call templates, ui components               | not required       |
 
 Either the destination id or connection parameters can be used, with one or more RFM names.
 
@@ -398,7 +398,7 @@ const cp: RfcConnectionParameters = {
 
   const api = new AbapCliApi();
 
-  // Call templates, annotations w/o Value Input Helps
+  // Call templates, annotations w/o Value Helps
   R = await a.call("MME", "stfc_connection");
 
   // Call templates and annotations

abap-api-tools/abap-api/README.md

@@ -1,6 +1,6 @@
 # ABAP API
 
-Value Input Helps annotations require remote-enablement of two ABAP Function Modules. Their names can be maintained in `system.yaml` of abap-ui-tools configuration or passed via API. Without these two function modules, parsing Value Input Helps annotations will be skipped.
+Value Helps annotations require remote-enablement of two ABAP Function Modules. Their names can be maintained in `system.yaml` of abap-api-tools configuration or passed via API. Without these two function modules, parsing Value Helps annotations will be skipped.
 
 :exclamation: The implementation given here just as example, neither maintained, nor supported here
 

abap-api-tools/package.json

@@ -1,7 +1,7 @@
 {
   "name": "abap-api-tools",
   "description": "ABAP api tools",
-  "version": "1.9.1",
+  "version": "1.9.2",
   "homepage": "https://github.com/sap/fundamental-tools",
   "author": "SAP",
   "license": "Apache-2.0",

abap-value-input-help/README.md → abap-value-help/README.md

@@ -1,13 +1,15 @@
-# Value Input Helps <!-- omit in toc -->
+# ABAP Value Help <!-- omit in toc -->
 
-![License](https://img.shields.io/npm/l/abap-value-input-help)
-[![npm](https://img.shields.io/npm/v/abap-value-input-help)](https://www.npmjs.com/package/abap-value-input-help)
+![License](https://img.shields.io/npm/l/abap-value-help)
+[![npm](https://img.shields.io/npm/v/abap-value-help)](https://www.npmjs.com/package/abap-value-help)
 [![Slack](https://img.shields.io/badge/slack-ui--fundamentals-blue.svg?logo=slack)](https://join.slack.com/t/ui-fundamentals/shared_invite/enQtNTIzOTU0Mzc2NTc5LWQzZWI5MWFhYjE5OTc4YzliN2JhOTc1ZjQxZTg1YjZiMWZiYzRkNjMwYzgyMmFkYmNhZDVjMWE5MDIzOWEzMmM)
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/fundamental-tools)](https://api.reuse.software/info/github.com/SAP/fundamental-tools)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-f8bc45.svg)](https://github.com/prettier/prettier)
 
-Server component exposing generic Value Input Helps for [pattern based applications](https://github.com/SAP/fundamental-tools/blob/main/doc/app.md) and ui frameworks supported by [Fundamental Library for ABAP](https://github.com/SAP/fundamental-tools). ABAP developers already know how it works (like in SAPGUI):
+Server component exposing generic Value Helps for [pattern based applications](https://github.com/SAP/fundamental-tools/blob/main/doc/app.md) and ui frameworks supported by [Fundamental Library for ABAP](https://github.com/SAP/fundamental-tools).
+
+ABAP developers already know how it works - like in SAPGUI:
 
 - ABAP Fixed Domain Values (FV)
 - ABAP Elementary and complex Search Helps (SH)
@@ -19,21 +21,21 @@ Server component exposing generic Value Input Helps for [pattern based applicati
 Server runtime component:
 
 ```shell
-npm install abap-value-input-help
+npm install abap-value-help
 ```
 
 ## Usage
 
-Add server routes for generic [ABAP Search Helps API](./abap-api/README.md)
+Add server routes for generic [ABAP Value Helps API](https://github.com/SAP/fundamental-tools/blob/main/abap-value-input-help/abap-api/README.md)
 
-| Search Help Type                         | route                       | ABAP API                                  |
-| ---------------------------------------- | --------------------------- | ----------------------------------------- |
-| Fixed domain values (FV)                 | `/fieldvalues/<path>`       | `SHLP_DOMVALUES_GET`                      |
-| Elementary and Complex Search Helps (SH) | `/helpselect`<br/>`/search` | `SHLP_METADATA_GET`<br/>`SHLP_VALUES_GET` |
-| Check Tables (CT)                        | `/tabselect`                | CT/CH tables' query                       |
-| Custom input helps                       | `/valuelist/`               | any ABP RFM                               |
+| Search Help Type                     | Route                       | ABAP Value Help API                                  | ABAP API (internal)                       |
+| ------------------------------------ | --------------------------- | ---------------------------------------------------- | ----------------------------------------- |
+| Fixed domain values (FV)             | `/fieldvalues/<path>`       | getDomainValues()                                    | `SHLP_DOMVALUES_GET`                      |
+| Elementary/complex Search Helps (SH) | `/helpselect`<br/>`/search` | getShlpDescriptor()<br>search()                      | `SHLP_METADATA_GET`<br/>`SHLP_VALUES_GET` |
+| Check Tables (CT, CH)                | `/tabselect`                | Generic on HANA systems<br>Custom BAPI/RFM otherwise | CT/CH tables' query                       |
+| Custom input helps                   | `/valuelist/`               | pass-through                                         | any ABP RFM                               |
 
-More API details: [unit tests](https://github.com/SAP/fundamental-tools/tree/main/abap-value-input-help/tests)
+More API details: [unit tests](https://github.com/SAP/fundamental-tools/tree/main/abap-value-help/tests)
 
 Add custom attribute `shlp` to input component, like:
 
@@ -57,9 +59,9 @@ Add custom attribute `shlp` to input component, like:
 ></ui-input>
 ```
 
-Custom attribute will add Search Help icon input addon and run the Search Help dialog using abovementioned exposed routes. Input ui component is updated with the Search Help dialog result:
+Custom attribute will add Search Help icon input addon and run the Search Help dialog using abovementioned routes. Input ui component is updated with the Search Help dialog result:
 
-![](https://raw.githubusercontent.com/SAP/fundamental-tools/main/abap-value-input-help/doc/assets/ValueInputHelpsDialog.jpg)
+![](https://raw.githubusercontent.com/SAP/fundamental-tools/main/abap-value-help/doc/assets/ValueInputHelpsDialog.jpg)
 
 ## Known Issues
 

abap-value-input-help/package.json → abap-value-help/package.json

@@ -1,7 +1,7 @@
 {
-  "name": "abap-value-input-help",
-  "description": "ABAP Value Input Helps",
-  "version": "0.9.1",
+  "name": "abap-value-help",
+  "description": "ABAP Value Help",
+  "version": "0.9.2",
   "homepage": "https://github.com/sap/fundamental-tools",
   "author": "SAP",
   "license": "Apache-2.0",