8.0.3

Reviewed-on: #4

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: code.foss.global/host.today/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @ship.zone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -3,7 +3,6 @@
 # artifacts
 coverage/
 public/
-pages/
 
 # installs
 node_modules/
@@ -17,4 +16,4 @@ node_modules/
 dist/
 dist_*/
 
-# custom
+#------# custom

changelog.md

@@ -1,5 +1,157 @@
 # Changelog
 
+## 2025-03-24 - 8.0.3 - fix(ci)
+Add Gitea workflow files for CI/CD, update repository URLs, and standardize formatting
+
+- Added .gitea/workflows/default_nottags.yaml and default_tags.yaml to manage CI for tagged and non-tagged pushes
+- Updated package.json repository, homepage, and bugs URLs to reflect the new code.foss.global location
+- Modified .gitignore custom section comment for clarity
+- Standardized code formatting and string quoting across various source files
+- Enhanced tsconfig.json by adding baseUrl and paths settings
+
+## 2025-03-24 - 8.0.2 - fix(commitinfo)
+Refresh autogenerated commit info and internal metadata for version consistency
+
+- No functional changes were made
+- Updated internal commit metadata to reflect the current project state
+
+## 2025-03-24 - 8.0.1 - fix(documentation)
+Improve documentation clarity and update package metadata
+
+- Correct author field in package.json to 'Task Venture Capital GmbH'
+- Enhance readme.md with comprehensive usage examples and detailed type structure for better guidance
+
+## 2025-03-24 - 8.0.0 - BREAKING CHANGE(tsclass)
+Trigger patch release with no code changes
+
+
+## 2025-03-20 - 7.1.1 - fix(finance)
+Add optional date property to the IInvoice interface
+
+- Introduced an optional 'date' field with explanatory comments to capture the invoice date if not provided from the encompassing letter
+
+## 2025-03-20 - 7.1.0 - feat(ts/finance/invoice)
+Add electronicAddress field to IInvoice for circular xinvoice support
+
+- Introduce optional electronicAddress property with scheme and value
+- Enhance documentation for buyer reference in invoice interface
+
+## 2025-03-20 - 7.0.0 - BREAKING CHANGE(business/address)
+Remove eAddress property from IAddress interface
+
+- Removed eAddress field that allowed storage of electronic contact means (phone, email, peppolId)
+
+## 2025-03-20 - 6.1.2 - fix(business/address)
+Improve documentation comments for address interface properties
+
+- Added detailed comments for the 'coordinates' property to explain its usage
+- Added detailed comments for the 'eAddress' property to describe the storage of electronic contact information
+
+## 2025-03-20 - 6.1.1 - fix(finance)
+Add clarifying comment for the buyerReference field in the invoice interface
+
+- Document buyerReference as an optional field to help buyers identify the invoice
+
+## 2025-03-20 - 6.1.0 - feat(business/address)
+Add optional countryCode and coordinates properties to IAddress interface
+
+- Extend address interface with an optional countryCode property
+- Add optional coordinates object with lat and lng for geographic metadata
+
+## 2025-03-19 - 6.0.1 - fix(business)
+Remove exports for 'company' and 'person' modules from the business index
+
+- Removed export statement for './company.js' in ts/business/index.ts
+- Removed export statement for './person.js' in ts/business/index.ts
+
+## 2025-03-19 - 6.0.0 - BREAKING CHANGE(TContact)
+Reaffirm project metadata and documentation consistency
+
+- Verified commitinfo data, package.json, and README content for correctness
+- No functional code changes were introduced
+
+## 2025-03-11 - 5.0.0 - BREAKING CHANGE(network)
+Update reverse proxy configuration to support multiple destination IPs and ports
+
+- Replaced 'destinationIp' and 'destinationPort' with 'destinationIps' (array) and 'destinationPorts' (array) to enable multiple destinations
+
+## 2025-03-10 - 4.4.4 - fix(business)
+Fixes typo in ILetter interface
+
+- Removed unused property 'letterData' from ILetter content structure.
+
+## 2025-03-07 - 4.4.3 - fix(network)
+Fix destinationPort type for IReverseProxyConfig
+
+- Corrected the type of destinationPort in IReverseProxyConfig from 'string' to 'number'.
+
+## 2025-03-07 - 4.4.2 - fix(dependencies)
+Updated package dependencies for improved stability and performance.
+
+- Updated 'type-fest' dependency to version ^4.37.0.
+- Updated '@git.zone/tsbuild' to version ^2.2.6.
+- Updated '@git.zone/tstest' to version ^1.0.96.
+- Updated '@push.rocks/tapbundle' to ^5.5.6.
+- Updated '@types/node' to ^22.13.9.
+
+## 2025-03-07 - 4.4.1 - fix(business)
+Fix missing letterData property in ILetter interface.
+
+- Added missing letterData property to the content structure of the ILetter interface.
+- Ensured consistency and completeness of ILetter interface for proper data handling of letter components.
+
+## 2025-01-11 - 4.4.0 - feat(website)
+Add ILinkBlock interface for managing groups of links
+
+- Introduced a new interface ILinkBlock in ts/website/linkblock.ts for managing grouped links.
+- Exported ILinkBlock from ts/website/index.ts to make it available for external usage.
+
+## 2025-01-10 - 4.3.0 - feat(website)
+Added new ILink interface to the website module.
+
+- Introduced ILink interface with properties like url, text, description, icon, and target.
+- Updated ts/website/index.ts to export the new link interface.
+
+## 2024-12-11 - 4.2.0 - feat(dependencies)
+Update dependencies and enhance code documentation
+
+- Updated 'type-fest' dependency from ^4.20.1 to ^4.30.0 for improved type definitions.
+- Updated development dependencies for better development experience.
+- Enhanced code documentation for the ICommitInfo interface with detailed JSDoc comments.
+
+## 2024-07-26 - 4.1.2 - fix(finance)
+Updated IInvoice interface to support various currencies.
+
+- Changed the 'currency' field in the IInvoice interface from fixed 'EUR' to type TCurrency.
+
+## 2024-07-26 - 4.1.1 - fix(finance)
+Fix IInvoice interface to correctly include the currency field
+
+- Corrected the IInvoice interface definition in `ts/finance/invoice.ts`
+- Moved `position` field to the top of the IInvoiceItem interface
+
+## 2024-07-26 - 4.1.0 - feat(finance)
+Added notes field to IInvoice interface
+
+- Expanded IInvoice interface to include notes field allowing additional notes for invoices.
+
+## 2024-07-24 - 4.0.65 - fix(finance)
+Added 'type' property to IInvoice interface
+
+- Added 'type' property to the IInvoice interface in the finance domain.
+- This property indicates whether the invoice is a 'creditnote' or 'debitnote'.
+
+## 2024-07-18 - 4.0.64 - fix(business)
+Add relationship field to contact interface
+
+- Added 'relationship' field to the IContact interface in ts/business/contact.ts
+
+## 2024-06-28 - 4.0.63 - fix(saas)
+Refactor IProduct to separate IProductFeature interface
+
+- Updated @types/node from 20.14.8 to 20.14.9
+- Refactored IProduct's features property to a standalone IProductFeature interface in saas/product.ts
+
 ## 2024-06-24 - 4.0.62 - fix(dependencies)
 Updated dependencies to latest versions
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsclass/tsclass",
-  "version": "4.0.62",
+  "version": "8.0.3",
   "private": false,
   "description": "Provides TypeScript definitions for various business, financial, networking, content, and other common classes.",
   "main": "dist_ts/index.js",
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/tsclass/tsclass.git"
+    "url": "https://code.foss.global/tsclass/tsclass.git"
   },
   "keywords": [
     "TypeScript",
@@ -30,21 +30,21 @@
     "Authentication",
     "Web Development"
   ],
