@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-database/api/Class.RepositoryBase.md

@@ -0,0 +1,526 @@
+---
+title: 'Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L27)
+
+The base class for all repositories.
+
+## Type Parameters
+
+| Type Parameter                                                                           | Default type |
+| ---------------------------------------------------------------------------------------- | ------------ |
+| `TDelegate` _extends_ `Record`\<`RepositoryOperations`, (`args`) => `Promise`\<`any`\>\> | -            |
+| `TArgs` _extends_ `Record`\<`RepositoryOperations`, `unknown`\>                          | -            |
+| `TReturn` _extends_ `Record`\<`RepositoryOperations`, `unknown`\>                        | -            |
+| `TEntity`                                                                                | `unknown`    |
+
+## Constructors
+
+### Constructor
+
+```ts
+new RepositoryBase<TDelegate, TArgs, TReturn, TEntity>(db, model): RepositoryBase<TDelegate, TArgs, TReturn, TEntity>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L44)
+
+#### Parameters
+
+| Parameter | Type                                       |
+| --------- | ------------------------------------------ |
+| `db`      | [`DatabaseService`](Class.DatabaseService) |
+| `model`   | `TDelegate`                                |
+
+#### Returns
+
+`RepositoryBase`\<`TDelegate`, `TArgs`, `TReturn`, `TEntity`\>
+
+## Methods
+
+### aggregate()
+
+```ts
+aggregate<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:232](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L232)
+
+Performs aggregation operations on the records.
+
+#### Type Parameters
+
+| Type Parameter | Default type               |
+| -------------- | -------------------------- |
+| `TResult`      | `TReturn`\[`"aggregate"`\] |
+
+#### Parameters
+
+| Parameter | Type                     | Description                               |
+| --------- | ------------------------ | ----------------------------------------- |
+| `args`    | `TArgs`\[`"aggregate"`\] | The arguments to perform the aggregation. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The aggregation result.
+
+---
+
+### count()
+
+```ts
+count<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:244](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L244)
+
+Counts the number of records that match the criteria.
+
+#### Type Parameters
+
+| Type Parameter | Default type           |
+| -------------- | ---------------------- |
+| `TResult`      | `TReturn`\[`"count"`\] |
+
+#### Parameters
+
+| Parameter | Type                 | Description                         |
+| --------- | -------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"count"`\] | The arguments to count the records. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The count of matching records.
+
+---
+
+### create()
+
+```ts
+create<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:148](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L148)
+
+Creates a new record.
+
+#### Type Parameters
+
+| Type Parameter | Default type            |
+| -------------- | ----------------------- |
+| `TResult`      | `TReturn`\[`"create"`\] |
+
+#### Parameters
+
+| Parameter | Type                  | Description                         |
+| --------- | --------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"create"`\] | The arguments to create the record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The created record.
+
+---
+
+### createMany()
+
+```ts
+createMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L160)
+
+Creates multiple records.
+
+#### Type Parameters
+
+| Type Parameter | Default type                |
+| -------------- | --------------------------- |
+| `TResult`      | `TReturn`\[`"createMany"`\] |
+
+#### Parameters
+
+| Parameter | Type                      | Description                          |
+| --------- | ------------------------- | ------------------------------------ |
+| `args`    | `TArgs`\[`"createMany"`\] | The arguments to create the records. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The created records.
+
+---
+
+### delete()
+
+```ts
+delete<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:208](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L208)
+
+Deletes a record by its identifier.
+
+#### Type Parameters
+
+| Type Parameter | Default type            |
+| -------------- | ----------------------- |
+| `TResult`      | `TReturn`\[`"delete"`\] |
+
+#### Parameters
+
+| Parameter | Type                  | Description                         |
+| --------- | --------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"delete"`\] | The arguments to delete the record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The deleted record.
+
+---
+
+### deleteMany()
+
+```ts
+deleteMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:220](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L220)
+
+Deletes multiple records by their identifiers.
+
+#### Type Parameters
+
+| Type Parameter | Default type                |
+| -------------- | --------------------------- |
+| `TResult`      | `TReturn`\[`"deleteMany"`\] |
+
+#### Parameters
+
+| Parameter | Type                      | Description                          |
+| --------- | ------------------------- | ------------------------------------ |
+| `args`    | `TArgs`\[`"deleteMany"`\] | The arguments to delete the records. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The deleted records.
+
+---
+
+### execute()
+
+```ts
+execute<TResult>(query): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L82)
+
+Executes a predefined query against the underlying model.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TResult`      |
+
+#### Parameters
+
+| Parameter | Type                                                                       | Description                      |
+| --------- | -------------------------------------------------------------------------- | -------------------------------- |
+| `query`   | [`IRepositoryQuery`](Interface.IRepositoryQuery)\<`TDelegate`, `TResult`\> | The query definition to execute. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The query result.
+
+---
+
+### executeTransactional()
+
+```ts
+executeTransactional<TResult>(query): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L94)
+
+Executes a transactional query providing a Prisma TransactionClient for multi-model work.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TResult`      |
+
+#### Parameters
+
+| Parameter | Type                                                                                    | Description                                    |
+| --------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| `query`   | [`ITransactionalRepositoryQuery`](Interface.ITransactionalRepositoryQuery)\<`TResult`\> | The transactional query definition to execute. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The query result.
+
+---
+
+### findFirst()
+
+```ts
+findFirst<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:136](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L136)
+
+Finds the first record that matches the criteria.
+
+#### Type Parameters
+
+| Type Parameter | Default type               |
+| -------------- | -------------------------- |
+| `TResult`      | `TReturn`\[`"findFirst"`\] |
+
+#### Parameters
+
+| Parameter | Type                     | Description                             |
+| --------- | ------------------------ | --------------------------------------- |
+| `args`    | `TArgs`\[`"findFirst"`\] | The arguments to find the first record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The found record or null if not found.
+
+---
+
+### findMany()
+
+```ts
+findMany<TResult>(args?, page?): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:119](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L119)
+
+Finds multiple records with optional pagination.
+
+#### Type Parameters
+
+| Type Parameter | Default type              |
+| -------------- | ------------------------- |
+| `TResult`      | `TReturn`\[`"findMany"`\] |
+
+#### Parameters
+
+| Parameter | Type                                                           | Description                        |
+| --------- | -------------------------------------------------------------- | ---------------------------------- |
+| `args?`   | `TArgs`\[`"findMany"`\]                                        | The arguments to find the records. |
+| `page?`   | `Required`\<[`IPaginateOptions`](Interface.IPaginateOptions)\> | The pagination options.            |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The found records.
+
+---
+
+### findUnique()
+
+```ts
+findUnique<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L106)
+
+Finds a unique record by its identifier.
+
+#### Type Parameters
+
+| Type Parameter | Default type                |
+| -------------- | --------------------------- |
+| `TResult`      | `TReturn`\[`"findUnique"`\] |
+
+#### Parameters
+
+| Parameter | Type                      | Description                              |
+| --------- | ------------------------- | ---------------------------------------- |
+| `args`    | `TArgs`\[`"findUnique"`\] | The arguments to find the unique record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The found record or null if not found.
+
+---
+
+### groupBy()
+
+```ts
+groupBy<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:256](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L256)
+
+Groups records by specified fields and performs aggregations.
+
+#### Type Parameters
+
+| Type Parameter | Default type             |
+| -------------- | ------------------------ |
+| `TResult`      | `TReturn`\[`"groupBy"`\] |
+
+#### Parameters
+
+| Parameter | Type                   | Description                         |
+| --------- | ---------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"groupBy"`\] | The arguments to group the records. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The grouped records with aggregations.
+
+---
+
+### merge()
+
+```ts
+merge<TResult>(entity): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:268](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L268)
+
+Merges the given `data` with the user identified by the `id`.
+
+#### Type Parameters
+
+| Type Parameter | Default type            |
+| -------------- | ----------------------- |
+| `TResult`      | `TReturn`\[`"update"`\] |
+
+#### Parameters
+
+| Parameter | Type                                           |
+| --------- | ---------------------------------------------- |
+| `entity`  | `Partial`\<`TEntity`\> & \{ `id`: `string`; \} |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The merged data.
+
+---
+
+### update()
+
+```ts
+update<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:172](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L172)
+
+Updates an existing record.
+
+#### Type Parameters
+
+| Type Parameter | Default type            |
+| -------------- | ----------------------- |
+| `TResult`      | `TReturn`\[`"update"`\] |
+
+#### Parameters
+
+| Parameter | Type                  | Description                         |
+| --------- | --------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"update"`\] | The arguments to update the record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The updated record.
+
+---
+
+### updateMany()
+
+```ts
+updateMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:184](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L184)
+
+Updates multiple existing records.
+
+#### Type Parameters
+
+| Type Parameter | Default type                |
+| -------------- | --------------------------- |
+| `TResult`      | `TReturn`\[`"updateMany"`\] |
+
+#### Parameters
+
+| Parameter | Type                      | Description                          |
+| --------- | ------------------------- | ------------------------------------ |
+| `args`    | `TArgs`\[`"updateMany"`\] | The arguments to update the records. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The updated records.
+
+---
+
+### upsert()
+
+```ts
+upsert<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:196](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L196)
+
+Creates or updates a record based on its existence.
+
+#### Type Parameters
+
+| Type Parameter | Default type            |
+| -------------- | ----------------------- |
+| `TResult`      | `TReturn`\[`"upsert"`\] |
+
+#### Parameters
+
+| Parameter | Type                  | Description                         |
+| --------- | --------------------- | ----------------------------------- |
+| `args`    | `TArgs`\[`"upsert"`\] | The arguments to upsert the record. |
+
+#### Returns
+
+`Promise`\<`TResult`\>
+
+The created or updated record.

