@breadstone/archipel-mcp 0.0.1 → 0.0.2

package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md

@@ -3,11 +3,6 @@ title: 'Abstract Class: BaseDocumentRenderer'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Abstract Class: BaseDocumentRenderer
 
 Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L18)
@@ -25,8 +20,8 @@ Provides common functionality for template loading, parsing, and image processin
 
 ```ts
 new BaseDocumentRenderer(
-   options,
-   resourceManager,
+   options, 
+   resourceManager, 
    imageProcessor): BaseDocumentRenderer;
 ```
 
@@ -34,22 +29,128 @@ Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:29](https://github.com/R
 
 #### Parameters
 
-| Parameter                  | Type                                                                                                                                      | Description                                                                                                                                                                                                                    |
-| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `options`                  | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; \} | -                                                                                                                                                                                                                              |
-| `options.debug`            | `boolean`                                                                                                                                 | 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 |
-| `options.delimiters`       | \{ `end`: `string`; `start`: `string`; \}                                                                                                 | Delimiters for template placeholders.                                                                                                                                                                                          |
-| `options.delimiters.end`   | `string`                                                                                                                                  | Ending delimiter. **Default** `']]'`                                                                                                                                                                                           |
-| `options.delimiters.start` | `string`                                                                                                                                  | Starting delimiter. **Default** `'[['`                                                                                                                                                                                         |
-| `options.maxImageHeight`   | `number`                                                                                                                                  | Maximum image height in pixels.                                                                                                                                                                                                |
-| `options.maxImageWidth`    | `number`                                                                                                                                  | Maximum image width in pixels.                                                                                                                                                                                                 |
-| `resourceManager`          | `ResourceManager`                                                                                                                         | -                                                                                                                                                                                                                              |
-| `imageProcessor`           | [`IImageProcessor`](Interface.IImageProcessor)                                                                                            | -                                                                                                                                                                                                                              |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; \} | - |
+| `options.debug` | `boolean` | 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 |
+| `options.delimiters` | \{ `end`: `string`; `start`: `string`; \} | Delimiters for template placeholders. |
+| `options.delimiters.end` | `string` | Ending delimiter. **Default** `']]'` |
+| `options.delimiters.start` | `string` | Starting delimiter. **Default** `'[['` |
+| `options.maxImageHeight` | `number` | Maximum image height in pixels. |
+| `options.maxImageWidth` | `number` | Maximum image width in pixels. |
+| `resourceManager` | `ResourceManager` | - |
+| `imageProcessor` | [`IImageProcessor`](Interface.IImageProcessor) | - |
 
 #### Returns
 
 `BaseDocumentRenderer`
 
+## Properties
+
+### \_imageProcessor
+
+```ts
+protected readonly _imageProcessor: IImageProcessor;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L23)
+
+***
+
+### \_options
+
+```ts
+protected readonly _options: {
+  debug: boolean;
+  delimiters: {
+     end: string;
+     start: string;
+  };
+  maxImageHeight: number;
+  maxImageWidth: number;
+};
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L21)
+
+#### debug
+
+```ts
+readonly debug: boolean;
+```
+
+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 delimiters: {
+  end: string;
+  start: string;
+};
+```
+
+Delimiters for template placeholders.
+
+##### delimiters.end
+
+```ts
+readonly end: string;
+```
+
+Ending delimiter.
+
+###### Default
+
+```ts
+']]'
+```
+
+##### delimiters.start
+
+```ts
+readonly start: string;
+```
+
+Starting delimiter.
+
+###### Default
+
+```ts
+'[['
+```
+
+#### maxImageHeight
+
+```ts
+readonly maxImageHeight: number;
+```
+
+Maximum image height in pixels.
+
+#### maxImageWidth
+
+```ts
+readonly maxImageWidth: number;
+```
+
+Maximum image width in pixels.
+
+***
+
+### \_resourceManager
+
+```ts
+protected readonly _resourceManager: ResourceManager;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L22)
+
 ## Accessors
 
 ### supportedFormats
@@ -76,6 +177,79 @@ Supported document formats for this renderer.
 
 ## Methods
 
+### isImagePayload()
+
+```ts
+protected isImagePayload(value): boolean;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L102)
+
+Check if value is an image payload.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `unknown` | Value to check |
+
+#### Returns
+
+`boolean`
+
+True if image payload
+
+***
+
+### preprocessData()
+
+```ts
+protected preprocessData(data): Promise<Record<string, unknown>>;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L64)
+
+Preprocess template data (process images).
+Template syntax processing is handled later by parser.processXml().
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `Record`\<`string`, `unknown`\> | Raw template data |
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, `unknown`\>\>
+
+Processed data
+
+***
+
+### processImages()
+
+```ts
+protected processImages(data): Promise<Record<string, unknown>>;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L75)
+
+Process image payloads in data.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `Record`\<`string`, `unknown`\> | Data object |
+
+#### Returns
+
+`Promise`\<`Record`\<`string`, `unknown`\>\>
+
+Data with processed images
+
+***
+
 ### render()
 
 ```ts
