@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,100 @@
+---
+title: 'Interface: IDocumentModuleOptions'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IDocumentModuleOptions
+
+Defined in: [DocumentModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L15)
+
+Configuration options for the DocumentModule.
+
+## Properties
+
+### debug?
+
+```ts
+readonly optional debug?: boolean;
+```
+
+Defined in: [DocumentModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L50)
+
+Enable debug logging for document processing pipeline.
+When enabled, detailed logs will be written for:
+
+- Parser strategy selection
+- Template variable replacements
+- Data object transformations
+- Renderer processing steps
+
+---
+
+### delimiters?
+
+```ts
+readonly optional delimiters?: {
+  end?: string;
+  start?: string;
+};
+```
+
+Defined in: [DocumentModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L29)
+
+Delimiters for template placeholders.
+
+#### end?
+
+```ts
+readonly optional end?: string;
+```
+
+Ending delimiter.
+
+##### Default
+
+```ts
+']]';
+```
+
+#### start?
+
+```ts
+readonly optional start?: string;
+```
+
+Starting delimiter.
+
+##### Default
+
+```ts
+'[[';
+```
+
+---
+
+### maxImageHeight?
+
+```ts
+readonly optional maxImageHeight?: number;
+```
+
+Defined in: [DocumentModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L24)
+
+Maximum image height in pixels.
+
+---
+
+### maxImageWidth?
+
+```ts
+readonly optional maxImageWidth?: number;
+```
+
+Defined in: [DocumentModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L19)
+
+Maximum image width in pixels.

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

@@ -0,0 +1,75 @@
+---
+title: 'Interface: IDocumentPlaceholderDetail'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IDocumentPlaceholderDetail
+
+Defined in: [types/DocumentTypes.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L41)
+
+Placeholder detail for document probe report.
+
+## Properties
+
+### original
+
+```ts
+original: string;
+```
+
+Defined in: [types/DocumentTypes.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L45)
+
+Original placeholder text as found in template
+
+---
+
+### path
+
+```ts
+path: string;
+```
+
+Defined in: [types/DocumentTypes.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L50)
+
+Resolved data path
+
+---
+
+### reason?
+
+```ts
+optional reason?: string;
+```
+
+Defined in: [types/DocumentTypes.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L65)
+
+Reason why placeholder was not replaced or had issues
+
+---
+
+### replacementValue?
+
+```ts
+optional replacementValue?: string;
+```
+
+Defined in: [types/DocumentTypes.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L60)
+
+Replacement value (stringified if replaced)
+
+---
+
+### status
+
+```ts
+status: 'replaced' | 'notFound' | 'error';
+```
+
+Defined in: [types/DocumentTypes.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L55)
+
+Processing status

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

@@ -0,0 +1,123 @@
+---
+title: 'Interface: IDocumentProbeReport'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IDocumentProbeReport
+
+Defined in: [types/DocumentTypes.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L73)
+
+Document probe report.
+
+## Properties
+
+### dataKeys?
+
+```ts
+optional dataKeys?: string[];
+```
+
+Defined in: [types/DocumentTypes.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L112)
+
+Optional list of available data keys
+
+---
+
+### errorMessage?
+
+```ts
+optional errorMessage?: string;
+```
+
+Defined in: [types/DocumentTypes.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L102)
+
+Optional error message
+
+---
+
+### format
+
+```ts
+format: DocumentFormat;
+```
+
+Defined in: [types/DocumentTypes.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L77)
+
+Document format
+
+---
+
+### placeholders
+
+```ts
+placeholders: IDocumentPlaceholderDetail[];
+```
+
+Defined in: [types/DocumentTypes.ts:117](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L117)
+
+Detailed placeholder information
+
+---
+
+### replacedPlaceholders
+
+```ts
+replacedPlaceholders: number;
+```
+
+Defined in: [types/DocumentTypes.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L87)
+
+Number of placeholders successfully replaced
+
+---
+
+### success
+
+```ts
+success: boolean;
+```
+
+Defined in: [types/DocumentTypes.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L97)
+
+Whether probing succeeded
+
+---
+
+### templateId?
+
+```ts
+optional templateId?: string;
+```
+
+Defined in: [types/DocumentTypes.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L107)
+
+Optional template identifier
+
+---
+
+### totalPlaceholders
+
+```ts
+totalPlaceholders: number;
+```
+
+Defined in: [types/DocumentTypes.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L82)
+
+Total placeholders found
+
+---
+
+### unresolvedPlaceholders
+
+```ts
+unresolvedPlaceholders: number;
+```
+
+Defined in: [types/DocumentTypes.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L92)
+
+Number of placeholders not resolved

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

