@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

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

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

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

@@ -3,11 +3,6 @@ title: 'Interface: IDatabaseModuleConfig'
 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

@@ -3,11 +3,6 @@ title: 'Interface: IPaginateOptions'
 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)
@@ -22,7 +17,7 @@ optional page?: string | number;
 
 Defined in: [features/Pagination.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L14)
 
----
+***
 
 ### perPage?
 

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

@@ -3,11 +3,6 @@ title: 'Interface: IPaginatedResult\<T\>'
 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)
@@ -15,8 +10,8 @@ Defined in: [features/Pagination.ts:1](https://github.com/RueDeRennes/archipel/b
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |
 
 ## Properties
 
@@ -28,7 +23,7 @@ data: T[];
 
 Defined in: [features/Pagination.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L2)
 
----
+***
 
 ### meta
 
@@ -40,7 +35,7 @@ meta: {
   perPage: number;
   prev: number | null;
   total: number;
-}
+};
 ```
 
 Defined in: [features/Pagination.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L3)

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

@@ -3,11 +3,6 @@ title: 'Interface: IRepositoryQuery\<TDelegate, TResult\>'
 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)
@@ -16,10 +11,10 @@ Represents a reusable query definition for repositories.
 
 ## Type Parameters
 
-| Type Parameter | Description               |
-| -------------- | ------------------------- |
-| `TDelegate`    | The Prisma delegate type. |
-| `TResult`      | The query result type.    |
+| Type Parameter | Description |
+| ------ | ------ |
+| `TDelegate` | The Prisma delegate type. |
+| `TResult` | The query result type. |
 
 ## Properties
 
@@ -47,9 +42,9 @@ Executes the query against the provided model.
 
 #### Parameters
 
-| Parameter | Type        | Description          |
-| --------- | ----------- | -------------------- |
-| `model`   | `TDelegate` | The Prisma delegate. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `model` | `TDelegate` | The Prisma delegate. |
 
 #### Returns
 

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

@@ -3,11 +3,6 @@ title: 'Interface: ITransactionalRepositoryQuery\<TResult\>'
 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)
@@ -17,8 +12,8 @@ Represents a repository query that requires a Prisma TransactionClient to access
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `TResult`      |
+| ------ |
+| `TResult` |
 
 ## Properties
 
@@ -46,9 +41,9 @@ Executes the query with an active transaction client.
 
 #### Parameters
 
-| Parameter | Type  | Description                |
-| --------- | ----- | -------------------------- |
-| `tx`      | `any` | Prisma transaction client. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `tx` | `any` | Prisma transaction client. |
 
 #### Returns
 

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

@@ -3,11 +3,6 @@ title: 'Type Alias: DelegateArgs\<T\>'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # Type Alias: DelegateArgs\<T\>
 
 ```ts