@@ -88,8 +262,8 @@ Render a document from template with provided data.
 
 #### Parameters
 
-| Parameter | Type                                         | Description    |
-| --------- | -------------------------------------------- | -------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
 
 #### Returns

package/data/packages/platform-documents/api/Class.DocumentEngine.md

@@ -3,11 +3,6 @@ title: 'Class: DocumentEngine'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Class: DocumentEngine
 
 Defined in: [engine/DocumentEngine.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/engine/DocumentEngine.ts#L16)
@@ -27,10 +22,10 @@ Defined in: [engine/DocumentEngine.ts:41](https://github.com/RueDeRennes/archipe
 
 #### Parameters
 
-| Parameter         | Type                                                 |
-| ----------------- | ---------------------------------------------------- |
-| `resourceManager` | `ResourceManager`                                    |
-| `renderers`       | [`IDocumentRenderer`](Interface.IDocumentRenderer)[] |
+| Parameter | Type |
+| ------ | ------ |
+| `resourceManager` | `ResourceManager` |
+| `renderers` | [`IDocumentRenderer`](Interface.IDocumentRenderer)[] |
 
 #### Returns
 
@@ -72,14 +67,14 @@ Render a document from template.
 
 #### Parameters
 
-| Parameter | Type                                         | Description    |
-| --------- | -------------------------------------------- | -------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
 
 #### Returns
 
 `Promise`\<[`IRenderResult`](Interface.IRenderResult) & \{
-`name`: `string`;
+  `name`: `string`;
 \}\>
 
 Render result with buffer and metadata

package/data/packages/platform-documents/api/Class.DocumentModule.md

@@ -3,11 +3,6 @@ title: 'Class: DocumentModule'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Class: DocumentModule
 
 Defined in: [DocumentModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentModule.ts#L62)
@@ -41,8 +36,8 @@ Configures the module with the specified options.
 
 #### Parameters
 
-| Parameter | Type                                                         | Description                       |
-| --------- | ------------------------------------------------------------ | --------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IDocumentModuleOptions`](Interface.IDocumentModuleOptions) | The module configuration options. |
 
 #### Returns

package/data/packages/platform-documents/api/Class.SharpImageProcessor.md

@@ -3,11 +3,6 @@ title: 'Class: SharpImageProcessor'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Class: SharpImageProcessor
 
 Defined in: [processor/SharpImageProcessor.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/SharpImageProcessor.ts#L15)
@@ -31,8 +26,8 @@ Defined in: [processor/SharpImageProcessor.ts:26](https://github.com/RueDeRennes
 
 #### Parameters
 
-| Parameter | Type                                                         |
-| --------- | ------------------------------------------------------------ |
+| Parameter | Type |
+| ------ | ------ |
 | `options` | [`IDocumentModuleOptions`](Interface.IDocumentModuleOptions) |
 
 #### Returns
@@ -53,8 +48,8 @@ Process image payload.
 
 #### Parameters
 
-| Parameter | Type                                       | Description   |
-| --------- | ------------------------------------------ | ------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `payload` | [`IImagePayload`](Interface.IImagePayload) | Image payload |
 
 #### Returns
@@ -67,15 +62,15 @@ Processed payload
 
 [`IImageProcessor`](Interface.IImageProcessor).[`process`](Interface.IImageProcessor#process)
 
----
+***
 
 ### toJpeg()
 
 ```ts
 toJpeg(
-   buffer,
-   width?,
-   height?,
+   buffer, 
+   width?, 
+   height?, 
 quality?): Promise<Buffer<ArrayBufferLike>>;
 ```
 
@@ -85,12 +80,12 @@ Convert to JPEG.
 
 #### Parameters
 
-| Parameter  | Type     | Default value | Description   |
-| ---------- | -------- | ------------- | ------------- |
-| `buffer`   | `Buffer` | `undefined`   | Image buffer  |
-| `width?`   | `number` | `undefined`   | Target width  |
-| `height?`  | `number` | `undefined`   | Target height |
-| `quality?` | `number` | `90`          | JPEG quality  |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `buffer` | `Buffer` | `undefined` | Image buffer |
+| `width?` | `number` | `undefined` | Target width |
+| `height?` | `number` | `undefined` | Target height |
+| `quality?` | `number` | `90` | JPEG quality |
 
 #### Returns
 
@@ -102,14 +97,14 @@ JPEG buffer
 
 [`IImageProcessor`](Interface.IImageProcessor).[`toJpeg`](Interface.IImageProcessor#tojpeg)
 
----
+***
 
 ### toPng()
 
 ```ts
 toPng(
-   buffer,
-   width?,
+   buffer, 
+   width?, 
 height?): Promise<Buffer<ArrayBufferLike>>;
 ```
 
@@ -119,10 +114,10 @@ Convert to PNG.
 
 #### Parameters
 
-| Parameter | Type     | Description   |
-| --------- | -------- | ------------- |
-| `buffer`  | `Buffer` | Image buffer  |
-| `width?`  | `number` | Target width  |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Buffer` | Image buffer |
+| `width?` | `number` | Target width |
 | `height?` | `number` | Target height |
 
 #### Returns

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

@@ -3,11 +3,6 @@ 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)
@@ -26,13 +21,12 @@ Defined in: [DocumentModule.ts:50](https://github.com/RueDeRennes/archipel/blob/
 
 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?
 
@@ -58,7 +52,7 @@ Ending delimiter.
 ##### Default
 
 ```ts
-']]';
+']]'
 ```
 
 #### start?
@@ -72,10 +66,10 @@ Starting delimiter.
 ##### Default
 
 ```ts
-'[[';
+'[['
 ```
 
----
+***
 
 ### maxImageHeight?
 
@@ -87,7 +81,7 @@ Defined in: [DocumentModule.ts:24](https://github.com/RueDeRennes/archipel/blob/
 
 Maximum image height in pixels.
 
----
+***
 
 ### maxImageWidth?
 

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

@@ -3,11 +3,6 @@ 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)
@@ -26,7 +21,7 @@ Defined in: [types/DocumentTypes.ts:45](https://github.com/RueDeRennes/archipel/
 
 Original placeholder text as found in template
 
----
+***
 
 ### path
 
@@ -38,7 +33,7 @@ Defined in: [types/DocumentTypes.ts:50](https://github.com/RueDeRennes/archipel/
 
 Resolved data path
 
----
+***
 
 ### reason?
 
@@ -50,7 +45,7 @@ Defined in: [types/DocumentTypes.ts:65](https://github.com/RueDeRennes/archipel/
 
 Reason why placeholder was not replaced or had issues
 
----
+***
 
 ### replacementValue?
 
@@ -62,12 +57,12 @@ Defined in: [types/DocumentTypes.ts:60](https://github.com/RueDeRennes/archipel/
 
 Replacement value (stringified if replaced)
 
----
+***
 
 ### status
 
 ```ts
-status: 'replaced' | 'notFound' | 'error';
+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)

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

@@ -3,11 +3,6 @@ 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)
@@ -26,7 +21,7 @@ Defined in: [types/DocumentTypes.ts:112](https://github.com/RueDeRennes/archipel
 
 Optional list of available data keys
 
----
+***
 
 ### errorMessage?
 
@@ -38,7 +33,7 @@ Defined in: [types/DocumentTypes.ts:102](https://github.com/RueDeRennes/archipel
 
 Optional error message
 
----
+***
 
 ### format
 
@@ -50,7 +45,7 @@ Defined in: [types/DocumentTypes.ts:77](https://github.com/RueDeRennes/archipel/
 
 Document format
 
----
+***
 
 ### placeholders
 
@@ -62,7 +57,7 @@ Defined in: [types/DocumentTypes.ts:117](https://github.com/RueDeRennes/archipel
 
 Detailed placeholder information
 
----
+***
 
 ### replacedPlaceholders
 
@@ -74,7 +69,7 @@ Defined in: [types/DocumentTypes.ts:87](https://github.com/RueDeRennes/archipel/
 
 Number of placeholders successfully replaced
 
----
+***
 
 ### success
 
@@ -86,7 +81,7 @@ Defined in: [types/DocumentTypes.ts:97](https://github.com/RueDeRennes/archipel/
 
 Whether probing succeeded
 
----
+***
 
 ### templateId?
 
@@ -98,7 +93,7 @@ Defined in: [types/DocumentTypes.ts:107](https://github.com/RueDeRennes/archipel
 
 Optional template identifier
 
----
+***
 
 ### totalPlaceholders
 
@@ -110,7 +105,7 @@ Defined in: [types/DocumentTypes.ts:82](https://github.com/RueDeRennes/archipel/
 
 Total placeholders found
 
----
+***
 
 ### unresolvedPlaceholders
 

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

@@ -3,11 +3,6 @@ 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)
@@ -41,8 +36,8 @@ Render a document from template with provided data.
 
 #### Parameters
 
-| Parameter | Type                                         | Description    |
-| --------- | -------------------------------------------- | -------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
 
 #### Returns

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

@@ -3,11 +3,6 @@ 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)
@@ -26,7 +21,7 @@ Defined in: [interfaces/IImagePayload.ts:12](https://github.com/RueDeRennes/arch
 
 Image data (Buffer or base64 string).
 
----
+***
 
 ### height?
 
@@ -38,7 +33,7 @@ Defined in: [interfaces/IImagePayload.ts:22](https://github.com/RueDeRennes/arch
 
 Desired height in pixels.
 
----
+***
 
 ### mimeType?
 
@@ -50,7 +45,7 @@ Defined in: [interfaces/IImagePayload.ts:27](https://github.com/RueDeRennes/arch
 
 Image MIME type.
 
----
+***
 
 ### width?