From 83f51dc11b70b3f5e33cf89223d3ff26117f107e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 4 Jul 2025 14:52:28 +0000 Subject: [PATCH 1/4] Initial plan From b3ceaf096e6d80fd76dead9f4df7388e0e913012 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 4 Jul 2025 14:57:56 +0000 Subject: [PATCH 2/4] Enhance Handlebars example with multi-file templates and comprehensive HTML structure Co-authored-by: Thomas-Torggler-EOS <163338087+Thomas-Torggler-EOS@users.noreply.github.com> --- .../Handlebars/HandleBars.Codeunit.al | 164 ++++++++++++++++++ EX004.EosAdminLib/Handlebars/README.md | 74 ++++++++ .../Handlebars/templates/example-output.html | 56 ++++++ .../Handlebars/templates/footer.html | 5 + .../Handlebars/templates/header.html | 6 + .../Handlebars/templates/layout.html | 25 +++ .../Handlebars/templates/order-details.html | 18 ++ 7 files changed, 348 insertions(+) create mode 100644 EX004.EosAdminLib/Handlebars/README.md create mode 100644 EX004.EosAdminLib/Handlebars/templates/example-output.html create mode 100644 EX004.EosAdminLib/Handlebars/templates/footer.html create mode 100644 EX004.EosAdminLib/Handlebars/templates/header.html create mode 100644 EX004.EosAdminLib/Handlebars/templates/layout.html create mode 100644 EX004.EosAdminLib/Handlebars/templates/order-details.html diff --git a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al index 2d24a25..285dd77 100644 --- a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al +++ b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al @@ -80,6 +80,44 @@ codeunit 50100 HandlebarsTest Assert.IsTrue(Result.Contains('

Hello ' + jh.GetText(Payload, 'CustomerName') + '!

'), ''); end; + [Test] + procedure RenderFromMultiFileTemplate() + var + Handlebars: Codeunit "EOS004 Handlebars Renderer"; + Result: Text; + MainTemplate: TextBuilder; + Payload: JsonObject; + begin + // initialize the codeunit with a default service config 'TEST' + ServiceConfig.Get(ServiceConfigCode); + Handlebars.Initialize(ServiceConfig); + + // Load and set multiple template files as partials + // In a real scenario, these would be loaded from actual files + // Here we simulate loading from the template files we created + Handlebars.SetPartial('header', GetHeaderTemplate()); + Handlebars.SetPartial('order-details', GetOrderDetailsTemplate()); + Handlebars.SetPartial('footer', GetFooterTemplate()); + + // Load the main layout template + MainTemplate.Append(GetLayoutTemplate()); + + // create the payload with more comprehensive data + Payload := CreateEnhancedPayload(); + + // render the complete HTML document + Handlebars.Template(MainTemplate.ToText()); + Handlebars.Render(Payload, Result); + + // validate the multi-file template rendered correctly + Assert.IsTrue(Result.Contains(''), 'Layout template should contain DOCTYPE'); + Assert.IsTrue(Result.Contains('
'), 'Header partial should be included'); + Assert.IsTrue(Result.Contains('
'), 'Order details partial should be included'); + Assert.IsTrue(Result.Contains('
'), 'Footer partial should be included'); + Assert.IsTrue(Result.Contains(jh.GetText(Payload, 'CompanyName')), 'Company name should be rendered'); + Assert.IsTrue(Result.Contains(jh.GetText(Payload, 'CustomerName')), 'Customer name should be rendered'); + end; + local procedure CreatePayload() Result: JsonObject var SalesHeader: Record "Sales Header"; @@ -108,4 +146,130 @@ codeunit 50100 HandlebarsTest Result.ReadFrom(jw.GetJSonAsText()); end; + local procedure CreateEnhancedPayload() Result: JsonObject + var + SalesHeader: Record "Sales Header"; + SalesLine: Record "Sales Line"; + CompanyInfo: Record "Company Information"; + jw: Codeunit "Json Text Reader/Writer"; + TotalAmount: Decimal; + begin + // Get company information + CompanyInfo.Get(); + + // Get a sales order + SalesHeader.SetRange("Document Type", SalesHeader."Document Type"::Order); + SalesHeader.FindFirst(); + + jw.WriteStartObject(''); + + // Document properties + jw.WriteStringProperty('DocumentTitle', 'Order Confirmation - ' + SalesHeader."No."); + + // Company information + jw.WriteStringProperty('CompanyName', CompanyInfo.Name); + jw.WriteStringProperty('CompanyAddress', CompanyInfo.Address + ', ' + CompanyInfo.City); + jw.WriteStringProperty('CompanyPhone', CompanyInfo."Phone No."); + + // Order information + jw.WriteStringProperty('OrderNumber', SalesHeader."No."); + jw.WriteStringProperty('CustomerName', SalesHeader."Sell-to Customer Name"); + jw.WriteStringProperty('OrderDate', Format(SalesHeader."Order Date")); + + // Order lines with enhanced details + jw.WriteStartArray('Lines'); + SalesLine.SetRange("Document Type", SalesHeader."Document Type"); + SalesLine.SetRange("Document No.", SalesHeader."No."); + if SalesLine.FindSet() then + repeat + jw.WriteStartObject(''); + jw.WriteStringProperty('No', SalesLine."No."); + jw.WriteStringProperty('Description', SalesLine.Description); + jw.WriteNumberProperty('Quantity', SalesLine.Quantity); + jw.WriteStringProperty('UnitPrice', Format(SalesLine."Unit Price")); + jw.WriteStringProperty('Amount', Format(SalesLine.Quantity * SalesLine."Unit Price")); + TotalAmount += SalesLine.Quantity * SalesLine."Unit Price"; + jw.WriteEndObject(); + until SalesLine.Next() = 0; + jw.WriteEndArray(); + + // Total amount + jw.WriteStringProperty('TotalAmount', Format(TotalAmount)); + + jw.WriteEndObject(); + + Result.ReadFrom(jw.GetJSonAsText()); + end; + + local procedure GetLayoutTemplate(): Text + begin + // In a real implementation, this would load from an actual file + // This simulates the content of templates/layout.html + exit('' + + '' + + '' + + ' ' + + ' ' + + ' {{DocumentTitle}}' + + ' ' + + '' + + '' + + ' {{> header}}' + + '
' + + ' {{> order-details}}' + + '
' + + ' {{> footer}}' + + '' + + ''); + end; + + local procedure GetHeaderTemplate(): Text + begin + // In a real implementation, this would load from templates/header.html + exit('
' + + '

{{CompanyName}}

' + + '

Order Confirmation

' + + '

Customer: {{CustomerName}}

' + + '

Date: {{OrderDate}}

' + + '
'); + end; + + local procedure GetOrderDetailsTemplate(): Text + begin + // In a real implementation, this would load from templates/order-details.html + exit('
' + + '

Order #{{OrderNumber}}

' + + '

Thank you for your order! Below are the details:

' + + '

Order Lines:

' + + '
    ' + + ' {{#each Lines}}' + + '
  • ' + + ' {{No}} - {{Description}}' + + '
    Quantity: {{Quantity}} | Unit Price: {{UnitPrice}} | Amount: {{Amount}}' + + '
    • ' + + ' {{/each}}' + + '
' + + '
' + + '

Total Amount: {{TotalAmount}}

' + + '
' + + '
'); + end; + + local procedure GetFooterTemplate(): Text + begin + // In a real implementation, this would load from templates/footer.html + exit('
' + + '

Thank you for your business!

' + + '

{{CompanyName}} | {{CompanyAddress}} | {{CompanyPhone}}

' + + '

This is an automatically generated document.

' + + '
'); + end; + } \ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/README.md b/EX004.EosAdminLib/Handlebars/README.md new file mode 100644 index 0000000..996edf6 --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/README.md @@ -0,0 +1,74 @@ +# Handlebars Multi-File Template Example + +This example demonstrates how to use Handlebars with multiple template files to create a complete HTML document. The example shows a practical approach to organizing templates for better maintainability and reusability. + +## Template Structure + +The example uses a multi-file template approach with the following structure: + +### 1. Main Layout Template (`templates/layout.html`) +- Contains the base HTML structure +- Includes CSS styling +- References other templates using partials (`{{> template-name}}`) + +### 2. Header Template (`templates/header.html`) +- Company information and branding +- Order confirmation header +- Customer and date information + +### 3. Order Details Template (`templates/order-details.html`) +- Order number and line items +- Detailed product information with quantities and prices +- Total amount calculation + +### 4. Footer Template (`templates/footer.html`) +- Company contact information +- Thank you message +- Document generation notice + +## Implementation Details + +The AL codeunit `HandlebarsTest` demonstrates three different approaches: + +### 1. Single Template (`RenderFromSingleTemplate`) +Basic template rendering with all content in one template string. + +### 2. Simple Partials (`RenderWithPartials`) +Uses Handlebars partials to separate header and line templates. + +### 3. Multi-File Template (`RenderFromMultiFileTemplate`) +**NEW**: Demonstrates a complete multi-file template approach: +- Loads multiple template files as partials +- Combines them into a complete HTML document +- Uses enhanced data payload with company information +- Produces a professional-looking order confirmation document + +## Key Features + +- **Separation of Concerns**: Each template file handles a specific part of the document +- **Reusability**: Templates can be reused across different document types +- **Maintainability**: Easy to update individual sections without affecting others +- **Professional Output**: Generates complete HTML documents with proper styling +- **Rich Data Binding**: Demonstrates complex data structures with nested objects and arrays + +## Usage + +The `RenderFromMultiFileTemplate` test method shows how to: + +1. Initialize the Handlebars renderer +2. Load multiple template files as partials +3. Set the main layout template +4. Create a comprehensive data payload +5. Render the complete HTML document +6. Validate the output + +## Data Structure + +The enhanced payload includes: +- **Document Properties**: Title, date +- **Company Information**: Name, address, phone +- **Order Information**: Number, customer, date +- **Line Items**: Product details with pricing +- **Calculations**: Total amounts + +This example provides a foundation for creating complex, multi-file template systems in Business Central using the EOS Handlebars integration. \ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/templates/example-output.html b/EX004.EosAdminLib/Handlebars/templates/example-output.html new file mode 100644 index 0000000..4f4567e --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/templates/example-output.html @@ -0,0 +1,56 @@ + + + + + + Order Confirmation - SO12345 + + + + +
+

ACME Corporation

+

Order Confirmation

+

Customer: John Doe

+

Date: 2024-01-15

+
+ +
+ +
+

Order #SO12345

+

Thank you for your order! Below are the details:

+ +

Order Lines:

+
    +
  • + ITEM001 - Premium Widget +
    Quantity: 2 | Unit Price: $50.00 | Amount: $100.00 +
    • +
  • + ITEM002 - Standard Widget +
    Quantity: 5 | Unit Price: $25.00 | Amount: $125.00 +
    • +
+ +
+

Total Amount: $225.00

+
+
+
+ + +
+

Thank you for your business!

+

ACME Corporation | 123 Business St, City | (555) 123-4567

+

This is an automatically generated document.

+
+ + \ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/templates/footer.html b/EX004.EosAdminLib/Handlebars/templates/footer.html new file mode 100644 index 0000000..15f7073 --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/templates/footer.html @@ -0,0 +1,5 @@ +
+

Thank you for your business!

+

{{CompanyName}} | {{CompanyAddress}} | {{CompanyPhone}}

+

This is an automatically generated document.

+
\ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/templates/header.html b/EX004.EosAdminLib/Handlebars/templates/header.html new file mode 100644 index 0000000..acc2165 --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/templates/header.html @@ -0,0 +1,6 @@ +
+

{{CompanyName}}

+

Order Confirmation

+

Customer: {{CustomerName}}

+

Date: {{OrderDate}}

+
\ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/templates/layout.html b/EX004.EosAdminLib/Handlebars/templates/layout.html new file mode 100644 index 0000000..608cce9 --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/templates/layout.html @@ -0,0 +1,25 @@ + + + + + + {{DocumentTitle}} + + + + {{> header}} + +
+ {{> order-details}} +
+ + {{> footer}} + + \ No newline at end of file diff --git a/EX004.EosAdminLib/Handlebars/templates/order-details.html b/EX004.EosAdminLib/Handlebars/templates/order-details.html new file mode 100644 index 0000000..3cacd1d --- /dev/null +++ b/EX004.EosAdminLib/Handlebars/templates/order-details.html @@ -0,0 +1,18 @@ +
+

Order #{{OrderNumber}}

+

Thank you for your order! Below are the details:

+ +

Order Lines:

+
    + {{#each Lines}} +
  • + {{No}} - {{Description}} +
    Quantity: {{Quantity}} | Unit Price: {{UnitPrice}} | Amount: {{Amount}} +
    • + {{/each}} +
+ +
+

Total Amount: {{TotalAmount}}

+
+
\ No newline at end of file From 22c0f2bd29547cc8c606b6255e13b4bb30f6250e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 7 Jul 2025 09:26:43 +0000 Subject: [PATCH 3/4] Fix critical bugs and improve code quality in Handlebars example - Fix missing SalesLine filtering in CreatePayload() method - Add proper error handling for record lookups - Improve code readability by replacing long concatenated strings with TextBuilder - Break down template methods for better maintainability Co-authored-by: Thomas-Torggler-EOS <163338087+Thomas-Torggler-EOS@users.noreply.github.com> --- .../Handlebars/HandleBars.Codeunit.al | 123 ++++++++++-------- 1 file changed, 70 insertions(+), 53 deletions(-) diff --git a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al index 285dd77..2de2cd8 100644 --- a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al +++ b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al @@ -125,13 +125,16 @@ codeunit 50100 HandlebarsTest jw: Codeunit "Json Text Reader/Writer"; begin SalesHeader.SetRange("Document Type", SalesHeader."Document Type"::Order); - SalesHeader.FindFirst(); + if not SalesHeader.FindFirst() then + Error('No sales order found'); jw.WriteStartObject(''); jw.WriteStringProperty('No', SalesHeader."No."); jw.WriteStringProperty('CustomerName', SalesHeader."Sell-to Customer Name"); jw.WriteStartArray('Lines'); + SalesLine.SetRange("Document Type", SalesHeader."Document Type"); + SalesLine.SetRange("Document No.", SalesHeader."No."); if SalesLine.FindSet() then repeat jw.WriteStartObject(''); @@ -155,11 +158,13 @@ codeunit 50100 HandlebarsTest TotalAmount: Decimal; begin // Get company information - CompanyInfo.Get(); + if not CompanyInfo.Get() then + Error('Company information not found'); // Get a sales order SalesHeader.SetRange("Document Type", SalesHeader."Document Type"::Order); - SalesHeader.FindFirst(); + if not SalesHeader.FindFirst() then + Error('No sales order found'); jw.WriteStartObject(''); @@ -202,74 +207,86 @@ codeunit 50100 HandlebarsTest end; local procedure GetLayoutTemplate(): Text + var + Template: TextBuilder; begin // In a real implementation, this would load from an actual file // This simulates the content of templates/layout.html - exit('' + - '' + - '' + - ' ' + - ' ' + - ' {{DocumentTitle}}' + - ' ' + - '' + - '' + - ' {{> header}}' + - '
' + - ' {{> order-details}}' + - '
' + - ' {{> footer}}' + - '' + - ''); + Template.AppendLine(''); + Template.AppendLine(''); + Template.AppendLine(''); + Template.AppendLine(' '); + Template.AppendLine(' '); + Template.AppendLine(' {{DocumentTitle}}'); + Template.AppendLine(' '); + Template.AppendLine(''); + Template.AppendLine(''); + Template.AppendLine(' {{> header}}'); + Template.AppendLine('
'); + Template.AppendLine(' {{> order-details}}'); + Template.AppendLine('
'); + Template.AppendLine(' {{> footer}}'); + Template.AppendLine(''); + Template.AppendLine(''); + exit(Template.ToText()); end; local procedure GetHeaderTemplate(): Text + var + Template: TextBuilder; begin // In a real implementation, this would load from templates/header.html - exit('
' + - '

{{CompanyName}}

' + - '

Order Confirmation

' + - '

Customer: {{CustomerName}}

' + - '

Date: {{OrderDate}}

' + - '
'); + Template.AppendLine('
'); + Template.AppendLine('

{{CompanyName}}

'); + Template.AppendLine('

Order Confirmation

'); + Template.AppendLine('

Customer: {{CustomerName}}

'); + Template.AppendLine('

Date: {{OrderDate}}

'); + Template.AppendLine('
'); + exit(Template.ToText()); end; local procedure GetOrderDetailsTemplate(): Text + var + Template: TextBuilder; begin // In a real implementation, this would load from templates/order-details.html - exit('
' + - '

Order #{{OrderNumber}}

' + - '

Thank you for your order! Below are the details:

' + - '

Order Lines:

' + - '
    ' + - ' {{#each Lines}}' + - '
  • ' + - ' {{No}} - {{Description}}' + - '
    Quantity: {{Quantity}} | Unit Price: {{UnitPrice}} | Amount: {{Amount}}' + - '
    • ' + - ' {{/each}}' + - '
' + - '
' + - '

Total Amount: {{TotalAmount}}

' + - '
' + - '
'); + Template.AppendLine('
'); + Template.AppendLine('

Order #{{OrderNumber}}

'); + Template.AppendLine('

Thank you for your order! Below are the details:

'); + Template.AppendLine('

Order Lines:

'); + Template.AppendLine('
    '); + Template.AppendLine(' {{#each Lines}}'); + Template.AppendLine('
  • '); + Template.AppendLine(' {{No}} - {{Description}}'); + Template.AppendLine('
    Quantity: {{Quantity}} | Unit Price: {{UnitPrice}} | Amount: {{Amount}}'); + Template.AppendLine('
    • '); + Template.AppendLine(' {{/each}}'); + Template.AppendLine('
'); + Template.AppendLine('
'); + Template.AppendLine('

Total Amount: {{TotalAmount}}

'); + Template.AppendLine('
'); + Template.AppendLine('
'); + exit(Template.ToText()); end; local procedure GetFooterTemplate(): Text + var + Template: TextBuilder; begin // In a real implementation, this would load from templates/footer.html - exit('
' + - '

Thank you for your business!

' + - '

{{CompanyName}} | {{CompanyAddress}} | {{CompanyPhone}}

' + - '

This is an automatically generated document.

' + - '
'); + Template.AppendLine('
'); + Template.AppendLine('

Thank you for your business!

'); + Template.AppendLine('

{{CompanyName}} | {{CompanyAddress}} | {{CompanyPhone}}

'); + Template.AppendLine('

This is an automatically generated document.

'); + Template.AppendLine('
'); + exit(Template.ToText()); end; } \ No newline at end of file From 671d36159806e77405b0349848f1bbe36d7dec96 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 7 Jul 2025 09:27:54 +0000 Subject: [PATCH 4/4] Remove unused variables to clean up AL code - Remove unused 'Compr: Codeunit "Data Compression"' variables from test methods Co-authored-by: Thomas-Torggler-EOS <163338087+Thomas-Torggler-EOS@users.noreply.github.com> --- EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al | 2 -- 1 file changed, 2 deletions(-) diff --git a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al index 2de2cd8..a317b02 100644 --- a/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al +++ b/EX004.EosAdminLib/Handlebars/HandleBars.Codeunit.al @@ -15,7 +15,6 @@ codeunit 50100 HandlebarsTest Handlebars: Codeunit "EOS004 Handlebars Renderer"; Result: Text; Template: TextBuilder; - Compr: Codeunit "Data Compression"; Payload: JsonObject; begin // initialize the codeunit with a default service config 'TEST' @@ -47,7 +46,6 @@ codeunit 50100 HandlebarsTest Result: Text; Template: TextBuilder; HeaderPartial, LinePartial : TextBuilder; - Compr: Codeunit "Data Compression"; Payload: JsonObject; begin // initialize the codeunit with a default service config 'TEST'