nets-service-sdk 1.0.0

package/README.md

@@ -0,0 +1,102 @@
+# NETS Service SDK
+
+A utility library for integrating with NETS payment terminals and handling related operations. This SDK provides tools for serial communication, message parsing, configuration management, and common utility functions.
+
+## Installation
+
+```bash
+npm install nets-service-sdk
+```
+
+## Usage
+
+### Importing the SDK
+
+```javascript
+const netsSdk = require('nets-service-sdk');
+// OR destructure specific modules
+const { communication, manageConfig, logger } = require('nets-service-sdk');
+```
+
+### Configuration Management
+
+Manage your application configuration using `manageConfig`. It reads/writes to a `config.json` file in your project root.
+
+```javascript
+const { manageConfig } = require('nets-service-sdk');
+
+// Get entire configuration
+const config = manageConfig.getConfig();
+
+// Get specific config value
+const port = manageConfig.getConfigByKey('com');
+
+// Update configuration
+manageConfig.updateConfig({ com: '/dev/ttyUSB0' });
+```
+
+### Serial Communication (Payment Terminal)
+
+Handle communication with the NETS terminal.
+
+```javascript
+const { communication } = require('nets-service-sdk');
+
+// Initialize the serial connection
+// Ensure your config.json has 'com' (port) and 'terminal' settings
+communication.initialize();
+
+// Send a request to the terminal
+// Types: 'STATUS_CHECK', 'LOGON', 'PAYMENT', 'CREDIT_PAYMENT'
+communication.sentToTerminal('STATUS_CHECK', {});
+
+// For Payment
+communication.sentToTerminal('PAYMENT', {
+    amount: 1000, // Amount in cents
+    reference: 'ORDER123'
+});
+```
+
+### Utility Functions
+
+The SDK exports various utility functions directly.
+
+```javascript
+const { padWithLeadingZeros, xorCalculation, generateServiceKey } = require('nets-service-sdk');
+
+// Pad numbers
+console.log(padWithLeadingZeros(5, 3)); // Output: "005"
+
+// XOR Calculation for checksums
+const checksum = xorCalculation("02313030");
+
+// Generate Service Key
+const key = generateServiceKey({ some: "payload" });
+```
+
+### Logging
+
+Use the built-in Winston logger.
+
+```javascript
+const { logger } = require('nets-service-sdk');
+const myLogger = logger(module);
+
+myLogger.info('This is an info message');
+myLogger.error('This is an error message');
+```
+
+## Modules
+
+-   **communication**: Handles serial port communication with the terminal.
+-   **manageConfig**: Reads and writes configuration to `config.json`.
+-   **utilsHelper**: General utility functions (padding, XOR, hex conversion, etc.).
+-   **logger**: Winston logger configuration.
+-   **queue**: Queue management (if applicable).
+-   **sendMessage**: Helper for sending messages (e.g., to socket rooms).
+-   **hexRequest**: Generates HEX requests for the terminal.
+-   **parser**: Parses responses from the terminal.
+
+## License
+
+ISC

package/dist/index.js

@@ -0,0 +1,2 @@
+function e(){return e=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var n=arguments[r];for(var s in n)({}).hasOwnProperty.call(n,s)&&(e[s]=n[s])}return e},e.apply(null,arguments)}var r=require("./src/utils.helper"),n=require("./src/winston"),s=require("./src/manageConfig"),u=require("./src/queue"),a=require("./src/sendMessage"),t=require("./src/payment/communication"),i=require("./src/payment/hexRequest"),c=require("./src/payment/httpRequest"),o=require("./src/payment/parser"),p=require("./src/payment/responseHandler");module.exports=e({},r,{logger:n,manageConfig:s,queue:u,sendMessage:a,communication:t,hexRequest:i,httpRequest:c,parser:o,responseHandler:p});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../index.js"],"sourcesContent":["const utilsHelper = require('./src/utils.helper');\nconst winston = require('./src/winston');\nconst manageConfig = require('./src/manageConfig');\nconst queue = require('./src/queue');\nconst sendMessage = require('./src/sendMessage');\nconst communication = require('./src/payment/communication');\nconst hexRequest = require('./src/payment/hexRequest');\nconst httpRequest = require('./src/payment/httpRequest');\nconst parser = require('./src/payment/parser');\nconst responseHandler = require('./src/payment/responseHandler');\n\nmodule.exports = {\n    ...utilsHelper,\n    logger: winston,\n    manageConfig,\n    queue,\n    sendMessage,\n    communication,\n    hexRequest,\n    httpRequest,\n    parser,\n    responseHandler\n};\n"],"names":["utilsHelper","require","winston","manageConfig","queue","sendMessage","communication","hexRequest","httpRequest","parser","responseHandler","module","exports","_extends","logger"],"mappings":"wNAAA,IAAMA,EAAcC,QAAQ,sBACtBC,EAAUD,QAAQ,iBAClBE,EAAeF,QAAQ,sBACvBG,EAAQH,QAAQ,eAChBI,EAAcJ,QAAQ,qBACtBK,EAAgBL,QAAQ,+BACxBM,EAAaN,QAAQ,4BACrBO,EAAcP,QAAQ,6BACtBQ,EAASR,QAAQ,wBACjBS,EAAkBT,QAAQ,iCAEhCU,OAAOC,QAAOC,EAAA,CAAA,EACPb,EAAW,CACdc,OAAQZ,EACRC,aAAAA,EACAC,MAAAA,EACAC,YAAAA,EACAC,cAAAA,EACAC,WAAAA,EACAC,YAAAA,EACAC,OAAAA,EACAC,gBAAAA"}

