4.0.37

.gitlab-ci.yml

@@ -12,40 +12,36 @@ stages:
   - release
   - metadata
 
+before_script:
+  - pnpm install -g pnpm
+  - pnpm install -g @shipzone/npmci
+  - npmci npm prepare
+
+# ====================
+# security stage
+# ====================
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 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
 
 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
 
@@ -56,7 +52,6 @@ auditDevDependencies:
 testStable:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci npm test
@@ -67,7 +62,6 @@ testStable:
 testBuild:
   stage: test
   script:
-    - npmci npm prepare
     - npmci node install stable
     - npmci npm install
     - npmci command npm run build
@@ -96,10 +90,9 @@ codequality:
   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
@@ -119,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

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -9,7 +9,7 @@
       "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.33",
+  "version": "4.0.37",
   "private": false,
   "description": "common classes for TypeScript",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "tstest test/",
-    "build": "(tsbuild --web)"
+    "build": "(tsbuild --web)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -24,15 +26,14 @@
   },
   "homepage": "https://github.com/tsclass/tsclass#readme",
   "dependencies": {
-    "@pushrocks/tapbundle": "^3.2.9",
-    "type-fest": "^0.16.0"
+    "type-fest": "^3.7.2"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.44",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.65",
+    "@gitzone/tsrun": "^1.2.39",
+    "@gitzone/tstest": "^1.0.74",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.15.11"
   },
   "files": [
     "ts/**/*",

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.37',
+  description: 'common classes for TypeScript'
+}

ts/00helperfunctions.ts/finance.ts

@@ -0,0 +1,5 @@
+import { IInvoice } from "../finance/invoice.js";
+
+export function createLetterFromInvoice(invoiceArg: IInvoice) {
+
+}

ts/00helperfunctions.ts/index.ts

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

ts/authentication/index.ts

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

ts/authentication/processedclaim.ts

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

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,5 @@
-import { business } from '..';
+import { finance } from '../index.js';
+import { business } from '../index.js';
 
 export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
 
@@ -33,5 +34,5 @@ export interface IContact {
   // financial
   // =========
   vatId?: string;
-  bankAccountNumber?: string;
+  sepaConnection?: finance.ISepaConnection;
 }

ts/business/contract.ts

@@ -0,0 +1,20 @@
+import * as database from '../database/index.js';
+import { IPerson } from './person.js';
+
+export interface IContract {
+  parties: {
+    signingOrder: number;
+    referencedAs: string;
+    person: IPerson;
+    role: 'signer' | 'cc';
+    signature: {
+      given: boolean;
+      timestamp?: number;
+      location?: string;
+      ip?: string;
+      verifications?: [];
+    };
+  }[];
+  contractTextMarkdown: string;
+  actions: database.IObjectAction[];
+}

ts/business/index.ts

@@ -1,4 +1,8 @@
-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 './job.js';
+export * from './letter.js';
+export * from './pdf.js';
+export * from './person.js';
+export * from './project.js';

ts/business/job.ts

@@ -0,0 +1,12 @@
+import * as finance from '../finance/index.js';
+import { ICompany } from './company.js';
+import { IContact } from './contact.js';
+export class IJob {
+  type: 'contract' | 'employment';
+  name: string;
+  description: string;
+  monthlyTotal: number;
+  currency: finance.TCurrency;
+  from: ICompany;
+  contact: IContact;
+}

ts/business/letter.ts

