Compare commits

...

30 Commits

Author SHA1 Message Date
49c15a98e4 1.3.2 2024-12-02 15:05:07 +01:00
840de119ad fix(core): Minor updates and optimizations in the output PDF formatting process. 2024-12-02 15:05:07 +01:00
3919956c57 Merge remote-tracking branch 'origin/master' 2024-12-02 15:04:22 +01:00
de0ecfd7ae 1.3.1 2024-12-02 15:02:15 +01:00
d0d4671d41 fix(documentation): Updated project description and enhanced documentation in package.json and README 2024-12-02 15:02:14 +01:00
bc4f018b06 Merge pull request 'fix: use type import to avoid ts dependency in js files' (#1) from fix/use-type-import into master
Reviewed-on: #1
2024-12-02 13:37:59 +00:00
8f7677ab82 fix: use type import to avoid ts dependency in js files 2024-12-02 12:59:19 +00:00
406db92ac1 1.3.0 2024-12-02 12:46:28 +01:00
d59734fb7c feat(translation): Add multi-language support for document translations. 2024-12-02 12:46:28 +01:00
c8b102e798 1.2.0 2024-12-01 23:04:28 +01:00
4c9b2671a9 feat(core): Enhance document generation capabilities with improved modular structure and extended translation support. 2024-12-01 23:04:28 +01:00
ab2c1e21f2 1.1.0 2024-11-30 20:54:15 +01:00
af77fcbe0e feat(core): Enhanced document generation features and added translation capabilities 2024-11-30 20:54:15 +01:00
e6cd135920 1.0.103 2024-11-27 19:27:31 +01:00
7dd585553c fix(DeDocument): Fix rendering of documents by properly moving new pages back to the document container 2024-11-27 19:27:30 +01:00
561b391f03 1.0.102 2024-11-27 19:15:30 +01:00
a5ff39d306 fix(contentinvoice): Fixed currency display issues in invoice content rendering. 2024-11-27 19:15:29 +01:00
60e6d935d6 1.0.101 2024-11-27 12:21:35 +01:00
e547e38158 fix(shared): Fixed the demo letter item details by replacing with to correctly define the item position. 2024-11-27 12:21:35 +01:00
78e4fb23cf 1.0.100 2024-11-27 12:19:19 +01:00
ecc8396f4f fix(core): fix scaling greater than 1x, fix automatic document updates 2024-11-27 12:19:18 +01:00
efac2187f2 update documentation 2024-04-20 23:17:35 +02:00
12c1d92ec4 1.0.99 2024-02-16 19:18:21 +01:00
4769548dad fix(core): update 2024-02-16 19:18:20 +01:00
1ebfa25695 1.0.98 2024-01-15 13:02:31 +01:00
e519ba6ebe fix(core): update 2024-01-15 13:02:30 +01:00
5736f2b7d3 1.0.97 2023-11-26 16:59:05 +01:00
0d5dc9a82f fix(core): update 2023-11-26 16:59:04 +01:00
86366d86b9 1.0.96 2023-10-26 17:39:03 +02:00
855ce7c074 fix(core): update 2023-10-26 17:39:02 +02:00
28 changed files with 8879 additions and 4006 deletions

70
changelog.md Normal file
View File

@ -0,0 +1,70 @@
# Changelog
## 2024-12-02 - 1.3.2 - fix(core)
Minor updates and optimizations in the output PDF formatting process.
- Improved handling of page content overflow in PDF generation.
- Refined default document settings for consistent rendering.
## 2024-12-02 - 1.3.1 - fix(documentation)
Updated project description and enhanced documentation in package.json and README
- The package description in package.json was updated to include more features.
- Added more details about setting up and using the PdfService.
- Included comprehensive examples for initializing and generating PDFs.
- Expanded sections covering advanced features, modular components, interactive documents, and localization support.
## 2024-12-02 - 1.3.0 - feat(translation)
Add multi-language support for document translations.
- Implemented translation interface for document labels.
- Added Spanish translations alongside existing English and German.
- Updated content invoice, page header, and page footer elements to utilize language-specific translations.
## 2024-12-01 - 1.2.0 - feat(core)
Enhance document generation capabilities with improved modular structure and extended translation support.
- Enhanced document generation framework with a more modular structure.
- Integrated support for translations using JSON-based language maps.
- Optimized PDF generation process for dynamic document content.
- Added properties in 'IDocumentSettings' for language code management.
- Updated README documentation with more comprehensive examples and guidance.
## 2024-11-30 - 1.1.0 - feat(core)
Enhanced document generation features and added translation capabilities
- Updated document rendering with advanced modular architecture.
- Introduced translation mechanism for document content.
- Improved PDF generation with dynamic settings support.
- Enhanced test cases for PDF generation with complex document structures.
## 2024-11-27 - 1.0.103 - fix(DeDocument)
Fix rendering of documents by properly moving new pages back to the document container
- Resolved an issue in the DeDocument component where new pages were wrongly managed, causing errors in the rendering of documents.
- Added a documentBuildContainer for temporary storage during page setup, ensuring correct page ordering.
## 2024-11-27 - 1.0.102 - fix(contentinvoice)
Fixed currency display issues in invoice content rendering.
- Corrected the usage of currency property to consistently pull from letterData content for invoice items.
- Ensured currency is correctly displayed in the invoice PDF generation.
## 2024-11-27 - 1.0.101 - fix(shared)
Fixed the demo letter item details by replacing `currency` with `position` to correctly define the item position.
- Replaced incorrect 'currency' field with 'position' in demoletter.ts for item details.
- Ensured item positions are correctly assigned in demoletter.ts.
## 2024-11-27 - 1.0.100 - fix(core)
Fix issues with PDF service, invoice item positioning, and update package dependencies.
- Updated package dependencies to latest versions for improved stability and performance.
- Fixed invoice item positioning in demo data.
- Ensured PDF service handles rendering updates more efficiently.
## 2024-04-20 to 2023-10-16 - 1.0.99 to 1.0.90 - Core Fixes and Documentation Update
Routine updates and fixes with a focus on core improvements and documentation enhancements.
- Regular core updates to enhance stability and performance
- Updated project documentation for better clarity and user guidance

View File

@ -2,19 +2,42 @@
"gitzone": { "gitzone": {
"projectType": "wcc", "projectType": "wcc",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "designestate/private", "gitscope": "designestate/private",
"gitrepo": "dedocument-catalog", "gitrepo": "dedocument-catalog",
"description": "a catalog for creating documents like invoices", "description": "A sophisticated framework for dynamically generating and rendering business documents like invoices with modern web technologies, featuring PDF creation, templating, and automation.",
"npmPackagename": "@designestate_private/dedocument-catalog", "npmPackagename": "@designestate_private/dedocument-catalog",
"license": "MIT", "license": "MIT",
"projectDomain": "design.estate", "projectDomain": "design.estate",
"shortDescription": "undefined variable" "shortDescription": "undefined variable",
"keywords": [
"document generation",
"invoice automation",
"business documentation",
"dynamic rendering",
"PDF creation",
"web components",
"Node.js",
"TypeScript",
"templating",
"modern web technologies",
"responsive design",
"QR code",
"modular architecture",
"automated workflows",
"localization",
"digital signatures",
"security",
"interactive documents"
]
} }
}, },
"npmci": { "npmci": {
"npmGlobalTools": [], "npmGlobalTools": [],
"npmAccessLevel": "private", "npmAccessLevel": "private",
"npmRegistryUrl": "verdaccio2.lossless.one" "npmRegistryUrl": "verdaccio2.lossless.one"
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis 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. \n\n**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.\n\n### Trademarks\n\nThis 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.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy 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.\n"
} }
} }

