smartcsv/ts/index.ts

203 lines
5.5 KiB
TypeScript
Raw Normal View History

import * as plugins from './smartcsv.plugins.js';
2018-05-10 17:47:14 +00:00
export interface ICsvConstructorOptions {
headers: boolean;
2019-10-11 13:48:23 +00:00
unquote?: boolean;
trimSpace?: boolean;
removeBomMarkers?: boolean;
2018-05-10 17:47:14 +00:00
}
export class Csv {
2019-05-23 15:28:21 +00:00
// STATIC
/**
* creates a Csv Object from string
* @param csvStringArg
* @param optionsArg
*/
public static async createCsvFromString(
csvStringArg: string,
optionsArg: ICsvConstructorOptions
): Promise<Csv> {
const csvInstance = new Csv(csvStringArg, optionsArg);
2019-10-10 16:30:29 +00:00
await csvInstance.exportAsObject();
2018-05-10 17:47:14 +00:00
return csvInstance;
}
2019-05-23 15:28:21 +00:00
public static async createCsvStringFromArray(arrayArg: any[]): Promise<string> {
const foundKeys: string[] = [];
// lets deal with the keys
for (const objectArg of arrayArg) {
for (const key of Object.keys(objectArg)) {
foundKeys.includes(key) ? null : foundKeys.push(key);
}
}
// lets deal with the data
const dataRows: string[] = [];
for (const objectArg of arrayArg) {
const dataRowArray: string[] = [];
for (const key of foundKeys) {
dataRowArray.push(objectArg[key]);
}
dataRows.push(dataRowArray.join(','));
}
// lets put togehter the csv string and return it
const headerString = foundKeys.join(',');
const dataString = dataRows.join('\n');
const csvString = `${headerString}\n${dataString}\n`;
return csvString;
}
// INSTANCE
2018-05-10 17:47:14 +00:00
public csvString: string;
public headers: string[];
public keyFrame: string = null;
2019-10-10 16:30:29 +00:00
public data: any[];
2018-05-10 17:47:14 +00:00
2019-12-15 18:15:03 +00:00
private base64RecognitionPrefix = '####12345####';
2018-05-10 17:47:14 +00:00
public options: ICsvConstructorOptions = {
2019-10-10 16:30:29 +00:00
headers: true,
unquote: true,
trimSpace: true,
removeBomMarkers: true,
2018-05-10 17:47:14 +00:00
};
constructor(csvStringArg: string, optionsArg: ICsvConstructorOptions) {
2019-10-10 16:30:29 +00:00
this.options = {
...this.options,
...optionsArg,
2019-10-10 16:30:29 +00:00
};
let csvStringToParse = csvStringArg;
if (this.options.removeBomMarkers) {
csvStringToParse = csvStringToParse.replace(/^\uFEFF/, '');
}
// Quotes allow separators to be contained in quoted strings.
// To preserve them, when unquoting, we convert everything in between to base64 here
2019-10-10 16:30:29 +00:00
if (this.options.unquote) {
csvStringToParse = csvStringToParse.replace(
/"(.*?)"/gi,
(match, p1, offset, originalString) => {
2019-12-15 18:15:03 +00:00
return this.base64RecognitionPrefix + plugins.smartstring.base64.encode(match);
2019-10-10 16:30:29 +00:00
}
);
}
this.csvString = csvStringToParse;
this.determineKeyframe();
}
/**
* determines the keyframe of the csv string
*/
2019-10-10 16:30:29 +00:00
private determineKeyframe() {
let commaLength = 0;
let semicolonLength = 0;
const commaRegexResult = this.csvString.match(/,/g);
const semicolonRegexResult = this.csvString.match(/;/g);
if (commaRegexResult) {
commaLength = commaRegexResult.length;
}
if (semicolonRegexResult) {
semicolonLength = semicolonRegexResult.length;
}
// tslint:disable-next-line:prefer-conditional-expression
if (commaLength < semicolonLength) {
this.keyFrame = ';';
} else {
this.keyFrame = ',';
}
}
/**
* serializes the csv string
*/
2019-10-10 16:30:29 +00:00
private serializeCsvString() {
2018-05-10 17:47:14 +00:00
const rowArray = this.getRows();
const resultArray = [];
if (this.options.headers) {
this.getHeaders();
rowArray.shift();
}
for (const row of rowArray) {
resultArray.push(row.split(this.keyFrame));
2018-05-10 17:47:14 +00:00
}
return resultArray;
}
2019-10-10 16:30:29 +00:00
/**
* gets the rows of the csv
*/
private getRows(): string[] {
2018-06-10 12:29:09 +00:00
const rowsArray = this.csvString.split('\n');
if (rowsArray[rowsArray.length - 1] === '') {
rowsArray.pop();
}
return rowsArray;
2018-05-10 17:47:14 +00:00
}
2019-10-10 16:30:29 +00:00
private getHeaders() {
2018-05-10 17:47:14 +00:00
const rowArray = this.getRows();
if (this.options.headers) {
let headerRow = rowArray[0];
this.headers = headerRow.split(this.keyFrame);
2019-10-10 16:30:29 +00:00
if (this.options.unquote) {
const unquotedHeaders: string[] = [];
2019-12-15 18:15:03 +00:00
for (let header of this.headers) {
if (header.startsWith(this.base64RecognitionPrefix)) {
header = header.replace(this.base64RecognitionPrefix, '');
2019-10-10 16:30:29 +00:00
unquotedHeaders.push(plugins.smartstring.base64.decode(header).replace(/['"]+/g, ''));
} else {
unquotedHeaders.push(header);
}
}
this.headers = unquotedHeaders;
}
if (this.options.trimSpace) {
const trimmedHeaders = [];
for (const header of this.headers) {
trimmedHeaders.push(header.trim());
}
this.headers = trimmedHeaders;
}
2018-05-10 17:47:14 +00:00
}
return this.headers;
}
2019-10-10 16:30:29 +00:00
private createDataObject(dataArray: string[]) {
2018-05-10 17:47:14 +00:00
const neededIterations = dataArray.length;
let resultJson: any = {};
for (let i = 0; i < neededIterations; i++) {
2019-10-10 16:30:29 +00:00
let value = dataArray[i];
2019-12-15 18:15:03 +00:00
if (this.options.unquote && value.startsWith(this.base64RecognitionPrefix)) {
value = value.replace(this.base64RecognitionPrefix, '');
value = plugins.smartstring.base64
.decode(value)
.replace(/['"]+/g, '')
.replace(/['"]+/g, '');
2019-10-10 16:30:29 +00:00
}
if (this.options.trimSpace) {
value = value.trim();
}
2019-10-10 16:30:29 +00:00
resultJson[this.headers[i]] = value;
2018-05-10 17:47:14 +00:00
}
return resultJson;
}
public async exportAsObject(): Promise<any> {
2018-05-10 17:47:14 +00:00
const serializedData = this.serializeCsvString();
const dataObjects = [];
for (const dataArray of serializedData) {
dataObjects.push(this.createDataObject(dataArray));
}
2019-10-10 16:30:29 +00:00
this.data = dataObjects;
2018-05-10 17:47:14 +00:00
return dataObjects;
}
}