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

@breadstone/archipel-mcp 0.0.1 → 0.0.2

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 (548) hide show

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

@@ -3,11 +3,6 @@ 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)
@@ -16,12 +11,12 @@ 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`    |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TDelegate` *extends* `Record`\<`RepositoryOperations`, (`args`) => `Promise`\<`any`\>\> | - |
+| `TArgs` *extends* `Record`\<`RepositoryOperations`, `unknown`\> | - |
+| `TReturn` *extends* `Record`\<`RepositoryOperations`, `unknown`\> | - |
+| `TEntity` | `unknown` |
 ## Constructors
@@ -35,15 +30,50 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:44](https://github.com/Rue
 #### Parameters
-| Parameter | Type                                       |
-| --------- | ------------------------------------------ |
-| `db`      | [`DatabaseService`](Class.DatabaseService) |
-| `model`   | `TDelegate`                                |
+| 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:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L67)
+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:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L57)
+##### Returns
+`TDelegate`
 ## Methods
 ### aggregate()
@@ -58,15 +88,15 @@ Performs aggregation operations on the records.
 #### Type Parameters
-| Type Parameter | Default type               |
-| -------------- | -------------------------- |
-| `TResult`      | `TReturn`\[`"aggregate"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"aggregate"`\] |
 #### Parameters
-| Parameter | Type                     | Description                               |
-| --------- | ------------------------ | ----------------------------------------- |
-| `args`    | `TArgs`\[`"aggregate"`\] | The arguments to perform the aggregation. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"aggregate"`\] | The arguments to perform the aggregation. |
 #### Returns
@@ -74,7 +104,7 @@ Performs aggregation operations on the records.
 The aggregation result.
----
+***
 ### count()
@@ -88,15 +118,15 @@ Counts the number of records that match the criteria.
 #### Type Parameters
-| Type Parameter | Default type           |
-| -------------- | ---------------------- |
-| `TResult`      | `TReturn`\[`"count"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"count"`\] |
 #### Parameters
-| Parameter | Type                 | Description                         |
-| --------- | -------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"count"`\] | The arguments to count the records. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"count"`\] | The arguments to count the records. |
 #### Returns
@@ -104,7 +134,7 @@ Counts the number of records that match the criteria.
 The count of matching records.
----
+***
 ### create()
@@ -118,15 +148,15 @@ Creates a new record.
 #### Type Parameters
-| Type Parameter | Default type            |
-| -------------- | ----------------------- |
-| `TResult`      | `TReturn`\[`"create"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"create"`\] |
 #### Parameters
-| Parameter | Type                  | Description                         |
-| --------- | --------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"create"`\] | The arguments to create the record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"create"`\] | The arguments to create the record. |
 #### Returns
@@ -134,7 +164,7 @@ Creates a new record.
 The created record.
----
+***
 ### createMany()
@@ -148,15 +178,15 @@ Creates multiple records.
 #### Type Parameters
-| Type Parameter | Default type                |
-| -------------- | --------------------------- |
-| `TResult`      | `TReturn`\[`"createMany"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"createMany"`\] |
 #### Parameters
-| Parameter | Type                      | Description                          |
-| --------- | ------------------------- | ------------------------------------ |
-| `args`    | `TArgs`\[`"createMany"`\] | The arguments to create the records. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"createMany"`\] | The arguments to create the records. |
 #### Returns
@@ -164,7 +194,7 @@ Creates multiple records.
 The created records.
----
+***
 ### delete()
@@ -178,15 +208,15 @@ Deletes a record by its identifier.
 #### Type Parameters
-| Type Parameter | Default type            |
-| -------------- | ----------------------- |
-| `TResult`      | `TReturn`\[`"delete"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"delete"`\] |
 #### Parameters
-| Parameter | Type                  | Description                         |
-| --------- | --------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"delete"`\] | The arguments to delete the record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"delete"`\] | The arguments to delete the record. |
 #### Returns
@@ -194,7 +224,7 @@ Deletes a record by its identifier.
 The deleted record.
----
+***
 ### deleteMany()
@@ -208,15 +238,15 @@ Deletes multiple records by their identifiers.
 #### Type Parameters
