Compare commits

...

55 Commits

Author SHA1 Message Date
e4028e6ac1 8.0.0 2025-03-24 08:04:14 +00:00
dfee187404 BREAKING CHANGE(tsclass): new document base type for invoice, contract etc. 2025-03-24 08:04:14 +00:00
065b5faba2 Merge pull request 'feat/TInvoice' (#2) from feat/TInvoice into master
Reviewed-on: #2
Reviewed-by: Dominik Schwank <dominik@schwank.cc>
2025-03-24 07:55:21 +00:00
7ddc98d9c8 remove obsolete files 2025-03-22 23:42:45 +00:00
65503e554b feat(business): Add TDocumentEnvelope as common base for letters and contracts
- Created a new TDocumentEnvelope base type for shared document properties
- Refactored TLetterEnvelope to extend from TDocumentEnvelope
- Refactored TContractEnvelope to extend from TDocumentEnvelope
- Centralized common fields like version tracking, date, and formatting
2025-03-22 23:42:22 +00:00
9b66c438b4 feat(business): Refactor TContract to use structured paragraphs and envelope pattern
- Replaced single markdown string with structured paragraphs
- Implemented TContractEnvelope pattern for different contract types
- Added specific contract types (employment, NDA, service, lease)
- Added metadata for dates, status, versioning, and attachments
- Removed legacy contract interface
2025-03-22 23:34:45 +00:00
0c977bd869 feat(finance): Refactor TInvoice to use TLetterEnvelope pattern
- Implemented envelope pattern for TInvoice using business.TLetterEnvelope
- Separated TInvoice into TCreditNote and TDebitNote types
- Fixed IInvoiceItem references to use TInvoiceItem
- Added compatibility interface for IInvoiceItem
2025-03-22 21:38:50 +00:00
6d3f097bb8 on the way to new letter / invoice relationship 2025-03-22 21:27:20 +00:00
d87b50fb45 7.1.1 2025-03-20 19:25:56 +00:00
4f72f484d0 fix(finance): Add optional date property to the IInvoice interface 2025-03-20 19:25:56 +00:00
7931d458c5 7.1.0 2025-03-20 18:56:35 +00:00
d5b21e6567 feat(ts/finance/invoice): Add electronicAddress field to IInvoice for circular xinvoice support 2025-03-20 18:56:35 +00:00
1ccafa8c87 7.0.0 2025-03-20 18:53:49 +00:00
850d56df8b BREAKING CHANGE(business/address): Remove eAddress property from IAddress interface 2025-03-20 18:53:49 +00:00
dead451ab0 6.1.2 2025-03-20 17:52:17 +00:00
d7855494a7 fix(business/address): Improve documentation comments for address interface properties 2025-03-20 17:52:17 +00:00
0a12915c7e 6.1.1 2025-03-20 17:44:10 +00:00
9a942cafa5 fix(finance): Add clarifying comment for the buyerReference field in the invoice interface 2025-03-20 17:44:10 +00:00
0292b4fef4 6.1.0 2025-03-20 17:34:56 +00:00
2d9d2a5a47 feat(business/address): Add optional countryCode and coordinates properties to IAddress interface 2025-03-20 17:34:56 +00:00
079e315b23 6.0.1 2025-03-19 14:17:43 +00:00
caf3e4766f fix(business): Remove exports for company and person modules from the business index 2025-03-19 14:17:43 +00:00
50b5630aed 6.0.0 2025-03-19 14:16:55 +00:00
a8776be6b8 BREAKING CHANGE(TContact): new structure around TContact that combines functionality of previous interfaces like ICompany and IPerson 2025-03-19 14:16:55 +00:00
4e173d4dd4 Merge pull request 'feat: add registration info and refactor contact' (#1) from feat/add-registration-info into master
Reviewed-on: #1
2025-03-19 14:08:30 +00:00
edcbdea31f chore: fix typo 2025-03-18 16:49:51 +00:00
6072974bda feat: add registration info and refactor contact 2025-03-17 19:15:08 +00:00
8883bf181e 5.0.0 2025-03-11 12:07:33 +00:00
cd09a70232 BREAKING CHANGE(network): Update reverse proxy configuration to support multiple destination IPs and ports 2025-03-11 12:07:33 +00:00
e6811c75fc 4.4.4 2025-03-10 15:20:24 +00:00
e0ba9c6cef fix(business): Fixes typo in ILetter interface 2025-03-10 15:20:24 +00:00
90c56c6d4f 4.4.3 2025-03-07 14:21:32 +00:00
91caa9a747 fix(network): Fix destinationPort type for IReverseProxyConfig 2025-03-07 14:21:32 +00:00
115250edab 4.4.2 2025-03-07 14:20:18 +00:00
1127b8961f fix(dependencies): Updated package dependencies for improved stability and performance. 2025-03-07 14:20:18 +00:00
cc15835c8e 4.4.1 2025-03-07 14:18:42 +00:00
300ac01629 fix(business): Fix missing letterData property in ILetter interface. 2025-03-07 14:18:42 +00:00
a9a2f94f7e 4.4.0 2025-01-11 19:01:53 +01:00
5e8473d16b feat(website): Add ILinkBlock interface for managing groups of links 2025-01-11 19:01:53 +01:00
6366b4f990 4.3.0 2025-01-10 22:05:27 +01:00
a3e147f946 feat(website): Added new ILink interface to the website module. 2025-01-10 22:05:26 +01:00
1c6fc3666d 4.2.0 2024-12-11 12:53:04 +01:00
891b0f0f10 feat(dependencies): Update dependencies and enhance code documentation 2024-12-11 12:53:04 +01:00
96a31cbc71 4.1.2 2024-07-26 22:23:23 +02:00
450139682f fix(finance): Updated IInvoice interface to support various currencies. 2024-07-26 22:23:23 +02:00
741b361f4b 4.1.1 2024-07-26 22:20:19 +02:00
cabd160fb2 fix(finance): Fix IInvoice interface to correctly include the currency field 2024-07-26 22:20:18 +02:00
12a9e231ae 4.1.0 2024-07-26 16:51:34 +02:00
f9c7f90d73 feat(finance): Added notes field to IInvoice interface 2024-07-26 16:51:33 +02:00
6095e0ea5c 4.0.65 2024-07-24 15:16:28 +02:00
63b2bd59a2 fix(finance): Added type property to IInvoice interface 2024-07-24 15:16:27 +02:00
c4d13e6f8a 4.0.64 2024-07-18 21:01:09 +02:00
f6bda9a20c fix(business): Add relationship field to contact interface 2024-07-18 21:01:08 +02:00
4f1947d38a 4.0.63 2024-06-28 18:56:02 +02:00
c59ad68771 fix(saas): Refactor IProduct to separate IProductFeature interface 2024-06-28 18:56:01 +02:00
25 changed files with 5693 additions and 1613 deletions

View File

@ -1,5 +1,136 @@
# Changelog # Changelog
## 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) ## 2024-06-24 - 4.0.62 - fix(dependencies)
Updated dependencies to latest versions Updated dependencies to latest versions

View File

@ -1,6 +1,6 @@
{ {
"name": "@tsclass/tsclass", "name": "@tsclass/tsclass",
"version": "4.0.62", "version": "8.0.0",
"private": false, "private": false,
"description": "Provides TypeScript definitions for various business, financial, networking, content, and other common classes.", "description": "Provides TypeScript definitions for various business, financial, networking, content, and other common classes.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
@ -37,14 +37,14 @@
}, },
"homepage": "https://github.com/tsclass/tsclass#readme", "homepage": "https://github.com/tsclass/tsclass#readme",
"dependencies": { "dependencies": {
"type-fest": "^4.20.1" "type-fest": "^4.37.0"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.82", "@git.zone/tsbuild": "^2.3.2",
"@git.zone/tsrun": "^1.2.49", "@git.zone/tsrun": "^1.3.3",
"@git.zone/tstest": "^1.0.90", "@git.zone/tstest": "^1.0.96",
"@push.rocks/tapbundle": "^5.0.23", "@push.rocks/tapbundle": "^5.6.0",
"@types/node": "^20.14.8" "@types/node": "^22.13.11"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",

6514
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -34,7 +34,7 @@ The business domain includes classes for managing contacts, companies, and proje
```typescript ```typescript
import { business } from '@tsclass/tsclass'; import { business } from '@tsclass/tsclass';
const companyContact: business.IContact = { const companyContact: business.TContact = {
type: 'company', type: 'company',
name: 'Example Company', name: 'Example Company',
address: { address: {
@ -48,7 +48,7 @@ const companyContact: business.IContact = {
email: 'contact@example.com' email: 'contact@example.com'
}; };
const exampleCompany: business.ICompany = { const exampleCompany: business.TCompany = {
name: 'Example Company', name: 'Example Company',
foundedDate: { foundedDate: {
day: 1, day: 1,

View File

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

View File

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

View File

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

View File

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

View File

@ -5,4 +5,13 @@ export interface IAddress {
postalCode: string; postalCode: string;
city: string; city: string;
country: 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;
};
} }

View File

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

View File

@ -1,38 +1,60 @@
import { finance } from '../index.js'; import { finance, general } from "../index.js";
import { business } 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'; type TContactEnvelope<TYPE extends string, FIELDS> = {
type: TYPE;
export interface IContact {
// =======
// general
// =======
salutation?: TContactSalutation;
type: TContactType;
title?: TContactTitle;
name: string; name: string;
surname?: string;
legalEntity?: string;
address: business.IAddress; address: business.IAddress;
description: string; description: string;
legalEntity?: string;
customerNumber?: string; customerNumber?: string;
relationship?: "customer" | "supplier" | "partner" | "employee" | "other";
email?: string; email?: string;
logoUrl?: string;
website?: string;
facebookUrl?: string;
twitterUrl?: string;
phone?: string; phone?: string;
fax?: string; fax?: string;
// ========= logoUrl?: string;
// financial website?: string;
// =========
vatId?: string; socials?: TSocialLinks[];
sepaConnection?: finance.ISepaConnection; 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;
};
}
>;
export type TCompany = TContactEnvelope<
"company",
{
registrationDetails: TRegistrationDetails;
foundedDate: general.IDate;
closedDate: general.IDate;
status: "planned" | "founding" | "active" | "liquidation" | "closed";
}
>;
export type TContact = TPerson | TCompany;

View File

@ -1,20 +1,157 @@
import * as database from '../database/index.js'; import * as database from "../database/index.js";
import { type IPerson } from './person.js'; import { business } from "../index.js";
export interface IContract { /**
parties: { * Represents a paragraph or section in a contract.
signingOrder: number; */
referencedAs: string; export type TContractParagraph = {
person: IPerson; id: string;
role: 'signer' | 'cc'; title?: string;
signature: { content: string; // Markdown formatted text
given: boolean; order: number;
timestamp?: 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; location?: string;
ip?: string; probationPeriod?: {
verifications?: []; 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;

107
ts/business/document.ts Normal file
View File

@ -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;

View File

@ -1,8 +1,7 @@
export * from './address.js'; export * from './address.js';
export * from './company.js';
export * from './contact.js'; export * from './contact.js';
export * from './document.js';
export * from './job.js'; export * from './job.js';
export * from './letter.js'; export * from './letter.js';
export * from './pdf.js'; export * from './pdf.js';
export * from './person.js';
export * from './project.js'; export * from './project.js';

View File

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

View File

@ -1,35 +1,65 @@
import * as business from './index.js'; import * as business from "./index.js";
import * as finance from '../finance/index.js'; import * as finance from "../finance/index.js";
import * as database from '../database/index.js';
export interface ILetter { /**
versionInfo: { * Letter-specific envelope extending the base document type
type: 'draft' | 'final'; */
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;
};
incidenceId: string; /**
type: 'invoice' | 'notice' | 'warning' | 'verification' | 'contract'; * The sender of the letter
date: number; */
from: business.IContact; from: business.TContact;
to: business.IContact;
legalContact: business.IContact; /**
logoUrl: string; * The recipient of the letter
subject: string; */
accentColor?: string; to: business.TContact;
needsCoverSheet: boolean;
content: { /**
textData: string[]; * The legal contact is the contact that is responsible for the letter
invoiceData?: finance.IInvoice; * this is often the same as the from contact, but not always
contractData?: { */
id: string; legalContact?: business.TContact;
contractDate: number;
/**
* 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; } & FIELDS
} >;
pdf?: business.IPdf;
pdfAttachments: business.IPdf[]; export type TLetterSimple = TLetterEnvelope<"simple", {}>;
language: string;
objectActions: database.IObjectAction[];
} export type TLetter = TLetterSimple;
// type: "invoice" | "notice" | "warning" | "verification" | "contract";
/* content: {
textData: string[];
invoiceData?: finance.IInvoice;
contractData?: {
id: string;
contractDate: number;
};
timesheetData: string;
}; */

View File

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

View File

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

View File

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

View File

@ -1,38 +1,62 @@
import { business, finance } from '../index.js'; import { business, finance } from '../index.js';
import type { TCurrency } from './currency.js';
export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded'; export type TInvoiceStatus = 'draft' | 'invoice' | 'paid' | 'refunded';
export interface IInvoiceItem { export type TInvoiceItem = {
position: number;
name: string; name: string;
articleNumber?: string; articleNumber?: string;
unitType: string; unitType: string;
unitQuantity: number; unitQuantity: number;
unitNetPrice: number; unitNetPrice: number;
vatPercentage: number; vatPercentage: number;
currency: 'EUR';
} }
export interface IInvoice { export type TInvoiceEnvelope<TYPE extends 'creditnote' | 'debitnote', FIELDS> = business.TLetterEnvelope<
id: string; 'invoice',
billedBy: business.IContact; {
billedTo: business.IContact; invoiceId: string;
status: TInvoiceStatus; status: TInvoiceStatus;
items: IInvoiceItem[]; type: TYPE;
periodOfPerformance?: { items: TInvoiceItem[];
from: number; periodOfPerformance?: {
to: number; from: number;
}; to: number;
deliveryDate?: number;
dueInDays: number;
reverseCharge: boolean;
printResult?: {
pdfBufferString: string;
totalNet: number;
totalGross: number;
vatGroups: {
percentage: number;
items: IInvoiceItem[];
}; };
}; deliveryDate?: number;
paymentOptions?: finance.IPaymentOptionInfo; 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 {}

View File

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

View File

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

View File

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

7
ts/website/link.ts Normal file
View File

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

6
ts/website/linkblock.ts Normal file
View File

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