Merge pull request #32 from bchainhub/update/feature-download-03

Fixed download to multiplatform

Author: rastislavcore

README.md

@@ -145,6 +145,7 @@ The library is designed to be compatible with both module systems, so you can ch
 - `getEndpoint(network?: number | string, countriesList?: string | Array<string>): { [key: string]: Array<string> }` — Get an object of SMS endpoints (phone numbers) per country.
 - `sms(number?: boolean | string | number | Array<string>, message?: string, network?: number | string, encodeMessage?: boolean, platform?: string): string` — Create an SMS URI based on the provided parameters.
 - `mms(number?: boolean | string | number | Array<string>, message?: string, network?: number | string, encodeMessage?: boolean, platform?: string): string` — Create an MMS URI based on the provided parameters.
+- `downloadMessage(hex: string, optionalFilename?: string): Promise<string>` — Download a file with the encoded content as `.txms.txt` file in your working directory.
 
 ### Parameters
 
@@ -171,7 +172,7 @@ npm i -g txms.js
 txms {type} {value} {location}
 ```
 
-- type: `encode` (`e`), `decode` (`d`), `getendpoint` (`g`)
+- type: `encode` (`e`), `decode` (`d`), `getendpoint` (`g`), `sms`, `mms`, `download` (`dl`)
 - value: message; network for getendpoint
 - location: ISO 3166 Alpha-2 country/ies code/s for getendpoint
 

bin/txms

@@ -54,8 +54,8 @@ function run(typ, value, loc) {
 			const mms = txms.mms(true, value);
 			process.stdout.write(`${mms}\n`);
 		} else if (typ === 'download' || typ === 'dl') {
-			txms.downloadMessage(value, loc);
-			process.stdout.write(`TxMS downloaded as file\n`);
+			const filename = txms.downloadMessage(value, loc);
+			process.stdout.write(`TxMS file was downloaded as "${filename}" in your working directory.\n`);
 		} else {
 			throw new Error('Invalid type specified.');
 		}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "txms.js",
-	"version": "1.2.5",
+	"version": "1.2.6",
 	"description": "Transaction messaging service protocol",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

src/index.ts

@@ -1,14 +1,11 @@
-import fs from 'fs';
-import { Buffer } from 'buffer';
-
 export interface Transport {
 	encode(hex: string): string;
 	decode(data: string): string;
 	getEndpoint(network?: number | string, countriesList?: string | Array<string>): { [key: string]: Array<string> };
 	sms(number?: boolean | string | number | Array<string>, message?: string, network?: number | string, encodeMessage?: boolean, platform?: string): string;
 	mms(number?: boolean | string | number | Array<string>, message?: string, network?: number | string, encodeMessage?: boolean, platform?: string): string;
 	generateMessageUri(type: 'sms' | 'mms', number?: boolean | string | number | Array<string>, message?: string, network?: number | string, encodeMessage?: boolean, platform?: string): string;
-	downloadMessage(hex: string, optionalFilename?: string): void;
+	downloadMessage(hex: string, optionalFilename?: string): Promise<string>;
 }
 
 export interface Error extends globalThis.Error {
@@ -170,19 +167,36 @@ const txms: Transport = {
 		return endpoint ? `${type}:${endpoint}${encodedMessage ? `${platform === 'ios' ? '&' : '?'}body=${encodedMessage}` : ''}` : `${type}:${platform === 'ios' ? '&' : '?'}body=${encodedMessage}`;
 	},
 
-	downloadMessage(hex: string, optionalFilename?: string): void {
+	async downloadMessage(hex: string, optionalFilename?: string): Promise<string> {
 		const encodedMessage = this.encode(hex);
 
 		let filename: string;
 		const cleanedHex = hex.startsWith('0x') ? hex.slice(2) : hex;
-		const first6 = cleanedHex.slice(0, 6);
-		const last6 = cleanedHex.slice(-6);
-		filename = `${first6}${last6}.txms.txt`;
+		if (cleanedHex.length < 12) {
+			filename = `${cleanedHex}.txms.txt`;
+		} else {
+			const first6 = cleanedHex.slice(0, 6);
+			const last6 = cleanedHex.slice(-6);
+			filename = `${first6}${last6}.txms.txt`;
+		}
+
 		if (optionalFilename) {
-			filename = `${slugify(filename)}.txms.txt`;
+			filename = `${slugify(optionalFilename)}.txms.txt`;
 		}
-		const buffer = Buffer.from(encodedMessage, 'utf16le').swap16();
-		fs.writeFileSync(filename, buffer);
+
+		if (typeof process !== 'undefined' && process.versions && process.versions.node) {
+			const fs = await import('fs');
+			fs.writeFileSync(filename, encodedMessage);
+		} else {
+			const blob = new Blob([encodedMessage], { type: 'text/plain;charset=utf-16' });
+
+			const link = document.createElement('a');
+			link.href = URL.createObjectURL(blob);
+			link.download = filename;
+			link.click();
+		}
+
+		return filename;
 	}
 };