@breadstone/archipel-mcp 0.0.25 → 0.0.27
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.
- package/data/guides/document-generation.md +17 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsHealthIndicator.md +4 -4
- package/data/packages/platform-authentication/api/Class.AuthenticationHealthIndicator.md +3 -3
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +4 -4
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +4 -4
- package/data/packages/platform-database/api/Class.RepositoryBase.md +124 -50
- package/data/packages/platform-database/api/Class.RepositoryBase2.md +181 -0
- package/data/packages/platform-database/api/Function.aggregate.md +33 -0
- package/data/packages/platform-database/api/Function.aggregateRaw.md +34 -0
- package/data/packages/platform-database/api/Function.count.md +33 -0
- package/data/packages/platform-database/api/Function.create.md +33 -0
- package/data/packages/platform-database/api/Function.createMany.md +33 -0
- package/data/packages/platform-database/api/Function.createManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.findFirst.md +35 -0
- package/data/packages/platform-database/api/Function.findFirstOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.findMany.md +32 -0
- package/data/packages/platform-database/api/Function.findManyPaged.md +34 -0
- package/data/packages/platform-database/api/Function.findRaw.md +34 -0
- package/data/packages/platform-database/api/Function.findUnique.md +32 -0
- package/data/packages/platform-database/api/Function.findUniqueOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.groupBy.md +33 -0
- package/data/packages/platform-database/api/Function.pipe.md +34 -0
- package/data/packages/platform-database/api/Function.pipeAll.md +35 -0
- package/data/packages/platform-database/api/Function.query2.md +35 -0
- package/data/packages/platform-database/api/Function.remove.md +33 -0
- package/data/packages/platform-database/api/Function.removeMany.md +33 -0
- package/data/packages/platform-database/api/Function.update.md +33 -0
- package/data/packages/platform-database/api/Function.updateMany.md +33 -0
- package/data/packages/platform-database/api/Function.updateManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.upsert.md +33 -0
- package/data/packages/platform-database/api/Interface.IRepositoryQuery2.md +45 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.DelegateOperations.md +29 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.RepositoryOperationsAll.md +19 -0
- package/data/packages/platform-database/api/TypeAlias.RepositoryOperationsBase.md +34 -0
- package/data/packages/platform-database/api/index.md +29 -1
- package/data/packages/platform-database/index.md +1 -1
- package/data/packages/platform-documents/index.md +14 -7
- package/data/packages/platform-esigning/api/Class.EsigningHealthIndicator.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -4
- package/data/packages/platform-mcp/api/Class.McpHealthIndicator.md +4 -4
- package/data/packages/platform-payments/api/Class.PaymentHealthIndicator.md +4 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryHealthIndicator.md +4 -4
- package/package.json +1 -1
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: pipeAll()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: pipeAll()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function pipeAll<D, R>(delegate, ...ops): Promise<R>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/pipe.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/pipe.ts#L22)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Sequentially executes multiple operators. The last result is returned.
|
|
17
|
+
Useful for multi-step dependent operations.
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
| Type Parameter | Description |
|
|
22
|
+
| ------ | ------ |
|
|
23
|
+
| `D` | Concrete delegate type (e.g. Prisma.UserDelegate) |
|
|
24
|
+
| `R` | Result type produced by the operator |
|
|
25
|
+
|
|
26
|
+
## Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `delegate` | `D` |
|
|
31
|
+
| ...`ops` | `QueryOperator`\<`D`, `unknown`\>[] |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<`R`\>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: query2()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: query2()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function query2<TDelegate, TRun, TResult>(name, run): IRepositoryQuery2<TDelegate, TRun>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/queries/query2.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/query2.ts#L15)
|
|
13
|
+
|
|
14
|
+
Creates a new repository query.
|
|
15
|
+
|
|
16
|
+
## Type Parameters
|
|
17
|
+
|
|
18
|
+
| Type Parameter |
|
|
19
|
+
| ------ |
|
|
20
|
+
| `TDelegate` |
|
|
21
|
+
| `TRun` *extends* (`delegate`) => `TResult` |
|
|
22
|
+
| `TResult` |
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| ------ | ------ | ------ |
|
|
28
|
+
| `name` | `string` | The name of the query. |
|
|
29
|
+
| `run` | `TRun` | The function that runs the query. |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
[`IRepositoryQuery2`](Interface.IRepositoryQuery2)\<`TDelegate`, `TRun`\>
|
|
34
|
+
|
|
35
|
+
The repository query.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: remove()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: remove()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function remove<D, A>(args): QueryOperator<D, ReturnType<D["delete"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/delete.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/delete.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Deletes a single record via the delegate `delete` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IDeleteDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma delete arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"delete"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: removeMany()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: removeMany()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function removeMany<D, A>(args): QueryOperator<D, ReturnType<D["deleteMany"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/deleteMany.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/deleteMany.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Deletes multiple records via the delegate `deleteMany` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IDeleteManyDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma deleteMany arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"deleteMany"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: update()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: update()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function update<D, A>(args): QueryOperator<D, ReturnType<D["update"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/update.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/update.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates a single record via the delegate `update` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpdateDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma update arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"update"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: updateMany()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: updateMany()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function updateMany<D, A>(args): QueryOperator<D, ReturnType<D["updateMany"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/updateMany.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/updateMany.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates multiple records via the delegate `updateMany` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpdateManyDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma updateMany arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"updateMany"`\]\>\>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: updateManyAndReturn()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: updateManyAndReturn()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function updateManyAndReturn<D, A>(args): QueryOperator<D, ReturnType<D["updateManyAndReturn"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/updateManyAndReturn.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/updateManyAndReturn.ts#L15)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates multiple records and returns them via the delegate `updateManyAndReturn` method.
|
|
17
|
+
|
|
18
|
+
**Provider support:** PostgreSQL, CockroachDB, SQLite only.
|
|
19
|
+
|
|
20
|
+
## Type Parameters
|
|
21
|
+
|
|
22
|
+
| Type Parameter |
|
|
23
|
+
| ------ |
|
|
24
|
+
| `D` *extends* `IUpdateManyAndReturnDelegate` |
|
|
25
|
+
| `A` *extends* `unknown` |
|
|
26
|
+
|
|
27
|
+
## Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type | Description |
|
|
30
|
+
| ------ | ------ | ------ |
|
|
31
|
+
| `args` | `A` | Prisma updateManyAndReturn arguments |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"updateManyAndReturn"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: upsert()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: upsert()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function upsert<D, A>(args): QueryOperator<D, ReturnType<D["upsert"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/upsert.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/upsert.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Creates or updates a record via the delegate `upsert` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpsertDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma upsert arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"upsert"`\]\>\>
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IRepositoryQuery2\<TDelegate, TRun\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IRepositoryQuery2\<TDelegate, TRun\>
|
|
7
|
+
|
|
8
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L8)
|
|
9
|
+
|
|
10
|
+
Represents a reusable query definition for repositories.
|
|
11
|
+
|
|
12
|
+
## Template
|
|
13
|
+
|
|
14
|
+
The query result type.
|
|
15
|
+
|
|
16
|
+
## Type Parameters
|
|
17
|
+
|
|
18
|
+
| Type Parameter | Default type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `TDelegate` | - | The Prisma delegate type. |
|
|
21
|
+
| `TRun` *extends* (`delegate`) => `any` | (`delegate`) => `any` | - |
|
|
22
|
+
|
|
23
|
+
## Properties
|
|
24
|
+
|
|
25
|
+
### name
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly name: string;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L17)
|
|
32
|
+
|
|
33
|
+
The identifier used for logging.
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### run
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
run: TRun;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L26)
|
|
44
|
+
|
|
45
|
+
Executes the query against the provided model.
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateArgs<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<unknown> ? A : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:423](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L423)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: DelegateOperations\<TDelegate\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: DelegateOperations\<TDelegate\>
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type DelegateOperations<TDelegate> = Extract<RepositoryOperationsAll, keyof TDelegate>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L66)
|
|
13
|
+
|
|
14
|
+
Extracts the subset of known Prisma operations that a concrete delegate actually implements.
|
|
15
|
+
Useful for type-level checks without requiring the consumer to state the provider explicitly.
|
|
16
|
+
|
|
17
|
+
## Type Parameters
|
|
18
|
+
|
|
19
|
+
| Type Parameter |
|
|
20
|
+
| ------ |
|
|
21
|
+
| `TDelegate` |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
// On PostgreSQL: 'findUnique' | ... | 'createManyAndReturn' | 'updateManyAndReturn'
|
|
27
|
+
// On SQL Server: 'findUnique' | ... (15 base ops only)
|
|
28
|
+
type Ops = DelegateOperations<Prisma.TaskDelegate>;
|
|
29
|
+
```
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateReturnTypes<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<infer R> ? R : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:430](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L430)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: RepositoryOperationsAll'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: RepositoryOperationsAll
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type RepositoryOperationsAll =
|
|
10
|
+
| RepositoryOperationsBase
|
|
11
|
+
| "createManyAndReturn"
|
|
12
|
+
| "updateManyAndReturn"
|
|
13
|
+
| "findRaw"
|
|
14
|
+
| "aggregateRaw";
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L20)
|
|
18
|
+
|
|
19
|
+
Superset of all known Prisma model delegate operations across every supported database provider.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: RepositoryOperationsBase'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: RepositoryOperationsBase
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type RepositoryOperationsBase =
|
|
10
|
+
| "aggregate"
|
|
11
|
+
| "count"
|
|
12
|
+
| "create"
|
|
13
|
+
| "createMany"
|
|
14
|
+
| "delete"
|
|
15
|
+
| "deleteMany"
|
|
16
|
+
| "findFirst"
|
|
17
|
+
| "findFirstOrThrow"
|
|
18
|
+
| "findMany"
|
|
19
|
+
| "findUnique"
|
|
20
|
+
| "findUniqueOrThrow"
|
|
21
|
+
| "groupBy"
|
|
22
|
+
| "update"
|
|
23
|
+
| "updateMany"
|
|
24
|
+
| "upsert";
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L37)
|
|
28
|
+
|
|
29
|
+
The baseline set of operations available on **every** Prisma provider
|
|
30
|
+
(PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB).
|
|
31
|
+
|
|
32
|
+
Provider-specific extras (e.g. `createManyAndReturn` on PostgreSQL) are
|
|
33
|
+
deliberately excluded so that consumers targeting any provider satisfy
|
|
34
|
+
the constraint automatically.
|
|
@@ -13,7 +13,8 @@ editUrl: false
|
|
|
13
13
|
| [DatabaseModule](Class.DatabaseModule) | - |
|
|
14
14
|
| [DatabaseService](Class.DatabaseService) | Represents the database service. |
|
|
15
15
|
| [PrismaService](Class.PrismaService) | Represents the prisma service. |
|
|
16
|
-
| [
|
|
16
|
+
| [RepositoryBase](Class.RepositoryBase) | The base class for all repositories. |
|
|
17
|
+
| [RepositoryBase2](Class.RepositoryBase2) | Minimal repository base that exposes the underlying Prisma delegate and provides a typed pipe helper for functional operators. |
|
|
17
18
|
| [RepositoryExceptionFilter](Class.RepositoryExceptionFilter) | Represents the Prisma client exception filter. |
|
|
18
19
|
|
|
19
20
|
## Interfaces
|
|
@@ -27,6 +28,7 @@ editUrl: false
|
|
|
27
28
|
| [IPaginateOptions](Interface.IPaginateOptions) | - |
|
|
28
29
|
| [IPrismaServiceOptions](Interface.IPrismaServiceOptions) | Represents the options for the PrismaService. |
|
|
29
30
|
| [IRepositoryQuery](Interface.IRepositoryQuery) | Represents a reusable query definition for repositories. |
|
|
31
|
+
| [IRepositoryQuery2](Interface.IRepositoryQuery2) | Represents a reusable query definition for repositories. |
|
|
30
32
|
| [ITransactionalRepositoryQuery](Interface.ITransactionalRepositoryQuery) | Represents a repository query that requires a Prisma TransactionClient to access multiple delegates. |
|
|
31
33
|
|
|
32
34
|
## Type Aliases
|
|
@@ -35,9 +37,12 @@ editUrl: false
|
|
|
35
37
|
| ------ | ------ |
|
|
36
38
|
| [CursorPaginateFunction](TypeAlias.CursorPaginateFunction) | The type of a cursor paginate function. |
|
|
37
39
|
| [DelegateArgs](TypeAlias.DelegateArgs) | - |
|
|
40
|
+
| [DelegateOperations](TypeAlias.DelegateOperations) | Extracts the subset of known Prisma operations that a concrete delegate actually implements. Useful for type-level checks without requiring the consumer to state the provider explicitly. |
|
|
38
41
|
| [DelegateReturnTypes](TypeAlias.DelegateReturnTypes) | - |
|
|
39
42
|
| [PaginateFunction](TypeAlias.PaginateFunction) | - |
|
|
40
43
|
| [QueryResultType](TypeAlias.QueryResultType) | Extracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types. |
|
|
44
|
+
| [RepositoryOperationsAll](TypeAlias.RepositoryOperationsAll) | Superset of all known Prisma model delegate operations across every supported database provider. |
|
|
45
|
+
| [RepositoryOperationsBase](TypeAlias.RepositoryOperationsBase) | The baseline set of operations available on **every** Prisma provider (PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB). |
|
|
41
46
|
| [TransactionalQueryResultType](TypeAlias.TransactionalQueryResultType) | Extracts the result type from a transactional repository query. |
|
|
42
47
|
|
|
43
48
|
## Variables
|
|
@@ -52,9 +57,32 @@ editUrl: false
|
|
|
52
57
|
|
|
53
58
|
| Function | Description |
|
|
54
59
|
| ------ | ------ |
|
|
60
|
+
| [aggregate](Function.aggregate) | Executes an aggregate query via the delegate `aggregate` method. |
|
|
61
|
+
| [aggregateRaw](Function.aggregateRaw) | Executes a raw aggregate query via the delegate `aggregateRaw` method. |
|
|
62
|
+
| [count](Function.count) | Counts records via the delegate `count` method. |
|
|
63
|
+
| [create](Function.create) | Creates a record using the underlying delegate `create` method. |
|
|
64
|
+
| [createMany](Function.createMany) | Creates multiple records via the delegate `createMany` method. |
|
|
65
|
+
| [createManyAndReturn](Function.createManyAndReturn) | Creates multiple records and returns them via the delegate `createManyAndReturn` method. |
|
|
55
66
|
| [cursorPaginator](Function.cursorPaginator) | Creates a cursor-based pagination function with the given default options. |
|
|
67
|
+
| [findFirst](Function.findFirst) | Creates an operator that executes a `findFirst` query with the provided arguments. |
|
|
68
|
+
| [findFirstOrThrow](Function.findFirstOrThrow) | Finds the first record matching the criteria via the delegate `findFirstOrThrow` method. Throws a `PrismaClientKnownRequestError` with code `P2025` if no record is found. |
|
|
69
|
+
| [findMany](Function.findMany) | Finds many records via the delegate `findMany` method. |
|
|
70
|
+
| [findManyPaged](Function.findManyPaged) | Finds many records with pagination using the delegate `findMany` method. |
|
|
71
|
+
| [findRaw](Function.findRaw) | Executes a raw find query via the delegate `findRaw` method. |
|
|
72
|
+
| [findUnique](Function.findUnique) | Finds a unique record via the delegate `findUnique` method. |
|
|
73
|
+
| [findUniqueOrThrow](Function.findUniqueOrThrow) | Finds a unique record via the delegate `findUniqueOrThrow` method. Throws a `PrismaClientKnownRequestError` with code `P2025` if no record is found. |
|
|
74
|
+
| [groupBy](Function.groupBy) | Performs a group-by query via the delegate `groupBy` method. |
|
|
56
75
|
| [pageable](Function.pageable) | - |
|
|
57
76
|
| [paginator](Function.paginator) | - |
|
|
77
|
+
| [pipe](Function.pipe) | Executes a single operator against the provided delegate. |
|
|
78
|
+
| [pipeAll](Function.pipeAll) | Sequentially executes multiple operators. The last result is returned. Useful for multi-step dependent operations. |
|
|
58
79
|
| [query](Function.query) | Creates a new repository query. |
|
|
80
|
+
| [query2](Function.query2) | Creates a new repository query. |
|
|
81
|
+
| [remove](Function.remove) | Deletes a single record via the delegate `delete` method. |
|
|
82
|
+
| [removeMany](Function.removeMany) | Deletes multiple records via the delegate `deleteMany` method. |
|
|
59
83
|
| [skip](Function.skip) | 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. |
|
|
60
84
|
| [transactionalQuery](Function.transactionalQuery) | Factory to create a transactional repository query. |
|
|
85
|
+
| [update](Function.update) | Updates a single record via the delegate `update` method. |
|
|
86
|
+
| [updateMany](Function.updateMany) | Updates multiple records via the delegate `updateMany` method. |
|
|
87
|
+
| [updateManyAndReturn](Function.updateManyAndReturn) | Updates multiple records and returns them via the delegate `updateManyAndReturn` method. |
|
|
88
|
+
| [upsert](Function.upsert) | Creates or updates a record via the delegate `upsert` method. |
|
|
@@ -89,7 +89,7 @@ import type { Prisma } from '@prisma/client';
|
|
|
89
89
|
@Injectable()
|
|
90
90
|
export class OrderRepository extends RepositoryBase<Prisma.OrderDelegate, Prisma.OrderFindManyArgs, unknown> {
|
|
91
91
|
constructor(database: DatabaseService) {
|
|
92
|
-
super(database
|
|
92
|
+
super(database, database.order);
|
|
93
93
|
}
|
|
94
94
|
}
|
|
95
95
|
```
|
|
@@ -17,10 +17,15 @@ Template-based document generation engine supporting DOCX and PDF output. Uses p
|
|
|
17
17
|
```typescript
|
|
18
18
|
import { Module } from '@nestjs/common';
|
|
19
19
|
import { DocumentModule } from '@breadstone/archipel-platform-documents';
|
|
20
|
+
import { SharpImageProcessor } from '@breadstone/archipel-platform-documents/sharp';
|
|
21
|
+
import { DocxDocumentRenderer2 } from '@breadstone/archipel-platform-documents/docx';
|
|
22
|
+
import { PdfDocumentRenderer } from '@breadstone/archipel-platform-documents/pdf';
|
|
20
23
|
|
|
21
24
|
@Module({
|
|
22
25
|
imports: [
|
|
23
26
|
DocumentModule.forRoot({
|
|
27
|
+
imageProcessor: SharpImageProcessor,
|
|
28
|
+
renderers: [DocxDocumentRenderer2, PdfDocumentRenderer],
|
|
24
29
|
maxImageWidth: 1920,
|
|
25
30
|
maxImageHeight: 1080,
|
|
26
31
|
delimiters: { start: '[[', end: ']]' },
|
|
@@ -37,13 +42,15 @@ export class AppModule {}
|
|
|
37
42
|
|
|
38
43
|
### IDocumentModuleOptions
|
|
39
44
|
|
|
40
|
-
| Property | Type
|
|
41
|
-
| ------------------ |
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
44
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
45
|
+
| Property | Type | Default | Description |
|
|
46
|
+
| ------------------ | ----------------------------- | ------- | ------------------------------------------------------------------------- |
|
|
47
|
+
| `imageProcessor` | `Type<IImageProcessor>` | — | **Required.** Image processor class (e.g. `SharpImageProcessor`) |
|
|
48
|
+
| `renderers` | `Type<IDocumentRenderer>[]` | — | **Required.** Renderer classes (e.g. `[DocxDocumentRenderer2, PdfDocumentRenderer]`) |
|
|
49
|
+
| `maxImageWidth` | `number` | `1920` | Maximum width for embedded images |
|
|
50
|
+
| `maxImageHeight` | `number` | `1080` | Maximum height for embedded images |
|
|
51
|
+
| `delimiters.start` | `string` | `'[['` | Template variable start delimiter |
|
|
52
|
+
| `delimiters.end` | `string` | `']]'` | Template variable end delimiter |
|
|
53
|
+
| `debug` | `boolean` | `false` | Enable debug output |
|
|
47
54
|
|
|
48
55
|
---
|
|
49
56
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: EsigningHealthIndicator
|
|
7
7
|
|
|
8
|
-
Defined in: health/EsigningHealthIndicator.ts:17
|
|
8
|
+
Defined in: [health/EsigningHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L17)
|
|
9
9
|
|
|
10
10
|
Health indicator for the e-signing infrastructure.
|
|
11
11
|
Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provider connectivity.
|
|
@@ -22,7 +22,7 @@ Calls [EsigningClientPort.ping](Class.EsigningClientPort#ping) to verify provide
|
|
|
22
22
|
new EsigningHealthIndicator(esigningClient?): EsigningHealthIndicator;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: health/EsigningHealthIndicator.ts:27
|
|
25
|
+
Defined in: [health/EsigningHealthIndicator.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L27)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -42,7 +42,7 @@ Defined in: health/EsigningHealthIndicator.ts:27
|
|
|
42
42
|
readonly key: string = 'esigning';
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: health/EsigningHealthIndicator.ts:35
|
|
45
|
+
Defined in: [health/EsigningHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L35)
|
|
46
46
|
|
|
47
47
|
Unique key identifying the indicator
|
|
48
48
|
|
|
@@ -60,7 +60,7 @@ IHealthIndicator.key
|
|
|
60
60
|
check(): Promise<HealthIndicatorResult<string>>;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: health/EsigningHealthIndicator.ts:48
|
|
63
|
+
Defined in: [health/EsigningHealthIndicator.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/health/EsigningHealthIndicator.ts#L48)
|
|
64
64
|
|
|
65
65
|
Pings the e-signing provider to verify connectivity.
|
|
66
66
|
Returns disabled status when no client is configured.
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: MailHealthIndicator
|
|
7
7
|
|
|
8
|
-
Defined in: platform-mailing/src/health/MailHealthIndicator.ts:17
|
|
8
|
+
Defined in: [platform-mailing/src/health/MailHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/health/MailHealthIndicator.ts#L17)
|
|
9
9
|
|
|
10
10
|
Health indicator for mail service.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Health indicator for mail service.
|
|
|
21
21
|
new MailHealthIndicator(configService): MailHealthIndicator;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: platform-mailing/src/health/MailHealthIndicator.ts:31
|
|
24
|
+
Defined in: [platform-mailing/src/health/MailHealthIndicator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/health/MailHealthIndicator.ts#L31)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `MailHealthIndicator` class.
|
|
27
27
|
|
|
@@ -43,7 +43,7 @@ Constructs a new instance of the `MailHealthIndicator` class.
|
|
|
43
43
|
readonly key: string = 'mail';
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
Defined in: platform-mailing/src/health/MailHealthIndicator.ts:39
|
|
46
|
+
Defined in: [platform-mailing/src/health/MailHealthIndicator.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/health/MailHealthIndicator.ts#L39)
|
|
47
47
|
|
|
48
48
|
Unique key identifying the indicator
|
|
49
49
|
|
|
@@ -61,7 +61,7 @@ IHealthIndicator.key
|
|
|
61
61
|
check(): HealthIndicatorResult<"mail">;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: platform-mailing/src/health/MailHealthIndicator.ts:51
|
|
64
|
+
Defined in: [platform-mailing/src/health/MailHealthIndicator.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/health/MailHealthIndicator.ts#L51)
|
|
65
65
|
|
|
66
66
|
Checks if the mail configuration is valid.
|
|
67
67
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: McpHealthIndicator
|
|
7
7
|
|
|
8
|
-
Defined in: health/McpHealthIndicator.ts:17
|
|
8
|
+
Defined in: [health/McpHealthIndicator.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/health/McpHealthIndicator.ts#L17)
|
|
9
9
|
|
|
10
10
|
Health indicator for the MCP server infrastructure.
|
|
11
11
|
Verifies that at least one tool, resource, or prompt handler is registered.
|
|
@@ -22,7 +22,7 @@ Verifies that at least one tool, resource, or prompt handler is registered.
|
|
|
22
22
|
new McpHealthIndicator(registry?): McpHealthIndicator;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: health/McpHealthIndicator.ts:26
|
|
25
|
+
Defined in: [health/McpHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/health/McpHealthIndicator.ts#L26)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -42,7 +42,7 @@ Defined in: health/McpHealthIndicator.ts:26
|
|
|
42
42
|
readonly key: string = 'mcp';
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: health/McpHealthIndicator.ts:34
|
|
45
|
+
Defined in: [health/McpHealthIndicator.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/health/McpHealthIndicator.ts#L34)
|
|
46
46
|
|
|
47
47
|
Unique key identifying the indicator
|
|
48
48
|
|
|
@@ -60,7 +60,7 @@ IHealthIndicator.key
|
|
|
60
60
|
check(): HealthIndicatorResult<string>;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: health/McpHealthIndicator.ts:47
|
|
63
|
+
Defined in: [health/McpHealthIndicator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/health/McpHealthIndicator.ts#L47)
|
|
64
64
|
|
|
65
65
|
Verifies that the MCP registry has at least one registered handler.
|
|
66
66
|
Returns disabled status when no registry is configured.
|