3.0.18

.gitignore

@@ -1,4 +1,22 @@
-.yarn/
+.nogit/
-pages/
+
+# artifacts
+coverage/
 public/
+pages/
+
+# installs
 node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -20,62 +20,27 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - docker
     - notpriv
 
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
     - npmci npm prepare
@@ -84,6 +49,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -95,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -103,20 +83,14 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   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:
+    - lossless
     - docker
     - priv
 
@@ -127,18 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+ignore: {}
+patch: {}

npmextra.json

@@ -7,5 +7,15 @@
     "baseImage": "hosttoday/ht-docker-node:npmci",
     "command": "npmci node install stable && npmci npm install && npmci npm test",
     "dockerSock": false
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartstring",
+      "shortDescription": "handle strings in smart ways. TypeScript ready.",
+      "npmPackagename": "@pushrocks/smartstring",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartstring",
-  "version": "3.0.8",
+  "version": "3.0.18",
   "private": false,
   "description": "handle strings in smart ways. TypeScript ready.",
   "main": "dist/index.js",
@@ -24,17 +24,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstring#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.1.17",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.18",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^10.12.18"
+    "@types/node": "^13.1.8",
+    "tslint": "^6.0.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "crypto-random-string": "^1.0.0",
+    "crypto-random-string": "^3.1.0",
-    "js-base64": "^2.5.0",
+    "js-base64": "^2.5.1",
     "normalize-newline": "^3.0.0",
     "randomatic": "^3.1.1",
-    "strip-indent": "^2.0.0"
+    "strip-indent": "^3.0.0"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -1,25 +1,20 @@
-# smartstring
+# @pushrocks/smartstring
-
 handle strings in smart ways. TypeScript ready.
 
