@breadstone/archipel-mcp 0.0.46 → 0.0.48

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 (34) hide show
  1. package/data/guides/composition-context.md +462 -0
  2. package/data/guides/index.md +1 -0
  3. package/data/packages/platform-blob-storage/api/Class.BlobStorageStrategyBase.md +1 -0
  4. package/data/packages/platform-blob-storage/api/Class.EmptyBlobStorageStrategy.md +183 -0
  5. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ACCESS_KEY_ID.md +1 -1
  6. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_BUCKET.md +1 -1
  7. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_CONFIG_ENTRIES.md +1 -1
  8. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_ENDPOINT.md +1 -1
  9. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_REGION.md +1 -1
  10. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_SECRET_ACCESS_KEY.md +1 -1
  11. package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BASE_PATH.md +1 -1
  12. package/data/packages/platform-blob-storage/api/Variable.LOCAL_BLOB_BUCKET.md +1 -1
  13. package/data/packages/platform-blob-storage/api/Variable.LOCAL_CONFIG_ENTRIES.md +1 -1
  14. package/data/packages/platform-blob-storage/api/Variable.PLATFORM_BLOB_STORAGE_CONFIG_ENTRIES.md +1 -1
  15. package/data/packages/platform-blob-storage/api/index.md +1 -0
  16. package/data/packages/platform-blob-storage/index.md +21 -1
  17. package/data/packages/platform-bootstrap/api/Class.CompositionContext.md +226 -0
  18. package/data/packages/platform-bootstrap/api/Class.CompositionModule.md +56 -0
  19. package/data/packages/platform-bootstrap/api/Class.CompositionResolver.md +206 -0
  20. package/data/packages/platform-bootstrap/api/Class.PlatformApplicationBuilder.md +75 -8
  21. package/data/packages/platform-bootstrap/api/Function.createCompositionContext.md +56 -0
  22. package/data/packages/platform-bootstrap/api/Interface.ICompositionContext.md +179 -0
  23. package/data/packages/platform-bootstrap/api/Interface.ICreateCompositionContextOptions.md +54 -0
  24. package/data/packages/platform-bootstrap/api/Interface.ICreateWithCompositionOptions.md +128 -0
  25. package/data/packages/platform-bootstrap/api/Interface.IProviderDecision.md +36 -0
  26. package/data/packages/platform-bootstrap/api/TypeAlias.CompositionImport.md +20 -0
  27. package/data/packages/platform-bootstrap/api/TypeAlias.ProviderComposer.md +53 -0
  28. package/data/packages/platform-bootstrap/api/index.md +10 -0
  29. package/data/packages/platform-database/api/Class.DatabaseModule.md +22 -7
  30. package/data/packages/platform-database/api/Interface.IRepositoryQuery2.md +2 -0
  31. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -1
  32. package/data/packages/platform-mailing/api/index.md +0 -1
  33. package/package.json +1 -1
  34. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -71
@@ -9,6 +9,9 @@ editUrl: false
9
9
 
10
10
  | Class | Description |
11
11
  | ------ | ------ |
12
+ | [CompositionContext](Class.CompositionContext) | Default implementation of the composition context. |
13
+ | [CompositionModule](Class.CompositionModule) | Minimal module providing configuration access for composition. |
14
+ | [CompositionResolver](Class.CompositionResolver) | Abstract base class for composition-time feature resolution. |
12
15
  | [PlatformApplication](Class.PlatformApplication) | Entry point for composing an existing NestJS application with Archipel bootstrap steps. |
13
16
  | [PlatformApplicationBuilder](Class.PlatformApplicationBuilder) | Fluent builder that composes NestJS bootstrap steps and executes them once. |
14
17
  | [PlatformBootstrapContext](Class.PlatformBootstrapContext) | Runtime context shared by platform bootstrap steps. |
@@ -20,11 +23,15 @@ editUrl: false
20
23
  | ------ | ------ |
21
24
  | [IApiStepOptions](Interface.IApiStepOptions) | Options for the generic Archipel API bootstrap step. |
22
25
  | [IApiValidationOptions](Interface.IApiValidationOptions) | Validation options used by the generic Archipel API bootstrap step. |
26
+ | [ICompositionContext](Interface.ICompositionContext) | Pre-bootstrap context for stage-aware module composition. |
27
+ | [ICreateCompositionContextOptions](Interface.ICreateCompositionContextOptions) | Options for creating the composition context. |
28
+ | [ICreateWithCompositionOptions](Interface.ICreateWithCompositionOptions) | Options for creating a composed application. |
23
29
  | [IExpressServerStepOptions](Interface.IExpressServerStepOptions) | Options for the Express-compatible server bootstrap step. |