-  "author": "Lossless GmbH",
+  "author": "Task Venture Capital GmbH",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/tsclass/tsclass/issues"
+    "url": "https://code.foss.global/tsclass/tsclass/issues"
   },
-  "homepage": "https://github.com/tsclass/tsclass#readme",
+  "homepage": "https://code.foss.global/tsclass/tsclass#readme",
   "dependencies": {
-    "type-fest": "^4.20.1"
+    "type-fest": "^4.37.0"
   },
   "devDependencies": {
-    "@git.zone/tsbuild": "^2.1.82",
-    "@git.zone/tsrun": "^1.2.49",
-    "@git.zone/tstest": "^1.0.90",
-    "@push.rocks/tapbundle": "^5.0.23",
-    "@types/node": "^20.14.8"
+    "@git.zone/tsbuild": "^2.3.2",
+    "@git.zone/tsrun": "^1.3.3",
+    "@git.zone/tstest": "^1.0.96",
+    "@push.rocks/tapbundle": "^5.6.0",
+    "@types/node": "^22.13.11"
   },
   "files": [
     "ts/**/*",
@@ -60,5 +60,8 @@
   ],
   "browserslist": [
     "last 1 chrome versions"
-  ]
+  ],
+  "pnpm": {
+    "overrides": {}
+  }
 }

readme.md

@@ -1,40 +1,77 @@
 # @tsclass/tsclass
-common classes for TypeScript
 
