Refactor io output functions into nodejs folder-getting rid of browser related methods

Author: risenW

src/danfojs-base/core/frame.ts

@@ -12,8 +12,6 @@
 * limitations under the License.
 * ==========================================================================
 */
-import { toCSVBrowser, toExcelBrowser, toJSONBrowser } from "../io/browser";
-import { toCSVNode, toExcelNode, toJSONNode } from "../io/node";
 import dummyEncode from "../transformers/encoders/dummy.encoder";
 import { variance, std, median, mode, mean } from 'mathjs';
 import tensorflow from '../shared/tensorflowlib'
@@ -32,12 +30,6 @@ import {
     ArrayType2D,
     DataFrameInterface,
     BaseDataOptionType,
-    CsvOutputOptionsBrowser,
-    ExcelOutputOptionsBrowser,
-    JsonOutputOptionsBrowser,
-    CsvOutputOptionsNode,
-    ExcelOutputOptionsNode,
-    JsonOutputOptionsNode
 } from "../shared/types";
 
 const utils = new Utils();
@@ -3383,157 +3375,6 @@ export default class DataFrame extends NDframe implements DataFrameInterface {
         }
     }
 
-    /**
-     * Converts a DataFrame to CSV. 
-     * @param options Configuration object. Supports the following options:
-     * - `filePath`: Local file path to write the CSV file. If not specified, the CSV will be returned as a string. Option is only available in NodeJS.
-     * - `fileName`: Name of the CSV file. Defaults to `data.csv`. Option is only available in Browser.
-     * - `download`: If true, the CSV will be downloaded. Defaults to false. Option is only available in Browser.
-     * - `header`: Boolean indicating whether to include a header row in the CSV file.
-     * - `sep`: Character to be used as a separator in the CSV file.
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const csv = df.toCSV()
-     * console.log(csv)
-     * //output
-     * "A","B"
-     * 1,2
-     * 3,4
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const csv = df.toCSV({ header: false })
-     * console.log(csv)
-     * //output
-     * 1,2
-     * 3,4
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const csv = df.toCSV({ sep: ';' })
-     * console.log(csv)
-     * //output
-     * "A";"B"
-     * 1;2
-     * 3;4
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toCSV({ filePath: './data.csv' }) //write to local file in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toCSV({ fileName: 'data.csv', download: true }) //Downloads file in Browser
-     * ```
-     * 
-     */
-    toCSV(options?: CsvOutputOptionsBrowser | CsvOutputOptionsNode): string
-    toCSV(options?: CsvOutputOptionsBrowser | CsvOutputOptionsNode): string | void {
-        if (utils.isBrowserEnv()) {
-            return toCSVBrowser(this, options as CsvOutputOptionsBrowser)
-        } else {
-            return toCSVNode(this, options as CsvOutputOptionsNode)
-        }
-    }
-
-    /**
-     * Converts a DataFrame to JSON. 
-     * @param options Configuration object. Supported options:
-     * - `filePath`: The file path to write the JSON to. If not specified, the JSON object is returned. Option is only available in NodeJS.
-     * - `fileName`: The name of the JSON file. Defaults to `data.json`. Option is only available in Browser.
-     * - `download`: If true, the JSON will be downloaded. Defaults to false. Option is only available in Browser.
-     * - `format`: The format of the JSON. Supported values are `'column'` and `'row'`. Defaults to `'column'`.
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const json = df.toJSON()
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const json = df.toJSON({ format: 'row' })
-     * console.log(json)
-     * //output
-     * [{"A":1,"B":2},{"A":3,"B":4}]
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * const json = df.toJSON({ format: "column" })
-     * console.log(json)
-     * //output
-     * {"A":[1,3],"B":[2,4]}
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toJSON({ filePath: './data.json' }) // downloads to local file system as data.json in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toJSON({ fileName: 'data.json', download: true }) // downloads file browser
-     * ```
-     */
-    toJSON(options?: JsonOutputOptionsBrowser | JsonOutputOptionsNode): object
-    toJSON(options?: JsonOutputOptionsBrowser | JsonOutputOptionsNode): object | void {
-        if (utils.isBrowserEnv()) {
-            return toJSONBrowser(this, options as JsonOutputOptionsBrowser)
-        } else {
-            return toJSONNode(this, options as JsonOutputOptionsNode)
-        }
-    }
-
-
-    /**
-     * Converts a DataFrame to Excel file format. 
-     * @param options Configuration object. Supported options:
-     * - `sheetName`: The sheet name to be written to. Defaults to `'Sheet1'`.
-     * - `filePath`: The filePath to be written to. Defaults to `'./output.xlsx'`. Option is only available in NodeJs
-     * - `fileName`: The fileName to be written to. Defaults to `'output.xlsx'`. Option is only available in Browser
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toExcel({ filePath: './output.xlsx' }) // writes to local file system as output.xlsx in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toExcel({ fileName: 'output.xlsx', download: true }) // downloads file browser
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new DataFrame([[1, 2], [3, 4]], { columns: ['A', 'B']})
-     * df.toExcel({ sheetName: 'Sheet2' }) // writes to Sheet2 in Excel
-     * ```
-     * 
-     */
-    toExcel(options?: ExcelOutputOptionsBrowser | ExcelOutputOptionsNode): void {
-        if (utils.isBrowserEnv()) {
-            toExcelBrowser(this, options as ExcelOutputOptionsBrowser)
-        } else {
-            return toExcelNode(this, options as ExcelOutputOptionsNode)
-        }
-    }
-
     /**
      * Access a single value for a row/column pair by integer position.
      * Similar to {@link iloc}, in that both provide integer-based lookups. 

src/danfojs-base/core/series.ts

@@ -12,8 +12,6 @@
 * limitations under the License.
 * ==========================================================================
 */
