up the version to 0.0.8

chore: readme maintenance

README.md

@@ -1,4 +1,4 @@
-# node-ebics-client v0.0.35
+# node-ebics-client
 ---
 
 Pure node.js ( >=8 ) implementation of [EBICS](https://en.wikipedia.org/wiki/Electronic_Banking_Internet_Communication_Standard) ( Electronic Banking Internet Communication ).
@@ -21,4 +21,4 @@ The basic concept of this library was inspired by the [EPICS](https://github.com
 
 ## Copyright
 
-Copyright: eCollect AG, 2018.
+Copyright: eCollect AG, 2018-9.

examples/bankLetter.js

@@ -0,0 +1,31 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const ebics = require('../index');
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
+
+const client = new ebics.Client({
+	url: 'https://ebics.server',
+	partnerId: '',
+	userId: '',
+	hostId: '',
+	passphrase: 'test', // keys-test will be decrypted with this passphrase
+	keyStorage: ebics.fsKeysStorage('./keys-test'),
+});
+
+const bankName = 'Bank name';
+const template = fs.readFileSync('./templates/ini.hbs').toString();
+const letter = new ebics.BankLetter({ client, bankName, template });
+const bankLetterFile = path.join(os.homedir(), 'bankLetter.html');
+
+letter.serialize(bankLetterFile)
+	.then(() => {
+		console.log('Send your bank the letter (%s)', bankLetterFile);
+	})
+	.catch((err) => {
+		console.error(err);
+		process.exit(1);
+	});

examples/initialize.js

@@ -0,0 +1,32 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const ebics = require('../index');
+
+const client = new ebics.Client({
+	url: 'https://ebics.server',
+	partnerId: 'PARTNER',
+	userId: 'USER',
+	hostId: 'HOST',
+	passphrase: 'test', // keys-test will be encrypted with this passphrase
+	keyStorage: ebics.fsKeysStorage('./keys-test'),
+});
+
+// New keys will be generated and saved in ./keys-test
+client.send(ebics.Orders.INI)
+	.then((resp) => {
+		console.log('Respose for INI order %j', resp);
+		return client.send(ebics.Orders.HIA);
+	})
+	.then((resp) => {
+		console.log('Reponse for HIA order %j', resp);
+		if (resp.technicalCode !== '000000')
+			throw new Error('Something might went wrong');
+
+		console.log('Public keys should be sent to bank now. See examples/bankLetter.js');
+	})
+	.catch((err) => {
+		console.error(err);
+		process.exit(1);
+	});

examples/save-bank-kesy.js

@@ -0,0 +1,30 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const ebics = require('../index');
+
+const client = new ebics.Client({
+	url: 'https://ebics.server',
+	partnerId: '',
+	userId: '',
+	hostId: '',
+	passphrase: 'test', // keys-test will be decrypted with this passphrase
+	keyStorage: ebics.fsKeysStorage('./keys-test'),
+});
+
+// Client keys must be already generated and send by letter.
+// The bank should have enabled the user
+client.send(ebics.Orders.HPB)
+	.then((resp) => {
+		console.log('Respose for HPB order %j', resp);
+		if (resp.technicalCode !== '000000')
+			throw new Error('Something went wrong');
+
+		console.log('Received bank keys: %j', resp.bankKeys);
+		return client.setBankKeys(resp.bankKeys);
+	})
+	.catch((err) => {
+		console.error(err);
+		process.exit(1);
+	});

examples/send-hbt-order.js

@@ -0,0 +1,29 @@
+#! /usr/bin/env node
+
+'use strict';
+
+const ebics = require('../index');
+
+const client = new ebics.Client({
+	url: 'https://ebics.server',
+	partnerId: '',
+	userId: '',
+	hostId: '',
+	passphrase: 'test', // keys-test will be decrypted with this passphrase
+	keyStorage: ebics.fsKeysStorage('./keys-test'),
+});
+
+// The bank keys must have been already saved
+client.send(ebics.Orders.HTD)
+	.then((resp) => {
+		console.log('Respose for HTD order %j', resp);
+		if (resp.technicalCode !== '000000')
+			throw new Error('Something went wrong');
+
+		const data = Buffer.from(resp.orderData);
+		console.log(data.toString('utf8'));
+	})
+	.catch((err) => {
+		console.error(err);
+		process.exit(1);
+	});

lib/BankLetter.js

@@ -63,11 +63,10 @@ module.exports = class BankLetter {
 
 		try {
 			fs.writeFileSync(path, letter);
-			console.log('Data written to file');
 		} catch (error) {
-			console.log(error);
 			throw error;
 		}
+
 		return new Promise(resolve => resolve(true));
 	}
 };

lib/Client.js

@@ -42,7 +42,7 @@ module.exports = class Client {
 			throw new Error('passphrase is requierd');
 
 		if (!keyStorage || typeof keyStorage.read !== 'function' || typeof keyStorage.write !== 'function')
-			throw new Error('keyStorage implemntation missing or wrong');
+			throw new Error('keyStorage implementation missing or wrong');
 
 		this.url = url;
 		this.partnerId = partnerId;

lib/consts.js

@@ -2,7 +2,7 @@
 
 const packageJson = require('../package.json');
 
-const name = 'eCollect Node Ebics Client';
+const name = 'Node Ebics Client';
 const { version } = packageJson;
 const orderOperations = {
 	ini: 'INI',

lib/predefinedOrders/HAC.js

@@ -1,23 +1,13 @@
 'use strict';
 
-const dateRange = (start, end) => {
-	if (start && end)
-		return {
-			DateRange: {
-				Start: start,
-				End: end,
-			},
-		};
-
-	return {};
-};
+const utils = require('../utils');
 
 module.exports = (start = null, end = null) => ({
 	version: 'h004',
 	orderDetails: {
 		OrderType: 'HAC',
 		OrderAttribute: 'DZHNN',
-		StandardOrderParams: dateRange(start, end),
+		StandardOrderParams: utils.dateRange(start, end),
 	},
 	operation: 'download',
 });

lib/predefinedOrders/PTK.js

@@ -1,23 +1,13 @@
 'use strict';
 
-const dateRange = (start, end) => {
-	if (start && end)
-		return {
-			DateRange: {
-				Start: start,
-				End: end,
-			},
-		};
-
-	return {};
-};
+const utils = require('../utils');
 
 module.exports = (start = null, end = null) => ({
 	version: 'h004',
 	orderDetails: {
 		OrderType: 'PTK',
 		OrderAttribute: 'DZHNN',
-		StandardOrderParams: dateRange(start, end),
+		StandardOrderParams: utils.dateRange(start, end),
 	},
 	operation: 'download',
 });

lib/predefinedOrders/STA.js

@@ -1,23 +1,13 @@
 'use strict';
 
-const dateRange = (start, end) => {
-	if (start && end)
-		return {
-			DateRange: {
-				Start: start,
-				End: end,
-			},
-		};
-
-	return {};
-};
+const utils = require('../utils');
 
 module.exports = (start = null, end = null) => ({
 	version: 'h004',
 	orderDetails: {
 		OrderType: 'STA',
 		OrderAttribute: 'DZHNN',
-		StandardOrderParams: dateRange(start, end),
+		StandardOrderParams: utils.dateRange(start, end),
 	},
 	operation: 'download',
 });

lib/predefinedOrders/VMK.js

@@ -1,23 +1,13 @@
 'use strict';
 
-const dateRange = (start, end) => {
-	if (start && end)
-		return {
-			DateRange: {
-				Start: start,
-				End: end,
-			},
-		};
-
-	return {};
-};
+const utils = require('../utils');
 
 module.exports = (start = null, end = null) => ({
 	version: 'h004',
 	orderDetails: {
 		OrderType: 'VMK',
 		OrderAttribute: 'DZHNN',
-		StandardOrderParams: dateRange(start, end),
+		StandardOrderParams: utils.dateRange(start, end),
 	},
 	operation: 'download',
 });

lib/predefinedOrders/XCT.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = document => ({
+	version: 'h004',
+	orderDetails: { OrderType: 'XCT', OrderAttribute: 'OZHNN', StandardOrderParams: {} },
+	operation: 'upload',
+	document,
+});

lib/predefinedOrders/Z53.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const utils = require('../utils');
+
+module.exports = (start = null, end = null) => ({
+	version: 'h004',
+	orderDetails: {
+		OrderType: 'Z53',
+		OrderAttribute: 'DZHNN',
+		StandardOrderParams: utils.dateRange(start, end),
+	},
+	operation: 'download',
+});

lib/predefinedOrders/index.js

@@ -12,6 +12,7 @@ const CDS = require('./CDS');
 const CCT = require('./CCT');
 const CCS = require('./CCS');
 const XE3 = require('./XE3');
+const XCT = require('./XCT');
 
 const STA = require('./STA');
 const VMK = require('./VMK');
@@ -21,11 +22,13 @@ const HPD = require('./HPD');
 const HKD = require('./HKD');
 const PTK = require('./PTK');
 const HAC = require('./HAC');
+const Z53 = require('./Z53');
 
 module.exports = {
 	INI,
 	HIA,
 	HPB,
+	Z53,
 
 	AZV,
 	CD1,
@@ -35,7 +38,7 @@ module.exports = {
 	CCT,
 	CCS,
 	XE3,
-
+	XCT,
 	STA,
 	VMK,
 	HAA,

lib/storages/tracesStorage.js

@@ -58,9 +58,7 @@ module.exports = dir => ({
 
 		try {
 			fs.writeFileSync(path, this.traceData);
-			console.log("Data written to file");
 		} catch (error) {
-			console.log(error);
 			throw error;
 		}
 	},

lib/utils.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const dateRange = (start, end) => {
+	if (start && end)
+		return {
+			DateRange: {
+				Start: start,
+				End: end,
+			},
+		};
+
+	return {};
+};
+
+
+module.exports = {
+	dateRange,
+};

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ebics-client",
-	"version": "0.0.5",
+	"version": "0.0.8",
 	"description": "Node.js ISO 20022 Compliant EBICS Client",
 	"main": "index.js",
 	"scripts": {
@@ -21,6 +21,10 @@
 		{
 			"name": "Vasyl Stashuk",
 			"url": "https://github.com/vasyas"
+		},
+		{
+			"name": "Yago",
+			"url": "https://github.com/yagop"
 		}
 	],
 	"license": "MIT",