-| Type Parameter | Default type                |
-| -------------- | --------------------------- |
-| `TResult`      | `TReturn`\[`"deleteMany"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"deleteMany"`\] |
 #### Parameters
-| Parameter | Type                      | Description                          |
-| --------- | ------------------------- | ------------------------------------ |
-| `args`    | `TArgs`\[`"deleteMany"`\] | The arguments to delete the records. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"deleteMany"`\] | The arguments to delete the records. |
 #### Returns
@@ -224,7 +254,7 @@ Deletes multiple records by their identifiers.
 The deleted records.
----
+***
 ### execute()
@@ -239,14 +269,14 @@ Executes a predefined query against the underlying model.
 #### Type Parameters
 | Type Parameter |
-| -------------- |
-| `TResult`      |
+| ------ |
+| `TResult` |
 #### Parameters
-| Parameter | Type                                                                       | Description                      |
-| --------- | -------------------------------------------------------------------------- | -------------------------------- |
-| `query`   | [`IRepositoryQuery`](Interface.IRepositoryQuery)\<`TDelegate`, `TResult`\> | The query definition to execute. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `query` | [`IRepositoryQuery`](Interface.IRepositoryQuery)\<`TDelegate`, `TResult`\> | The query definition to execute. |
 #### Returns
@@ -254,7 +284,7 @@ Executes a predefined query against the underlying model.
 The query result.
----
+***
 ### executeTransactional()
@@ -269,14 +299,14 @@ Executes a transactional query providing a Prisma TransactionClient for multi-mo
 #### Type Parameters
 | Type Parameter |
-| -------------- |
-| `TResult`      |
+| ------ |
+| `TResult` |
 #### Parameters
-| Parameter | Type                                                                                    | Description                                    |
-| --------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- |
-| `query`   | [`ITransactionalRepositoryQuery`](Interface.ITransactionalRepositoryQuery)\<`TResult`\> | The transactional query definition to execute. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `query` | [`ITransactionalRepositoryQuery`](Interface.ITransactionalRepositoryQuery)\<`TResult`\> | The transactional query definition to execute. |
 #### Returns
@@ -284,7 +314,7 @@ Executes a transactional query providing a Prisma TransactionClient for multi-mo
 The query result.
----
+***
 ### findFirst()
@@ -298,15 +328,15 @@ Finds the first record that matches the criteria.
 #### Type Parameters
-| Type Parameter | Default type               |
-| -------------- | -------------------------- |
-| `TResult`      | `TReturn`\[`"findFirst"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"findFirst"`\] |
 #### Parameters
-| Parameter | Type                     | Description                             |
-| --------- | ------------------------ | --------------------------------------- |
-| `args`    | `TArgs`\[`"findFirst"`\] | The arguments to find the first record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"findFirst"`\] | The arguments to find the first record. |
 #### Returns
@@ -314,7 +344,7 @@ Finds the first record that matches the criteria.
 The found record or null if not found.
----
+***
 ### findMany()
@@ -328,16 +358,16 @@ Finds multiple records with optional pagination.
 #### Type Parameters
-| Type Parameter | Default type              |
-| -------------- | ------------------------- |
-| `TResult`      | `TReturn`\[`"findMany"`\] |
+| 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.            |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args?` | `TArgs`\[`"findMany"`\] | The arguments to find the records. |
+| `page?` | `Required`\<[`IPaginateOptions`](Interface.IPaginateOptions)\> | The pagination options. |
 #### Returns
@@ -345,7 +375,7 @@ Finds multiple records with optional pagination.
 The found records.
----
+***
 ### findUnique()
@@ -359,15 +389,15 @@ Finds a unique record by its identifier.
 #### Type Parameters
-| Type Parameter | Default type                |
-| -------------- | --------------------------- |
-| `TResult`      | `TReturn`\[`"findUnique"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"findUnique"`\] |
 #### Parameters
-| Parameter | Type                      | Description                              |
-| --------- | ------------------------- | ---------------------------------------- |
-| `args`    | `TArgs`\[`"findUnique"`\] | The arguments to find the unique record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"findUnique"`\] | The arguments to find the unique record. |
 #### Returns
@@ -375,7 +405,7 @@ Finds a unique record by its identifier.
 The found record or null if not found.
