Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
ab2c1e21f2 | |||
af77fcbe0e | |||
e6cd135920 | |||
7dd585553c | |||
561b391f03 | |||
a5ff39d306 | |||
60e6d935d6 | |||
e547e38158 | |||
78e4fb23cf | |||
ecc8396f4f | |||
efac2187f2 | |||
12c1d92ec4 | |||
4769548dad | |||
1ebfa25695 | |||
e519ba6ebe |
40
changelog.md
Normal file
40
changelog.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 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
|
@ -2,19 +2,41 @@
|
|||||||
"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 versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.",
|
||||||
"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",
|
||||||
|
"invoices",
|
||||||
|
"PDF creation",
|
||||||
|
"TypeScript",
|
||||||
|
"web components",
|
||||||
|
"templating",
|
||||||
|
"dynamic rendering",
|
||||||
|
"responsive design",
|
||||||
|
"business documentation",
|
||||||
|
"automated workflows",
|
||||||
|
"modular architecture",
|
||||||
|
"smart contracts",
|
||||||
|
"javascript",
|
||||||
|
"QR code",
|
||||||
|
"custom elements",
|
||||||
|
"nodejs",
|
||||||
|
"data-driven"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"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"
|
||||||
}
|
}
|
||||||
}
|
}
|
61
package.json
61
package.json
@ -1,8 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "@design.estate/dees-document",
|
"name": "@design.estate/dees-document",
|
||||||
"version": "1.0.97",
|
"version": "1.1.0",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "a catalog for creating documents like invoices",
|
"description": "A versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.",
|
||||||
"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": {
|
||||||
@ -18,26 +18,26 @@
|
|||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@design.estate/dees-domtools": "^2.0.55",
|
"@design.estate/dees-domtools": "^2.0.65",
|
||||||
"@design.estate/dees-element": "^2.0.32",
|
"@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.6",
|
"@push.rocks/smarttime": "^4.0.8",
|
||||||
"@tsclass/tsclass": "^4.0.46",
|
"@tsclass/tsclass": "^4.1.2",
|
||||||
"@types/qrcode": "^1.5.4",
|
"@types/qrcode": "^1.5.5",
|
||||||
"qrcode": "^1.5.3"
|
"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 +62,24 @@
|
|||||||
"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",
|
||||||
|
"invoices",
|
||||||
|
"PDF creation",
|
||||||
|
"TypeScript",
|
||||||
|
"web components",
|
||||||
|
"templating",
|
||||||
|
"dynamic rendering",
|
||||||
|
"responsive design",
|
||||||
|
"business documentation",
|
||||||
|
"automated workflows",
|
||||||
|
"modular architecture",
|
||||||
|
"smart contracts",
|
||||||
|
"javascript",
|
||||||
|
"QR code",
|
||||||
|
"custom elements",
|
||||||
|
"nodejs",
|
||||||
|
"data-driven"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
11625
pnpm-lock.yaml
generated
11625
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
|
186
readme.md
186
readme.md
@ -1,7 +1,185 @@
|
|||||||
# @design.estate/private/dedocument-catalog
|
# @design.estate/dees-document
|
||||||
a catalog for creating documents like invoices
|
|
||||||
|
A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
To add `@design.estate/dees-document` to your project, run the following command in your terminal:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
npm install @design.estate/dees-document --save
|
||||||
|
```
|
||||||
|
|
||||||
|
This will install the package and add it to your project's dependencies, ensuring all required modules are available in your `node_modules` directory.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use TypeScript for best in class intellisense
|
The `@design.estate/dees-document` package provides a robust framework for creating documents including invoices, contracts, and various other business-related documents. It is built on modern web technologies including TypeScript and ES modules to ensure a type-safe and easy-to-integrate experience. Below, we will guide you through the comprehensive usage of this package, from setting up your environment to generating PDF documents.
|
||||||
For further information read the linked docs at the top of this readme.
|
|
||||||
|
### Getting Started
|
||||||
|
|
||||||
|
Before creating documents, initialize the document service which is central to this package. This is typically done at the beginning of your application.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { PdfService, IPdfServiceConstructorOptions } from '@design.estate/dees-document';
|
||||||
|
|
||||||
|
async function setupPdfService() {
|
||||||
|
const options: IPdfServiceConstructorOptions = {
|
||||||
|
// Add necessary configuration here
|
||||||
|
};
|
||||||
|
|
||||||
|
const pdfService = await PdfService.createAndStart(options);
|
||||||
|
console.log('PDF Service started successfully.');
|
||||||
|
return pdfService;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This script initializes `PdfService`. Modify the options to tailor the service to your needs.
|
||||||
|
|
||||||
|
### Creating Documents
|
||||||
|
|
||||||
|
With the PDF service ready, you can proceed to generate documents. The following section provides a detailed example of creating an invoice. This example is applicable to various document types with necessary adjustments.
|
||||||
|
|
||||||
|
#### Step-by-Step: Create an Invoice
|
||||||
|
|
||||||
|
1. **Define the Data Structure**: Describe the invoice details. This includes sender and recipient information, the items being invoiced, and more.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ILetter } from '@design.estate/dees-document';
|
||||||
|
|
||||||
|
const invoiceData: 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"
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, `ILetter` interface details all components of an invoice including sender (`from`) and recipient (`to`) information, as well as the invoiced items.
|
||||||
|
|
||||||
|
2. **Generate the PDF**: Transform the invoice details into a PDF.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async function generateInvoice(pdfService: PdfService, invoiceData: ILetter) {
|
||||||
|
const pdfBuffer = await pdfService.createPdfFromLetterObject(invoiceData);
|
||||||
|
console.log('Invoice PDF generated successfully.');
|
||||||
|
|
||||||
|
// Save the PDF, send it via email, etc.
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The function `createPdfFromLetterObject` returns a `Buffer` containing the generated PDF. From here, you can save this PDF to a file, send it to clients, or archive it.
|
||||||
|
|
||||||
|
3. **Integrate It All**: Here's how everything ties together into a complete script for generating an invoice:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
async function main() {
|
||||||
|
const pdfService = await setupPdfService();
|
||||||
|
await generateInvoice(pdfService, invoiceData);
|
||||||
|
}
|
||||||
|
|
||||||
|
main().then(() => console.log('Invoice generation process completed.'));
|
||||||
|
```
|
||||||
|
|
||||||
|
This script initiates the PDF service and generates the invoice PDF with the provided information.
|
||||||
|
|
||||||
|
### Advanced Document Features
|
||||||
|
|
||||||
|
The package is designed to create not only invoices but a wide range of document types. Leverage its modular architecture to build and customize documents to fit specific needs.
|
||||||
|
|
||||||
|
#### Advanced Scenarios
|
||||||
|
|
||||||
|
1. **Custom Styling**: Customize the appearance of elements within your documents, such as headers, footers, and more.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { DeDocumentViewer } from '@design.estate/dees-element';
|
||||||
|
|
||||||
|
const customStyledViewer = new DeDocumentViewer();
|
||||||
|
customStyledViewer.style.setProperty('--main-bg-color', 'lightblue');
|
||||||
|
document.body.appendChild(customStyledViewer);
|
||||||
|
```
|
||||||
|
|
||||||
|
Customize via CSS or dynamically through TypeScript where necessary.
|
||||||
|
|
||||||
|
2. **Interactive Document Elements**: Incorporate UI components like buttons, input fields, or visualizations tailored for your document needs.
|
||||||
|
|
||||||
|
3. **Multi-page Document Generation**: Handle overflow of content and automatic page generation while maintaining headers and footers.
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
pdfService.adjustDePageScaling();
|
||||||
|
```
|
||||||
|
|
||||||
|
Toggle between print and digital formats and handle scaling.
|
||||||
|
|
||||||
|
4. **Embedding Images and Logos**: Add company logos, graphics, or auxiliary content to enhance document presentation.
|
||||||
|
|
||||||
|
### Additional Capabilities
|
||||||
|
|
||||||
|
Beyond these examples, delve deeper into advanced functionalities such as:
|
||||||
|
|
||||||
|
- **Document Management**: Manage multiple document templates, manage versions, and add annotations or notes.
|
||||||
|
- **Dynamic Rendering**: Use templating for dynamic content rendering based on variable inputs.
|
||||||
|
- **Responsive Design for Digital Documents**: Ensure documents are displayed correctly across devices.
|
||||||
|
|
||||||
|
### Concluding Remarks
|
||||||
|
|
||||||
|
The `@design.estate/dees-document` package is an essential tool in the modern document generation ecosystem. Its expansive capabilities, from basic invoices to complex document templates, make it a versatile solution for businesses of all scales. Implementing this service broadly simplifies document management workflows and enhances document presentation precision and quality. For further depth, consult the package's documentation or explore the examples included in the module.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
72
test/test.ts
72
test/test.ts
@ -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 () => {
|
||||||
|
@ -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.97',
|
version: '1.1.0',
|
||||||
description: 'a catalog for creating documents like invoices'
|
description: 'A versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.'
|
||||||
}
|
}
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
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 helpers from './helpers.js';
|
import * as helpers from './helpers.js';
|
||||||
|
import * as interfaces from '../ts/interfaces/index.js';
|
||||||
|
|
||||||
export interface IPdfServiceConstructorOptions {
|
export interface IPdfServiceConstructorOptions {
|
||||||
|
|
||||||
@ -10,6 +11,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 +45,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: interfaces.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);
|
||||||
|
5
ts/interfaces/document.ts
Normal file
5
ts/interfaces/document.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
export interface IDocumentSettings {
|
||||||
|
enableTopDraftText?: boolean;
|
||||||
|
enableDefaultHeader?: boolean;
|
||||||
|
enableDefaultFooter?: boolean;
|
||||||
|
}
|
2
ts/interfaces/index.ts
Normal file
2
ts/interfaces/index.ts
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
export * from './document.js';
|
||||||
|
export * from './translation.js';
|
4
ts/interfaces/translation.ts
Normal file
4
ts/interfaces/translation.ts
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
export interface IDeDocumentTranslations {
|
||||||
|
"invoice": string;
|
||||||
|
"quantity": string;
|
||||||
|
}
|
@ -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.97',
|
version: '1.1.0',
|
||||||
description: 'a catalog for creating documents like invoices'
|
description: 'A versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.'
|
||||||
}
|
}
|
||||||
|
@ -12,14 +12,13 @@ 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 './shared/index.js';
|
import * as shared from './shared/index.js';
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
declare global {
|
declare global {
|
||||||
interface HTMLElementTagNameMap {
|
interface HTMLElementTagNameMap {
|
||||||
'dedocument-contentinvoice': DeContentInvoice;
|
'dedocument-contentinvoice': DeContentInvoice;
|
||||||
@ -277,8 +276,8 @@ export class DeContentInvoice extends DeesElement {
|
|||||||
<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">Item Pos.</div>
|
||||||
<div class="lineItem">Description</div>
|
<div class="lineItem">${shared.translation.translate('DE', 'description', 'Description')}</div>
|
||||||
<div class="lineItem">Quantity</div>
|
<div class="lineItem">${shared.translation.translate('DE', 'quantity', 'Quantity')}</div>
|
||||||
<div class="lineItem">Unit Type</div>
|
<div class="lineItem">Unit Type</div>
|
||||||
<div class="lineItem">Unit Net Price</div>
|
<div class="lineItem">Unit Net Price</div>
|
||||||
<div class="lineItem">Total Net Price</div>
|
<div class="lineItem">Total Net Price</div>
|
||||||
@ -292,9 +291,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>
|
||||||
`
|
`
|
||||||
@ -343,7 +342,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`
|
||||||
|
@ -11,8 +11,15 @@ 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';
|
||||||
@ -32,21 +39,25 @@ export class DeDocument extends DeesElement {
|
|||||||
|
|
||||||
@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;
|
||||||
|
|
||||||
@ -60,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();
|
||||||
@ -109,25 +127,27 @@ export class DeDocument extends DeesElement {
|
|||||||
this.registerGarbageFunction(() => {
|
this.registerGarbageFunction(() => {
|
||||||
resizeObserver.disconnect();
|
resizeObserver.disconnect();
|
||||||
})
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
public latestRenderedLetterData: plugins.tsclass.business.ILetter = null;
|
||||||
|
|
||||||
if (this.letterDataUrl) {
|
|
||||||
const response = await fetch(this.letterDataUrl);
|
|
||||||
this.letterData = await response.json();
|
|
||||||
}
|
|
||||||
this.renderDocument();
|
|
||||||
}
|
|
||||||
|
|
||||||
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;
|
||||||
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;
|
||||||
@ -142,13 +162,8 @@ export class DeDocument extends DeesElement {
|
|||||||
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();
|
||||||
@ -167,15 +182,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();
|
||||||
|
@ -8,8 +8,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 interfaces from '../../ts/interfaces/index.js';
|
||||||
|
|
||||||
|
import { defaultDocumentSettings } from './document.js';
|
||||||
|
|
||||||
import * as shared from './shared/index.js';
|
import * as shared from './shared/index.js';
|
||||||
|
|
||||||
@ -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({
|
||||||
@ -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();
|
||||||
@ -65,8 +79,6 @@ export class DePage extends DeesElement {
|
|||||||
css`
|
css`
|
||||||
:host {
|
:host {
|
||||||
display: block;
|
display: block;
|
||||||
max-height: ${shared.a4Height}px;
|
|
||||||
max-width: ${shared.a4Width}px;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#scaleWrapper {
|
#scaleWrapper {
|
||||||
@ -110,12 +122,16 @@ export class DePage extends DeesElement {
|
|||||||
<div id="scaleWrapper">
|
<div id="scaleWrapper">
|
||||||
<dedocument-pagecontainer .printMode=${this.printMode}>
|
<dedocument-pagecontainer .printMode=${this.printMode}>
|
||||||
${this.letterData
|
${this.letterData
|
||||||
|
? html`
|
||||||
|
${this.documentSettings.enableDefaultHeader
|
||||||
? html`
|
? html`
|
||||||
<dedocument-pageheader
|
<dedocument-pageheader
|
||||||
.letterData=${this.letterData}
|
.letterData=${this.letterData}
|
||||||
.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
|
||||||
@ -131,26 +147,33 @@ export class DePage extends DeesElement {
|
|||||||
.letterData=${this.letterData}
|
.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}
|
||||||
.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`
|
: html` <slot></slot> `}
|
||||||
<slot></slot>
|
|
||||||
`}
|
|
||||||
</dedocument-pagecontainer>
|
</dedocument-pagecontainer>
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
|
@ -74,13 +74,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 +92,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>
|
||||||
`;
|
`;
|
||||||
|
@ -59,31 +59,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 +93,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 +140,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,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
@ -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';
|
31
ts_web/elements/shared/translation.ts
Normal file
31
ts_web/elements/shared/translation.ts
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
import * as interfaces from '../../../ts/interfaces/index.js';
|
||||||
|
|
||||||
|
type TTranslationImplementation = {
|
||||||
|
[key in keyof interfaces.IDeDocumentTranslations]: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const EN_translations: TTranslationImplementation = {
|
||||||
|
invoice: 'Invoice',
|
||||||
|
quantity: 'Quantity',
|
||||||
|
};
|
||||||
|
|
||||||
|
export const DE_translations: TTranslationImplementation = {
|
||||||
|
invoice: 'Rechnung',
|
||||||
|
quantity: 'Anzahl',
|
||||||
|
};
|
||||||
|
|
||||||
|
export const languageCodeMap = {
|
||||||
|
'DE': DE_translations,
|
||||||
|
'EN': EN_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;
|
||||||
|
}
|
||||||
|
};
|
Reference in New Issue
Block a user