abap-api-tools Value Help descriptors added to backend output

README.md

@@ -8,26 +8,25 @@
 [![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)
 
-- Minimalistic, unobtrusive, powerful
 - Web standards based applications with ABAP programming model
-- Front-end frameworks:
+- Standard front-ends:
   - [Aurelia](http://aurelia.io/)
   - Angular, React and Vue by [SAP Fundamenal Library](https://sap.github.io/fundamental/)
   - Angular, React and Vue by [Microsoft FAST](https://www.fast.design/docs/introduction/)
   - UI5 web components for [React](https://sap.github.io/ui5-webcomponents-react/?path=/story/getting-started--page)
 - Servers
   - SAP Cloud Platform
   - Koa, express, Spark, Jooby, Sanic, Django, Pyramid, Flask, Tornado ...
-- Application frameworks: electron, NW.js ...
-- Building [pattern based application](./doc/app.md)
+- Frameworks: electron, NW.js ...
+- [Conventions based application](./doc/app.md)
 
-Pattern based apps components
+Components
 
-- [**abap-api-tools**](./abap-api-tools/README.md) node CLI tool for pattern based applications
+- [abap-api-tools](./abap-api-tools/README.md) node CLI tool, app elements generator
 
-- [**abap-value-help**](./abap-value-help/README.md) generic Value Help runtime component
+- [abap-value-help](./abap-value-help/README.md) Generic Value Helps server API
 
-:star: Your star is appreciated, it helps!
+:star: Your star helps!
 
 ## Content <!-- omit in toc -->
 

abap-api-tools/README.md

@@ -1,19 +1,20 @@
 # abap api tools<!-- omit in toc -->
 
-![NPM](https://img.shields.io/npm/l/abap-api-tools)
+![License](https://img.shields.io/npm/l/abap-api-tools)
 
-Command line tool for building [pattern based applications](https://github.com/SAP/fundamental-tools/blob/main/doc/app.md):
+CLI tool for [conventions' based applications](https://github.com/SAP/fundamental-tools/blob/main/doc/app.md)
 
 - BAPI/RFM call templates ([What is BAPI/RFM?](https://sap.github.io/cloud-sdk/docs/java/features/bapi-and-rfc/bapi-and-rfc-overview/))
-- Ui components with ABAP data annotations:
+- Ui components with ABAP annotations:
   - [Aurelia](http://aurelia.io/)
   - Angular, React and Vue by [SAP Fundamenal Library](https://sap.github.io/fundamental/)
   - Angular, React and Vue by [Microsoft FAST](https://www.fast.design/docs/introduction/)
   - UI5 web components for [React](https://sap.github.io/ui5-webcomponents-react/?path=/story/getting-started--page)
 - Custom configurations, open for integration
 - Minimalistic, unobtrusive, powerful
+- [Conventions' based app](https://github.com/SAP/fundamental-tools/blob/main/doc/app.md)
 
-:gift: Generic Value Help runtime component: [**abap-value-help**](https://github.com/SAP/fundamental-tools/blob/main/abap-value-help/README.md)
+:gift: Generic Value Helps: [abap-value-help](https://github.com/SAP/fundamental-tools/blob/main/abap-value-help/README.md)
 
 ## Content<!-- omit in toc -->
 

abap-api-tools/package.json

@@ -1,7 +1,7 @@
 {
   "name": "abap-api-tools",
   "description": "ABAP api tools",
-  "version": "1.9.3",
+  "version": "2.0.0",
   "homepage": "https://github.com/sap/fundamental-tools",
   "author": "SAP",
   "license": "Apache-2.0",
@@ -28,7 +28,7 @@
   "scripts": {
     "ts": "tsc -p src/ts && cp -r src/configuration dist/.",
     "lint": "eslint src/ts",
-    "dependencies": "npm i --save chalk js-yaml loglevel sprintf-js yargs node-rfc",
+    "dependencies": "npm i --save chalk js-yaml loglevel sprintf-js yargs node-rfc abap-value-help",
     "devDependencies": "npm i --save-dev @types/node @types/js-yaml @types/sprintf-js @types/yargs @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint jest typescript",
     "build": "reuse lint && rm -rf dist && npm run ts && npm run lint",
     "lock": "npm install --package-lock-only",
@@ -45,6 +45,7 @@
     "nodejs"
   ],
   "dependencies": {
+    "abap-value-help": "^0.9.6",
     "chalk": "^4.1.0",
     "js-yaml": "^4.0.0",
     "loglevel": "^1.7.1",

abap-api-tools/src/ts/abap.ts

@@ -50,7 +50,12 @@ export type Destination =
   | string
   | {
       connectionParameters: RfcConnectionParameters;
-      searchHelpApi?: { determine: string; dom_values: string };
+      searchHelpApi?: {
+        determine: string;
+        dom_values: string;
+        metadata?: string;
+        search?: string;
+      };
     };
 
 export {
@@ -78,6 +83,7 @@ export type Arguments = {
   ui?: string | AbapCliUiConfig;
   "sort-fields"?: boolean;
   runInBg?: boolean;
+  helps?: boolean;
 };
 
 export type AbapCliResult = {
@@ -182,6 +188,7 @@ export class AbapCliApi {
     lang: DefaultLanguage,
     "sort-fields": false,
     debug: false,
+    helps: false,
   };
 
   async call(
@@ -219,7 +226,7 @@ export class AbapCliApi {
   async get(
     dest: Destination,
     rfm_names: string | string[],
-    options?: { lang?: string; debug?: boolean }
+    options?: { lang?: string; debug?: boolean; helps?: boolean }
   ): Promise<AbapCliResult> {
     if (options) {
       Object.assign(this.options, options);
@@ -239,6 +246,7 @@ export class AbapCliApi {
       lang: this.options.lang,
       debug: this.options.debug,
       runInBg: true,
+      helps: this.options.helps,
     };
 
     const cli = new CliHandler(args);
@@ -382,6 +390,13 @@ if (require.main === module)
             type: "boolean",
             default: false,
             nargs: 0,
+          })
+          .option("h", {
+            alias: "helps",
+            describe: "Value Helps descriptors",
+            type: "boolean",
+            default: false,
+            nargs: 0,
           });
       },
       handler: (argv) => {