4.0.18

.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
@@ -108,11 +122,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
     - npmci npm prepare
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

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,15 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "3.0.5",
+  "version": "4.0.18",
   "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)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -24,24 +26,29 @@
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
   "dependencies": {
-    "@pushrocks/tapbundle": "^3.0.13"
+    "type-fest": "^2.18.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.65",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "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

@@ -8,13 +8,20 @@ common classes for TypeScript
 * [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/)
+
+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
 
@@ -49,7 +56,6 @@ class myOwnInvoice implements IInvoice {
 
 > 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). :)

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,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@tsclass/tsclass',
+  version: '4.0.18',
+  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.js';
+
+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,6 @@
-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 './pdf.js';
+export * from './person.js';

ts/business/letter.ts

@@ -0,0 +1,26 @@
+import * as business from './index.js';
+import * as finance from '../finance/index.js';
+import * as database from '../database/index.js';
+import type { TypedArray } from 'type-fest';
+export interface ILetter {
+  incidenceId: string;
+  date: number;
+  from: business.IContact;
+  to: business.IContact;
+  legalContact: business.IContact;
+  logoUrl: string;
+  subject: string;
+  text: string[];
+  accentColor?: string;
+  needsCoverSheet: boolean;
+  invoiceData?: finance.IInvoice;
+  contractData?: {
+    id: string;
+    contractDate: number;
+  };
+  timesheetData: string;
+  pdf?: business.IPdf;
+  pdfAttachments: business.IPdf[];
+  language: string;
+  objectActions: database.IObjectAction[];
+}

ts/business/pdf.ts

@@ -0,0 +1,8 @@
+export interface IPdf {
+  name: string;
+  id: string;
+  metadata: {
+      textExtraction: string;
+  };
+  buffer: ArrayBufferLike;
+}

ts/code/commitinfo.ts

@@ -0,0 +1,5 @@
+export interface ICommitInfo {
+  name: string;
+  version: string;
+  description: 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,24 @@
-import { content } from '..';
+import { content } from '../index.js';
+
+/**
+ * a general content article:
+ * * can be news
+ * * can be a productdescription,
+ * * can be anything that has text with a title
+ */
+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 +34,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,5 +1,8 @@
-import { general, content } from '..';
+import { general, content } from '../index.js';
 
+/**
+ * answers the question "Who wrote that?"
+ */
 export interface IAuthor {
   /**
    * the first name of an author

ts/content/documentationset.ts

@@ -0,0 +1,10 @@
+import { IArticle } from './article.js';
+
+/**
+ * a set of articles that together form a body of documentation
+ */
+export interface IDocumentationSet {
+  id: string;
+  creationTimestamp: number;
+  articles: IArticle[];
+}

ts/content/index.ts

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

ts/database/index.ts

@@ -0,0 +1,3 @@
+export * from './mongodescriptor.js';
+export * from './objectaction.js';
+export * from './wrappeddata.js'

ts/database/mongodescriptor.ts

@@ -0,0 +1,25 @@
+/**
+ * contains the complete info for how to connect to a mongodb database.
+ */
+export interface IMongoDescriptor {
+  /**
+   * the URL to connect to
+   */
+  mongoDbUrl: string;
+
+  /**
+   * the db to use for the project
+   */
+  mongoDbName?: string;
+
+  /**
+   * a username to use to connect to the database
+   */
+
+  mongoDbUser?: string;
+
+  /**
+   * an optional password that will be replace <PASSWORD> in the connection string
+   */
+  mongoDbPass?: string;
+}

ts/database/objectaction.ts

@@ -0,0 +1,8 @@
+export interface IObjectAction {
+  timestamp: number;
+  name: string;
+  userId: string;
+  data: any;
+  message: string;
+  privateMessage: string;
+}

ts/database/wrappeddata.ts

@@ -0,0 +1,3 @@
+export interface IWrappedData<T> {
+  data: T;
+}

ts/events/contractevent.ts

@@ -1,5 +1,5 @@
 /**
- * a constract event describes any kind of sale
+ * a contract event describes any kind of sale
  */
 export interface IEvent_Contract {
   contractId: string;

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,35 @@
 // Business
-import * as business from './business';
+import * as business from './business/index.js';
+
+// Code
+import * as code from './code/index.js';
+
+// Container
+import * as container from './container/index.js';
+
+// Database
+import * as database from './database/index.js';
 
 // Finance
-import * as finance from './finance';
+import * as finance from './finance/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';
+
+// Website
+export * from './website/index.js';
+
+export { business, container, code, database, finance, content, general, network, saas };
+
+import type * as typeFest from 'type-fest';
+
+export { typeFest };

ts/network/dns.ts

@@ -13,8 +13,8 @@ export type TDnsRecordType =
   | 'TXT';
 
 export interface IDnsRecord {
-  chunked?: string[];
   name: string;
   type: TDnsRecordType;
   value: string;
+  dnsSecEnabled: boolean;
 }

ts/network/dnschallenge.ts

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

ts/network/index.ts

@@ -1,5 +1,6 @@
-export * from './cert';
-export * from './dns';
-export * from './dnschallenge';
-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;
+}

ts/website/index.ts

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

ts/website/menuitem.ts

@@ -0,0 +1,4 @@
+export interface IMenuItem {
+  name: string;
+  action: <T = any>() => void | Promise<T>;
+}

tsconfig.json

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