24
30
  | [IOpenApiStepOptions](Interface.IOpenApiStepOptions) | Options for the OpenAPI bootstrap step. |
25
31
  | [IPlatformApplicationOptions](Interface.IPlatformApplicationOptions) | Options for wrapping an existing NestJS application with Archipel platform bootstrap support. |
26
32
  | [IPlatformListenOptions](Interface.IPlatformListenOptions) | Options for resolving the HTTP listen port from typed configuration keys. |
27
33
  | [IPlatformTestApplication](Interface.IPlatformTestApplication) | In-memory application contract used by platform bootstrap tests. |
34
+ | [IProviderDecision](Interface.IProviderDecision) | Represents the result of a provider composition decision. |
28
35
  | [ISecurityStepOptions](Interface.ISecurityStepOptions) | Options for the generic security bootstrap step. |
29
36
  | [ISessionStepOptions](Interface.ISessionStepOptions) | Options for the Express-compatible session bootstrap step. |
30
37
 
@@ -32,10 +39,12 @@ editUrl: false
32
39
 
33
40
  | Type Alias | Description |
34
41
  | ------ | ------ |
42
+ | [CompositionImport](TypeAlias.CompositionImport) | Represents a valid NestJS module import that can be used during composition. |
35
43
  | [PlatformBootstrapNext](TypeAlias.PlatformBootstrapNext) | Continues execution with the next platform bootstrap step. |
36
44
  | [PlatformBootstrapStep](TypeAlias.PlatformBootstrapStep) | A composable bootstrap step in the platform application pipeline. |
37
45
  | [PlatformContentSecurityPolicyMode](TypeAlias.PlatformContentSecurityPolicyMode) | Named content-security-policy modes supported by `platform-bootstrap/security`. |
38
46
  | [PlatformCorsOptions](TypeAlias.PlatformCorsOptions) | CORS options accepted by the security bootstrap step. |
47
+ | [ProviderComposer](TypeAlias.ProviderComposer) | Function signature for a provider composer. |
39
48
  | [SecurityRateLimitOptions](TypeAlias.SecurityRateLimitOptions) | Rate-limit options accepted by the security bootstrap step. |
40
49
 
41
50
  ## Variables
@@ -57,6 +66,7 @@ editUrl: false
57
66
 
58
67
  | Function | Description |
59
68
  | ------ | ------ |
69
+ | [createCompositionContext](Function.createCompositionContext) | Creates a temporary NestJS context for stage-aware module composition. |
60
70
  | [createPlatformTestApplication](Function.createPlatformTestApplication) | Creates a lightweight in-memory NestJS application double for platform bootstrap tests. |
61
71
  | [useApi](Function.useApi) | Creates the generic Archipel API bootstrap step. |
62
72
  | [useExpressServer](Function.useExpressServer) | Creates an Express-compatible server bootstrap step. |
@@ -27,15 +27,18 @@ new DatabaseModule(): DatabaseModule;
27
27
  static forRoot(config?): DynamicModule;
28
28
  ```
29
29
 
30
- Defined in: [libs/platform-database/src/DatabaseModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L62)
30
+ Defined in: [libs/platform-database/src/DatabaseModule.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L103)
31
31
 
32
- Registers the `DatabaseModule` with global middlewares.
32
+ Registers the `DatabaseModule` globally with the provided configuration.
33
+
34
+ Use this method when you need to configure a Prisma adapter (e.g. `PrismaPg`)
35
+ for Prisma 7+ compatibility.
33
36
 
34
37
  #### Parameters
35
38
 
36
39
  | Parameter | Type | Description |
37
40
  | ------ | ------ | ------ |
38
- | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
41
+ | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration including the adapter |
39
42
 
40
43
  #### Returns
41
44
 
@@ -43,6 +46,16 @@ Registers the `DatabaseModule` with global middlewares.
43
46
 
44
47
  A `DynamicModule` that can be imported globally
45
48
 
49
+ #### Example
50
+
51
+ ```typescript
52
+ import { PrismaPg } from '@prisma/adapter-pg';
53
+
54
+ DatabaseModule.forRoot({
55
+ adapter: new PrismaPg(connectionUrl),
56
+ })
57
+ ```
58
+
46
59
  ***
47
60
 
48
61
  ### register()
@@ -51,18 +64,20 @@ A `DynamicModule` that can be imported globally
51
64
  static register(config?): DynamicModule;
52
65
  ```
53
66
 