package/dist/index.modern.mjs

@@ -0,0 +1,2 @@
+function e(){return e=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var n=arguments[r];for(var s in n)({}).hasOwnProperty.call(n,s)&&(e[s]=n[s])}return e},e.apply(null,arguments)}const r=require("./src/utils.helper"),n=require("./src/winston"),s=require("./src/manageConfig"),t=require("./src/queue"),u=require("./src/sendMessage"),a=require("./src/payment/communication"),i=require("./src/payment/hexRequest"),c=require("./src/payment/httpRequest"),o=require("./src/payment/parser"),p=require("./src/payment/responseHandler");module.exports=e({},r,{logger:n,manageConfig:s,queue:t,sendMessage:u,communication:a,hexRequest:i,httpRequest:c,parser:o,responseHandler:p});
+//# sourceMappingURL=index.modern.mjs.map

package/dist/index.modern.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.modern.mjs","sources":["../index.js"],"sourcesContent":["const utilsHelper = require('./src/utils.helper');\nconst winston = require('./src/winston');\nconst manageConfig = require('./src/manageConfig');\nconst queue = require('./src/queue');\nconst sendMessage = require('./src/sendMessage');\nconst communication = require('./src/payment/communication');\nconst hexRequest = require('./src/payment/hexRequest');\nconst httpRequest = require('./src/payment/httpRequest');\nconst parser = require('./src/payment/parser');\nconst responseHandler = require('./src/payment/responseHandler');\n\nmodule.exports = {\n    ...utilsHelper,\n    logger: winston,\n    manageConfig,\n    queue,\n    sendMessage,\n    communication,\n    hexRequest,\n    httpRequest,\n    parser,\n    responseHandler\n};\n"],"names":["utilsHelper","require","winston","manageConfig","queue","sendMessage","communication","hexRequest","httpRequest","parser","responseHandler","module","exports","_extends","logger"],"mappings":"wNAAA,MAAMA,EAAcC,QAAQ,sBACtBC,EAAUD,QAAQ,iBAClBE,EAAeF,QAAQ,sBACvBG,EAAQH,QAAQ,eAChBI,EAAcJ,QAAQ,qBACtBK,EAAgBL,QAAQ,+BACxBM,EAAaN,QAAQ,4BACrBO,EAAcP,QAAQ,6BACtBQ,EAASR,QAAQ,wBACjBS,EAAkBT,QAAQ,iCAEhCU,OAAOC,QAAOC,EAAA,CAAA,EACPb,EAAW,CACdc,OAAQZ,EACRC,eACAC,QACAC,cACAC,gBACAC,aACAC,cACAC,SACAC"}

package/dist/index.module.js

@@ -0,0 +1,2 @@
+function e(){return e=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var n=arguments[r];for(var s in n)({}).hasOwnProperty.call(n,s)&&(e[s]=n[s])}return e},e.apply(null,arguments)}var r=require("./src/utils.helper"),n=require("./src/winston"),s=require("./src/manageConfig"),u=require("./src/queue"),a=require("./src/sendMessage"),t=require("./src/payment/communication"),i=require("./src/payment/hexRequest"),c=require("./src/payment/httpRequest"),o=require("./src/payment/parser"),p=require("./src/payment/responseHandler");module.exports=e({},r,{logger:n,manageConfig:s,queue:u,sendMessage:a,communication:t,hexRequest:i,httpRequest:c,parser:o,responseHandler:p});
+//# sourceMappingURL=index.module.js.map