-## Install
+A comprehensive TypeScript library providing well-structured type definitions for various domains including business, finance, networking, content management, and more.
 
-To install `@tsclass/tsclass`, run the following command in your project directory:
+## Installation
 
 ```bash
 npm install @tsclass/tsclass
 ```
 
-This will add `@tsclass/tsclass` to your project's dependencies.
+## Overview
 
-## Usage
+This library offers a rich collection of TypeScript interfaces and types designed to provide consistent structures for common business and development needs. It's organized into domain-specific modules to maintain clarity and separation of concerns.
 
-`@tsclass/tsclass` offers a comprehensive TypeScript library that provides common classes and interfaces for various domains, including business, finance, content, networking, and more. The package utilizes ESM syntax and is intended for use with TypeScript for optimal developer experience.
+## Type Structure
 
-### Getting Started
+### Authentication
+- **IClaim**: Authentication claims with user and role data
+- **IProcessedClaim**: Processed JWT claims with verification status
 
-First, ensure that you are using ES Modules in your TypeScript project by having `"type": "module"` in your `package.json`, and install the package as described above.
+### Business
+- **TDocumentEnvelope**: Base type for all document types
+- **IAddress**: Physical/postal address structure
+- **TContact**: Person and company contact information
+- **TContractEnvelope**: Various contract types (Employment, NDA, Service, Lease)
+- **TLetterEnvelope**: Letter document types
+- **IPdf**: PDF document with metadata
 
-### Importing Classes and Interfaces
+### Finance
+- **TCurrency**: Currency representation
+- **TInvoiceEnvelope**: Invoice document structure
+- **TInvoiceItem**: Line items for invoices
+- **IPaymentOptionInfo**: Banking and payment method details
 
-You can import classes and interfaces from `@tsclass/tsclass` as follows:
+### Network
+- **INetworkNode**: Network device representation
+- **ICert**: Certificate management
+- **IJWT**: JWT token structure
+- **IDnsChallenge**: DNS verification challenges
 
-```typescript
-import { business, finance, content } from '@tsclass/tsclass';
-```
+### Container
+- **IContainer**: Container configuration
+- **IVolumeMount**: Volume mount specification
 
-### Business Domain
+### Database
+- **IMongoDescriptor**: MongoDB connection details
+- **IObjectAction**: Document lifecycle tracking
 
-The business domain includes classes for managing contacts, companies, and projects. Here is how you can work with a company and contact classes:
+### Content
+- **IArticle**: Content article structure
+- **IAuthor**: Content author metadata
+- **IDocumentationSet**: Documentation collections
+
+### Code
+- **ICommitInfo**: Code commit information
+- **IStatusObject**: Status tracking object
+
+### Website
+- **ILink**: Website link structure
+- **ILinkBlock**: Link collection
+- **IMenuItem**: Navigation menu items
+
+### SaaS
+- **IProduct**: SaaS product definition
+- **ISubscriptionPlan**: Subscription plan details
+
+## Usage Examples
+
+### Business Contact
 
 ```typescript
 import { business } from '@tsclass/tsclass';
 
-const companyContact: business.IContact = {
+const companyContact: business.TCompany = {
   type: 'company',
   name: 'Example Company',
   address: {
@@ -44,86 +81,59 @@ const companyContact: business.IContact = {
     city: 'Example City',
     country: 'Exland'
   },
-  description: 'An example company for demonstration purposes.',
-  email: 'contact@example.com'
-};
-
-const exampleCompany: business.ICompany = {
-  name: 'Example Company',
+  email: 'contact@example.com',
   foundedDate: {
     day: 1,
     month: 1,
     year: 2020
   },
-  status: 'active',
-  contact: companyContact
+  status: 'active'
 };
 ```
 
-### Finance Domain
-
-The finance domain provides interfaces for working with invoices, transactions, and payment information. Here’s how you can define an invoice:
+### Invoice
 
 ```typescript
-import { finance } from '@tsclass/tsclass';
+import { finance, business } from '@tsclass/tsclass';
 
-const exampleInvoice: finance.IInvoice = {
-  id: 'INV12345',
-  billedBy: companyContact,
-  billedTo: companyContact, // In a real scenario, this should be a different contact.
-  status: 'draft',
+const invoice: finance.TInvoiceEnvelope = {
+  id: 'INV-2023-001',
+  status: 'invoice',
+  issueDate: {
+    day: 15,
+    month: 3,
+    year: 2023
+  },
   items: [
     {
-      name: 'Product 1',
-      unitType: 'Item',
-      unitQuantity: 2,
-      unitNetPrice: 50,
+      name: 'Consulting Services',
+      unitType: 'hour',
+      unitQuantity: 10,
+      unitNetPrice: 150,
       vatPercentage: 20,
       currency: 'EUR'
     }
   ],
   dueInDays: 30,
-  reverseCharge: false
+  billedBy: { /* company details */ },
+  billedTo: { /* client details */ }
 };
 ```
 
