@breadstone/archipel-mcp 0.0.30 → 0.0.32

package/data/packages/platform-feature-flags/api/Class.AzureFeatureFlagWriter.md

@@ -0,0 +1,235 @@
+---
+title: 'Class: AzureFeatureFlagWriter'
+generated: true
+editUrl: false
+---
+# Class: AzureFeatureFlagWriter
+
+Defined in: azure/AzureFeatureFlagWriter.ts:28
+
+Azure App Configuration implementation of the [FeatureFlagWriterPort](Class.FeatureFlagWriterPort).
+Uses `@azure/app-configuration` (`AppConfigurationClient`) for CRUD operations
+on feature flags stored in Azure App Configuration.
+
+## Extends
+
+- [`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort)
+
+## Implements
+
+- `OnModuleInit`
+
+## Constructors
+
+### Constructor
+
+```ts
+new AzureFeatureFlagWriter(configService): AzureFeatureFlagWriter;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:39
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+
+#### Returns
+
+`AzureFeatureFlagWriter`
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`constructor`](Class.FeatureFlagWriterPort#constructor)
+
+## Methods
+
+### createFlag()
+
+```ts
+createFlag(definition): Promise<void>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:150
+
+Creates a new feature flag.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `definition` | [`IFeatureFlagDefinition`](Interface.IFeatureFlagDefinition) | The flag definition to create. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Throws
+
+If the flag already exists or creation fails.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`createFlag`](Class.FeatureFlagWriterPort#createflag)
+
+***
+
+### deleteFlag()
+
+```ts
+deleteFlag(key): Promise<void>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:218
+
+Deletes a feature flag.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key of the flag to delete. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Throws
+
+If the deletion fails.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`deleteFlag`](Class.FeatureFlagWriterPort#deleteflag)
+
+***
+
+### getFlag()
+
+```ts
+getFlag(key): Promise<
+  | IFeatureFlagDefinition
+| undefined>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:81
+
+Returns a single feature flag definition by key.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key identifying the feature flag. |
+
+#### Returns
+
+`Promise`\<
+  \| [`IFeatureFlagDefinition`](Interface.IFeatureFlagDefinition)
+  \| `undefined`\>
+
+The flag definition, or `undefined` if not found.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`getFlag`](Class.FeatureFlagWriterPort#getflag)
+
+***
+
+### listFlags()
+
+```ts
+listFlags(): Promise<readonly IFeatureFlagDefinition[]>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:115
+
+Returns all feature flag definitions managed by the provider.
+
+#### Returns
+
+`Promise`\<readonly [`IFeatureFlagDefinition`](Interface.IFeatureFlagDefinition)[]\>
+
+Array of flag definitions.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`listFlags`](Class.FeatureFlagWriterPort#listflags)
+
+***
+
+### onModuleInit()
+
+```ts
+onModuleInit(): Promise<void>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:53
+
+Initializes the Azure App Configuration management client.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit
+```
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:237
+
+Lightweight connectivity check for the writer provider.
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`ping`](Class.FeatureFlagWriterPort#ping)
+
+***
+
+### updateFlag()
+
+```ts
+updateFlag(key, updates): Promise<void>;
+```
+
+Defined in: azure/AzureFeatureFlagWriter.ts:177
+
+Updates an existing feature flag.
+Only the fields present in the partial definition are updated.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key of the flag to update. |
+| `updates` | `Partial`\<`Omit`\<[`IFeatureFlagDefinition`](Interface.IFeatureFlagDefinition), `"key"`\>\> | Partial definition with the fields to update. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Throws
+
+If the flag does not exist or the update fails.
+
+#### Overrides
+
+[`FeatureFlagWriterPort`](Class.FeatureFlagWriterPort).[`updateFlag`](Class.FeatureFlagWriterPort#updateflag)

package/data/packages/platform-feature-flags/api/Class.FeatureFlagError.md

@@ -0,0 +1,65 @@
+---
+title: 'Class: FeatureFlagError'
+generated: true
+editUrl: false
+---
+# Class: FeatureFlagError
+
+Defined in: errors/FeatureFlagError.ts:6
+
+Domain error thrown when a feature flag operation fails.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeatureFlagError(
+   provider, 
+   message, 
+   cause?): FeatureFlagError;
+```
+
+Defined in: errors/FeatureFlagError.ts:16
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `provider` | `string` |
+| `message` | `string` |
+| `cause?` | `unknown` |
+
+#### Returns
+
+`FeatureFlagError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: "FEATURE_FLAG" = 'FEATURE_FLAG';
+```
+
+Defined in: errors/FeatureFlagError.ts:9
+
+***
+
+### provider
+
+```ts
+readonly provider: string;
+```
+
+Defined in: errors/FeatureFlagError.ts:10

package/data/packages/platform-feature-flags/api/Class.FeatureFlagGuard.md

@@ -0,0 +1,68 @@
+---
+title: 'Class: FeatureFlagGuard'
+generated: true
+editUrl: false
+---
+# Class: FeatureFlagGuard
+
+Defined in: guards/FeatureFlagGuard.ts:17
+
+Guard that checks if a feature flag is enabled before allowing access to a route.
+Use the [FeatureFlag](Function.FeatureFlag) decorator to specify which flag to check.
+
+## Implements
+
+- `CanActivate`
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeatureFlagGuard(featureFlagReader, reflector): FeatureFlagGuard;
+```
+
+Defined in: guards/FeatureFlagGuard.ts:35
+
+Constructs a new instance of the `FeatureFlagGuard` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `featureFlagReader` | [`FeatureFlagReaderPort`](Class.FeatureFlagReaderPort) | The feature flag reader port. |
+| `reflector` | `Reflector` | The NestJS reflector. |
+
+#### Returns
+
+`FeatureFlagGuard`
+
+## Methods
+
+### canActivate()
+
+```ts
+canActivate(context): Promise<boolean>;
+```
+
+Defined in: guards/FeatureFlagGuard.ts:51
+
+Determines whether the guarded feature flag is enabled.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | `ExecutionContext` | The execution context. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` when the feature flag is enabled and access is allowed.
+
+#### Implementation of
+
+```ts
+CanActivate.canActivate
+```

package/data/packages/platform-feature-flags/api/Class.FeatureFlagModule.md

@@ -0,0 +1,49 @@
+---
+title: 'Class: FeatureFlagModule'
+generated: true
+editUrl: false
+---
+# Class: FeatureFlagModule
+
+Defined in: FeatureFlagModule.ts:21
+
+NestJS module providing feature flag infrastructure.
+Exposes a configurable feature flag reader and a route guard.
+Optionally exposes a writer port for CRUD operations when `featureFlagWriter` is provided.
+The specific provider (Azure App Configuration, Vercel Edge Config) is selected via the options.
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeatureFlagModule(): FeatureFlagModule;
+```
+
+#### Returns
+
+`FeatureFlagModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(options): DynamicModule;
+```
+
+Defined in: FeatureFlagModule.ts:31
+
+Configures the module with the specified options.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IFeatureFlagModuleOptions`](Interface.IFeatureFlagModuleOptions) | The module configuration options. |
+
+#### Returns
+
+`DynamicModule`
+
+Dynamic module definition.

package/data/packages/platform-feature-flags/api/Class.FeatureFlagReaderPort.md

@@ -0,0 +1,150 @@
+---
+title: 'Abstract Class: FeatureFlagReaderPort'
+generated: true
+editUrl: false
+---
+# Abstract Class: FeatureFlagReaderPort
+
+Defined in: contracts/FeatureFlagReaderPort.ts:15
+
+Abstract port for feature flag reader operations.
+Each provider (Azure App Configuration, Vercel Edge Config) must implement this contract
+so that the consuming application can switch providers without changing business logic.
+
+## Extended by
+
+- [`AzureFeatureFlagReader`](Class.AzureFeatureFlagReader)
+- [`VercelFeatureFlagReader`](Class.VercelFeatureFlagReader)
+
+## Constructors
+
+### Constructor
+
+```ts
+new FeatureFlagReaderPort(): FeatureFlagReaderPort;
+```
+
+#### Returns
+
+`FeatureFlagReaderPort`
+
+## Methods
+
+### getAllFlags()
+
+```ts
+abstract getAllFlags(context?): Promise<readonly IFeatureFlagEvaluation[]>;
+```
+
+Defined in: contracts/FeatureFlagReaderPort.ts:46
+
+Returns all known feature flags with their current evaluation.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context?` | [`IFeatureFlagContext`](Interface.IFeatureFlagContext) | Optional evaluation context for targeting and segmentation. |
+
+#### Returns
+
+`Promise`\<readonly [`IFeatureFlagEvaluation`](Interface.IFeatureFlagEvaluation)[]\>
+
+Array of evaluated feature flags.
+
+***
+
+### getVariant()
+
+```ts
+abstract getVariant<T>(
+   key, 
+   defaultValue, 
+context?): Promise<T>;
+```
+
+Defined in: contracts/FeatureFlagReaderPort.ts:37
+
+Returns the variant value of a feature flag for multivariate flags and A/B testing.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `unknown` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key identifying the feature flag. |
+| `defaultValue` | `T` | The default value to return if the flag is not found. |
+| `context?` | [`IFeatureFlagContext`](Interface.IFeatureFlagContext) | Optional evaluation context for targeting and segmentation. |
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The variant value of the feature flag.
+
+***
+
+### isEnabled()
+
+```ts
+abstract isEnabled(key, context?): Promise<boolean>;
+```
+
+Defined in: contracts/FeatureFlagReaderPort.ts:26
+
+Evaluates whether a feature flag is enabled.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key identifying the feature flag. |
+| `context?` | [`IFeatureFlagContext`](Interface.IFeatureFlagContext) | Optional evaluation context for targeting and segmentation. |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the feature flag is enabled.
+
+***
+
+### ping()
+
+```ts
+ping(): Promise<boolean>;
+```
+
+Defined in: contracts/FeatureFlagReaderPort.ts:64
+
+Lightweight connectivity check for the feature flag provider.
+Override in adapters to perform a real API call.
+Defaults to `true` if not overridden.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+`true` if the provider is reachable.
+
+***
+
+### refresh()
+
+```ts
+abstract refresh(): Promise<void>;
+```
+
+Defined in: contracts/FeatureFlagReaderPort.ts:54
+
+Refreshes the flag state from the remote provider.
+Implementations should reload configuration from the upstream source.
+
+#### Returns
+
+`Promise`\<`void`\>