@breadstone/archipel-mcp 0.0.13 → 0.0.14

package/data/packages/platform-documents/api/Interface.IRenderOptions.md

@@ -1,64 +0,0 @@
----
-title: 'Interface: IRenderOptions'
-generated: true
-editUrl: false
----
-# Interface: IRenderOptions
-
-Defined in: [interfaces/IRenderOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L8)
-
-Options for rendering a document.
-
-## Properties
-
-### data
-
-```ts
-readonly data: Record<string, unknown>;
-```
-
-Defined in: [interfaces/IRenderOptions.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L33)
-
-Data payload for template placeholders.
-
-***
-
-### template?
-
-```ts
-readonly optional template?: string | Buffer<ArrayBufferLike>;
-```
-
-Defined in: [interfaces/IRenderOptions.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L28)
-
-Template buffer for direct template upload.
-Either templateId or templateBuffer must be provided.
-
-- Buffer: Binary document content (DOCX, PDF)
-- string: Raw XML document content (for DOCX only)
-
-***
-
-### templateFormat?
-
-```ts
-readonly optional templateFormat?: TemplateFormat;
-```
-
-Defined in: [interfaces/IRenderOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L19)
-
-Template format type (encodian or mustache).
-Defaults to 'encodian' if not specified.
-
-***
-
-### templateId?
-
-```ts
-readonly optional templateId?: string;
-```
-
-Defined in: [interfaces/IRenderOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L13)
-
-Template identifier for registered templates.
-Either templateId or templateBuffer must be provided.

package/data/packages/platform-documents/api/Interface.IRenderResult.md

@@ -1,58 +0,0 @@
----
-title: 'Interface: IRenderResult'
-generated: true
-editUrl: false
----
-# Interface: IRenderResult
-
-Defined in: [types/DocumentTypes.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L125)
-
-Document render result.
-
-## Properties
-
-### buffer
-
-```ts
-buffer: Buffer;
-```
-
-Defined in: [types/DocumentTypes.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L130)
-
-Document buffer.
-
-***
-
-### format
-
-```ts
-format: DocumentFormat;
-```
-
-Defined in: [types/DocumentTypes.ts:135](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L135)
-
-Document format.
-
-***
-
-### mimeType
-
-```ts
-mimeType: string;
-```
-
-Defined in: [types/DocumentTypes.ts:140](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L140)
-
-MIME type.
-
-***
-
-### report
-
-```ts
-report: IDocumentProbeReport | null;
-```
-
-Defined in: [types/DocumentTypes.ts:145](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L145)
-
-Document probe report (null if not available)

package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md

@@ -1,14 +0,0 @@
----
-title: 'Type Alias: DocumentFormat'
-generated: true
-editUrl: false
----
-# Type Alias: DocumentFormat
-
-```ts
-type DocumentFormat = "pdf" | "docx";
-```
-
-Defined in: [types/DocumentTypes.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L6)
-
-Document output format types.

package/data/packages/platform-documents/api/TypeAlias.EngineType.md

@@ -1,14 +0,0 @@
----
-title: 'Type Alias: EngineType'
-generated: true
-editUrl: false
----
-# Type Alias: EngineType
-
-```ts
-type EngineType = "docx" | "pdf";
-```
-
-Defined in: [types/DocumentTypes.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L27)
-
-Template engine type.

package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md

@@ -1,14 +0,0 @@
----
-title: 'Type Alias: ImageMimeType'
-generated: true
-editUrl: false
----
-# Type Alias: ImageMimeType
-
-```ts
-type ImageMimeType = "image/png" | "image/jpeg" | "image/jpg" | "image/webp";
-```
-
-Defined in: [types/DocumentTypes.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L34)
-
-Image MIME type.

package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md

@@ -1,14 +0,0 @@
----
-title: 'Type Alias: TemplateFormat'
-generated: true
-editUrl: false
----
-# Type Alias: TemplateFormat
-
-```ts
-type TemplateFormat = "encodian" | "mustache";
-```
-
-Defined in: [types/DocumentTypes.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L13)
-
-Template format type (parser syntax).

package/data/packages/platform-documents/api/TypeAlias.TemplateType.md

@@ -1,14 +0,0 @@
----
-title: 'Type Alias: TemplateType'
-generated: true
-editUrl: false
----
-# Type Alias: TemplateType
-
-```ts
-type TemplateType = "docx" | "pdf";
-```
-
-Defined in: [types/DocumentTypes.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L20)
-
-Template type.

package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: DOCUMENT\_MODULE\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: DOCUMENT\_MODULE\_OPTIONS
-
-```ts
-const DOCUMENT_MODULE_OPTIONS: typeof DOCUMENT_MODULE_OPTIONS;
-```
-
-Defined in: [DocumentTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L6)
-
-Injection token for DocumentModule options.