-### Network Domain
-
-Networking interfaces, such as those for managing SSH keys or network nodes, are available under the `network` namespace:
+### Network Certificate
 
 ```typescript
 import { network } from '@tsclass/tsclass';
 
-const sshKey: network.ISshKey = {
-  keyName: 'example-ssh-key',
-  public: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQD...'
-  // Private key is typically kept secret and not included in source code
+const certificate: network.ICert = {
+  domain: 'example.com',
+  validFrom: { day: 1, month: 1, year: 2023 },
+  validTo: { day: 1, month: 1, year: 2024 },
+  issuer: 'Let\'s Encrypt',
+  certificateBody: '-----BEGIN CERTIFICATE-----\n...'
 };
 ```
 
-### Storage Domain
-
-Interfaces for storage management, such as S3 descriptors, can be found under the `storage` namespace:
-
-```typescript
-import { storage } from '@tsclass/tsclass';
-
-const s3Descriptor: storage.IS3Descriptor = {
-  endpoint: 's3.example.com',
-  accessKey: 'AKIAIOSFODNN7EXAMPLE',
-  accessSecret: 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY',
-  useSsl: true
-};
-```
-
-### Content and More
-
-`@tsclass/tsclass` also provides classes for the content domain (e.g., articles, authors) and many other utilities across different fields. The examples above only scratch the surface of what `@tsclass/tsclass` offers. Depending on your project's needs, explore other domains and interfaces provided by the library.
-
-Remember, while `@tsclass/tsclass` aims to streamline the TypeScript development process by providing ready-to-use classes and interfaces, it is crucial to adapt these examples to your specific project requirements, ensuring that all aspects, such as security (especially for networking and storage operations), are adequately handled.
-
-For a deeper look into all available classes and interfaces, refer to the TypeScript definitions in the package. This will also give you insight into additional functionalities such as content management, events, authentication, and more detailed use cases within each domain.
-
 ## License and Legal Information
 
 This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
@@ -141,4 +151,4 @@ Registered at District court Bremen HRB 35230 HB, Germany
 
 For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
 
-By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

test/test.both.ts

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

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@tsclass/tsclass',
-  version: '4.0.62',
+  version: '8.0.3',
   description: 'Provides TypeScript definitions for various business, financial, networking, content, and other common classes.'
 }

ts/00helperfunctions.ts/finance.ts

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

ts/00helperfunctions.ts/index.ts

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

ts/business/address.ts

@@ -5,4 +5,13 @@ export interface IAddress {
   postalCode: string;
   city: string;
   country: string;
+  countryCode?: string;
+  /**
+   * allows storage of coordinates for this address
+   * useful for countries where addresses are not unique
+   */
+  coordinates?: {
+    lat: number;
+    lng: number;
+  };
 }

ts/business/company.ts

@@ -1,20 +0,0 @@
-import { business, general } from '../index.js';
-
-/**
- * describes a company's lifecycle state
- */
-export type TCompanyStatus = 'planed' | 'founding' | 'active' | 'liquidation' | 'closed';
-
-/**
- * describes a company
- */
-export interface ICompany {
-  name: string;
-  slogan?: string;
-  description?: string;
-  logoLink?: string;
-  foundedDate: general.IDate;
-  closedDate: general.IDate;
-  status: business.TCompanyStatus;
-  contact: business.IContact;
-}

ts/business/contact.ts

@@ -1,38 +1,84 @@
-import { finance } from '../index.js';
-import { business } from '../index.js';
+import { finance, general } from "../index.js";
+import { business } from "../index.js";
 
-export type TContactSalutation = 'Mr' | 'Ms' | 'Mrs';
+export type TSocialLinks = {
+  type: "facebook" | "twitter" | "linkedin" | string;
+  url: string;
+};
 
-export type TContactType = 'person' | 'company';
+export type TRegistrationDetails = {
+  vatId: string;
+  registrationId: string;
+  registrationName: string;
+};
 