----
+***
 ### groupBy()
@@ -389,15 +419,15 @@ Groups records by specified fields and performs aggregations.
 #### Type Parameters
-| Type Parameter | Default type             |
-| -------------- | ------------------------ |
-| `TResult`      | `TReturn`\[`"groupBy"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"groupBy"`\] |
 #### Parameters
-| Parameter | Type                   | Description                         |
-| --------- | ---------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"groupBy"`\] | The arguments to group the records. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"groupBy"`\] | The arguments to group the records. |
 #### Returns
@@ -405,7 +435,7 @@ Groups records by specified fields and performs aggregations.
 The grouped records with aggregations.
----
+***
 ### merge()
@@ -419,15 +449,15 @@ Merges the given `data` with the user identified by the `id`.
 #### Type Parameters
-| Type Parameter | Default type            |
-| -------------- | ----------------------- |
-| `TResult`      | `TReturn`\[`"update"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"update"`\] |
 #### Parameters
-| Parameter | Type                                           |
-| --------- | ---------------------------------------------- |
-| `entity`  | `Partial`\<`TEntity`\> & \{ `id`: `string`; \} |
+| Parameter | Type |
+| ------ | ------ |
+| `entity` | `Partial`\<`TEntity`\> & \{ `id`: `string`; \} |
 #### Returns
@@ -435,7 +465,37 @@ Merges the given `data` with the user identified by the `id`.
 The merged data.
----
+***
+### tryCatch()
+```ts
+protected tryCatch<T>(promise): Promise<T>;
+```
+Defined in: [repositories/abstracts/RepositoryBase.ts:302](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L302)
+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()
@@ -449,15 +509,15 @@ Updates an existing record.
 #### Type Parameters
-| Type Parameter | Default type            |
-| -------------- | ----------------------- |
-| `TResult`      | `TReturn`\[`"update"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"update"`\] |
 #### Parameters
-| Parameter | Type                  | Description                         |
-| --------- | --------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"update"`\] | The arguments to update the record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"update"`\] | The arguments to update the record. |
 #### Returns
@@ -465,7 +525,7 @@ Updates an existing record.
 The updated record.
----
+***
 ### updateMany()
@@ -479,15 +539,15 @@ Updates multiple existing records.
 #### Type Parameters
-| Type Parameter | Default type                |
-| -------------- | --------------------------- |
-| `TResult`      | `TReturn`\[`"updateMany"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"updateMany"`\] |
 #### Parameters
-| Parameter | Type                      | Description                          |
-| --------- | ------------------------- | ------------------------------------ |
-| `args`    | `TArgs`\[`"updateMany"`\] | The arguments to update the records. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"updateMany"`\] | The arguments to update the records. |
 #### Returns
@@ -495,7 +555,7 @@ Updates multiple existing records.
 The updated records.
----
+***
 ### upsert()
@@ -509,15 +569,15 @@ Creates or updates a record based on its existence.
 #### Type Parameters
-| Type Parameter | Default type            |
-| -------------- | ----------------------- |
-| `TResult`      | `TReturn`\[`"upsert"`\] |
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TResult` | `TReturn`\[`"upsert"`\] |
 #### Parameters
-| Parameter | Type                  | Description                         |
-| --------- | --------------------- | ----------------------------------- |
-| `args`    | `TArgs`\[`"upsert"`\] | The arguments to upsert the record. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `TArgs`\[`"upsert"`\] | The arguments to upsert the record. |
 #### Returns

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

@@ -3,11 +3,6 @@ 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)
@@ -44,10 +39,10 @@ Catches the exception.
 #### Parameters
-| Parameter    | Type              | Description |
-| ------------ | ----------------- | ----------- |
-| `_exception` | `RepositoryError` | -           |
-| `host`       | `ArgumentsHost`   | The host.   |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `_exception` | `RepositoryError` | - |
+| `host` | `ArgumentsHost` | The host. |
 #### Returns
@@ -56,5 +51,5 @@ Catches the exception.
 #### Implementation of
 ```ts
-ExceptionFilter.catch;
+ExceptionFilter.catch
 ```

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

@@ -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`\>

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

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