@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,590 @@
+---
+title: '~~Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>~~'
+generated: true
+editUrl: false
+---
+# ~~Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>~~
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L45)
+
+The base class for all repositories.
+
+## Deprecated
+
+Use `RepositoryBase2` instead. This class will be removed in a future major version.
+
+## 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:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L61)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `db` | [`DatabaseService`](Class.DatabaseService) |
+| `model` | `TDelegate` |
+
+#### Returns
+
+`RepositoryBase`\<`TDelegate`, `TArgs`, `TReturn`, `TEntity`\>
+
+## Accessors
+
+### ~~database~~
+
+#### Get Signature
+
+```ts
+get protected database(): DatabaseService;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L84)
+
+Provides access to the underlying DatabaseService for derived repositories.
+Only to be used for transactional orchestration that spans multiple models.
+
+##### Returns
+
+[`DatabaseService`](Class.DatabaseService)
+
+***
+
+### ~~model~~
+
+#### Get Signature
+
+```ts
+get protected model(): TDelegate;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L74)
+
+##### Returns
+
+`TDelegate`
+
+## Methods
+
+### ~~aggregate()~~
+
+```ts
+protected aggregate<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:254](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L254)
+
+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
+protected count<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:266](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L266)
+
+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
+protected create<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L170)
+
+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
+protected createMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L182)
+
+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
+protected delete<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:230](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L230)
+
+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
+protected deleteMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:242](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L242)
+
+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:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L99)
+
+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:111](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L111)
+
+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
+protected findFirst<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:158](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L158)
+
+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:136](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L136)
+
+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
+protected findUnique<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L123)
+
+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
+protected groupBy<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:278](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L278)
+
+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
+protected merge<TResult>(entity): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:290](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L290)
+
+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.
+
+***
+
+### ~~tryCatch()~~
+
+```ts
+protected tryCatch<T>(promise): Promise<T>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:324](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L324)
+
+Wraps a promise in a try-catch block to handle errors uniformly.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `promise` | `Promise`\<`T`\> | The promise to wrap. |
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The result of the promise or throws an error.
+
+***
+
+### ~~update()~~
+
+```ts
+protected update<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:194](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L194)
+
+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
+protected updateMany<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:206](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L206)
+
+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
+protected upsert<TResult>(args): Promise<TResult>;
+```
+
+Defined in: [repositories/abstracts/RepositoryBase.ts:218](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L218)
+
+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,55 @@
+---
+title: 'Class: RepositoryExceptionFilter'
+generated: true
+editUrl: false
+---
+# 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/Function.cursorPaginator.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: cursorPaginator()'
+generated: true
+editUrl: false
+---
+# Function: cursorPaginator()
+
+```ts
+function cursorPaginator(defaultOptions): CursorPaginateFunction;
+```
+
+Defined in: [features/CursorPagination.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/CursorPagination.ts#L50)
+
+Creates a cursor-based pagination function with the given default options.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `defaultOptions` | [`ICursorPaginateOptions`](Interface.ICursorPaginateOptions) | Default cursor pagination options. |
+
+## Returns
+
+[`CursorPaginateFunction`](TypeAlias.CursorPaginateFunction)
+
+A function that paginates using cursor-based strategy.

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

@@ -0,0 +1,35 @@
+---
+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`\>