-export type TContactTitle = 'Doctor' | 'Professor';
-
-export interface IContact {
-  // =======
-  // general
-  // =======
-  salutation?: TContactSalutation;
-  type: TContactType;
-  title?: TContactTitle;
+type TContactEnvelope<TYPE extends string, FIELDS> = {
+  type: TYPE;
   name: string;
-  surname?: string;
-  legalEntity?: string;
   address: business.IAddress;
   description: string;
+  legalEntity?: string;
   customerNumber?: string;
+  relationship?: "customer" | "supplier" | "partner" | "employee" | "other";
+
   email?: string;
-
-  logoUrl?: string;
-  website?: string;
-  facebookUrl?: string;
-  twitterUrl?: string;
-
   phone?: string;
   fax?: string;
 
-  // =========
-  // financial
-  // =========
-  vatId?: string;
+  logoUrl?: string;
+  website?: string;
+
+  socials?: TSocialLinks[];
+
   sepaConnection?: finance.ISepaConnection;
-}
+} & FIELDS;
+
+export type TPerson = TContactEnvelope<
+  "person",
+  {
+    surname: string;
+    salutation: "Mr" | "Ms" | "Mrs";
+    sex: "male" | "female" | "other";
+    title: "Doctor" | "Professor";
+    registrationDetails?: TRegistrationDetails;
+    legalProxyFor?: {
+      type: "self" | "other";
+      contact?: TContact;
+    };
+  }
+>;
+
+type TCompanyInCreation = {
+  status: "planned" | "founding";
+};
+
+type TCompanyActive = {
+  status: "active";
+  foundedDate: general.IDate;
+};
+
+type TCompanyInLiquidation = {
+  status: "liquidation";
+  foundedDate: general.IDate;
+  liquidationDate: general.IDate;
+};
+
+type TCompanyClosed = {
+  status: "closed";
+  foundedDate: general.IDate;
+  liquidationDate: general.IDate;
+  closedDate: general.IDate;
+};
+
+type TCompanyStatus =
+  | TCompanyInCreation
+  | TCompanyActive
+  | TCompanyInLiquidation
+  | TCompanyClosed;
+
+export type TCompany = TContactEnvelope<
+  "company",
+  { registrationDetails: TRegistrationDetails } & TCompanyStatus
+>;
+
+export type TContact = TPerson | TCompany;

ts/business/contract.ts

@@ -1,20 +1,157 @@
-import * as database from '../database/index.js';
-import { type IPerson } from './person.js';
+import * as database from "../database/index.js";
+import { business } from "../index.js";
 
