3.0.23

.gitignore

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

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-# 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
@@ -19,38 +19,41 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
-  - notpriv
+
+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
 # ====================
 
-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
@@ -60,7 +63,17 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
     - docker
-  - notpriv
+
+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:
+    - docker
 
 release:
   stage: release
@@ -70,6 +83,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +92,16 @@ release:
 # ====================
 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:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +112,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: {}

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.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

@@ -9,6 +9,7 @@
     "dockerSock": false
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "@pushrocks/smartstring",
-  "version": "3.0.11",
+  "version": "3.0.23",
   "private": false,
   "description": "handle strings in smart ways. TypeScript ready.",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -24,19 +24,36 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstring#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.28",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "@types/node": "^12.7.12",
+    "@types/node": "^14.14.17",
-    "tslint": "^5.20.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "crypto-random-string": "^3.0.1",
+    "@pushrocks/smartenv": "^4.0.16",
+    "crypto-random-string": "^3.3.0",
     "js-base64": "^2.5.1",
     "normalize-newline": "^3.0.0",
     "randomatic": "^3.1.1",
-    "strip-indent": "^3.0.0"
+    "strip-indent": "^3.0.0",
-  }
+    "url": "^0.11.0"
+  },
+  "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

@@ -8,13 +8,20 @@ handle strings in smart ways. TypeScript ready.
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartstring/)
 
 ## Status for 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)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartstring.svg)](https://www.npmjs.com/package/@pushrocks/smartstring)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartstring/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartstring)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartstring/badges/master/pipeline.svg)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartstring/badges/master/coverage.svg)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartstring)](https://lossless.cloud)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartstring)](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/smartstring)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartstring)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartstring)](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
 
