first commit

Author: stubbies

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+*.log

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "soap-req-json",
+  "version": "1.0.0",
+  "description": "Does a SOAP request and returns JSON string.",
+  "main": "dist/index.js",
+  "author": "Ervald Culoli",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^16.9.6",
+    "typescript": "^4.4.3"
+  },
+  "dependencies": {
+    "xml-js": "^1.6.11"
+  }
+}

readme.md

@@ -0,0 +1,72 @@
+# Soap Request To Json
+
+Does a SOAP request and returns JSON string.
+
+# Usage
+
+## `Installation`
+
+```
+npm install soap-req-json
+// or
+yarn add soap-req-json
+```
+
+## `Quick Start`
+
+```
+const srj = require('soap-req-json');
+
+// SOAP Envelope
+const envelope = `
+  <SOAP-ENV:Envelope
+    xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+    SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
+    <SOAP-ENV:Header>
+        <t:Transaction :t="some-URI" SOAP-ENV:mustUnderstand="1">5</t:Transaction>
+    </SOAP-ENV:Header>
+  </SOAP-ENV:Envelope>`;
+
+// URL
+const url = 'https://electrocommerce.org/abc/service';
+
+// The SOAPAction HTTP Header Field
+const SOAPAction = 'https://electrocommerce.org/abc#MyMessage';
+
+const jsonString = await srj({ envelope, url, SOAPAction })
+```
+
+## `Options`
+
+| Option       | Type                                       | Required |
+|--------------|--------------------------------------------|----------|
+| `envelope`   | `string` SOAP Envelope                     | `true`   |
+| `url`        | `url`                                      | `true`   |
+| `SOAPAction` | `string` The SOAPAction HTTP Header Field. | `true`   |
+| `timeout`    | `number` Timeout request. Default `0`      | `false`  |
+
+
+## `Error messages`
+
+| Message           | Description                  |
+|-------------------|------------------------------|
+| `INVALID_URL`     | URL could not be parsed.     |
+| `REQUEST_TIMEOUT` | Request timeout.             |
+| `SERVER_ERROR`    | Server responded with error. |
+
+
+# Dependencies
+
+## `dependencies`
+
+| Package | Description                                                         |
+|---------|---------------------------------------------------------------------|
+| xml-js  | Convert XML text to Javascript object / JSON text (and vice versa). |
+
+
+## `devDependencies`
+
+| Package     | Description                                                          |
+|-------------|----------------------------------------------------------------------|
+| @types/node | This package contains type definitions for Node.js                   |
+| typescript  | JavaScript compiler/type checker that boosts JavaScript productivity |

src/index.ts

@@ -0,0 +1,67 @@
+
+import { URL } from 'url';
+import { request } from 'https';
+import { xml2json } from 'xml-js';
+
+export interface SoapRequesJsonParams {
+  envelope: string;
+  url: string;
+  SOAPAction: string;
+  timeout?: number;
+}
+
+export enum ERRORS {
+  INVALID_URL = 'INVALID_URL',
+  REQUEST_TIMEOUT = 'REQUEST_TIMEOUT',
+  SERVER_ERROR = 'SERVER_ERROR'
+}
+
+const getOptions = (p: SoapRequesJsonParams) => {
+  try {
+    const url = new URL(p.url);
+    const options = {
+      hostname: url.host,
+      port: url.port,
+      path: url.pathname,
+      method: 'POST',
+      headers: {
+        'Content-Type': 'text/xml; charset=utf-8',
+        'Content-Length': p.envelope.length,
+        'SOAPAction': p.SOAPAction
+      },
+      timeout: p.timeout ?? 0
+    };
+
+    return options;
+
+  } catch (e) {
+    throw new Error(ERRORS.INVALID_URL);
+  }
+};
+
+const soapRequestJson = async (p: SoapRequesJsonParams): Promise<string | Error> => {
+  return new Promise((resolve, reject) => {
+    const req = request(p.url, getOptions(p), (res) => {
+      let data = '';
+      res.on('data', (chunk) => data += chunk);
+      res.on('end', () => {
+        const json = xml2json(data, { compact: true, spaces: 2 });
+        resolve(json);
+      });
+    });
+
+    req.on('error', (err) => {
+      reject(new Error(ERRORS.SERVER_ERROR));
+    });
+
+    req.on('timeout', () => {
+      req.destroy();
+      reject(new Error(ERRORS.REQUEST_TIMEOUT));
+    });
+
+    req.write(p.envelope);
+    req.end();
+  });
+};
+
+export default soapRequestJson;

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "commonjs",
+    "removeComments": true,
+    "moduleResolution": "node",
+    "strict": true,
+    "baseUrl": ".",
+    "outDir": "dist",
+    "declaration": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": ["node_modules"],
+}

yarn.lock

@@ -0,0 +1,25 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"@types/node@^16.9.6":
+  version "16.9.6"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.9.6.tgz#040a64d7faf9e5d9e940357125f0963012e66f04"
+  integrity sha512-YHUZhBOMTM3mjFkXVcK+WwAcYmyhe1wL4lfqNtzI0b3qAy7yuSetnM7QJazgE5PFmgVTNGiLOgRFfJMqW7XpSQ==
+
+sax@^1.2.4:
+  version "1.2.4"
+  resolved "https://registry.yarnpkg.com/sax/-/sax-1.2.4.tgz#2816234e2378bddc4e5354fab5caa895df7100d9"
+  integrity sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==
+
+typescript@^4.4.3:
+  version "4.4.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.3.tgz#bdc5407caa2b109efd4f82fe130656f977a29324"
+  integrity sha512-4xfscpisVgqqDfPaJo5vkd+Qd/ItkoagnHpufr+i2QCHBsNYp+G7UAoyFl8aPtx879u38wPV65rZ8qbGZijalA==
+
+xml-js@^1.6.11:
+  version "1.6.11"
+  resolved "https://registry.yarnpkg.com/xml-js/-/xml-js-1.6.11.tgz#927d2f6947f7f1c19a316dd8eea3614e8b18f8e9"
+  integrity sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==
+  dependencies:
+    sax "^1.2.4"