-## Availabililty
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstring)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstring)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstring)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartstring)
+* [github.com (source mirror)](https://github.com/pushrocks/smartstring)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstring)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartstring/)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstring/)
 
 ## Status for master
-
+[![pipeline status](https://gitlab.com/pushrocks/smartstring/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartstring/commits/master)
-[![build status](https://GitLab.com/pushrocks/smartstring/badges/master/build.svg)](https://GitLab.com/pushrocks/smartstring/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartstring/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartstring/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartstring/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartstring/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartstring.svg)](https://www.npmjs.com/package/@pushrocks/smartstring)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartstring.svg)](https://www.npmjs.com/package/smartstring)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartstring/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartstring)
-[![Dependency Status](https://david-dm.org/pushrocks/smartstring.svg)](https://david-dm.org/pushrocks/smartstring)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstring/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstring/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartstring/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstring)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
 
@@ -63,8 +58,13 @@ smartstring.indent.indent('somestringanotherstring', '>>>> '); // indents a stri
 smartstring.indent.normalize('    somestring        anotherstring', '>>>> '); // looks for the least amount of indention and removes superflouous space
 ```
 
-For further information read the linked docs at the top of this README.
+## 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://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.normalize.ts

@@ -6,14 +6,14 @@ tap.test('should normalize a string', async () => {
   const testString = `
     myawesome string;
       is indented with two spaces
-  `
+  `;
   const normalizedString = smartstring.normalize.standard(testString);
   expect(normalizedString).to.equal(
-`
+    `
 myawesome string;
   is indented with two spaces
   `
-  )
+  );
-})
+});
 
-tap.start()
+tap.start();

test/test.type.ts

@@ -0,0 +1,14 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+import * as smartstring from '../ts';
+
+tap.test('should state valuid utf8', async () => {
+  expect(smartstring.type.isUtf8('hithere')).to.be.true;
+});
+
+tap.test('should state wether base64 string is valid', async () => {
+  const base64String = smartstring.base64.encode('hi there');
+  expect(smartstring.type.isBase64(base64String)).to.be.true;
+  expect(smartstring.type.isBase64('hi there')).to.be.false;
+});
+
+tap.start();

ts/index.ts

@@ -2,8 +2,9 @@ import * as create from './smartstring.create';
 import * as docker from './smartstring.docker';
 import * as indent from './smartstring.indent';
 import * as normalize from './smartstring.normalize';
+import * as type from './smartstring.type';
 
-export { create, docker, normalize, indent };
+export { create, docker, normalize, indent, type };
 
 export { Base64, base64 } from './smartstring.base64';
 export { Domain } from './smartstring.domain';

ts/smartstring.domain.ts

@@ -1,24 +1,26 @@
 import * as plugins from './smartstring.plugins';
 
 export class Domain {
-  fullName: string;
+  public fullName: string;
-  level1: string;
+  public level1: string;
-  level2: string;
+  public level2: string;
-  level3: string;
+  public level3: string;
-  level4: string;
+  public level4: string;
-  level5: string;
+  public level5: string;
-  protocol: string;
+  public protocol: string;
-  zoneName: string;
+  public zoneName: string;
   // aliases
-  topLevel: string;
+  public topLevel: string;
-  domainName;
+  public domainName;
-  subDomain;
+  public subDomain;
+  public port;
+  public nodeParsedUrl: plugins.url.UrlWithStringQuery;
   constructor(domainStringArg: string) {
-    let regexMatches = domainRegex(domainStringArg);
+    const regexMatches = this._domainRegex(domainStringArg);
     this.fullName = '';
     for (let i = 1; i <= 5; i++) {
       if (regexMatches[i - 1]) {
-        let localMatch = regexMatches[i - 1];
+        const localMatch = regexMatches[i - 1];
         this['level' + i.toString()] = localMatch;
         if (this.fullName === '') {
           this.fullName = localMatch;
@@ -29,33 +31,49 @@ export class Domain {
         this['level' + i.toString()] = undefined;
       }
     }
-    this.protocol = protocolRegex(domainStringArg);
+    this.protocol = this._protocolRegex(domainStringArg);
     this.zoneName = this.level2 + '.' + this.level1;
 
     // aliases
     this.topLevel = this.level1;
     this.domainName = this.level2;
     this.subDomain = this.level3;
-  }
-}
 
-let domainRegex = function(stringArg: string) {
+    this.nodeParsedUrl = plugins.url.parse(domainStringArg);
-  let regexString = /([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}$/;
+    this.port = this.nodeParsedUrl.port;
-  let regexMatches = regexString.exec(stringArg);
+  }
+
+  // helper functions
+
+  /** */
+  private _domainRegex(stringArg: string) {
+    const regexString = /([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}([a-zA-Z0-9\-\_]*)\.{0,1}$/;
+    const regexMatches = regexString.exec(stringArg);
     regexMatches.reverse(); //make sure we build the domain from toplevel to subdomain (reversed order)
     regexMatches.pop(); // pop the last element, which is, since we reversed the Array, the full String of matched elements
-  let regexMatchesFiltered = regexMatches.filter(function(stringArg: string) {
+    const regexMatchesFiltered = regexMatches.filter(function(stringArg: string) {
       return stringArg !== '';
     });
     return regexMatchesFiltered;
-};
+  }
 
-let protocolRegex = function(stringArg: string) {
+  private _protocolRegex(stringArg: string) {
-  let regexString = /^([a-zA-Z0-9]*):\/\//;
+    const regexString = /^([a-zA-Z0-9]*):\/\//;
-  let regexMatches = regexString.exec(stringArg);
+    const regexMatches = regexString.exec(stringArg);
     if (regexMatches) {
       return regexMatches[1];
     } else {
       return undefined;
     }
-};
+  }
+
+  private _portRegex(stringArg: string) {
+    const regexString = /^([a-zA-Z0-9]*):\/\//;
+    const regexMatches = regexString.exec(stringArg);
+    if (regexMatches) {
+      return regexMatches[1];
+    } else {
+      return undefined;
+    }
+  }
+}

ts/smartstring.plugins.ts

@@ -1,9 +1,8 @@
 // node native
-import * as crypto from 'crypto';
+import crypto from 'crypto';
+import * as url from 'url';
 
-export {
+export { crypto, url };
-  crypto
-}
 
 // third party
 export let jsBase64 = require('js-base64').Base64;
@@ -12,4 +11,3 @@ export let stripIndent = require('strip-indent');
 export let normalizeNewline = require('normalize-newline');
 export let randomatic = require('randomatic');
 export let cryptoRandomString = require('crypto-random-string');
-

ts/smartstring.type.ts

@@ -0,0 +1,99 @@
+import * as plugins from './smartstring.plugins';
+import * as base64 from './smartstring.base64';
+
+export const isUtf8 = (stringArg: string) => {
+  const bytes = Buffer.from(stringArg);
+  let i = 0;
+  while (i < bytes.length) {
+    if (
+      // ASCII
+      bytes[i] === 0x09 ||
+      bytes[i] === 0x0a ||
+      bytes[i] === 0x0d ||
+      (0x20 <= bytes[i] && bytes[i] <= 0x7e)
+    ) {
+      i += 1;
+      continue;
+    }
+
+    if (
+      // non-overlong 2-byte
+      0xc2 <= bytes[i] &&
+      bytes[i] <= 0xdf &&
+      0x80 <= bytes[i + 1] &&
+      bytes[i + 1] <= 0xbf
+    ) {
+      i += 2;
+      continue;
+    }
+
+    if (
+      // excluding overlongs
+      (bytes[i] === 0xe0 &&
+        0xa0 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0xbf &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf) || // straight 3-byte
+      (((0xe1 <= bytes[i] && bytes[i] <= 0xec) || bytes[i] === 0xee || bytes[i] === 0xef) &&
+        0x80 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0xbf &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf) || // excluding surrogates
+      (bytes[i] === 0xed &&
+        0x80 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0x9f &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf)
+    ) {
+      i += 3;
+      continue;
+    }
+
+    if (
+      // planes 1-3
+      (bytes[i] === 0xf0 &&
+        0x90 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0xbf &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf &&
+        0x80 <= bytes[i + 3] &&
+        bytes[i + 3] <= 0xbf) || // planes 4-15
+      (0xf1 <= bytes[i] &&
+        bytes[i] <= 0xf3 &&
+        0x80 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0xbf &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf &&
+        0x80 <= bytes[i + 3] &&
+        bytes[i + 3] <= 0xbf) || // plane 16
+      (bytes[i] === 0xf4 &&
+        0x80 <= bytes[i + 1] &&
+        bytes[i + 1] <= 0x8f &&
+        0x80 <= bytes[i + 2] &&
+        bytes[i + 2] <= 0xbf &&
+        0x80 <= bytes[i + 3] &&
+        bytes[i + 3] <= 0xbf)
+    ) {
+      i += 4;
+      continue;
+    }
+
+    return false;
+  }
+
+  return true;
+};
+
+export const isBase64 = (stringArg: string) => {
+  const notBase64 = /[^A-Z0-9+\/=]/i;
+  const len = stringArg.length;
+  if (!len || len % 4 !== 0 || notBase64.test(stringArg)) {
+    return false;
+  }
+  const firstPaddingChar = stringArg.indexOf('=');
+  return (
+    firstPaddingChar === -1 ||
+    firstPaddingChar === len - 1 ||
+    (firstPaddingChar === len - 2 && stringArg[len - 1] === '=')
+  );
+};