-export interface IContract {
-  parties: {
-    signingOrder: number;
-    referencedAs: string;
-    person: IPerson;
-    role: 'signer' | 'cc';
-    signature: {
-      given: boolean;
-      timestamp?: number;
+/**
+ * Represents a paragraph or section in a contract.
+ */
+export type TContractParagraph = {
+  id: string;
+  title?: string;
+  content: string;  // Markdown formatted text
+  order: number;
+  type: "heading" | "clause" | "subclause" | "definition" | "exhibit";
+  isRequired: boolean;
+  metadata?: {
+    applicableJurisdictions?: string[];
+    tags?: string[];
+    lastModified?: number;
+    versionId?: string;
+  };
+};
+
+/**
+ * Contract party with signature information.
+ */
+export type TContractParty = {
+  signingOrder: number;
+  referencedAs: string;
+  person: business.TPerson;
+  role: "signer" | "cc" | "witness";
+  signature: {
+    given: boolean;
+    timestamp?: number;
+    location?: string;
+    ip?: string;
+    verifications?: any[];
+  };
+};
+
+/**
+ * Contract attachment like exhibits, appendices.
+ */
+export type TContractAttachment = {
+  id: string;
+  title: string;
+  type: "exhibit" | "appendix" | "schedule";
+  fileReference?: string;
+  content?: string;  // Markdown or reference
+};
+
+/**
+ * Base envelope type for all contract types, extending the common document type.
+ */
+export type TContractEnvelope<TYPE extends string, FIELDS> = business.TDocumentEnvelope<
+  TYPE,
+  {
+    // Contract-specific dates
+    effectiveDate: number;
+    expirationDate?: number;
+    
+    // Contract-specific status
+    status: "draft" | "negotiation" | "active" | "expired" | "terminated" | "renewed";
+    
+    // Parties (multiple, without sender/recipient distinction)
+    parties: TContractParty[];
+    
+    // Structured content
+    paragraphs: TContractParagraph[];
+    
+    // Additional attachments
+    attachments?: TContractAttachment[];
+  } & FIELDS
+>;
+
+/**
+ * Employment contract specific type.
+ */
+export type TEmploymentContract = TContractEnvelope<
+  "employment", 
+  {
+    employmentTerms: {
+      startDate: number;
+      position: string;
+      compensationDetails: string;
+      workingHours?: string;
       location?: string;
-      ip?: string;
-      verifications?: [];
+      probationPeriod?: {
+        durationInMonths: number;
+        terms?: string;
+      };
     };
-  }[];
-  contractTextMarkdown: string;
-  actions: database.IObjectAction[];
-}
+  }
+>;
+
+/**
+ * Non-disclosure agreement specific type.
+ */
+export type TNDAContract = TContractEnvelope<
+  "nda", 
+  {
+    confidentialityTerms: {
+      duration: number;  // In months
+      scope: string;
+      exclusions?: string[];
+    };
+  }
+>;
+
+/**
+ * Service agreement specific type.
+ */
+export type TServiceContract = TContractEnvelope<
+  "service", 
+  {
+    serviceTerms: {
+      scope: string;
+      deliverables: string[];
+      timeline?: {
+        milestones: {
+          description: string;
+          dueDate: number;
+        }[];
+      };
+      paymentTerms: string;
+    };
+  }
+>;
+
+/**
+ * Real estate lease agreement specific type.
+ */
+export type TLeaseContract = TContractEnvelope<
+  "lease", 
+  {
+    propertyDetails: {
+      address: business.IAddress;
+      propertyType: string;
+      areaSize?: number;
+      areaSizeUnit?: string;
+    };
+    leaseTerms: {
+      rentAmount: number;
+      rentCurrency: string;
+      paymentFrequency: "monthly" | "quarterly" | "annually";
+      depositAmount?: number;
+      utilities?: string[];
+    };
+  }
+>;
+
+/**
+ * Union type for all contract types.
+ */
+export type TContract = 
+  | TEmploymentContract 
+  | TNDAContract 
+  | TServiceContract 
+  | TLeaseContract;

ts/business/document.ts

@@ -0,0 +1,107 @@
+import * as database from "../database/index.js";
+import * as business from "./index.js";
+
+/**
+ * Base type for common document properties across different document types.
+ */
+export type TDocumentEnvelope<TYPE extends string, FIELDS> = {
+  /**
+   * Document type identifier
+   */
+  type: TYPE;
+  
+  /**
+   * Unique identifier for the document
+   */
+  id: string;
+  
+  /**
+   * Document creation/issuance date as a Unix timestamp
+   */
+  date: number;
+  
+  /**
+   * Document status in its lifecycle
+   */
+  status: string;
+  
+  /**
+   * Version information for the document
+   */
+  versionInfo: {
+    /**
+     * Should follow semVer format
+     */
+    version: string;
+    
+    /**
+     * Type of version (draft vs final)
+     */
+    type: "draft" | "final";
+    
+    /**
+     * When this version was last modified
+     */
+    lastModified?: number;
+    
+    /**
+     * Version history for tracking changes
+     */
+    history?: {
+      version: string;
+      modifiedAt: number;
+      modifiedBy?: string;
+      changeDescription?: string;
+    }[];
+  };
+  
+  /**
+   * Primary language of the document
+   */
+  language: string;
+  
+  /**
+   * The text displayed at the top of the document, often a greeting or introduction
+   */
+  topText?: string;
+  
+  /**
+   * The text displayed at the bottom of the document, often a signature or conclusion
+   */
+  bottomText?: string;
+  
+  /**
+   * Formatting/branding information
+   */
+  appearance?: {
+    /**
+     * URL to the logo to be displayed on the document
+     */
+    logoUrl?: string;
+    
+    /**
+     * Primary color for document styling
+     */
+    accentColor?: string;
+    
+    /**
+     * Font family for the document
+     */
+    fontFamily?: string;
+  };
+  
+  /**
+   * References to PDF versions of the document
+   */
+  pdf?: business.IPdf;
+  
+  /**
+   * PDF attachments are additional PDFs attached to the document
+   */
+  pdfAttachments?: business.IPdf[];
+  
+  /**
+   * Track document lifecycle actions
+   */
+  objectActions?: database.IObjectAction[];
+} & FIELDS;

ts/business/index.ts

@@ -1,8 +1,7 @@
 export * from './address.js';
-export * from './company.js';
 export * from './contact.js';
+export * from './document.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

@@ -1,18 +1,17 @@
-import * as finance from '../finance/index.js';
-import { type ICompany } from './company.js';
-import { type IContact } from './contact.js';
+import * as finance from "../finance/index.js";
+import { type TContact } from "./contact.js";
 export class IJob {
-  type: 'contract' | 'employment';
+  type: "contract" | "employment";
   techTags?: string[];
   qualificationTags?: string[];
   languages?: {
     name: string;
-    level: 'basic' | 'intermediate' | 'advanced' | 'native';
+    level: "basic" | "intermediate" | "advanced" | "native";
   }[];
   name: string;
   description: string;
   monthlyTotal: number;
   currency: finance.TCurrency;
-  from: ICompany;
-  contact: IContact;
-}
+  from: TContact;
+  contact: TContact;
+}

