@breadstone/archipel-mcp 0.0.17 → 0.0.19

package/data/packages/platform-openapi/api/Function.Api.md

@@ -9,26 +9,15 @@ editUrl: false
 function Api(options): ClassDecorator & MethodDecorator & PropertyDecorator;
 ```
 
-Defined in: [decorators/Api.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/Api.ts#L21)
+Defined in: [decorators/Api.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/Api.ts#L141)
 
-Custom Swagger Decorator
-This decorator wraps all necessary Swagger decorators into one.
+Composite Swagger decorator that wraps all NestJS OpenAPI decorators into a single declaration.
 
 ## Parameters
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `options` | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators. |
-| `options.auth?` | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"` | - |
-| `options.body?` | `ApiBodyOptions` | Options for the ApiBody decorator. |
-| `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | - |
-| `options.headers?` | `ApiHeaderOptions`[] | Options for the ApiHeaders decorator. |
-| `options.operation?` | `Partial`\<`OperationObject`\> | Options for the ApiOperation decorator. |
-| `options.params?` | `ApiParamOptions` \| `ApiParamOptions`[] | Options for the ApiParam decorator. |
-| `options.query?` | `ApiQueryOptions` \| `ApiQueryOptions`[] | Options for the ApiQuery decorator (can be an array or single query). |
-| `options.responses?` | `ApiResponseOptions` \| `ApiResponseOptions`[] | - |
-| `options.scopes?` | `string`[] | - |
-| `options.tags?` | `string` \| `string`[] | Options for the ApiTags decorator (can be an array or single tag). |
+| `options` | `IApiOptions` | Configuration for the Swagger decorators. |
 
 ## Returns
 

package/data/packages/platform-openapi/api/index.md

@@ -36,7 +36,7 @@ editUrl: false
 
 | Function | Description |
 | ------ | ------ |
-| [Api](Function.Api) | Custom Swagger Decorator This decorator wraps all necessary Swagger decorators into one. |
+| [Api](Function.Api) | Composite Swagger decorator that wraps all NestJS OpenAPI decorators into a single declaration. |
 | [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator. |
 | [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Get the Swagger feature metadata from a module class |
 | [SwaggerFeature](Function.SwaggerFeature) | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |

package/data/packages/platform-openapi/index.md

@@ -15,19 +15,27 @@ Multi-tenant Swagger/OpenAPI documentation system with feature-scoped discovery,
 ## Quick Start
 
 ```typescript
-import { Module } from '@nestjs/common';
+import { Module, Controller, Get, Param } from '@nestjs/common';
 import { SwaggerFeature, Api } from '@breadstone/archipel-platform-openapi';
 
 @SwaggerFeature({
-  name: 'User Management',
-  description: 'User CRUD and profile operations',
-  version: '1.0',
+  name: 'users',
+  title: 'My App API — Users',
+  description: 'User CRUD and profile operations.',
+  tag: 'Users',
+  tags: ['Users'],
 })
