4.0.23

.gitlab-ci.yml

@@ -13,31 +13,24 @@ stages:
   - metadata
 
 before_script:
-  - npm install -g @shipzone/npmci
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
 
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
+# ====================
+# security stage
+# ====================
 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
+     - npmci command npm config set registry https://registry.npmjs.org
+     - npmci command pnpm audit --audit-level=high --prod
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -45,11 +38,10 @@ auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high --only=dev
+    - npmci command pnpm audit --audit-level=high --dev
   tags:
+    - lossless
     - docker
   allow_failure: true
 
@@ -60,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -71,7 +62,6 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci command npm run build
@@ -122,11 +112,9 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
-    - npmci npm prepare
+    - npmci node install stable
     - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
   tags:
     - lossless
     - docker

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "4.0.1",
+  "version": "4.0.23",
   "private": false,
   "description": "common classes for TypeScript",
   "main": "dist_ts/index.js",
@@ -8,7 +8,8 @@
   "type": "module",
   "scripts": {
     "test": "tstest test/",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -25,15 +26,13 @@
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
   "dependencies": {
-    "type-fest": "^2.9.0"
+    "type-fest": "^3.1.0"
   },
   "devDependencies": {
-    "@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"
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsrun": "^1.2.37",
+    "@gitzone/tstest": "^1.0.73",
+    "@pushrocks/tapbundle": "^5.0.4"
   },
   "files": [
     "ts/**/*",

ts/00_commitinfo_data.ts

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

ts/authentication/processedclaim.ts

@@ -1,4 +1,4 @@
-import { IClaim } from './claim';
+import { IClaim } from './claim.js';
 
 export interface IProcessedClaim {
   originalJWT: string;

ts/business/contact.ts

@@ -1,3 +1,4 @@
+import { finance } from '../index.js';
 import { business } from '../index.js';
 
 export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
@@ -33,8 +34,5 @@ export interface IContact {
   // financial
   // =========
   vatId?: string;
-  sepaConnection?: {
-    iban: string;
-    bic: string;
-  };
+  sepaConnection?: finance.ISepaConnection;
 }

ts/business/index.ts

@@ -2,4 +2,5 @@ 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

@@ -1,21 +1,27 @@
 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;
+  type: 'invoice' | 'notice' | 'warning' | 'verification' | 'contract';
   date: number;
   from: business.IContact;
   to: business.IContact;
+  legalContact: business.IContact;
   logoUrl: string;
-  accentColor: string;
   subject: string;
   text: string[];
+  accentColor?: string;
+  needsCoverSheet: boolean;
   invoiceData?: finance.IInvoice;
   contractData?: {
     id: string;
     contractDate: number;
   };
   timesheetData: string;
-  pdfAttachments: Uint8Array[];
-  legalContact: business.IContact;
+  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/content/article.ts

@@ -1,5 +1,11 @@
 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

ts/content/author.ts

@@ -1,5 +1,8 @@
 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.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/finance/index.ts

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

ts/finance/invoice.ts

@@ -1,4 +1,4 @@
-import { business } from '../index.js';
+import { business, finance } from '../index.js';
 
 export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
 
@@ -34,4 +34,5 @@ export interface IInvoice {
       items: IInvoiceItem[];
     };
   };
+  paymentOptions?: finance.IPaymentOptionInfo;
 }

ts/finance/payment.ts

@@ -0,0 +1,14 @@
+export interface ISepaConnection {
+  institution?: string;
+  iban: string;
+  bic: string;
+}
+
+export interface IPayPalConnection {
+  email: string;
+}
+
+export interface IPaymentOptionInfo {
+  sepaConnection: ISepaConnection;
+  payPal: IPayPalConnection;
+}

ts/index.ts

@@ -1,15 +1,18 @@
 // 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/index.js';
 
-// Code
-import * as code from './code/index.js';
-
 // Content
 import * as content from './content/index.js';
 
@@ -22,7 +25,10 @@ import * as network from './network/index.js';
 // SaaS
 import * as saas from './saas/index.js';
 
-export { business, container, code, finance, content, general, network, saas };
+// Website
+import * as website from './website/index.js';
+
+export { business, container, code, database, finance, content, general, network, saas, website };
 
 import type * as typeFest from 'type-fest';
 

ts/network/device.ts

@@ -0,0 +1,10 @@
+export interface IDevice {
+  id: string;
+  resolutionWidth?: number;
+  resolutionHeight?: number;
+  dpi?: number;
+  manufacturer?: string;
+  name?: string;
+  ipv4?: string;
+  ipv6?: string;
+}

ts/network/index.ts

@@ -1,4 +1,5 @@
 export * from './cert.js';
+export * from './device.js';
 export * from './dns.js';
 export * from './dnschallenge.js';
 export * from './networknode.js';

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>;
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}