4.0.0

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,22 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+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
+  allow_failure: true
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,11 +97,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

npmextra.json

@@ -4,11 +4,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "tsclass",
       "gitrepo": "tsclass",
-      "shortDescription": "common classes for TypeScript",
+      "description": "common classes for TypeScript",
       "npmPackagename": "@tsclass/tsclass",
       "license": "MIT"
     }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "private": false,
   "description": "common classes for TypeScript",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "tstest test/",
-    "build": "tsbuild"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -24,24 +25,29 @@
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
   "dependencies": {
-    "@pushrocks/tapbundle": "^3.0.13"
+    "type-fest": "^2.9.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.27",
-    "tslint": "^5.20.0",
+    "@gitzone/tsbuild": "^2.1.61",
+    "@gitzone/tsrun": "^1.2.32",
+    "@gitzone/tstest": "^1.0.70",
+    "@pushrocks/tapbundle": "^3.2.15",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,68 @@
+# @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
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/tsclass/tsclass/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/tsclass/tsclass/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@tsclass/tsclass)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/tsclass/tsclass)](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/@tsclass/tsclass)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@tsclass/tsclass)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@tsclass/tsclass)](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
+
+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
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.both.ts

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

ts/00_commitinfo_data.ts

@@ -0,0 +1,11 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const name: string = '@tsclass/tsclass';
+export const version: string = '4.0.48';
+export const description: string = 'common classes for TypeScript'
+export const commitinfo = {
+  name: '@tsclass/tsclass',
+  version: '4.0.48',
+  description: 'common classes for TypeScript'
+}

ts/authentication/claim.ts

@@ -0,0 +1,6 @@
+export interface IClaim {
+  userName: string;
+  userId: string;
+  validUntil: number;
+  roles: string[];
+}

ts/authentication/index.ts

@@ -0,0 +1,2 @@
+export * from './claim.js';
+export * from './processedclaim.js';

ts/authentication/processedclaim.ts

@@ -0,0 +1,7 @@
+import { IClaim } from './claim';
+
+export interface IProcessedClaim {
+  originalJWT: string;
+  claim: IClaim;
+  signed: boolean;
+}

ts/business/company.ts

@@ -1,4 +1,4 @@
-import { business, general } from '..';
+import { business, general } from '../index.js';
 
 /**
  * describes a company's lifecycle state

ts/business/contact.ts

@@ -1,4 +1,4 @@
-import { business } from '..';
+import { business } from '../index.js';
 
 export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
 
@@ -19,8 +19,13 @@ export interface IContact {
   address: business.IAddress;
   description: string;
   customerNumber?: string;
-
   email?: string;
+
+  logoUrl?: string;
+  website?: string;
+  facebookUrl?: string;
+  twitterUrl?: string;
+
   phone?: string;
   fax?: string;
 
@@ -28,5 +33,8 @@ export interface IContact {
   // financial
   // =========
   vatId?: string;
-  bankAccountNumber?: string;
+  sepaConnection?: {
+    iban: string;
+    bic: string;
+  };
 }

ts/business/index.ts

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

ts/business/letter.ts

@@ -0,0 +1,21 @@
+import * as business from './index.js';
+import * as finance from '../finance/index.js';
+export interface ILetter {
+  incidenceId: string;
+  date: number;
+  from: business.IContact;
+  to: business.IContact;
+  logoUrl: string;
+  accentColor: string;
+  subject: string;
+  text: string[];
+  invoiceData?: finance.IInvoice;
+  contractData?: {
+    id: string;
+    contractDate: number;
+  };
+  timesheetData: string;
+  pdfAttachments: Uint8Array[];
+  legalContact: business.IContact;
+  language: string;
+}

ts/code/index.ts

@@ -0,0 +1 @@
+export * from './commitinfo.js';

ts/container/container.ts

@@ -0,0 +1,9 @@
+export interface IContainer {
+  registryUrl: string;
+  tag: string;
+  /**
+   * version is usually derived from labels
+   */
+  version: string;
+  labels: string[];
+}

ts/container/index.ts

@@ -0,0 +1,2 @@
+export * from './container.js';
+export * from './volumemount.js';

ts/container/volumemount.ts

@@ -0,0 +1,4 @@
+export interface IVolumeMount {
+  hostFsPath: string;
+  containerFsPath: string;
+}

ts/content/article.ts