View File

@ -1,8 +1,8 @@
{ {
"name": "@design.estate/dees-document", "name": "@design.estate/dees-document",
"version": "1.0.95", "version": "1.3.2",
"private": false, "private": false,
"description": "a catalog for creating documents like invoices", "description": "A sophisticated framework for dynamically generating and rendering business documents like invoices with modern web technologies, featuring PDF creation, templating, and automation.",
"main": "dist_ts_web/index.js", "main": "dist_ts_web/index.js",
"typings": "dist_ts_web/index.d.ts", "typings": "dist_ts_web/index.d.ts",
"exports": { "exports": {
@ -11,33 +11,34 @@
}, },
"scripts": { "scripts": {
"test": "npm run build && tstest test/", "test": "npm run build && tstest test/",
"build": "tsbuild --allowimplicitany && tsbuild element --allowimplicitany && tsbundle element --production", "build": "tsbuild tsfolders --allowimplicitany && tsbuild element --allowimplicitany && tsbundle element --production",
"watch": "tswatch element", "watch": "tswatch element",
"buildDocs": "tsdoc" "buildDocs": "tsdoc"
}, },
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@design.estate/dees-domtools": "^2.0.34", "@design.estate/dees-domtools": "^2.0.65",
"@design.estate/dees-element": "^2.0.23", "@design.estate/dees-element": "^2.0.39",
"@design.estate/dees-wcctools": "^1.0.76", "@design.estate/dees-wcctools": "^1.0.90",
"@git.zone/tsrun": "^1.2.44", "@git.zone/tsrun": "^1.3.3",
"@push.rocks/smartfile": "^10.0.26", "@push.rocks/smartfile": "^11.0.21",
"@push.rocks/smartjson": "^5.0.10", "@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartpath": "^5.0.5", "@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartpdf": "^3.0.16", "@push.rocks/smartpdf": "^3.1.8",
"@push.rocks/smarttime": "^4.0.1", "@push.rocks/smarttime": "^4.0.8",
"@tsclass/tsclass": "^4.0.46", "@tsclass/tsclass": "^4.1.2",
"@types/qrcode": "^1.5.2", "@types/node": "^22.10.1",
"qrcode": "^1.5.3" "@types/qrcode": "^1.5.5",
"qrcode": "^1.5.4"
}, },
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.66", "@git.zone/tsbuild": "^2.2.0",
"@git.zone/tsbundle": "^2.0.8", "@git.zone/tsbundle": "^2.1.0",
"@git.zone/tstest": "^1.0.77", "@git.zone/tstest": "^1.0.90",
"@git.zone/tswatch": "^2.0.7", "@git.zone/tswatch": "^2.0.25",
"@push.rocks/projectinfo": "^5.0.1", "@push.rocks/projectinfo": "^5.0.2",
"@push.rocks/tapbundle": "^5.0.8" "@push.rocks/tapbundle": "^5.5.3"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -62,5 +63,25 @@
"bugs": { "bugs": {
"url": "https://gitlab.com/designestate/private/dedocument-catalog/issues" "url": "https://gitlab.com/designestate/private/dedocument-catalog/issues"
}, },
"homepage": "https://gitlab.com/designestate/private/dedocument-catalog#readme" "homepage": "https://gitlab.com/designestate/private/dedocument-catalog#readme",
"keywords": [
"document generation",
"invoice automation",
"business documentation",
"dynamic rendering",
"PDF creation",
"web components",
"Node.js",
"TypeScript",
"templating",
"modern web technologies",
"responsive design",
"QR code",
"modular architecture",
"automated workflows",
"localization",
"digital signatures",
"security",
"interactive documents"
]
} }

11593
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

194
readme.md
View File

@ -1,7 +1,193 @@
# @design.estate/private/dedocument-catalog # @design.estate/dees-document
a catalog for creating documents like invoices
A comprehensive tool for dynamically generating and rendering business documents like invoices using modern web technologies.
## Install
To incorporate `@design.estate/dees-document` into your project, execute the following command in your terminal:
```shell
npm install @design.estate/dees-document --save
```
This command will install the package and add it to your project's dependencies, thus making all the necessary modules available within your `node_modules` directory.
## Usage ## Usage
Use TypeScript for best in class intellisense The `@design.estate/dees-document` package serves as a robust framework to facilitate the generation of business documents, such as invoices, contracts, and reports. Leveraging modern web technologies, this package integrates seamlessly with TypeScript and ES modules, offering a type-safe environment conducive to efficient, dynamic document creation.
For further information read the linked docs at the top of this readme.
Below, we provide a detailed guide for utilizing this package, from initializing your environment to generating complete PDF documents.
### Setting Up the Environment
Before diving into document creation, ensure your environment is properly configured. Make sure to import necessary dependencies and setup configurations:
```typescript
import { PdfService, IPdfServiceConstructorOptions } from '@design.estate/dees-document';
async function setupPdfService() {
const options: IPdfServiceConstructorOptions = {
// Configure your options here
};
const pdfService = await PdfService.createAndStart(options);
console.log('PDF Service started successfully.');
return pdfService;
}
```
In this setup snippet, you set up the `PdfService` which is the core component for PDF generation. The configuration options should be adjusted to fit your needs, especially considering options such as file paths, languages, and template directories.
### Creating a Document Template
To create documents, particularly invoices, you'll first need to define a template. This template describes the structure of your document:
```typescript
import { ILetter } from '@design.estate/dees-document';
const invoiceTemplate: ILetter = {
from: {
name: "Your Company Name",
address: {
streetName: "Your Street",
houseNumber: "123",
city: "Your City",
country: "Your Country",
postalCode: "12345",
},
email: "your-email@example.com",
phone: "123-456-7890",
},
to: {
name: "Recipient Company Name",
address: {
streetName: "Recipient Street",
houseNumber: "456",
city: "Recipient City",
country: "Recipient Country",
postalCode: "67890",
},
email: "recipient-email@example.com",
phone: "098-765-4321",
},
content: {
invoiceData: {
items: [
{
name: "Service or Product Name",
unitQuantity: 2,
unitNetPrice: 100.00,
unitType: 'service',
vatPercentage: 19,
currency: 'EUR',
}
]
}
},
subject: "Invoice for Services Rendered",
date: new Date().getTime(),
versionInfo: {
type: "final",
version: "1.0.0"
},
};
```
The `invoiceTemplate` object utilizes the `ILetter` interface which specifies the structure for invoice data, including sender and recipient details, itemization, and pricing.
### Generating the Document
Once a template is established, the next step is generating a PDF:
```typescript
async function generateInvoice(pdfService: PdfService, invoiceData: ILetter) {
const pdfBuffer = await pdfService.createPdfFromLetterObject(invoiceData);
console.log('Invoice PDF generated successfully.');
// Here you could save the PDF to your filesystem, send it via email, etc.
}
```
In this function, the `createPdfFromLetterObject` method converts your invoice data into a `Buffer` containing the PDF. This `Buffer` can subsequently be saved as a file or sent over HTTP.
### Comprehensive Example
Below is an example integrating all previous steps into a single coherent script:
```typescript
async function main() {
const pdfService = await setupPdfService();
const invoiceData: ILetter = {
// Populate your invoice object
};
await generateInvoice(pdfService, invoiceData);
}
main().then(() => console.log('Invoice generation process completed.'));
```
This script encompasses initializing services and generating a PDF in a streamlined, efficient workflow.
### Advanced Features
`@design.estate/dees-document` provides several advanced functionalities, enabling rich document creation:
1. **Custom Templates & Styling**
- Customize the styling through CSS or using inline styles in TypeScript.
- Templates can be adjusted to present different document types (e.g., contracts, reports).
2. **Modular Components and Reuse**
- Utilize modular components to create reusable parts across different documents, enhancing maintainability and reducing redundancy.
3. **Interactive Documents**
- Integrate interactivities like forms, buttons, and interactive charts within your documents.
4. **Localization Support**
- Documents can be localized to support multiple languages, enhancing accessibility and usability.
5. **Responsive and Adaptive Designs**
- Create documents that adjust layout dynamically depending on print or digital medium, maintaining consistency across platforms.
6. **Security Features**
- Apply digital signatures and encrypt sensitive documents to ensure secure and authentic document distribution.
7. **Complex Business Logic**
- Implement complex logic for feature-rich documents such as inventory systems, automatic tax calculations, or real-time pricing adjustments.
### Utilize Translation for Localization
The package offers a translation mechanism to adapt your documents for international clients:
```typescript
import { translate } from '@design.estate/dees-document/shared';
const languageCode: 'DE' | 'EN' | 'ES' = 'EN'; // Set required language code
console.log(translate(languageCode, 'invoice', 'Invoice')); // Translated output
```
Different language settings can be applied, enabling the seamless presentation of document contents tailored to regional and linguistic preferences.
### Conclusion
The `@design.estate/dees-document` package is a versatile and powerful solution for businesses seeking to automate and streamline their document generation processes using modern web technologies. By integrating seamlessly with TypeScript, it offers robust capabilities for creating complex, customizable, and interactive documents that can meet a variety of business needs.
From custom templates to localization and advanced security features, this module provides the flexibility and power to create polished and professional documents efficiently. Whether you're generating invoices, contracts, or detailed reports, `@design.estate/dees-document` has the tools to support your enterprise workflows with ease and precision.
## 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.