-import { toCSVBrowser, toExcelBrowser, toJSONBrowser } from "../io/browser";
-import { toCSVNode, toExcelNode, toJSONNode } from "../io/node";
 import dummyEncode from "../transformers/encoders/dummy.encoder";
 import { variance, std, median, mode } from 'mathjs';
 import tensorflow from '../shared/tensorflowlib'
@@ -2159,114 +2157,6 @@ export default class Series extends NDframe implements SeriesInterface {
         }
     }
 
-    /**
-     * Converts a Series to CSV. 
-     * @param options Configuration object. Supports the following options:
-     * - `filePath`: Local file path to write the CSV file. If not specified, the CSV will be returned as a string. Option is only available in NodeJS.
-     * - `fileName`: Name of the CSV file. Defaults to `data.csv`. Option is only available in Browser.
-     * - `download`: If true, the CSV will be downloaded. Defaults to false. Option is only available in Browser.
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * const csv = df.toCSV()
-     * console.log(csv)
-     * //output "1,2,3,4"
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toCSV({ filePath: './data.csv' }) //write to local file in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toCSV({ fileName: 'data.csv', download: true }) //Downloads file in Browser
-     * ```
-     * 
-    */
-    toCSV(options?: CsvOutputOptionsBrowser | CsvOutputOptionsNode): string
-    toCSV(options?: CsvOutputOptionsBrowser | CsvOutputOptionsNode): string | void {
-        if (utils.isBrowserEnv()) {
-            return toCSVBrowser(this, options as CsvOutputOptionsBrowser)
-        } else {
-            return toCSVNode(this, options as CsvOutputOptionsNode)
-        }
-    }
-
-    /**
-     * Converts a Series to JSON. 
-     * @param options Configuration object. Supported options:
-     * - `filePath`: The file path to write the JSON to. If not specified, the JSON object is returned. Option is only available in NodeJS.
-     * - `fileName`: The name of the JSON file. Defaults to `data.json`. Option is only available in Browser.
-     * - `download`: If true, the JSON will be downloaded. Defaults to false. Option is only available in Browser.
-     * 
-     * @example
-     * ```
-     * const df = new Series([[1, 2, 3, 4]], { columns: ['A']})
-     * const json = df.toJSON()
-     * console.log(json)
-     * //output { A: [ '1,2,3,4' ] }
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toJSON({ filePath: './data.json' }) // downloads to local file system as data.json in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toJSON({ fileName: 'data.json', download: true }) // downloads file browser
-     * ```
-    */
-    toJSON(options?: JsonOutputOptionsBrowser | JsonOutputOptionsNode): object
-    toJSON(options?: JsonOutputOptionsBrowser | JsonOutputOptionsNode): object | void {
-        if (utils.isBrowserEnv()) {
-            return toJSONBrowser(this, options as JsonOutputOptionsBrowser)
-        } else {
-            return toJSONNode(this, options as JsonOutputOptionsNode)
-        }
-    }
-
-
-    /**
-     * Converts a Series to Excel file format. 
-     * @param options Configuration object. Supported options:
-     * - `sheetName`: The sheet name to be written to. Defaults to `'Sheet1'`.
-     * - `filePath`: The filePath to be written to. Defaults to `'./output.xlsx'`. Option is only available in NodeJs
-     * - `fileName`: The fileName to be written to. Defaults to `'output.xlsx'`. Option is only available in Browser
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toExcel({ filePath: './output.xlsx' }) // writes to local file system as output.xlsx in NodeJS
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toExcel({ fileName: 'output.xlsx', download: true }) // downloads file browser
-     * ```
-     * 
-     * @example
-     * ```
-     * const df = new Series([1, 2, 3, 4])
-     * df.toExcel({ sheetName: 'Sheet2' }) // writes to Sheet2 in Excel
-     * ```
-     * 
-    */
-    toExcel(options?: ExcelOutputOptionsBrowser | ExcelOutputOptionsNode): void {
-        if (utils.isBrowserEnv()) {
-            toExcelBrowser(this, options as ExcelOutputOptionsBrowser)
-        } else {
-            return toExcelNode(this, options as ExcelOutputOptionsNode)
-        }
-    }
-
     /**
      * Access a single value for a row index.
      * Similar to iloc, in that both provide index-based lookups. 

src/danfojs-base/shared/types.ts

@@ -181,9 +181,6 @@ export interface SeriesInterface extends NDframeInterface {
         inplace?: boolean
     }): DataFrame
     plot(divId: string): IPlotlyLib
-    toCSV(options?: CsvOutputOptionsBrowser): string | void
-    toJSON(options?: JsonOutputOptionsBrowser): object | void
-    toExcel(options?: ExcelOutputOptionsBrowser): void
     iat(index: number): number | string | boolean | undefined
     at(index: string | number): number | string | boolean | undefined
 }
@@ -329,9 +326,6 @@ export interface DataFrameInterface extends NDframeInterface {
         inplace?: boolean
     }): DataFrame | void
     plot(divId: string): IPlotlyLib
-    toCSV(options?: CsvOutputOptionsBrowser): string | void
-    toJSON(options?: JsonOutputOptionsBrowser): object | void
-    toExcel(options?: ExcelOutputOptionsBrowser): void
     iat(row: number, column: number): number | string | boolean | undefined
     at(row: string | number, column: string): number | string | boolean | undefined
 }

src/danfojs-node/package.json

@@ -26,16 +26,18 @@
     "request": "^2.88.2",
     "seedrandom": "^2.4.3",
     "stream-json": "^1.7.3",
-    "table": "6.7.1",
-    "xlsx": "^0.17.2",
-    "plotly.js-dist-min": "^2.8.0"
+    "table": "6.7.1"
+  },
+  "peerDependencies": {
+    "plotly.js-dist-min": "^2.8.0",
+    "xlsx": "0.17.2"
   },
   "scripts": {
     "test": "nyc mocha --require ts-node/register test/**/*.test.ts",
     "test:clean": "yarn build:clean && yarn test",
     "dev": "nodemon",
     "build": "tsc",
-    "build:clean": "rimraf ./build && node ./scripts/prebuild.js && tsc",
+    "build:clean": "rm -rf ./dist && node ./scripts/prebuild.js && tsc",
     "lint": "eslint ./src",
     "coveralls": "cat ./coverage/lcov.info | ./node_modules/.bin/coveralls",
     "coverage": "nyc report --reporter=text-lcov | coveralls && nyc report --reporter=lcov",