Compare commits

...

21 Commits

Author SHA1 Message Date
bab1ffc4b4 1.4.0 2024-12-02 15:20:58 +01:00
8986ec2543 feat(translation): Add French and Italian translations for document interface 2024-12-02 15:20:57 +01:00
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
27 changed files with 788 additions and 545 deletions

View File

@ -1,5 +1,68 @@
# Changelog
## 2024-12-02 - 1.4.0 - feat(translation)
Add French and Italian translations for document interface
- Expanded translation support by adding French and Italian language translations
- Fixed duplicated text in German final page statement
- Improved Spanish translation of reverse VAT note and final page statement
## 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.

View File

@ -5,28 +5,30 @@
"githost": "code.foss.global",
"gitscope": "designestate/private",
"gitrepo": "dedocument-catalog",
"description": "A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.",
"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",
"license": "MIT",
"projectDomain": "design.estate",
"shortDescription": "undefined variable",
"keywords": [
"document generation",
"invoices",
"PDF creation",
"typescript",
"web components",
"custom elements",
"QR code",
"smart contracts",
"templating",
"invoice automation",
"business documentation",
"dynamic rendering",
"PDF creation",
"web components",
"Node.js",
"TypeScript",
"templating",
"modern web technologies",
"responsive design",
"modular development",
"lightweight",
"efficient",
"finance",
"business"
"QR code",
"modular architecture",
"automated workflows",
"localization",
"digital signatures",
"security",
"interactive documents"
]
}
},

View File

@ -1,8 +1,8 @@
{
"name": "@design.estate/dees-document",
"version": "1.0.100",
"version": "1.4.0",
"private": false,
"description": "A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.",
"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",
"typings": "dist_ts_web/index.d.ts",
"exports": {
@ -11,7 +11,7 @@
},
"scripts": {
"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",
"buildDocs": "tsdoc"
},
@ -25,9 +25,10 @@
"@push.rocks/smartfile": "^11.0.21",
"@push.rocks/smartjson": "^5.0.20",
"@push.rocks/smartpath": "^5.0.18",
"@push.rocks/smartpdf": "^3.1.7",
"@push.rocks/smartpdf": "^3.1.8",
"@push.rocks/smarttime": "^4.0.8",
"@tsclass/tsclass": "^4.1.2",
"@types/node": "^22.10.1",
"@types/qrcode": "^1.5.5",
"qrcode": "^1.5.4"
},
@ -65,20 +66,22 @@
"homepage": "https://gitlab.com/designestate/private/dedocument-catalog#readme",
"keywords": [
"document generation",
"invoices",
"PDF creation",
"typescript",
"web components",
"custom elements",
"QR code",
"smart contracts",
"templating",
"invoice automation",
"business documentation",
"dynamic rendering",
"PDF creation",
"web components",
"Node.js",
"TypeScript",
"templating",
"modern web technologies",
"responsive design",
"modular development",
"lightweight",
"efficient",
"finance",
"business"
"QR code",
"modular architecture",
"automated workflows",
"localization",
"digital signatures",
"security",
"interactive documents"
]
}