package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md

@@ -0,0 +1,60 @@
+---
+title: 'Class: RepositoryExceptionFilter'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-database**](../)
+
+---
+
+# Class: RepositoryExceptionFilter
+
+Defined in: [filters/RepositoryExceptionFilter.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/filters/RepositoryExceptionFilter.ts#L15)
+
+Represents the Prisma client exception filter.
+
+## Implements
+
+- `ExceptionFilter`\<`RepositoryError`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new RepositoryExceptionFilter(): RepositoryExceptionFilter;
+```
+
+#### Returns
+
+`RepositoryExceptionFilter`
+
+## Methods
+
+### catch()
+
+```ts
+catch(_exception, host): void;
+```
+
+Defined in: [filters/RepositoryExceptionFilter.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/filters/RepositoryExceptionFilter.ts#L26)
+
+Catches the exception.
+
+#### Parameters
+
+| Parameter    | Type              | Description |
+| ------------ | ----------------- | ----------- |
+| `_exception` | `RepositoryError` | -           |
+| `host`       | `ArgumentsHost`   | The host.   |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+ExceptionFilter.catch;
+```

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

@@ -0,0 +1,27 @@
+---
+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)
+
+Represents the database module configuration.
+
+## Properties
+
+### middlewares?
+
+```ts
+optional middlewares?: unknown[];
+```
+
+Defined in: [DatabaseModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L19)
+
+Future extension point for Prisma middlewares

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

@@ -0,0 +1,33 @@
+---
+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)
+
+## Properties
+
+### page?
+
+```ts
+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?
+
+```ts
+optional perPage?: string | number;
+```
+
+Defined in: [features/Pagination.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L15)