@@ -1,6 +1,18 @@
-import { content } from '..';
+import { content } from '../index.js';
+
+export interface IArticle<T = any> {
+  /**
+   * the main url of an article
+   */
+  url?: string;
+
+  /**
+   * the mainimage of the article
+   */
+  featuredImageUrl?: string;
+
+  referenceObject?: T;
 
-export interface IArticle {
   /**
    * the title of an article
    */
@@ -16,6 +28,11 @@ export interface IArticle {
    */
   content: string;
 
+  /**
+   * a timestamp for when the article was written
+   */
+  timestamp: number;
+
   /**
    * the tags of an article
    */

ts/content/author.ts

@@ -1,4 +1,4 @@
-import { general, content } from '..';
+import { general, content } from '../index.js';
 
 export interface IAuthor {
   /**

ts/content/index.ts

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

ts/events/index.ts

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

ts/finance/checkingaccount.ts

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

ts/finance/expense.ts

@@ -1,4 +1,4 @@
-import { business } from '../';
+import { business } from '../index.js';
 
 export interface IExpenseItem {
   description: string;

ts/finance/index.ts

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

ts/finance/invoice.ts

@@ -1,17 +1,37 @@
-import { business } from '..';
+import { business } from '../index.js';
 
 export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
 
 export interface IInvoiceItem {
   name: string;
+  articleNumber?: string;
   unitType: string;
-  quantity: number;
+  unitQuantity: number;
+  unitNetPrice: number;
   vatPercentage: number;
+  currency: 'EUR';
 }
 
 export interface IInvoice {
+  id: string;
   billedBy: business.IContact;
   billedTo: business.IContact;
   status: TInvoiceStatus;
   items: IInvoiceItem[];
+  periodOfPerformance?: {
+    from: number;
+    to: number;
+  };
+  deliveryDate?: number;
+  dueInDays: number;
+  reverseCharge: boolean;
+  printResult?: {
+    pdfBufferString: string;
+    totalNet: number;
+    totalGross: number;
+    vatGroups: {
+      percentage: number;
+      items: IInvoiceItem[];
+    };
+  };
 }

ts/general/index.ts

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

ts/index.ts

@@ -1,16 +1,29 @@
 // Business
-import * as business from './business';
+import * as business from './business/index.js';
+
+// Container
+import * as container from './container/index.js';
 
 // Finance
-import * as finance from './finance';
+import * as finance from './finance/index.js';
+
+// Code
+import * as code from './code/index.js';
 
 // Content
-import * as content from './content';
+import * as content from './content/index.js';
 
 // General
-import * as general from './general';
+import * as general from './general/index.js';
 
 // Network
-import * as network from './network';
+import * as network from './network/index.js';
 
-export { business, finance, content, general, network };
+// SaaS
+import * as saas from './saas/index.js';
+
+export { business, container, code, finance, content, general, network, saas };
+
+import type * as typeFest from 'type-fest';
+
+export { typeFest };

ts/network/cert.ts

@@ -2,6 +2,7 @@ export interface ICert {
   id: string;
   domainName: string;
   created: number;
+  validUntil: number;
   privateKey: string;
   publicKey: string;
   csr: string;

ts/network/dns.ts

@@ -1 +1,20 @@
-export type TDnsRecord = 'A' | 'AAAA' | 'CNAME' | 'TXT' | 'SRV' | 'LOC' | 'MX' | 'NS' | 'SPF';
+export type TDnsRecordType =
+  | 'A'
+  | 'AAAA'
+  | 'CNAME'
+  | 'LOC'
+  | 'PTR'
+  | 'MX'
+  | 'NAPTR'
+  | 'NS'
+  | 'SOA'
+  | 'SPF'
+  | 'SRV'
+  | 'TXT';
+
+export interface IDnsRecord {
+  name: string;
+  type: TDnsRecordType;
+  value: string;
+  dnsSecEnabled: boolean;
+}

ts/network/dnschallenge.ts

@@ -0,0 +1,4 @@
+export interface IDnsChallenge {
+  hostName: string;
+  challenge: string;
+}

ts/network/index.ts

@@ -1,4 +1,6 @@
-export * from './cert';
-export * from './dns';
-export * from './networknode';
-export * from './reverseproxy';
+export * from './cert.js';
+export * from './dns.js';
+export * from './dnschallenge.js';
+export * from './networknode.js';
+export * from './request.js';
+export * from './reverseproxy.js';

ts/network/request.ts

@@ -0,0 +1,26 @@
+export interface ISimpleRequest {
+  headers: {};
+  parsedUrl: {
+    hash: string;
+    host: string;
+    hostname: string;
+    href: string;
+    readonly origin: string;
+    password: string;
+    pathname: string;
+    port: string;
+    protocol: string;
+    search: string;
+    readonly searchParams: any;
+    username: string;
+    toString: () => string;
+    toJSON: () => string;
+  };
+  body?: string | object | Buffer;
+}
+
+export interface ISimpleResponse {
+  headers: { [key: string]: string };
+  body: string;
+}
+export type IRenderFunction = (req: ISimpleRequest) => Promise<ISimpleResponse>;

ts/saas/index.ts

@@ -0,0 +1,2 @@
+export * from './subscriptionplan.js';
+export * from './product.js';

ts/saas/product.ts

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

ts/saas/subscriptionplan.ts

@@ -0,0 +1,14 @@
+import { IProduct } from './product.js';
+
+export interface ISubscriptionPlan {
+  name: string;
+  unit: 'device' | 'user';
+  quantity: boolean;
+  availableTerms: {
+    period: 'daily' | 'weekly' | 'monthly' | 'yearly';
+    price: number;
+    currency: 'EUR' | 'USD';
+  }[];
+  containedProducts: IProduct[];
+  limits: any;
+}

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}