@design.estate/dees-document 1.0.101 → 1.1.0

package/npmextra.json

@@ -5,7 +5,7 @@
       "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 versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.",
       "npmPackagename": "@designestate_private/dedocument-catalog",
       "license": "MIT",
       "projectDomain": "design.estate",
@@ -14,19 +14,20 @@
         "document generation",
         "invoices",
         "PDF creation",
-        "typescript",
+        "TypeScript",
         "web components",
-        "custom elements",
-        "QR code",
-        "smart contracts",
         "templating",
         "dynamic rendering",
         "responsive design",
-        "modular development",
-        "lightweight",
-        "efficient",
-        "finance",
-        "business"
+        "business documentation",
+        "automated workflows",
+        "modular architecture",
+        "smart contracts",
+        "javascript",
+        "QR code",
+        "custom elements",
+        "nodejs",
+        "data-driven"
       ]
     }
   },

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@design.estate/dees-document",
-  "version": "1.0.101",
+  "version": "1.1.0",
   "private": false,
-  "description": "A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.",
+  "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",
   "typings": "dist_ts_web/index.d.ts",
   "exports": {
@@ -19,7 +19,7 @@
     "@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/qrcode": "^1.5.5",
@@ -61,19 +61,20 @@
     "document generation",
     "invoices",
     "PDF creation",
-    "typescript",
+    "TypeScript",
     "web components",
-    "custom elements",
-    "QR code",
-    "smart contracts",
     "templating",
     "dynamic rendering",
     "responsive design",
-    "modular development",
-    "lightweight",
-    "efficient",
-    "finance",
-    "business"
+    "business documentation",
+    "automated workflows",
+    "modular architecture",
+    "smart contracts",
+    "javascript",
+    "QR code",
+    "custom elements",
+    "nodejs",
+    "data-driven"
   ],
   "scripts": {
     "test": "npm run build && tstest test/",

package/readme.md

@@ -1,26 +1,31 @@
 # @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 install `@design.estate/dees-document`, run the following command in your project directory:
+
+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 add `@design.estate/dees-document` to your project's dependencies and ensure it's installed into your `node_modules` folder.
+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
-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 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. 
+
+### 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 = {
-    // Configuration options here
+    // Add necessary configuration here
   };
   
   const pdfService = await PdfService.createAndStart(options);
@@ -29,100 +34,136 @@ 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.
+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"
+     },
+   };
+   ```
 
-### 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.
+   Here, `ILetter` interface details all components of an invoice including sender (`from`) and recipient (`to`) information, as well as the invoiced items.
 
-#### Define the Invoice Data Structure
-First, define the basic structure of your invoice. This involves specifying details like the sender, recipient, items, and more.
+2. **Generate the PDF**: Transform the invoice details into a PDF.
 
-```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"
-  },
-};
-```
+   ```typescript
+   async function generateInvoice(pdfService: PdfService, invoiceData: ILetter) {
+     const pdfBuffer = await pdfService.createPdfFromLetterObject(invoiceData);
+     console.log('Invoice PDF generated successfully.');
 
-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`.
+     // Save the PDF, send it via email, etc.
+   }
+   ```
 
-#### Generate the Invoice PDF
-With the invoice data ready, you can now generate the PDF using the `PdfService` instance.
+   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.
 
-```typescript
-async function generateInvoice(pdfService: PdfService, invoiceData: ILetter) {
-  const pdfBuffer = await pdfService.createPdfFromLetterObject(invoiceData);
-  console.log('Invoice PDF generated successfully.');
+3. **Integrate It All**: Here's how everything ties together into a complete script for generating an invoice:
 
-  // Here, you can save the PDF to a file, send it over a network, etc.
-}
-```
+   ```typescript
+   async function main() {
+     const pdfService = await setupPdfService();
+     await generateInvoice(pdfService, invoiceData);
+   }
 
-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.
+   main().then(() => console.log('Invoice generation process completed.'));
+   ```
 
-#### 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:
+   This script initiates the PDF service and generates the invoice PDF with the provided information.
 
-```typescript
-async function main() {
-  const pdfService = await setupPdfService();
-  await generateInvoice(pdfService, invoiceData);
-}
+### Advanced Document Features
 
-main().then(() => console.log('Invoice generation process completed.'));
-```
+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';
 
-### 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.
+   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.
 
-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.
+### Concluding Remarks
 
-### 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`.
+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
 

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@design.estate/dees-document',
-  version: '1.0.101',
-  description: 'A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.'
+  version: '1.1.0',
+  description: 'A versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.'
 }

package/ts/classes.pdfservice.ts

@@ -1,6 +1,7 @@
 import * as plugins from './plugins.js';
 import * as paths from './paths.js';
 import * as helpers from './helpers.js';
+import * as interfaces from '../ts/interfaces/index.js';
 
 export interface IPdfServiceConstructorOptions {
 
@@ -44,12 +45,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: interfaces.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);

package/ts/interfaces/document.ts

@@ -0,0 +1,5 @@
+export interface IDocumentSettings {
+  enableTopDraftText?: boolean;
+  enableDefaultHeader?: boolean;
+  enableDefaultFooter?: boolean;
+}

package/ts/interfaces/index.ts

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

package/ts/interfaces/translation.ts

@@ -0,0 +1,4 @@
+export interface IDeDocumentTranslations {
+  "invoice": string;
+  "quantity": string;
+}

package/ts_web/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@design.estate/dees-document',
-  version: '1.0.101',
-  description: 'A comprehensive solution for generating documents like invoices, integrating elements, templates, and services to streamline document creation.'
+  version: '1.1.0',
+  description: 'A versatile tool for dynamically generating and rendering business documents, such as invoices, using modern web technologies and elements.'
 }

package/ts_web/elements/contentinvoice.ts

@@ -12,14 +12,13 @@ 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';
 
 
+
 declare global {
   interface HTMLElementTagNameMap {
     '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 class="grid topLine dataHeader">
           <div class="lineItem">Item Pos.</div>
-          <div class="lineItem">Description</div>
-          <div class="lineItem">Quantity</div>
+          <div class="lineItem">${shared.translation.translate('DE', 'description', 'Description')}</div>
+          <div class="lineItem">${shared.translation.translate('DE', 'quantity', 'Quantity')}</div>
           <div class="lineItem">Unit Type</div>
           <div class="lineItem">Unit 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.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>
             `
@@ -343,7 +342,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`

package/ts_web/elements/document.ts

@@ -11,8 +11,15 @@ 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';
@@ -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,27 @@ 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;
     document.body.appendChild(content);
+
     await domtools.convenience.smartdelay.delayFor(0);
     let overallContentOffset: number = 0;
     let currentContentOffset: number;
@@ -146,13 +162,8 @@ export class DeDocument extends DeesElement {
       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 +182,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);