@@ -19,5 +14,5 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:333](https://github.com/Ru
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |

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

@@ -3,11 +3,6 @@ title: 'Type Alias: DelegateReturnTypes\<T\>'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # Type Alias: DelegateReturnTypes\<T\>
 
 ```ts
@@ -19,5 +14,5 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:340](https://github.com/Ru
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
+| ------ |
+| `T` |

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

@@ -3,11 +3,6 @@ title: 'Type Alias: PaginateFunction'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # Type Alias: PaginateFunction
 
 ```ts
@@ -19,16 +14,16 @@ Defined in: [features/Pagination.ts:17](https://github.com/RueDeRennes/archipel/
 ## Type Parameters
 
 | Type Parameter |
-| -------------- |
-| `T`            |
-| `K`            |
+| ------ |
+| `T` |
+| `K` |
 
 ## Parameters
 
-| Parameter  | Type                                             |
-| ---------- | ------------------------------------------------ |
-| `model`    | `any`                                            |
-| `args?`    | `K`                                              |
+| Parameter | Type |
+| ------ | ------ |
+| `model` | `any` |
+| `args?` | `K` |
 | `options?` | [`IPaginateOptions`](Interface.IPaginateOptions) |
 
 ## Returns

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

@@ -3,11 +3,6 @@ title: 'Type Alias: QueryResultType\<T\>'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # Type Alias: QueryResultType\<T\>
 
 ```ts
@@ -21,9 +16,9 @@ Useful for type-safe mapping without duplicating query result types.
 
 ## Type Parameters
 
-| Type Parameter | Description                |
-| -------------- | -------------------------- |
-| `T`            | The repository query type. |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The repository query type. |
 
 ## Example
 

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

@@ -3,11 +3,6 @@ title: 'Type Alias: TransactionalQueryResultType\<T\>'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # Type Alias: TransactionalQueryResultType\<T\>
 
 ```ts
@@ -20,9 +15,9 @@ Extracts the result type from a transactional repository query.
 
 ## Type Parameters
 
-| Type Parameter | Description                              |
-| -------------- | ---------------------------------------- |
-| `T`            | The transactional repository query type. |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The transactional repository query type. |
 
 ## Example
 

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

@@ -3,181 +3,45 @@ title: '@breadstone/archipel-platform-database'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-database**](../)
-
----
-
 # @breadstone/archipel-platform-database
 
 ## Classes
 
-| Class                                                        | Description                                    |
-| ------------------------------------------------------------ | ---------------------------------------------- |
-| [DatabaseHealthIndicator](Class.DatabaseHealthIndicator)     | Health indicator for database connectivity.    |
-| [DatabaseModule](Class.DatabaseModule)                       | Represents the database module.                |
-| [DatabaseService](Class.DatabaseService)                     | Represents the database service.               |
-| [PrismaService](Class.PrismaService)                         | Represents the prisma service.                 |
-| [RepositoryBase](Class.RepositoryBase)                       | The base class for all repositories.           |
+| Class | Description |
+| ------ | ------ |
+| [DatabaseHealthIndicator](Class.DatabaseHealthIndicator) | Health indicator for database connectivity. |
+| [DatabaseModule](Class.DatabaseModule) | Represents the database module. |
+| [DatabaseService](Class.DatabaseService) | Represents the database service. |
+| [PrismaService](Class.PrismaService) | Represents the prisma service. |
+| [RepositoryBase](Class.RepositoryBase) | The base class for all repositories. |
 | [RepositoryExceptionFilter](Class.RepositoryExceptionFilter) | Represents the Prisma client exception filter. |
 
 ## Interfaces
 
-| Interface                                                                | Description                                                                                          |
-| ------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
-| [IDatabaseModuleConfig](Interface.IDatabaseModuleConfig)                 | Represents the database module configuration.                                                        |
-| [IPaginatedResult](Interface.IPaginatedResult)                           | -                                                                                                    |
-| [IPaginateOptions](Interface.IPaginateOptions)                           | -                                                                                                    |
-| [IRepositoryQuery](Interface.IRepositoryQuery)                           | Represents a reusable query definition for repositories.                                             |
+| Interface | Description |
+| ------ | ------ |
+| [IDatabaseModuleConfig](Interface.IDatabaseModuleConfig) | Represents the database module configuration. |
+| [IPaginatedResult](Interface.IPaginatedResult) | - |
+| [IPaginateOptions](Interface.IPaginateOptions) | - |
+| [IRepositoryQuery](Interface.IRepositoryQuery) | Represents a reusable query definition for repositories. |
 | [ITransactionalRepositoryQuery](Interface.ITransactionalRepositoryQuery) | Represents a repository query that requires a Prisma TransactionClient to access multiple delegates. |
 
 ## Type Aliases
 
-| Type Alias                                                             | Description                                                                                                            |
-| ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| [DelegateArgs](TypeAlias.DelegateArgs)                                 | -                                                                                                                      |
-| [DelegateReturnTypes](TypeAlias.DelegateReturnTypes)                   | -                                                                                                                      |
-| [PaginateFunction](TypeAlias.PaginateFunction)                         | -                                                                                                                      |
-| [QueryResultType](TypeAlias.QueryResultType)                           | Extracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types. |
-| [TransactionalQueryResultType](TypeAlias.TransactionalQueryResultType) | Extracts the result type from a transactional repository query.                                                        |
+| Type Alias | Description |
+| ------ | ------ |
+| [DelegateArgs](TypeAlias.DelegateArgs) | - |
+| [DelegateReturnTypes](TypeAlias.DelegateReturnTypes) | - |
+| [PaginateFunction](TypeAlias.PaginateFunction) | - |
+| [QueryResultType](TypeAlias.QueryResultType) | Extracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types. |
+| [TransactionalQueryResultType](TypeAlias.TransactionalQueryResultType) | Extracts the result type from a transactional repository query. |
 
 ## 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. |