@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,19 @@
+---
+title: 'Type Alias: TemplateFormat'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# 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

@@ -0,0 +1,19 @@
+---
+title: 'Type Alias: TemplateType'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# 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/index.md

@@ -0,0 +1,91 @@
+---
+title: '@breadstone/archipel-platform-documents'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# @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
+
+### 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.
+
+---
+
+### 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.
+
+---
+
+### 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).
+
+---
+
+### 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/index.md

@@ -0,0 +1,219 @@
+---
+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                |

package/data/packages/platform-logging/api/Class.AnalyticsService.md

@@ -0,0 +1,113 @@
+---
+title: 'Class: AnalyticsService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-logging**](../)
+
+---
+
+# Class: AnalyticsService
+
+Defined in: [services/AnalyticsService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L14)
+
+A service to log analytics events
+
+## Constructors
+
+### Constructor
+
+```ts
+new AnalyticsService(): AnalyticsService;
+```
+
+Defined in: [services/AnalyticsService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L18)
+
+#### Returns
+
+`AnalyticsService`
+
+## Methods
+
+### captureException()
+
+```ts
+captureException(error, context?): void;
+```
+
+Defined in: [services/AnalyticsService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L35)
+
+#### Parameters
+
+| Parameter  | Type                            |
+| ---------- | ------------------------------- |
+| `error`    | `Error`                         |
+| `context?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+---
+
+### logError()
+
+```ts
+logError(error, context?): void;
+```
+
+Defined in: [services/AnalyticsService.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L31)
+
+#### Parameters
+
+| Parameter  | Type                            |
+| ---------- | ------------------------------- |
+| `error`    | `Error`                         |
+| `context?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+---
+
+### logMessage()
+
+```ts
+logMessage(message, context?): void;
+```
+
+Defined in: [services/AnalyticsService.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L27)
+
+#### Parameters
+
+| Parameter  | Type                            |
+| ---------- | ------------------------------- |
+| `message`  | `string`                        |
+| `context?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`
+
+---
+
+### setUser()
+
+```ts
+setUser(userId, userContext?): void;
+```
+
+Defined in: [services/AnalyticsService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/services/AnalyticsService.ts#L39)
+
+#### Parameters
+
+| Parameter      | Type                            |
+| -------------- | ------------------------------- |
+| `userId`       | `string`                        |
+| `userContext?` | `Record`\<`string`, `unknown`\> |
+
+#### Returns
+
+`void`

package/data/packages/platform-logging/api/Class.LoggerModule.md

@@ -0,0 +1,25 @@
+---
+title: 'Class: LoggerModule'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-logging**](../)
+
+---
+
+# Class: LoggerModule
+
+Defined in: [LoggerModule.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/LoggerModule.ts#L26)
+
+## Constructors
+
+### Constructor
+
+```ts
+new LoggerModule(): LoggerModule;
+```
+
+#### Returns
+
+`LoggerModule`

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

@@ -0,0 +1,42 @@
+---
+title: '@breadstone/archipel-platform-logging'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-logging**](../)
+
+---
+
+# @breadstone/archipel-platform-logging
+
+## Classes
+
+| Class                                      | Description                       |
+| ------------------------------------------ | --------------------------------- |
+| [AnalyticsService](Class.AnalyticsService) | A service to log analytics events |
+| [LoggerModule](Class.LoggerModule)         | -                                 |
+
+## Variables
+
+### APP_LOG_LEVEL
+
+```ts
+const APP_LOG_LEVEL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/env.ts#L12)
+
+Application log level (e.g. `'debug'`, `'info'`, `'warn'`, `'error'`).
+
+---
+
+### PLATFORM_LOGGING_CONFIG_ENTRIES
+
+```ts
+const PLATFORM_LOGGING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-logging/src/env.ts#L19)
+
+All configuration entries required by `platform-logging`.

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

