154 lines
4.7 KiB
Markdown
154 lines
4.7 KiB
Markdown
# @tsclass/tsclass
|
|
|
|
A comprehensive TypeScript library providing well-structured type definitions for various domains including business, finance, networking, content management, and more.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @tsclass/tsclass
|
|
```
|
|
|
|
## Overview
|
|
|
|
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.
|
|
|
|
## Type Structure
|
|
|
|
### Authentication
|
|
- **IClaim**: Authentication claims with user and role data
|
|
- **IProcessedClaim**: Processed JWT claims with verification status
|
|
|
|
### 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
|
|
|
|
### Finance
|
|
- **TCurrency**: Currency representation
|
|
- **TInvoiceEnvelope**: Invoice document structure
|
|
- **TInvoiceItem**: Line items for invoices
|
|
- **IPaymentOptionInfo**: Banking and payment method details
|
|
|
|
### Network
|
|
- **INetworkNode**: Network device representation
|
|
- **ICert**: Certificate management
|
|
- **IJWT**: JWT token structure
|
|
- **IDnsChallenge**: DNS verification challenges
|
|
|
|
### Container
|
|
- **IContainer**: Container configuration
|
|
- **IVolumeMount**: Volume mount specification
|
|
|
|
### Database
|
|
- **IMongoDescriptor**: MongoDB connection details
|
|
- **IObjectAction**: Document lifecycle tracking
|
|
|
|
### 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.TCompany = {
|
|
type: 'company',
|
|
name: 'Example Company',
|
|
address: {
|
|
streetName: 'Main St',
|
|
houseNumber: '123',
|
|
postalCode: '12345',
|
|
city: 'Example City',
|
|
country: 'Exland'
|
|
},
|
|
email: 'contact@example.com',
|
|
foundedDate: {
|
|
day: 1,
|
|
month: 1,
|
|
year: 2020
|
|
},
|
|
status: 'active'
|
|
};
|
|
```
|
|
|
|
### Invoice
|
|
|
|
```typescript
|
|
import { finance, business } from '@tsclass/tsclass';
|
|
|
|
const invoice: finance.TInvoiceEnvelope = {
|
|
id: 'INV-2023-001',
|
|
status: 'invoice',
|
|
issueDate: {
|
|
day: 15,
|
|
month: 3,
|
|
year: 2023
|
|
},
|
|
items: [
|
|
{
|
|
name: 'Consulting Services',
|
|
unitType: 'hour',
|
|
unitQuantity: 10,
|
|
unitNetPrice: 150,
|
|
vatPercentage: 20,
|
|
currency: 'EUR'
|
|
}
|
|
],
|
|
dueInDays: 30,
|
|
billedBy: { /* company details */ },
|
|
billedTo: { /* client details */ }
|
|
};
|
|
```
|
|
|
|
### Network Certificate
|
|
|
|
```typescript
|
|
import { network } from '@tsclass/tsclass';
|
|
|
|
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...'
|
|
};
|
|
```
|
|
|
|
## 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.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH
|
|
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. |