1.0.19

.gitlab-ci.yml

@@ -3,66 +3,125 @@ image: hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
-- pages
+- metadata
 
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+  - npmci git mirror
+  tags:
+  - docker
+  - notpriv
+
+snyk:
+  stage: security
+  script:
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
+
+# ====================
+# test stage
+# ====================
 testLEGACY:
   stage: test
   script:
-    - npmci test legacy
+  - npmci node install legacy
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
   allow_failure: true
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+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]
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
 
 pages:
   image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
+    - npmci command npm install -g npmpage
     - npmci command npmpage
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:

README.md

@@ -1,13 +1,16 @@
 # tsclass
+
 common classes for TypeScript
 
 ## Availabililty
+
 [![npm](https://tsclass.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/tsclass)
 [![git](https://tsclass.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/tsclass/tsclass)
 [![git](https://tsclass.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/tsclass/tsclass)
 [![docs](https://tsclass.gitlab.io/assets/repo-button-docs.svg)](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.svg)](https://www.npmjs.com/package/tsclass)
@@ -19,39 +22,41 @@ common classes for TypeScript
 [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## 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'
+import { IInvoice } from 'tsclass';
 
 class myOwnInvoice implements IInvoice {
-    constructor(){
-        super() // you need to call super() in the constructor
-    }
+  constructor() {
+    super(); // you need to call super() in the constructor
+  }
 }
-
 ```
 
 ### Time/Date
-* Date
-* Time
+
+- Date
+- Time
 
 ### Publications/Websites/Blogs
-* Article
-* Author
+
+- Article
+- Author
 
 ### Finance
-* Invoice
 
+- 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)
+> | 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)

dist/business/address.d.ts

@@ -0,0 +1,8 @@
+export interface IAddress {
+    name?: string;
+    streetName: string;
+    houseNumber: string;
+    postalCode: string;
+    city: string;
+    country: string;
+}

dist/business/address.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWRkcmVzcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2J1c2luZXNzL2FkZHJlc3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

dist/business/contact.d.ts

@@ -0,0 +1,13 @@
+import { IAddress } from '../index';
+export declare type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
+export declare type TContactType = 'person' | 'company';
+export declare type TContactTitle = 'Doctor' | 'Professor';
+export interface IContact {
+    salutation?: TContactSalutation;
+    type: TContactType;
+    title: TContactTitle;
+    name: string;
+    address: IAddress;
+    vatId?: string;
+    accountNumber?: string;
+}

dist/business/contact.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGFjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3RzL2J1c2luZXNzL2NvbnRhY3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

dist/business/invoice.d.ts

@@ -1,2 +1,14 @@
-export interface IInvoice {
+import { IContact } from '../index';
+export declare type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
+export interface IInvoiceItem {
+    name: string;
+    unitType: string;
+    quantity: number;
+    vatPercentage: number;
+}
+export interface IInvoice {
+    billedBy: IContact;
+    billedTo: IContact;
+    status: TInvoiceStatus;
+    items: IInvoiceItem[];
 }

dist/cloud/dns.d.ts

@@ -0,0 +1 @@
+export declare type TDnsRecord = 'A' | 'AAAA' | 'CNAME' | 'TXT' | 'SRV' | 'LOC' | 'MX' | 'NS' | 'SPF';

dist/cloud/dns.js

@@ -1 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZG5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvY2xvdWQvZG5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

dist/index.d.ts

@@ -1,6 +1,9 @@
+export * from './business/address';
+export * from './business/company';
+export * from './business/contact';
+export * from './business/invoice';
+export * from './cloud/dns';
 export * from './content/article';
 export * from './content/author';
-export * from './business/company';
 export * from './general/date';
-export * from './business/invoice';
 export * from './general/time';

npmextra.json

@@ -1,7 +1,8 @@
 {
   "npmci": {
-    "globalNpmTools": [
+    "npmGlobalTools": [
       "npmts"
-    ]
+    ],
+    "npmAccessLevel": "public"
   }
 }

package-lock.json

@@ -0,0 +1,5 @@
+{
+  "name": "tsclass",
+  "version": "1.0.19",
+  "lockfileVersion": 1
+}

package.json

@@ -1,11 +1,13 @@
 {
   "name": "tsclass",
-  "version": "1.0.11",
+  "version": "1.0.19",
+  "private": false,
   "description": "common classes for TypeScript",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts --notest)"
+    "test": "(npmts --notest)",
+    "build": "echo \"Not needed for now\""
   },
   "repository": {
     "type": "git",
@@ -20,5 +22,6 @@
   "bugs": {
     "url": "https://github.com/tsclass/tsclass/issues"
   },
-  "homepage": "https://github.com/tsclass/tsclass#readme"
+  "homepage": "https://github.com/tsclass/tsclass#readme",
+  "dependencies": {}
 }

ts/business/address.ts

@@ -0,0 +1,8 @@
+export interface IAddress {
+  name?: string;
+  streetName: string;
+  houseNumber: string;
+  postalCode: string;
+  city: string;
+  country: string;
+}

ts/business/company.ts

@@ -1,16 +1,17 @@
-import { IDate } from '../index'
+import { IContact } from '../index';
+import { IDate } from '../index';
 
 /**
  * describes a company's lifecycle state
  */
-export type TCompanyStatus = 'planed' | 'founding' | 'active' | 'liquidation' | 'closed'
+export type TCompanyStatus = 'planed' | 'founding' | 'active' | 'liquidation' | 'closed';
 
 /**
  * describes a company
  */
 export interface ICompany {
-  name: string
-  foundedDate: IDate
-  closedDate: IDate
-  status: TCompanyStatus
+  name: string;
+  foundedDate: IDate;
+  closedDate: IDate;
+  status: TCompanyStatus;
 }

ts/business/contact.ts

@@ -0,0 +1,24 @@
+import { IAddress } from '../index';
+
+export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
+
+export type TContactType = 'person' | 'company';
+
+export type TContactTitle = 'Doctor' | 'Professor';
+
+export interface IContact {
+  // =======
+  // general
+  // =======
+  salutation?: TContactSalutation;
+  type: TContactType;
+  title: TContactTitle;
+  name: string;
+  address: IAddress;
+
+  // =========
+  // financial
+  // =========
+  vatId?: string;
+  accountNumber?: string;
+}

ts/business/invoice.ts

@@ -1,3 +1,17 @@
-export interface IInvoice {
+import { IContact } from '../index';
 
+export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
+
+export interface IInvoiceItem {
+  name: string;
+  unitType: string;
+  quantity: number;
+  vatPercentage: number;
+}
+
+export interface IInvoice {
+  billedBy: IContact;
+  billedTo: IContact;
+  status: TInvoiceStatus;
+  items: IInvoiceItem[];
 }

ts/cloud/dns.ts

@@ -1 +1 @@
-export type TRecord = 'A' | 'AAAA' | 'CNAME' | 'TXT' | 'SRV' | 'LOC' | 'MX' | 'NS' | 'SPF'
+export type TDnsRecord = 'A' | 'AAAA' | 'CNAME' | 'TXT' | 'SRV' | 'LOC' | 'MX' | 'NS' | 'SPF';

ts/content/article.ts

@@ -1,23 +1,23 @@
-import { IAuthor } from '../index'
+import { IAuthor } from '../index';
 
 export interface IArticle {
   /**
    * the title of an article
    */
-  title: string
+  title: string;
 
   /**
    * the Author of an article
    */
-  author: IAuthor
+  author: IAuthor;
 
   /**
    * the content of an article
    */
-  content: string
+  content: string;
 
   /**
    * the tags of an article
    */
-  tags: string[]
+  tags: string[];
 }

ts/content/author.ts

@@ -1,25 +1,24 @@
-import { IDate } from '../index'
-import { IArticle } from '../index'
+import { IDate } from '../index';
+import { IArticle } from '../index';
 
 export interface IAuthor {
-
   /**
    * the first name of an author
    */
-  firstName: string
+  firstName: string;
 
   /**
    * the surname of an author
    */
-  surName: string
+  surName: string;
 
   /**
    * the birthday of an author
    */
-  birthday: IDate
+  birthday: IDate;
 
   /**
    * articles of an author
    */
-  articles: IArticle[]
+  articles: IArticle[];
 }

ts/general/date.ts

@@ -1,5 +1,5 @@
 export interface IDate {
-  day: number
-  month: number
-  year: number
+  day: number;
+  month: number;
+  year: number;
 }

ts/general/time.ts

@@ -1,3 +1 @@
-export interface ITime {
-
-}
+export interface ITime {}

ts/index.ts

@@ -1,14 +1,16 @@
 // Business
-export * from './business/company'
-export * from './business/invoice'
+export * from './business/address';
+export * from './business/company';
+export * from './business/contact';
+export * from './business/invoice';
 
 // Cloud
-export * from './cloud/dns'
+export * from './cloud/dns';
 
 // Content
-export * from './content/article'
-export * from './content/author'
+export * from './content/article';
+export * from './content/author';
 
 // General
-export * from './general/date'
-export * from './general/time'
+export * from './general/date';
+export * from './general/time';

yarn.lock

@@ -1,4 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-