feat(addon): addon methods added for language code conversions and ini file reload

Author: bsrdjan

CMakeLists.txt

@@ -93,7 +93,7 @@ else()
 endif()
 
 # source files and target library
-add_library(${PROJECT_NAME} SHARED src/Client.cc src/nwrfcsdk.cc src/Pool.cc src/Throughput.cc src/Server.cc src/addon.cc)
+add_library(${PROJECT_NAME} SHARED src/cpp/Client.cc src/cpp/nwrfcsdk.cc src/cpp/Pool.cc src/cpp/Throughput.cc src/cpp/Server.cc src/cpp/addon.cc)
 
 # build path ignored on Windows, copy after build
 if(MSVC)

README.md

@@ -1,5 +1,7 @@
 # node-rfc
 
+:tada: Darwin on ARM supported with SAP NW RFC SDK 7.50 PL11 :tada:
+
 Asynchronous, non-blocking [SAP NetWeaver RFC SDK](https://support.sap.com/en/product/connectors/nwrfcsdk.html) client bindings for [Node.js](http://nodejs.org/), providing convenient ABAP business logic consumption from Node.js.
 
 [![NPM](https://nodei.co/npm/node-rfc.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-rfc/)
@@ -49,9 +51,11 @@ Asynchronous, non-blocking [SAP NetWeaver RFC SDK](https://support.sap.com/en/pr
 
 - [Current and active nodejs LTS releases](https://github.com/nodejs/LTS)
 
-- The _node-rfc_ connector can be [built from source](#download-and-installation) on all platforms supported both by [SAP NW RFC SDK](https://launchpad.support.sap.com/#/notes/2573790) and by [nodejs](https://github.com/nodejs/node/blob/master/BUILDING.md#supported-platforms-1)
+- The _node-rfc_ connector can be built from source([build instructions](#download-and-installation)) on all platforms supported by both [SAP NW RFC SDK](https://launchpad.support.sap.com/#/notes/2573790) and [nodejs](https://github.com/nodejs/node/blob/master/BUILDING.md#supported-platforms-1)
+
+- In addition, pre-built wheels are provided for [active nodejs LTS releases](https://github.com/nodejs/LTS), for Windows, Darwin and Ubuntu Linux, attached to node-rfc GitHub [release](https://github.com/SAP/node-rfc/releases/latest).
 
-- Pre-built binaries are provided for [active nodejs LTS releases](https://github.com/nodejs/LTS), for 64 bit Windows 10, macOS 10.15 and [Centos 7 based docker container](https://github.com/SAP/fundamental-tools/tree/master/docker)
+- Docker containers: [[SAP fundamental-tools/docker]](https://github.com/SAP/fundamental-tools/tree/main/docker)
 
 Other platforms and frameworks:
 
@@ -74,7 +78,7 @@ Other platforms and frameworks:
 
 ## Requirements
 
-### All platforms
+### SAP NW RFC SDK 7.50.11
 
 - SAP NW RFC SDK C++ binaries must be downloaded (SAP partner or customer account required) and locally installed. Check [installation instructions](doc/installation.md#sap-nwrfc-sdk-installation) and [SAP NW RFC SDK section on SAP Support Portal](https://support.sap.com/en/product/connectors/nwrfcsdk.html). Using the latest version is reccomended as SAP NW RFC SDK is fully backwards compatible, supporting all NetWeaver systems, from today S4, down to R/3 release 4.6C.
 

doc/api.md

@@ -29,6 +29,14 @@ Usage: [usage/addon](usage.md#addon)
 setIniFileDirectory(iniFileDirectory: string)
 ```
 
+### reloadIniFile
+
+Usage: [usage/addon](usage.md#addon)
+
+```ts
+reloadIniFile()
+```
+
 ### loadCryptoLibrary
 
 Usage: [usage/addon](usage.md#addon)
@@ -45,6 +53,22 @@ Usage: [usage/addon](usage.md#cancelclient)
 cancelClient(client: Client, callback?: Function): void | Promise<any>;
 ```
 
+### languageIsoToSap
+
+Usage: [usage/addon](usage.md#addon)
+
+```ts
+languageIsoToSap(langIsoCode: string): string|Error
+```
+
+### languageSapToIso
+
+Usage: [usage/addon](usage.md#addon)
+
+```ts
+languageSapToIso(langSapCode: string): string|Error
+```
+
 ## Client
 
 Usage: [usage/client](usage.md#client)

doc/usage.md

@@ -6,8 +6,11 @@
 - **[ABAP Function Module](#abap-function-module)**
 - **[Addon](#addon)**
   - [setIniFileDirectory](#setinifiledirectory)
+  - [reloadIniFile](#reloadinifile)
   - [loadCryptoLibrary](#loadcryptolibrary)
   - [cancelClient](#cancelclient)
+  - [languageIsoToSap](#languageisotosap)
+  - [languageSapToIso](#languagesaptoiso)
 
 <a name="client-toc"></a>
 
@@ -144,6 +147,27 @@ const noderfc = require("node-rfc");
 noderfc.setIniFileDirectory("/some/folder");
 ```
 
+### reloadIniFile
+
+Reloads the contents of the `sapnwrfc.ini` file into memory.
+
+Searches the directory given by `RfcSetIniPath()` (or the current working directory)
+for the file `sapnwrfc.ini` and loads its contents into memory. Reloading the `sapnwrfc.ini`
+file is only necessary after the file has been manually edited.
+If you want to use a `sapnwrfc.ini` file in a different location, consider using `setIniFileDirectory()`.
+
+Note: If a file with the name `sapnwrfc.ini` does not exist in the given directory,
+this is not considered an error! Default settings are used in this case.
+
+```ts
+const noderfc = require("node-rfc");
+try{
+noderfc.reloadIniFile();
+} catch (ex) {
+    console.log(ex);
+}
+```
+
 ### loadCryptoLibrary
 
 Sets the absolute path to the sapcrypto library to enable TLS encryption via Websocket RFC.
@@ -166,6 +190,28 @@ const noderfc = require("node-rfc");
 noderfc.cancelClient(client);
 ```
 
+### languageIsoToSap
+
+API: [api/addon](api.md#languageisotosap)
+
+Conversion of language ISO code to 1-digit SAP code
+
+```ts
+const noderfc = require("node-rfc");
+const langSAP = noderfc.languageIsoToSap("EN");
+```
+
+### languageSapToIso
+
+API: [api/addon](api.md#languagesaptoiso)
+
+Conversion of language 1-digit SAP code to ISO code
+
+```ts
+const noderfc = require("node-rfc");
+const langSAP = noderfc.languageSapToIso("E");
+```
+
 ## Client
 
 API: [api/client](api.md#client)

lib/index.d.ts

@@ -7,6 +7,9 @@ export * from "./wrapper/sapnwrfc-pool";
 export * from "./wrapper/sapnwrfc-throughput";
 export * from "./wrapper/sapnwrfc-server";
 export declare function setIniFileDirectory(iniFileDirectory: string): void;
+export declare function reloadIniFile(): void;
 export declare function loadCryptoLibrary(libAbsolutePath: string): void;
 export declare const sapnwrfcEvents: EventEmitter;
 export declare function cancelClient(client: Client, callback?: Function): void | Promise<any>;
+export declare function languageIsoToSap(langIso: string): string;
+export declare function languageSapToIso(langSap: string): string;

lib/index.js

@@ -19,6 +19,14 @@ export interface NodeRfcEnvironment {
     noderfc: NodeRfcBindingVersions;
     versions: Object;
 }
+export interface NWRfcSdkError {
+    name: string;
+    group: number;
+    code: number;
+    codeString: string;
+    key: string;
+    message: string;
+}
 export interface NWRfcBinding {
     Client: RfcClientBinding;
     Pool: RfcPoolBinding;
@@ -28,6 +36,9 @@ export interface NWRfcBinding {
     environment: NodeRfcEnvironment;
     setIniFileDirectory(iniFileDirectory: string): any | undefined;
     loadCryptoLibrary(libAbsolutePath: string): any | undefined;
+    languageIsoToSap(langIso: string): string | NWRfcSdkError;
+    languageSapToIso(langSap: string): string | NWRfcSdkError;
+    reloadIniFile(): undefined | NWRfcSdkError;
     verbose(): this;
 }
 declare let noderfc_binding: NWRfcBinding;