@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,82 @@
+---
+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)
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+## Properties
+
+### data
+
+```ts
+data: T[];
+```
+
+Defined in: [features/Pagination.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L2)
+
+---
+
+### meta
+
+```ts
+meta: {
+  currentPage: number;
+  lastPage: number;
+  next: number | null;
+  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)
+
+#### currentPage
+
+```ts
+currentPage: number;
+```
+
+#### lastPage
+
+```ts
+lastPage: number;
+```
+
+#### next
+
+```ts
+next: number | null;
+```
+
+#### perPage
+
+```ts
+perPage: number;
+```
+
+#### prev
+
+```ts
+prev: number | null;
+```
+
+#### total
+
+```ts
+total: number;
+```

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

@@ -0,0 +1,56 @@
+---
+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)
+
+Represents a reusable query definition for repositories.
+
+## Type Parameters
+
+| Type Parameter | Description               |
+| -------------- | ------------------------- |
+| `TDelegate`    | The Prisma delegate type. |
+| `TResult`      | The query result type.    |
+
+## Properties
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [repositories/queries/IRepositoryQuery.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/IRepositoryQuery.ts#L16)
+
+The identifier used for logging.
+
+## Methods
+
+### run()
+
+```ts
+run(model): Promise<TResult>;
+```
+
+Defined in: [repositories/queries/IRepositoryQuery.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/IRepositoryQuery.ts#L27)
+
+Executes the query against the provided model.
+
+#### Parameters
+
+| Parameter | Type        | Description          |
+| --------- | ----------- | -------------------- |
+| `model`   | `TDelegate` | The Prisma delegate. |
+
+#### Returns
+
+`Promise`\<`TResult`\>

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

@@ -0,0 +1,55 @@
+---
+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)
+
+Represents a repository query that requires a Prisma TransactionClient to access multiple delegates.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TResult`      |
+
+## Properties
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [repositories/queries/ITransactionalRepositoryQuery.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/ITransactionalRepositoryQuery.ts#L17)
+
+Identifier used for logging.
+
+## Methods
+
+### run()
+
+```ts
+run(tx): Promise<TResult>;
+```
+
+Defined in: [repositories/queries/ITransactionalRepositoryQuery.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/ITransactionalRepositoryQuery.ts#L28)
+
+Executes the query with an active transaction client.
+
+#### Parameters
+
+| Parameter | Type  | Description                |
+| --------- | ----- | -------------------------- |
+| `tx`      | `any` | Prisma transaction client. |
+
+#### Returns
+
+`Promise`\<`TResult`\>

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

@@ -0,0 +1,23 @@
+---
+title: 'Type Alias: DelegateArgs\<T\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Type Alias: DelegateArgs\<T\>
+
+```ts
+type DelegateArgs<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<unknown> ? A : never };
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:333](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L333)
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |

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

@@ -0,0 +1,23 @@
+---
+title: 'Type Alias: DelegateReturnTypes\<T\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Type Alias: DelegateReturnTypes\<T\>
+
+```ts
+type DelegateReturnTypes<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<infer R> ? R : never };
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:340](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L340)
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |

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

@@ -0,0 +1,36 @@
+---
+title: 'Type Alias: PaginateFunction'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Type Alias: PaginateFunction
+
+```ts
+type PaginateFunction = <T, K>(model, args?, options?) => Promise<IPaginatedResult<T>>;
+```
+
+Defined in: [features/Pagination.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L17)
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+| `K`            |
+
+## Parameters
+
+| Parameter  | Type                                             |
+| ---------- | ------------------------------------------------ |
+| `model`    | `any`                                            |
+| `args?`    | `K`                                              |
+| `options?` | [`IPaginateOptions`](Interface.IPaginateOptions) |
+
+## Returns
+
+`Promise`\<[`IPaginatedResult`](Interface.IPaginatedResult)\<`T`\>\>

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

@@ -0,0 +1,32 @@
+---
+title: 'Type Alias: QueryResultType\<T\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Type Alias: QueryResultType\<T\>
+
+```ts
+type QueryResultType<T> = T extends IRepositoryQuery<unknown, infer R> ? R : never;
+```
+
+Defined in: [repositories/queries/IRepositoryQuery.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/IRepositoryQuery.ts#L45)
+
+Extracts the result type from a repository query.
+Useful for type-safe mapping without duplicating query result types.
+
+## Type Parameters
+
+| Type Parameter | Description                |
+| -------------- | -------------------------- |
+| `T`            | The repository query type. |
+
+## Example
+
+```typescript
+type UserProfileResult = QueryResultType<ReturnType<typeof createUserProfileQuery>>;
+```

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

@@ -0,0 +1,31 @@
+---
+title: 'Type Alias: TransactionalQueryResultType\<T\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Type Alias: TransactionalQueryResultType\<T\>
+
+```ts
+type TransactionalQueryResultType<T> = T extends ITransactionalRepositoryQuery<infer R> ? R : never;
+```
+
+Defined in: [repositories/queries/ITransactionalRepositoryQuery.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/queries/ITransactionalRepositoryQuery.ts#L44)
+
+Extracts the result type from a transactional repository query.
+
+## Type Parameters
+
+| Type Parameter | Description                              |
+| -------------- | ---------------------------------------- |
+| `T`            | The transactional repository query type. |
+
+## Example
+
+```typescript
+type ConversationResult = TransactionalQueryResultType<ReturnType<typeof createConversationQuery>>;
+```

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

@@ -0,0 +1,183 @@
+---
+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.           |
+| [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.                                             |
+| [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.                                                        |
+
+## 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`\>