npm - @breadstone/archipel-mcp - Versions diffs - 0.0.1 → 0.0.3 - Mend

@breadstone/archipel-mcp 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (407) hide show

package/data/packages/platform-database/api/Function.pageable.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+title: 'Function: pageable()'
+generated: true
+editUrl: false
+---
+# Function: pageable()
+```ts
+function pageable<TEntity>(items, total, skip, take?): IPageableCollection<TEntity>;
+```
+Defined in: [models/entities/IPageableEntityCollection.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/models/entities/IPageableEntityCollection.ts#L13)
+## Type Parameters
+| Type Parameter |
+| -------------- |
+| `TEntity`      |
+## Parameters
+| Parameter | Type        |
+| --------- | ----------- |
+| `items`   | `TEntity`[] |
+| `total`   | `number`    |
+| `skip`    | `number`    |
+| `take?`   | `number`    |
+## Returns
+`IPageableCollection`\<`TEntity`\>

package/data/packages/platform-database/api/Function.paginator.md ADDED Viewed

@@ -0,0 +1,23 @@
+---
+title: 'Function: paginator()'
+generated: true
+editUrl: false
+---
+# Function: paginator()
+```ts
+function paginator(defaultOptions): PaginateFunction;
+```
+Defined in: [features/Pagination.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L19)
+## Parameters
+| Parameter        | Type                                             |
+| ---------------- | ------------------------------------------------ |
+| `defaultOptions` | [`IPaginateOptions`](Interface.IPaginateOptions) |
+## Returns
+[`PaginateFunction`](TypeAlias.PaginateFunction)

package/data/packages/platform-database/api/Function.query.md ADDED Viewed

@@ -0,0 +1,35 @@
+---
+title: 'Function: query()'
+generated: true
+editUrl: false
+---
+# Function: query()
+```ts
+function query<TDelegate, TResult>(name, run): IRepositoryQuery<TDelegate, TResult>;
+```
+Defined in: [repositories/queries/query.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/query.ts#L15)
+Creates a new repository query.
+## Type Parameters
+| Type Parameter |
+| -------------- |
+| `TDelegate`    |
+| `TResult`      |
+## Parameters
+| Parameter | Type                                | Description                       |
+| --------- | ----------------------------------- | --------------------------------- |
+| `name`    | `string`                            | The name of the query.            |
+| `run`     | (`model`) => `Promise`\<`TResult`\> | The function that runs the query. |
+## Returns
+[`IRepositoryQuery`](Interface.IRepositoryQuery)\<`TDelegate`, `TResult`\>
+The repository query.

package/data/packages/platform-database/api/Function.skip.md ADDED Viewed

@@ -0,0 +1,34 @@
+---
+title: 'Function: skip()'
+generated: true
+editUrl: false
+---
+# Function: skip()
+```ts
+function skip<T>(value): Exclude<T, undefined> | undefined;
+```
+Defined in: [types/Skip.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/types/Skip.ts#L9)
+Utility function that returns the provided value or `undefined` if the value is `undefined`.
+In Prisma 6+, passing `undefined` for a field in a query signals Prisma to skip that field.
+## Type Parameters
+| Type Parameter |
+| -------------- |
+| `T`            |
+## Parameters
+| Parameter | Type | Description         |
+| --------- | ---- | ------------------- |
+| `value`   | `T`  | The value to check. |
+## Returns
+`Exclude`\<`T`, `undefined`\> \| `undefined`
+The original value (excluding undefined) or `undefined` to skip the field.

package/data/packages/platform-database/api/Function.transactionalQuery.md ADDED Viewed

@@ -0,0 +1,32 @@
+---
+title: 'Function: transactionalQuery()'
+generated: true
+editUrl: false
+---
+# Function: transactionalQuery()
+```ts
+function transactionalQuery<TResult>(name, run): ITransactionalRepositoryQuery<TResult>;
+```
+Defined in: [repositories/queries/transactionalQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/transactionalQuery.ts#L11)
+Factory to create a transactional repository query.
+## Type Parameters
+| Type Parameter |
+| -------------- |
+| `TResult`      |
+## Parameters
+| Parameter | Type                             |
+| --------- | -------------------------------- |
+| `name`    | `string`                         |
+| `run`     | (`tx`) => `Promise`\<`TResult`\> |
+## Returns
+[`ITransactionalRepositoryQuery`](Interface.ITransactionalRepositoryQuery)\<`TResult`\>

package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Interface: IDatabaseModuleConfig
 Defined in: [DatabaseModule.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L17)

package/data/packages/platform-database/api/Interface.IPaginateOptions.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Interface: IPaginateOptions
 Defined in: [features/Pagination.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L13)

package/data/packages/platform-database/api/Interface.IPaginatedResult.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Interface: IPaginatedResult\<T\>
 Defined in: [features/Pagination.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L1)

package/data/packages/platform-database/api/Interface.IRepositoryQuery.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Interface: IRepositoryQuery\<TDelegate, TResult\>
 Defined in: [repositories/queries/IRepositoryQuery.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/IRepositoryQuery.ts#L9)

package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Interface: ITransactionalRepositoryQuery\<TResult\>
 Defined in: [repositories/queries/ITransactionalRepositoryQuery.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/ITransactionalRepositoryQuery.ts#L12)

package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Type Alias: DelegateArgs\<T\>
 ```ts

package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Type Alias: DelegateReturnTypes\<T\>
 ```ts

package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Type Alias: PaginateFunction
 ```ts

package/data/packages/platform-database/api/TypeAlias.QueryResultType.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Type Alias: QueryResultType\<T\>
 ```ts

package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # Type Alias: TransactionalQueryResultType\<T\>
 ```ts

package/data/packages/platform-database/api/index.md CHANGED Viewed

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
-[**@breadstone/archipel-platform-database**](../)
----
 # @breadstone/archipel-platform-database
 ## Classes
@@ -43,141 +39,10 @@ editUrl: false
 ## Functions
-### pageable()
-```ts
-function pageable<TEntity>(items, total, skip, take?): IPageableCollection<TEntity>;
-```
-Defined in: [models/entities/IPageableEntityCollection.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/models/entities/IPageableEntityCollection.ts#L13)
-#### Type Parameters
-| Type Parameter |
-| -------------- |
-| `TEntity`      |
-#### Parameters
-| Parameter | Type        |
-| --------- | ----------- |
-| `items`   | `TEntity`[] |
-| `total`   | `number`    |
-| `skip`    | `number`    |
-| `take?`   | `number`    |
-#### Returns
-`IPageableCollection`\<`TEntity`\>
----
-### paginator()
-```ts
-function paginator(defaultOptions): PaginateFunction;
-```
-Defined in: [features/Pagination.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L19)
-#### Parameters
-| Parameter        | Type                                             |
-| ---------------- | ------------------------------------------------ |
-| `defaultOptions` | [`IPaginateOptions`](Interface.IPaginateOptions) |
-#### Returns
-[`PaginateFunction`](TypeAlias.PaginateFunction)
----
-### query()
-```ts
-function query<TDelegate, TResult>(name, run): IRepositoryQuery<TDelegate, TResult>;
-```
-Defined in: [repositories/queries/query.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/query.ts#L15)
-Creates a new repository query.
-#### Type Parameters
-| Type Parameter |
-| -------------- |
-| `TDelegate`    |
-| `TResult`      |
-#### Parameters
-| Parameter | Type                                | Description                       |
-| --------- | ----------------------------------- | --------------------------------- |
-| `name`    | `string`                            | The name of the query.            |
-| `run`     | (`model`) => `Promise`\<`TResult`\> | The function that runs the query. |
-#### Returns
-[`IRepositoryQuery`](Interface.IRepositoryQuery)\<`TDelegate`, `TResult`\>
-The repository query.
----
-### skip()
-```ts
-function skip<T>(value): Exclude<T, undefined> | undefined;
-```
-Defined in: [types/Skip.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/types/Skip.ts#L9)
-Utility function that returns the provided value or `undefined` if the value is `undefined`.
-In Prisma 6+, passing `undefined` for a field in a query signals Prisma to skip that field.
-#### Type Parameters
-| Type Parameter |
-| -------------- |
-| `T`            |
-#### Parameters
-| Parameter | Type | Description         |
-| --------- | ---- | ------------------- |
-| `value`   | `T`  | The value to check. |
-#### Returns
-`Exclude`\<`T`, `undefined`\> \| `undefined`
-The original value (excluding undefined) or `undefined` to skip the field.
----
-### transactionalQuery()
-```ts
-function transactionalQuery<TResult>(name, run): ITransactionalRepositoryQuery<TResult>;
-```
-Defined in: [repositories/queries/transactionalQuery.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/transactionalQuery.ts#L11)
-Factory to create a transactional repository query.
-#### Type Parameters
-| Type Parameter |
-| -------------- |
-| `TResult`      |
-#### Parameters
-| Parameter | Type                             |
-| --------- | -------------------------------- |
-| `name`    | `string`                         |
-| `run`     | (`tx`) => `Promise`\<`TResult`\> |
-#### Returns
-[`ITransactionalRepositoryQuery`](Interface.ITransactionalRepositoryQuery)\<`TResult`\>
+| Function                                          | Description                                                                                                                                                                              |
+| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [pageable](Function.pageable)                     | -                                                                                                                                                                                        |
+| [paginator](Function.paginator)                   | -                                                                                                                                                                                        |
+| [query](Function.query)                           | Creates a new repository query.                                                                                                                                                          |
+| [skip](Function.skip)                             | Utility function that returns the provided value or `undefined` if the value is `undefined`. In Prisma 6+, passing `undefined` for a field in a query signals Prisma to skip that field. |
+| [transactionalQuery](Function.transactionalQuery) | Factory to create a transactional repository query.                                                                                                                                      |

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

@@ -4,10 +4,6 @@ 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)
@@ -50,6 +46,113 @@ Defined in: [renderer/abstracts/BaseDocumentRenderer.ts:29](https://github.com/R
 `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 +179,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

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

@@ -4,10 +4,6 @@ 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)

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

@@ -4,10 +4,6 @@ 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)

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

@@ -4,10 +4,6 @@ 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)

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

@@ -4,10 +4,6 @@ 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)