@@ -0,0 +1,28 @@
+import * as business from './index.js';
+import * as finance from '../finance/index.js';
+import * as database from '../database/index.js';
+export interface ILetter {
+  incidenceId: string;
+  type: 'invoice' | 'notice' | 'warning' | 'verification' | 'contract';
+  date: number;
+  from: business.IContact;
+  to: business.IContact;
+  legalContact: business.IContact;
+  logoUrl: string;
+  subject: string;
+  accentColor?: string;
+  needsCoverSheet: boolean;
+  content: {
+    textData: string[];
+    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/business/person.ts

@@ -1,6 +1,12 @@
+import { IContact } from './contact.js';
+
 export interface IPerson {
   title: string;
   name: string;
   surname: string;
   sex: 'male' | 'female' | 'queer';
+  legalProxyFor?: {
+    type: 'self' | 'other';
+    contact?: IContact;
+  };
 }

ts/business/project.ts

@@ -0,0 +1,18 @@
+export interface IProject {
+  active: boolean;
+  category: 'SaaS' | 'IaaS' | 'Media' | 'Blockchain' | 'Open Source' | 'Consulting' | 'internal' | 'partner';
+  branch?: null;
+  branchId? : string;
+  domain: string;
+  redirectDomains: string[];
+  gitlab: string;
+  name: string;
+  social: {
+    facebook?: string;
+    gitlab?: string;
+    github?: string;
+    twitter?: string;
+  };
+  tagLine: string;
+  tags: string[];
+}

ts/code/commitinfo.ts

@@ -0,0 +1,5 @@
+export interface ICommitInfo {
+  name: string;
+  version: string;
+  description: string;
+}

ts/code/index.ts

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

ts/code/statusobject.ts

@@ -0,0 +1,13 @@
+export type TStatus = 'ok' | 'partly_ok' | 'not_ok';
+export interface IStatusObject {
+  id?: string;
+  name: string;
+  combinedStatus?: TStatus;
+  combinedStatusText: string;
+  details: Array<{
+    name: string;
+    value: string;
+    status: TStatus;
+    statusText: string;
+  }> 
+}

ts/container/container.ts

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

ts/container/index.ts

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

ts/content/article.ts

@@ -1,16 +1,24 @@
-import { content } from '..';
+import { content } from '../index.js';
 
-export interface IArticle {
+/**
+ * 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;
+
   /**
    * the title 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,4 @@
+export * from './mongodescriptor.js';
+export * from './objectaction.js';
+export * from './objectstatus.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/objectstatus.ts

@@ -0,0 +1,7 @@
+export interface IObjectStatus {
+  current: 'active' | 'inactive' | 'hidden' | 'markedForDeletion';
+  scheduledDeletion: number;
+  justForLooks: {
+    scheduledDeletionIso: 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,4 +1,4 @@
-import { finance } from '../';
+import { finance } from '../index.js';
 
 export interface ICheckingAccount {
   name: string;

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,6 @@
-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 './payment.js';
+export * from './transaction.js';

ts/finance/invoice.ts

@@ -1,9 +1,10 @@
-import { business } from '..';
+import { business, finance } from '../index.js';
 
 export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
 
 export interface IInvoiceItem {
   name: string;
+  articleNumber?: string;
   unitType: string;
   unitQuantity: number;
   unitNetPrice: number;
@@ -12,10 +13,18 @@ export interface IInvoiceItem {
 }
 
 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;
@@ -23,6 +32,7 @@ export interface IInvoice {
     vatGroups: {
       percentage: number;
       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/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,25 +1,34 @@
 // 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';
+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';
 
 // SaaS
-import * as saas from './saas';
+import * as saas from './saas/index.js';
 
-export { business, container, 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/cname.ts

@@ -0,0 +1,29 @@
+import { ICert } from "./cert.js";
+
+export class ICnameDescriptor {
+  /**
+   * the original domain that is being cnamed
+   */
+  cnamedDomain: string;
+
+  /**
+   * the cname proxy domain
+   * the domain that is used for the cname dns entry
+   */
+  cnameProxyDomain: string;
+
+  /**
+   * the internal target url
+   */
+  targetUrl: string;
+
+  /**
+   * a description
+   */
+  description: string;
+
+  /**
+   * the ssl certificate
+   */
+  sslCertificate?: ICert;
+};

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/domainidentifier.ts

@@ -0,0 +1,22 @@
+export interface IDomainIdentifier {
+  /**
+   * only if it applis: the origininating url
+   */
+  fullUrl: string;
+  /**
+   * the full domain name
+   */
+  fullDomain: string;
+  /**
+   * the domain, meaning whats usually considered a domain like google.com
+   */
+  domain: string;
+  /**
+   * the public suffix, meaning whats usually considered a public suffix like .com
+   */
+  publicSuffix: string;
+  /**
+   * the subdomain, meaning whats usually considered a subdomain like www
+   */
+  subdomain: string;
+}

ts/network/index.ts

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

ts/saas/index.ts

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

ts/saas/subscriptionplan.ts

@@ -1,4 +1,4 @@
-import { IProduct } from './product';
+import { IProduct } from './product.js';
 
 export interface ISubscriptionPlan {
   name: string;

ts/website/index.ts

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

ts/website/menuitem.ts

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

tsconfig.json

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

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"
-}