+@Module({
+  controllers: [UserController],
+})
+export class UserModule {}
+
 @Controller('api/v1/users')
 export class UserController {
   @Api({
+    tags: 'Users',
     summary: 'Get user by ID',
-    responses: { 200: { description: 'User found' } },
+    responses: [{ status: 200, description: 'User found', type: UserResponse }],
   })
   @Get(':id')
   public async getUser(@Param('id') id: string): Promise<UserResponse> {
@@ -44,21 +52,22 @@ The key concept is **per-feature Swagger documents** — each feature or module
 
 ### @SwaggerFeature Decorator
 
-Associates a controller with a named feature group:
+Associates a module with a named feature group:
 
 ```typescript
 import { SwaggerFeature } from '@breadstone/archipel-platform-openapi';
 
 @SwaggerFeature({
-  name: 'Orders',
-  description: 'Order management and fulfillment',
-  version: '2.0',
-  tags: ['orders', 'fulfillment'],
+  name: 'orders',
+  title: 'My App API — Orders',
+  description: 'Order management and fulfillment.',
+  tag: 'Orders',
+  tags: ['Orders'],
 })
-@Controller('api/v1/orders')
-export class OrderController {
-  /* ... */
-}
+@Module({
+  controllers: [OrderController],
+})
+export class OrderModule {}
 ```
 
 ### @Api Decorator
@@ -70,12 +79,12 @@ import { Api } from '@breadstone/archipel-platform-openapi';
 
 @Api({
     summary: 'Create a new order',
-    description: 'Creates an order and initiates payment processing.',
-    responses: {
-        201: { description: 'Order created successfully' },
-        400: { description: 'Invalid order data' },
-        402: { description: 'Payment required' },
-    },
+    operation: { description: 'Creates an order and initiates payment processing.' },
+    responses: [
+        { status: 201, description: 'Order created successfully' },
+        { status: 400, description: 'Invalid order data' },
+        { status: 402, description: 'Payment required' },
+    ],
 })
 @Post()
 public async createOrder(@Body() body: CreateOrderDto): Promise<OrderResponse> { /* ... */ }
@@ -104,20 +113,37 @@ export class DocsController {
 ### Bootstrap Setup
 
 ```typescript
-import { SwaggerModule } from '@nestjs/swagger';
-import { SwaggerMultiDocumentService, SwaggerTheme } from '@breadstone/archipel-platform-openapi';
+import {
+  SwaggerFeatureDiscovery,
+  SwaggerFeatureRegistry,
+  SwaggerMultiDocumentService,
+} from '@breadstone/archipel-platform-openapi';
+import { ConfigService, ContentTemplateEngine, HostService, ResourceManager } from '@breadstone/archipel-platform-core';
 
 async function bootstrap(): Promise<void> {
   const app = await NestFactory.create(AppModule);
-  const docsService = app.get(SwaggerMultiDocumentService);
-  const documents = docsService.generateAll();
-
-  for (const [featureName, spec] of documents) {
-    const path = `docs/${featureName.toLowerCase().replace(/\s+/g, '-')}`;
-    SwaggerModule.setup(path, app, spec, {
-      customCss: SwaggerTheme.getDefaultCss(),
-    });
-  }
+
+  const configService = app.get(ConfigService);
+  const hostService = app.get(HostService);
+  const resourceManager = app.get(ResourceManager);
+  const contentTemplateEngine = app.get(ContentTemplateEngine);
+
+  // 1. Discover features
+  const featureRegistry = new SwaggerFeatureRegistry();
+  const discovery = new SwaggerFeatureDiscovery();
+  discovery.registerDiscoveredFeatures(featureRegistry);
+  discovery.registerDefaultFeatures(featureRegistry);
+
+  // 2. Setup multi-document Swagger UI
+  const swaggerService = new SwaggerMultiDocumentService(
+    app,
+    configService,
+    hostService,
+    featureRegistry,
+    resourceManager,
+    contentTemplateEngine,
+  );
+  await swaggerService.setupMultipleSwaggerDocuments();
 
   await app.listen(3000);
 }
@@ -129,30 +155,39 @@ async function bootstrap(): Promise<void> {
 
 ### SwaggerFeatureDiscovery
 
-Auto-discovers all `@SwaggerFeature` decorated controllers at bootstrap:
+Reads the global store populated by `@SwaggerFeature()` decorators and registers features into a `SwaggerFeatureRegistry`:
 
 ```typescript
-import { SwaggerFeatureDiscovery } from '@breadstone/archipel-platform-openapi';
+import { SwaggerFeatureDiscovery, SwaggerFeatureRegistry } from '@breadstone/archipel-platform-openapi';
+
+const featureRegistry = new SwaggerFeatureRegistry();
+const discovery = new SwaggerFeatureDiscovery();
 
-const discovery = app.get(SwaggerFeatureDiscovery);
-const features = discovery.discoverAll();
-// → [{ name: 'User Management', controllers: [...] }, ...]
+discovery
+  .registerDiscoveredFeatures(featureRegistry)
+  .registerDefaultFeatures(featureRegistry);
 ```
 
 ### SwaggerFeatureRegistry
 
-Programmatic registry for feature configurations:
+Holds the finalized, immutable list of features. After all features are registered, call `finalize()`:
 
 ```typescript
 import { SwaggerFeatureRegistry } from '@breadstone/archipel-platform-openapi';
 
-const registry = app.get(SwaggerFeatureRegistry);
-registry.register({
-  name: 'Admin',
-  description: 'Admin-only endpoints',
-  version: '1.0',
-  controllers: [AdminController],
+const registry = new SwaggerFeatureRegistry();
+
+registry.registerFeature({
+  name: 'admin',
+  title: 'My App API — Admin',
+  description: 'Admin-only endpoints.',
+  tag: 'Admin',
+  tags: ['Admin'],
+  path: 'docs/admin',
 });
+
+registry.finalize();
+const features = registry.getFeatures(); // sorted, read-only copy
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-mcp",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "MCP server providing Archipel platform knowledge — documentation, query patterns, and coding conventions — to AI development tools.",
   "type": "commonjs",
   "main": "./src/main.js",

package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: ESIGNING\_API\_BASE\_URL'
-generated: true
-editUrl: false
----
-# Variable: ESIGNING\_API\_BASE\_URL
-
-```ts
-const ESIGNING_API_BASE_URL: IConfigKey<string>;
-```
-
-Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L18)
-
-Active e-signing provider base URL.

package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: ESIGNING\_API\_KEY'
-generated: true
-editUrl: false
----
-# Variable: ESIGNING\_API\_KEY
-
-```ts
-const ESIGNING_API_KEY: IConfigKey<string>;
-```
-
-Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L12)
-
-Active e-signing provider API key.

package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md

@@ -1,12 +0,0 @@
----
-title: 'Variable: ESIGNING\_PROVIDER'
-generated: true
-editUrl: false
----
-# Variable: ESIGNING\_PROVIDER
-
-```ts
-const ESIGNING_PROVIDER: typeof ESIGNING_PROVIDER;
-```
-
-Defined in: [tokens.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/tokens.ts#L3)

package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md

@@ -1,12 +0,0 @@
----
-title: 'Variable: ESIGNING\_PROVIDER\_OPTIONS'
-generated: true
-editUrl: false
----
-# Variable: ESIGNING\_PROVIDER\_OPTIONS
-
-```ts
-const ESIGNING_PROVIDER_OPTIONS: typeof ESIGNING_PROVIDER_OPTIONS;
-```
-
-Defined in: [tokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/tokens.ts#L4)

package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: ESIGNING\_WEBHOOK\_SECRET'
-generated: true
-editUrl: false
----
-# Variable: ESIGNING\_WEBHOOK\_SECRET
-
-```ts
-const ESIGNING_WEBHOOK_SECRET: IConfigKey<string>;
-```
-
-Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L15)
-
-Active e-signing provider webhook signing secret.

package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: PLATFORM\_ESIGNING\_CONFIG\_ENTRIES'
-generated: true
-editUrl: false
----
-# Variable: PLATFORM\_ESIGNING\_CONFIG\_ENTRIES
-
-```ts
-const PLATFORM_ESIGNING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
-```
-
-Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/env.ts#L25)
-
-All configuration entries required by `platform-esigning`.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_API\_KEY'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_API\_KEY
-
-```ts
-const SIGNNOW_API_KEY: IConfigKey<string>;
-```
-
-Defined in: [signnow/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L12)
-
-signNow API key (basic token).

package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_BASE\_URL'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_BASE\_URL
-
-```ts
-const SIGNNOW_BASE_URL: IConfigKey<string>;
-```
-
-Defined in: [signnow/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L21)
-
-signNow base URL.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_CLIENT\_ID'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_CLIENT\_ID
-
-```ts
-const SIGNNOW_CLIENT_ID: IConfigKey<string>;
-```
-
-Defined in: [signnow/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L15)
-
-signNow client ID.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_CLIENT\_SECRET'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_CLIENT\_SECRET
-
-```ts
-const SIGNNOW_CLIENT_SECRET: IConfigKey<string>;
-```
-
-Defined in: [signnow/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L18)
-
-signNow client secret.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_CONFIG\_ENTRIES'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_CONFIG\_ENTRIES
-
-```ts
-const SIGNNOW_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
-```
-
-Defined in: [signnow/env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L31)
-
-Configuration entries required by the signNow e-signing provider.

package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md

@@ -1,14 +0,0 @@
----
-title: 'Variable: SIGNNOW\_WEBHOOK\_SECRET'
-generated: true
-editUrl: false
----
-# Variable: SIGNNOW\_WEBHOOK\_SECRET
-
-```ts
-const SIGNNOW_WEBHOOK_SECRET: IConfigKey<string>;
-```
-
-Defined in: [signnow/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/signnow/env.ts#L24)
-
-signNow webhook callback secret.