@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md

@@ -0,0 +1,104 @@
+---
+title: 'Class: SwaggerFeatureRegistry'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# Class: SwaggerFeatureRegistry
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L15)
+
+Registry service for dynamically discovered Swagger features.
+Collects feature configurations from
+
+## Swagger Feature
+
+decorators.
+
+## Constructors
+
+### Constructor
+
+```ts
+new SwaggerFeatureRegistry(): SwaggerFeatureRegistry;
+```
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L28)
+
+#### Returns
+
+`SwaggerFeatureRegistry`
+
+## Methods
+
+### finalize()
+
+```ts
+finalize(): void;
+```
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L70)
+
+Finalize feature registration and prepare for use
+
+#### Returns
+
+`void`
+
+---
+
+### getFeatures()
+
+```ts
+getFeatures(): IFeatureSwaggerConfig[];
+```
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L82)
+
+Get all registered features
+
+#### Returns
+
+[`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig)[]
+
+---
+
+### getInstance()
+
+```ts
+static getInstance(): SwaggerFeatureRegistry | null;
+```
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L42)
+
+Get the singleton instance of the registry service
+
+#### Returns
+
+`SwaggerFeatureRegistry` \| `null`
+
+---
+
+### registerFeature()
+
+```ts
+registerFeature(feature): void;
+```
+
+Defined in: [registry/SwaggerFeatureRegistry.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L50)
+
+Register a new feature for Swagger documentation
+
+#### Parameters
+
+| Parameter | Type                                                       | Description               |
+| --------- | ---------------------------------------------------------- | ------------------------- |
+| `feature` | [`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig) | The feature configuration |
+
+#### Returns
+
+`void`

package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md

@@ -0,0 +1,82 @@
+---
+title: 'Class: SwaggerMultiDocumentService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# Class: SwaggerMultiDocumentService
+
+Defined in: [services/SwaggerMultiDocumentService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L13)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SwaggerMultiDocumentService(
+   app,
+   configService,
+   hostService,
+   featureRegistry,
+   resourceManager,
+   contentTemplateEngine): SwaggerMultiDocumentService;
+```
+
+Defined in: [services/SwaggerMultiDocumentService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L29)
+
+#### Parameters
+
+| Parameter               | Type                                                     |
+| ----------------------- | -------------------------------------------------------- |
+| `app`                   | `INestApplication`                                       |
+| `configService`         | `ConfigService`                                          |
+| `hostService`           | `HostService`                                            |
+| `featureRegistry`       | [`SwaggerFeatureRegistry`](Class.SwaggerFeatureRegistry) |
+| `resourceManager`       | `ResourceManager`                                        |
+| `contentTemplateEngine` | `ContentTemplateEngine`                                  |
+
+#### Returns
+
+`SwaggerMultiDocumentService`
+
+## Methods
+
+### generateOpenApiDocuments()
+
+```ts
+generateOpenApiDocuments(): {
+  document: OpenAPIObject;
+  feature: IFeatureSwaggerConfig;
+}[];
+```
+
+Defined in: [services/SwaggerMultiDocumentService.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L77)
+
+Generates OpenAPI documents for every registered feature without wiring HTTP routes.
+
+#### Returns
+
+\{
+`document`: `OpenAPIObject`;
+`feature`: [`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig);
+\}[]
+
+---
+
+### setupMultipleSwaggerDocuments()
+
+```ts
+setupMultipleSwaggerDocuments(): Promise<void>;
+```
+
+Defined in: [services/SwaggerMultiDocumentService.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L53)
+
+Setup multiple Swagger documents for different features
+
+#### Returns
+
+`Promise`\<`void`\>

package/data/packages/platform-openapi/api/Class.SwaggerTheme.md

@@ -0,0 +1,51 @@
+---
+title: 'Class: SwaggerTheme'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# Class: SwaggerTheme
+
+Defined in: [SwaggerTheme.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L14)
+
+The swagger theme class
+
+## Constructors
+
+### Constructor
+
+```ts
+new SwaggerTheme(resourceManager): SwaggerTheme;
+```
+
+Defined in: [SwaggerTheme.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L29)
+
+Constructs a new instance of the `SwaggerTheme` class.
+
+#### Parameters
+
+| Parameter         | Type              |
+| ----------------- | ----------------- |
+| `resourceManager` | `ResourceManager` |
+
+#### Returns
+
+`SwaggerTheme`
+
+## Methods
+
+### getOptions()
+
+```ts
+getOptions(): Pick<SwaggerCustomOptions, "customCss" | "customJsStr">;
+```
+
+Defined in: [SwaggerTheme.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L37)
+
+#### Returns
+
+`Pick`\<`SwaggerCustomOptions`, `"customCss"` \| `"customJsStr"`\>

package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md

@@ -0,0 +1,73 @@
+---
+title: 'Interface: IFeatureSwaggerConfig'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# Interface: IFeatureSwaggerConfig
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L1)
+
+## Properties
+
+### description
+
+```ts
+readonly description: string;
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L4)
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L2)
+
+---
+
+### path
+
+```ts
+readonly path: string;
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L7)
+
+---
+
+### tag
+
+```ts
+readonly tag: string;
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L5)
+
+---
+
+### tags
+
+```ts
+readonly tags: string[];
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L6)
+
+---
+
+### title
+
+```ts
+readonly title: string;
+```
+
+Defined in: [registry/IFeatureSwaggerConfig.ts:3](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L3)