ts/business/letter.ts

@@ -1,35 +1,65 @@
-import * as business from './index.js';
-import * as finance from '../finance/index.js';
-import * as database from '../database/index.js';
-export interface ILetter {
-  versionInfo: {
-    type: 'draft' | 'final';
+import * as business from "./index.js";
+import * as finance from "../finance/index.js";
+
+/**
+ * Letter-specific envelope extending the base document type
+ */
+export type TLetterEnvelope<TYPE extends string, FIELDS> = business.TDocumentEnvelope<
+  TYPE,
+  {
     /**
-     * should follow semVer
+     * The incident or case ID this letter relates to
      */
-    version: string;
-  };
-  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;
+    incidenceId: string;
+    
+    /**
+     * The sender of the letter
+     */
+    from: business.TContact;
+    
+    /**
+     * The recipient of the letter
+     */
+    to: business.TContact;
+    
+    /**
+     * The legal contact is the contact that is responsible for the letter
+     * this is often the same as the from contact, but not always
+     */
+    legalContact?: business.TContact;
+    
+    /**
+     * Subject line of the letter
+     */
+    subject: string;
+    
+    /**
+     * Cover sheet configuration for the letter
+     */
+    coverSheet?: {
+      enabled: boolean;
+      coverSheetText: string;
+      /**
+       * if true, the cover sheet will be marked as confidential
+       * hinting that only authorized persons should handle the letter
+       */
+      confidential: boolean;
     };
-    timesheetData: string;
-  }
-  pdf?: business.IPdf;
-  pdfAttachments: business.IPdf[];
-  language: string;
-  objectActions: database.IObjectAction[];
-}
+  } & FIELDS
+>;
+
+export type TLetterSimple = TLetterEnvelope<"simple", {}>;
+
+
+export type TLetter = TLetterSimple;
+
+// type: "invoice" | "notice" | "warning" | "verification" | "contract";
+/* content: {
+  textData: string[];
+  invoiceData?: finance.IInvoice;
+  contractData?: {
+    id: string;
+    contractDate: number;
+  };
+  timesheetData: string;
+}; */

ts/business/person.ts

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

ts/code/commitinfo.ts

@@ -1,5 +1,20 @@
 export interface ICommitInfo {
+  /**
+   * the name of the project
+   */
   name: string;
+  /**
+   * the current version of the project
+   */
   version: string;
+
+  /**
+   * the description of the project
+   */
   description: string;
+
+  /**
+   * the changelog of the project
+   */
+  changelog?: string[]; 
 }

ts/finance/expense.ts

@@ -13,5 +13,5 @@ export interface IVoucher {
   date: Date;
   description: string;
   expenseItems: IExpenseItem[];
-  contactRef: business.IContact;
+  contactRef: business.TContact;
 }

ts/finance/invoice.ts

@@ -1,38 +1,65 @@
 import { business, finance } from '../index.js';
+import type { TCurrency } from './currency.js';
 
 export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
 
-export interface IInvoiceItem {
+export type TInvoiceItem = {
+  position: number;
   name: string;
   articleNumber?: string;
   unitType: string;
   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[];
+export type TInvoiceEnvelope<
+  TYPE extends 'creditnote' | 'debitnote',
+  FIELDS,
+> = business.TLetterEnvelope<
+  'invoice',
+  {
+    invoiceId: string;
+    invoiceType: TYPE;
+    status: TInvoiceStatus;
+    items: TInvoiceItem[];
+    periodOfPerformance?: {
+      from: number;
+      to: number;
     };
-  };
-  paymentOptions?: finance.IPaymentOptionInfo;
-}
+    deliveryDate?: number;
+    dueInDays: number;
+    reverseCharge: boolean;
+    /**
+     * buyer reference is an optional field, that helps the buyer to identify the invoice
+     */
+    buyerReference?: string;
+    /**
+     * also a kind of reference, esspecially needed for circular xinvoice support.
+     */
+    electronicAddress?: {
+      scheme: string;
+      value: string;
+    };
+    printResult?: {
+      pdfBufferString: string;
+      totalNet: number;
+      totalGross: number;
+      vatGroups: {
+        percentage: number;
+        items: TInvoiceItem[];
+      };
+    };
+    notes: string[];
+    paymentOptions?: finance.IPaymentOptionInfo;
+    currency: TCurrency;
+  } & FIELDS
+>;
+
+export type TCreditNote = TInvoiceEnvelope<'creditnote', {}>;
+export type TDebitNote = TInvoiceEnvelope<'debitnote', {}>;
+
+export type TInvoice = TCreditNote | TDebitNote;
+
+// Legacy type for backward compatibility
+export interface IInvoiceItem extends TInvoiceItem {}

