3.0.2

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
-- test
-- release
-- metadata
+  - security
+  - test
+  - release
+  - metadata
 
 # ====================
 # security stage
@@ -18,60 +18,65 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
-  - notpriv
+    - 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:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci command npm run build
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install lts
-  - npmci npm publish
+    - npmci node install stable
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,31 +86,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
-  - priv
+    - lossless
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
-  - notpriv
+    - lossless
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -113,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

README.md

@@ -1,64 +0,0 @@
-# @tsclass/tsclass
-common classes for TypeScript
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@tsclass/tsclass)
-* [gitlab.com (source)](https://gitlab.com/tsclass/tsclass)
-* [github.com (source mirror)](https://github.com/tsclass/tsclass)
-* [docs (typedoc)](https://tsclass.gitlab.io/tsclass/)
-
-## Status for master
-[![build status](https://gitlab.com/tsclass/tsclass/badges/master/build.svg)](https://gitlab.com/tsclass/tsclass/commits/master)
-[![coverage report](https://gitlab.com/tsclass/tsclass/badges/master/coverage.svg)](https://gitlab.com/tsclass/tsclass/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@tsclass/tsclass.svg)](https://www.npmjs.com/package/@tsclass/tsclass)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@tsclass/tsclass/badge.svg)](https://snyk.io/test/npm/@tsclass/tsclass)
-[![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
-
-Use TypeScript for best in class instellisense.
-
-tsclass exposes many commonly used objects as interface to implement (-> extends keyword) by individual implementations.
-They come complete with best in class intellisense and are easy to require.
-
-```javascript
-import { IInvoice } from 'tsclass';
-
-class myOwnInvoice implements IInvoice {
-  constructor() {
-    super(); // you need to call super() in the constructor
-  }
-}
-```
-
-### Time/Date
-
-- Date
-- Time
-
-### Publications/Websites/Blogs
-
-- Article
-- Author
-
-### Finance
-
-- Invoice
-
-> The modules in bold letters exist as own modules and can be used seperately
-
-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)
-
-[![repo-footer](https://tsclass.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
-
-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)
-
-[![repo-footer](https://tsclass.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

package.json

@@ -1,12 +1,12 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "2.0.1",
+  "version": "3.0.2",
   "private": false,
   "description": "common classes for TypeScript",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "tsrun test/test.ts",
+    "test": "tstest test/",
     "build": "tsbuild"
   },
   "repository": {
@@ -23,19 +23,23 @@
     "url": "https://github.com/tsclass/tsclass/issues"
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
-  "dependencies": {},
+  "dependencies": {
+    "@pushrocks/tapbundle": "^3.0.13"
+  },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.2.6",
-    "tslint": "^5.18.0",
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.27",
+    "tslint": "^5.20.0",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"

test/test.node.ts

@@ -0,0 +1,9 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+
+import * as tsclass from '../ts/index';
+
+tap.test('should assign a correct type', async () => {
+  let contact: tsclass.business.IContact;
+});
+
+tap.start();

test/test.ts

@@ -1,3 +0,0 @@
-import * as tsclass from '../ts/index';
-
-let contact: tsclass.IContact;

ts/business/company.ts

@@ -1,5 +1,4 @@
-import { IContact } from '..';
-import { IDate } from '..';
+import { business, general } from '..';
 
 /**
  * describes a company's lifecycle state
@@ -11,7 +10,8 @@ export type TCompanyStatus = 'planed' | 'founding' | 'active' | 'liquidation' |
  */
 export interface ICompany {
   name: string;
-  foundedDate: IDate;
-  closedDate: IDate;
-  status: TCompanyStatus;
+  foundedDate: general.IDate;
+  closedDate: general.IDate;
+  status: business.TCompanyStatus;
+  contact: business.IContact;
 }

ts/business/contact.ts

@@ -1,4 +1,4 @@
-import { IAddress } from '..';
+import { business } from '..';
 
 export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
 
@@ -16,12 +16,13 @@ export interface IContact {
   name: string;
   surname?: string;
   legalEntity?: string;
-  address: IAddress;
+  address: business.IAddress;
   description: string;
   customerNumber?: string;
 
   email?: string;
   phone?: string;
+  fax?: string;
 
   // =========
   // financial

ts/business/index.ts

@@ -0,0 +1,4 @@
+export * from './address';
+export * from './company';
+export * from './contact';
+export * from './person';

ts/business/person.ts

@@ -0,0 +1,6 @@
+export interface IPerson {
+  title: string;
+  name: string;
+  surname: string;
+  sex: 'male' | 'female' | 'queer';
+}

ts/content/article.ts

@@ -1,4 +1,4 @@
-import { IAuthor } from '..';
+import { content } from '..';
 
 export interface IArticle {
   /**
@@ -9,7 +9,7 @@ export interface IArticle {
   /**
    * the Author of an article
    */
-  author: IAuthor;
+  author: content.IAuthor;
 
   /**
    * the content of an article

ts/content/author.ts

@@ -1,5 +1,4 @@
-import { IDate } from '..';
-import { IArticle } from '..';
+import { general, content } from '..';
 
 export interface IAuthor {
   /**
@@ -15,10 +14,10 @@ export interface IAuthor {
   /**
    * the birthday of an author
    */
-  birthday: IDate;
+  birthday: general.IDate;
 
   /**
    * articles of an author
    */
-  articles: IArticle[];
+  articles: content.IArticle[];
 }

ts/content/index.ts

@@ -0,0 +1,2 @@
+export * from './article';
+export * from './author';

ts/events/contractevent.ts

@@ -0,0 +1,10 @@
+/**
+ * a constract event describes any kind of sale
+ */
+export interface IEvent_Contract {
+  contractId: string;
+  date: number;
+  enddate: number;
+  product: string;
+  type: 'single purchase' | 'subscription' | 'canceled';
+}

ts/events/index.ts

@@ -0,0 +1,6 @@
+export * from './contractevent';
+export * from './moneyevent';
+export * from './releaseevent';
+export * from './requestevent';
+export * from './sessionevent';
+export * from './userevent';

ts/events/moneyevent.ts

@@ -0,0 +1,6 @@
+export interface IEvent_Money {
+  transferId: string;
+  valueInEuro: number;
+  channel: 'sepa' | 'creditcard' | 'paypal' | 'cardano';
+  direction: 'internal' | 'outgoing' | 'incoming';
+}

ts/events/releaseevent.ts

@@ -0,0 +1,6 @@
+export interface IEvent_Release {
+  releaseType: 'Apple App Store' | 'Google Play' | 'npm package' | 'dockerimage';
+  dockerImageUrl: string;
+  npmPackageUrl: string;
+  appleAppStoreIdentifier: string;
+}

ts/events/requestevent.ts

@@ -0,0 +1,5 @@
+export interface IEvent_Request {
+  httpMethod: string;
+  httpRoute: string;
+  durationToResponse: number;
+}

ts/events/sessionevent.ts

@@ -0,0 +1,4 @@
+export interface IEvent_Session {
+  userID: string;
+  sessionType: 'new' | 'reactivated';
+}

ts/events/userevent.ts

@@ -0,0 +1 @@
+export interface IEvent_User {}

ts/finance/checkingaccount.ts

@@ -1,8 +1,7 @@
-import { TCurrency } from './currency';
-import { ITransaction } from './transaction';
+import { finance } from '../';
 
 export interface ICheckingAccount {
   name: string;
-  currency: TCurrency;
-  transactions: ITransaction[];
+  currency: finance.TCurrency;
+  transactions: finance.ITransaction[];
 }

ts/finance/expense.ts

@@ -1,5 +1,4 @@
-import { IInvoice } from './invoice';
-import { IContact } from '../business/contact';
+import { business } from '../';
 
 export interface IExpenseItem {
   description: string;
@@ -14,5 +13,5 @@ export interface IVoucher {
   date: Date;
   description: string;
   expenseItems: IExpenseItem[];
-  contactRef: IContact;
+  contactRef: business.IContact;
 }

ts/finance/index.ts

@@ -0,0 +1,5 @@
+export * from './checkingaccount';
+export * from './currency';
+export * from './expense';
+export * from './invoice';
+export * from './transaction';

ts/finance/invoice.ts

@@ -1,4 +1,4 @@
-import { IContact } from '..';
+import { business } from '..';
 
 export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
 
@@ -10,8 +10,8 @@ export interface IInvoiceItem {
 }
 
 export interface IInvoice {
-  billedBy: IContact;
-  billedTo: IContact;
+  billedBy: business.IContact;
+  billedTo: business.IContact;
   status: TInvoiceStatus;
   items: IInvoiceItem[];
 }

ts/general/index.ts

@@ -0,0 +1,2 @@
+export * from './date';
+export * from './time';

ts/index.ts

@@ -1,22 +1,16 @@
 // Business
-export * from './business/address';
-export * from './business/company';
-export * from './business/contact';
+import * as business from './business';
 
 // Finance
-export * from './finance/checkingaccount';
-export * from './finance/currency';
-export * from './finance/expense';
-export * from './finance/invoice';
-export * from './finance/transaction';
-
-// Cloud
-export * from './cloud/dns';
+import * as finance from './finance';
 
 // Content
-export * from './content/article';
-export * from './content/author';
+import * as content from './content';
 
 // General
-export * from './general/date';
-export * from './general/time';
+import * as general from './general';
+
+// Network
+import * as network from './network';
+
+export { business, finance, content, general, network };

ts/network/cert.ts

@@ -0,0 +1,8 @@
+export interface ICert {
+  id: string;
+  domainName: string;
+  created: number;
+  privateKey: string;
+  publicKey: string;
+  csr: string;
+}

ts/network/index.ts

@@ -0,0 +1,4 @@
+export * from './cert';
+export * from './dns';
+export * from './networknode';
+export * from './reverseproxy';

ts/network/networknode.ts

@@ -0,0 +1,6 @@
+export interface INetworkNode {
+  name: string;
+  ipv4: string;
+  ipv6: string;
+  securityLevel: 'private' | 'public' | 'confidential';
+}

ts/network/reverseproxy.ts

@@ -0,0 +1,12 @@
+export interface IReverseProxyConfig {
+  destinationIp: string;
+  destinationPort: string;
+  hostName: string;
+  privateKey: string;
+  publicKey: string;
+  authentication?: {
+    type: 'Basic';
+    user: string;
+    pass: string;
+  };
+}