package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: DOCUMENT\_PARSER\_TOKEN'
-generated: true
-editUrl: false
----
-# Variable: DOCUMENT\_PARSER\_TOKEN
-
-```ts
-const DOCUMENT_PARSER_TOKEN: typeof DOCUMENT_PARSER_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L20)
-
-Injection token for IDocumentParser.

package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: DOCUMENT\_RENDERER\_TOKEN'
-generated: true
-editUrl: false
----
-# Variable: DOCUMENT\_RENDERER\_TOKEN
-
-```ts
-const DOCUMENT_RENDERER_TOKEN: typeof DOCUMENT_RENDERER_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L27)
-
-Injection token for IDocumentRenderer (multi-provider).

package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: IMAGE\_PROCESSOR\_TOKEN'
-generated: true
-editUrl: false
----
-# Variable: IMAGE\_PROCESSOR\_TOKEN
-
-```ts
-const IMAGE_PROCESSOR_TOKEN: typeof IMAGE_PROCESSOR_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L13)
-
-Injection token for IImageProcessor.

package/data/packages/platform-documents/api/index.md

@@ -1,47 +0,0 @@
----
-title: '@breadstone/archipel-platform-documents'
-generated: true
-editUrl: false
----
-# @breadstone/archipel-platform-documents
-
-## Classes
-
-| Class | Description |
-| ------ | ------ |
-| [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing. |
-| [DocumentEngine](Class.DocumentEngine) | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components. |
-| [DocumentModule](Class.DocumentModule) | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
-| [SharpImageProcessor](Class.SharpImageProcessor) | Sharp-based image processor. Handles image resizing and format conversion. |
-
-## Interfaces
-
-| Interface | Description |
-| ------ | ------ |
-| [IDocumentModuleOptions](Interface.IDocumentModuleOptions) | Configuration options for the DocumentModule. |
-| [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report. |
-| [IDocumentProbeReport](Interface.IDocumentProbeReport) | Document probe report. |
-| [IDocumentRenderer](Interface.IDocumentRenderer) | Base interface for document renderers. Each renderer handles specific document formats. |
-| [IImagePayload](Interface.IImagePayload) | Image payload for templates. |
-| [IImageProcessor](Interface.IImageProcessor) | Base interface for image processors. Handles image manipulation and format conversion. |
-| [IRenderOptions](Interface.IRenderOptions) | Options for rendering a document. |
-| [IRenderResult](Interface.IRenderResult) | Document render result. |
-
-## Type Aliases
-
-| Type Alias | Description |
-| ------ | ------ |
-| [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types. |
-| [EngineType](TypeAlias.EngineType) | Template engine type. |
-| [ImageMimeType](TypeAlias.ImageMimeType) | Image MIME type. |
-| [TemplateFormat](TypeAlias.TemplateFormat) | Template format type (parser syntax). |
-| [TemplateType](TypeAlias.TemplateType) | Template type. |
-
-## Variables
-
-| Variable | Description |
-| ------ | ------ |
-| [DOCUMENT\_MODULE\_OPTIONS](Variable.DOCUMENT_MODULE_OPTIONS) | Injection token for DocumentModule options. |
-| [DOCUMENT\_PARSER\_TOKEN](Variable.DOCUMENT_PARSER_TOKEN) | Injection token for IDocumentParser. |
-| [DOCUMENT\_RENDERER\_TOKEN](Variable.DOCUMENT_RENDERER_TOKEN) | Injection token for IDocumentRenderer (multi-provider). |
-| [IMAGE\_PROCESSOR\_TOKEN](Variable.IMAGE_PROCESSOR_TOKEN) | Injection token for IImageProcessor. |

package/data/packages/platform-documents/index.md

@@ -1,219 +0,0 @@
----
-title: platform-documents
-description: Document generation engine supporting DOCX and PDF with template-based rendering.
-order: 9
-tags: [documents, docx, pdf, templates, generation, rendering]
-package: '@breadstone/archipel-platform-documents'
----
-
-# platform-documents
-
-Template-based document generation engine supporting DOCX and PDF output. Uses pluggable renderers and template parsers with image processing via Sharp.
-
-**Package:** `@breadstone/archipel-platform-documents`
-
-## Quick Start
-
-```typescript
-import { Module } from '@nestjs/common';
-import { DocumentModule } from '@breadstone/archipel-platform-documents';
-
-@Module({
-  imports: [
-    DocumentModule.forRoot({
-      maxImageWidth: 1920,
-      maxImageHeight: 1080,
-      delimiters: { start: '[[', end: ']]' },
-      debug: false,
-    }),
-  ],
-})
-export class AppModule {}
-```
-
----
-
-## Module Configuration
-
-### IDocumentModuleOptions
-
-| Property           | Type      | Default | Description                        |
-| ------------------ | --------- | ------- | ---------------------------------- |
-| `maxImageWidth`    | `number`  | `1920`  | Maximum width for embedded images  |
-| `maxImageHeight`   | `number`  | `1080`  | Maximum height for embedded images |
-| `delimiters.start` | `string`  | `'[['`  | Template variable start delimiter  |
-| `delimiters.end`   | `string`  | `']]'`  | Template variable end delimiter    |
-| `debug`            | `boolean` | `false` | Enable debug output                |
-
----
-
-## DocumentEngine
-
-Main orchestrator for document rendering.
-
-### Render from Template
-
-```typescript
-import { DocumentEngine } from '@breadstone/archipel-platform-documents';
-
-@Injectable()
-export class InvoiceService {
-  constructor(private readonly _docEngine: DocumentEngine) {}
-
-  public async generateInvoice(data: IInvoiceData): Promise<Buffer> {
-    const result = await this._docEngine.render({
-      templateId: 'invoice-template',
-      data: {
-        invoiceNumber: data.number,
-        customerName: data.customerName,
-        items: data.items.map((item) => ({
-          description: item.description,
-          qty: item.quantity,
-          unitPrice: `€${item.unitPrice.toFixed(2)}`,
-          total: `€${(item.quantity * item.unitPrice).toFixed(2)}`,
-        })),
-        subtotal: `€${data.subtotal.toFixed(2)}`,
-        tax: `€${data.tax.toFixed(2)}`,
-        total: `€${data.total.toFixed(2)}`,
-        date: new Date().toLocaleDateString('de-DE'),
-      },
-      templateFormat: 'docx',
-    });
-
-    return result.buffer;
-  }
-}
-```
-
-### Render from Buffer
-
-```typescript
-const templateBuffer = await fs.readFile('./templates/contract.docx');
-
-const result = await this._docEngine.render({
-  templateBuffer,
-  data: { clientName: 'Acme Corp', startDate: '2025-01-01' },
-  templateFormat: 'docx',
-});
-```
-
-### Templates with Images
-
-```typescript
-const result = await this._docEngine.render({
-  templateId: 'report-with-charts',
-  data: {
-    title: 'Q4 Report',
-    summary: 'Revenue increased by 23%.',
-  },
-  images: [
-    {
-      tag: 'revenueChart', // Matches [[revenueChart]] in template
-      buffer: chartImageBuffer,
-      contentType: 'image/png',
-      width: 800,
-      height: 400,
-    },
-  ],
-  templateFormat: 'docx',
-});
-```
-
----
-
-## Document Renderers
-
-### DOCX Renderer
-
-Renders DOCX (Microsoft Word) documents using `docxtemplater`:
-
-- Variable substitution: `[[variableName]]`
-- Loops: `[[#items]][[name]] - [[price]][[/items]]`
-- Conditionals: `[[#if showDiscount]]...[[/if]]`
-- Image placeholders: `[[imageName]]`
-
-### PDF Renderer
-
-Renders PDF documents using `pdf-lib`:
-
-- Text substitution in PDF form fields
-- Image insertion
-- Page manipulation
-
----
-
-## Image Processing
-
-### SharpImageProcessor
-
-Resizes and optimizes images before embedding in documents:
-
-```typescript
-import { SharpImageProcessor } from '@breadstone/archipel-platform-documents';
-
-// Used internally by DocumentEngine
-// Respects maxImageWidth and maxImageHeight from module options
-```
-
-Supported formats: PNG, JPEG, WebP, TIFF, AVIF.
-
----
-
-## Real-World Example: Contract Generator
-
-```typescript
-@Controller('api/v1/contracts')
-export class ContractController {
-  constructor(
-    private readonly _docEngine: DocumentEngine,
-    private readonly _blobService: BlobService,
-  ) {}
-
-  @Post(':id/generate')
-  public async generate(@Param('id') contractId: string, @Res() res: Response): Promise<void> {
-    const contract = await this._contractService.findById(contractId);
-
-    const result = await this._docEngine.render({
-      templateId: 'service-agreement',
-      data: {
-        clientName: contract.clientName,
-        startDate: contract.startDate.toLocaleDateString('de-DE'),
-        endDate: contract.endDate.toLocaleDateString('de-DE'),
-        monthlyFee: `€${contract.monthlyFee.toFixed(2)}`,
-        services: contract.services,
-      },
-      templateFormat: 'docx',
-    });
-
-    // Optionally store in blob storage
-    await this._blobService.uploadFile(
-      `contracts/${contractId}/${result.name}`,
-      result.buffer,
-      'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
-    );
-
-    res.set({
-      'Content-Type': result.contentType,
-      'Content-Disposition': `attachment; filename="${result.name}"`,
-    });
-    res.send(result.buffer);
-  }
-}
-```
-
----
-
-## Exports Summary
-
-| Export                 | Type           | Description                               |
-| ---------------------- | -------------- | ----------------------------------------- |
-| `DocumentModule`       | NestJS Module  | `forRoot()` configuration                 |
-| `DocumentEngine`       | Service        | Main rendering orchestrator               |
-| `BaseDocumentRenderer` | Abstract class | Renderer base                             |
-| `IDocumentRenderer`    | Interface      | Renderer contract                         |
-| `SharpImageProcessor`  | Service        | Image resize/optimization                 |
-| `IImageProcessor`      | Interface      | Image processor contract                  |
-| `DocumentFormat`       | Enum           | `'docx'` / `'pdf'`                        |
-| `TemplateFormat`       | Enum           | Template format identifiers               |
-| `IRenderResult`        | Interface      | Render output (buffer, name, contentType) |
-| `IDocumentProbeReport` | Interface      | Template validation report                |