367
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,26 +1,33 @@
# @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 install `@design.estate/dees-document`, run the following command in your project directory:
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 will add `@design.estate/dees-document` to your project's dependencies and ensure it's installed into your `node_modules` folder.
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
The `@design.estate/dees-document` package is a comprehensive toolkit for creating various types of documents, such as invoices, with ease. It leverages modern ECMAScript (ES) modules and TypeScript for a type-safe, developer-friendly experience. Below, you'll find detailed examples covering how to utilize the package to its full potential.
### Setting Up the Document Service
Before diving into creating documents, you first need to set up the document service. This involves importing the necessary modules and initializing the service instance.
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.
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 = {
// Configuration options here
// Configure your options here
};
const pdfService = await PdfService.createAndStart(options);
@ -29,18 +36,16 @@ async function setupPdfService() {
}
```
In the example above, we import `PdfService` from the package and use its `createAndStart` method to initialize it with optional configuration settings. Replace `// Configuration options here` with any specific options your project may require.
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 Simple Invoice
After setting up the document service, you can proceed to create documents such as invoices. Here, we'll demonstrate how to create a basic invoice.
### Creating a Document Template
#### Define the Invoice Data Structure
First, define the basic structure of your invoice. This involves specifying details like the sender, recipient, items, and more.
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 invoiceData: ILetter = {
const invoiceTemplate: ILetter = {
from: {
name: "Your Company Name",
address: {
@ -88,41 +93,85 @@ const invoiceData: ILetter = {
};
```
In this structure, `invoiceData` outlines essential details for an invoice document, using the `ILetter` interface. It includes information about both the sender (`from`) and the recipient (`to`), as well as the invoiced items under `content.invoiceData.items`.
The `invoiceTemplate` object utilizes the `ILetter` interface which specifies the structure for invoice data, including sender and recipient details, itemization, and pricing.
#### Generate the Invoice PDF
With the invoice data ready, you can now generate the PDF using the `PdfService` instance.
### 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 can save the PDF to a file, send it over a network, etc.
// Here you could save the PDF to your filesystem, send it via email, etc.
}
```
The method `createPdfFromLetterObject` receives the invoice data and returns a `Buffer` containing the PDF. You can then save this PDF to the filesystem, send it over email, or perform any other required actions.
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.
#### Complete Example Integration
Combining everything, your complete script to set up the service, define invoice data, and generate a PDF invoice might look something like this:
### 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.'));
```
### Beyond Invoices
The `@design.estate/dees-document` package is not limited to invoices alone. It's designed to handle a wide range of document types. The modular architecture allows for the customizable construction of documents, enabling you to tailor the output to meet precise requirements.
This script encompasses initializing services and generating a PDF in a streamlined, efficient workflow.
For instance, you can create contracts, reports, and other document types using a similar approach—by defining the content structure and utilizing the PDF service to generate the document. The package's flexibility and extensibility make it an invaluable tool in any document generation workflow.
### Advanced Features
### Advanced Usage
For more advanced scenarios, such as custom styling, embedding images, and handling more complex document structures, refer to the package's documentation. It provides comprehensive details and examples to help you fully leverage the capabilities of `@design.estate/dees-document`.
`@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

View File

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

View File

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@design.estate/dees-document',
version: '1.0.100',
description: 'A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.'
version: '1.4.0',
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 paths from './paths.js';
import * as helpers from './helpers.js';
import type { IDocumentSettings} from '../ts/interfaces/index.js';
export interface IPdfServiceConstructorOptions {
@ -44,12 +44,15 @@ export class PdfService {
/**
* creates an letter
*/
public async createPdfFromLetterObject(letterDataArg: plugins.tsclass.business.ILetter) {
public async createPdfFromLetterObject(optionsArg: {
letterData: plugins.tsclass.business.ILetter,
documentSettings: IDocumentSettings
}) {
const html = `
<script type="module">
${await helpers.getBundleAsString()}
</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);
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 interfaces from '../interfaces/index.js';
const fromContact: tsclass.business.IContact = {
name: 'Awesome From Company',
type: 'company',
@ -59,19 +61,21 @@ export const demoLetter: tsclass.business.ILetter = {
deliveryDate: new Date().getTime(),
periodOfPerformance: null,
printResult: null,
currency: 'EUR',
notes: [],
type: 'debitnote',
items: [
{
name: 'Item with 19% VAT',
unitQuantity: 1,
unitQuantity: 2,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 19,
currency: 'EUR',
position: 0,
},
{
name: 'Item with 7% VAT',
unitQuantity: 1,
unitQuantity: 4,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 7,
@ -79,7 +83,7 @@ export const demoLetter: tsclass.business.ILetter = {
},
{
name: 'Item with 7% VAT',
unitQuantity: 1,
unitQuantity: 3,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 7,
@ -95,14 +99,14 @@ export const demoLetter: tsclass.business.ILetter = {
},
{
name: 'Item with 0% VAT',
unitQuantity: 1,
unitQuantity: 6,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 0,
position: 4,
},{
name: 'Item with 19% VAT',
unitQuantity: 1,
unitQuantity: 8,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 19,
@ -110,27 +114,27 @@ export const demoLetter: tsclass.business.ILetter = {
},
{
name: 'Item with 7% VAT',
unitQuantity: 1,
unitQuantity: 9,
unitNetPrice: 100,
unitType: 'hours',
vatPercentage: 7,
currency: 'EUR',
position: 6,
},
{
name: 'Item with 7% VAT',
unitQuantity: 1,
unitQuantity: 4,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 7,
currency: 'EUR',
position: 8,
},
{
name: 'Item with 21% VAT',
unitQuantity: 1,
unitQuantity: 3,
unitNetPrice: 230,
unitType: 'hours',
vatPercentage: 21,
currency: 'EUR',
position: 9,
},
{
name: 'Item with 0% VAT',
@ -138,7 +142,55 @@ export const demoLetter: tsclass.business.ILetter = {
unitNetPrice: 230,
unitType: 'hours',
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,
},
],
}
@ -158,3 +210,10 @@ export const demoLetter: tsclass.business.ILetter = {
pdfAttachments: null,
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 leftMargin = 90;
import * as translation from './translation.js';
export { translation };
export * from './demoletter.js';

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

@ -0,0 +1,124 @@
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: 'Dies ist die letzte Seite dieses Dokuments.',
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: 'El IVA se aplica por inversión del sujeto pasivo y debe ser pagado 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: 'Continúa en la página',
finalPageStatement: 'Esta es la última página de este documento.',
page: 'Página',
};
export const FR_translations: TTranslationImplementation = {
address: 'Adresse',
bankConnection: 'Coordonnées bancaires',
contactInfo: 'Informations de contact',
description: 'Description',
invoice: 'Facture',
itemPos: 'Position',
quantity: 'Quantité',
registrationInfo: 'Informations d\'enregistrement',
reverseVatNote: 'La TVA s\'applique selon le mécanisme d\'autoliquidation et est à payer par le client.',
totalNetPrice: 'Prix net total',
unitNetPrice: 'Prix unitaire net',
unitType: 'Type d\'unité',
yourCustomerId: 'Votre numéro de client :',
yourVatId: 'Votre numéro de TVA :',
continuesOnPage: 'Continue sur la page',
finalPageStatement: 'Ceci est la dernière page de ce document.',
page: 'Page',
};
export const IT_translations: TTranslationImplementation = {
address: 'Indirizzo',
bankConnection: 'Coordinate bancarie',
contactInfo: 'Informazioni di contatto',
description: 'Descrizione',
invoice: 'Fattura',
itemPos: 'Pos.',
quantity: 'Quantità',
registrationInfo: 'Informazioni di registrazione',
reverseVatNote: 'L\'IVA è applicata con inversione contabile ed è a carico del cliente.',
totalNetPrice: 'Prezzo netto totale',
unitNetPrice: 'Prezzo netto unitario',
unitType: 'Tipo di unità',
yourCustomerId: 'Il tuo numero cliente:',
yourVatId: 'Il tuo numero di partita IVA:',
continuesOnPage: 'Continua alla pagina',
finalPageStatement: 'Questa è l\'ultima pagina di questo documento.',
page: 'Pagina',
};
export const languageCodeMap = {
'DE': DE_translations,
'EN': EN_translations,
'ES': ES_translations,
'FR': FR_translations,
'IT': IT_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

@ -3,6 +3,6 @@
*/
export const commitinfo = {
name: '@design.estate/dees-document',
version: '1.0.100',
description: 'A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.'
version: '1.4.0',
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,
unsafeCSS,
render,
domtools,
} from '@design.estate/dees-element';
import * as domtools from '@design.estate/dees-domtools';
import * as plugins from '../plugins.js';
import * as shared from './shared/index.js';
import * as shared from '../../ts/shared/index.js';
import * as interfaces from '../../ts/interfaces/index.js';
declare global {
@ -46,6 +45,12 @@ export class DeContentInvoice extends DeesElement {
})
public letterData: plugins.tsclass.business.ILetter;
@property({
type: Object,
reflect: true,
})
public documentSettings: interfaces.IDocumentSettings;
constructor() {
super();
domtools.DomTools.setupDomTools();
@ -276,12 +281,12 @@ export class DeContentInvoice extends DeesElement {
</style>
<div>We hereby invoice products and services provided to you by Lossless GmbH:</div>
<div class="grid topLine dataHeader">
<div class="lineItem">Item Pos.</div>
<div class="lineItem">Description</div>
<div class="lineItem">Quantity</div>
<div class="lineItem">Unit Type</div>
<div class="lineItem">Unit Net Price</div>
<div class="lineItem">Total Net Price</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'itemPos', 'Item Pos.')}</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'description', 'Description')}</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'quantity', 'Quantity')}</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'unitType', 'Unit Type')}</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'unitNetPrice', 'Unit Net Price')}</div>
<div class="lineItem">${shared.translation.translate(this.documentSettings.languageCode, 'totalNetPrice', 'Total Net Price')}</div>
</div>
${(() => {
let counter = 1;
@ -292,9 +297,9 @@ export class DeContentInvoice extends DeesElement {
<div class="lineItem">${invoiceItem.name}</div>
<div class="lineItem">${invoiceItem.unitQuantity}</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">
${invoiceItem.unitQuantity * invoiceItem.unitNetPrice} ${invoiceItem.currency}
${invoiceItem.unitQuantity * invoiceItem.unitNetPrice} ${this.letterData?.content.invoiceData.currency}
</div>
</div>
`
@ -330,7 +335,7 @@ export class DeContentInvoice extends DeesElement {
${this.letterData?.content.invoiceData.reverseCharge
? html`
<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>
`
: ``}
@ -343,7 +348,7 @@ export class DeContentInvoice extends DeesElement {
IBAN: ${this.letterData?.from?.sepaConnection?.iban}<br />
BIC: ${this.letterData?.from?.sepaConnection?.bic}<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>
${this.letterData?.content?.contractData?.contractDate
? html`

View File

@ -1,4 +1,4 @@
import * as shared from './shared/index.js';
import * as shared from '../../ts/shared/index.js';
import { html } from '@design.estate/dees-element';
export const demoFunc = () => html`

View File

@ -11,13 +11,20 @@ import {
domtools,
} from '@design.estate/dees-element';
import * as interfaces from '../../ts/interfaces/index.js';
import * as plugins from '../plugins.js';
export const defaultDocumentSettings: interfaces.IDocumentSettings = {
enableTopDraftText: true,
enableDefaultHeader: true,
enableDefaultFooter: true,
};
import { DePage } from './page.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 {
@ -68,9 +75,17 @@ export class DeDocument extends DeesElement {
public letterData: plugins.tsclass.business.ILetter;
@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() {
super();
@ -112,26 +127,28 @@ export class DeDocument extends DeesElement {
this.registerGarbageFunction(() => {
resizeObserver.disconnect();
})
if (this.letterDataUrl) {
const response = await fetch(this.letterDataUrl);
this.letterData = await response.json();
}
this.renderDocument();
}
public latestRenderedLetterData: plugins.tsclass.business.ILetter = null;
public async renderDocument() {
const domtools = await this.domtoolsPromise;
const documentContainer = this.shadowRoot.querySelector('.documentContainer');
const documentBuildContainer = document.createElement('div');
document.body.appendChild(documentBuildContainer);
let pages: DePage[] = [];
let pageCounter = 0;
let complete = false;
const content: DeContentInvoice = document.createElement(
'dedocument-contentinvoice'
) as DeContentInvoice;
// lets append the content
const content: DeContentInvoice = new DeContentInvoice();
content.letterData = this.letterData;
content.documentSettings = this.documentSettings;
document.body.appendChild(content);
await domtools.convenience.smartdelay.delayFor(0);
let overallContentOffset: number = 0;
let currentContentOffset: number;
@ -142,17 +159,13 @@ export class DeDocument extends DeesElement {
const newPage = new DePage();
newPage.printMode = this.printMode;
newPage.letterData = this.letterData;
newPage.documentSettings = this.documentSettings;
pages.push(newPage);
newPage.pageNumber = pageCounter;
newPage.append(currentContent);
newPage.pageTotalNumber = pageCounter;
documentContainer.append(newPage);
// betweenPagesSpacer
if (!this.printMode) {
const betweenPagesSpacerDiv = document.createElement('div');
betweenPagesSpacerDiv.classList.add('betweenPagesSpacer');
documentContainer.append(betweenPagesSpacerDiv);
}
documentBuildContainer.append(newPage);
await currentContent.elementDomReady;
await currentContent.trimStartToOffset(overallContentOffset);
let newPageOverflows = await newPage.checkOverflow();
@ -171,15 +184,28 @@ export class DeDocument extends DeesElement {
console.log(currentContentOffset);
}
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) {
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.latestRenderedLetterData = this.letterData;
}
async updated(changedProperties: Map<string | number | symbol, unknown>): void {
async updated(changedProperties: Map<string | number | symbol, unknown>): Promise<void> {
super.updated(changedProperties);
const domtools = await this.domtoolsPromise;
const renderedDocIsUpToDate = domtools.convenience.smartjson.deepEqualObjects(this.letterData, this.latestRenderedLetterData);

View File

@ -8,4 +8,4 @@ export * from './pagefooter.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';
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';
declare global {

View File

@ -8,10 +8,14 @@ import {
css,
cssManager,
unsafeCSS,
domtools,
} 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 {
interface HTMLElementTagNameMap {
@ -23,10 +27,14 @@ declare global {
export class DePage extends DeesElement {
public static demo = () => html` <dedocument-page .format="${'a4'}"></dedocument-page> `;
@property()
@property({
type: Number,
})
viewWidth: number = null;
@property()
@property({
type: Number,
})
viewHeight: number = null;
@property({
@ -55,6 +63,12 @@ export class DePage extends DeesElement {
})
printMode = false;
@property({
type: Object,
reflect: true,
})
public documentSettings: interfaces.IDocumentSettings = defaultDocumentSettings;
constructor() {
super();
domtools.DomTools.setupDomTools();
@ -108,47 +122,62 @@ export class DePage extends DeesElement {
<div id="scaleWrapper">
<dedocument-pagecontainer .printMode=${this.printMode}>
${this.letterData
? html`
${this.documentSettings.enableDefaultHeader
? html`
<dedocument-pageheader
.letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}"
></dedocument-pageheader>
`
: ``}
${this.pageNumber === 1
? html`
<dedocument-letterheader
.pageNumber="${this.pageNumber}"
.letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageTotalNumber="${this.pageTotalNumber}"
></dedocument-letterheader>
`
: html``}
<dedocument-pagecontent
.letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}"
.letterData=${this.letterData}
><slot></slot
></dedocument-pagecontent>
${this.documentSettings.enableDefaultFooter
? html`
<dedocument-pagefooter
.letterData=${this.letterData}
.documentSettings=${this.documentSettings}
.pageNumber="${this.pageNumber}"
.pageTotalNumber="${this.pageTotalNumber}"
></dedocument-pagefooter>
`
: ``}
<div class="versionOverlay">
${this.letterData.versionInfo.type === 'draft'
? html`
${this.documentSettings.enableTopDraftText
? html`
<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}
</div>
`
: ``}
<div class="bigDraftText">DRAFT</div>
`
: html``}
</div>
`
: html`
<slot></slot>
`}
: html` <slot></slot> `}
</dedocument-pagecontainer>
</div>
`;

View File

@ -10,7 +10,7 @@ import {
} from '@design.estate/dees-element';
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 {
interface HTMLElementTagNameMap {

View File

@ -10,7 +10,7 @@ import {
} from '@design.estate/dees-element';
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';
declare global {

View File

@ -7,10 +7,12 @@ import {
css,
cssManager,
unsafeCSS,
domtools,
} 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';
declare global {
@ -30,6 +32,12 @@ export class DePageFooter extends DeesElement {
})
letterData: tsclass.business.ILetter;
@property({
type: Object,
reflect: true,
})
documentSettings: interfaces.IDocumentSettings;
@property({
type: Number
})
@ -96,26 +104,26 @@ export class DePageFooter extends DeesElement {
return html`
<div class="bottomstripe">
<div>
<strong>Address:</strong><br />
<strong>${shared.translation.translate(this.documentSettings.languageCode, 'address', 'Address')}:</strong><br />
${this.letterData.from.name}<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.country}
</div>
<div>
<strong>Registration Info:</strong><br />
<strong>${shared.translation.translate(this.documentSettings.languageCode, 'registrationInfo', 'Registration Info')}:</strong><br />
Amtsgericht Bremen<br />
<i>reg-#:</i> HRB 35230 HB<br />
<i>vat-id:</i> ${this.letterData.from.vatId}
</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>phone:</i> ${this.letterData.from.phone}<br />
<i>fax:</i> ${this.letterData.from.fax}
</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>institution:</i> ${this.letterData?.from?.sepaConnection?.institution}<br />
<i>iban:</i> ${this.letterData?.from?.sepaConnection?.iban}<br />

View File

@ -7,10 +7,12 @@ import {
css,
cssManager,
unsafeCSS,
domtools
} 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';
declare global {
@ -30,6 +32,12 @@ export class DePageHeader extends DeesElement {
})
public letterData: tsclass.business.ILetter = null;
@property({
type: Object,
reflect: true,
})
documentSettings: interfaces.IDocumentSettings;
@property({
type: Number,
})
@ -74,13 +82,17 @@ export class DePageHeader extends DeesElement {
color: #333;
font-size: 10px;
}
.topstripe img {
filter: invert(1);
.topstripe .logo {
position: absolute;
bottom: 10px;
height: 25px;
left: auto;
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 {
return html`
<div class="topstripe">
<img src="https://assetbroker.lossless.one/brandfiles/lossless/svg-minimal-bright.svg" />
<div class="logo">
No logo set!
</div>
</div>
<div class="topstripe2">${this.letterData?.from?.description || '[no letterData.from.description set]'}</div>
`;

View File

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

View File

@ -1,4 +1,5 @@
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';
@ -17,6 +18,8 @@ export class DeDocumentViewer extends DeesElement {
// INSTANCE
public letterData: plugins.tsclass.business.ILetter = null;
public documentSettings: interfaces.IDocumentSettings;
public static styles = [
cssManager.defaultStyles,
css`
@ -67,7 +70,7 @@ export class DeDocumentViewer extends DeesElement {
<div class="maincontainer">
<div class="viewport">
${this.letterData
? html` <dedocument-dedocument .letterData=${this.letterData}></dedocument-dedocument> `
? html` <dedocument-dedocument .letterData=${this.letterData} .documentSettings=${this.documentSettings}></dedocument-dedocument> `
: html``}
</div>
<div class="controls"></div>