ts/index.ts

@@ -31,7 +31,19 @@ import * as storage from './storage/index.js';
 // Website
 import * as website from './website/index.js';
 
-export { business, container, code, database, finance, content, general, network, saas, storage, website };
+export {
+  business,
+  container,
+  code,
+  database,
+  finance,
+  content,
+  general,
+  network,
+  saas,
+  storage,
+  website,
+};
 
 import type * as typeFest from 'type-fest';
 import * as typeFestOwn from './typefest.own.js';

ts/network/cname.ts

@@ -1,4 +1,4 @@
-import { type ICert } from "./cert.js";
+import { type ICert } from './cert.js';
 
 export class ICnameDescriptor {
   /**
@@ -26,4 +26,4 @@ export class ICnameDescriptor {
    * the ssl certificate
    */
   sslCertificate?: ICert;
-};
+}

ts/network/dns.ts

@@ -1,24 +1,24 @@
 export type TDnsRecordType =
-  | "A"
-  | "AAAA"
-  | "CNAME"
-  | "LOC"
-  | "PTR"
-  | "MX"
-  | "NAPTR"
-  | "NS"
-  | "SRV"
-  | "TXT"
-  | "CAA"
-  | "CERT"
-  | "DNSKEY"
-  | "DS"
-  | "HTTPS"
-  | "SMIMEA"
-  | "SSHFP"
-  | "SVCB"
-  | "TLSA"
-  | "URI";
+  | 'A'
+  | 'AAAA'
+  | 'CNAME'
+  | 'LOC'
+  | 'PTR'
+  | 'MX'
+  | 'NAPTR'
+  | 'NS'
+  | 'SRV'
+  | 'TXT'
+  | 'CAA'
+  | 'CERT'
+  | 'DNSKEY'
+  | 'DS'
+  | 'HTTPS'
+  | 'SMIMEA'
+  | 'SSHFP'
+  | 'SVCB'
+  | 'TLSA'
+  | 'URI';
 
 export interface IDnsRecord {
   name: string;

ts/network/jwt.ts

@@ -1,4 +1,4 @@
 export interface IJwtKeypair {
   privatePem: string;
   publicPem: string;
-}
+}

ts/network/reverseproxy.ts

@@ -1,6 +1,6 @@
 export interface IReverseProxyConfig {
-  destinationIp: string;
-  destinationPort: string;
+  destinationIps: string[];
+  destinationPorts: number[];
   hostName: string;
   privateKey: string;
   publicKey: string;

ts/network/ssh.ts

@@ -2,4 +2,4 @@ export interface ISshKey {
   keyName: string;
   public: string;
   private?: string;
-}
+}

ts/saas/product.ts

@@ -1,14 +1,22 @@
-import { type ICompany } from "../business/company.js";
+import type { TCompany } from '../business/contact.js';
 
 export interface IProduct {
   name: string;
   slogan: string;
   description: string;
-  os: 'web-based',
-  category: 'Business Application',
+  os: 'web-based';
+  category: 'Business Application';
   offers: any[];
+  features: IProductFeature[];
   landingPage: string;
   appLink: string;
   logoLink: string;
-  publisher?: ICompany;
-}
+  publisher?: TCompany;
+}
+
+export interface IProductFeature {
+  heading: string;
+  description: string;
+  linkText: string;
+  linkUrl: string;
+}

ts/typefest.own.ts

@@ -2,7 +2,4 @@ type SecondArgument<T> = T extends (arg1: any, arg2: infer P, ...args: any[]) =>
 
 type ValueType<T> = T extends { [key: string]: infer U } ? U : never;
 
-export type {
-  SecondArgument,
-  ValueType
-}
+export type { SecondArgument, ValueType };

ts/website/index.ts

@@ -1 +1,3 @@
+export * from './link.js';
 export * from './menuitem.js';
+export * from './linkblock.js';

ts/website/link.ts

@@ -0,0 +1,7 @@
+export interface ILink {
+  url: string;
+  text?: string;
+  description?: string;
+  icon?: string;
+  target?: '_blank' | '_self' | '_parent' | '_top';
+}

ts/website/linkblock.ts

@@ -0,0 +1,6 @@
+import type { ILink } from './link.js';
+
+export interface ILinkBlock {
+  title: string;
+  links: ILink[];
+}

tsconfig.json

@@ -6,9 +6,11 @@
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "esModuleInterop": true,
-    "verbatimModuleSyntax": true
+    "verbatimModuleSyntax": true,
+    "baseUrl": ".",
+    "paths": {}
   },
   "exclude": [
     "dist_*/**/*.d.ts"
   ]
-}
+}