54
- Defined in: [libs/platform-database/src/DatabaseModule.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L82)
67
+ Defined in: [libs/platform-database/src/DatabaseModule.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L122)
68
+
69
+ Registers the `DatabaseModule` with the provided configuration.
55
70
 
56
- Registers the `DatabaseModule` with dynamic middlewares.
71
+ Use this method for non-global registration with a Prisma adapter.
57
72
 
58
73
  #### Parameters
59
74
 
60
75
  | Parameter | Type | Description |
61
76
  | ------ | ------ | ------ |
62
- | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
77
+ | `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration including the adapter |
63
78
 
64
79
  #### Returns
65
80
 
66
81
  `DynamicModule`
67
82
 
68
- A `DynamicModule` that can be imported with middlewares
83
+ A `DynamicModule` that can be imported
@@ -11,6 +11,8 @@ Represents a reusable query definition for repositories.
11
11
 
12
12
  ## Template
13
13
 
14
+ **TResult**
15
+
14
16
  The query result type.
15
17
 
16
18
  ## Type Parameters
@@ -11,7 +11,6 @@ Represents the base class for all email delivery strategies.
11
11
 
12
12
  ## Extended by
13
13
 
14
- - [`LogDeliveryStrategy`](Class.LogDeliveryStrategy)
15
14
  - [`SmtpDeliveryStrategy`](Class.SmtpDeliveryStrategy)
16
15
  - [`PostmarkDeliveryStrategy`](Class.PostmarkDeliveryStrategy)
17
16
  - [`ResendDeliveryStrategy`](Class.ResendDeliveryStrategy)
@@ -13,7 +13,6 @@ editUrl: false
13
13
  | [DatabaseTemplateFetchStrategy](Class.DatabaseTemplateFetchStrategy) | Template fetch strategy that loads templates from a database via the [IMailTemplateRepository](Interface.IMailTemplateRepository) port. |
14
14
  | [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
15
15
  | [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class. |
16
- | [LogDeliveryStrategy](Class.LogDeliveryStrategy) | The `LogDeliveryStrategy` class. |
17
16
  | [MailDeliveryError](Class.MailDeliveryError) | Domain error thrown when email delivery fails. |
18
17
  | [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
19
18
  | [MailHealthIndicator](Class.MailHealthIndicator) | Health indicator for mail service. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.46",
3
+ "version": "0.0.48",
4
4
  "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",
@@ -1,71 +0,0 @@
1
- ---
2
- title: 'Class: LogDeliveryStrategy'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Class: LogDeliveryStrategy
7
-
8
- Defined in: [platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts#L14)
9
-
10
- The `LogDeliveryStrategy` class.
11
-
12
- ## Extends
13
-
14
- - [`DeliveryStrategyBase`](Class.DeliveryStrategyBase)
15
-
16
- ## Constructors
17
-
18
- ### Constructor
19
-
20
- ```ts
21
- new LogDeliveryStrategy(): LogDeliveryStrategy;
22
- ```
23
-
24
- Defined in: [platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts#L28)
25
-
26
- Constructs a new instance of the `LogDelivery` class.
27
-
28
- #### Returns
29
-
30
- `LogDeliveryStrategy`
31
-
32
- #### Overrides
33
-
34
- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase).[`constructor`](Class.DeliveryStrategyBase#constructor)
35
-
36
- ## Methods
37
-
38
- ### send()
39
-
40
- ```ts
41
- abstract send(
42
- from,
43
- to,
44
- subject,
45
- content,
46
- isHtml,
47
- _attachments?): Promise<void>;
48
- ```
49
-
50
- Defined in: [platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/delivering/strategies/logger/LogDeliveryStrategy.ts#L36)
51
-
52
- Sends an email with either plain text or HTML content.
53
-
54
- #### Parameters
55
-
56
- | Parameter | Type | Description |
57
- | ------ | ------ | ------ |
58
- | `from` | `string` | Sender's email address (optional, defaults to config) |
59
- | `to` | `string` | Recipient's email address |
60
- | `subject` | `string` | Subject of the email |
61
- | `content` | `string` | Email body content (plain text or HTML) |
62
- | `isHtml` | `boolean` | Flag to indicate whether the email is HTML (true) or plain text (false) |
63
- | `_attachments?` | [`IMailAttachment`](Interface.IMailAttachment)[] | - |
64
-
65
- #### Returns
66
-
67
- `Promise`\<`void`\>
68
-
69
- #### Overrides
70
-
71
- [`DeliveryStrategyBase`](Class.DeliveryStrategyBase).[`send`](Class.DeliveryStrategyBase#send)