@@ -58,9 +65,13 @@ smartstring.indent.indent('somestringanotherstring', '>>>> '); // indents a stri
 smartstring.indent.normalize('    somestring        anotherstring', '>>>> '); // looks for the least amount of indention and removes superflouous space
 ```
 
+## 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.html)
+| 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://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.domain.ts

@@ -29,4 +29,9 @@ tap.test('testDomain2 expect be a basic domain', async () => {
   console.log(testDomain2);
 });
 
+tap.test('should parse complex domains', async () => {
+  testDomain2 = new smartstring.Domain('https://sub1.sub2.lossless.com/some/path:5431');
+  console.log(testDomain2);
+});
+
 tap.start();

test/test.type.ts

@@ -5,4 +5,10 @@ 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/smartstring.base64.ts

@@ -65,5 +65,5 @@ export let base64 = {
    */
   decode: (stringArg: string) => {
     return plugins.jsBase64.decode(stringArg);
-  }
+  },
 };

ts/smartstring.domain.ts

@@ -16,7 +16,12 @@ export class Domain {
   public port;
   public nodeParsedUrl: plugins.url.UrlWithStringQuery;
   constructor(domainStringArg: string) {
-    const regexMatches = this._domainRegex(domainStringArg);
+    // lets do the node standard stuff first
+    this.nodeParsedUrl = plugins.url.parse(domainStringArg);
+    this.port = this.nodeParsedUrl.port;
+
+    // lets do the rest after
+    const regexMatches = this._domainRegex(domainStringArg.replace(this.nodeParsedUrl.path, ''));
     this.fullName = '';
     for (let i = 1; i <= 5; i++) {
       if (regexMatches[i - 1]) {
@@ -38,9 +43,6 @@ export class Domain {
     this.topLevel = this.level1;
     this.domainName = this.level2;
     this.subDomain = this.level3;
-
-    this.nodeParsedUrl = plugins.url.parse(domainStringArg);
-    this.port = this.nodeParsedUrl.port;
   }
 
   // helper functions

ts/smartstring.encryption.ts

@@ -10,10 +10,7 @@ export class Cryptr {
       throw new Error('Cryptr: secret must be a non-0-length string');
     }
 
-    this.key = plugins.crypto
+    this.key = plugins.crypto.createHash('sha256').update(String(secret)).digest();
-      .createHash('sha256')
-      .update(String(secret))
-      .digest();
   }
 
   encrypt(value: string) {

ts/smartstring.plugins.ts

@@ -1,13 +1,18 @@
 // node native
-import * as crypto from 'crypto';
+import * as smartenv from '@pushrocks/smartenv';
+const smartenvInstance = new smartenv.Smartenv();
+const crypto = smartenvInstance.getSafeNodeModule('crypto');
+
 import * as url from 'url';
 
 export { crypto, url };
 
 // third party
-export let jsBase64 = require('js-base64').Base64;
+const jsBase64 = require('js-base64').Base64;
 
-export let stripIndent = require('strip-indent');
+const stripIndent = require('strip-indent');
-export let normalizeNewline = require('normalize-newline');
+const normalizeNewline = require('normalize-newline');
-export let randomatic = require('randomatic');
+const randomatic = smartenvInstance.getSafeNodeModule('randomatic');
-export let cryptoRandomString = require('crypto-random-string');
+const cryptoRandomString = smartenvInstance.getSafeNodeModule('crypto-random-string');
+
+export { jsBase64, stripIndent, normalizeNewline, randomatic, cryptoRandomString };

ts/smartstring.type.ts

@@ -1,70 +1,78 @@
 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)
+  while (i < bytes.length) {
-    {
+    if (
-        if(     (// ASCII
+      // ASCII
       bytes[i] === 0x09 ||
-                    bytes[i] === 0x0A ||
+      bytes[i] === 0x0a ||
-                    bytes[i] === 0x0D ||
+      bytes[i] === 0x0d ||
-                    (0x20 <= bytes[i] && bytes[i] <= 0x7E)
+      (0x20 <= bytes[i] && bytes[i] <= 0x7e)
-                )
     ) {
       i += 1;
       continue;
     }
 
-        if(     (// non-overlong 2-byte
+    if (
-                    (0xC2 <= bytes[i] && bytes[i] <= 0xDF) &&
+      // non-overlong 2-byte
-                    (0x80 <= bytes[i+1] && bytes[i+1] <= 0xBF)
+      0xc2 <= bytes[i] &&
-                )
+      bytes[i] <= 0xdf &&
+      0x80 <= bytes[i + 1] &&
+      bytes[i + 1] <= 0xbf
     ) {
       i += 2;
       continue;
     }
 
-        if(     (// excluding overlongs
+    if (
-                    bytes[i] === 0xE0 &&
+      // excluding overlongs
-                    (0xA0 <= bytes[i + 1] && bytes[i + 1] <= 0xBF) &&
+      (bytes[i] === 0xe0 &&
-                    (0x80 <= bytes[i + 2] && bytes[i + 2] <= 0xBF)
+        0xa0 <= bytes[i + 1] &&
-                ) ||
+        bytes[i + 1] <= 0xbf &&
-                (// straight 3-byte
+        0x80 <= bytes[i + 2] &&
-                 ((0xE1 <= bytes[i] && bytes[i] <= 0xEC) ||
+        bytes[i + 2] <= 0xbf) || // straight 3-byte
-                  bytes[i] === 0xEE ||
+      (((0xe1 <= bytes[i] && bytes[i] <= 0xec) || bytes[i] === 0xee || bytes[i] === 0xef) &&
-                  bytes[i] === 0xEF) &&
+        0x80 <= bytes[i + 1] &&
-                 (0x80 <= bytes[i + 1] && bytes[i+1] <= 0xBF) &&
+        bytes[i + 1] <= 0xbf &&
-                 (0x80 <= bytes[i+2] && bytes[i+2] <= 0xBF)
+        0x80 <= bytes[i + 2] &&
-                ) ||
+        bytes[i + 2] <= 0xbf) || // excluding surrogates
-                (// excluding surrogates
+      (bytes[i] === 0xed &&
-                 bytes[i] === 0xED &&
+        0x80 <= bytes[i + 1] &&
-                 (0x80 <= bytes[i+1] && bytes[i+1] <= 0x9F) &&
+        bytes[i + 1] <= 0x9f &&
-                 (0x80 <= bytes[i+2] && bytes[i+2] <= 0xBF)
+        0x80 <= bytes[i + 2] &&
-                )
+        bytes[i + 2] <= 0xbf)
     ) {
       i += 3;
       continue;
     }
 
-        if(     (// planes 1-3
+    if (
-                    bytes[i] === 0xF0 &&
+      // planes 1-3
-                    (0x90 <= bytes[i + 1] && bytes[i + 1] <= 0xBF) &&
+      (bytes[i] === 0xf0 &&
-                    (0x80 <= bytes[i + 2] && bytes[i + 2] <= 0xBF) &&
+        0x90 <= bytes[i + 1] &&
-                    (0x80 <= bytes[i + 3] && bytes[i + 3] <= 0xBF)
+        bytes[i + 1] <= 0xbf &&
-                ) ||
+        0x80 <= bytes[i + 2] &&
-                (// planes 4-15
+        bytes[i + 2] <= 0xbf &&
-                 (0xF1 <= bytes[i] && bytes[i] <= 0xF3) &&
+        0x80 <= bytes[i + 3] &&
-                 (0x80 <= bytes[i + 1] && bytes[i + 1] <= 0xBF) &&
+        bytes[i + 3] <= 0xbf) || // planes 4-15
-                 (0x80 <= bytes[i + 2] && bytes[i + 2] <= 0xBF) &&
+      (0xf1 <= bytes[i] &&
-                 (0x80 <= bytes[i + 3] && bytes[i + 3] <= 0xBF)
+        bytes[i] <= 0xf3 &&
-                ) ||
+        0x80 <= bytes[i + 1] &&
-                (// plane 16
+        bytes[i + 1] <= 0xbf &&
-                 bytes[i] === 0xF4 &&
+        0x80 <= bytes[i + 2] &&
-                 (0x80 <= bytes[i + 1] && bytes[i + 1] <= 0x8F) &&
+        bytes[i + 2] <= 0xbf &&
-                 (0x80 <= bytes[i + 2] && bytes[i + 2] <= 0xBF) &&
+        0x80 <= bytes[i + 3] &&
-                 (0x80 <= bytes[i + 3] && bytes[i + 3] <= 0xBF)
+        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;
@@ -75,3 +83,17 @@ export const isUtf8 = (stringArg: string) => {
 
   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] === '=')
+  );
+};