npm - @breadstone/archipel-mcp - Versions diffs - 0.0.11 → 0.0.14 - Mend

@breadstone/archipel-mcp 0.0.11 → 0.0.14

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

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

@@ -1,586 +0,0 @@
----
-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: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`\>
-## 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()
-```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.
-***
-### 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()
-```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 DELETED Viewed

@@ -1,55 +0,0 @@
----
-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.pageable.md DELETED Viewed

@@ -1,35 +0,0 @@
----
-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 DELETED Viewed

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