Merge pull request alexcaza#6 from devlavshah/feature_for_txt

Issue: 3 : Feature for text file alexcaza#3

Author: alexcaza

README.md

@@ -47,6 +47,7 @@ var data = [
     showLabels: true, 
     showTitle: true,
     title: 'My Awesome CSV',
+    useTextFile: false,
     useBom: true,
     useKeysAsHeaders: true,
     // headers: ['Column 1', 'Column 2', etc...] <-- Won't work with useKeysAsHeaders present!
@@ -71,6 +72,7 @@ csvExporter.generateCsv(data);
 | **showTitle** | false      | Includes the title as the first line in the generated file   |
 | **title** | 'My Generated Report' | This string will be used as the report title |
 | **useBom** | true      | If true, adds a BOM character at the start of the CSV to improve file compatibility |
+| **useTextFile** | false      | If true, returns a `.txt` file instead of `.csv` |
 | **useKeysAsHeaders** | false      | If true, this will use the keys of the first object in the collection as the column headers|
 | **headers** | []      | Expects an array of strings, which if supplied, will be used as the column headers|
 

export-to-csv.spec.ts

@@ -72,5 +72,54 @@ describe('ExportToCsv', () => {
         const exportToCsvInstance = new ExportToCsv(options);
         exportToCsvInstance.generateCsv(mockData);
 
+    });
+});
+
+describe('ExportToCsv As A Text File', () => {
+    it('should create a comma seperated string', () => {
+        const options: Options = {
+            title: "Test Csv 1",
+            useTextFile: true,
+            useBom: true,
+            useKeysAsHeaders: true,
+        };
+
+        const exportToCsvInstance = new ExportToCsv(options);
+        const string = exportToCsvInstance.generateCsv(mockData, true);
+        expect(string).toBeTruthy(typeof string === 'string');
+    });
+
+    it('should use keys of first object in collection as headers', () => {
+        const options: Options = {
+            filename: "Test Csv 2",
+            useTextFile: true,
+            useBom: true,
+            useKeysAsHeaders: true,
+        };
+
+        const exportToCsvInstance = new ExportToCsv(options);
+        const string = exportToCsvInstance.generateCsv(mockData, true);
+
+        const firstLine = string.split('\n')[0];
+        const keys = firstLine.split(',').map((s: string) => s.trim());
+
+        const mockDataKeys = Object.keys(mockData[0]);
+        expect(keys).toEqual(mockDataKeys);
+    });
+
+    it('should initiate download through spawned browser', () => {
+        if (!window) {
+            pending('it should only initiate download when run in browser context');
+        }
+        const options: Options = {
+            filename: "Test Csv 3",
+            useTextFile: true,
+            useBom: true,
+            useKeysAsHeaders: true
+        };
+
+        const exportToCsvInstance = new ExportToCsv(options);
+        exportToCsvInstance.generateCsv(mockData);
+
     });
 });

export-to-csv.ts

@@ -6,6 +6,7 @@ export interface Options {
     showLabels?: boolean;
     showTitle?: boolean;
     title?: string;
+    useTextFile?: boolean,
     useBom?: boolean;
     headers?: string[];
     useKeysAsHeaders?: boolean;
@@ -23,6 +24,7 @@ export class CsvConfigConsts {
     public static DEFAULT_TITLE = 'My Generated Report';
     public static DEFAULT_FILENAME = 'generated';
     public static DEFAULT_SHOW_LABELS = false;
+    public static DEFAULT_USE_TEXT_FILE= false;
     public static DEFAULT_USE_BOM = true;
     public static DEFAULT_HEADER: string[] = [];
     public static DEFAULT_KEYS_AS_HEADERS = false;
@@ -37,6 +39,7 @@ export const ConfigDefaults: Options = {
     showLabels: CsvConfigConsts.DEFAULT_SHOW_LABELS,
     showTitle: CsvConfigConsts.DEFAULT_SHOW_TITLE,
     title: CsvConfigConsts.DEFAULT_TITLE,
+    useTextFile: CsvConfigConsts.DEFAULT_USE_TEXT_FILE,
     useBom: CsvConfigConsts.DEFAULT_USE_BOM,
     headers: CsvConfigConsts.DEFAULT_HEADER,
     useKeysAsHeaders: CsvConfigConsts.DEFAULT_KEYS_AS_HEADERS,
@@ -104,18 +107,21 @@ export class ExportToCsv {
 
         // Create CSV blob to download if requesting in the browser and the
         // consumer doesn't set the shouldReturnCsv param
-        let blob = new Blob([this._csv], { "type": "text/csv;charset=utf8;" });
+        const FileType = this._options.useTextFile ? 'plain' : 'csv';
+        const fileExtension = this._options.useTextFile ? '.txt' : '.csv';
+        let blob = new Blob([this._csv], { "type": "text/" + FileType + ";charset=utf8;" });
 
         if (navigator.msSaveBlob) {
-            let filename = this._options.filename.replace(/ /g, "_") + ".csv";
+            let filename = this._options.filename.replace(/ /g, "_") + fileExtension;
             navigator.msSaveBlob(blob, filename);
         } else {
-            let uri = 'data:attachment/csv;charset=utf-8,' + encodeURI(this._csv);
+            const attachmentType = this._options.useTextFile ? 'text' : 'csv';
+            let uri = 'data:attachment/'+ attachmentType +';charset=utf-8,' + encodeURI(this._csv);
             let link = document.createElement("a");
             link.href = URL.createObjectURL(blob);
 
             link.setAttribute('visibility', 'hidden');
-            link.download = this._options.filename.replace(/ /g, "_") + ".csv";
+            link.download = this._options.filename.replace(/ /g, "_") + fileExtension;
 
             document.body.appendChild(link);
             link.click();