@@ -0,0 +1,92 @@
+---
+title: platform-logging
+description: Sentry integration for error tracking and analytics.
+order: 6
+tags: [logging, sentry, error-tracking, analytics]
+package: '@breadstone/archipel-platform-logging'
+---
+
+# platform-logging
+
+Sentry integration for centralized error tracking and analytics. Provides structured error reporting with context enrichment.
+
+**Package:** `@breadstone/archipel-platform-logging`
+
+## Quick Start
+
+```typescript
+import { Module } from '@nestjs/common';
+import { LoggerModule } from '@breadstone/archipel-platform-logging';
+
+@Module({
+  imports: [LoggerModule],
+})
+export class AppModule {}
+```
+
+---
+
+## AnalyticsService
+
+Central service for error and event reporting to Sentry.
+
+```typescript
+import { AnalyticsService } from '@breadstone/archipel-platform-logging';
+
+@Injectable()
+export class PaymentService {
+  constructor(private readonly _analytics: AnalyticsService) {}
+
+  public async processPayment(orderId: string): Promise<void> {
+    try {
+      // ... payment logic
+    } catch (error) {
+      this._analytics.captureException(error, {
+        tags: { module: 'payments', orderId },
+      });
+      throw error;
+    }
+  }
+}
+```
+
+---
+
+## Environment Variables
+
+| Variable                    | Description                                          | Required |
+| --------------------------- | ---------------------------------------------------- | -------- |
+| `SENTRY_DSN`                | Sentry Data Source Name                              | Yes      |
+| `SENTRY_ENVIRONMENT`        | Environment label (e.g. `'production'`, `'staging'`) | No       |
+| `SENTRY_TRACES_SAMPLE_RATE` | Sampling rate for performance traces (0.0–1.0)       | No       |
+
+---
+
+## Real-World Example: Global Error Filter
+
+```typescript
+import { Catch, type ExceptionFilter, type ArgumentsHost } from '@nestjs/common';
+import { AnalyticsService } from '@breadstone/archipel-platform-logging';
+
+@Catch()
+export class GlobalExceptionFilter implements ExceptionFilter {
+  constructor(private readonly _analytics: AnalyticsService) {}
+
+  public catch(exception: unknown, host: ArgumentsHost): void {
+    this._analytics.captureException(exception);
+
+    const ctx = host.switchToHttp();
+    const response = ctx.getResponse();
+    response.status(500).json({ error: 'Internal Server Error' });
+  }
+}
+```
+
+---
+
+## Exports Summary
+
+| Export             | Type          | Description                      |
+| ------------------ | ------------- | -------------------------------- |
+| `LoggerModule`     | NestJS Module | Global Sentry integration        |
+| `AnalyticsService` | Service       | Error capture and event tracking |

package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md

@@ -0,0 +1,67 @@
+---
+title: 'Class: BlobTemplateFetchStrategy'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-mailing**](../)
+
+---
+
+# Class: BlobTemplateFetchStrategy
+
+Defined in: [platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts#L16)
+
+The `BlobTemplateFetchStrategy` class.
+
+## Extends
+
+- [`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new BlobTemplateFetchStrategy(blobService): BlobTemplateFetchStrategy;
+```
+
+Defined in: [platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts#L30)
+
+Constructs a new instance of the `BlobTemplateFetchStrategy` class.
+
+#### Parameters
+
+| Parameter     | Type          |
+| ------------- | ------------- |
+| `blobService` | `BlobService` |
+
+#### Returns
+
+`BlobTemplateFetchStrategy`
+
+#### Overrides
+
+```ts
+TemplateFetchStrategyBase.constructor;
+```
+
+## Methods
+
+### load()
+
+```ts
+abstract load(): Promise<Record<string, IMailTemplateVariants>>;
+```
+
+Defined in: [platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/templating/strategies/BlobTemplateFetchStrategy.ts#L40)
+
+Loads the templates.
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, [`IMailTemplateVariants`](Interface.IMailTemplateVariants)\>\>
+
+#### Overrides
+
+[`TemplateFetchStrategyBase`](Class.TemplateFetchStrategyBase).[`load`](Class.TemplateFetchStrategyBase#load)