View File

@ -1,5 +1,6 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as paths from './paths.js'; import * as paths from './paths.js';
import * as interfaces from '../ts/interfaces/index.js';
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@push.rocks/tapbundle';
import * as deesDocumentServer from '../ts/index.js'; import * as deesDocumentServer from '../ts/index.js';
@ -16,6 +17,9 @@ const testLetterData: plugins.tsclass.business.ILetter = {
id: 'XX-CLIENT-48765', id: 'XX-CLIENT-48765',
reverseCharge: true, reverseCharge: true,
dueInDays: 30, dueInDays: 30,
currency: 'EUR',
notes: [],
type: 'debitnote',
billedBy: { billedBy: {
address: null, address: null,
description: null, description: null,
@ -43,7 +47,7 @@ const testLetterData: plugins.tsclass.business.ILetter = {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 1,
}, },
], ],
}, },
@ -102,26 +106,38 @@ tap.test('should create a document from an invoice', async () => {
tap.test('should create an invoice', async () => { tap.test('should create an invoice', async () => {
let counter = 0; let counter = 0;
const saveResult = async (letterDataArg: plugins.tsclass.business.ILetter) => { const saveResult = async (optionsArg: {
const pdfResult = await testPdfServiceInstance.createPdfFromLetterObject(letterDataArg); letterData: plugins.tsclass.business.ILetter;
await plugins.smartfile.memory.toFs(Buffer.from(pdfResult.buffer), plugins.path.join(paths.nogitDir, `test-${counter++}.pdf`)); documentSettings: interfaces.IDocumentSettings;
} }) => {
await saveResult(testLetterData); const pdfResult = await testPdfServiceInstance.createPdfFromLetterObject(optionsArg);
await plugins.smartfile.memory.toFs(
Buffer.from(pdfResult.buffer),
plugins.path.join(paths.nogitDir, `test-${counter++}.pdf`)
);
};
await saveResult({ await saveResult({
letterData: testLetterData,
documentSettings: {},
});
await saveResult({
letterData: {
...testLetterData, ...testLetterData,
versionInfo: { versionInfo: {
type: 'draft', type: 'draft',
version: '1.0.0', version: '1.0.0',
} },
},
documentSettings: {},
}); });
testLetterData.content.invoiceData.items = [ (testLetterData.content.invoiceData.items = [
{ {
name: 'Website Creation', name: 'Website Creation',
unitQuantity: 1, unitQuantity: 1,
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 1,
}, },
{ {
name: 'Hosting', name: 'Hosting',
@ -129,7 +145,7 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 19, vatPercentage: 19,
currency: 'EUR', position: 2,
}, },
{ {
name: 'Overnight Shipping', name: 'Overnight Shipping',
@ -137,14 +153,15 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 24, vatPercentage: 24,
currency: 'EUR', position: 3,
},{ },
{
name: 'Website Creation', name: 'Website Creation',
unitQuantity: 1, unitQuantity: 1,
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 4,
}, },
{ {
name: 'Hosting', name: 'Hosting',
@ -152,7 +169,7 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 19, vatPercentage: 19,
currency: 'EUR', position: 5,
}, },
{ {
name: 'Overnight Shipping', name: 'Overnight Shipping',
@ -160,14 +177,15 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 24, vatPercentage: 24,
currency: 'EUR', position: 6,
},{ },
{
name: 'Website Creation', name: 'Website Creation',
unitQuantity: 1, unitQuantity: 1,
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 7,
}, },
{ {
name: 'Hosting', name: 'Hosting',
@ -175,7 +193,7 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 19, vatPercentage: 19,
currency: 'EUR', position: 8,
}, },
{ {
name: 'Overnight Shipping', name: 'Overnight Shipping',
@ -183,14 +201,15 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 24, vatPercentage: 24,
currency: 'EUR', position: 9,
},{ },
{
name: 'Website Creation', name: 'Website Creation',
unitQuantity: 1, unitQuantity: 1,
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 10,
}, },
{ {
name: 'Hosting', name: 'Hosting',
@ -198,7 +217,7 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 19, vatPercentage: 19,
currency: 'EUR', position: 11,
}, },
{ {
name: 'Overnight Shipping', name: 'Overnight Shipping',
@ -206,12 +225,13 @@ tap.test('should create an invoice', async () => {
unitNetPrice: 1200, unitNetPrice: 1200,
unitType: 'item', unitType: 'item',
vatPercentage: 24, vatPercentage: 24,
currency: 'EUR', position: 12,
}, },
], ]),
await saveResult({ await saveResult({
...testLetterData, letterData: testLetterData,
}) documentSettings: {},
});
}); });
tap.test('should stop the service', async () => { tap.test('should stop the service', async () => {

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@design.estate/dees-document', name: '@design.estate/dees-document',
version: '1.0.95', version: '1.3.2',
description: 'a catalog for creating documents like invoices' description: 'A sophisticated framework for dynamically generating and rendering business documents like invoices with modern web technologies, featuring PDF creation, templating, and automation.'
} }

View File

@ -1,6 +1,6 @@
import * as plugins from './plugins.js'; import * as plugins from './plugins.js';
import * as paths from './paths.js';
import * as helpers from './helpers.js'; import * as helpers from './helpers.js';
import type { IDocumentSettings} from '../ts/interfaces/index.js';
export interface IPdfServiceConstructorOptions { export interface IPdfServiceConstructorOptions {
@ -10,6 +10,13 @@ export interface IPdfServiceConstructorOptions {
* a pdf service for generating pdfs * a pdf service for generating pdfs
*/ */
export class PdfService { export class PdfService {
// STATIC
public static async createAndStart(optionsArg: IPdfServiceConstructorOptions) {
const pdfService = new PdfService(optionsArg);
await pdfService.start();
return pdfService;
}
// INSTANCE // INSTANCE
options: IPdfServiceConstructorOptions; options: IPdfServiceConstructorOptions;
@ -37,12 +44,15 @@ export class PdfService {
/** /**
* creates an letter * creates an letter
*/ */
public async createPdfFromLetterObject(letterDataArg: plugins.tsclass.business.ILetter) { public async createPdfFromLetterObject(optionsArg: {
letterData: plugins.tsclass.business.ILetter,
documentSettings: IDocumentSettings
}) {
const html = ` const html = `
<script type="module"> <script type="module">
${await helpers.getBundleAsString()} ${await helpers.getBundleAsString()}
</script> </script>
<dedocument-dedocument printMode letterData="${plugins.smartjson.stringifyBase64(letterDataArg)}"></dedocument-dedocument> <dedocument-dedocument printMode documentSettings="${plugins.smartjson.stringifyBase64(optionsArg.documentSettings)}" letterData="${plugins.smartjson.stringifyBase64(optionsArg.letterData)}"></dedocument-dedocument>
`; `;
// console.log(html); // console.log(html);
const pdfResult = await this.smartpdfInstance.getA4PdfResultForHtmlString(html); const pdfResult = await this.smartpdfInstance.getA4PdfResultForHtmlString(html);

View File

@ -0,0 +1,8 @@
import * as shared from '../shared/index.js';
export interface IDocumentSettings {
enableTopDraftText?: boolean;
enableDefaultHeader?: boolean;
enableDefaultFooter?: boolean;
languageCode?: shared.translation.TLanguageCode;
}

2
ts/interfaces/index.ts Normal file
View File

@ -0,0 +1,2 @@
export * from './document.js';
export * from './translation.js';

View File

@ -0,0 +1,19 @@
export interface IDeDocumentTranslations {
address: string;
bankConnection: string;
contactInfo: string;
description: string;
invoice: string;
itemPos: string;
quantity: string;
registrationInfo: string;
reverseVatNote: string;
totalNetPrice: string;
unitNetPrice: string;
unitType: string;
yourCustomerId: string;
yourVatId: string;
continuesOnPage: string;
finalPageStatement: string;
page: string;
}

View File

@ -1,4 +1,6 @@
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
import * as interfaces from '../interfaces/index.js';
const fromContact: tsclass.business.IContact = { const fromContact: tsclass.business.IContact = {
name: 'Awesome From Company', name: 'Awesome From Company',
type: 'company', type: 'company',
@ -59,31 +61,33 @@ export const demoLetter: tsclass.business.ILetter = {
deliveryDate: new Date().getTime(), deliveryDate: new Date().getTime(),
periodOfPerformance: null, periodOfPerformance: null,
printResult: null, printResult: null,
currency: 'EUR',
notes: [],
type: 'debitnote',
items: [ items: [
{ {
name: 'Item with 19% VAT', name: 'Item with 19% VAT',
unitQuantity: 1, unitQuantity: 2,
unitNetPrice: 100, unitNetPrice: 100,
unitType: 'hours', unitType: 'hours',
vatPercentage: 19, vatPercentage: 19,
currency: 'EUR', position: 0,
}, },
{ {
name: 'Item with 7% VAT', name: 'Item with 7% VAT',
unitQuantity: 1, unitQuantity: 4,
unitNetPrice: 100, unitNetPrice: 100,
unitType: 'hours', unitType: 'hours',
vatPercentage: 7, vatPercentage: 7,
currency: 'EUR', position: 1,
}, },
{ {
name: 'Item with 7% VAT', name: 'Item with 7% VAT',
unitQuantity: 1, unitQuantity: 3,
unitNetPrice: 230, unitNetPrice: 230,
unitType: 'hours', unitType: 'hours',
vatPercentage: 7, vatPercentage: 7,
currency: 'EUR', position: 2,
}, },
{ {
name: 'Item with 21% VAT', name: 'Item with 21% VAT',
@ -91,7 +95,46 @@ export const demoLetter: tsclass.business.ILetter = {
unitNetPrice: 230, unitNetPrice: 230,
unitType: 'hours', unitType: 'hours',
vatPercentage: 21, vatPercentage: 21,
currency: 'EUR', position: 3,
},
{
name: 'Item with 0% VAT',
unitQuantity: 6,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 4,
},{
name: 'Item with 19% VAT',
unitQuantity: 8,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 19,
position: 5,
},
{
name: 'Item with 7% VAT',
unitQuantity: 9,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 7,
position: 6,
},
{
name: 'Item with 7% VAT',
unitQuantity: 4,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 7,
position: 8,
},
{
name: 'Item with 21% VAT',
unitQuantity: 3,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 21,
position: 9,
}, },
{ {
name: 'Item with 0% VAT', name: 'Item with 0% VAT',
@ -99,7 +142,55 @@ export const demoLetter: tsclass.business.ILetter = {
unitNetPrice: 230, unitNetPrice: 230,
unitType: 'hours', unitType: 'hours',
vatPercentage: 0, vatPercentage: 0,
currency: 'EUR', position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 10,
}, },
], ],
} }
@ -119,3 +210,10 @@ export const demoLetter: tsclass.business.ILetter = {
pdfAttachments: null, pdfAttachments: null,
subject: 'Invoice: LL-INV-48765', subject: 'Invoice: LL-INV-48765',
} }
export const demoDocumentSettings: interfaces.IDocumentSettings = {
enableTopDraftText: true,
enableDefaultHeader: true,
enableDefaultFooter: true,
languageCode: 'DE',
};

View File

@ -3,4 +3,7 @@ export const a4Width = 794;
export const rightMargin = 70; export const rightMargin = 70;
export const leftMargin = 90; export const leftMargin = 90;
import * as translation from './translation.js';
export { translation };
export * from './demoletter.js'; export * from './demoletter.js';

82
ts/shared/translation.ts Normal file
View File

@ -0,0 +1,82 @@
import * as interfaces from '../interfaces/index.js';
type TTranslationImplementation = {
[key in keyof interfaces.IDeDocumentTranslations]: string;
}
export const EN_translations: TTranslationImplementation = {
address: 'Address',
bankConnection: 'Bank Connection',
contactInfo: 'Contact Info',
description: 'Description',
invoice: 'Invoice',
itemPos: 'Item Pos.',
quantity: 'Quantity',
registrationInfo: 'Registration Info',
reverseVatNote: 'VAT arises on a reverse charge basis and is payable by the customer.',
totalNetPrice: 'Total Net Price',
unitNetPrice: 'Unit Net Price',
unitType: 'Unit Type',
yourCustomerId: 'Your Customer ID:',
yourVatId: 'Your vat id on file:',
continuesOnPage: 'Continues on page',
finalPageStatement: 'This is the final page of this document.',
page: 'Page',
};
export const DE_translations: TTranslationImplementation = {
address: 'Adresse',
bankConnection: 'Bankverbindung',
contactInfo: 'Kontaktinformationen',
description: 'Beschreibung',
invoice: 'Rechnung',
itemPos: 'Pos.',
quantity: 'Anzahl',
registrationInfo: 'HRA/HRB Info',
reverseVatNote: 'Umkehr der Umsatzsteuerpflicht: Der Rechnungsempfänger ist für die korrekte Abrechnung der Umsatzsteuer zuständig.',
totalNetPrice: 'Nettopreis Summe',
unitNetPrice: 'Nettopreis',
unitType: 'Einheit',
yourCustomerId: 'Ihre Kundennummer:',
yourVatId: 'Ihre Umsatzsteuer-ID:',
continuesOnPage: 'Fortsetzung auf Seite',
finalPageStatement: 'Diese ist die letzte Seite einer Dokumente.',
page: 'Seite',
};
export const ES_translations: TTranslationImplementation = {
address: 'Dirección',
bankConnection: 'Conexión bancaria',
contactInfo: 'Información de contacto',
description: 'Descripción',
invoice: 'Factura',
itemPos: 'Pos.',
quantity: 'Cantidad',
registrationInfo: 'Información de registro',
reverseVatNote: 'La declaración de IVA se aplica en base a la factura de venta, y se paga por el cliente.',
totalNetPrice: 'Precio total neto',
unitNetPrice: 'Precio unitario neto',
unitType: 'Tipo de unidad',
yourCustomerId: 'Su número de cliente:',
yourVatId: 'Su ID de IVA:',
continuesOnPage: 'Continues on page',
finalPageStatement: 'This is the final page of this document.',
page: 'Page',
};
export const languageCodeMap = {
'DE': DE_translations,
'EN': EN_translations,
'ES': ES_translations,
};
export type TLanguageCode = keyof typeof languageCodeMap;
export const translate = (languageCode: TLanguageCode, key: string, defaultValue: string) => {
const translations = languageCodeMap[languageCode] || EN_translations;
if (translations && translations[key]) {
return translations[key];
} else {
return defaultValue;
}
};

View File

@ -1,8 +1,8 @@
/** /**
* autocreated commitinfo by @pushrocks/commitinfo * autocreated commitinfo by @push.rocks/commitinfo
*/ */
export const commitinfo = { export const commitinfo = {
name: '@design.estate/dees-document', name: '@design.estate/dees-document',
version: '1.0.95', version: '1.3.2',
description: 'a catalog for creating documents like invoices' description: 'A sophisticated framework for dynamically generating and rendering business documents like invoices with modern web technologies, featuring PDF creation, templating, and automation.'
} }

View File

@ -12,12 +12,11 @@ import {
cssManager, cssManager,
unsafeCSS, unsafeCSS,
render, render,
domtools,
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools';
import * as plugins from '../plugins.js'; import * as plugins from '../plugins.js';
import * as shared from '../../ts/shared/index.js';
import * as shared from './shared/index.js'; import * as interfaces from '../../ts/interfaces/index.js';
declare global { declare global {
@ -46,6 +45,12 @@ export class DeContentInvoice extends DeesElement {
}) })
public letterData: plugins.tsclass.business.ILetter; public letterData: plugins.tsclass.business.ILetter;
@property({
type: Object,
reflect: true,
})
public documentSettings: interfaces.IDocumentSettings;
constructor() { constructor() {
super(); super();
domtools.DomTools.setupDomTools(); domtools.DomTools.setupDomTools();
@ -276,12 +281,12 @@ export class DeContentInvoice extends DeesElement {
</style> </style>
<div>We hereby invoice products and services provided to you by Lossless GmbH:</div> <div>We hereby invoice products and services provided to you by Lossless GmbH:</div>
<div class="grid topLine dataHeader"> <div class="grid topLine dataHeader">
<div class="lineItem">Item Pos.</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'itemPos', 'Item Pos.')}</div>
<div class="lineItem">Description</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'description', 'Description')}</div>
<div class="lineItem">Quantity</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'quantity', 'Quantity')}</div>
<div class="lineItem">Unit Type</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'unitType', 'Unit Type')}</div>
<div class="lineItem">Unit Net Price</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'unitNetPrice', 'Unit Net Price')}</div>
<div class="lineItem">Total Net Price</div> <div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'totalNetPrice', 'Total Net Price')}</div>
</div> </div>
${(() => { ${(() => {
let counter = 1; let counter = 1;
@ -292,9 +297,9 @@ export class DeContentInvoice extends DeesElement {
<div class="lineItem">${invoiceItem.name}</div> <div class="lineItem">${invoiceItem.name}</div>
<div class="lineItem">${invoiceItem.unitQuantity}</div> <div class="lineItem">${invoiceItem.unitQuantity}</div>
<div class="lineItem">${invoiceItem.unitType}</div> <div class="lineItem">${invoiceItem.unitType}</div>
<div class="lineItem">${invoiceItem.unitNetPrice} ${invoiceItem.currency}</div> <div class="lineItem">${invoiceItem.unitNetPrice} ${this.letterData?.content.invoiceData.currency}</div>
<div class="lineItem"> <div class="lineItem">
${invoiceItem.unitQuantity * invoiceItem.unitNetPrice} ${invoiceItem.currency} ${invoiceItem.unitQuantity * invoiceItem.unitNetPrice} ${this.letterData?.content.invoiceData.currency}
</div> </div>
</div> </div>
` `
@ -330,7 +335,7 @@ export class DeContentInvoice extends DeesElement {
${this.letterData?.content.invoiceData.reverseCharge ${this.letterData?.content.invoiceData.reverseCharge
? html` ? html`
<div class="taxNote"> <div class="taxNote">
VAT arises on a reverse charge basis and is payable by the customer. ${shared.translation.translate(this.documentSettings.languageCode, 'reverseVatNote', 'VAT arises on a reverse charge basis and is payable by the customer.')}
</div> </div>
` `
: ``} : ``}
@ -343,7 +348,7 @@ export class DeContentInvoice extends DeesElement {
IBAN: ${this.letterData?.from?.sepaConnection?.iban}<br /> IBAN: ${this.letterData?.from?.sepaConnection?.iban}<br />
BIC: ${this.letterData?.from?.sepaConnection?.bic}<br /> BIC: ${this.letterData?.from?.sepaConnection?.bic}<br />
Description: ${this.letterData?.content.invoiceData?.id}<br /> Description: ${this.letterData?.content.invoiceData?.id}<br />
Amount: ${this.getTotalGross()} ${this.letterData?.content.invoiceData.items[0].currency} Amount: ${this.getTotalGross()} ${this.letterData?.content.invoiceData.currency}
</div> </div>
${this.letterData?.content?.contractData?.contractDate ${this.letterData?.content?.contractData?.contractDate
? html` ? html`

View File

@ -0,0 +1,6 @@
import * as shared from '../../ts/shared/index.js';
import { html } from '@design.estate/dees-element';
export const demoFunc = () => html`
<dedocument-dedocument .format="${'a4'}" .letterData=${shared.demoLetter}></dedocument-dedocument>
`;

View File

@ -11,13 +11,21 @@ import {
domtools, domtools,
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as interfaces from '../../ts/interfaces/index.js';
import * as plugins from '../plugins.js'; import * as plugins from '../plugins.js';
export const defaultDocumentSettings: interfaces.IDocumentSettings = {
enableTopDraftText: true,
enableDefaultHeader: true,
enableDefaultFooter: true,
};
import { DePage } from './page.js'; import { DePage } from './page.js';
import { DeContentInvoice } from './contentinvoice.js'; import { DeContentInvoice } from './contentinvoice.js';
import * as shared from './shared/index.js'; import * as shared from '../../ts/shared/index.js';
import { demoFunc } from './document.demo.js';
declare global { declare global {
interface HTMLElementTagNameMap { interface HTMLElementTagNameMap {
@ -27,27 +35,29 @@ declare global {
@customElement('dedocument-dedocument') @customElement('dedocument-dedocument')
export class DeDocument extends DeesElement { export class DeDocument extends DeesElement {
public static demo = () => html` public static demo = demoFunc;
<dedocument-dedocument .format="${'a4'}" .letterData=${shared.demoLetter}></dedocument-dedocument>
`;
@property({ @property({
type: String, type: String,
reflect: true,
}) })
public format: 'a4' = 'a4'; public format: 'a4' = 'a4';
@property({ @property({
type: Number, type: Number,
reflect: true,
}) })
public viewWidth: number = null; public viewWidth: number = null;
@property({ @property({
type: Number, type: Number,
reflect: true,
}) })
public viewHeight: number = null; public viewHeight: number = null;
@property({ @property({
type: Boolean, type: Boolean,
reflect: true,
}) })
printMode = false; printMode = false;
@ -61,14 +71,21 @@ export class DeDocument extends DeesElement {
return valueArg; return valueArg;
} }
}, },
}) })
public letterData: plugins.tsclass.business.ILetter; public letterData: plugins.tsclass.business.ILetter;
@property({ @property({
type: String, type: Object,
reflect: true,
converter: (valueArg) => {
if (typeof valueArg === 'string') {
return plugins.smartjson.parseBase64(valueArg)
} else {
return valueArg;
}
},
}) })
public letterDataUrl: string; public documentSettings: interfaces.IDocumentSettings = defaultDocumentSettings;
constructor() { constructor() {
super(); super();
@ -86,7 +103,7 @@ export class DeDocument extends DeesElement {
} }
.betweenPagesSpacer { .betweenPagesSpacer {
height: 20px; height: 16px;
} }
`, `,
]; ];
@ -107,24 +124,31 @@ export class DeDocument extends DeesElement {
} }
}); });
resizeObserver.observe(this); resizeObserver.observe(this);
if (this.letterDataUrl) { this.registerGarbageFunction(() => {
const response = await fetch(this.letterDataUrl); resizeObserver.disconnect();
this.letterData = await response.json(); })
}
this.renderDocument();
} }
public latestRenderedLetterData: plugins.tsclass.business.ILetter = null;
public async renderDocument() { public async renderDocument() {
const domtools = await this.domtoolsPromise; const domtools = await this.domtoolsPromise;
const documentContainer = this.shadowRoot.querySelector('.documentContainer');
const documentBuildContainer = document.createElement('div');
document.body.appendChild(documentBuildContainer);
let pages: DePage[] = []; let pages: DePage[] = [];
let pageCounter = 0; let pageCounter = 0;
let complete = false; let complete = false;
const content: DeContentInvoice = document.createElement(
'dedocument-contentinvoice' // lets append the content
) as DeContentInvoice; const content: DeContentInvoice = new DeContentInvoice();
content.letterData = this.letterData; content.letterData = this.letterData;
content.documentSettings = this.documentSettings;
document.body.appendChild(content); document.body.appendChild(content);
await domtools.convenience.smartdelay.delayFor(0); await domtools.convenience.smartdelay.delayFor(0);
let overallContentOffset: number = 0; let overallContentOffset: number = 0;
let currentContentOffset: number; let currentContentOffset: number;
@ -135,17 +159,13 @@ export class DeDocument extends DeesElement {
const newPage = new DePage(); const newPage = new DePage();
newPage.printMode = this.printMode; newPage.printMode = this.printMode;
newPage.letterData = this.letterData; newPage.letterData = this.letterData;
newPage.documentSettings = this.documentSettings;
pages.push(newPage); pages.push(newPage);
newPage.pageNumber = pageCounter; newPage.pageNumber = pageCounter;
newPage.append(currentContent); newPage.append(currentContent);
newPage.pageTotalNumber = pageCounter; newPage.pageTotalNumber = pageCounter;
documentContainer.append(newPage); documentBuildContainer.append(newPage);
// betweenPagesSpacer
if (!this.printMode) {
const betweenPagesSpacerDiv = document.createElement('div');
betweenPagesSpacerDiv.classList.add('betweenPagesSpacer');
documentContainer.append(betweenPagesSpacerDiv);
}
await currentContent.elementDomReady; await currentContent.elementDomReady;
await currentContent.trimStartToOffset(overallContentOffset); await currentContent.trimStartToOffset(overallContentOffset);
let newPageOverflows = await newPage.checkOverflow(); let newPageOverflows = await newPage.checkOverflow();
@ -164,15 +184,34 @@ export class DeDocument extends DeesElement {
console.log(currentContentOffset); console.log(currentContentOffset);
} }
document.body.removeChild(content); document.body.removeChild(content);
document.body.removeChild(documentBuildContainer);
const documentContainer = this.shadowRoot.querySelector('.documentContainer');
if (documentContainer) {
const children = Array.from(documentContainer.children);
children.forEach((child) => documentContainer.removeChild(child));
}
for (const page of pages) { for (const page of pages) {
page.pageTotalNumber = pageCounter; page.pageTotalNumber = pageCounter;
documentContainer.append(page);
// betweenPagesSpacer
if (!this.printMode) {
const betweenPagesSpacerDiv = document.createElement('div');
betweenPagesSpacerDiv.classList.add('betweenPagesSpacer');
documentContainer.appendChild(betweenPagesSpacerDiv);
}
} }
this.adjustDePageScaling(); this.adjustDePageScaling();
this.latestRenderedLetterData = this.letterData;
} }
updated(changedProperties: Map<string | number | symbol, unknown>): void { async updated(changedProperties: Map<string | number | symbol, unknown>): Promise<void> {
super.updated(changedProperties); super.updated(changedProperties);
const domtools = await this.domtoolsPromise;
const renderedDocIsUpToDate = domtools.convenience.smartjson.deepEqualObjects(this.letterData, this.latestRenderedLetterData);
if (!renderedDocIsUpToDate) {
this.renderDocument();
}
if (changedProperties.has('viewHeight') || changedProperties.has('viewWidth')) { if (changedProperties.has('viewHeight') || changedProperties.has('viewWidth')) {
this.adjustDePageScaling(); this.adjustDePageScaling();

View File

@ -6,5 +6,6 @@ export * from './pagecontainer.js';
export * from './pagecontent.js'; export * from './pagecontent.js';
export * from './pagefooter.js'; export * from './pagefooter.js';
export * from './pageheader.js'; export * from './pageheader.js';
export * from './viewer.js';
export * from './shared/index.js'; export * from '../../ts/shared/index.js';

View File

@ -10,7 +10,7 @@ import {
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools'; import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as shared from '../../ts/shared/index.js';
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
declare global { declare global {

View File

@ -8,10 +8,14 @@ import {
css, css,
cssManager, cssManager,
unsafeCSS, unsafeCSS,
domtools,
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as interfaces from '../../ts/interfaces/index.js';
import { defaultDocumentSettings } from './document.js';
import * as shared from '../../ts/shared/index.js';
declare global { declare global {
interface HTMLElementTagNameMap { interface HTMLElementTagNameMap {
@ -23,10 +27,14 @@ declare global {
export class DePage extends DeesElement { export class DePage extends DeesElement {
public static demo = () => html` <dedocument-page .format="${'a4'}"></dedocument-page> `; public static demo = () => html` <dedocument-page .format="${'a4'}"></dedocument-page> `;
@property() @property({
type: Number,
})
viewWidth: number = null; viewWidth: number = null;
@property() @property({
type: Number,
})
viewHeight: number = null; viewHeight: number = null;
@property({ @property({
@ -47,7 +55,7 @@ export class DePage extends DeesElement {
@property({ @property({
type: Object, type: Object,
}) })
public letterData: tsclass.business.ILetter = shared.demoLetter; public letterData: tsclass.business.ILetter = null;
@property({ @property({
type: Boolean, type: Boolean,
@ -55,6 +63,12 @@ export class DePage extends DeesElement {
}) })
printMode = false; printMode = false;
@property({
type: Object,
reflect: true,
})
public documentSettings: interfaces.IDocumentSettings = defaultDocumentSettings;
constructor() { constructor() {
super(); super();
domtools.DomTools.setupDomTools(); domtools.DomTools.setupDomTools();
@ -64,6 +78,7 @@ export class DePage extends DeesElement {
domtools.elementBasic.staticStyles, domtools.elementBasic.staticStyles,
css` css`
:host { :host {
display: block;
} }
#scaleWrapper { #scaleWrapper {
@ -106,42 +121,63 @@ export class DePage extends DeesElement {
return html` return html`
<div id="scaleWrapper"> <div id="scaleWrapper">
<dedocument-pagecontainer .printMode=${this.printMode}> <dedocument-pagecontainer .printMode=${this.printMode}>
${this.letterData
? html`
${this.documentSettings.enableDefaultHeader
? html`
<dedocument-pageheader <dedocument-pageheader
.letterData=${this.letterData} .letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}" .pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}" .pageTotalNumber="${this.pageTotalNumber}"
></dedocument-pageheader> ></dedocument-pageheader>
`
: ``}
${this.pageNumber === 1 ${this.pageNumber === 1
? html` ? html`
<dedocument-letterheader <dedocument-letterheader
.pageNumber="${this.pageNumber}" .pageNumber="${this.pageNumber}"
.letterData=${this.letterData} .letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageTotalNumber="${this.pageTotalNumber}" .pageTotalNumber="${this.pageTotalNumber}"
></dedocument-letterheader> ></dedocument-letterheader>
` `
: html``} : html``}
<dedocument-pagecontent <dedocument-pagecontent
.letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}" .pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}" .pageTotalNumber="${this.pageTotalNumber}"
.letterData=${this.letterData}
><slot></slot ><slot></slot
></dedocument-pagecontent> ></dedocument-pagecontent>
${this.documentSettings.enableDefaultFooter
? html`
<dedocument-pagefooter <dedocument-pagefooter
.letterData=${this.letterData} .letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}" .pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}" .pageTotalNumber="${this.pageTotalNumber}"
></dedocument-pagefooter> ></dedocument-pagefooter>
`
: ``}
<div class="versionOverlay"> <div class="versionOverlay">
${this.letterData.versionInfo.type === 'draft' ${this.letterData.versionInfo.type === 'draft'
? html`
${this.documentSettings.enableTopDraftText
? html` ? html`
<div class="topInfo"> <div class="topInfo">
Please note: THIS IS A DRAFT ONLY. NO RIGHTS CAN BE DERIVED FROM THIS.<br /> Please note: THIS IS A DRAFT ONLY. NO RIGHTS CAN BE DERIVED FROM
THIS.<br />
-> Revision/Document version: ${this.letterData.versionInfo.version} -> Revision/Document version: ${this.letterData.versionInfo.version}
</div> </div>
`
: ``}
<div class="bigDraftText">DRAFT</div> <div class="bigDraftText">DRAFT</div>
` `
: html``} : html``}
</div> </div>
`
: html` <slot></slot> `}
</dedocument-pagecontainer> </dedocument-pagecontainer>
</div> </div>
`; `;
@ -155,14 +191,14 @@ export class DePage extends DeesElement {
updated(changedProperties: Map<string | number | symbol, unknown>): void { updated(changedProperties: Map<string | number | symbol, unknown>): void {
super.updated(changedProperties); super.updated(changedProperties);
if (changedProperties.has("viewHeight") || changedProperties.has("viewWidth")) { if (changedProperties.has('viewHeight') || changedProperties.has('viewWidth')) {
this.adjustScaling(); this.adjustScaling();
} }
} }
private adjustScaling() { private adjustScaling() {
console.log('page scale adjustment triggered.') console.log('page scale adjustment triggered.');
const scaleWrapper: HTMLDivElement = this.shadowRoot.querySelector("#scaleWrapper"); const scaleWrapper: HTMLDivElement = this.shadowRoot.querySelector('#scaleWrapper');
if (!scaleWrapper) return; if (!scaleWrapper) return;
@ -177,7 +213,7 @@ export class DePage extends DeesElement {
// Adjust the outer dimensions so they match the scaled content // Adjust the outer dimensions so they match the scaled content
scaleWrapper.style.width = `${shared.a4Width * scale}px`; // this.style.width = `${shared.a4Width * scale}px`;
scaleWrapper.style.height = `${shared.a4Height * scale}px`; this.style.height = `${shared.a4Height * scale}px`;
} }
} }

View File

@ -10,7 +10,7 @@ import {
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools'; import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as shared from '../../ts/shared/index.js';
declare global { declare global {
interface HTMLElementTagNameMap { interface HTMLElementTagNameMap {

View File

@ -10,7 +10,7 @@ import {
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools'; import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as shared from '../../ts/shared/index.js';
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
declare global { declare global {

View File

@ -7,10 +7,12 @@ import {
css, css,
cssManager, cssManager,
unsafeCSS, unsafeCSS,
domtools,
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as interfaces from '../../ts/interfaces/index.js';
import * as shared from '../../ts/shared/index.js';
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
declare global { declare global {
@ -30,6 +32,12 @@ export class DePageFooter extends DeesElement {
}) })
letterData: tsclass.business.ILetter; letterData: tsclass.business.ILetter;
@property({
type: Object,
reflect: true,
})
documentSettings: interfaces.IDocumentSettings;
@property({ @property({
type: Number type: Number
}) })
@ -96,26 +104,26 @@ export class DePageFooter extends DeesElement {
return html` return html`
<div class="bottomstripe"> <div class="bottomstripe">
<div> <div>
<strong>Address:</strong><br /> <strong>${shared.translation.translate(this.documentSettings.languageCode, 'address', 'Address')}:</strong><br />
${this.letterData.from.name}<br /> ${this.letterData.from.name}<br />
${this.letterData.from.address.streetName} ${this.letterData.from.address.houseNumber}<br /> ${this.letterData.from.address.streetName} ${this.letterData.from.address.houseNumber}<br />
${this.letterData.from.address.postalCode} ${this.letterData.from.address.city}<br /> ${this.letterData.from.address.postalCode} ${this.letterData.from.address.city}<br />
${this.letterData.from.address.country} ${this.letterData.from.address.country}
</div> </div>
<div> <div>
<strong>Registration Info:</strong><br /> <strong>${shared.translation.translate(this.documentSettings.languageCode, 'registrationInfo', 'Registration Info')}:</strong><br />
Amtsgericht Bremen<br /> Amtsgericht Bremen<br />
<i>reg-#:</i> HRB 35230 HB<br /> <i>reg-#:</i> HRB 35230 HB<br />
<i>vat-id:</i> ${this.letterData.from.vatId} <i>vat-id:</i> ${this.letterData.from.vatId}
</div> </div>
<div> <div>
<strong>Contact Info:</strong><br /> <strong>${shared.translation.translate(this.documentSettings.languageCode, 'contactInfo', 'Contact Info')}:</strong><br />
<i>email:</i> ${this.letterData.from.email}<br /> <i>email:</i> ${this.letterData.from.email}<br />
<i>phone:</i> ${this.letterData.from.phone}<br /> <i>phone:</i> ${this.letterData.from.phone}<br />
<i>fax:</i> ${this.letterData.from.fax} <i>fax:</i> ${this.letterData.from.fax}
</div> </div>
<div> <div>
<strong>Bank Connection:</strong><br /> <strong>${shared.translation.translate(this.documentSettings.languageCode, 'bankConnection', 'Bank Connection')}:</strong><br />
<i>beneficiary:</i> ${this.letterData?.from?.name}<br /> <i>beneficiary:</i> ${this.letterData?.from?.name}<br />
<i>institution:</i> ${this.letterData?.from?.sepaConnection?.institution}<br /> <i>institution:</i> ${this.letterData?.from?.sepaConnection?.institution}<br />
<i>iban:</i> ${this.letterData?.from?.sepaConnection?.iban}<br /> <i>iban:</i> ${this.letterData?.from?.sepaConnection?.iban}<br />

View File

@ -7,10 +7,12 @@ import {
css, css,
cssManager, cssManager,
unsafeCSS, unsafeCSS,
domtools
} from '@design.estate/dees-element'; } from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools';
import * as shared from './shared/index.js'; import * as interfaces from '../../ts/interfaces/index.js';
import * as shared from '../../ts/shared/index.js';
import * as tsclass from '@tsclass/tsclass'; import * as tsclass from '@tsclass/tsclass';
declare global { declare global {
@ -30,6 +32,12 @@ export class DePageHeader extends DeesElement {
}) })
public letterData: tsclass.business.ILetter = null; public letterData: tsclass.business.ILetter = null;
@property({
type: Object,
reflect: true,
})
documentSettings: interfaces.IDocumentSettings;
@property({ @property({
type: Number, type: Number,
}) })
@ -74,13 +82,17 @@ export class DePageHeader extends DeesElement {
color: #333; color: #333;
font-size: 10px; font-size: 10px;
} }
.topstripe img { .topstripe .logo {
filter: invert(1);
position: absolute; position: absolute;
bottom: 10px; bottom: 10px;
height: 25px; height: 25px;
left: auto; left: auto;
right: ${unsafeCSS(shared.rightMargin + 'px')}; right: ${unsafeCSS(shared.rightMargin + 'px')};
font-family: 'Courier New', Courier, monospace;
}
.topstripe .logo img {
position: relative;
height: 25px;
} }
`, `,
]; ];
@ -88,7 +100,9 @@ export class DePageHeader extends DeesElement {
public render(): TemplateResult { public render(): TemplateResult {
return html` return html`
<div class="topstripe"> <div class="topstripe">
<img src="https://assetbroker.lossless.one/brandfiles/lossless/svg-minimal-bright.svg" /> <div class="logo">
No logo set!
</div>
</div> </div>
<div class="topstripe2">${this.letterData?.from?.description || '[no letterData.from.description set]'}</div> <div class="topstripe2">${this.letterData?.from?.description || '[no letterData.from.description set]'}</div>
`; `;

View File

@ -0,0 +1,6 @@
import { html } from '@design.estate/dees-element';
import * as shared from '../../ts/shared/index.js';
export const demoFunc = () => html`
<dedocument-viewer .letterData=${shared.demoLetter} .documentSettings=${shared.demoDocumentSettings}></dedocument-viewer>
`;

86
ts_web/elements/viewer.ts Normal file
View File

@ -0,0 +1,86 @@
import * as plugins from '../plugins.js';
import * as interfaces from '../../ts/interfaces/index.js';
import { DeesElement, css, cssManager, customElement, html } from '@design.estate/dees-element';
import { demoFunc } from './viewer.demo.js';
declare global {
interface HTMLElementTagNameMap {
'dedocument-viewer': DeDocumentViewer;
}
}
@customElement('dedocument-viewer')
export class DeDocumentViewer extends DeesElement {
// DEMO
public static demo = demoFunc;
// INSTANCE
public letterData: plugins.tsclass.business.ILetter = null;
public documentSettings: interfaces.IDocumentSettings;
public static styles = [
cssManager.defaultStyles,
css`
.maincontainer {
position: relative;
height: 100%;
width: 100%;
background: ${cssManager.bdTheme('#eeeeeb', '#111')};
}
.controls {
top: 0px;
right: 0px;
left: 0px;
position: absolute;
height: 32px;
width: 100%;
background: ${cssManager.bdTheme('#eeeeeb', '#111111ee')};
box-shadow: 0px 2px 8px 0px #000000;
}
.controlsShadow {
position: absolute;
top: 32px;
right: 0px;
left: 0px;
height: 16px;
width: 100%;
position: absolute;
background: linear-gradient(to bottom, #111111cc 0%, #11111100 100%);
}
.viewport {
position: absolute;
padding: 16px;
padding-top: 48px;
padding-bottom: 0px;
top: 0px;
left: 0px;
right: 0px;
bottom: 0px;
overflow-y: scroll;
overscroll-behavior: contain;
}
`,
];
public render = () => {
return html`
<div class="maincontainer">
<div class="viewport">
${this.letterData
? html` <dedocument-dedocument .letterData=${this.letterData} .documentSettings=${this.documentSettings}></dedocument-dedocument> `
: html``}
</div>
<div class="controls"></div>
</div>
`;
};
public updated = (changedProperties: Map<string | number | symbol, unknown>) => {
super.updated(changedProperties);
if (changedProperties.has('letterData')) {
}
};
}