package/dist/index.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.module.js","sources":["../index.js"],"sourcesContent":["const utilsHelper = require('./src/utils.helper');\nconst winston = require('./src/winston');\nconst manageConfig = require('./src/manageConfig');\nconst queue = require('./src/queue');\nconst sendMessage = require('./src/sendMessage');\nconst communication = require('./src/payment/communication');\nconst hexRequest = require('./src/payment/hexRequest');\nconst httpRequest = require('./src/payment/httpRequest');\nconst parser = require('./src/payment/parser');\nconst responseHandler = require('./src/payment/responseHandler');\n\nmodule.exports = {\n    ...utilsHelper,\n    logger: winston,\n    manageConfig,\n    queue,\n    sendMessage,\n    communication,\n    hexRequest,\n    httpRequest,\n    parser,\n    responseHandler\n};\n"],"names":["utilsHelper","require","winston","manageConfig","queue","sendMessage","communication","hexRequest","httpRequest","parser","responseHandler","module","exports","_extends","logger"],"mappings":"wNAAA,IAAMA,EAAcC,QAAQ,sBACtBC,EAAUD,QAAQ,iBAClBE,EAAeF,QAAQ,sBACvBG,EAAQH,QAAQ,eAChBI,EAAcJ,QAAQ,qBACtBK,EAAgBL,QAAQ,+BACxBM,EAAaN,QAAQ,4BACrBO,EAAcP,QAAQ,6BACtBQ,EAASR,QAAQ,wBACjBS,EAAkBT,QAAQ,iCAEhCU,OAAOC,QAAOC,EAAA,CAAA,EACPb,EAAW,CACdc,OAAQZ,EACRC,aAAAA,EACAC,MAAAA,EACAC,YAAAA,EACAC,cAAAA,EACAC,WAAAA,EACAC,YAAAA,EACAC,OAAAA,EACAC,gBAAAA"}

package/dist/index.umd.js

@@ -0,0 +1,2 @@
+!function(e){"function"==typeof define&&define.amd?define(e):e()}(function(){function e(){return e=Object.assign?Object.assign.bind():function(e){for(var r=1;r<arguments.length;r++){var n=arguments[r];for(var s in n)({}).hasOwnProperty.call(n,s)&&(e[s]=n[s])}return e},e.apply(null,arguments)}var r=require("./src/utils.helper"),n=require("./src/winston"),s=require("./src/manageConfig"),i=require("./src/queue"),t=require("./src/sendMessage"),u=require("./src/payment/communication"),a=require("./src/payment/hexRequest"),c=require("./src/payment/httpRequest"),o=require("./src/payment/parser"),p=require("./src/payment/responseHandler");module.exports=e({},r,{logger:n,manageConfig:s,queue:i,sendMessage:t,communication:u,hexRequest:a,httpRequest:c,parser:o,responseHandler:p})});
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../index.js"],"sourcesContent":["const utilsHelper = require('./src/utils.helper');\nconst winston = require('./src/winston');\nconst manageConfig = require('./src/manageConfig');\nconst queue = require('./src/queue');\nconst sendMessage = require('./src/sendMessage');\nconst communication = require('./src/payment/communication');\nconst hexRequest = require('./src/payment/hexRequest');\nconst httpRequest = require('./src/payment/httpRequest');\nconst parser = require('./src/payment/parser');\nconst responseHandler = require('./src/payment/responseHandler');\n\nmodule.exports = {\n    ...utilsHelper,\n    logger: winston,\n    manageConfig,\n    queue,\n    sendMessage,\n    communication,\n    hexRequest,\n    httpRequest,\n    parser,\n    responseHandler\n};\n"],"names":["utilsHelper","require","winston","manageConfig","queue","sendMessage","communication","hexRequest","httpRequest","parser","responseHandler","module","exports","_extends","logger"],"mappings":"qSAAA,IAAMA,EAAcC,QAAQ,sBACtBC,EAAUD,QAAQ,iBAClBE,EAAeF,QAAQ,sBACvBG,EAAQH,QAAQ,eAChBI,EAAcJ,QAAQ,qBACtBK,EAAgBL,QAAQ,+BACxBM,EAAaN,QAAQ,4BACrBO,EAAcP,QAAQ,6BACtBQ,EAASR,QAAQ,wBACjBS,EAAkBT,QAAQ,iCAEhCU,OAAOC,QAAOC,EAAA,CAAA,EACPb,EAAW,CACdc,OAAQZ,EACRC,aAAAA,EACAC,MAAAA,EACAC,YAAAA,EACAC,cAAAA,EACAC,WAAAA,EACAC,YAAAA,EACAC,OAAAA,EACAC,gBAAAA"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "nets-service-sdk",
+  "version": "1.0.0",
+  "description": "Utility functions for OM Service",
+  "source": "index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.module.js",
+  "unpkg": "dist/index.umd.js",
+  "scripts": {
+    "build": "microbundle",
+    "watch": "microbundle watch",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "dineshhv",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "dollars-to-cents": "^1.0.3",
+    "lodash": "^4.17.21",
+    "moment": "^2.29.4",
+    "request": "^2.88.2",
+    "serialport": "^10.5.0",
+    "socket.io-client": "^4.7.2",
+    "winston": "^3.8.2"
+  },
+  "devDependencies": {
+    "microbundle": "^0.15.1"
+  }
+}