1.0.23

.gitignore

@@ -1,6 +1,20 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,19 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci
 
 # ====================
 # security stage
@@ -18,108 +21,115 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
+    - npmci command npm install --production --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci node install lts
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
-    
+testBuild:
-testSTABLE:
   stage: test
   script:
-  - npmci node install stable
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
+  only:
-    - docker:stable-dind
+    - tags
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
+    - npmci node install lts
-    - npmci command npmpage
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -127,4 +137,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -1,9 +1,17 @@
 {
   "npmci": {
-    "npmGlobalTools": [
+    "npmGlobalTools": [],
-      "@gitzone/npmts",
-      "ts-node"
-    ],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartcsv",
+      "shortDescription": "handle csv data | gitzone standard compliant",
+      "npmPackagename": "@pushrocks/smartcsv",
+      "license": "MIT"
+    }
   }
-}
+}

package.json

@@ -1,23 +1,43 @@
 {
   "name": "@pushrocks/smartcsv",
-  "version": "1.0.7",
+  "version": "1.0.23",
-  "private": true,
+  "private": false,
   "description": "handle csv data | gitzone standard compliant",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tsrun test/test.ts)",
+    "test": "(tstest test/)",
-    "build": "(npmts)",
+    "build": "(tsbuild)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsrun": "^1.0.5",
+    "@gitzone/tsbuild": "^2.1.28",
-    "smartfile": "^4.2.28",
+    "@gitzone/tsrun": "^1.2.18",
-    "tapbundle": "^2.0.0"
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/smartfile": "^9.0.5",
+    "@pushrocks/tapbundle": "^3.2.15",
+    "@types/node": "^17.0.7",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "smartq": "^1.1.8"
+    "@pushrocks/smartpromise": "^3.1.6",
-  }
+    "@pushrocks/smartstring": "^3.0.24"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,42 @@
+# @pushrocks/smartcsv
+handle csv data | gitzone standard compliant
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartcsv)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartcsv)
+* [github.com (source mirror)](https://github.com/pushrocks/smartcsv)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartcsv/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartcsv/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartcsv/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartcsv)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartcsv)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartcsv)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartcsv)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartcsv)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## Usage
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/sample.csv

@@ -1,3 +1,3 @@
-Header 1;Header 2; Header3
+Header 1;Header 2;"Header 3"
-row1data1; row1data2; row1data3
+"row1data1";"row1data2";"row1data3"
-row2data1; row2data2; row2data3
+"row2data1";row2data2;"row2data3"

test/test.ts

@@ -1,21 +1,27 @@
-// tslint:disable-next-line:no-implicit-dependencies
+import { expect, tap } from '@pushrocks/tapbundle';
-import { expect, tap } from 'tapbundle';
 import * as smartcsv from '../ts/index';
 
-// tslint:disable-next-line:no-implicit-dependencies
+import * as smartfile from '@pushrocks/smartfile';
-import * as smartfile from 'smartfile';
 
 let fileString: string;
 let testCsv: smartcsv.Csv;
 
-tap.test('should read a file', async tools => {
+tap.test('should read a file', async (tools) => {
   fileString = smartfile.fs.toStringSync('./test/sample.csv');
 });
 
 tap.test('should create a valid csv', async () => {
-  testCsv = await smartcsv.Csv.createCsvFromString(fileString, { headers: true });
+  testCsv = await smartcsv.Csv.createCsvFromString(fileString, { headers: true, unquote: true });
   const result = await testCsv.exportAsObject();
   console.log(result);
 });
 
+tap.test('should create a valid csv string', async () => {
+  const createdCsvString = await smartcsv.Csv.createCsvStringFromArray([
+    { wow: 'hi', wow2: 'there' },
+    { wow: 'really', wow3: 'yes' },
+  ]);
+  console.log(createdCsvString);
+});
+
 tap.start();

ts/index.ts

@@ -2,27 +2,96 @@ import * as plugins from './smartcsv.plugins';
 
 export interface ICsvConstructorOptions {
   headers: boolean;
+  unquote?: boolean;
+  removeBomMarkers?: boolean;
 }
 
 export class Csv {
+  // STATIC
+
+  /**
+   * creates a Csv Object from string
+   * @param csvStringArg
+   * @param optionsArg
+   */
   public static async createCsvFromString(
     csvStringArg: string,
-    options: ICsvConstructorOptions
+    optionsArg: ICsvConstructorOptions
   ): Promise<Csv> {
-    const csvInstance = new Csv();
+    const csvInstance = new Csv(csvStringArg, optionsArg);
-    csvInstance.csvString = csvStringArg;
+    await csvInstance.exportAsObject();
-    csvInstance.determineKeyframe();
     return csvInstance;
   }
+
+  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
   public csvString: string;
   public headers: string[];
   public keyFrame: string = null;
+  public data: any[];
+
+  private base64RecognitionPrefix = '####12345####';
 
   public options: ICsvConstructorOptions = {
-    headers: true
+    headers: true,
+    unquote: true,
+    removeBomMarkers: true,
   };
 
-  public determineKeyframe() {
+  constructor(csvStringArg: string, optionsArg: ICsvConstructorOptions) {
+    this.options = {
+      ...this.options,
+      ...optionsArg,
+    };
+
+    let csvStringToParse = csvStringArg;
+    if (this.options.removeBomMarkers) {
+      csvStringToParse = csvStringToParse.replace(/^\uFEFF/, '');
+    }
+    if (this.options.unquote) {
+      csvStringToParse = csvStringToParse.replace(
+        /"(.*?)"/gi,
+        (match, p1, offset, originalString) => {
+          return this.base64RecognitionPrefix + plugins.smartstring.base64.encode(match);
+        }
+      );
+    }
+
+    this.csvString = csvStringToParse;
+
+    this.determineKeyframe();
+  }
+
+  /**
+   * determines the keyframe of the csv string
+   */
+  private determineKeyframe() {
     let commaLength = 0;
     let semicolonLength = 0;
     const commaRegexResult = this.csvString.match(/,/g);
@@ -41,7 +110,10 @@ export class Csv {
     }
   }
 
-  public serializeCsvString() {
+  /**
+   * serializes the csv string
+   */
+  private serializeCsvString() {
     const rowArray = this.getRows();
     const resultArray = [];
     if (this.options.headers) {
@@ -54,7 +126,10 @@ export class Csv {
     return resultArray;
   }
 
-  public getRows(): string[] {
+  /**
+   * gets the rows of the csv
+   */
+  private getRows(): string[] {
     const rowsArray = this.csvString.split('\n');
     if (rowsArray[rowsArray.length - 1] === '') {
       rowsArray.pop();
@@ -62,20 +137,40 @@ export class Csv {
     return rowsArray;
   }
 
-  public getHeaders() {
+  private getHeaders() {
     const rowArray = this.getRows();
     if (this.options.headers) {
       let headerRow = rowArray[0];
       this.headers = headerRow.split(this.keyFrame);
+      if (this.options.unquote) {
+        const unquotedHeaders: string[] = [];
+        for (let header of this.headers) {
+          if (header.startsWith(this.base64RecognitionPrefix)) {
+            header = header.replace(this.base64RecognitionPrefix, '');
+            unquotedHeaders.push(plugins.smartstring.base64.decode(header).replace(/['"]+/g, ''));
+          } else {
+            unquotedHeaders.push(header);
+          }
+        }
+        this.headers = unquotedHeaders;
+      }
     }
     return this.headers;
   }
 
-  public createDataObject(dataArray: string[]) {
+  private createDataObject(dataArray: string[]) {
     const neededIterations = dataArray.length;
     let resultJson: any = {};
     for (let i = 0; i < neededIterations; i++) {
-      resultJson[this.headers[i]] = dataArray[i];
+      let value = dataArray[i];
+      if (this.options.unquote && value.startsWith(this.base64RecognitionPrefix)) {
+        value = value.replace(this.base64RecognitionPrefix, '');
+        value = plugins.smartstring.base64
+          .decode(value)
+          .replace(/['"]+/g, '')
+          .replace(/['"]+/g, '');
+      }
+      resultJson[this.headers[i]] = value;
     }
     return resultJson;
   }
@@ -86,6 +181,7 @@ export class Csv {
     for (const dataArray of serializedData) {
       dataObjects.push(this.createDataObject(dataArray));
     }
+    this.data = dataObjects;
     return dataObjects;
   }
 }

ts/smartcsv.plugins.ts

@@ -1,3 +1,4 @@
-import * as smartq from 'smartq';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartstring from '@pushrocks/smartstring';
 
-export { smartq };
+export { smartpromise, smartstring };

tslint.json

@@ -1,13 +1,17 @@
 {
-    "extends": [
+  "extends": ["tslint:latest", "tslint-config-prettier"],
-      "tslint:latest",
+  "rules": {
-      "tslint-config-prettier"
+    "semicolon": [true, "always"],
-    ],
+    "no-console": false,
-    "rules": {
+    "ordered-imports": false,
-      "semicolon": [
+    "object-literal-sort-keys": false,
-        true,
+    "member-ordering": {
-        "always"
+      "options":{
-      ]
+        "order": [
+          "static-method"
+        ]
+      }
     }
-  }
+  },
-  
+  "defaultSeverity": "warning"
+}