@@ -0,0 +1,52 @@
+---
+title: 'Interface: IDocumentRenderer'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IDocumentRenderer
+
+Defined in: [renderer/interfaces/IDocumentRenderer.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/interfaces/IDocumentRenderer.ts#L10)
+
+Base interface for document renderers.
+Each renderer handles specific document formats.
+
+## Properties
+
+### supportedFormats
+
+```ts
+readonly supportedFormats: readonly DocumentFormat[];
+```
+
+Defined in: [renderer/interfaces/IDocumentRenderer.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/interfaces/IDocumentRenderer.ts#L15)
+
+Supported document formats for this renderer.
+
+## Methods
+
+### render()
+
+```ts
+render(options): Promise<IRenderResult>;
+```
+
+Defined in: [renderer/interfaces/IDocumentRenderer.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/interfaces/IDocumentRenderer.ts#L23)
+
+Render a document from template with provided data.
+
+#### Parameters
+
+| Parameter | Type                                         | Description    |
+| --------- | -------------------------------------------- | -------------- |
+| `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
+
+#### Returns
+
+`Promise`\<[`IRenderResult`](Interface.IRenderResult)\>
+
+Render result with buffer and metadata

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

@@ -0,0 +1,63 @@
+---
+title: 'Interface: IImagePayload'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IImagePayload
+
+Defined in: [interfaces/IImagePayload.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L8)
+
+Image payload for templates.
+
+## Properties
+
+### data
+
+```ts
+data: string | Buffer<ArrayBufferLike>;
+```
+
+Defined in: [interfaces/IImagePayload.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L12)
+
+Image data (Buffer or base64 string).
+
+---
+
+### height?
+
+```ts
+optional height?: number;
+```
+
+Defined in: [interfaces/IImagePayload.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L22)
+
+Desired height in pixels.
+
+---
+
+### mimeType?
+
+```ts
+optional mimeType?: ImageMimeType;
+```
+
+Defined in: [interfaces/IImagePayload.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L27)
+
+Image MIME type.
+
+---
+
+### width?
+
+```ts
+optional width?: number;
+```
+
+Defined in: [interfaces/IImagePayload.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L17)
+
+Desired width in pixels.

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

@@ -0,0 +1,100 @@
+---
+title: 'Interface: IImageProcessor'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-documents**](../)
+
+---
+
+# Interface: IImageProcessor
+
+Defined in: [processor/interfaces/IImageProcessor.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/interfaces/IImageProcessor.ts#L9)
+
+Base interface for image processors.
+Handles image manipulation and format conversion.
+
+## Methods
+
+### process()
+
+```ts
+process(payload): Promise<IImagePayload>;
+```
+
+Defined in: [processor/interfaces/IImageProcessor.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/interfaces/IImageProcessor.ts#L17)
+
+Process image payload (resize, format conversion).
+
+#### Parameters
+
+| Parameter | Type                                       | Description   |
+| --------- | ------------------------------------------ | ------------- |
+| `payload` | [`IImagePayload`](Interface.IImagePayload) | Image payload |
+
+#### Returns
+
+`Promise`\<[`IImagePayload`](Interface.IImagePayload)\>
+
+Processed image payload
+
+---
+
+### toJpeg()
+
+```ts
+toJpeg(
+   buffer,
+   width?,
+   height?,
+quality?): Promise<Buffer<ArrayBufferLike>>;
+```
+
+Defined in: [processor/interfaces/IImageProcessor.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/interfaces/IImageProcessor.ts#L38)
+
+Convert image to JPEG format.
+
+#### Parameters
+
+| Parameter  | Type     | Description          |
+| ---------- | -------- | -------------------- |
+| `buffer`   | `Buffer` | Image buffer         |
+| `width?`   | `number` | Target width         |
+| `height?`  | `number` | Target height        |
+| `quality?` | `number` | JPEG quality (0-100) |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+
+JPEG buffer
+
+---
+
+### toPng()
+
+```ts
+toPng(
+   buffer,
+   width?,
+height?): Promise<Buffer<ArrayBufferLike>>;
+```
+
+Defined in: [processor/interfaces/IImageProcessor.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/interfaces/IImageProcessor.ts#L27)
+
+Convert image to PNG format.
+
+#### Parameters
+
+| Parameter | Type     | Description   |
+| --------- | -------- | ------------- |
+| `buffer`  | `Buffer` | Image buffer  |
+| `width?`  | `number` | Target width  |
+| `height?` | `number` | Target height |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+
+PNG buffer

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

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

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

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

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

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