@breadstone/archipel-mcp 0.0.21 → 0.0.23

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

@@ -0,0 +1,333 @@
+---
+title: 'Class: DocxDocumentRenderer2'
+generated: true
+editUrl: false
+---
+# Class: DocxDocumentRenderer2
+
+Defined in: [renderer/DocxDocumentRenderer2.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/DocxDocumentRenderer2.ts#L17)
+
+DOCX document renderer.
+Delegates template processing to the configured parser (Encodian, Mustache, etc.).
+The parser handles all template syntax logic via its processXml() method.
+
+## Extends
+
+- [`BaseDocumentRenderer`](Class.BaseDocumentRenderer)
+
+## Constructors
+
+### Constructor
+
+```ts
+new DocxDocumentRenderer2(
+   options, 
+   resourceManager, 
+   imageProcessor): DocxDocumentRenderer2;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L29)
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `imageProcessor`: \{ \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; `renderers`: \{ \}[]; \} | - |
+| `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.imageProcessor` | \{ \} | Image processor implementation class. Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor. |
+| `options.maxImageHeight` | `number` | Maximum image height in pixels. |
+| `options.maxImageWidth` | `number` | Maximum image width in pixels. |
+| `options.renderers` | \{ \}[] | Document renderer implementation classes. Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers. |
+| `resourceManager` | `ResourceManager` | - |
+| `imageProcessor` | [`IImageProcessor`](Interface.IImageProcessor) | - |
+
+#### Returns
+
+`DocxDocumentRenderer2`
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`constructor`](Class.BaseDocumentRenderer#constructor)
+
+## 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)
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_imageProcessor`](Class.BaseDocumentRenderer#_imageprocessor)
+
+***
+
+### \_options
+
+```ts
+protected readonly _options: {
+  debug: boolean;
+  delimiters: {
+     end: string;
+     start: string;
+  };
+  imageProcessor: {
+  };
+  maxImageHeight: number;
+  maxImageWidth: number;
+  renderers: {
+  }[];
+};
+```
+
+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
+'[['
+```
+
+#### imageProcessor
+
+```ts
+readonly imageProcessor: {
+};
+```
+
+Image processor implementation class.
+Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor.
+
+#### maxImageHeight
+
+```ts
+readonly maxImageHeight: number;
+```
+
+Maximum image height in pixels.
+
+#### maxImageWidth
+
+```ts
+readonly maxImageWidth: number;
+```
+
+Maximum image width in pixels.
+
+#### renderers
+
+```ts
+readonly renderers: {
+}[];
+```
+
+Document renderer implementation classes.
+Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers.
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_options`](Class.BaseDocumentRenderer#_options)
+
+***
+
+### \_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)
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_resourceManager`](Class.BaseDocumentRenderer#_resourcemanager)
+
+## Accessors
+
+### supportedFormats
+
+#### Get Signature
+
+```ts
+get supportedFormats(): readonly DocumentFormat[];
+```
+
+Defined in: [renderer/DocxDocumentRenderer2.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/DocxDocumentRenderer2.ts#L25)
+
+Supported document formats.
+
+##### Returns
+
+readonly [`DocumentFormat`](TypeAlias.DocumentFormat)[]
+
+Supported document formats for this renderer.
+
+#### Overrides
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`supportedFormats`](Class.BaseDocumentRenderer#supportedformats)
+
+## 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`isImagePayload`](Class.BaseDocumentRenderer#isimagepayload)
+
+***
+
+### 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`preprocessData`](Class.BaseDocumentRenderer#preprocessdata)
+
+***
+
+### 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`processImages`](Class.BaseDocumentRenderer#processimages)
+
+***
+
+### render()
+
+```ts
+render(options): Promise<IRenderResult>;
+```
+
+Defined in: [renderer/DocxDocumentRenderer2.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/DocxDocumentRenderer2.ts#L37)
+
+Render DOCX document from template.
+Template processing is delegated to the parser (no template logic in renderer).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
+
+#### Returns
+
+`Promise`\<[`IRenderResult`](Interface.IRenderResult)\>
+
+Render result
+
+#### Overrides
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`render`](Class.BaseDocumentRenderer#render)

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

@@ -0,0 +1,355 @@
+---
+title: 'Class: PdfDocumentRenderer'
+generated: true
+editUrl: false
+---
+# Class: PdfDocumentRenderer
+
+Defined in: [renderer/PdfDocumentRenderer.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/PdfDocumentRenderer.ts#L16)
+
+PDF document renderer using pdf-lib.
+Supports placeholder overlay and table rendering.
+
+## Extends
+
+- [`BaseDocumentRenderer`](Class.BaseDocumentRenderer)
+
+## Constructors
+
+### Constructor
+
+```ts
+new PdfDocumentRenderer(
+   options, 
+   resourceManager, 
+   imageProcessor): PdfDocumentRenderer;
+```
+
+Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/abstracts/BaseDocumentRenderer.ts#L29)
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ `debug`: `boolean`; `delimiters`: \{ `end`: `string`; `start`: `string`; \}; `imageProcessor`: \{ \}; `maxImageHeight`: `number`; `maxImageWidth`: `number`; `renderers`: \{ \}[]; \} | - |
+| `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.imageProcessor` | \{ \} | Image processor implementation class. Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor. |
+| `options.maxImageHeight` | `number` | Maximum image height in pixels. |
+| `options.maxImageWidth` | `number` | Maximum image width in pixels. |
+| `options.renderers` | \{ \}[] | Document renderer implementation classes. Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers. |
+| `resourceManager` | `ResourceManager` | - |
+| `imageProcessor` | [`IImageProcessor`](Interface.IImageProcessor) | - |
+
+#### Returns
+
+`PdfDocumentRenderer`
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`constructor`](Class.BaseDocumentRenderer#constructor)
+
+## 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)
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_imageProcessor`](Class.BaseDocumentRenderer#_imageprocessor)
+
+***
+
+### \_options
+
+```ts
+protected readonly _options: {
+  debug: boolean;
+  delimiters: {
+     end: string;
+     start: string;
+  };
+  imageProcessor: {
+  };
+  maxImageHeight: number;
+  maxImageWidth: number;
+  renderers: {
+  }[];
+};
+```
+
+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
+'[['
+```
+
+#### imageProcessor
+
+```ts
+readonly imageProcessor: {
+};
+```
+
+Image processor implementation class.
+Import from `@breadstone/archipel-platform-documents/sharp` for the default Sharp-based processor.
+
+#### maxImageHeight
+
+```ts
+readonly maxImageHeight: number;
+```
+
+Maximum image height in pixels.
+
+#### maxImageWidth
+
+```ts
+readonly maxImageWidth: number;
+```
+
+Maximum image width in pixels.
+
+#### renderers
+
+```ts
+readonly renderers: {
+}[];
+```
+
+Document renderer implementation classes.
+Import from `@breadstone/archipel-platform-documents/docx` and `/pdf` for the built-in renderers.
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_options`](Class.BaseDocumentRenderer#_options)
+
+***
+
+### \_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)
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`_resourceManager`](Class.BaseDocumentRenderer#_resourcemanager)
+
+## Accessors
+
+### supportedFormats
+
+#### Get Signature
+
+```ts
+get supportedFormats(): readonly DocumentFormat[];
+```
+
+Defined in: [renderer/PdfDocumentRenderer.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/PdfDocumentRenderer.ts#L28)
+
+Supported document formats.
+
+##### Returns
+
+readonly [`DocumentFormat`](TypeAlias.DocumentFormat)[]
+
+Supported document formats for this renderer.
+
+#### Overrides
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`supportedFormats`](Class.BaseDocumentRenderer#supportedformats)
+
+## Methods
+
+### createFromScratch()
+
+```ts
+createFromScratch(data): Promise<IRenderResult>;
+```
+
+Defined in: [renderer/PdfDocumentRenderer.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/PdfDocumentRenderer.ts#L108)
+
+Create PDF from scratch (no template).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | `Record`\<`string`, `unknown`\> | Document data |
+
+#### Returns
+
+`Promise`\<[`IRenderResult`](Interface.IRenderResult)\>
+
+Render result
+
+***
+
+### 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`isImagePayload`](Class.BaseDocumentRenderer#isimagepayload)
+
+***
+
+### 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`preprocessData`](Class.BaseDocumentRenderer#preprocessdata)
+
+***
+
+### 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
+
+#### Inherited from
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`processImages`](Class.BaseDocumentRenderer#processimages)
+
+***
+
+### render()
+
+```ts
+render(options): Promise<IRenderResult>;
+```
+
+Defined in: [renderer/PdfDocumentRenderer.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/PdfDocumentRenderer.ts#L39)
+
+Render PDF document from template.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IRenderOptions`](Interface.IRenderOptions) | Render options |
+
+#### Returns
+
+`Promise`\<[`IRenderResult`](Interface.IRenderResult)\>
+
+Render result
+
+#### Overrides
+
+[`BaseDocumentRenderer`](Class.BaseDocumentRenderer).[`render`](Class.BaseDocumentRenderer#render)