2.0.1

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smarturl",
-  "version": "1.0.2",
+  "version": "2.0.1",
   "private": false,
   "description": "a url parsing lib",
   "main": "dist_ts/index.js",
@@ -8,16 +8,15 @@
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)"
-    "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^10.11.7",
+    "@types/node": "^14.14.37",
-    "tslint": "^5.11.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {},
@@ -32,5 +31,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,13 +8,20 @@ a url parsing lib
 * [docs (typedoc)](https://pushrocks.gitlab.io/smarturl/)
 
 ## Status for master
-[![pipeline status](https://gitlab.com/pushrocks/smarturl/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smarturl/commits/master)
+
-[![coverage report](https://gitlab.com/pushrocks/smarturl/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smarturl/commits/master)
+Status Category | Status Badge
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smarturl.svg)](https://www.npmjs.com/package/@pushrocks/smarturl)
+-- | --
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smarturl/badge.svg)](https://snyk.io/test/npm/@pushrocks/smarturl)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smarturl/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/smarturl/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/smarturl)](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/smarturl)](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/smarturl)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smarturl)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smarturl)](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
 

test/test.ts

@@ -1,8 +1,25 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smarturl from '../ts/index';
 
+let testSmarturl: smarturl.Smarturl;
+
 tap.test('first test', async () => {
-  console.log(smarturl.standardExport);
+  testSmarturl = new smarturl.Smarturl();
+  expect(testSmarturl).to.be.instanceOf(smarturl.Smarturl);
+});
+
+tap.test('should parse an URL', async () => {
+  const testUrl = 'https://lossless.com:3000/?some=cool&more=yes';
+  // const urlMod = await import('url');
+  // const altParsed = urlMod.parse(testUrl);
+  // console.log(altParsed);
+  const parsedUrl = smarturl.Smarturl.createFromUrl(testUrl, {
+    searchParams: {
+      more: 'overwritten'
+    }
+  });
+  console.log(parsedUrl);
+  console.log(parsedUrl.toString());
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1 @@
-import * as plugins from './smarturl.plugins';
+export * from './smarturl.classes.smarturl';
-
-export let standardExport = 'Hi there! :) This is an exported string';

ts/smarturl.classes.smarturl.ts

@@ -0,0 +1,112 @@
+import * as plugins from './smarturl.plugins';
+
+export interface IUrlObject {
+  href: string;
+  origin: string;
+  protocol: string;
+  username: string;
+  password: string;
+  host: string;
+  hostname: string;
+  port: string;
+  path: string;
+  pathname: string;
+  search: string;
+  searchParams: ISearchParams;
+  hash: string;
+}
+
+export interface ISearchParams {
+  [key: string]: string;
+}
+
+export class Smarturl implements IUrlObject {
+  public static createFromUrl(
+    urlArg: string,
+    optionsArg?: {
+      searchParams?: ISearchParams;
+    }
+  ): Smarturl {
+    const parsedUrlInstance = new plugins.url.URL(urlArg);
+    const searchParams: ISearchParams = {};
+
+    // enrichment
+    const searchParamKeys = parsedUrlInstance.searchParams.keys();
+    for (const key of searchParamKeys) {
+      searchParams[key] = parsedUrlInstance.searchParams.get(key);
+    }
+    if (optionsArg?.searchParams) {
+      for (const key of Object.keys(optionsArg.searchParams)) {
+        searchParams[key] = optionsArg.searchParams[key];
+      }
+    }
+
+    let path = parsedUrlInstance.pathname;
+    if (Object.keys(searchParams).length > 0) {
+      path += '?';
+      let first = true;
+      for(const key of Object.keys(searchParams)) {
+        if (first) {
+          first = false;
+        } else {
+          path += '&';
+        }
+        path += `${key}=${searchParams[key]}`;
+      }
+    }
+
+    const parsedUrl: IUrlObject = {
+      href: parsedUrlInstance.href,
+      origin: parsedUrlInstance.origin,
+      protocol: parsedUrlInstance.protocol,
+      username: parsedUrlInstance.username,
+      password: parsedUrlInstance.password,
+      host: parsedUrlInstance.host,
+      hostname: parsedUrlInstance.hostname,
+      port: parsedUrlInstance.port,
+      path,
+      pathname: parsedUrlInstance.pathname,
+      search: parsedUrlInstance.search,
+      searchParams,
+      hash: parsedUrlInstance.hash,
+    };
+
+    if (!parsedUrl.port && parsedUrl.protocol === 'https:') {
+      // console.log(`inferring port 443 for "https:"`);
+      parsedUrl.port = '443';
+    }
+    if (!parsedUrl.port && parsedUrl.protocol === 'http:') {
+      // console.log(`inferring port 80 for "http:"`);
+      parsedUrl.port = '80';
+    }
+    const returnSmarturl = new Smarturl();
+    Object.assign(returnSmarturl, parsedUrl);
+    return returnSmarturl;
+  }
+  public static createFromParsedUrl(parsedUrlArg: IUrlObject) {
+    const returnSmarturl = new Smarturl();
+    Object.assign(returnSmarturl, parsedUrlArg);
+    return returnSmarturl;
+  }
+
+  // INSTANCE
+  href: string;
+  origin: string;
+  protocol: string;
+  username: string;
+  password: string;
+  host: string;
+  hostname: string;
+  port: string;
+  path: string;
+  pathname: string;
+  search: string;
+  searchParams: ISearchParams;
+  hash: string;
+
+  constructor() {}
+
+  toString() {
+    return `${this.protocol}//${this.hostname}:${this.port}${this.path}`
+  }
+}

ts/smarturl.plugins.ts

@@ -1,2 +1,4 @@
-const removeme = {};
+// node native
-export { removeme };
+import * as url from 'url';
+
+export { url };