3.0.13

.gitignore

@@ -1,4 +1,22 @@
-.yarn/
-pages/
+.nogit/
+
+# 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,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -34,48 +34,11 @@ snyk:
   - 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:
-  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:
+testStable:
   stage: test
   script:
   - npmci npm prepare
@@ -85,6 +48,18 @@ testSTABLE:
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - 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:
+  - docker
   - notpriv
 
 release:
@@ -103,19 +78,12 @@ 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/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
   - docker
   - priv
@@ -131,13 +99,15 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - 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:
     - docker
     - notpriv

README.md

@@ -1,25 +1,20 @@
-# smartstring
-
+# @pushrocks/smartstring
 handle strings in smart ways. TypeScript ready.
 
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartstring)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartstring)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartstring)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartstring/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstring)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstring)
+* [github.com (source mirror)](https://github.com/pushrocks/smartstring)
+* [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)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartstring.svg)](https://www.npmjs.com/package/smartstring)
-[![Dependency Status](https://david-dm.org/pushrocks/smartstring.svg)](https://david-dm.org/pushrocks/smartstring)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartstring/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartstring/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartstring/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartstring)
-[![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/)
+[![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)
+[![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)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
 
 ## Usage
 
@@ -63,8 +58,9 @@ 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.
+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)

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.9",
+  "version": "3.0.13",
   "private": false,
   "description": "handle strings in smart ways. TypeScript ready.",
   "main": "dist/index.js",
@@ -24,19 +24,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartstring#readme",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.4",
-    "@gitzone/tsrun": "^1.1.17",
-    "@gitzone/tstest": "^1.0.18",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.12.18",
-    "tslint": "^5.15.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.12",
+    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "crypto-random-string": "^1.0.0",
-    "js-base64": "^2.5.0",
+    "crypto-random-string": "^3.0.1",
+    "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"
+  ]
 }

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.create.ts

@@ -2,12 +2,12 @@ import * as plugins from './smartstring.plugins';
 
 /**
  * creates a random string
- * 
+ *
  * ```ts
  * createRandomString('AAAA')
- * //=> 'AGHR' 
+ * //=> 'AGHR'
  * ```
- * 
+ *
  * @param patternArg the pattern argument to use, Aa0!* are viable pattern descritors
  * @param lengthArg  the length of the random string
  * @param optionsArg options

ts/smartstring.domain.ts

@@ -46,7 +46,7 @@ export class Domain {
   // helper functions
 
   /** */
-  private _domainRegex (stringArg: string) {
+  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)
@@ -57,7 +57,7 @@ export class Domain {
     return regexMatchesFiltered;
   }
 
-  private _protocolRegex (stringArg: string) {
+  private _protocolRegex(stringArg: string) {
     const regexString = /^([a-zA-Z0-9]*):\/\//;
     const regexMatches = regexString.exec(stringArg);
     if (regexMatches) {
@@ -67,7 +67,7 @@ export class Domain {
     }
   }
 
-  private _portRegex (stringArg: string) {
+  private _portRegex(stringArg: string) {
     const regexString = /^([a-zA-Z0-9]*):\/\//;
     const regexMatches = regexString.exec(stringArg);
     if (regexMatches) {
@@ -76,5 +76,4 @@ export class Domain {
       return undefined;
     }
   }
-
 }

ts/smartstring.plugins.ts

@@ -2,10 +2,7 @@
 import * as crypto from 'crypto';
 import * as url from 'url';
 
-export {
-  crypto,
-  url
-};
+export { crypto, url };
 
 // third party
 export let jsBase64 = require('js-base64').Base64;
@@ -14,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,73 @@
+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) => {
+  return stringArg.endsWith('=');
+};