package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md

@@ -0,0 +1,73 @@
+---
+title: 'Interface: ISwaggerFeatureMetadata'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# Interface: ISwaggerFeatureMetadata
+
+Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)
+
+## Properties
+
+### description
+
+```ts
+readonly description: string;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L21)
+
+---
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L19)
+
+---
+
+### path?
+
+```ts
+readonly optional path?: string;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L24)
+
+---
+
+### tag
+
+```ts
+readonly tag: string;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L22)
+
+---
+
+### tags
+
+```ts
+readonly tags: string[];
+```
+
+Defined in: [decorators/SwaggerFeature.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L23)
+
+---
+
+### title
+
+```ts
+readonly title: string;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L20)

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

@@ -0,0 +1,209 @@
+---
+title: '@breadstone/archipel-platform-openapi'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-openapi**](../)
+
+---
+
+# @breadstone/archipel-platform-openapi
+
+## Classes
+
+| Class                                                            | Description                                                                                        |
+| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| [SwaggerFeatureDiscovery](Class.SwaggerFeatureDiscovery)         | Centralizes the discovery of Swagger features declared across backend modules.                     |
+| [SwaggerFeatureRegistry](Class.SwaggerFeatureRegistry)           | Registry service for dynamically discovered Swagger features. Collects feature configurations from |
+| [SwaggerMultiDocumentService](Class.SwaggerMultiDocumentService) | -                                                                                                  |
+| [SwaggerTheme](Class.SwaggerTheme)                               | The swagger theme class                                                                            |
+
+## Interfaces
+
+| Interface                                                    | Description |
+| ------------------------------------------------------------ | ----------- |
+| [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig)     | -           |
+| [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | -           |
+
+## Variables
+
+### APP_VERSION
+
+```ts
+const APP_VERSION: IConfigKey<string>;
+```
+
+Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L12)
+
+Application version shown in the Swagger document.
+
+---
+
+### PLATFORM_OPENAPI_CONFIG_ENTRIES
+
+```ts
+const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+```
+
+Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L28)
+
+All configuration entries required by `platform-openapi`.
+
+---
+
+### SWAGGER_CONTACT_EMAIL
+
+```ts
+const SWAGGER_CONTACT_EMAIL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L21)
+
+Contact e-mail displayed in the Swagger document.
+
+---
+
+### SWAGGER_CONTACT_NAME
+
+```ts
+const SWAGGER_CONTACT_NAME: IConfigKey<string>;
+```
+
+Defined in: [env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L15)
+
+Contact name displayed in the Swagger document.
+
+---
+
+### SWAGGER_CONTACT_URL
+
+```ts
+const SWAGGER_CONTACT_URL: IConfigKey<string>;
+```
+
+Defined in: [env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L18)
+
+Contact URL displayed in the Swagger document.
+
+---
+
+### SWAGGER_FEATURE_METADATA_KEY
+
+```ts
+const SWAGGER_FEATURE_METADATA_KEY: 'swagger:feature' = 'swagger:feature';
+```
+
+Defined in: [decorators/SwaggerFeature.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L9)
+
+## Functions
+
+### Api()
+
+```ts
+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)
+
+Custom Swagger Decorator
+This decorator wraps all necessary Swagger decorators into one.
+
+#### 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).    |
+
+#### Returns
+
+`ClassDecorator` & `MethodDecorator` & `PropertyDecorator`
+
+---
+
+### getRegisteredSwaggerFeatures()
+
+```ts
+function getRegisteredSwaggerFeatures(): ISwaggerFeatureMetadata[];
+```
+
+Defined in: [decorators/SwaggerFeature.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L122)
+
+Retrieves all Swagger features that have been registered through the decorator.
+
+#### Returns
+
+[`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)[]
+
+---
+
+### getSwaggerFeatureMetadata()
+
+```ts
+function getSwaggerFeatureMetadata(target): ISwaggerFeatureMetadata | undefined;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L115)
+
+Get the Swagger feature metadata from a module class
+
+#### Parameters
+
+| Parameter | Type  |
+| --------- | ----- |
+| `target`  | `any` |
+
+#### Returns
+
+\| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
+\| `undefined`
+
+---
+
+### SwaggerFeature()
+
+```ts
+function SwaggerFeature(metadata): (target) => any;
+```
+
+Defined in: [decorators/SwaggerFeature.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L94)
+
+Decorator to register a module as a Swagger feature.
+This allows the SwaggerMultiDocumentService to automatically discover and create documentation.
+
+#### Parameters
+
+| Parameter  | Type                                                           | Description                                         |
+| ---------- | -------------------------------------------------------------- | --------------------------------------------------- |
+| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
+
+#### Returns
+
+(`target`) => `any`
+
+#### Example
+
+```typescript
+@SwaggerFeature({
+  name: 'tip',
+  title: 'Strivio API - Tips',
+  description: 'API endpoints for tip management',
+  tag: 'Tip',
+})
+@Module({
+  controllers: [TipController],
+  providers: [TipService],
+  exports: [TipService],
+})
+export class TipModule {}
+```