1.0.41

add ICompany

See merge request !1

.gitlab-ci.yml

@@ -1,59 +1,142 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .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:npmpage
-  stage: pages
+  image: hosttoday/ht-docker-node:npmci
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - npmci command npm install -g typedoc typescript
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true
+
+windowsCompatibility:
+  image: stefanscherer/node-windows:10-build-tools
+  stage: metadata
+  script:
+  - npm install & npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - windows
+  allow_failure: true

README.md

@@ -1,15 +1,19 @@
 # tsclass
-common classes for TypeScript.
+
+common classes for TypeScript
 
 ## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/tsclass)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/tsclass/tsclass)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/tsclass/tsclass)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://tsclass.gitlab.io/tsclass/)
+
+[![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)
+
+[![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)
 [![Dependency Status](https://david-dm.org/tsclass/tsclass.svg)](https://david-dm.org/tsclass/tsclass)
 [![bitHound Dependencies](https://www.bithound.io/github/tsclass/tsclass/badges/dependencies.svg)](https://www.bithound.io/github/tsclass/tsclass/master/dependencies/npm)
 [![bitHound Code](https://www.bithound.io/github/tsclass/tsclass/badges/code.svg)](https://www.bithound.io/github/tsclass/tsclass)
@@ -18,30 +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)
+
+[![repo-footer](https://tsclass.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/article.d.ts

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

dist/article.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXJ0aWNsZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2FydGljbGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

dist/author.d.ts

@@ -1,20 +0,0 @@
-import { IDate } from './date';
-import { IArticle } from './article';
-export interface IAuthor {
-    /**
-     * the first name of an author
-     */
-    firstName: string;
-    /**
-     * the surname of an author
-     */
-    surName: string;
-    /**
-     * the birthday of an author
-     */
-    birthday: IDate;
-    /**
-     * articles of an author
-     */
-    articles: IArticle;
-}

dist/author.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXV0aG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvYXV0aG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

dist/date.d.ts

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

dist/date.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGF0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2RhdGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

dist/index.d.ts

@@ -1,5 +0,0 @@
-export * from './article';
-export * from './author';
-export * from './date';
-export * from './invoice';
-export * from './time';

dist/index.js

@@ -1,6 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-__export(require("./invoice"));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBR0EsK0JBQXlCIn0=

dist/invoice.d.ts

@@ -1,2 +0,0 @@
-export declare class IInvoice {
-}

dist/invoice.js

@@ -1,5 +0,0 @@
-"use strict";
-class IInvoice {
-}
-exports.IInvoice = IInvoice;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW52b2ljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL2ludm9pY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBO0NBRUM7QUFGRCw0QkFFQyJ9

dist/time.d.ts

@@ -1,2 +0,0 @@
-export interface ITime {
-}

dist/time.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGltZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3RpbWUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

npmextra.json

@@ -0,0 +1,6 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "tsclass",
-  "version": "1.0.3",
+  "name": "@tsclass/tsclass",
+  "version": "1.0.41",
+  "private": false,
   "description": "common classes for TypeScript",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "tsrun test/test.ts",
+    "build": "tsbuild"
   },
   "repository": {
     "type": "git",
@@ -21,7 +23,9 @@
     "url": "https://github.com/tsclass/tsclass/issues"
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
+  "dependencies": {},
   "devDependencies": {
-    "npmts": "^5.1.5"
+    "@gitzone/tsrun": "^1.0.5",
+    "tsbuild": "^0.2.1"
   }
 }

test/test.ts

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

ts/article.ts

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

ts/author.ts

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

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

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

ts/business/contact.ts

@@ -0,0 +1,31 @@
+import { IAddress } from '..';
+
+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;
+  surname?: string;
+  legalEntity?: string;
+  address: IAddress;
+  description: string;
+  customerNumber?: string;
+
+  email?: string;
+  phone?: string;
+
+  // =========
+  // financial
+  // =========
+  vatId?: string;
+  bankAccountNumber?: string;
+}

ts/cloud/dns.ts

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

ts/content/article.ts

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

ts/content/author.ts

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

ts/date.ts

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

ts/finance/checkingaccount.ts

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

ts/finance/currency.ts

@@ -0,0 +1 @@
+export type TCurrency = 'eur' | 'usd' | 'sek';

ts/finance/expense.ts

@@ -0,0 +1,14 @@
+import { IInvoice } from './invoice';
+import { IContact } from '../business/contact';
+
+export interface IExpenseItem {
+  amount: number;
+  taxPercentage: number;
+}
+
+export interface IExpense {
+  voucherFile?: any;
+  expenseItems: IExpenseItem[];
+  contactRef: string;
+  accountRef: string;
+}

ts/finance/invoice.ts

@@ -0,0 +1,17 @@
+import { IContact } from '..';
+
+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/finance/transaction.ts

@@ -0,0 +1,4 @@
+export interface ITransaction {
+  amount: number;
+  date: Date;
+}

ts/general/date.ts

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

ts/general/time.ts

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

ts/index.ts

@@ -1,5 +1,22 @@
-export * from './article'
-export * from './author'
-export * from './date'
-export * from './invoice'
-export * from './time'
+// Business
+export * from './business/address';
+export * from './business/company';
+export * from './business/contact';
+
+// 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';
+
+// Content
+export * from './content/article';
+export * from './content/author';
+
+// General
+export * from './general/date';
+export * from './general/time';

ts/invoice.ts

@@ -1,3 +0,0 @@
-export class IInvoice {
-
-}

ts/time.ts

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